OOCheckEquipmentPListVerifierStage Class Reference

#include <OOCheckEquipmentPListVerifierStage.h>

Inheritance diagram for OOCheckEquipmentPListVerifierStage:

Collaboration diagram for OOCheckEquipmentPListVerifierStage:

Instance Methods
(NSString *)	- name [implementation]
(BOOL)	- shouldRun [implementation]
(void)	- run [implementation]
(void)	- runCheckWithEquipment: [implementation]
Instance Methods inherited from OOFileHandlingVerifierStage
(NSSet *)	- dependencies [implementation]
(NSSet *)	- dependents [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]

Detailed Description

Definition at line 32 of file OOCheckEquipmentPListVerifierStage.h.

Method Documentation

name

- (NSString *) name

implementation

Reimplemented from OOOXPVerifierStage.

Definition at line 34 of file OOCheckEquipmentPListVerifierStage.m.

{
    return kStageName;
}

run

- (void) run

implementation

Reimplemented from OOOXPVerifierStage.

Definition at line 34 of file OOCheckEquipmentPListVerifierStage.m.

{
    OOFileScannerVerifierStage  *fileScanner = nil;
    NSArray                     *equipmentPList = nil;
    
    fileScanner = [[self verifier] fileScannerStage];
    
    equipmentPList = [fileScanner plistNamed:@"equipment.plist"
                                    inFolder:@"Config"
                              referencedFrom:nil
                                checkBuiltIn:NO];
    
    if (equipmentPList == nil)  return;
    
    // Check that it's an array
    if (![equipmentPList isKindOfClass:[NSArray class]])
    {
        OOLog(@"verifyOXP.equipmentPList.notArray", @"%@", @"***** ERROR: equipment.plist is not an array.");
        return;
    }
    
    
    [self runCheckWithEquipment:equipmentPList];
}

runCheckWithEquipment:

- (void) runCheckWithEquipment: (NSArray *)  equipmentPList

implementation

Provided by category OOCheckEquipmentPListVerifierStage(OOPrivate).

Definition at line 34 of file OOCheckEquipmentPListVerifierStage.m.

                             :(NSArray *)equipmentPList
{
    NSArray                     *entry = nil;
    unsigned                    entryIndex = 0;
    NSUInteger                  elemCount;
    NSString                    *name = nil;
    NSString                    *entryDesc = nil;
    
    foreach (entry, equipmentPList)
    {
        ++entryIndex;
        
        // Entries should be arrays.
        if (![entry isKindOfClass:[NSArray class]])
        {
            OOLog(@"verifyOXP.equipmentPList.entryNotArray", @"***** ERROR: equipment.plist entry %u of equipment.plist is not an array.", entryIndex);
            continue;
        }
        
        elemCount = [entry count];
        
        // Make a name for entry for display purposes.
        if (EQUIPMENT_KEY_INDEX < elemCount)  name = [entry oo_stringAtIndex:EQUIPMENT_KEY_INDEX];
        else  name = nil;
        
        if (name != nil)  entryDesc = [NSString stringWithFormat:@"%u (\"%@\")", entryIndex, name];
        else  entryDesc = [NSString stringWithFormat:@"%u", entryIndex];
        
        // Check that the entry has an acceptable number of elements.
        if (elemCount < 5)
        {
            OOLog(@"verifyOXP.equipmentPList.badEntrySize", @"***** ERROR: equipment.plist entry %@ has too few elements (%llu, should be 5 or 6).", entryDesc, elemCount);
            continue;
        }
        if (6 < elemCount)
        {
            OOLog(@"verifyOXP.equipmentPList.badEntrySize", @"----- WARNING: equipment.plist entry %@ has too many elements (%llu, should be 5 or 6).", entryDesc, elemCount);
        }
        
        /*  Check element types. The numbers are required to be unsigned
            integers; the use of a negative default will catch both negative
            values and unconvertable values.
        */
        if ([entry oo_longAtIndex:EQUIPMENT_TECH_LEVEL_INDEX defaultValue:-1] < 0)
        {
            OOLog(@"verifyOXP.equipmentPList.badElementType", @"***** ERROR: tech level for entry %@ of equipment.plist is not a positive integer.", entryDesc);
        }
        if ([entry oo_longAtIndex:EQUIPMENT_PRICE_INDEX defaultValue:-1] < 0)
        {
            OOLog(@"verifyOXP.equipmentPList.badElementType", @"***** ERROR: price for entry %@ of equipment.plist is not a positive integer.", entryDesc);
        }
        if ([entry oo_stringAtIndex:EQUIPMENT_SHORT_DESC_INDEX] == nil)
        {
            OOLog(@"verifyOXP.equipmentPList.badElementType", @"***** ERROR: short description for entry %@ of equipment.plist is not a string.", entryDesc);
        }
        if ([entry oo_stringAtIndex:EQUIPMENT_KEY_INDEX] == nil)
        {
            OOLog(@"verifyOXP.equipmentPList.badElementType", @"***** ERROR: key for entry %@ of equipment.plist is not a string.", entryDesc);
        }
        if ([entry oo_stringAtIndex:EQUIPMENT_LONG_DESC_INDEX] == nil)
        {
            OOLog(@"verifyOXP.equipmentPList.badElementType", @"***** ERROR: long description for entry %@ of equipment.plist is not a string.", entryDesc);
        }
        
        if (5 < elemCount)
        {
            if ([entry oo_dictionaryAtIndex:EQUIPMENT_EXTRA_INFO_INDEX] == nil)
            {
                OOLog(@"verifyOXP.equipmentPList.badElementType", @"***** ERROR: equipment.plist entry %@'s extra information dictionary is not a dictionary.", entryDesc);
            }
            // TODO: verify contents of extra info dictionary.
        }
    }
}

shouldRun

- (BOOL) shouldRun

implementation

Reimplemented from OOOXPVerifierStage.

Definition at line 34 of file OOCheckEquipmentPListVerifierStage.m.

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

---

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

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