AI Class Reference

#include <AI.h>

Inheritance diagram for AI:

Collaboration diagram for AI:

Instance Methods
(NSString *)	- name
(NSString *)	- associatedJS
(NSString *)	- state
(void)	- setStateMachine:withJSScript:
(void)	- setState:
(void)	- setStateMachine:afterDelay:
(void)	- setState:afterDelay:
(id)	- initWithStateMachine:andState:
(ShipEntity *)	- owner
(void)	- setOwner:
(void)	- preserveCurrentStateMachine
(void)	- restorePreviousStateMachine
(BOOL)	- hasSuspendedStateMachines
(void)	- exitStateMachineWithMessage:
(NSUInteger)	- stackDepth
(void)	- reactToMessage:context:
(void)	- takeAction:
(void)	- think
(void)	- message:
(void)	- dropMessage:
(NSSet *)	- pendingMessages
(void)	- debugDumpPendingMessages
(void)	- setNextThinkTime:
(OOTimeAbsolute)	- nextThinkTime
(void)	- setThinkTimeInterval:
(OOTimeDelta)	- thinkTimeInterval
(void)	- clearStack
(void)	- clearAllData
(void)	- dumpState
(id)	- init [implementation]
(void)	- dealloc [implementation]
(NSString *)	- descriptionComponents [implementation]
(NSString *)	- shortDescriptionComponents [implementation]
(void)	- reportStackOverflow [implementation]
(NSString *)	- inspBasicIdentityLine [implementation]
(NSArray *)	- debugInspectorModules [implementation]
(void)	- performDeferredCall:withObject:afterDelay: [implementation]
(void)	- refreshOwnerDesc [implementation]
(void)	- directSetStateMachine:name: [implementation]
(void)	- directSetState: [implementation]
(NSDictionary *)	- loadStateMachine:jsName: [implementation]
(NSDictionary *)	- cleanHandlers:forState:stateMachine: [implementation]
(NSArray *)	- cleanActions:forHandler:state:stateMachine: [implementation]
Instance Methods inherited from OOWeakRefObject
(id)	- weakSelf
(id)	- weakRetain [implementation]
(void)	- weakRefDied: [implementation]
Instance Methods inherited from <OOWeakReferenceSupport>
(id)	- OO_RETURNS_RETAINED

Class Methods
(AI *)	+ currentlyRunningAI
(NSString *)	+ currentlyRunningAIDescription
(void)	+ deferredCallTrampolineWithInfo: [implementation]

Private Attributes
id	_owner
NSString *	ownerDesc
NSDictionary *	stateMachine
NSString *	stateMachineName
NSString *	currentState
NSMutableSet *	pendingMessages
NSMutableArray *	aiStack
OOTimeAbsolute	nextThinkTime
OOTimeDelta	thinkTimeInterval
NSString *	jsScript

Additional Inherited Members
Protected Attributes inherited from OOWeakRefObject
OOWeakReference *	weakSelf

Detailed Description

Definition at line 37 of file AI.h.

Method Documentation

associatedJS

- (NSString *) associatedJS

Definition at line 370 of file AI.m.

{
    return [stateMachine objectForKey:@"jsScript"];
}

References associatedJS.

Referenced by associatedJS, and ShipEntity(LoadRestore)::savedShipDictionaryWithContext:.

Here is the call graph for this function:

Here is the caller graph for this function:

cleanActions:forHandler:state:stateMachine:

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

implementation

Provided by category AI(OOPrivate).

Definition at line 914 of file AI.m.

                          :(NSArray *)actions forHandler:(NSString *)handlerKey state:(NSString *)stateKey stateMachine:(NSString *)smName
{
    NSEnumerator            *actionEnum = nil;
    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]];
    for (actionEnum = [actions objectEnumerator]; (action = [actionEnum nextObject]); )
    {
        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];
}

Referenced by AI(OOPrivate)::cleanHandlers:forState:stateMachine:.

Here is the caller graph for this function:

cleanHandlers:forState:stateMachine:

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

implementation

Provided by category AI(OOPrivate).

Definition at line 888 of file AI.m.

                                :(NSDictionary *)handlers forState:(NSString *)stateKey stateMachine:(NSString *)smName
{
    NSEnumerator            *handlerEnum = nil;
    NSString                *handlerKey = nil;
    NSArray                 *handlerActions = nil;
    NSMutableDictionary     *result = nil;
    
    result = [NSMutableDictionary dictionaryWithCapacity:[handlers count]];
    for (handlerEnum = [handlers keyEnumerator]; (handlerKey = [handlerEnum nextObject]); )
    {
        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];
}

Referenced by AI(OOPrivate)::loadStateMachine:jsName:.

Here is the caller graph for this function:

clearAllData

- (void) clearAllData

Definition at line 691 of file AI.m.

{
    [aiStack removeAllObjects];
    [pendingMessages removeAllObjects];
    
    nextThinkTime += 36000.0;  // should dealloc in under ten hours!
}

References clearAllData, and nextThinkTime.

Referenced by clearAllData, PlayerEntity::resetAutopilotAI, ShipEntity::setAI:, and thinkTimeInterval.

Here is the call graph for this function:

Here is the caller graph for this function:

clearStack

- (void) clearStack

Definition at line 685 of file AI.m.

{
    [aiStack removeAllObjects];
}

References clearStack.

Referenced by clearStack, WormholeEntity::suckInShip:, ShipEntity(AI)::switchAITo:, and thinkTimeInterval.

Here is the call graph for this function:

Here is the caller graph for this function:

currentlyRunningAI

+ (AI *) currentlyRunningAI

Definition at line 107 of file AI.m.

{
    return sCurrentlyRunningAI;
}

References currentlyRunningAI, and sCurrentlyRunningAI.

Referenced by currentlyRunningAI.

Here is the call graph for this function:

Here is the caller graph for this function:

currentlyRunningAIDescription

+ (NSString *) currentlyRunningAIDescription

Definition at line 113 of file AI.m.

{
    if (sCurrentlyRunningAI != nil)
    {
        return [NSString stringWithFormat:@"%@ in state %@", [sCurrentlyRunningAI name], [sCurrentlyRunningAI state]];
    }
    else
    {
        return @"<no AI running>";
    }
}

References currentlyRunningAIDescription, name, nil, sCurrentlyRunningAI, and state.

Referenced by currentlyRunningAIDescription.

Here is the call graph for this function:

Here is the caller graph for this function:

dealloc

- (void) dealloc

implementation

Reimplemented from OOWeakRefObject.

Definition at line 152 of file AI.m.

{
    if (sCurrentlyRunningAI == self)
    {
        sCurrentlyRunningAI = nil;
    }
    
    DESTROY(_owner);
    DESTROY(ownerDesc);
    DESTROY(aiStack);
    DESTROY(stateMachine);
    DESTROY(stateMachineName);
    DESTROY(currentState);
    DESTROY(pendingMessages);
    DESTROY(jsScript);
    
    [super dealloc];
}

References _owner, aiStack, currentState, dealloc, OOWeakRefObject::dealloc, DESTROY, jsScript, nil, ownerDesc, pendingMessages, sCurrentlyRunningAI, stateMachine, and stateMachineName.

Referenced by dealloc.

Here is the call graph for this function:

Here is the caller graph for this function:

debugDumpPendingMessages

- (void) debugDumpPendingMessages

Definition at line 639 of file AI.m.

{
    NSArray             *sortedMessages = nil;
    NSString            *displayMessages = nil;
    
    if ([pendingMessages count] > 0)
    {
        sortedMessages = [[pendingMessages allObjects] sortedArrayUsingSelector:@selector(caseInsensitiveCompare:)];
        displayMessages = [sortedMessages componentsJoinedByString:@", "];
    }
    else
    {
        displayMessages = @"none";
    }
    
    OOLog(@"ai.debug.pendingMessages", @"Pending messages for AI %@: %@", [self descriptionComponents], displayMessages);
}

References count, debugDumpPendingMessages, descriptionComponents, nil, OOLog, and pendingMessages.

Referenced by debugDumpPendingMessages, and pendingMessages.

Here is the call graph for this function:

Here is the caller graph for this function:

debugInspectorModules

- (NSArray *) debugInspectorModules

implementation

Provided by category AI(OOAIDebugInspectorModule).

Definition at line 102 of file OOAIDebugInspectorModule.m.

{
    return [[super debugInspectorModules] arrayByAddingInspectorModuleOfClass:[OOAIDebugInspectorModule class]
                                                                    forObject:(id)self];
}

deferredCallTrampolineWithInfo:

+ (void) deferredCallTrampolineWithInfo: (NSValue *) info

implementation

Provided by category AI(OOPrivate).

Definition at line 740 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];
    }
}

descriptionComponents

- (NSString *) descriptionComponents

implementation

Definition at line 172 of file AI.m.

{
    return [NSString stringWithFormat:@"\"%@\" in state: \"%@\" for %@", stateMachineName, currentState, ownerDesc];
}

References descriptionComponents.

Referenced by debugDumpPendingMessages, and descriptionComponents.

Here is the call graph for this function:

Here is the caller graph for this function:

directSetState:

- (void) directSetState: (NSString *) state

implementation

Provided by category AI(OOPrivate).

Definition at line 791 of file AI.m.

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

Referenced by restorePreviousStateMachine, setState:, and setStateMachine:withJSScript:.

Here is the caller graph for this function:

directSetStateMachine:name:

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

implementation

Provided by category AI(OOPrivate).

Definition at line 776 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];
    }
}

Referenced by restorePreviousStateMachine, and setStateMachine:withJSScript:.

Here is the caller graph for this function:

dropMessage:

- (void) dropMessage:

(NSString *)

ms

Definition at line 620 of file AI.m.

                    :(NSString *)ms
{
    [pendingMessages removeObject:ms];
}

dumpState

- (void) dumpState

Definition at line 700 of file AI.m.

{
    OOLog(@"dumpState.ai", @"State machine name: %@", stateMachineName);
    OOLog(@"dumpState.ai", @"Current state: %@", currentState);
    OOLog(@"dumpState.ai", @"Next think time: %g", nextThinkTime);
    OOLog(@"dumpState.ai", @"Next think interval: %g", thinkTimeInterval);
}

References currentState, dumpState, nextThinkTime, OOLog, stateMachineName, and thinkTimeInterval.

Referenced by ShipEntity::dumpSelfState, dumpState, and thinkTimeInterval.

Here is the call graph for this function:

Here is the caller graph for this function:

exitStateMachineWithMessage:

- (void) exitStateMachineWithMessage:

(NSString *)

message

Definition at line 296 of file AI.m.

                                    :(NSString *)message
{
    if ([aiStack count] != 0)
    {
        [self restorePreviousStateMachine];
        if (message == nil)  message = @"RESTARTED";
        [self reactToMessage:message context:@"suspended AI restart"];
    }
}

References aiStack, count, nil, reactToMessage:context:, and restorePreviousStateMachine.

Referenced by ShipEntity::behaviour_tractored:, ShipEntity::dumpItem:, ShipEntity::releaseCargoPodsDebris, ShipExitAI(), and ShipEntity::update:.

Here is the call graph for this function:

Here is the caller graph for this function:

hasSuspendedStateMachines

- (BOOL) hasSuspendedStateMachines

Definition at line 290 of file AI.m.

{
    return [aiStack count] != 0;
}

References hasSuspendedStateMachines.

Referenced by hasSuspendedStateMachines.

Here is the call graph for this function:

Here is the caller graph for this function:

init

- (id) init

implementation

Definition at line 126 of file AI.m.

{
    if ((self = [super init]))
    {
        nextThinkTime = INFINITY;  // don't think for a while
        thinkTimeInterval = AI_THINK_INTERVAL;
        
        stateMachineName = @"<no AI>";  // no initial brain
    }
    
    return self;
}

References AI_THINK_INTERVAL, init, nextThinkTime, stateMachineName, and thinkTimeInterval.

Referenced by init, and initWithStateMachine:andState:.

Here is the call graph for this function:

Here is the caller graph for this function:

initWithStateMachine:andState:

- (id) initWithStateMachine:		(NSString *)	smName
andState:		(NSString *)	stateName

Definition at line 140 of file AI.m.

                           :(NSString *)smName andState:(NSString *)stateName
{
    if ((self = [self init]))
    {
        if (smName != nil)  [self setStateMachine:smName withJSScript:@"oolite-nullAI.js"];
        if (stateName != nil)  currentState = [stateName retain];
    }
    
    return self;
}

References currentState, init, nil, and setStateMachine:withJSScript:.

Here is the call graph for this function:

inspBasicIdentityLine

- (NSString *) inspBasicIdentityLine

implementation

Provided by category AI(OOAIDebugInspectorModule).

Definition at line 95 of file OOAIDebugInspectorModule.m.

{
    if ([self owner] != nil)  return [NSString stringWithFormat:@"AI for %@", [[self owner] inspBasicIdentityLine]];
    return  [super inspBasicIdentityLine];
}

loadStateMachine:jsName:

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

implementation

Provided by category AI(OOPrivate).

Definition at line 801 of file AI.m.

                                   :(NSString *)smName jsName:(NSString *)script
{
    NSDictionary            *newSM = nil;
    NSMutableDictionary     *cleanSM = nil;
    OOCacheManager          *cacheMgr = [OOCacheManager sharedCache];
    NSEnumerator            *stateEnum = nil;
    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]];
            
            for (stateEnum = [newSM keyEnumerator]; (stateKey = [stateEnum nextObject]); )
            {
                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;
}

Referenced by setStateMachine:withJSScript:.

Here is the caller graph for this function:

message:

- (void) message:

(NSString *)

ms

Definition at line 600 of file AI.m.

                :(NSString *)ms
{
    if ([[self owner] universalID] == NO_TARGET)  return;  // don't think until launched
 
    if (EXPECT_NOT([pendingMessages count] > 32))
    {
        // Generate the error, but don't crash Oolite! Fixes bug #18055 - Pending message overflow for thargoids, -> crash !
        OOLogERR(@"ai.message.failed.overflow", @"AI message \"%@\" received by '%@' AI while pending messages stack full; message discarded. Pending messages:\n%@", ms, ownerDesc, pendingMessages);
    }
    else
    {
        if (pendingMessages == nil)
        {
            pendingMessages = [[NSMutableSet alloc] init];
        }
        [pendingMessages addObject:ms];
    }
}

References count, EXPECT_NOT, nil, NO_TARGET, OOLogERR, owner, ownerDesc, and pendingMessages.

Referenced by StationEntity::abortAllDockings, ShipEntity::acceptAsEscort:, StationEntity::acceptDockingClearanceRequestFrom:, StationEntity::autoDockShipsOnApproach, ShipEntity::behaviour_face_destination:, ShipEntity::behaviour_flee_target:, ShipEntity::behaviour_fly_from_destination:, ShipEntity::behaviour_fly_to_destination:, ShipEntity::behaviour_land_on_planet:, ShipEntity::broadcastAIMessage:, ShipEntity::checkForAegis, DockEntity::dockingInstructionsForShip:, ShipEntity::enterDock:, ShipEntity::enterWitchspace, ShipEntity::noteLostTarget, ShipEntity::noteTargetDestroyed:, StationEntity::sanityCheckShipsOnApproach, ShipEntity(PureAI)::scanForNearestShipMatchingPredicate:, ShipEntity::scoopUpProcess:processEvents:processMessages:, ShipEntity::sendAIMessage:, ShipEntity::setTargetToNearestStationIncludingHostiles:, ShipEntity(PureAI)::setTargetToPrimaryAggressor, ShipEntity::setTargetToSystemStation, WormholeEntity::suckInShip:, ShipEntity::transitionToAegisNone, ShipEntity::update:, StationEntity::update:, and ShipEntity::witchspaceLeavingEffects.

Here is the call graph for this function:

Here is the caller graph for this function:

name

- (NSString *) name

Definition at line 364 of file AI.m.

{
    return [[stateMachineName retain] autorelease];
}

References name.

Referenced by currentlyRunningAIDescription, ShipEntity::hasNewAI, AI(OOPrivate)::loadStateMachine:jsName:, name, reactToMessage:context:, reportStackOverflow, ShipEntity(PureAI)::safeScriptActionOnTarget:, ShipEntity(LoadRestore)::savedShipDictionaryWithContext:, ShipEntity(PureAI)::scanForNearestShipMatchingPredicate:, ShipEntity(PureAI)::scriptActionOnTarget:, ShipGetProperty(), OOAIDebugInspectorModule::update, and OOShipDebugInspectorModule::update.

Here is the call graph for this function:

Here is the caller graph for this function:

nextThinkTime

- (OOTimeAbsolute) nextThinkTime

References nextThinkTime.

owner

- (ShipEntity *) owner

Definition at line 184 of file AI.m.

{
    ShipEntity      *owner = [_owner weakRefUnderlyingObject];
    if (owner == nil)
    {
        [_owner release];
        _owner = nil;
    }
    
    return owner;
}

References _owner, nil, and owner.

Referenced by AI(OOAIDebugInspectorModule)::inspBasicIdentityLine, message:, owner, preserveCurrentStateMachine, reactToMessage:context:, AI(OOPrivate)::refreshOwnerDesc, restorePreviousStateMachine, takeAction:, think, and OOAIDebugInspectorModule::update.

Here is the call graph for this function:

Here is the caller graph for this function:

pendingMessages

- (NSSet *) pendingMessages

References debugDumpPendingMessages, and pendingMessages.

Here is the call graph for this function:

performDeferredCall:withObject:afterDelay:

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

implementation

Provided by category AI(OOPrivate).

Definition at line 719 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];
    }
}

Referenced by setState:afterDelay:, and setStateMachine:afterDelay:.

Here is the caller graph for this function:

preserveCurrentStateMachine

- (void) preserveCurrentStateMachine

Definition at line 231 of file AI.m.

{
    if (stateMachine == nil)  return;
    
    if (aiStack == nil)
    {
        aiStack = [[NSMutableArray alloc] init];
    }
    
    if ([aiStack count] >= kStackLimiter)
    {
        [self reportStackOverflow];
        
        [NSException raise:@"OoliteException"
                    format:@"AI stack overflow for %@", _owner];
    }
    
    OOPreservedAIStateMachine *preservedMachine = [[OOPreservedAIStateMachine alloc]
                                                   initWithStateMachine:stateMachine
                                                                   name:stateMachineName
                                                                  state:currentState
                                                        pendingMessages:pendingMessages
                                                                                                    jsScript:[stateMachine objectForKey:@"jsScript"]];
    
#ifndef NDEBUG
    if ([[self owner] reportAIMessages])  OOLog(@"ai.stack.push", @"Pushing state machine for %@", self);
#endif
    
    [aiStack addObject:preservedMachine];  // PUSH
    
    [preservedMachine release];
}

References aiStack, count, kStackLimiter, nil, OOLog, owner, preserveCurrentStateMachine, reportStackOverflow, and stateMachine.

Referenced by preserveCurrentStateMachine, and setStateMachine:withJSScript:.

Here is the call graph for this function:

Here is the caller graph for this function:

reactToMessage:context:

- (void) reactToMessage:		(NSString *)	message
context:		(NSString *)	debugContext

Definition at line 404 of file AI.m.

                       :(NSString *) message context:(NSString *)debugContext
{
    unsigned        i;
    NSArray         *actions = nil;
    NSDictionary    *messagesForState = nil;
    ShipEntity      *owner = [self owner];
    static unsigned recursionLimiter = 0;
    AI              *previousRunning = sCurrentlyRunningAI;
    
    /*  CRASH in _freedHandler when called via -setState: __NSFireDelayedPerform (1.69, OS X/x86).
        Analysis: owner invalid.
        Fix: make owner an OOWeakReference.
         -- Ahruman, 20070706
    */
    if (message == nil || owner == nil || [owner universalID] == NO_TARGET)  return;
 
#ifndef NDEBUG
    // Push debug stack frame.
    if (debugContext == nil)  debugContext = @"unspecified";
    AIStackElement stackElement =
    {
        .back = sStack,
        .owner = owner,
        .aiName = [[stateMachineName retain] autorelease],
        .state = [[currentState retain] autorelease],
        .message = message,
        .context = debugContext
    };
    sStack = &stackElement;
#endif
    
    /*  CRASH when calling reactToMessage: FOO in state FOO causes infinite
        recursion. (NB: there are other ways of triggering this.)
        FIX: recursion limiter. Alternative is to explicitly catch this case
        in takeAction:, but that could potentially miss indirect recursion via
        scripts.
    */
    if (recursionLimiter > kRecursionLimiter)
    {
        OOLogERR(@"ai.error.recursion", @"AI dispatch: hit stack depth limit in AI %@, state %@ handling message %@ in context \"%@\", aborting.", stateMachineName, currentState, message, debugContext);
        
#ifndef NDEBUG
        AIStackElement *stack = sStack;
        unsigned depth = 0;
        while (stack != NULL)
        {
            OOLog(@"ai.error.recursion.stackTrace", @"%4u  %@ - %@:%@.%@ (%@)", depth++, [stack->owner shortDescription], stack->aiName, stack->state, stack->message, stack->context);
            stack = stack->back;
        }
        
        // unwind.
        if (sStack != NULL)  sStack = sStack->back;
#endif
        
        return;
    }
    
    messagesForState = [stateMachine objectForKey:currentState];
    if (messagesForState == nil)  return;
    
#ifndef NDEBUG
    if (currentState != nil && ![message isEqual:@"UPDATE"] && [owner reportAIMessages])
    {
        OOLog(@"ai.message.receive", @"AI %@ for %@ in state '%@' receives message '%@'. Context: %@, stack depth: %u", stateMachineName, ownerDesc, currentState, message, debugContext, recursionLimiter);
    }
#endif
    
    actions = [[[messagesForState objectForKey:message] copy] autorelease];
    
    sCurrentlyRunningAI = self;
    if ([actions count] > 0)
    {
        ++recursionLimiter;
        @try
        {
            for (i = 0; i < [actions count]; i++)
            {
                [self takeAction:[actions objectAtIndex:i]];
            }
        }
        @catch (NSException *exception)
        {
            OOLog(kOOLogException, @"Squashing exception %@:%@ in AI handler %@:%@.%@", [exception name], [exception reason], stateMachineName, currentState, message);
        }
        
        --recursionLimiter;
    }
    else
    {
        if (currentState != nil)
        {
            if ([owner respondsToSelector:@selector(interpretAIMessage:)])
            {
                [owner performSelector:@selector(interpretAIMessage:) withObject:message];
            }
        }
    }
    
    sCurrentlyRunningAI = previousRunning;
#ifndef NDEBUG
    // Unwind stack.
    if (sStack != NULL)  sStack = sStack->back;
#endif
}

References AIStackElement::aiName, AIStackElement::back, AIStackElement::context, count, currentState, kOOLogException, kRecursionLimiter, AIStackElement::message, name, nil, NO_TARGET, OOLog, OOLogERR, owner, AIStackElement::owner, ownerDesc, sCurrentlyRunningAI, sStack, AIStackElement::state, stateMachineName, and takeAction:.

Referenced by StationEntity::acceptDockingClearanceRequestFrom:, Universe::allShipsDoScriptEvent:andReactToAIMessage:, ShipEntity::behaviour_intercept_target:, ShipEntity::checkForAegis, StationEntity::dockingInstructionsForShip:, ShipEntity::enterWormhole:replacing:, exitStateMachineWithMessage:, PlayerEntity(Scripting)::messageShipAIs:, ShipEntity::noteLostTarget, ShipEntity::reactToAIMessage:context:, StationEntity::setAlertLevel:signallingScript:, setState:, setStateMachine:withJSScript:, think, and ShipEntity::update:.

Here is the call graph for this function:

Here is the caller graph for this function:

refreshOwnerDesc

- (void) refreshOwnerDesc

implementation

Provided by category AI(OOPrivate).

Definition at line 757 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";
    }
}

Referenced by setOwner:, and setStateMachine:withJSScript:.

Here is the caller graph for this function:

reportStackOverflow

- (void) reportStackOverflow

implementation

Definition at line 205 of file AI.m.

{
    if (OOLogWillDisplayMessagesInClass(@"ai.error.stackOverflow"))
    {
        BOOL stackDump = OOLogWillDisplayMessagesInClass(@"ai.error.stackOverflow.dump");
        
        NSString *trailer = stackDump ? @" -- stack:" : @".";
        OOLogERR(@"ai.error.stackOverflow", @"AI stack overflow for %@ in %@: %@%@\n", [_owner shortDescription], stateMachineName, currentState, trailer);
        
        if (stackDump)
        {
            OOLogIndent();
            
            NSUInteger count = [aiStack count];
            while (count--)
            {
                OOPreservedAIStateMachine *preservedMachine = [aiStack objectAtIndex:count];
                OOLog(@"ai.error.stackOverflow.dump", @"%3lu: %@: %@", count, [preservedMachine name], [preservedMachine state]);
            }
            
            OOLogOutdent();
        }
    }
}

References _owner, count, currentState, name, OOLog, OOLogERR, OOLogIndent(), OOLogOutdent(), OOLogWillDisplayMessagesInClass(), reportStackOverflow, state, and stateMachineName.

Referenced by preserveCurrentStateMachine, and reportStackOverflow.

Here is the call graph for this function:

Here is the caller graph for this function:

restorePreviousStateMachine

- (void) restorePreviousStateMachine

Definition at line 265 of file AI.m.

{
    if ([aiStack count] == 0)  return;
    
    OOPreservedAIStateMachine *preservedMachine = [aiStack lastObject];
    
#ifndef NDEBUG
    if ([[self owner] reportAIMessages])  OOLog(@"ai.stack.pop", @"Popping previous state machine for %@", self);
#endif
    
    [self directSetStateMachine:[preservedMachine stateMachine]
                           name:[preservedMachine name]];
    
    [self directSetState:[preservedMachine state]];
    
    // restore JS script
    [[self owner] setAIScript:[preservedMachine jsScript]];
 
    [pendingMessages release];
    pendingMessages = [[preservedMachine pendingMessages] mutableCopy];  // restore a MUTABLE set
    
    [aiStack removeLastObject];  //  POP
}

References aiStack, count, directSetState:, directSetStateMachine:name:, OOPreservedAIStateMachine::jsScript, OOPreservedAIStateMachine::name, OOLog, owner, OOPreservedAIStateMachine::pendingMessages, pendingMessages, restorePreviousStateMachine, ShipEntity::setAIScript:, OOPreservedAIStateMachine::state, and OOPreservedAIStateMachine::stateMachine.

Referenced by exitStateMachineWithMessage:, and restorePreviousStateMachine.

Here is the call graph for this function:

Here is the caller graph for this function:

setNextThinkTime:

- (void) setNextThinkTime:

(OOTimeAbsolute)

ntt

Definition at line 658 of file AI.m.

                         :(OOTimeAbsolute) ntt
{
    nextThinkTime = ntt;
}

References nextThinkTime.

Referenced by DockEntity::launchShip:, PlayerEntity::resetAutopilotAI, PlayerEntity(Scripting)::sendAllShipsAway, OOAIDebugInspectorModule::thinkNow:, and Universe::update:.

Here is the caller graph for this function:

setOwner:

- (void) setOwner:

(ShipEntity *)

ship

Definition at line 197 of file AI.m.

                 :(ShipEntity *)ship
{
    [_owner release];
    _owner = [ship weakRetain];
    [self refreshOwnerDesc];
}

References _owner, refreshOwnerDesc, and OOWeakRefObject::weakRetain.

Referenced by Universe::addEntity:, PlayerEntity::resetAutopilotAI, and ShipEntity::setUpShipFromDictionary:.

Here is the call graph for this function:

Here is the caller graph for this function:

setState:

- (void) setState:

(NSString *)

stateName

Definition at line 334 of file AI.m.

                 :(NSString *) stateName
{
    if ([stateMachine objectForKey:stateName])
    {
        /*  CRASH in objc_msgSend, apparently on [self reactToMessage:@"EXIT"] (1.69, OS X/x86).
            Analysis: self corrupted. We're being called by __NSFireDelayedPerform, which doesn't go
            through -[NSObject performSelector:withObject:], suggesting it's using IMP caching. An
            invalid self is therefore possible.
            Attempted fix: new delayed dispatch with trampoline, see -[AI setState:afterDelay:].
             -- Ahruman, 20070706
        */
        [self reactToMessage:@"EXIT" context:@"changing state"];
        [self directSetState:stateName];
        [self reactToMessage:@"ENTER" context:@"changing state"];
    }
}

References directSetState:, reactToMessage:context:, and stateMachine.

Referenced by Universe::addEntity:, PlayerEntity::engageAutopilotToStation:, PlayerEntity::resetAutopilotAI, PlayerEntity(Scripting)::sendAllShipsAway, ShipEntity(PureAI)::setStateTo:, ShipEntity(Private)::setUpOneEscort:inGroup:withRole:atPosition:andCount:, and ShipSetProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

setState:afterDelay:

- (void) setState:		(NSString *)	stateName
afterDelay:		(NSTimeInterval)	delay

Definition at line 358 of file AI.m.

                 :(NSString *)stateName afterDelay:(NSTimeInterval)delay
{
    [self performDeferredCall:@selector(setState:) withObject:stateName afterDelay:delay];
}

References performDeferredCall:withObject:afterDelay:.

Referenced by ShipEntity::dockEscorts.

Here is the call graph for this function:

Here is the caller graph for this function:

setStateMachine:afterDelay:

- (void) setStateMachine:		(NSString *)	smName
afterDelay:		(NSTimeInterval)	delay

Definition at line 352 of file AI.m.

                        :(NSString *)smName afterDelay:(NSTimeInterval)delay
{
    [self performDeferredCall:@selector(setStateMachine:) withObject:smName afterDelay:delay];
}

References performDeferredCall:withObject:afterDelay:.

Here is the call graph for this function:

setStateMachine:withJSScript:

- (void) setStateMachine:		(NSString *)	smName
withJSScript:		(NSString *)	script

Definition at line 307 of file AI.m.

                        :(NSString *)smName withJSScript:(NSString *)script
{
    NSDictionary *newSM = [self loadStateMachine:smName jsName:script];
 
    if (newSM)
    {
        [self preserveCurrentStateMachine];
        [self directSetStateMachine:newSM name:smName];
        [self directSetState:@"GLOBAL"];
        
        nextThinkTime = 0.0;   // think at next tick
 
        /*  CRASH in objc_msgSend, apparently on [self reactToMessage:@"ENTER"] (1.69, OS X/x86).
            Analysis: self corrupted. We're being called by __NSFireDelayedPerform, which doesn't go
            through -[NSObject performSelector:withObject:], suggesting it's using IMP caching. An
            invalid self is therefore possible.
            Attempted fix: new delayed dispatch with trampoline, see -[AI setStateMachine:afterDelay:].
             -- Ahruman, 20070706
        */
        [self reactToMessage:@"ENTER" context:@"changing AI"];
        
        // refresh name
        [self refreshOwnerDesc];
    }
}

References directSetState:, directSetStateMachine:name:, loadStateMachine:jsName:, nextThinkTime, preserveCurrentStateMachine, reactToMessage:context:, and refreshOwnerDesc.

Referenced by initWithStateMachine:andState:, and ShipEntity(AI)::setAITo:.

Here is the call graph for this function:

Here is the caller graph for this function:

setThinkTimeInterval:

- (void) setThinkTimeInterval:

(OOTimeDelta)

tti

Definition at line 673 of file AI.m.

                             :(OOTimeDelta) tti
{
    thinkTimeInterval = tti;
}

References thinkTimeInterval.

shortDescriptionComponents

- (NSString *) shortDescriptionComponents

implementation

Definition at line 178 of file AI.m.

{
    return [NSString stringWithFormat:@"%@:%@ / %@", stateMachineName, currentState, [stateMachine objectForKey:@"jsScript"]];
}

References shortDescriptionComponents.

Referenced by ShipEntity::descriptionForObjDump, and shortDescriptionComponents.

Here is the call graph for this function:

Here is the caller graph for this function:

stackDepth

- (NSUInteger) stackDepth

Definition at line 382 of file AI.m.

{
    return [aiStack count];
}

References stackDepth.

Referenced by stackDepth, and OOAIDebugInspectorModule::update.

Here is the call graph for this function:

Here is the caller graph for this function:

state

- (NSString *) state

Definition at line 376 of file AI.m.

{
    return [[currentState retain] autorelease];
}

References state.

Referenced by currentlyRunningAIDescription, AI(OOPrivate)::loadStateMachine:jsName:, reportStackOverflow, ShipEntity(PureAI)::safeScriptActionOnTarget:, ShipEntity(PureAI)::scriptActionOnTarget:, ShipGetProperty(), state, OOAIDebugInspectorModule::update, and OOShipDebugInspectorModule::update.

Here is the call graph for this function:

Here is the caller graph for this function:

takeAction:

- (void) takeAction:

(NSString *)

action

Definition at line 510 of file AI.m.

                   :(NSString *)action
{
    ShipEntity *owner = [self owner];
    
#ifndef NDEBUG
    BOOL report = [owner reportAIMessages];
    if (report)
    {
        OOLog(@"ai.takeAction", @"%@ to take action %@", ownerDesc, action);
        OOLogIndent();
    }
#endif
    
    NSArray *tokens = ScanTokensFromString(action);
    NSUInteger tokenCount = [tokens count];
    
    if (tokenCount != 0)
    {
        NSString *selectorStr = [tokens objectAtIndex:0];
        
        if (owner != nil)
        {
            NSString *dataString = nil;
            
            if (tokenCount == 2)
            {
                dataString = [tokens objectAtIndex:1];
            }
            else if ([tokens count] > 1)
            {
                dataString = [[tokens subarrayWithRange:NSMakeRange(1, tokenCount - 1)] componentsJoinedByString:@" "];
            }
            
            SEL selector = NSSelectorFromString(selectorStr);
            if ([owner respondsToSelector:selector])
            {
                if (dataString != nil)  [owner performSelector:selector withObject:dataString];
                else  [owner performSelector:selector];
            }
            else
            {
                OOLogERR(@"ai.takeAction.badSelector", @"in AI %@ in state %@: %@ does not respond to %@", stateMachineName, currentState, ownerDesc, selectorStr);
            }
        }
        else
        {
            OOLog(@"ai.takeAction.orphaned", @"***** AI %@, trying to perform %@, is orphaned (no owner)", stateMachineName, selectorStr);
        }
    }
    else
    {
#ifndef NDEBUG
        if (report)  OOLog(@"ai.takeAction.noAction", @"DEBUG: - no action '%@'", action);
#endif
    }
    
#ifndef NDEBUG
    if (report)
    {
        OOLogOutdent();
    }
#endif
}

References count, currentState, nil, OOLog, OOLogERR, OOLogIndent(), OOLogOutdent(), owner, ownerDesc, ShipEntity::reportAIMessages, ScanTokensFromString(), and stateMachineName.

Referenced by reactToMessage:context:.

Here is the call graph for this function:

Here is the caller graph for this function:

think

- (void) think

Definition at line 575 of file AI.m.

{
    NSArray         *ms_list = nil;
    unsigned        i;
    
    if ([[self owner] universalID] == NO_TARGET || stateMachine == nil)  return;  // don't think until launched
    
    [self reactToMessage:@"UPDATE" context:@"periodic update"];
 
    if ([pendingMessages count] > 0)
    {
        ms_list = [pendingMessages allObjects];
        [pendingMessages removeAllObjects];
    }
    
    if (ms_list != nil)
    {
        for (i = 0; i < [ms_list count]; i++)
        {
            [self reactToMessage:[ms_list objectAtIndex:i] context:@"handling deferred message"];
        }
    }
}

References count, nil, NO_TARGET, owner, pendingMessages, reactToMessage:context:, stateMachine, and think.

Referenced by think, and Universe::update:.

Here is the call graph for this function:

Here is the caller graph for this function:

thinkTimeInterval

- (OOTimeDelta) thinkTimeInterval

References clearAllData, clearStack, dumpState, and thinkTimeInterval.

Here is the call graph for this function:

Member Data Documentation

_owner

- (id) _owner

private

Definition at line 40 of file AI.h.

Referenced by dealloc, owner, reportStackOverflow, and setOwner:.

aiStack

- (NSMutableArray*) aiStack

private

Definition at line 48 of file AI.h.

Referenced by dealloc, exitStateMachineWithMessage:, preserveCurrentStateMachine, and restorePreviousStateMachine.

currentState

- (NSString*) currentState

private

Definition at line 45 of file AI.h.

Referenced by dealloc, dumpState, initWithStateMachine:andState:, reactToMessage:context:, reportStackOverflow, and takeAction:.

jsScript

- (NSString*) jsScript

private

Definition at line 53 of file AI.h.

Referenced by dealloc.

nextThinkTime

- (OOTimeAbsolute) nextThinkTime

private

Definition at line 664 of file AI.m.

{
    if (!stateMachine)
        return INFINITY;
 
    return nextThinkTime;
}

Referenced by clearAllData, dumpState, init, nextThinkTime, setNextThinkTime:, setStateMachine:withJSScript:, OOAIDebugInspectorModule::update, and Universe::update:.

ownerDesc

- (NSString*) ownerDesc

private

Definition at line 41 of file AI.h.

Referenced by dealloc, message:, reactToMessage:context:, and takeAction:.

pendingMessages

- (NSSet *) pendingMessages

private

Definition at line 626 of file AI.m.

{
    if (pendingMessages != nil)
    {
        return [[pendingMessages copy] autorelease];
    }
    else
    {
        return [NSSet set];
    }
}

Referenced by dealloc, debugDumpPendingMessages, message:, pendingMessages, restorePreviousStateMachine, think, and OOAIDebugInspectorModule::update.

stateMachine

- (NSDictionary*) stateMachine

private

Definition at line 43 of file AI.h.

Referenced by dealloc, preserveCurrentStateMachine, setState:, and think.

stateMachineName

- (NSString*) stateMachineName

private

Definition at line 44 of file AI.h.

Referenced by dealloc, dumpState, init, reactToMessage:context:, reportStackOverflow, and takeAction:.

thinkTimeInterval

- (OOTimeDelta) thinkTimeInterval

private

Definition at line 679 of file AI.m.

{
    return thinkTimeInterval;
}

Referenced by dumpState, init, setThinkTimeInterval:, thinkTimeInterval, and Universe::update:.

---

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

• src/Core/AI.h
• src/Core/AI.m