OODockTilePlugIn Class Reference

#include <OODockTilePlugIn.h>

Inheritance diagram for OODockTilePlugIn:

Collaboration diagram for OODockTilePlugIn:

Instance Methods
(IBAction)	- showScreenShots:
(IBAction)	- showExpansionPacks:
(IBAction)	- showLatestLog:
(IBAction)	- showLogFolder:
(id)	- init [implementation]
(void)	- dealloc [implementation]
(BOOL)	- isDirectoryAtPath: [implementation]
(BOOL)	- addOnsExistAtPath: [implementation]
(void)	- openPath: [implementation]
(BOOL)	- validateMenuItem: [implementation]
(NSURL *)	- snapshotsURLCreatingIfNeeded: [implementation]
(NSString *)	- latestLogPath [implementation]
(NSString *)	- logFolderPath [implementation]

Class Methods
(static id)	+ GetPreference [implementation]
(static void)	+ SetPreference [implementation]
(static void)	+ RemovePreference [implementation]
(static NSString *)	+ DESC [implementation]

Properties
NSDockTile *	dockTile
IBOutlet NSMenu *	dockMenu

Private Attributes
NSDockTile *	_dockTile
NSMenu *	_dockMenu

Detailed Description

Definition at line 32 of file OODockTilePlugIn.h.

Method Documentation

addOnsExistAtPath:

- (BOOL) addOnsExistAtPath: (NSString *) path

implementation

Definition at line 342 of file OODockTilePlugIn.m.

                          :(NSString *)path
{
    if (![self isDirectoryAtPath:path])  return NO;
    
    NSWorkspace *workspace = NSWorkspace.sharedWorkspace;
    for (NSString *subPath in [NSFileManager.defaultManager enumeratorAtPath:path]) {
        subPath = [path stringByAppendingPathComponent:subPath];
        NSString *type = [workspace typeOfFile:subPath error:NULL];
        if ([workspace type:type conformsToType:@"org.aegidian.oolite.expansion"])  return YES;
    }
    
    return NO;
}

dealloc

- (void) dealloc

implementation

Definition at line 342 of file OODockTilePlugIn.m.

{
    self.dockTile = nil;
    self.dockMenu = nil;
    
    [super dealloc];
}

DESC

+ (static NSString *) DESC (NSString *) key

implementation

Definition at line 188 of file OODockTilePlugIn.m.

{
    static NSDictionary *descs = nil;
    if (descs == nil)
    {
        // Get default description.plist from Oolite.
        NSURL *url = [[NSBundle bundleForClass:[OODockTilePlugIn class]] bundleURL];
        url = [NSURL URLWithString:@"../../Resources/Config/descriptions.plist" relativeToURL:url];
        
        descs = [NSDictionary dictionaryWithContentsOfURL:url];
        if (descs == nil)  descs = [NSDictionary dictionary];
        [descs retain];
    }
    
    NSString *result = [descs objectForKey:key];
    if (![result isKindOfClass:[NSString class]])  result = key;    // We don't need to deal with arrays.
    return result;
}

References nil.

GetPreference

+ (static id) GetPreference (NSString *) key (Class) expectedClass

implementation

Definition at line 165 of file OODockTilePlugIn.m.

{
    // Use CFPreferences instead of NSDefaults so we can specify the app ID.
    CFPropertyListRef value = CFPreferencesCopyAppValue((CFStringRef)key, CFSTR("org.aegidian.oolite"));
    id result = [NSMakeCollectable(value) autorelease];
    if (expectedClass != Nil && ![result isKindOfClass:expectedClass])  result = nil;
    
    return result;
}

References nil.

init

- (id) init

implementation

Definition at line 342 of file OODockTilePlugIn.m.

{
    if ((self = [super init]))
    {
        [NSBundle loadNibNamed:@"OODockTilePlugIn" owner:self];
    }
    
    return self;
}

isDirectoryAtPath:

- (BOOL) isDirectoryAtPath: (NSString *) path

implementation

Definition at line 342 of file OODockTilePlugIn.m.

                          :(NSString *)path
{
    BOOL isDirectory;
    return [NSFileManager.defaultManager fileExistsAtPath:path isDirectory:&isDirectory] && isDirectory;
}

latestLogPath

- (NSString *) latestLogPath

implementation

Definition at line 188 of file OODockTilePlugIn.m.

{
    return [[self logFolderPath] stringByAppendingPathComponent:@"Latest.log"];
}

logFolderPath

- (NSString *) logFolderPath

implementation

Definition at line 188 of file OODockTilePlugIn.m.

{
    return OOLogHandlerGetLogBasePath();
}

openPath:

- (void) openPath: (NSString *) path

implementation

Definition at line 342 of file OODockTilePlugIn.m.

                 :(NSString *)path
{
    [NSWorkspace.sharedWorkspace openURL:[NSURL fileURLWithPath:path]];
}

RemovePreference

+ (static void) RemovePreference (NSString *) key

implementation

Definition at line 182 of file OODockTilePlugIn.m.

{
    SetPreference(key, nil);
}

References nil, and SetPreference.

Here is the call graph for this function:

SetPreference

+ (static void) SetPreference (NSString *) key (id) value

implementation

Definition at line 176 of file OODockTilePlugIn.m.

{
    CFPreferencesSetAppValue((CFStringRef)key, value, CFSTR("org.aegidian.oolite"));
}

Referenced by RemovePreference.

Here is the caller graph for this function:

showExpansionPacks:

- (IBAction) showExpansionPacks:

(id)

sender

Definition at line 342 of file OODockTilePlugIn.m.

                               :sender
{
    NSArray *paths = ResourceManagerRootPaths();
    
    // Look for an AddOns directory that actually contains some AddOns.
    for (NSString *path in paths) {
        if ([self addOnsExistAtPath:path]) {
            [self openPath:path];
            return;
        }
    }
    
    // If that failed, look for an AddOns directory that actually exists.
    for (NSString *path in paths) {
        if ([self isDirectoryAtPath:path]) {
            [self openPath:path];
            return;
        }
    }
    
    // None found, create the default path.
    [NSFileManager.defaultManager createDirectoryAtPath:paths[0]
                            withIntermediateDirectories:YES
                                             attributes:nil
                                                  error:NULL];
    [self openPath:paths[0]];
}

showLatestLog:

- (IBAction) showLatestLog:

(id)

sender

Definition at line 342 of file OODockTilePlugIn.m.

                          :(id)sender
{
    [[NSWorkspace sharedWorkspace] openURL:[NSURL fileURLWithPath:[self latestLogPath]]];
}

showLogFolder:

- (IBAction) showLogFolder:

(id)

sender

Definition at line 342 of file OODockTilePlugIn.m.

                          :(id)sender
{
    [[NSWorkspace sharedWorkspace] openURL:[NSURL fileURLWithPath:[self logFolderPath]]];
}

showScreenShots:

- (IBAction) showScreenShots:

(id)

sender

Definition at line 342 of file OODockTilePlugIn.m.

                            :(id)sender
{
    [[NSWorkspace sharedWorkspace] openURL:[self snapshotsURLCreatingIfNeeded:NO]];
}

snapshotsURLCreatingIfNeeded:

- (NSURL *) snapshotsURLCreatingIfNeeded: (BOOL) create

implementation

Definition at line 188 of file OODockTilePlugIn.m.

                                        :(BOOL)create
{
    BOOL            stale = NO;
    NSDictionary    *snapshotDirDict = GetPreference(kSnapshotsDirRefKey, [NSDictionary class]);
    NSURL           *url = nil;
    NSString        *name = DESC(@"snapshots-directory-name-mac");
    
    if (snapshotDirDict != nil)
    {
        url = JAURLFromPersistentFileReference(snapshotDirDict, kJAPersistentFileReferenceWithoutUI | kJAPersistentFileReferenceWithoutMounting, &stale);
        if (url != nil)
        {
            NSString *existingName = [[url path] lastPathComponent];
            if ([existingName compare:name options:NSCaseInsensitiveSearch] != 0)
            {
                // Check name from previous access, because we might have changed localizations.
                NSString *originalOldName = GetPreference(kSnapshotsDirNameKey, [NSString class]);
                if (originalOldName == nil || [existingName compare:originalOldName options:NSCaseInsensitiveSearch] != 0)
                {
                    url = nil;
                }
            }
            
            // did we put the old directory in the trash?
            Boolean inTrash = false;
            const UInt8* utfPath = (UInt8*)[[url path] UTF8String];
            
            OSStatus err = DetermineIfPathIsEnclosedByFolder(kOnAppropriateDisk, kTrashFolderType, utfPath, false, &inTrash);
            // if so, create a new directory.
            if (err == noErr && inTrash == true) url = nil;
        }
    }
    
    if (url == nil)
    {
        NSString *path = nil;
        NSArray *searchPaths = NSSearchPathForDirectoriesInDomains(NSDesktopDirectory, NSUserDomainMask, YES);
        if ([searchPaths count] > 0)
        {
            path = [[searchPaths objectAtIndex:0] stringByAppendingPathComponent:name];
        }
        url = [NSURL fileURLWithPath:path];
        
        if (url != nil)
        {
            stale = YES;
            if (create)
            {
                NSFileManager *fmgr = [NSFileManager defaultManager];
                if (![fmgr fileExistsAtPath:path])
                {
#if OOLITE_LEOPARD
                    [fmgr createDirectoryAtPath:path withIntermediateDirectories:YES attributes:nil error:NULL];
#else
                    [fmgr createDirectoryAtPath:path attributes:nil];
#endif
                }
            }
        }
    }
    
    if (stale)
    {
        snapshotDirDict = JAPersistentFileReferenceFromURL(url);
        if (snapshotDirDict != nil)
        {
            SetPreference(kSnapshotsDirRefKey, snapshotDirDict);
            SetPreference(kSnapshotsDirNameKey, [[url path] lastPathComponent]);
        }
        else
        {
            RemovePreference(kSnapshotsDirRefKey);
        }
    }
    
    return url;
}

validateMenuItem:

- (BOOL) validateMenuItem: (NSMenuItem *) menuItem

implementation

Definition at line 342 of file OODockTilePlugIn.m.

                         :(NSMenuItem *)menuItem
{
    SEL action = [menuItem action];
    
    if (action == @selector(showScreenShots:))
    {
        return [[NSFileManager defaultManager] fileExistsAtPath:[[self snapshotsURLCreatingIfNeeded:NO] path]];
    }
    else if (action == @selector(showLatestLog:))
    {
        return [[NSFileManager defaultManager] fileExistsAtPath:[self latestLogPath]];
    }
    
    return YES;
}

Member Data Documentation

_dockMenu

- (NSMenu*) _dockMenu

private

Definition at line 39 of file OODockTilePlugIn.h.

_dockTile

- (NSDockTile*) _dockTile

private

Definition at line 38 of file OODockTilePlugIn.h.

Property Documentation

dockMenu

- (IBOutlet NSMenu*) dockMenu

readwriteatomicassign

Definition at line 44 of file OODockTilePlugIn.h.

dockTile

- (NSDockTile*) dockTile

readwriteatomicretain

Definition at line 43 of file OODockTilePlugIn.h.

---

The documentation for this class was generated from the following files:

• Mac-specific/Oolite-docktile/OODockTilePlugIn.h
• Mac-specific/Oolite-docktile/OODockTilePlugIn.m