AI(OOPrivate) Category Reference

Instance Methods
(void)	- performDeferredCall:withObject:afterDelay:
(void)	- refreshOwnerDesc
(void)	- directSetStateMachine:name:
(void)	- directSetState:
(NSDictionary *)	- loadStateMachine:jsName:
(NSDictionary *)	- cleanHandlers:forState:stateMachine:
(NSArray *)	- cleanActions:forHandler:state:stateMachine:

Class Methods
(void)	+ deferredCallTrampolineWithInfo:

Detailed Description

Definition at line 55 of file AI.m.

Method Documentation

cleanActions:forHandler:state:stateMachine:

- (NSArray *) cleanActions:		(NSArray *)	actions
forHandler:		(NSString *)	handlerKey
state:		(NSString *)	stateKey
stateMachine:		(NSString *)	smName

Definition at line 397 of file AI.m.

                          :(NSArray *)actions forHandler:(NSString *)handlerKey state:(NSString *)stateKey stateMachine:(NSString *)smName
{
    NSString                *action = nil;
    NSRange                 spaceRange;
    NSString                *selector = nil;
    id                      aliasedSelector = nil;
    NSMutableArray          *result = nil;
    static NSSet            *whitelist = nil;
    static NSDictionary     *aliases = nil;
    NSArray                 *whitelistArray1 = nil;
    NSArray                 *whitelistArray2 = nil;
    
    if (whitelist == nil)
    {
        whitelistArray1 = [[ResourceManager whitelistDictionary] oo_arrayForKey:@"ai_methods"];
        if (whitelistArray1 == nil)  whitelistArray1 = [NSArray array];
        whitelistArray2 = [[ResourceManager whitelistDictionary] oo_arrayForKey:@"ai_and_action_methods"];
        if (whitelistArray2 != nil)  whitelistArray1 = [whitelistArray1 arrayByAddingObjectsFromArray:whitelistArray2];
        
        whitelist = [[NSSet alloc] initWithArray:whitelistArray1];
        aliases = [[[ResourceManager whitelistDictionary] oo_dictionaryForKey:@"ai_method_aliases"] retain];
    }
    
    result = [NSMutableArray arrayWithCapacity:[actions count]];
    foreach (action, actions)
    {
        if (![action isKindOfClass:[NSString class]])
        {
            OOLogWARN(@"ai.invalidFormat.action", @"An action in handler \"%@\" for state \"%@\" in AI \"%@\" is not a string, ignoring.", handlerKey, stateKey, smName);
            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];
        
        // Look in alias table.
        aliasedSelector = [aliases objectForKey:selector];
        if (aliasedSelector != nil)
        {
            if ([aliasedSelector isKindOfClass:[NSString class]])
            {
                // Change selector and action to use real method name.
                selector = aliasedSelector;
                if (spaceRange.location == NSNotFound)  action = aliasedSelector;
                else action = [aliasedSelector stringByAppendingString:[action substringFromIndex:spaceRange.location]];
            }
            else if ([aliasedSelector isKindOfClass:[NSArray class]] && [aliasedSelector count] != 0)
            {
                // Alias is complete expression, pretokenized in anticipation of a tokenized future.
                action = [aliasedSelector componentsJoinedByString:@" "];
                selector = [[aliasedSelector objectAtIndex:0] description];
            }
        }
        
        // Check for selector in whitelist.
        if (![whitelist containsObject:selector])
        {
            OOLog(@"ai.unpermittedMethod", @"Handler \"%@\" for state \"%@\" in AI \"%@\" uses \"%@\", which is not a permitted AI method.", handlerKey, stateKey, smName, selector);
            continue;
        }
        
        [result addObject:action];
    }
    
    // Return immutable copy.
    return [[result copy] autorelease];
}

cleanHandlers:forState:stateMachine:

- (NSDictionary *) cleanHandlers:		(NSDictionary *)	handlers
forState:		(NSString *)	stateKey
stateMachine:		(NSString *)	smName

Definition at line 397 of file AI.m.

                                :(NSDictionary *)handlers forState:(NSString *)stateKey stateMachine:(NSString *)smName
{
    NSString                *handlerKey = nil;
    NSArray                 *handlerActions = nil;
    NSMutableDictionary     *result = nil;
    
    result = [NSMutableDictionary dictionaryWithCapacity:[handlers count]];
    foreachkey (handlerKey, handlers)
    {
        handlerActions = [handlers objectForKey:handlerKey];
        if (![handlerActions isKindOfClass:[NSArray class]])
        {
            OOLogWARN(@"ai.invalidFormat.handler", @"Handler \"%@\" for state \"%@\" in AI \"%@\" is not an array, ignoring.", handlerKey, stateKey, smName);
            continue;
        }
        
        handlerActions = [self cleanActions:handlerActions forHandler:handlerKey state:stateKey stateMachine:smName];
        [result setObject:handlerActions forKey:handlerKey];
    }
    
    // Return immutable copy.
    return [[result copy] autorelease];
}

deferredCallTrampolineWithInfo:

+ (void) deferredCallTrampolineWithInfo:

(NSValue *)

info

Definition at line 397 of file AI.m.

                                      :(NSValue *)info
{
    OOAIDeferredCallTrampolineInfo  infoStruct;
    
    if (info != nil)
    {
        assert(strcmp([info objCType], @encode(OOAIDeferredCallTrampolineInfo)) == 0);
        [info getValue:&infoStruct];
        
        [infoStruct.ai performSelector:infoStruct.selector withObject:infoStruct.parameter];
        
        [infoStruct.ai release];
        [infoStruct.parameter release];
    }
}

directSetState:

- (void) directSetState:

(NSString *)

state

Definition at line 397 of file AI.m.

                       :(NSString *)state
{
    if (currentState != state)
    {
        [currentState release];
        currentState = [state copy];
    }
}

directSetStateMachine:name:

- (void) directSetStateMachine:		(NSDictionary *)	newSM
name:		(NSString *)	name

Definition at line 397 of file AI.m.

                              :(NSDictionary *)newSM name:(NSString *)name
{
    if (stateMachine != newSM)
    {
        [stateMachine release];
        stateMachine = [newSM copy];
    }
    if (stateMachineName != name)
    {
        [stateMachineName release];
        stateMachineName = [name copy];
    }
}

loadStateMachine:jsName:

- (NSDictionary *) loadStateMachine:		(NSString *)	smName
jsName:		(NSString *)	script

Definition at line 397 of file AI.m.

                                   :(NSString *)smName jsName:(NSString *)script
{
    NSDictionary            *newSM = nil;
    NSMutableDictionary     *cleanSM = nil;
    OOCacheManager          *cacheMgr = [OOCacheManager sharedCache];
    NSString                *stateKey = nil;
    NSDictionary            *stateHandlers = nil;
    NSAutoreleasePool       *pool = nil;
    
    if (![smName isEqualToString:@"nullAI.plist"])
    {
        // don't cache nullAI since they're different depending on associated JS AI
        newSM = [cacheMgr objectForKey:smName inCache:@"AIs"];
        if (newSM != nil && ![newSM isKindOfClass:[NSDictionary class]])  return nil;   // catches use of @"nil" to indicate no AI found.
    }
    
    if (newSM == nil)
    {
        pool = [[NSAutoreleasePool alloc] init];
        OOLog(@"ai.load", @"Loading and sanitizing AI \"%@\"", smName);
        OOLogPushIndent();
        OOLogIndentIf(@"ai.load");
        
        @try
        {
            // Load state machine and validate against whitelist.
            NSString *aiPath = [ResourceManager pathForFileNamed:smName inFolder:@"AIs"];
            if (aiPath != nil)
            {
                newSM = OODictionaryFromFile(aiPath);
            }
            if (newSM == nil)
            {
                [cacheMgr setObject:@"nil" forKey:smName inCache:@"AIs"];
                NSString *fromString = @"";
                if ([self state] != nil)
                {
                    fromString = [NSString stringWithFormat:@" from %@:%@", [self name], [self state]];
                }
                OOLog(@"ai.load.failed.unknownAI", @"Can't switch AI for %@%@ to \"%@\" - could not load file.", [[self owner] shortDescription], fromString, smName);
                return nil;
            }
            
            cleanSM = [NSMutableDictionary dictionaryWithCapacity:[newSM count]];
            
            foreachkey (stateKey, newSM)
            {
                stateHandlers = [newSM objectForKey:stateKey];
                if (![stateHandlers isKindOfClass:[NSDictionary class]])
                {
                    OOLogWARN(@"ai.invalidFormat.state", @"State \"%@\" in AI \"%@\" is not a dictionary, ignoring.", stateKey, smName);
                    continue;
                }
                
                stateHandlers = [self cleanHandlers:stateHandlers forState:stateKey stateMachine:smName];
                [cleanSM setObject:stateHandlers forKey:stateKey];
            }
            [cleanSM setObject:script forKey:@"jsScript"];
 
            // Make immutable.
            newSM = [[cleanSM copy] autorelease];
            
#if DEBUG_GRAPHVIZ
            if ([[NSUserDefaults standardUserDefaults] boolForKey:@"generate-ai-graphviz"])
            {
                GenerateGraphVizForAIStateMachine(newSM, smName);
            }
#endif
            
            // Cache.
            [cacheMgr setObject:newSM forKey:smName inCache:@"AIs"];
        }
        @finally
        {
            OOLogPopIndent();
        }
        
        [newSM retain];
        [pool release];
        [newSM autorelease];
    }
    
    return newSM;
}

performDeferredCall:withObject:afterDelay:

- (void) performDeferredCall:		(SEL)	selector
withObject:		(id)	object
afterDelay:		(NSTimeInterval)	delay

Definition at line 397 of file AI.m.

                           :(SEL)selector withObject:(id)object afterDelay:(NSTimeInterval)delay
{
    OOAIDeferredCallTrampolineInfo  infoStruct;
    NSValue                         *info = nil;
    
    if (selector != NULL)
    {
        infoStruct.ai = [self retain];
        infoStruct.selector = selector;
        infoStruct.parameter = object;
        
        info = [[NSValue alloc] initWithBytes:&infoStruct objCType:@encode(OOAIDeferredCallTrampolineInfo)];
        
        [[AI class] performSelector:@selector(deferredCallTrampolineWithInfo:)
                         withObject:info
                         afterDelay:delay];
        [info release];
    }
}

refreshOwnerDesc

- (void) refreshOwnerDesc

Definition at line 397 of file AI.m.

{
    ShipEntity *owner = [self owner];
    [ownerDesc release];
    if ([owner isPlayer])
    {
        ownerDesc = @"player autopilot";
    }
    else if (owner != nil)
    {
        ownerDesc = [[NSString alloc] initWithFormat:@"%@ %d", [owner name], [owner universalID]];
    }
    else
    {
        ownerDesc = @"no owner";
    }
}

---

The documentation for this category was generated from the following file:

• src/Core/AI.m