JAPersistentFileReference.h File Reference

import <Foundation/Foundation.h>

Include dependency graph for JAPersistentFileReference.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef uint32_t	JAPersistentFileReferenceResolveFlags

Enumerations
enum	{ kJAPersistentFileReferenceWithoutUI = 0x00000001UL , kJAPersistentFileReferenceWithoutMounting = 0x00000002UL , kJAPersistentFileReferenceReturnReferenceURL = 0x00000004UL }

Functions
NSDictionary *	JAPersistentFileReferenceFromURL (NSURL *url)
NSURL *	JAURLFromPersistentFileReference (NSDictionary *fileRef, JAPersistentFileReferenceResolveFlags flags, BOOL *isStale)
NSDictionary *	JAPersistentFileReferenceFromPath (NSString *path)
NSString *	JAPathFromPersistentFileReference (NSDictionary *fileRef, JAPersistentFileReferenceResolveFlags flags, BOOL *isStale)

Typedef Documentation

JAPersistentFileReferenceResolveFlags

typedef uint32_t JAPersistentFileReferenceResolveFlags

Definition at line 42 of file JAPersistentFileReference.h.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
kJAPersistentFileReferenceWithoutUI
kJAPersistentFileReferenceWithoutMounting
kJAPersistentFileReferenceReturnReferenceURL

Definition at line 35 of file JAPersistentFileReference.h.

{
    kJAPersistentFileReferenceWithoutUI             = 0x00000001UL, // Avoid user interaction.
    kJAPersistentFileReferenceWithoutMounting       = 0x00000002UL, // Avoid mounting volumes.
    kJAPersistentFileReferenceReturnReferenceURL    = 0x00000004UL  // Return a file reference URL if possible.
};

Function Documentation

JAPathFromPersistentFileReference()

NSString * JAPathFromPersistentFileReference	(	NSDictionary *	fileRef,
		JAPersistentFileReferenceResolveFlags	flags,
		BOOL *	isStale )

Definition at line 239 of file JAPersistentFileReference.m.

{
    NSURL *url = JAURLFromPersistentFileReference(fileRef, flags & ~kJAPersistentFileReferenceReturnReferenceURL, isStale);
    if ([url isFileURL])  return [url path];
    return nil;
}

References JAURLFromPersistentFileReference(), kJAPersistentFileReferenceReturnReferenceURL, and nil.

Here is the call graph for this function:

JAPersistentFileReferenceFromPath()

NSDictionary * JAPersistentFileReferenceFromPath

(

NSString *

path

)

Definition at line 233 of file JAPersistentFileReference.m.

{
    return JAPersistentFileReferenceFromURL([NSURL fileURLWithPath:path]);
}

References JAPersistentFileReferenceFromURL().

Here is the call graph for this function:

JAPersistentFileReferenceFromURL()

NSDictionary * JAPersistentFileReferenceFromURL

(

NSURL *

url

)

Definition at line 71 of file JAPersistentFileReference.m.

{
    if (url == nil)  return nil;
    
    NSMutableDictionary *result = [NSMutableDictionary dictionaryWithCapacity:3];
    [result setObject:[url absoluteString] forKey:kURLKey];
    
    if ([url isFileURL])
    {
        FSRef fsRef;
        if (CFURLGetFSRef((CFURLRef)[url absoluteURL], &fsRef))
        {
            AliasHandle alias = NULL;
            if (FSNewAlias(NULL, &fsRef, &alias) == noErr)
            {
                NSData *aliasData = [NSData dataWithBytes:*alias length:GetAliasSize(alias)];
                if (aliasData != NULL)
                {
                    [result setObject:aliasData forKey:kAliasKey];
                }
                DisposeHandle((Handle)alias);
            }
        }
    }
    
    if (BookmarkDataSupported())
    {
        NSURL *refURL = [url fileReferenceURL];
        if (refURL != nil)
        {
            NSData *bookmarkData = [refURL bookmarkDataWithOptions:0
                                    includingResourceValuesForKeys:nil
                                                     relativeToURL:nil
                                                             error:NULL];
            if (bookmarkData != nil)
            {
                [result setObject:bookmarkData forKey:kBookmarkKey];
            }
        }
    }
    
    return result;
}

References BookmarkDataSupported, and nil.

Referenced by JAPersistentFileReferenceFromPath().

Here is the caller graph for this function:

JAURLFromPersistentFileReference()

NSURL * JAURLFromPersistentFileReference	(	NSDictionary *	fileRef,
		JAPersistentFileReferenceResolveFlags	flags,
		BOOL *	isStale )

Definition at line 133 of file JAPersistentFileReference.m.

{
    NSURL *result = nil;
    BOOL stale = NO, staleIfFile = NO;
    
    // Try bookmark.
    if (BookmarkDataSupported())
    {
        NSData *bookmarkData = [fileRef objectForKey:kBookmarkKey];
        if ([bookmarkData isKindOfClass:[NSData class]])
        {
            result = [NSURL URLByResolvingBookmarkData:bookmarkData
                                               options:BookmarkOptionsFromFlags(flags)
                                         relativeToURL:nil
                                   bookmarkDataIsStale:&stale
                                                 error:NULL];
        }
        else  staleIfFile = YES;
    }
    
    // Try alias.
    if (result == nil)
    {
        NSData *aliasData = [fileRef objectForKey:kAliasKey];
        if ([aliasData isKindOfClass:[NSData class]])
        {
            size_t size = [aliasData length];
            AliasHandle alias = (AliasHandle)NewHandle(size);
            if (alias != NULL)
            {
                memcpy(*alias, [aliasData bytes], size);
                FSRef fsRef;
                
                Boolean carbonStale;
                if (FSResolveAliasWithMountFlags(NULL, alias, &fsRef, &carbonStale, AliasMountFlagsFromFlags(flags)) == noErr)
                {
                    stale = carbonStale;
                    result = (NSURL *)CFURLCreateFromFSRef(kCFAllocatorDefault, &fsRef);
#if 1050 <= MAC_OS_X_VERSION_MAX_ALLOWED
                    CFMakeCollectable((CFURLRef)result);
#endif
                    [result autorelease];
                }
                DisposeHandle((Handle)alias);
            }
        }
        else  staleIfFile = YES;
    }
    
    // Try URL.
    if (result == nil)
    {
        NSString *urlString = [fileRef objectForKey:kURLKey];
        if ([urlString isKindOfClass:[NSString class]])
        {
            result = [NSURL URLWithString:urlString relativeToURL:nil];
            if ([result isFileURL] && ![[NSFileManager defaultManager] fileExistsAtPath:[result path]])
            {
                result = nil;
            }
        }
    }
    
    // If we got nothing, it's definitely stale.
    if (result == nil)
    {
        stale = YES;
    }
    else
    {
        if ([result isFileURL] && staleIfFile)  stale = YES;
        
        // Convert to/from file reference URL as appropriate.
        if (BookmarkDataSupported())
        {
            if (flags & kJAPersistentFileReferenceReturnReferenceURL)
            {
                if (![result isFileReferenceURL] && [result isFileURL])
                {
                    NSURL *refURL = [result fileReferenceURL];
                    if (refURL != nil)  result = refURL;
                }
            }
            else
            {
                if ([result isFileReferenceURL])
                {
                    NSURL *pathURL = [result filePathURL];
                    if (pathURL != nil)  result = pathURL;
                }
            }
        }
    }
 
    
    if (isStale != NULL)  *isStale = stale;
    return result;
}

References AliasMountFlagsFromFlags(), BookmarkDataSupported, kJAPersistentFileReferenceReturnReferenceURL, and nil.

Referenced by JAPathFromPersistentFileReference().

Here is the call graph for this function:

Here is the caller graph for this function: