OOOXPVerifierStage Class Reference

#include <OOOXPVerifierStage.h>

Inheritance diagram for OOOXPVerifierStage:

Collaboration diagram for OOOXPVerifierStage:

Instance Methods
(OOOXPVerifier *)	- verifier
(BOOL)	- completed
(NSString *)	- name
(NSSet *)	- dependencies
(NSSet *)	- dependents
(BOOL)	- shouldRun
(void)	- run
(id)	- init [implementation]
(void)	- dealloc [implementation]
(id)	- description [implementation]
(void)	- setVerifier: [implementation]
(BOOL)	- isDependentOf: [implementation]
(void)	- registerDependency: [implementation]
(void)	- dependencyRegistrationComplete [implementation]
(BOOL)	- canRun [implementation]
(void)	- performRun [implementation]
(void)	- noteSkipped [implementation]
(NSSet *)	- resolvedDependencies [implementation]
(NSSet *)	- resolvedDependents [implementation]
(void)	- registerDepedent: [implementation]
(void)	- dependencyCompleted: [implementation]

Private Attributes
OOOXPVerifier *	_verifier
NSMutableSet *	_dependencies
NSMutableSet *	_incompleteDependencies
NSMutableSet *	_dependents
BOOL	_canRun
BOOL	_hasRun

Detailed Description

Definition at line 34 of file OOOXPVerifierStage.h.

Method Documentation

canRun

- (BOOL) canRun

implementation

Provided by category OOOXPVerifierStage(OOInternal).

Definition at line 1 of file OOOXPVerifierStage.m.

{
    return _canRun;
}

completed

- (BOOL) completed

Definition at line 1 of file OOOXPVerifierStage.m.

{
    return _hasRun;
}

dealloc

- (void) dealloc

implementation

Reimplemented in OOAIStateMachineVerifierStage, OOFileScannerVerifierStage, OOModelVerifierStage, and OOTextureVerifierStage.

Definition at line 1 of file OOOXPVerifierStage.m.

{
    [_dependencies release];
    [_incompleteDependencies release];
    [_dependents release];
    
    [super dealloc];
}

dependencies

- (NSSet *) dependencies

Reimplemented in OOFileHandlingVerifierStage, and OOListUnusedFilesStage.

Definition at line 1 of file OOOXPVerifierStage.m.

{
    return nil;
}

dependencyCompleted:

- (void) dependencyCompleted: (OOOXPVerifierStage *)  dependency

implementation

Provided by category OOOXPVerifierStage(OOPrivate).

Definition at line 1 of file OOOXPVerifierStage.m.

                           :(OOOXPVerifierStage *)dependency
{
    [_incompleteDependencies removeObject:dependency];
    if ([_incompleteDependencies count] == 0)  _canRun = YES;
}

dependencyRegistrationComplete

- (void) dependencyRegistrationComplete

implementation

Provided by category OOOXPVerifierStage(OOInternal).

Definition at line 1 of file OOOXPVerifierStage.m.

{
    _canRun = [_incompleteDependencies count] == 0;
}

dependents

- (NSSet *) dependents

Reimplemented in OOCheckShipDataPListVerifierStage, OOFileHandlingVerifierStage, and OOTextureHandlingStage.

Definition at line 1 of file OOOXPVerifierStage.m.

{
    return nil;
}

description

- (id) description

implementation

Definition at line 1 of file OOOXPVerifierStage.m.

{
    return [NSString stringWithFormat:@"<%@ %p>{\"%@\"}", [self class], self, [self name]];
}

init

- (id) init

implementation

Reimplemented in OOModelVerifierStage, and OOTextureVerifierStage.

Definition at line 1 of file OOOXPVerifierStage.m.

{
    self = [super init];
    
    if (self != nil)
    {
        _dependencies = [[NSMutableSet alloc] init];
        _incompleteDependencies = [[NSMutableSet alloc] init];
        _dependents = [[NSMutableSet alloc] init];
        _canRun = NO;
    }
    
    return self;
}

isDependentOf:

- (BOOL) isDependentOf: (OOOXPVerifierStage *)  stage

implementation

Provided by category OOOXPVerifierStage(OOInternal).

Definition at line 1 of file OOOXPVerifierStage.m.

                     :(OOOXPVerifierStage *)stage
{
    OOOXPVerifierStage      *directDep = nil;
    
    if (stage == nil)  return NO;
    
    // Direct dependency check.
    if ([_dependencies containsObject:stage])  return YES;
    
    // Recursive dependency check.
    foreach (directDep, _dependencies)
    {
        if ([directDep isDependentOf:stage])  return YES;
    }
    
    return NO;
}

name

- (NSString *) name

Reimplemented in OOAIStateMachineVerifierStage, OOCheckDemoShipsPListVerifierStage, OOCheckEquipmentPListVerifierStage, OOCheckJSSyntaxVerifierStage, OOCheckPListSyntaxVerifierStage, OOCheckRequiresPListVerifierStage, OOCheckShipDataPListVerifierStage, OOFileScannerVerifierStage, OOModelVerifierStage, and OOTextureVerifierStage.

Definition at line 1 of file OOOXPVerifierStage.m.

{
    OOLogGenericSubclassResponsibility();
    return nil;
}

noteSkipped

- (void) noteSkipped

implementation

Provided by category OOOXPVerifierStage(OOInternal).

Definition at line 1 of file OOOXPVerifierStage.m.

{
    assert(_canRun && !_hasRun);
    
    _hasRun = YES;
    _canRun = NO;
    [_dependents makeObjectsPerformSelector:@selector(dependencyCompleted:) withObject:self];
}

performRun

- (void) performRun

implementation

Provided by category OOOXPVerifierStage(OOInternal).

Definition at line 1 of file OOOXPVerifierStage.m.

{
    assert(_canRun && !_hasRun);
    
    OOLogPushIndent();
    @try
    {
        [self run];
    }
    @catch (NSException *exception)
    {
        OOLog(@"verifyOXP.exception", @"***** Exception while running verification stage \"%@\": %@", [self name], exception);
    }
    OOLogPopIndent();
    
    _hasRun = YES;
    _canRun = NO;
    [_dependents makeObjectsPerformSelector:@selector(dependencyCompleted:) withObject:self];
}

registerDepedent:

- (void) registerDepedent: (OOOXPVerifierStage *)  dependent

implementation

Provided by category OOOXPVerifierStage(OOPrivate).

Definition at line 1 of file OOOXPVerifierStage.m.

                        :(OOOXPVerifierStage *)dependent
{
    assert(![self isDependentOf:dependent]);
    
    [_dependents addObject:dependent];
}

registerDependency:

- (void) registerDependency: (OOOXPVerifierStage *)  dependency

implementation

Provided by category OOOXPVerifierStage(OOInternal).

Definition at line 1 of file OOOXPVerifierStage.m.

                          :(OOOXPVerifierStage *)dependency
{
    [_dependencies addObject:dependency];
    [_incompleteDependencies addObject:dependency];
    
    [dependency registerDepedent:self];
}

resolvedDependencies

- (NSSet *) resolvedDependencies

implementation

Provided by category OOOXPVerifierStage(OOInternal).

Definition at line 1 of file OOOXPVerifierStage.m.

{
    return _dependencies;
}

resolvedDependents

- (NSSet *) resolvedDependents

implementation

Provided by category OOOXPVerifierStage(OOInternal).

Definition at line 1 of file OOOXPVerifierStage.m.

{
    return _dependents;
}

run

- (void) run

Reimplemented in OOAIStateMachineVerifierStage, OOCheckDemoShipsPListVerifierStage, OOCheckEquipmentPListVerifierStage, OOCheckJSSyntaxVerifierStage, OOCheckPListSyntaxVerifierStage, OOCheckRequiresPListVerifierStage, OOCheckShipDataPListVerifierStage, OOFileScannerVerifierStage, OOListUnusedFilesStage, OOModelVerifierStage, and OOTextureVerifierStage.

Definition at line 1 of file OOOXPVerifierStage.m.

{
    OOLogGenericSubclassResponsibility();
}

setVerifier:

- (void) setVerifier: (OOOXPVerifier *)  verifier

implementation

Provided by category OOOXPVerifierStage(OOInternal).

Definition at line 1 of file OOOXPVerifierStage.m.

                   :(OOOXPVerifier *)verifier
{
    _verifier = verifier;   // Not retained.
}

shouldRun

- (BOOL) shouldRun

Reimplemented in OOAIStateMachineVerifierStage, OOCheckDemoShipsPListVerifierStage, OOCheckEquipmentPListVerifierStage, OOCheckJSSyntaxVerifierStage, OOCheckPListSyntaxVerifierStage, OOCheckRequiresPListVerifierStage, OOCheckShipDataPListVerifierStage, OOModelVerifierStage, and OOTextureVerifierStage.

Definition at line 1 of file OOOXPVerifierStage.m.

{
    return YES;
}

verifier

- (OOOXPVerifier *) verifier

Definition at line 1 of file OOOXPVerifierStage.m.

{
    return [[_verifier retain] autorelease];
}

Member Data Documentation

_canRun

- (BOOL) _canRun

private

Definition at line 41 of file OOOXPVerifierStage.h.

_dependencies

- (NSMutableSet*) _dependencies

private

Definition at line 38 of file OOOXPVerifierStage.h.

_dependents

- (NSMutableSet*) _dependents

private

Definition at line 40 of file OOOXPVerifierStage.h.

_hasRun

- (BOOL) _hasRun

private

Definition at line 41 of file OOOXPVerifierStage.h.

_incompleteDependencies

- (NSMutableSet*) _incompleteDependencies

private

Definition at line 39 of file OOOXPVerifierStage.h.

_verifier

- (OOOXPVerifier*) _verifier

private

Definition at line 37 of file OOOXPVerifierStage.h.

---

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

• src/Core/OXPVerifier/OOOXPVerifierStage.h
• src/Core/OXPVerifier/OOOXPVerifierStage.m