OODebugMonitor Class Reference

#include <OODebugMonitor.h>

Inheritance diagram for OODebugMonitor:

Collaboration diagram for OODebugMonitor:

Instance Methods
(BOOL)	- setDebugger:
(void)	- appendJSConsoleLine:colorKey:emphasisRange:
(void)	- appendJSConsoleLine:colorKey:
(void)	- clearJSConsole
(void)	- showJSConsole
(id)	- configurationValueForKey:class:defaultValue:
(long long)	- configurationIntValueForKey:defaultValue:
(NSArray *)	- configurationKeys
(BOOL)	- debuggerConnected
(void)	- dumpMemoryStatistics
(size_t)	- dumpJSMemoryStatistics
(void)	- setTCPIgnoresDroppedPackets:
(BOOL)	- TCPIgnoresDroppedPackets
(void)	- setUsingPlugInController:
(BOOL)	- usingPlugInController
(id)	- init [implementation]
(void)	- dealloc [implementation]
(oneway void)	- performJSConsoleCommand: [implementation]
(id)	- configurationValueForKey: [implementation]
(void)	- setConfigurationValue:forKey: [implementation]
(void)	- writeMemStat: [implementation]
(void)	- dumpEntity:withState:parentVisible: [implementation]
(NSString *)	- sourceCodeForFile:line: [implementation]
(void)	- disconnectDebugger:message: [implementation]
(void)	- applicationWillTerminate: [implementation]
(void)	- setUpDebugConsoleScript [implementation]
(void)	- javaScriptEngineWillReset: [implementation]
(void)	- disconnectDebuggerWithMessage: [implementation]
(NSDictionary *)	- mergedConfiguration [implementation]
(NSMutableDictionary *)	- normalizeConfigDictionary: [implementation]
(id)	- normalizeConfigValue:forKey: [implementation]
(NSArray *)	- loadSourceFile: [implementation]
(oneway void)	- jsEngine:context:error:stackSkip:showingLocation:withMessage: [implementation]
(oneway void)	- jsEngine:context:logMessage:ofClass: [implementation]
(jsval)	- oo_jsValueInContext: [implementation]
(id)	- copyWithZone: [implementation]
(id)	- retain [implementation]
(NSUInteger)	- retainCount [implementation]
(void)	- release [implementation]
(id)	- autorelease [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
(OODebugMonitor *)	+ sharedDebugMonitor
(static NSString *)	+ SizeString [implementation]
(id)	+ allocWithZone: [implementation]

Private Attributes
id< OODebuggerInterface >	_debugger
OOJSScript *	_script
struct JSObject *	_jsSelf
NSDictionary *	_configFromOXPs
NSMutableDictionary *	_configOverrides
NSMutableDictionary *	_fgColors
NSMutableDictionary *	_bgColors
NSMutableDictionary *	_sourceFiles
BOOL	_TCPIgnoresDroppedPackets
BOOL	_usingPlugInController

Additional Inherited Members
Protected Attributes inherited from OOWeakRefObject
OOWeakReference *	weakSelf

Detailed Description

Definition at line 65 of file OODebugMonitor.h.

Method Documentation

allocWithZone:

+ (id) allocWithZone: (NSZone *) inZone

implementation

Provided by category OODebugMonitor(Singleton).

Definition at line 1001 of file OODebugMonitor.m.

                   :(NSZone *)inZone
{
    if (sSingleton == nil)
    {
        sSingleton = [super allocWithZone:inZone];
        return sSingleton;
    }
    return nil;
}

appendJSConsoleLine:colorKey:

- (void) appendJSConsoleLine:		(id)	string
colorKey:		(NSString *)	colorKey

Definition at line 233 of file OODebugMonitor.m.

                           :(id)string
                   colorKey:(NSString *)colorKey
{
    [self appendJSConsoleLine:string
                     colorKey:colorKey
                emphasisRange:NSMakeRange(0, 0)];
}

References appendJSConsoleLine:colorKey:emphasisRange:.

Referenced by OODebugMonitor(Private)::jsEngine:context:logMessage:ofClass:, and writeMemStat:.

Here is the call graph for this function:

Here is the caller graph for this function:

appendJSConsoleLine:colorKey:emphasisRange:

- (void) appendJSConsoleLine:		(id)	string
colorKey:		(NSString *)	colorKey
emphasisRange:		(NSRange)	emphasisRange

Definition at line 212 of file OODebugMonitor.m.

                           :(id)string
                   colorKey:(NSString *)colorKey
              emphasisRange:(NSRange)emphasisRange
{
    if (string == nil)  return;
    OOJSPauseTimeLimiter();
    @try
    {
        [_debugger debugMonitor:self
                jsConsoleOutput:string
                       colorKey:colorKey
                  emphasisRange:emphasisRange];
    }
    @catch (NSException *exception)
    {
        OOLog(@"debugMonitor.debuggerConnection.exception", @"Exception while attempting to send JavaScript console text to debugger: %@ -- %@", [exception name], [exception reason]);
    }
    OOJSResumeTimeLimiter();
}

References nil, OOJSPauseTimeLimiter(), OOJSResumeTimeLimiter(), and OOLog.

Referenced by appendJSConsoleLine:colorKey:, and OODebugMonitor(Private)::jsEngine:context:error:stackSkip:showingLocation:withMessage:.

Here is the call graph for this function:

Here is the caller graph for this function:

applicationWillTerminate:

- (void) applicationWillTerminate: (NSNotification *) notification

implementation

Definition at line 723 of file OODebugMonitor.m.

                                :(NSNotification *)notification
{
    if (_configOverrides != nil)
    {
        [[NSUserDefaults standardUserDefaults] setObject:_configOverrides forKey:@"debug-settings-override"];
    }
    
    [self disconnectDebuggerWithMessage:@"Oolite is terminating."];
}

References _configOverrides, disconnectDebuggerWithMessage:, and nil.

Here is the call graph for this function:

autorelease

- (id) autorelease

implementation

Provided by category OODebugMonitor(Singleton).

Definition at line 1034 of file OODebugMonitor.m.

{
    return self;
}

clearJSConsole

- (void) clearJSConsole

Definition at line 242 of file OODebugMonitor.m.

{
    OOJSPauseTimeLimiter();
    @try
    {
        [_debugger debugMonitorClearConsole:self];
    }
    @catch (NSException *exception)
    {
        OOLog(@"debugMonitor.debuggerConnection.exception", @"Exception while attempting to clear JavaScript console: %@ -- %@", [exception name], [exception reason]);
    }
    OOJSResumeTimeLimiter();
}

References clearJSConsole, OOJSPauseTimeLimiter(), OOJSResumeTimeLimiter(), and OOLog.

Referenced by clearJSConsole.

Here is the call graph for this function:

Here is the caller graph for this function:

configurationIntValueForKey:defaultValue:

- (long long) configurationIntValueForKey:		(NSString *)	key
defaultValue:		(long long)	value

Definition at line 293 of file OODebugMonitor.m.

                                        :(NSString *)key defaultValue:(long long)value
{
    long long                   result;
    id                          object = nil;
    
    object = [self configurationValueForKey:key];
    if ([object respondsToSelector:@selector(longLongValue)])  result = [object longLongValue];
    else if ([object respondsToSelector:@selector(intValue)])  result = [object intValue];
    else  result = value;
    
    return result;
}

References configurationValueForKey:, long(), and nil.

Here is the call graph for this function:

configurationKeys

- (NSArray *) configurationKeys

Definition at line 342 of file OODebugMonitor.m.

{
    NSMutableSet                *result = nil;
    
    result = [NSMutableSet setWithCapacity:[_configFromOXPs count] + [_configOverrides count]];
    [result addObjectsFromArray:[_configFromOXPs allKeys]];
    [result addObjectsFromArray:[_configOverrides allKeys]];
    
    return [[result allObjects] sortedArrayUsingSelector:@selector(caseInsensitiveCompare:)];
}

References configurationKeys, and nil.

Referenced by configurationKeys.

Here is the call graph for this function:

Here is the caller graph for this function:

configurationValueForKey:

- (id) configurationValueForKey: (in NSString *) key

implementation

Reimplemented from <OODebugMonitorInterface>.

Definition at line 272 of file OODebugMonitor.m.

                              :(in NSString *)key
{
    return [self configurationValueForKey:key class:Nil defaultValue:nil];
}

References configurationValueForKey:class:defaultValue:.

Referenced by configurationIntValueForKey:defaultValue:, and setConfigurationValue:forKey:.

Here is the call graph for this function:

Here is the caller graph for this function:

configurationValueForKey:class:defaultValue:

- (id) configurationValueForKey:		(NSString *)	key
class:		(Class)	class
defaultValue:		(id)	value

Definition at line 278 of file OODebugMonitor.m.

                              :(NSString *)key class:(Class)class defaultValue:(id)value
{
    id                          result = nil;
    
    if (class == Nil)  class = [NSObject class];
    
    result = [_configOverrides objectForKey:key];
    if (![result isKindOfClass:class] && result != [NSNull null])  result = [_configFromOXPs objectForKey:key];
    if (![result isKindOfClass:class] && result != [NSNull null])  result = [[value retain] autorelease];
    if (result == [NSNull null])  result = nil;
    
    return result;
}

References nil.

Referenced by configurationValueForKey:.

Here is the caller graph for this function:

copyWithZone:

- (id) copyWithZone: (NSZone *) inZone

implementation

Provided by category OODebugMonitor(Singleton).

Definition at line 1012 of file OODebugMonitor.m.

                  :(NSZone *)inZone
{
    return self;
}

dealloc

- (void) dealloc

implementation

Reimplemented from OOWeakRefObject.

Definition at line 126 of file OODebugMonitor.m.

{
    [self disconnectDebuggerWithMessage:@"Debug controller object destroyed while debugging in progress."];
    
    [_configFromOXPs release];
    [_configOverrides release];
    
    [_fgColors release];
    [_bgColors release];
    [_sourceFiles release];
    
    if (_jsSelf != NULL)
    {
        [[OOJavaScriptEngine sharedEngine] removeGCObjectRoot:&_jsSelf];
    }
    
    [super dealloc];
}

References _jsSelf, dealloc, OOWeakRefObject::dealloc, disconnectDebuggerWithMessage:, OOJavaScriptEngine::removeGCObjectRoot:, and OOJavaScriptEngine::sharedEngine.

Referenced by dealloc.

Here is the call graph for this function:

Here is the caller graph for this function:

debuggerConnected

- (BOOL) debuggerConnected

Definition at line 354 of file OODebugMonitor.m.

{
    return _debugger != nil;
}

References _debugger, debuggerConnected, and nil.

Referenced by debuggerConnected, and OOJavaScriptConsoleController::validateMenuItem:.

Here is the call graph for this function:

Here is the caller graph for this function:

disconnectDebugger:message:

- (void) disconnectDebugger: (in id<OODebuggerInterface>) debugger message: (in NSString *) message

implementation

Reimplemented from <OODebugMonitorInterface>.

Definition at line 699 of file OODebugMonitor.m.

                          :(in id<OODebuggerInterface>)debugger
                   message:(in NSString *)message
{
    if (debugger == nil)  return;
        
    if (debugger == _debugger)
    {
        [self disconnectDebuggerWithMessage:message];
    }
    else
    {
        OOLog(@"debugMonitor.disconnect.ignored", @"Attempt to disconnect debugger %@, which is not current debugger; ignoring.", debugger);
    }
}

References _debugger, disconnectDebuggerWithMessage:, nil, and OOLog.

Referenced by OOMacDebugger::connectDebugMonitor:errorMessage:, OODebugTCPConsoleClient::dealloc, and OOMacDebugger::dealloc.

Here is the call graph for this function:

Here is the caller graph for this function:

disconnectDebuggerWithMessage:

- (void) disconnectDebuggerWithMessage: (NSString *) message

implementation

Provided by category OODebugMonitor(Private).

Definition at line 781 of file OODebugMonitor.m.

                                     :(NSString *)message
{
    @try
    {
        [_debugger disconnectDebugMonitor:self message:message];
    }
    @catch (NSException *exception)
    {
        OOLog(@"debugMonitor.debuggerConnection.exception", @"Exception while attempting to disconnect debugger: %@ -- %@", [exception name], [exception reason]);
    }
    
    id debugger = _debugger;
    _debugger = nil;
    [debugger release];
}

Referenced by applicationWillTerminate:, dealloc, disconnectDebugger:message:, and setDebugger:.

Here is the caller graph for this function:

dumpEntity:withState:parentVisible:

- (void) dumpEntity: (id) entity withState: (EntityDumpState *) state parentVisible: (BOOL) parentVisible

implementation

Definition at line 423 of file OODebugMonitor.m.

                   :(id)entity withState:(EntityDumpState *)state parentVisible:(BOOL)parentVisible
{
    if ([state->seenEntities containsObject:entity] || entity == nil)  return;
    [state->seenEntities addObject:entity];
    
    state->seenCount++;
    
    size_t entitySize = [entity oo_objectSize];
    size_t drawableSize = 0;
    if ([entity isKindOfClass:[OOEntityWithDrawable class]])
    {
        OODrawable *drawable = [entity drawable];
        drawableSize = [drawable totalSize];
    }
    
    BOOL visible = parentVisible && [entity isVisible];
    
    NSSet *textures = [entity allTextures];
    if (textures != nil)
    {
        [state->entityTextures unionSet:textures];
        if (visible)  [state->visibleEntityTextures unionSet:textures];
    }
    
    NSString *extra = @"";
    if (visible)
    {
        extra = [extra stringByAppendingString:@", visible"];
    }
    
    if (drawableSize != 0)
    {
        extra = [extra stringByAppendingFormat:@", drawable: %@", SizeString(drawableSize)];
    }
    
    [self writeMemStat:@"%@: %@%@", [entity shortDescription], SizeString(entitySize), extra];
    
    state->totalEntityObjSize += entitySize;
    state->totalDrawableSize += drawableSize;
    
    OOLogIndent();
    if ([entity isShip])
    {
        NSEnumerator *subEnum = nil;
        id subentity = nil;
        for (subEnum = [entity subEntityEnumerator]; (subentity = [subEnum nextObject]); )
        {
            [self dumpEntity:subentity withState:state parentVisible:visible];
        }
        
        if ([entity isPlayer])
        {
            NSUInteger i, count = [entity dialMaxMissiles];
            for (i = 0; i < count; i++)
            {
                subentity = [entity missileForPylon:i];
                if (subentity != nil)  [self dumpEntity:subentity withState:state parentVisible:NO];
            }
        }
    }
    if ([entity isPlanet])
    {
#if NEW_PLANETS
        // FIXME: dump atmosphere texture.
#else
        PlanetEntity *atmosphere = [entity atmosphere];
        if (atmosphere != nil)
        {
            [self dumpEntity:atmosphere withState:state parentVisible:visible];
        }
#endif
    }
    if ([entity isWormhole])
    {
        NSEnumerator *shipEnum = nil;
        NSDictionary *shipInfo = nil;
        for (shipEnum = [[entity shipsInTransit] objectEnumerator]; (shipInfo = [shipEnum nextObject]); )
        {
            ShipEntity *ship = [shipInfo objectForKey:@"ship"];
            [self dumpEntity:ship withState:state parentVisible:NO];
        }
    }
    OOLogOutdent();
}

References count, dumpEntity:withState:parentVisible:, nil, OOLogIndent(), OOLogOutdent(), PlanetEntity, EntityDumpState::seenCount, EntityDumpState::seenEntities, EntityDumpState::totalDrawableSize, EntityDumpState::totalEntityObjSize, OODrawable::totalSize, and writeMemStat:.

Referenced by dumpEntity:withState:parentVisible:, and dumpMemoryStatistics.

Here is the call graph for this function:

Here is the caller graph for this function:

dumpJSMemoryStatistics

- (size_t) dumpJSMemoryStatistics

Definition at line 633 of file OODebugMonitor.m.

{
    JSContext *context = OOJSAcquireContext();
    
    JSRuntime *runtime = JS_GetRuntime(context);
    size_t jsSize = JS_GetGCParameter(runtime, JSGC_BYTES);
    size_t jsMax = JS_GetGCParameter(runtime, JSGC_MAX_BYTES);
    uint32_t jsGCCount = JS_GetGCParameter(runtime, JSGC_NUMBER);
    
    OOJSRelinquishContext(context);
    
    [self writeMemStat:@"JavaScript heap: %@ (limit %@, %u collections to date)", SizeString(jsSize), SizeString(jsMax), jsGCCount];
    return jsSize;
}

References dumpJSMemoryStatistics, OOJSAcquireContext(), OOJSRelinquishContext(), and writeMemStat:.

Referenced by ConsoleWriteJSMemoryStats(), dumpJSMemoryStatistics, and dumpMemoryStatistics.

Here is the call graph for this function:

Here is the caller graph for this function:

dumpMemoryStatistics

- (void) dumpMemoryStatistics

Definition at line 509 of file OODebugMonitor.m.

{
    OOLog(@"debug.memStats", @"%@", @"Memory statistics:");
    OOLogIndent();
    
    //  Get texture retain counts before the entity dumper starts messing with them.
    NSSet *allTextures = [OOTexture allTextures];
    NSMutableDictionary *textureRefCounts = [NSMutableDictionary dictionaryWithCapacity:[allTextures count]];
    
    OOTexture *tex = nil;
    NSEnumerator *texEnum = nil;
    for (texEnum = [allTextures objectEnumerator]; (tex = [texEnum nextObject]); )
    {
        // We subtract one because allTextures retains the textures.
        [textureRefCounts setObject:[NSNumber numberWithUnsignedInteger:[tex retainCount] - 1] forKey:[NSValue valueWithNonretainedObject:tex]];
    }
    
    size_t totalSize = 0;
    
    [self writeMemStat:@"Entitites:"];
    OOLogIndent();
    
    NSArray *entities = [UNIVERSE entityList];
    EntityDumpState entityDumpState =
    {
        .entityTextures = [NSMutableSet set],
        .visibleEntityTextures = [NSMutableSet set],
        .seenEntities = [NSMutableSet set]
    };
    
    id entity = nil;
    NSEnumerator *entityEnum = nil;
    for (entityEnum = [entities objectEnumerator]; (entity = [entityEnum nextObject]); )
    {
        [self dumpEntity:entity withState:&entityDumpState parentVisible:YES];
    }
    for (entityEnum = [[PLAYER scannedWormholes] objectEnumerator]; (entity = [entityEnum nextObject]); )
    {
        [self dumpEntity:entity withState:&entityDumpState parentVisible:YES];
    }
    
    OOLogOutdent();
    [self writeMemStat:@"Total entity size (excluding %u entities not accounted for): %@ (%@ entity objects, %@ drawables)",
     gLiveEntityCount - entityDumpState.seenCount,
     SizeString(entityDumpState.totalEntityObjSize + entityDumpState.totalDrawableSize),
     SizeString(entityDumpState.totalEntityObjSize),
     SizeString(entityDumpState.totalDrawableSize)];
    totalSize += entityDumpState.totalEntityObjSize + entityDumpState.totalDrawableSize;
    
    /*  Sort textures so that textures in the "recent cache" come first by age,
        followed by others.
    */
    NSMutableArray *textures = [[[OOTexture cachedTexturesByAge] mutableCopy] autorelease];
    
    for (texEnum = [allTextures objectEnumerator]; (tex = [texEnum nextObject]); )
    {
        if ([textures indexOfObject:tex] == NSNotFound)
        {
            [textures addObject:tex];
        }
    }
    
    size_t totalTextureObjSize = 0;
    size_t totalTextureDataSize = 0;
    size_t visibleTextureDataSize = 0;
    
    [self writeMemStat:@"Textures:"];
    OOLogIndent();
    
    for (texEnum = [textures objectEnumerator]; (tex = [texEnum nextObject]); )
    {
        size_t objSize = [tex oo_objectSize];
        size_t dataSize = [tex dataSize];
        
#if OOTEXTURE_RELOADABLE
        NSString *byteCountSuffix = @"";
#else
        NSString *byteCountSuffix = @" (* 2)";
#endif
        
        NSString *usage = @"";
        if ([entityDumpState.visibleEntityTextures containsObject:tex])
        {
            visibleTextureDataSize += dataSize; // NOT doubled if !OOTEXTURE_RELOADABLE, because we're interested in what the GPU sees.
            usage = @", visible";
        }
        else if ([entityDumpState.entityTextures containsObject:tex])
        {
            usage = @", active";
        }
        
        unsigned refCount = [textureRefCounts oo_unsignedIntForKey:[NSValue valueWithNonretainedObject:tex]];
        
        [self writeMemStat:@"%@: [%u refs%@] %@%@",
         [tex name],
         refCount,
         usage,
         SizeString(objSize + dataSize),
         byteCountSuffix];
        
        totalTextureDataSize += dataSize;
        totalTextureObjSize += objSize;
    }
    totalSize += totalTextureObjSize + totalTextureDataSize;
    
    OOLogOutdent();
    
#if !OOTEXTURE_RELOADABLE
    totalTextureDataSize *= 2;
#endif
    [self writeMemStat:@"Total texture size: %@ (%@ object overhead, %@ data, %@ visible texture data)",
     SizeString(totalTextureObjSize + totalTextureDataSize),
     SizeString(totalTextureObjSize),
     SizeString(totalTextureDataSize),
     SizeString(visibleTextureDataSize)];
    
    totalSize += [self dumpJSMemoryStatistics];
    
    [self writeMemStat:@"Total: %@", SizeString(totalSize)];
    
    OOLogOutdent();
}

References OOTexture::allTextures, OOTexture::cachedTexturesByAge, OOTexture::dataSize, dumpEntity:withState:parentVisible:, dumpJSMemoryStatistics, dumpMemoryStatistics, EntityDumpState::entityTextures, nil, OOLog, OOLogIndent(), OOLogOutdent(), PLAYER, EntityDumpState::totalDrawableSize, EntityDumpState::totalEntityObjSize, EntityDumpState::visibleEntityTextures, and writeMemStat:.

Referenced by ConsoleWriteMemoryStats(), and dumpMemoryStatistics.

Here is the call graph for this function:

Here is the caller graph for this function:

init

- (id) init

implementation

Definition at line 79 of file OODebugMonitor.m.

{
    NSUserDefaults              *defaults = nil;
    NSMutableDictionary         *config = nil;
    
    self = [super init];
    if (self != nil)
    {
        config = [[[ResourceManager dictionaryFromFilesNamed:@"debugConfig.plist"
                                                    inFolder:@"Config"
                                                    andMerge:YES] mutableCopy] autorelease];
        _configFromOXPs = [[self normalizeConfigDictionary:config] copy];
        
        defaults = [NSUserDefaults standardUserDefaults];
        config = [self normalizeConfigDictionary:[defaults dictionaryForKey:@"debug-settings-override"]];
        if (config == nil)  config = [NSMutableDictionary dictionary];
        _configOverrides = [config retain];
        
        _TCPIgnoresDroppedPackets = NO;
        
        OOJavaScriptEngine *jsEng = [OOJavaScriptEngine sharedEngine];
#if OOJSENGINE_MONITOR_SUPPORT
        [jsEng setMonitor:self];
#endif
        
        [self setUpDebugConsoleScript];
        
        [[NSNotificationCenter defaultCenter] addObserver:self
                                                 selector:@selector(applicationWillTerminate:)
                                                     name:NSApplicationWillTerminateNotification
                                                   object:nil];
        
        [[NSNotificationCenter defaultCenter] addObserver:self
                                                 selector:@selector(javaScriptEngineWillReset:)
                                                     name:kOOJavaScriptEngineWillResetNotification
                                                   object:jsEng];
        
        [[NSNotificationCenter defaultCenter] addObserver:self
                                                 selector:@selector(setUpDebugConsoleScript)
                                                     name:kOOJavaScriptEngineDidResetNotification
                                                   object:jsEng];
    }
    
    return self;
}

References _configFromOXPs, _configOverrides, _TCPIgnoresDroppedPackets, ResourceManager::dictionaryFromFilesNamed:inFolder:andMerge:, init, nil, normalizeConfigDictionary:, OOJavaScriptEngine::setMonitor:, setUpDebugConsoleScript, and OOJavaScriptEngine::sharedEngine.

Referenced by init.

Here is the call graph for this function:

Here is the caller graph for this function:

javaScriptEngineWillReset:

- (void) javaScriptEngineWillReset: (NSNotification *) notification

implementation

Provided by category OODebugMonitor(Private).

Definition at line 772 of file OODebugMonitor.m.

                                  :(NSNotification *)notification
{
    DESTROY(_script);
    _jsSelf = NULL;
    
    OOJSConsoleDestroy();
}

jsEngine:context:error:stackSkip:showingLocation:withMessage:

- (oneway void) jsEngine: (in byref OOJavaScriptEngine *) engine context: (in JSContext *) context error: (in JSErrorReport *) errorReport stackSkip: (in unsigned) stackSkip showingLocation: (in BOOL) showLocation withMessage: (in NSString *) message

implementation

Provided by category OODebugMonitor(Private).

Definition at line 871 of file OODebugMonitor.m.

                       :(in byref OOJavaScriptEngine *)engine
                context:(in JSContext *)context
                  error:(in JSErrorReport *)errorReport
              stackSkip:(in unsigned)stackSkip
        showingLocation:(in BOOL)showLocation
            withMessage:(in NSString *)message
{
    NSString                    *colorKey = nil;
    NSString                    *prefix = nil;
    NSString                    *filePath = nil;
    NSString                    *sourceLine = nil;
    NSString                    *scriptLine = nil;
    NSMutableString             *formattedMessage = nil;
    NSRange                     emphasisRange;
    NSString                    *showKey = nil;
    
    if (_debugger == nil)  return;
    
    if (errorReport->flags & JSREPORT_WARNING)
    {
        colorKey = @"warning";
        prefix = @"Warning";
    }
    else if (errorReport->flags & JSREPORT_EXCEPTION)
    {
        colorKey = @"exception";
        prefix = @"Exception";
    }
    else
    {
        colorKey = @"error";
        prefix = @"Error";
    }
    
    if (errorReport->flags & JSREPORT_STRICT)
    {
        prefix = [prefix stringByAppendingString:@" (strict mode)"];
    }
    
    // Prefix and subsequent colon should be bold:
    emphasisRange = NSMakeRange(0, [prefix length] + 1);
    
    formattedMessage = [NSMutableString stringWithFormat:@"%@: %@", prefix, message];
    
    // Note that the "active script" isn't necessarily the one causing the
    // error, since one script can call another's methods.
    
    // avoid windows DEP exceptions!
    OOJSScript *thisScript = [[OOJSScript currentlyRunningScript] weakRetain];
    scriptLine = [[thisScript weakRefUnderlyingObject] displayName];
    [thisScript release];
    
    if (scriptLine != nil)
    {
        [formattedMessage appendFormat:@"\n    Active script: %@", scriptLine];
    }
    
    if (showLocation && stackSkip == 0)
    {
        // Append file name and line
        if (errorReport->filename != NULL)  filePath = [NSString stringWithUTF8String:errorReport->filename];
        if ([filePath length] != 0)
        {
            [formattedMessage appendFormat:@"\n    %@, line %u", [filePath lastPathComponent], errorReport->lineno];
            
            // Append source code
            sourceLine = [self sourceCodeForFile:filePath line:errorReport->lineno];
            if (sourceLine != nil)
            {
                [formattedMessage appendFormat:@":\n    %@", sourceLine];
            }
        }
    }
    
    [self appendJSConsoleLine:formattedMessage
                     colorKey:colorKey
                emphasisRange:emphasisRange];
    
    if (errorReport->flags & JSREPORT_WARNING)  showKey = @"show-console-on-warning";
    else  showKey = @"show-console-on-error";   // if not a warning, it's a proper error.
    if (OOBooleanFromObject([self configurationValueForKey:showKey], NO))
    {
        [self showJSConsole];
    }
}

jsEngine:context:logMessage:ofClass:

- (oneway void) jsEngine: (in byref OOJavaScriptEngine *) engine context: (in JSContext *) context logMessage: (in NSString *) message ofClass: (in NSString *) messageClass

implementation

Provided by category OODebugMonitor(Private).

Definition at line 958 of file OODebugMonitor.m.

                       :(in byref OOJavaScriptEngine *)engine
                context:(in JSContext *)context
             logMessage:(in NSString *)message
                ofClass:(in NSString *)messageClass
{
    [self appendJSConsoleLine:message colorKey:@"log"];
    if (OOBooleanFromObject([self configurationValueForKey:@"show-console-on-log"], NO))
    {
        [self showJSConsole];
    }
}

loadSourceFile:

- (NSArray *) loadSourceFile: (NSString *) filePath

implementation

Provided by category OODebugMonitor(Private).

Definition at line 810 of file OODebugMonitor.m.

                           :(NSString *)filePath
{
    NSString                    *contents = nil;
    NSArray                     *lines = nil;
    
    if (filePath == nil)  return nil;
    
    contents = [NSString stringWithContentsOfUnicodeFile:filePath];
    if (contents == nil)  return nil;
    
    /*  Extract lines from file.
FIXME: this works with CRLF and LF, but not CR.
        */
    lines = [contents componentsSeparatedByString:@"\n"];
    return lines;
}

Referenced by sourceCodeForFile:line:.

Here is the caller graph for this function:

mergedConfiguration

- (NSDictionary *) mergedConfiguration

implementation

Provided by category OODebugMonitor(Private).

Definition at line 798 of file OODebugMonitor.m.

{
    NSMutableDictionary         *result = nil;
    
    result = [NSMutableDictionary dictionary];
    if (_configFromOXPs != nil)  [result addEntriesFromDictionary:_configFromOXPs];
    if (_configOverrides != nil)  [result addEntriesFromDictionary:_configOverrides];
    
    return result;
}

Referenced by setDebugger:.

Here is the caller graph for this function:

normalizeConfigDictionary:

- (NSMutableDictionary *) normalizeConfigDictionary: (NSDictionary *) dictionary

implementation

Provided by category OODebugMonitor(Private).

Definition at line 828 of file OODebugMonitor.m.

                                                  :(NSDictionary *)dictionary
{
    NSMutableDictionary     *result = nil;
    NSEnumerator            *keyEnum = nil;
    NSString                *key = nil;
    id                      value = nil;
    
    result = [NSMutableDictionary dictionaryWithCapacity:[dictionary count]];
    for (keyEnum = [dictionary keyEnumerator]; (key = [keyEnum nextObject]); )
    {
        value = [dictionary objectForKey:key];
        value = [self normalizeConfigValue:value forKey:key];
        
        if (key != nil && value != nil)  [result setObject:value forKey:key];
    }
    
    return result;
}

Referenced by init.

Here is the caller graph for this function:

normalizeConfigValue:forKey:

- (id) normalizeConfigValue: (id) value forKey: (NSString *) key

implementation

Provided by category OODebugMonitor(Private).

Definition at line 848 of file OODebugMonitor.m.

                          :(id)value forKey:(NSString *)key
{
    OOColor                 *color = nil;
    BOOL                    boolValue;
    
    if (value != nil)
    {
        if ([key hasSuffix:@"-color"] || [key hasSuffix:@"-colour"])
        {
            color = [OOColor colorWithDescription:value];
            value = [color normalizedArray];
        }
        else if ([key hasPrefix:@"show-console"])
        {
            boolValue = OOBooleanFromObject(value, NO);
            value = [NSNumber numberWithBool:boolValue];
        }
    }
    
    return value;
}

Referenced by OODebugMonitor(Private)::normalizeConfigDictionary:, and setConfigurationValue:forKey:.

Here is the caller graph for this function:

oo_jsValueInContext:

- (jsval) oo_jsValueInContext: (JSContext *) context

implementation

Provided by category OODebugMonitor(Private).

Definition at line 971 of file OODebugMonitor.m.

                            :(JSContext *)context
{
    if (_jsSelf == NULL)
    {
        _jsSelf = DebugMonitorToJSConsole(context, self);
        if (_jsSelf != NULL)
        {
            if (!OOJSAddGCObjectRoot(context, &_jsSelf, "debug console"))
            {
                _jsSelf = NULL;
            }
        }
    }
    
    if (_jsSelf != NULL)  return OBJECT_TO_JSVAL(_jsSelf);
    else  return JSVAL_NULL;
}

performJSConsoleCommand:

- (oneway void) performJSConsoleCommand: (in NSString *) command

implementation

Reimplemented from <OODebugMonitorInterface>.

Definition at line 201 of file OODebugMonitor.m.

                                      :(in NSString *)command
{
    JSContext *context = OOJSAcquireContext();
    jsval commandVal = OOJSValueFromNativeObject(context, command);
    OOJSStartTimeLimiterWithTimeLimit(kOOJSLongTimeLimit);
    [_script callMethod:OOJSID("consolePerformJSCommand") inContext:context withArguments:&commandVal count:1 result:NULL];
    OOJSStopTimeLimiter();
    OOJSRelinquishContext(context);
}

References OOJSScript::callMethod:inContext:withArguments:count:result:, kOOJSLongTimeLimit, OOJSAcquireContext(), OOJSRelinquishContext(), OOJSStartTimeLimiterWithTimeLimit, OOJSStopTimeLimiter, and OOJSValueFromNativeObject().

Referenced by OODebugController::hideShowHUD:, OODebugController::insertLogSeparatorAction:, OODebugController::inspectPlayer:, OODebugController::inspectTarget:, OOMacDebugger::performConsoleCommand:, OODebugController::SetDisplayLogMessagesInClassThroughJS, OODebugController::setShaderModeToTag:, OODebugController::spawnShip:, and OODebugController::toggleThisDebugFlagAction:.

Here is the call graph for this function:

Here is the caller graph for this function:

release

- (void) release

implementation

Provided by category OODebugMonitor(Singleton).

Definition at line 1030 of file OODebugMonitor.m.

{}

Referenced by OOShipRegistry::reload.

Here is the caller graph for this function:

retain

- (id) retain

implementation

Provided by category OODebugMonitor(Singleton).

Definition at line 1018 of file OODebugMonitor.m.

{
    return self;
}

retainCount

- (NSUInteger) retainCount

implementation

Provided by category OODebugMonitor(Singleton).

Definition at line 1024 of file OODebugMonitor.m.

{
    return UINT_MAX;
}

setConfigurationValue:forKey:

- (void) setConfigurationValue: (in id) value forKey: (in NSString *) key

implementation

Reimplemented from <OODebugMonitorInterface>.

Definition at line 307 of file OODebugMonitor.m.

                             :(in id)value forKey:(in NSString *)key
{
    if (key == nil)  return;
    
    value = [self normalizeConfigValue:value forKey:key];
    
    if (value == nil)
    {
        [_configOverrides removeObjectForKey:key];
    }
    else
    {
        if (_configOverrides == nil)  _configOverrides = [[NSMutableDictionary alloc] init];
        [_configOverrides setObject:value forKey:key];
    }
    
    // Send changed value to debugger
    if (value == nil)
    {
        // Setting a nil value removes an override, and may reveal an underlying OXP-defined value
        value = [self configurationValueForKey:key];
    }
    @try
    {
        [_debugger debugMonitor:self
   noteChangedConfigrationValue:value
                         forKey:key];
    }
    @catch (NSException *exception)
    {
        OOLog(@"debugMonitor.debuggerConnection.exception", @"Exception while attempting to send configuration update to debugger: %@ -- %@", [exception name], [exception reason]);
    }
}

References _configOverrides, configurationValueForKey:, nil, normalizeConfigValue:forKey:, and OOLog.

Referenced by OOMacDebugger::setConfigurationValue:forKey:.

Here is the call graph for this function:

Here is the caller graph for this function:

setDebugger:

- (BOOL) setDebugger:

(id<OODebuggerInterface>)

debugger

Definition at line 158 of file OODebugMonitor.m.

                   :(id<OODebuggerInterface>)newDebugger
{
    NSString                    *error = nil;
    
    if (newDebugger != _debugger)
    {
        // Disconnect existing debugger, if any.
        if (newDebugger != nil)
        {
            [self disconnectDebuggerWithMessage:@"New debugger set."];
        }
        else
        {
            [self disconnectDebuggerWithMessage:@"Debugger disconnected programatically."];
        }
        
        // If a new debugger was specified, try to connect it.
        if (newDebugger != nil)
        {
            @try
            {
                if ([newDebugger connectDebugMonitor:self errorMessage:&error])
                {
                    [newDebugger debugMonitor:self
                            noteConfiguration:[self mergedConfiguration]];
                    _debugger = [newDebugger retain];
                }
                else
                {
                    OOLog(@"debugMonitor.setDebugger.failed", @"Could not connect to debugger %@, because an error occurred: %@", newDebugger, error);
                }
            }
            @catch (NSException *exception)
            {
                OOLog(@"debugMonitor.setDebugger.failed", @"Could not connect to debugger %@, because an exception occurred: %@ -- %@", newDebugger, [exception name], [exception reason]);
            }
        }
    }
    
    return _debugger == newDebugger;
}

References _debugger, disconnectDebuggerWithMessage:, mergedConfiguration, nil, and OOLog.

Referenced by OOInitDebugSupport(), and PlayerEntity(OOControlsPrivate)::pollFlightControls:.

Here is the call graph for this function:

Here is the caller graph for this function:

setTCPIgnoresDroppedPackets:

- (void) setTCPIgnoresDroppedPackets:

(BOOL)

flag

Definition at line 649 of file OODebugMonitor.m.

                                    :(BOOL)flag
{
    if (_TCPIgnoresDroppedPackets != flag)
    {
        OOLog(@"debugMonitor.TCPSettings", @"The TCP console will %@ TCP packets.",
                (flag ? @"try to stay connected, ignoring dropped" : @"disconnect if an error affects"));
    }
    _TCPIgnoresDroppedPackets = flag;
}

References _TCPIgnoresDroppedPackets, and OOLog.

Referenced by ConsoleSetProperty().

Here is the caller graph for this function:

setUpDebugConsoleScript

- (void) setUpDebugConsoleScript

implementation

Provided by category OODebugMonitor(Private).

Definition at line 739 of file OODebugMonitor.m.

{
    JSContext *context = OOJSAcquireContext();
    /*  The path to the console script is saved in this here static variable
        so that we can reload it when resetting into strict mode.
        -- Ahruman 2011-02-06
    */
    static NSString *path = nil;
    
    if (path == nil)
    {
        path = [[ResourceManager pathForFileNamed:@"oolite-debug-console.js" inFolder:@"Scripts"] retain];
    }
    if (path != nil)
    {
        NSDictionary *jsProps = [NSDictionary dictionaryWithObjectsAndKeys:
                                 self, @"console",
                                 JSSpecialFunctionsObjectWrapper(context), @"special",
                                 nil];
        _script = [[OOJSScript scriptWithPath:path properties:jsProps] retain];
    }
    
    // If no script, just make console visible globally as debugConsole.
    if (_script == nil)
    {
        JSObject *global = [[OOJavaScriptEngine sharedEngine] globalObject];
        JS_DefineProperty(context, global, "debugConsole", [self oo_jsValueInContext:context], NULL, NULL, JSPROP_ENUMERATE);
    }
    
    OOJSRelinquishContext(context);
}

Referenced by init.

Here is the caller graph for this function:

setUsingPlugInController:

- (void) setUsingPlugInController:

(BOOL)

flag

Definition at line 666 of file OODebugMonitor.m.

                                 :(BOOL)flag
{
    _usingPlugInController = flag;
}

References _usingPlugInController.

Referenced by OOInitDebugSupport().

Here is the caller graph for this function:

sharedDebugMonitor

+ (OODebugMonitor *) sharedDebugMonitor

Definition at line 146 of file OODebugMonitor.m.

{
    // NOTE: assumes single-threaded access. The debug monitor is not, on the whole, thread safe.
    if (sSingleton == nil)
    {
        sSingleton = [[self alloc] init];
    }
    
    return sSingleton;
}

References nil, sharedDebugMonitor, and sSingleton.

Referenced by ConsoleSetProperty(), ConsoleWriteJSMemoryStats(), ConsoleWriteMemoryStats(), OODebugController::hideShowHUD:, OODebugController::insertLogSeparatorAction:, OODebugController::inspectPlayer:, OODebugController::inspectTarget:, OOInitDebugSupport(), PlayerEntity(OOControlsPrivate)::pollFlightControls:, OODebugController::SetDisplayLogMessagesInClassThroughJS, OODebugController::setShaderModeToTag:, sharedDebugMonitor, OOJavaScriptConsoleController::showConsole:, OODebugController::spawnShip:, OODebugController::toggleThisDebugFlagAction:, and OOJavaScriptConsoleController::validateMenuItem:.

Here is the call graph for this function:

Here is the caller graph for this function:

showJSConsole

- (void) showJSConsole

Definition at line 257 of file OODebugMonitor.m.

{
    OOJSPauseTimeLimiter();
    @try
    {
        [_debugger debugMonitorShowConsole:self];
    }
    @catch (NSException *exception)
    {
        OOLog(@"debugMonitor.debuggerConnection.exception", @"Exception while attempting to show JavaScript console: %@ -- %@", [exception name], [exception reason]);
    }
    OOJSResumeTimeLimiter();
}

References OOJSPauseTimeLimiter(), OOJSResumeTimeLimiter(), OOLog, and showJSConsole.

Referenced by OODebugMonitor(Private)::jsEngine:context:error:stackSkip:showingLocation:withMessage:, OODebugMonitor(Private)::jsEngine:context:logMessage:ofClass:, OOJavaScriptConsoleController::showConsole:, and showJSConsole.

Here is the call graph for this function:

Here is the caller graph for this function:

SizeString

+ (static NSString *) SizeString (size_t) size

implementation

Definition at line 374 of file OODebugMonitor.m.

{
    enum
    {
        kThreshold = 2  // 2 KiB, 2 MiB etc.
    };
    
    unsigned magnitude = 0;
    NSString *suffix = @"";
    
    if (size < kThreshold << 10)
    {
        return [NSString stringWithFormat:@"%zu bytes", size];
    }
    if (size < kThreshold << 20)
    {
        magnitude = 1;
        suffix = @"KiB";
    }
    else if (size < ((size_t)kThreshold << 30))
    {
        magnitude = 2;
        suffix = @"MiB";
    }
    else
    {
        magnitude = 3;
        suffix = @"GiB";
    }
    
    float unit = 1 << (magnitude * 10);
    float sizef = (float)size / unit;
    sizef = round(sizef * 100.0f) / 100.f;
    
    return [NSString stringWithFormat:@"%.2f %@", sizef, suffix];
}

sourceCodeForFile:line:

- (NSString *) sourceCodeForFile: (in NSString *) filePath line: (in unsigned) line

implementation

Reimplemented from <OODebugMonitorInterface>.

Definition at line 678 of file OODebugMonitor.m.

                               :(in NSString *)filePath line:(in unsigned)line
{
    id                          linesForFile = nil;
    
    linesForFile = [_sourceFiles objectForKey:filePath];
    
    if (linesForFile == nil)
    {
        linesForFile = [self loadSourceFile:filePath];
        if (linesForFile == nil)  linesForFile = [NSArray arrayWithObject:[NSString stringWithFormat:@"<Can't load file %@>", filePath]];
        
        if (_sourceFiles == nil)  _sourceFiles = [[NSMutableDictionary alloc] init];
        [_sourceFiles setObject:linesForFile forKey:filePath];
    }
    
    if ([linesForFile count] < line || line == 0)  return @"<line out of range!>";
    
    return [linesForFile objectAtIndex:line - 1];
}

References _sourceFiles, count, loadSourceFile:, and nil.

Referenced by OODebugMonitor(Private)::jsEngine:context:error:stackSkip:showingLocation:withMessage:.

Here is the call graph for this function:

Here is the caller graph for this function:

TCPIgnoresDroppedPackets

- (BOOL) TCPIgnoresDroppedPackets

Definition at line 660 of file OODebugMonitor.m.

{
    return _TCPIgnoresDroppedPackets;
}

References _TCPIgnoresDroppedPackets, and TCPIgnoresDroppedPackets.

Referenced by TCPIgnoresDroppedPackets.

Here is the call graph for this function:

Here is the caller graph for this function:

usingPlugInController

- (BOOL) usingPlugInController

Definition at line 672 of file OODebugMonitor.m.

{
    return _usingPlugInController;
}

References _usingPlugInController, and usingPlugInController.

Referenced by usingPlugInController.

Here is the call graph for this function:

Here is the caller graph for this function:

writeMemStat:

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

implementation

Definition at line 360 of file OODebugMonitor.m.

                     :(NSString *)format, ...
{
    va_list args;
    va_start(args, format);
    NSString *message = [[NSString alloc] initWithFormat:format arguments:args];
    va_end(args);
    
    OOLog(@"debug.memStats", @"%@", message);
    [self appendJSConsoleLine:message colorKey:@"command-result"];
    
    [message release];
}

References appendJSConsoleLine:colorKey:, and OOLog.

Referenced by dumpEntity:withState:parentVisible:, dumpJSMemoryStatistics, and dumpMemoryStatistics.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

_bgColors

- (NSMutableDictionary *) _bgColors

private

Definition at line 80 of file OODebugMonitor.h.

_configFromOXPs

- (NSDictionary*) _configFromOXPs

private

Definition at line 75 of file OODebugMonitor.h.

Referenced by init.

_configOverrides

- (NSMutableDictionary*) _configOverrides

private

Definition at line 76 of file OODebugMonitor.h.

Referenced by applicationWillTerminate:, init, and setConfigurationValue:forKey:.

_debugger

- (id<OODebuggerInterface>) _debugger

private

Definition at line 69 of file OODebugMonitor.h.

Referenced by debuggerConnected, disconnectDebugger:message:, and setDebugger:.

_fgColors

- (NSMutableDictionary*) _fgColors

private

Definition at line 79 of file OODebugMonitor.h.

_jsSelf

- (struct JSObject*) _jsSelf

private

Definition at line 73 of file OODebugMonitor.h.

Referenced by dealloc.

_script

- (OOJSScript*) _script

private

Definition at line 72 of file OODebugMonitor.h.

_sourceFiles

- (NSMutableDictionary *) _sourceFiles

private

Definition at line 81 of file OODebugMonitor.h.

Referenced by sourceCodeForFile:line:.

_TCPIgnoresDroppedPackets

- (BOOL) _TCPIgnoresDroppedPackets

private

Definition at line 83 of file OODebugMonitor.h.

Referenced by init, setTCPIgnoresDroppedPackets:, and TCPIgnoresDroppedPackets.

_usingPlugInController

- (BOOL) _usingPlugInController

private

Definition at line 84 of file OODebugMonitor.h.

Referenced by setUsingPlugInController:, and usingPlugInController.

---

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

• src/Core/Debug/OODebugMonitor.h
• src/Core/Debug/OODebugMonitor.m