#include <OOShipGroup.h>

Inheritance diagram for OOShipGroup:

Collaboration diagram for OOShipGroup:

Instance Methods
(id)	- init

(id)	- initWithName:

(NSString *)	- name

(void)	- setName:

(ShipEntity *)	- leader

(void)	- setLeader:

(NSEnumerator *)	- objectEnumerator

(NSEnumerator *)	- mutationSafeEnumerator

(NSSet *)	- members

(NSArray *)	- memberArray

(NSSet *)	- membersExcludingLeader

(NSArray *)	- memberArrayExcludingLeader

(BOOL)	- containsShip:

(BOOL)	- addShip:

(BOOL)	- removeShip:

(NSUInteger)	- count

(BOOL)	- isEmpty

(void)	- dealloc `[implementation]`

(NSString *)	- descriptionComponents `[implementation]`

(BOOL)	- resizeTo: `[implementation]`

(void)	- cleanUp `[implementation]`

(NSUInteger)	- updateCount `[implementation]`

(NSUInteger)	- countByEnumeratingWithState:objects:count: `[implementation]`

(BOOL)	- suppressClangStuff `[implementation]`

(NSString *)	- inspDescription `[implementation]`

(NSString *)	- inspBasicIdentityLine `[implementation]`

(NSArray *)	- debugInspectorModules `[implementation]`

(jsval)	- oo_jsValueInContext: `[implementation]`

(void)	- oo_clearJSSelf: `[implementation]`

Instance Methods inherited from OOWeakRefObject
(id)	- weakSelf

(id)	- weakRetain `[implementation]`

(void)	- weakRefDied: `[implementation]`

Instance Methods inherited from <OOWeakReferenceSupport>
(id)	- OO_RETURNS_RETAINED

Class Methods
(instancetype)	+ groupWithName:

(instancetype)	+ groupWithName:leader:

(static id)	+ ShipGroupIterate `[implementation]`

Protected Attributes
< NSFastEnumeration > unsigned long	_updateCount

OOWeakReference **	_members

OOWeakReference *	_leader

NSString *	_name

struct JSObject *	_jsSelf

Protected Attributes inherited from OOWeakRefObject
OOWeakReference *	weakSelf

Detailed Description

Definition at line 33 of file OOShipGroup.h.

Method Documentation

◆ addShip:

- (BOOL) addShip: (ShipEntity *) ship

Definition at line 54 of file OOShipGroup.m.

                :(ShipEntity *)ship
{
    _updateCount++;
    
    if ([self containsShip:ship])  return YES;  // it's in the group already, result!
    
    // Ensure there's space.
    if (_count == _capacity)
    {
        if (![self resizeTo:(_capacity > kMaxFreeSpace) ? (_capacity + kMaxFreeSpace) : (_capacity * 2)])
        {
            if (![self resizeTo:_capacity + 1])
            {
                // Out of memory?
                return NO;
            }
        }
    }
    
    _members[_count++] = [ship weakRetain];
    return YES;
}

◆ cleanUp

- (void) cleanUp

implementation

Provided by category OOShipGroup(Private).

Definition at line 54 of file OOShipGroup.m.

{
    NSUInteger              newCapacity = _capacity;
    
    if (_count >= kMaxFreeSpace)
    {
        if (_capacity > _count + kMaxFreeSpace)
        {
            newCapacity = _count + 1;   // +1 keeps us at powers of two + multiples of kMaxFreespace.
        }
    }
    else
    {
        if (_capacity > _count * 2)
        {
            newCapacity = OORoundUpToPowerOf2_NS(_count);
            if (newCapacity < kMinSize) newCapacity = kMinSize;
        }
    }
    
    if (newCapacity != _capacity)  [self resizeTo:newCapacity];
}

Referenced by countByEnumeratingWithState:objects:count:.

Here is the caller graph for this function:

◆ containsShip:

- (BOOL) containsShip: (ShipEntity *) ship

Definition at line 54 of file OOShipGroup.m.

                     :(ShipEntity *)ship
{
    ShipEntity              *containedShip = nil;
    
    for (containedShip in self)
    {
        if ([ship isEqual:containedShip])
        {
            return YES;
        }
    }
    
    return NO;
}

◆ count

- (NSUInteger) count

Definition at line 54 of file OOShipGroup.m.

{
    NSEnumerator        *memberEnum = nil;
    NSUInteger          result = 0;
    
    if (_count != 0)
    {
        memberEnum = [self objectEnumerator];
        while ([memberEnum nextObject] != nil)  result++;
    }
    
    assert(result == _count);
    
    return result;
}

◆ countByEnumeratingWithState:objects:count:

- (NSUInteger) countByEnumeratingWithState:	(NSFastEnumerationState *)	state
objects:	(id *)	stackbuf
count:	(NSUInteger)	len

implementation

Definition at line 473 of file OOShipGroup.m.

                                         :(NSFastEnumerationState *)state objects:(id *)stackbuf count:(NSUInteger)len
{
    NSUInteger              srcIndex, dstIndex = 0;
    ShipEntity              *item = nil;
    BOOL                    cleanupNeeded = NO;
    
    srcIndex = state->state;
    while (srcIndex < _count && dstIndex < len)
    {
        item = [_members[srcIndex] weakRefUnderlyingObject];
        if (item != nil)
        {
            stackbuf[dstIndex++] = item;
            srcIndex++;
        }
        else
        {
            _members[srcIndex] = _members[--_count];
            cleanupNeeded = YES;
        }
    }
    
    if (cleanupNeeded)  [self cleanUp];
    
    state->state = srcIndex;
    state->itemsPtr = stackbuf;
    state->mutationsPtr = &_updateCount;
    
    return dstIndex;
}

References OOShipGroupEnumerator::_cleanupNeeded, OOShipGroupEnumerator::_considerCleanup, OOShipGroupEnumerator::_group, OOShipGroupEnumerator::_index, _members, _updateCount, OOShipGroupEnumerator::_updateCount, cleanUp, and nil.

Here is the call graph for this function:

◆ dealloc

- (void) dealloc

implementation

Reimplemented from OOWeakRefObject.

Definition at line 54 of file OOShipGroup.m.

{
    NSUInteger i;
    
    for (i = 0; i < _count; i++)
    {
        [_members[i] release];
    }
    free(_members);
    [_name release];
    
    [super dealloc];
}

◆ debugInspectorModules

- (NSArray *) debugInspectorModules

implementation

Provided by category OOShipGroup(OOInspectorExtensions).

Definition at line 1 of file OOShipGroupDebugInspectorModule.m.

{
    return [[super debugInspectorModules] arrayByAddingInspectorModuleOfClass:[OOShipGroupDebugInspectorModule class]
                                                                    forObject:(id)self];
}

◆ descriptionComponents

- (NSString *) descriptionComponents

implementation

Definition at line 54 of file OOShipGroup.m.

{
    NSString *desc = [NSString stringWithFormat:@"%llu ships", (unsigned long long)_count];
    if ([self name] != nil)
    {
        desc = [NSString stringWithFormat:@"\"%@\", %@", [self name], desc];
    }
    if ([self leader] != nil)
    {
        desc = [NSString stringWithFormat:@"%@, leader: %@", desc, [[self leader] shortDescription]];
    }
    return desc;
}

◆ groupWithName:

+ (instancetype) groupWithName: (NSString *) name

Definition at line 54 of file OOShipGroup.m.

                              :(NSString *)name
{
    return [[[self alloc] initWithName:name] autorelease];
}

◆ groupWithName:leader:

+ (instancetype) groupWithName:		(NSString *)	name
leader:		(ShipEntity *)	leader

Definition at line 54 of file OOShipGroup.m.

                              :(NSString *)name leader:(ShipEntity *)leader
{
    OOShipGroup *result = [self groupWithName:name];
    [result setLeader:leader];
    return result;
}

◆ init

- (id) init

Definition at line 54 of file OOShipGroup.m.

{
    return [self initWithName:nil];
}

◆ initWithName:

- (id) initWithName: (NSString *) name

Definition at line 54 of file OOShipGroup.m.

                   :(NSString *)name
{
    if ((self = [super init]))
    {
        _capacity = kMinSize;
        _members = malloc(sizeof *_members * _capacity);
        if (_members == NULL)
        {
            [self release];
            return nil;
        }
        
        [self setName:name];
    }
    
    return self;
}

◆ inspBasicIdentityLine

- (NSString *) inspBasicIdentityLine

implementation

Provided by category OOShipGroup(OOInspectorExtensions).

Definition at line 1 of file OOShipGroupDebugInspectorModule.m.

{
    NSString *name = [self name];
    if (name != nil)  return [NSString stringWithFormat:@"Group \"%@\"", name];
    else  return @"Anonymous group";
}

◆ inspDescription

- (NSString *) inspDescription

implementation

Provided by category OOShipGroup(OOInspectorExtensions).

Definition at line 1 of file OOShipGroupDebugInspectorModule.m.

{
    NSString *name = [self name];
    if (name != nil)  name = [NSString stringWithFormat:@"\"%@\"", name];
    else  name = @"anonymous";
    
    return [NSString stringWithFormat:@"%@, %lu ships", name, [self count]];
}

◆ isEmpty

- (BOOL) isEmpty

Definition at line 54 of file OOShipGroup.m.

{
    if (_count == 0)  return YES;
    
    return [[self objectEnumerator] nextObject] == nil;
}

◆ leader

- (ShipEntity *) leader

Definition at line 54 of file OOShipGroup.m.

{
    ShipEntity *result = [_leader weakRefUnderlyingObject];
    
    // If reference is stale, delete weakref object.
    if (result == nil && _leader != nil)
    {
        [_leader release];
        _leader = nil;
    }
    
    return result;
}

Referenced by ShipGroupAddShip(), and ShipGroupGetProperty().

Here is the caller graph for this function:

◆ memberArray

- (NSArray *) memberArray

Definition at line 54 of file OOShipGroup.m.

{
    id                      *objects = NULL;
    NSUInteger              count = 0;
    NSArray                 *result = nil;
    
    if (_count == 0)  return [NSArray array];
    
    objects = malloc(sizeof *objects * _count);
    for (id ship in self)
    {
        objects[count++] = ship;
    }
    
    result = [NSArray arrayWithObjects:objects count:count];
    free(objects);
    
    return result;
}

Referenced by ShipGroupGetProperty().

Here is the caller graph for this function:

◆ memberArrayExcludingLeader

- (NSArray *) memberArrayExcludingLeader

Definition at line 54 of file OOShipGroup.m.

{
    id                      *objects = NULL;
    NSUInteger              count = 0;
    NSArray                 *result = nil;
    ShipEntity              *leader = nil;
    
    if (_count == 0)  return [NSArray array];
    leader = self.leader;
    
    objects = malloc(sizeof *objects * _count);
    for (id ship in self)
    {
        if (ship != leader)
        {
            objects[count++] = ship;
        }
    }
    
    result = [NSArray arrayWithObjects:objects count:count];
    free(objects);
    
    return result;
}

Referenced by ShipGetProperty().

Here is the caller graph for this function:

◆ members

- (NSSet *) members

Definition at line 54 of file OOShipGroup.m.

{
    return [NSSet setWithArray:[self memberArray]];
}

◆ membersExcludingLeader

- (NSSet *) membersExcludingLeader

Definition at line 54 of file OOShipGroup.m.

{
    return [NSSet setWithArray:[self memberArrayExcludingLeader]];
}

◆ mutationSafeEnumerator

- (NSEnumerator *) mutationSafeEnumerator

Definition at line 54 of file OOShipGroup.m.

{
    return [[self memberArray] objectEnumerator];
}

◆ name

- (NSString *) name

Definition at line 54 of file OOShipGroup.m.

{
    return _name;
}

Referenced by ShipGroupGetProperty().

Here is the caller graph for this function:

◆ objectEnumerator

- (NSEnumerator *) objectEnumerator

Definition at line 54 of file OOShipGroup.m.

{
    return [[[OOShipGroupEnumerator alloc] initWithShipGroup:self] autorelease];
}

◆ oo_clearJSSelf:

- (void) oo_clearJSSelf: (JSObject *) selfVal

implementation

Provided by category OOShipGroup(OOJavaScriptExtensions).

Definition at line 353 of file OOJSShipGroup.m.

                       :(JSObject *)selfVal
{
    if (_jsSelf == selfVal)  _jsSelf = NULL;
}

◆ oo_jsValueInContext:

- (jsval) oo_jsValueInContext: (JSContext *) context

implementation

Provided by category OOShipGroup(OOJavaScriptExtensions).

Definition at line 353 of file OOJSShipGroup.m.

                             :(JSContext *)context
{
    jsval                   result = JSVAL_NULL;
    
    if (_jsSelf == NULL)
    {
        _jsSelf = JS_NewObject(context, &sShipGroupClass, sShipGroupPrototype, NULL);
        if (_jsSelf != NULL)
        {
            if (!JS_SetPrivate(context, _jsSelf, [self retain]))  _jsSelf = NULL;
        }
    }
    
    if (_jsSelf != NULL)  result = OBJECT_TO_JSVAL(_jsSelf);
    
    return result;
}

◆ removeShip:

- (BOOL) removeShip: (ShipEntity *) ship

Definition at line 54 of file OOShipGroup.m.

                   :(ShipEntity *)ship
{
    OOShipGroupEnumerator   *shipEnum = nil;
    ShipEntity              *containedShip = nil;
    NSUInteger              index;
    BOOL                    foundIt = NO;
    
    _updateCount++;
    
    if (ship == [self leader])  [self setLeader:nil];
    
    shipEnum = (OOShipGroupEnumerator *)[self objectEnumerator];
    [shipEnum setPerformCleanup:NO];
    while ((containedShip = [shipEnum nextObject]))
    {
        if ([ship isEqual:containedShip])
        {
            index = [shipEnum index] - 1;
            _members[index] = _members[--_count];
            foundIt = YES;
            
            // Clean up
            [ship setGroup:nil];
            [ship setOwner:ship];
            [self cleanUp];
            break;
        }
    }
    return foundIt;
}

◆ resizeTo:

- (BOOL) resizeTo: (NSUInteger) newCapacity

implementation

Provided by category OOShipGroup(Private).

Definition at line 54 of file OOShipGroup.m.

                 :(NSUInteger)newCapacity
{
    OOWeakReference         **temp = NULL;
    
    if (newCapacity < _count)  return NO;
    
    temp = realloc(_members, newCapacity * sizeof *_members);
    if (temp == NULL)  return NO;
    
    _members = temp;
    _capacity = newCapacity;
    return YES;
}

◆ setLeader:

- (void) setLeader: (ShipEntity *) leader

Definition at line 54 of file OOShipGroup.m.

                  :(ShipEntity *)leader
{
    _updateCount++;
    
    if (leader != [self leader])
    {
        [_leader release];
        [self addShip:leader];
        _leader = [leader weakRetain];
    }
}

Referenced by ShipGroupSetProperty().

Here is the caller graph for this function:

◆ setName:

- (void) setName: (NSString *) name

Definition at line 54 of file OOShipGroup.m.

                :(NSString *)name
{
    _updateCount++;
    
    if (_name != name)
    {
        [_name release];
        _name = [name retain];
    }
}

Referenced by ShipGroupSetProperty().

Here is the caller graph for this function:

◆ ShipGroupIterate

+ (static id) ShipGroupIterate (OOShipGroupEnumerator *) enumerator

implementation

Definition at line 473 of file OOShipGroup.m.

{
    // The work is done here so that we can have access to both OOShipGroup's and OOShipGroupEnumerator's ivars.
    
    OOShipGroup             *group = enumerator->_group;
    ShipEntity              *result = nil;
    BOOL                    cleanupNeeded = NO;
    
    if (enumerator->_updateCount != group->_updateCount)
    {
        [NSException raise:NSGenericException format:@"Collection <OOShipGroup: %p> was mutated while being enumerated.", group];
    }
    
    while (enumerator->_index < group->_count)
    {
        result = [group->_members[enumerator->_index] weakRefUnderlyingObject];
        if (result != nil)
        {
            enumerator->_index++;
            break;
        }
        
        // If we got here, the group contains a stale reference to a dead ship.
        group->_members[enumerator->_index] = group->_members[--group->_count];
        cleanupNeeded = YES;
    }
    
    // Clean-up handling. Only perform actual clean-up at end of iteration.
    if (enumerator->_considerCleanup)
    {
        enumerator->_cleanupNeeded = enumerator->_cleanupNeeded && cleanupNeeded;
        if (enumerator->_cleanupNeeded && result == nil)
        {
            [group cleanUp];
        }
    }
    
    return result;
}

◆ suppressClangStuff

- (BOOL) suppressClangStuff

implementation

Definition at line 473 of file OOShipGroup.m.

{
    return !_jsSelf;
}

◆ updateCount

- (NSUInteger) updateCount

implementation

Provided by category OOShipGroup(Private).

Definition at line 54 of file OOShipGroup.m.

{
    return _updateCount;
}

Member Data Documentation

◆ _jsSelf

- (struct JSObject*) _jsSelf

protected

Definition at line 45 of file OOShipGroup.h.

◆ _leader

- (OOWeakReference*) _leader

protected

Definition at line 42 of file OOShipGroup.h.

◆ _members

- (OOWeakReference**) _members

protected

Definition at line 41 of file OOShipGroup.h.

Referenced by countByEnumeratingWithState:objects:count:.

◆ _name

- (NSString*) _name

protected

Definition at line 43 of file OOShipGroup.h.

◆ _updateCount

- (<NSFastEnumeration> unsigned long) _updateCount

protected

Initial value:

{
@private
    NSUInteger              _count, _capacity

Definition at line 40 of file OOShipGroup.h.

Referenced by countByEnumeratingWithState:objects:count:.

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

src/Core/OOShipGroup.h
src/Core/OOShipGroup.m

Instance Methods

Class Methods

Protected Attributes

Detailed Description

Method Documentation

◆ addShip:

◆ cleanUp

◆ containsShip:

◆ count

◆ countByEnumeratingWithState:objects:count:

◆ dealloc

◆ debugInspectorModules

◆ descriptionComponents

◆ groupWithName:

◆ groupWithName:leader:

◆ init

◆ initWithName:

◆ inspBasicIdentityLine

◆ inspDescription

◆ isEmpty

◆ leader

◆ memberArray

◆ memberArrayExcludingLeader

◆ members

◆ membersExcludingLeader

◆ mutationSafeEnumerator

◆ name

◆ objectEnumerator

◆ oo_clearJSSelf:

◆ oo_jsValueInContext:

◆ removeShip:

◆ resizeTo:

◆ setLeader:

◆ setName:

◆ ShipGroupIterate

◆ suppressClangStuff

◆ updateCount

Member Data Documentation

◆ _jsSelf

◆ _leader

◆ _members

◆ _name

◆ _updateCount