OODebugMonitor(Private) Category Reference

Inheritance diagram for OODebugMonitor(Private):

Collaboration diagram for OODebugMonitor(Private):

Instance Methods
(void)	- setUpDebugConsoleScript
(void)	- javaScriptEngineWillReset:
(void)	- disconnectDebuggerWithMessage:
(NSDictionary *)	- mergedConfiguration
(NSMutableDictionary *)	- normalizeConfigDictionary:
(id)	- normalizeConfigValue:forKey:
(NSArray *)	- loadSourceFile:
(oneway void)	- jsEngine:context:error:stackSkip:showingLocation:withMessage: [implementation]
(oneway void)	- jsEngine:context:logMessage:ofClass: [implementation]
(jsval)	- oo_jsValueInContext: [implementation]

Detailed Description

Definition at line 53 of file OODebugMonitor.m.

Method Documentation

disconnectDebuggerWithMessage:

- (void) disconnectDebuggerWithMessage:

(NSString *)

message

Extends class OODebugMonitor.

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

javaScriptEngineWillReset:

- (void) javaScriptEngineWillReset:

(NSNotification *)

notification

Extends class OODebugMonitor.

Definition at line 419 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

Extends class OODebugMonitor.

Definition at line 419 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

Extends class OODebugMonitor.

Definition at line 419 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

Extends class OODebugMonitor.

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

mergedConfiguration

- (NSDictionary *) mergedConfiguration

Extends class OODebugMonitor.

Definition at line 419 of file OODebugMonitor.m.

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

normalizeConfigDictionary:

- (NSMutableDictionary *) normalizeConfigDictionary:

(NSDictionary *)

dictionary

Extends class OODebugMonitor.

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

normalizeConfigValue:forKey:

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

Extends class OODebugMonitor.

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

oo_jsValueInContext:

- (jsval) oo_jsValueInContext: (JSContext *) context

implementation

Extends class OODebugMonitor.

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

setUpDebugConsoleScript

- (void) setUpDebugConsoleScript

Extends class OODebugMonitor.

Definition at line 419 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);
}

---

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

• src/Core/Debug/OODebugMonitor.m