Objective C singleton pattern templates discussion

gistfile1.m

// Accessorizer's default generated singleton code for class Foo

static Foo *sharedInstance = nil; 

+ (void) initialize
{
    if (sharedInstance == nil)
        sharedInstance = [[self alloc] init];
        }

+ (id) sharedFoo
{
    //Already set by +initialize.
    return sharedInstance;
}

+ (id) allocWithZone: (NSZone *) zone
{
    //Usually already set by +initialize.
    @synchronized(self)
    {
        if (sharedInstance)
        {
            //The caller expects to receive a new object, so implicitly retain it
            //to balance out the eventual release message.
            return [sharedInstance retain];
        } else
        {
            //When not already set, +initialize is our caller.
            //It's creating the shared instance, let this go through.
            return [super allocWithZone: zone];
        }
    }
}

- (id) init
{
    //If sharedInstance is nil, +initialize is our caller, so initialize the instance.
    //If it is not nil, simply return the instance without re-initializing it.
    if (sharedInstance == nil)
    {
        self = [super init];
        if (self)
        {
            //Initialize the instance here.
        }
    }
    return self;
}

- (id) copyWithZone: (NSZone *) zone
{
    return self;
}
- (id) retain
{
    return self;
}
- (unsigned) retainCount
{
    return UINT_MAX; // denotes an object that cannot be released
}
- (void) release
{
    // do nothing 
}
- (id) autorelease
{
    return self;
}

gistfile2.m

// Apple's documented version (from Cocoa Fundamentals Guide)

// http://developer.apple.com/library/ios/#documentation/Cocoa/Conceptual/CocoaFundamentals/CocoaObjects/CocoaObjects.html%23//apple_ref/doc/uid/TP40002974-CH4-SW32

static MyGizmoClass *sharedGizmoManager = nil;
 
+ (MyGizmoClass*)sharedManager
{
    if (sharedGizmoManager == nil) {
        sharedGizmoManager = [[super allocWithZone:NULL] init];
    }
    return sharedGizmoManager;
}
 
+ (id)allocWithZone:(NSZone *)zone
{
    return [[self sharedManager] retain];
}
 
- (id)copyWithZone:(NSZone *)zone
{
    return self;
}
 
- (id)retain
{
    return self;
}
 
- (NSUInteger)retainCount
{
    return NSUIntegerMax;  //denotes an object that cannot be released
}
 
- (void)release
{
    //do nothing
}
 
- (id)autorelease
{
    return self;
}

thanks to all for this discussion - I have a few switches (options) in the Accessorizer Singleton code gen interface. I can re-implement/add some custom options there. People just need to email me what they want and I'll do my best to accommodate. Lastly, if there's ever a question with the code generated by Accessorizer, do NOT hesitate to contact me via email so we can discuss, modify, improve etc.