OOAIStateMachineVerifierStage Class Reference

#include <OOAIStateMachineVerifierStage.h>

Inheritance diagram for OOAIStateMachineVerifierStage:

Collaboration diagram for OOAIStateMachineVerifierStage:

Instance Methods
(void)	- stateMachineNamed:usedByShip:
(void)	- dealloc [implementation]
(NSString *)	- name [implementation]
(BOOL)	- shouldRun [implementation]
(void)	- run [implementation]
(void)	- validateAI: [implementation]
Instance Methods inherited from OOFileHandlingVerifierStage
(NSSet *)	- dependencies [implementation]
(NSSet *)	- dependents [implementation]
Instance Methods inherited from OOOXPVerifierStage
(OOOXPVerifier *)	- verifier
(BOOL)	- completed
(id)	- init [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]

Class Methods
(NSString *)	+ nameForReverseDependencyForVerifier:

Private Attributes
NSSet *	_whitelist
NSMutableSet *	_usedAIs

Detailed Description

Definition at line 32 of file OOAIStateMachineVerifierStage.h.

Method Documentation

dealloc

- (void) dealloc

implementation

Reimplemented from OOOXPVerifierStage.

Definition at line 34 of file OOAIStateMachineVerifierStage.m.

{
    [_whitelist release];
    [_usedAIs release];
    
    [super dealloc];
}

name

- (NSString *) name

implementation

Reimplemented from OOOXPVerifierStage.

Definition at line 34 of file OOAIStateMachineVerifierStage.m.

{
    return kStageName;
}

nameForReverseDependencyForVerifier:

+ (NSString *) nameForReverseDependencyForVerifier:

(OOOXPVerifier *)

verifier

Definition at line 34 of file OOAIStateMachineVerifierStage.m.

                                                  :(OOOXPVerifier *)verifier
{
    return kStageName;
}

run

- (void) run

implementation

Reimplemented from OOOXPVerifierStage.

Definition at line 34 of file OOAIStateMachineVerifierStage.m.

{
    NSArray                     *aiNames = nil;
    NSString                    *aiName = nil;
    NSMutableSet                *whitelist = nil;
    
    // Build whitelist. Note that we merge in aliases since the distinction doesn't matter when just validating.
    whitelist = [[NSMutableSet alloc] init];
    [whitelist addObjectsFromArray:[[ResourceManager whitelistDictionary] oo_arrayForKey:@"ai_methods"]];
    [whitelist addObjectsFromArray:[[ResourceManager whitelistDictionary] oo_arrayForKey:@"ai_and_action_methods"]];
    [whitelist addObjectsFromArray:[[[ResourceManager whitelistDictionary] oo_dictionaryForKey:@"ai_method_aliases"] allKeys]];
    _whitelist = [whitelist copy];
    [whitelist release];
    
    aiNames = [[_usedAIs allObjects] sortedArrayUsingSelector:@selector(caseInsensitiveCompare:)];
    foreach (aiName, aiNames)
    {
        [self validateAI:aiName];
    }
    
    [_whitelist release];
    _whitelist = nil;
}

shouldRun

- (BOOL) shouldRun

implementation

Reimplemented from OOOXPVerifierStage.

Definition at line 34 of file OOAIStateMachineVerifierStage.m.

{
    return [_usedAIs count] != 0;
}

stateMachineNamed:usedByShip:

- (void) stateMachineNamed:		(NSString *)	name
usedByShip:		(NSString *)	shipName

Definition at line 34 of file OOAIStateMachineVerifierStage.m.

                          :(NSString *)name usedByShip:(NSString *)shipName
{
    OOFileScannerVerifierStage  *fileScanner = nil;
    
    if (name == nil)  return;
    if ([_usedAIs containsObject:name])  return;
    if (_usedAIs == nil)  _usedAIs = [[NSMutableSet alloc] init];
    [_usedAIs addObject:name];
    
    fileScanner = [[self verifier] fileScannerStage];
    if (![fileScanner fileExists:name
                        inFolder:@"AIs"
                  referencedFrom:[NSString stringWithFormat:@"shipdata.plist entry \"%@\"", shipName]
                    checkBuiltIn:YES])
    {
        OOLog(@"verifyOXP.validateAI.notFound", @"----- WARNING: AI state machine \"%@\" referenced in shipdata.plist entry \"%@\" could not be found in %@ or in Oolite.", name, shipName, [[self verifier] oxpDisplayName]);
    }
}

validateAI:

- (void) validateAI: (NSString *)  aiName

implementation

Provided by category OOAIStateMachineVerifierStage(Private).

Definition at line 34 of file OOAIStateMachineVerifierStage.m.

                   :(NSString *)aiName
{
    NSString                *path = nil;
    NSDictionary            *aiStateMachine = nil;
    NSString                *stateKey = nil;
    NSDictionary            *stateHandlers = nil;
    NSString                *handlerKey = nil;
    NSArray                 *handlerActions = nil;
    NSString                *action = nil;
    NSRange                 spaceRange;
    NSString                *selector = nil;
    NSMutableSet            *badSelectors = nil;
    NSString                *badSelectorDesc = nil;
    NSUInteger              index = 0;
    
    OOLog(@"verifyOXP.verbose.validateAI", @"- Validating AI \"%@\".", aiName);
    OOLogIndentIf(@"verifyOXP.verbose.validateAI");
    
    // Attempt to load AI.
    path = [[[self verifier] fileScannerStage] pathForFile:aiName inFolder:@"AIs" referencedFrom:@"AI list" checkBuiltIn:NO];
    if (path == nil)  return;
    
    badSelectors = [NSMutableSet set];
    
    aiStateMachine = OODictionaryFromFile(path);
    if (aiStateMachine == nil)
    {
        OOLog(@"verifyOXP.validateAI.failed.notDictPlist", @"***** ERROR: could not interpret \"%@\" as a dictionary.", path);
        return;
    }
    
    // Validate each state.
    foreachkey (stateKey, aiStateMachine)
    {
        stateHandlers = [aiStateMachine objectForKey:stateKey];
        if (![stateHandlers isKindOfClass:[NSDictionary class]])
        {
            OOLog(@"verifyOXP.validateAI.failed.invalidFormat.state", @"***** ERROR: state \"%@\" in AI \"%@\" is not a dictionary.", stateKey, aiName);
            continue;
        }
        
        // Verify handlers for this state.
        foreachkey (handlerKey, stateHandlers)
        {
            handlerActions = [stateHandlers objectForKey:handlerKey];
            if (![handlerActions isKindOfClass:[NSArray class]])
            {
                OOLog(@"verifyOXP.validateAI.failed.invalidFormat.handler", @"***** ERROR: handler \"%@\" for state \"%@\" in AI \"%@\" is not an array, ignoring.", handlerKey, stateKey, aiName);
                continue;
            }
            
            // Verify commands for this handler.
            index = 0;
            foreach (action, handlerActions)
            {
                index++;
                if (![action isKindOfClass:[NSString class]])
                {
                    OOLog(@"verifyOXP.validateAI.failed.invalidFormat.action", @"***** ERROR: action %llu in handler \"%@\" for state \"%@\" in AI \"%@\" is not a string, ignoring.", index - 1, handlerKey, stateKey, aiName);
                    continue;
                }
                
                // Trim spaces from beginning and end.
                action = [action stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceCharacterSet]];
                
                // Cut off parameters.
                spaceRange = [action rangeOfString:@" "];
                if (spaceRange.location == NSNotFound)  selector = action;
                else  selector = [action substringToIndex:spaceRange.location];
                
                // Check against whitelist.
                if (![_whitelist containsObject:selector])
                {
                    [badSelectors addObject:selector];
                }
            }
        }
    }
    
    if ([badSelectors count] != 0)
    {
        badSelectorDesc = [[[badSelectors allObjects] sortedArrayUsingSelector:@selector(caseInsensitiveCompare:)] componentsJoinedByString:@", "];
        OOLog(@"verifyOXP.validateAI.failed.badSelector", @"***** ERROR: the AI \"%@\" uses %llu unpermitted method%s: %@", aiName, [badSelectors count], ([badSelectors count] == 1) ? "" : "s", badSelectorDesc);
    }
    
    OOLogOutdentIf(@"verifyOXP.verbose.validateAI");
}

Member Data Documentation

_usedAIs

- (NSMutableSet*) _usedAIs

private

Definition at line 36 of file OOAIStateMachineVerifierStage.h.

_whitelist

- (NSSet*) _whitelist

private

Definition at line 35 of file OOAIStateMachineVerifierStage.h.

---

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

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