#include <OOCheckShipDataPListVerifierStage.h>

Inheritance diagram for OOCheckShipDataPListVerifierStage:

Collaboration diagram for OOCheckShipDataPListVerifierStage:

Instance Methods
(NSString *)	- name `[implementation]`

(NSSet *)	- dependents `[implementation]`

(BOOL)	- shouldRun `[implementation]`

(void)	- run `[implementation]`

(void)	- verifyShipInfo:withName: `[implementation]`

(void)	- message: `[implementation]`

(void)	- verboseMessage: `[implementation]`

(void)	- getRoles `[implementation]`

(void)	- checkKeys `[implementation]`

(void)	- checkSchema `[implementation]`

(void)	- checkModel `[implementation]`

(NSSet *)	- rolesFromString: `[implementation]`

(BOOL)	- verifier:withPropertyList:named:testProperty:atPath:againstType:error: `[implementation]`

(BOOL)	- verifier:withPropertyList:named:failedForProperty:withError:expectedType: `[implementation]`

Instance Methods inherited from OOFileHandlingVerifierStage
(NSSet *)	- dependencies `[implementation]`

Instance Methods inherited from OOOXPVerifierStage
(OOOXPVerifier *)	- verifier

(BOOL)	- completed

(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
NSDictionary *	_shipdataPList

NSSet *	_ooliteShipNames

NSSet *	_basicKeys

NSSet *	_stationKeys

NSSet *	_playerKeys

NSSet *	_allKeys

OOPListSchemaVerifier *	_schemaVerifier

OOAIStateMachineVerifierStage *	_aiVerifierStage

NSString *	_name

NSDictionary *	_info

NSSet *	_roles

uint32_t	_isStation: 1

uint32_t	_isPlayer: 1

uint32_t	_isTemplate: 1

uint32_t	_havePrintedMessage: 1

Detailed Description

Definition at line 34 of file OOCheckShipDataPListVerifierStage.h.

Method Documentation

◆ checkKeys

- (void) checkKeys

implementation

Provided by category OOCheckShipDataPListVerifierStage(OOPrivate).

Definition at line 39 of file OOCheckShipDataPListVerifierStage.m.

{
    NSSet                       *referenceSet = nil;
    NSEnumerator                *keyEnum = nil;
    NSString                    *key = nil;
    
    if (_isPlayer)  referenceSet = _playerKeys;
    else if (_isStation)  referenceSet = _stationKeys;
    else  referenceSet = _basicKeys;
    
    for (keyEnum = [_info keyEnumerator]; (key = [keyEnum nextObject]); )
    {
        if (![referenceSet containsObject:key])
        {
            if ([_allKeys containsObject:key])
            {
                if (!_isTemplate)
                {
                    // if it's a template, this key might apply to a descendant
                    // as happens in the core files
                    [self message:@"----- WARNING: key \"%@\" does not apply to this category of ship.", key];
                }
            }
            else
            {
                [self message:@"----- WARNING: unknown key \"%@\".", key];
            }
        }
    }
}

◆ checkModel

- (void) checkModel

implementation

Provided by category OOCheckShipDataPListVerifierStage(OOPrivate).

Definition at line 39 of file OOCheckShipDataPListVerifierStage.m.

{
    id                          model = nil,
                                materials = nil,
                                shaders = nil;
    
    model = [_info oo_stringForKey:@"model"];
    materials = [_info oo_dictionaryForKey:@"materials"];
    shaders = [_info oo_dictionaryForKey:@"shaders"];
    
    if (model != nil)
    {
        if (![[[self verifier] modelVerifierStage] modelNamed:model
                                                 usedForEntry:_name
                                                       inFile:@"shipdata.plist"
                                                withMaterials:materials
                                                   andShaders:shaders])
        {
            [self message:@"----- WARNING: model \"%@\" could not be found in %@ or in Oolite.", model, [[self verifier] oxpDisplayName]];
        }
    }
    else
    {
        if ([_info oo_stringForKey:@"like_ship"] == nil)
        {
            [self message:@"***** ERROR: ship does not specify model or like_ship."];
        }
    }
}

◆ checkSchema

- (void) checkSchema

implementation

Provided by category OOCheckShipDataPListVerifierStage(OOPrivate).

Definition at line 39 of file OOCheckShipDataPListVerifierStage.m.

{
    [_schemaVerifier verifyPropertyList:_info named:_name];
}

◆ dependents

- (NSSet *) dependents

implementation

Reimplemented from OOTextureHandlingStage.

Definition at line 39 of file OOCheckShipDataPListVerifierStage.m.

{
    NSMutableSet *result = [[super dependents] mutableCopy];
    [result addObject:[OOModelVerifierStage nameForReverseDependencyForVerifier:[self verifier]]];
    [result addObject:[OOAIStateMachineVerifierStage nameForReverseDependencyForVerifier:[self verifier]]];
    return [result autorelease];
}

◆ getRoles

- (void) getRoles

implementation

Provided by category OOCheckShipDataPListVerifierStage(OOPrivate).

Definition at line 39 of file OOCheckShipDataPListVerifierStage.m.

{
    NSString                    *rolesString = nil;
    
    rolesString = [_info objectForKey:@"roles"];
    _roles = [self rolesFromString:rolesString];
    _isPlayer = [_roles containsObject:@"player"];
    _isStation = [_info oo_boolForKey:@"is_carrier" defaultValue:NO] ||
                 [_info oo_boolForKey:@"isCarrier" defaultValue:NO] ||
                 [rolesString rangeOfString:@"station"].location != NSNotFound ||
                 [rolesString rangeOfString:@"carrier"].location != NSNotFound;
    // the is_carrier or isCarrier key will be missed when it was insise a like_ship definition.
    _isTemplate = [_info oo_boolForKey:@"is_template" defaultValue:NO];
 
    if (_isPlayer && _isStation)
    {
        [self message:@"***** ERROR: ship is both a player ship and a station. Treating as non-station."];
        _isStation = NO;
    }
}

◆ message:

- (void) message:	(NSString *)	format
,		...

implementation

Provided by category OOCheckShipDataPListVerifierStage(OOPrivate).

Definition at line 39 of file OOCheckShipDataPListVerifierStage.m.

               :(NSString *)format, ...
{
    va_list                     args;
    
    if (!_havePrintedMessage)
    {
        OOLog(@"verifyOXP.shipData.firstMessage", @"Ship \"%@\":", _name);
        OOLogIndent();
        _havePrintedMessage = YES;
    }
    
    va_start(args, format);
    OOLogWithFunctionFileAndLineAndArguments(@"verifyOXP.shipData", NULL, NULL, 0, format, args);
    va_end(args);
}

◆ name

- (NSString *) name

implementation

Reimplemented from OOOXPVerifierStage.

Definition at line 39 of file OOCheckShipDataPListVerifierStage.m.

{
    return kStageName;
}

◆ rolesFromString:

- (NSSet *) rolesFromString: (NSString *) string

implementation

Provided by category OOCheckShipDataPListVerifierStage(OOPrivate).

Definition at line 39 of file OOCheckShipDataPListVerifierStage.m.

                          :(NSString *)string
{
    NSArray                     *parts = nil;
    NSMutableSet                *result = nil;
    NSUInteger                  i, count;
    NSString                    *role = nil;
    NSRange                     parenRange;
    
    if (string == nil)  return [NSSet set];
    
    parts = ScanTokensFromString(string);
    count = [parts count];
    if (count == 0)  return [NSSet set];
    
    result = [NSMutableSet setWithCapacity:count];
    for (i = 0; i != count; ++i)
    {
        role = [parts objectAtIndex:i];
        parenRange = [role rangeOfString:@"("];
        if (parenRange.location != NSNotFound)
        {
            role = [role substringToIndex:parenRange.location];
        }
        [result addObject:role];
    }
    
    return result;
}

◆ run

- (void) run

implementation

Reimplemented from OOOXPVerifierStage.

Definition at line 39 of file OOCheckShipDataPListVerifierStage.m.

{
    OOFileScannerVerifierStage  *fileScanner = nil;
    NSAutoreleasePool           *pool = nil;
    NSEnumerator                *shipEnum = nil;
    NSString                    *shipKey = nil;
    NSDictionary                *shipInfo = nil;
    NSDictionary                *ooliteShipData = nil;
    NSDictionary                *settings = nil;
    NSMutableSet                *mergeSet = nil;
    NSArray                     *shipList = nil;
    
    fileScanner = [[self verifier] fileScannerStage];
    _shipdataPList = [fileScanner plistNamed:@"shipdata.plist"
                                    inFolder:@"Config"
                              referencedFrom:nil
                                checkBuiltIn:NO];
    
    if (_shipdataPList == nil)  return;
    
    // Get AI verifier stage (may be nil).
    _aiVerifierStage = [[self verifier] stageWithName:[OOAIStateMachineVerifierStage nameForReverseDependencyForVerifier:[self verifier]]];
    
    ooliteShipData = [ResourceManager dictionaryFromFilesNamed:@"shipdata.plist"
                                                      inFolder:@"Config"
                                                      andMerge:YES];
    
    // Check that it's a dictionary
    if (![_shipdataPList isKindOfClass:[NSDictionary class]])
    {
        OOLog(@"verifyOXP.shipdataPList.notDict", @"%@", @"***** ERROR: shipdata.plist is not a dictionary.");
        return;
    }
    
    // Keys that apply to all ships
    _ooliteShipNames = [NSSet setWithArray:[ooliteShipData allKeys]];
    settings = [[self verifier] configurationDictionaryForKey:@"shipdataPListSettings"];
    _basicKeys = [settings oo_setForKey:@"knownShipKeys"];
    
    // Keys that apply to stations/carriers
    mergeSet = [_basicKeys mutableCopy];
    [mergeSet addObjectsFromArray:[settings oo_arrayForKey:@"knownStationKeys"]];
    _stationKeys = mergeSet;
    
    // Keys that apply to player ships
    mergeSet = [_basicKeys mutableCopy];
    [mergeSet addObjectsFromArray:[settings oo_arrayForKey:@"knownPlayerKeys"]];
    _playerKeys = [[mergeSet copy] autorelease];
    
    // Keys that apply to _any_ ship -- union of the above
    [mergeSet unionSet:_stationKeys];
    _allKeys = mergeSet;
    
    _schemaVerifier = [OOPListSchemaVerifier verifierWithSchema:[ResourceManager dictionaryFromFilesNamed:@"shipdataEntrySchema.plist" inFolder:@"Schemata" andMerge:NO]];
    [_schemaVerifier setDelegate:self];
    
    shipList = [[_shipdataPList allKeys] sortedArrayUsingSelector:@selector(caseInsensitiveCompare:)];
    for (shipEnum = [shipList objectEnumerator]; (shipKey = [shipEnum nextObject]); )
    {
        pool = [[NSAutoreleasePool alloc] init];
        
        shipInfo = [_shipdataPList oo_dictionaryForKey:shipKey];
        if (shipInfo == nil)
        {
            OOLog(@"verifyOXP.shipdata.badType", @"***** ERROR: shipdata.plist entry for \"%@\" is not a dictionary.", shipKey);
        }
        else
        {
            [self verifyShipInfo:shipInfo withName:shipKey];
        }
        
        [pool release];
    }
    
    _shipdataPList = nil;
    _ooliteShipNames = nil;
    _basicKeys = nil;
    _stationKeys = nil;
    _playerKeys = nil;
}

◆ shouldRun

- (BOOL) shouldRun

implementation

Reimplemented from OOOXPVerifierStage.

Definition at line 39 of file OOCheckShipDataPListVerifierStage.m.

{
    OOFileScannerVerifierStage  *fileScanner = nil;
    
    fileScanner = [[self verifier] fileScannerStage];
    return [fileScanner fileExists:@"shipdata.plist"
                          inFolder:@"Config"
                    referencedFrom:nil
                      checkBuiltIn:NO];
}

◆ verboseMessage:

- (void) verboseMessage:	(NSString *)	format
,		...

implementation

Provided by category OOCheckShipDataPListVerifierStage(OOPrivate).

Definition at line 39 of file OOCheckShipDataPListVerifierStage.m.

                      :(NSString *)format, ...
{
    va_list                     args;
    
    if (!OOLogWillDisplayMessagesInClass(@"verifyOXP.verbose.shipData"))  return;
    
    if (!_havePrintedMessage)
    {
        OOLog(@"verifyOXP.shipData.firstMessage", @"Ship \"%@\":", _name);
        OOLogIndent();
        _havePrintedMessage = YES;
    }
    
    va_start(args, format);
    OOLogWithFunctionFileAndLineAndArguments(@"verifyOXP.verbose.shipData", NULL, NULL, 0, format, args);
    va_end(args);
}

◆ verifier:withPropertyList:named:failedForProperty:withError:expectedType:

- (BOOL) verifier:	(OOPListSchemaVerifier *)	verifier
withPropertyList:	(id)	rootPList
named:	(NSString *)	name
failedForProperty:	(id)	subPList
withError:	(NSError *)	error
expectedType:	(NSDictionary *)	localSchema

implementation

Provided by category OOCheckShipDataPListVerifierStage(OOPrivate).

Definition at line 39 of file OOCheckShipDataPListVerifierStage.m.

                :(OOPListSchemaVerifier *)verifier
withPropertyList:(id)rootPList
           named:(NSString *)name
 failedForProperty:(id)subPList
       withError:(NSError *)error
    expectedType:(NSDictionary *)localSchema
{
    // FIXME: use fancy new error codes to provide useful error descriptions.
    [self message:@"***** ERROR: verification of ship \"%@\" failed at \"%@\": %@", name, [error plistKeyPathDescription], [error localizedFailureReason]];
    return YES;
}

◆ verifier:withPropertyList:named:testProperty:atPath:againstType:error:

- (BOOL) verifier:	(OOPListSchemaVerifier *)	verifier
withPropertyList:	(id)	rootPList
named:	(NSString *)	name
testProperty:	(id)	subPList
atPath:	(NSArray *)	keyPath
againstType:	(NSString *)	typeKey
error:	(NSError **)	outError

implementation

Provided by category OOCheckShipDataPListVerifierStage(OOPrivate).

Definition at line 39 of file OOCheckShipDataPListVerifierStage.m.

                :(OOPListSchemaVerifier *)verifier
withPropertyList:(id)rootPList
           named:(NSString *)name
    testProperty:(id)subPList
          atPath:(NSArray *)keyPath
     againstType:(NSString *)typeKey
           error:(NSError **)outError
{
    [self verboseMessage:@"- Skipping verification for type %@ at %@.%@.", typeKey, _name, [OOPListSchemaVerifier descriptionForKeyPath:keyPath]];
    return YES;
}

◆ verifyShipInfo:withName:

- (void) verifyShipInfo:	(NSDictionary *)	info
withName:	(NSString *)	name

implementation

Provided by category OOCheckShipDataPListVerifierStage(OOPrivate).

Definition at line 39 of file OOCheckShipDataPListVerifierStage.m.

                      :(NSDictionary *)info withName:(NSString *)name
{
    _name = name;
    _info = info;
    _havePrintedMessage = NO;
    OOLogPushIndent();
    
    [self getRoles];
    [self checkKeys];
    [self checkSchema];
    [self checkModel];
    
    NSString *aiName = [info oo_stringForKey:@"ai_type"];
    if (aiName != nil) 
    {
        if (![aiName hasSuffix:@".js"])
        {
            [_aiVerifierStage stateMachineNamed:aiName usedByShip:name];
        }
    }
    
    // Todo: check for pirates with 0 bounty
    
    OOLogPopIndent();
    if (!_havePrintedMessage)
    {
        OOLog(@"verifyOXP.verbose.shipData.OK", @"- ship \"%@\" OK.", _name);
    }
    _name = nil;
    _info = nil;
    _roles = nil;
}