Line data    Source code

       1           0 : /*
       2             : 
       3             : JAPersistentFileReference.h
       4             : 
       5             : Store file references in a property list format. For file URLs, uses bookmark
       6             : data (when available) and aliases to track files even if they're moved or
       7             : renamed.
       8             : 
       9             : 
      10             : Copyright (C) 2010-2013 Jens Ayton
      11             : 
      12             : Permission is hereby granted, free of charge, to any person obtaining a copy
      13             : of this software and associated documentation files (the "Software"), to deal
      14             : in the Software without restriction, including without limitation the rights
      15             : to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
      16             : copies of the Software, and to permit persons to whom the Software is
      17             : furnished to do so, subject to the following conditions:
      18             : 
      19             : The above copyright notice and this permission notice shall be included in all
      20             : copies or substantial portions of the Software.
      21             : 
      22             : THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
      23             : IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
      24             : FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
      25             : AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
      26             : LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
      27             : OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
      28             : SOFTWARE.
      29             : 
      30             : */
      31             : 
      32             : #import <Foundation/Foundation.h>
      33             : 
      34             : 
      35           0 : enum
      36             : {
      37             :         kJAPersistentFileReferenceWithoutUI                             = 0x00000001UL, // Avoid user interaction.
      38             :         kJAPersistentFileReferenceWithoutMounting               = 0x00000002UL, // Avoid mounting volumes.
      39             :         kJAPersistentFileReferenceReturnReferenceURL    = 0x00000004UL  // Return a file reference URL if possible.
      40             : };
      41             : 
      42           0 : typedef uint32_t JAPersistentFileReferenceResolveFlags;
      43             : 
      44             : 
      45           0 : NSDictionary *JAPersistentFileReferenceFromURL(NSURL *url);
      46           0 : NSURL *JAURLFromPersistentFileReference(NSDictionary *fileRef, JAPersistentFileReferenceResolveFlags flags, BOOL *isStale);
      47             : 
      48           0 : NSDictionary *JAPersistentFileReferenceFromPath(NSString *path);
      49           0 : NSString *JAPathFromPersistentFileReference(NSDictionary *fileRef, JAPersistentFileReferenceResolveFlags flags, BOOL *isStale);