OOJSConsole.m File Reference

import "OOJSConsole.h"
import "OODebugMonitor.h"
#include <stdint.h>
import "OOJSEngineTimeManagement.h"
import "OOJSScript.h"
import "OOJSVector.h"
import "OOJSEntity.h"
import "OOJSCall.h"
import "OOLoggingExtended.h"
import "OOConstToString.h"
import "OOOpenGLExtensionManager.h"
import "OODebugFlags.h"
import "OOProfilingStopwatch.h"
import "ResourceManager.h"

Include dependency graph for OOJSConsole.m:

Go to the source code of this file.

Classes
category	Entity(OODebugInspector)

Macros
#define	DEBUG_FLAG_DECL(x)   { #x, kConsole_##x, OOJS_PROP_READONLY_CB }
#define	DEBUG_FLAG_CASE(x)   case kConsole_##x: *value = INT_TO_JSVAL(x); break;

Enumerations
enum	{   kConsole_debugFlags , kConsole_detailLevel , kConsole_maximumDetailLevel , kConsole_displayFPS ,   kConsole_platformDescription , kConsole_ignoreDroppedPackets , kConsole_pedanticMode , kConsole_showErrorLocations ,   kConsole_dumpStackForErrors , kConsole_dumpStackForWarnings , kConsole_glVendorString , kConsole_glRendererString ,   kConsole_glFixedFunctionTextureUnitCount , kConsole_glFragmentShaderTextureUnitCount , kConsole_DEBUG_LINKED_LISTS , kConsole_DEBUG_COLLISIONS ,   kConsole_DEBUG_DOCKING , kConsole_DEBUG_OCTREE_LOGGING , kConsole_DEBUG_BOUNDING_BOXES , kConsole_DEBUG_OCTREE_DRAW ,   kConsole_DEBUG_DRAW_NORMALS , kConsole_DEBUG_NO_DUST , kConsole_DEBUG_NO_SHADER_FALLBACK , kConsole_DEBUG_SHADER_VALIDATION ,   kConsole_DEBUG_MISC }

Functions
NSString *	OOPlatformDescription (void)
static JSBool	ConsoleGetProperty (JSContext *context, JSObject *this, jsid propID, jsval *value)
static JSBool	ConsoleSetProperty (JSContext *context, JSObject *this, jsid propID, JSBool strict, jsval *value)
static void	ConsoleFinalize (JSContext *context, JSObject *this)
static JSBool	ConsoleConsoleMessage (JSContext *context, uintN argc, jsval *vp)
static JSBool	ConsoleClearConsole (JSContext *context, uintN argc, jsval *vp)
static JSBool	ConsoleScriptStack (JSContext *context, uintN argc, jsval *vp)
static JSBool	ConsoleInspectEntity (JSContext *context, uintN argc, jsval *vp)
static JSBool	ConsoleIsExecutableJavaScript (JSContext *context, uintN argc, jsval *vp)
static JSBool	ConsoleDisplayMessagesInClass (JSContext *context, uintN argc, jsval *vp)
static JSBool	ConsoleSetDisplayMessagesInClass (JSContext *context, uintN argc, jsval *vp)
static JSBool	ConsoleWriteLogMarker (JSContext *context, uintN argc, jsval *vp)
static JSBool	ConsoleWriteMemoryStats (JSContext *context, uintN argc, jsval *vp)
static JSBool	ConsoleWriteJSMemoryStats (JSContext *context, uintN argc, jsval *vp)
static JSBool	ConsoleGarbageCollect (JSContext *context, uintN argc, jsval *vp)
static JSBool	ConsoleSettingsDeleteProperty (JSContext *context, JSObject *this, jsid propID, jsval *value)
static JSBool	ConsoleSettingsGetProperty (JSContext *context, JSObject *this, jsid propID, jsval *value)
static JSBool	ConsoleSettingsSetProperty (JSContext *context, JSObject *this, jsid propID, JSBool strict, jsval *value)
static void	InitOOJSConsole (JSContext *context, JSObject *global)
void	OOJSConsoleDestroy (void)
JSObject *	DebugMonitorToJSConsole (JSContext *context, OODebugMonitor *monitor)
static BOOL	DoWeDefineAllDebugFlags (enum OODebugFlags flags) GCC_ATTR((unused))

Variables
static JSObject *	sConsolePrototype = NULL
static JSObject *	sConsoleSettingsPrototype = NULL
static JSClass	sConsoleClass
static JSPropertySpec	sConsoleProperties []
static JSFunctionSpec	sConsoleMethods []
static JSClass	sConsoleSettingsClass

Macro Definition Documentation

DEBUG_FLAG_CASE

#define DEBUG_FLAG_CASE

(

x

)

case kConsole_##x: *value = INT_TO_JSVAL(x); break;

DEBUG_FLAG_DECL

#define DEBUG_FLAG_DECL

(

x

)

{ #x, kConsole_##x, OOJS_PROP_READONLY_CB }

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
kConsole_debugFlags
kConsole_detailLevel
kConsole_maximumDetailLevel
kConsole_displayFPS
kConsole_platformDescription
kConsole_ignoreDroppedPackets
kConsole_pedanticMode
kConsole_showErrorLocations
kConsole_dumpStackForErrors
kConsole_dumpStackForWarnings
kConsole_glVendorString
kConsole_glRendererString
kConsole_glFixedFunctionTextureUnitCount
kConsole_glFragmentShaderTextureUnitCount
kConsole_DEBUG_LINKED_LISTS
kConsole_DEBUG_COLLISIONS
kConsole_DEBUG_DOCKING
kConsole_DEBUG_OCTREE_LOGGING
kConsole_DEBUG_BOUNDING_BOXES
kConsole_DEBUG_OCTREE_DRAW
kConsole_DEBUG_DRAW_NORMALS
kConsole_DEBUG_NO_DUST
kConsole_DEBUG_NO_SHADER_FALLBACK
kConsole_DEBUG_SHADER_VALIDATION
kConsole_DEBUG_MISC

Definition at line 120 of file OOJSConsole.m.

{
    // Property IDs
    kConsole_debugFlags,                        // debug flags, integer, read/write
    kConsole_detailLevel,                       // graphics detail level, symbolic string, read/write
    kConsole_maximumDetailLevel,                // maximum graphics detail level, symbolic string, read-only
    kConsole_displayFPS,                        // display FPS (and related info), boolean, read/write
    kConsole_platformDescription,               // Information about system we're running on in unspecified format, string, read-only
    kConsole_ignoreDroppedPackets,              // boolean (default false), read/write
    kConsole_pedanticMode,                      // JS pedantic mode (JS_STRICT flag, not the same as "use strict"), boolean (default true), read/write
    kConsole_showErrorLocations,                // Show error/warning source locations, boolean (default true), read/write
    kConsole_dumpStackForErrors,                // Write stack dump when reporting error/exception, boolean (default false), read/write
    kConsole_dumpStackForWarnings,              // Write stack dump when reporting warning, boolean (default false), read/write
    
    kConsole_glVendorString,                    // OpenGL GL_VENDOR string, string, read-only
    kConsole_glRendererString,                  // OpenGL GL_RENDERER string, string, read-only
    kConsole_glFixedFunctionTextureUnitCount,   // GL_MAX_TEXTURE_UNITS_ARB, integer, read-only
    kConsole_glFragmentShaderTextureUnitCount,  // GL_MAX_TEXTURE_IMAGE_UNITS_ARB, integer, read-only
    
    // Symbolic constants for debug flags:
    kConsole_DEBUG_LINKED_LISTS,
    kConsole_DEBUG_COLLISIONS,
    kConsole_DEBUG_DOCKING,
    kConsole_DEBUG_OCTREE_LOGGING,
    kConsole_DEBUG_BOUNDING_BOXES,
    kConsole_DEBUG_OCTREE_DRAW,
    kConsole_DEBUG_DRAW_NORMALS,
    kConsole_DEBUG_NO_DUST,
    kConsole_DEBUG_NO_SHADER_FALLBACK,
    kConsole_DEBUG_SHADER_VALIDATION,
    
    kConsole_DEBUG_MISC
};

Function Documentation

ConsoleClearConsole()

static JSBool ConsoleClearConsole ( JSContext * context, uintN argc, jsval * vp )

static

Definition at line 693 of file OOJSConsole.m.

{
    OOJS_NATIVE_ENTER(context)
    
    id                  monitor = nil;
    
    monitor = OOJSNativeObjectFromJSObject(context, OOJS_THIS);
    if (![monitor isKindOfClass:[OODebugMonitor class]])
    {
        OOJSReportError(context, @"Expected OODebugMonitor, got %@ in %s. %@", [monitor class], __PRETTY_FUNCTION__, @"This is an internal error, please report it.");
        return NO;
    }
    
    [monitor clearJSConsole];
    OOJS_RETURN_VOID;
    
    OOJS_NATIVE_EXIT
}

References nil, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJS_RETURN_VOID, OOJS_THIS, OOJSNativeObjectFromJSObject(), and OOJSReportError().

Here is the call graph for this function:

ConsoleConsoleMessage()

static JSBool ConsoleConsoleMessage ( JSContext * context, uintN argc, jsval * vp )

static

Definition at line 631 of file OOJSConsole.m.

{
    NSRange             emphasisRange = {0, 0};
    
    OOJS_NATIVE_ENTER(context)
    
    id                  monitor = nil;
    NSString            *colorKey = nil,
                        *message = nil;
    jsdouble            location, length;
    
    // Not OOJS_BEGIN_FULL_NATIVE() - we use JSAPI while paused.
    OOJSPauseTimeLimiter();
    monitor = OOJSNativeObjectOfClassFromJSObject(context, OOJS_THIS, [OODebugMonitor class]);
    if (monitor == nil)
    {
        OOJSReportError(context, @"Expected OODebugMonitor, got %@ in %s. %@", [monitor class], __PRETTY_FUNCTION__, @"This is an internal error, please report it.");
        OOJSResumeTimeLimiter();
        return NO;
    }
    
    if (argc > 0) colorKey = OOStringFromJSValue(context,OOJS_ARGV[0]);
    if (argc > 1) message = OOStringFromJSValue(context,OOJS_ARGV[1]);
    
    if (argc > 3)
    {
        // Attempt to get two numbers, specifying an emphasis range.
        if (JS_ValueToNumber(context, OOJS_ARGV[2], &location) &&
            JS_ValueToNumber(context, OOJS_ARGV[3], &length))
        {
            emphasisRange = (NSRange){location, length};
        }
    }
    
    if (message == nil)
    {
        if (colorKey == nil)
        {
            OOJSReportWarning(context, @"Console.consoleMessage() called with no parameters.");
        }
        else
        {
            message = colorKey;
            colorKey = @"command-result";
        }
    }
    
    if (message != nil)
    {
        [monitor appendJSConsoleLine:message
                            colorKey:colorKey
                       emphasisRange:emphasisRange];
    }
    OOJSResumeTimeLimiter();
    
    OOJS_RETURN_VOID;
    
    OOJS_NATIVE_EXIT
}

References nil, OOJS_ARGV, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJS_RETURN_VOID, OOJS_THIS, OOJSNativeObjectOfClassFromJSObject(), OOJSPauseTimeLimiter(), OOJSReportError(), OOJSReportWarning(), OOJSResumeTimeLimiter(), and OOStringFromJSValue().

Here is the call graph for this function:

ConsoleDisplayMessagesInClass()

static JSBool ConsoleDisplayMessagesInClass ( JSContext * context, uintN argc, jsval * vp )

static

Definition at line 826 of file OOJSConsole.m.

{
    OOJS_NATIVE_ENTER(context)
    
    NSString                *messageClass = nil;
    
    messageClass = OOStringFromJSValue(context, OOJS_ARGV[0]);
    OOJS_RETURN_BOOL(messageClass != nil && OOLogWillDisplayMessagesInClass(messageClass));
    
    OOJS_NATIVE_EXIT
}

References nil, OOJS_ARGV, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJS_RETURN_BOOL, OOLogWillDisplayMessagesInClass(), and OOStringFromJSValue().

Here is the call graph for this function:

ConsoleFinalize()

static void ConsoleFinalize ( JSContext * context, JSObject * this )

static

Definition at line 518 of file OOJSConsole.m.

{
    OOJS_PROFILE_ENTER
    
    [(id)JS_GetPrivate(context, this) release];
    JS_SetPrivate(context, this, nil);
    
    OOJS_PROFILE_EXIT_VOID
}

References nil, OOJS_PROFILE_ENTER, and OOJS_PROFILE_EXIT_VOID.

ConsoleGarbageCollect()

static JSBool ConsoleGarbageCollect ( JSContext * context, uintN argc, jsval * vp )

static

Definition at line 901 of file OOJSConsole.m.

{
    OOJS_NATIVE_ENTER(context)
    
    uint32_t bytesBefore = JS_GetGCParameter(JS_GetRuntime(context), JSGC_BYTES);
    JS_GC(context);
    uint32_t bytesAfter = JS_GetGCParameter(JS_GetRuntime(context), JSGC_BYTES);
    
    OOJS_RETURN_OBJECT(([NSString stringWithFormat:@"Bytes before: %u Bytes after: %u", bytesBefore, bytesAfter]));
    
    OOJS_NATIVE_EXIT
}

ConsoleGetProperty()

static JSBool ConsoleGetProperty ( JSContext * context, JSObject * this, jsid propID, jsval * value )

static

Definition at line 308 of file OOJSConsole.m.

{
    if (!JSID_IS_INT(propID))  return YES;
    
    OOJS_NATIVE_ENTER(context)
    
    switch (JSID_TO_INT(propID))
    {
#ifndef NDEBUG
        case kConsole_debugFlags:
            *value = INT_TO_JSVAL((uint32_t)gDebugFlags);
            break;
#endif      
            
        case kConsole_detailLevel:
            *value = [OOStringFromGraphicsDetail([UNIVERSE detailLevel]) oo_jsValueInContext:context];
            break;
            
        case kConsole_maximumDetailLevel:
            *value = [OOStringFromGraphicsDetail([[OOOpenGLExtensionManager sharedManager] maximumDetailLevel]) oo_jsValueInContext:context];
            break;
            
        case kConsole_displayFPS:
            *value = OOJSValueFromBOOL([UNIVERSE displayFPS]);
            break;
            
        case kConsole_platformDescription:
            *value = OOJSValueFromNativeObject(context, OOPlatformDescription());
            break;
            
        case kConsole_pedanticMode:
            {
                uint32_t options = JS_GetOptions(context);
                *value = OOJSValueFromBOOL(options & JSOPTION_STRICT);
            }
            break;
            
        case kConsole_ignoreDroppedPackets:
            *value = OOJSValueFromBOOL([[OODebugMonitor sharedDebugMonitor] TCPIgnoresDroppedPackets]);
            break;
            
        case kConsole_showErrorLocations:
            *value = OOJSValueFromBOOL([[OOJavaScriptEngine sharedEngine] showErrorLocations]);
            break;
            
        case kConsole_dumpStackForErrors:
            *value = OOJSValueFromBOOL([[OOJavaScriptEngine sharedEngine] dumpStackForErrors]);
            break;
            
        case kConsole_dumpStackForWarnings:
            *value = OOJSValueFromBOOL([[OOJavaScriptEngine sharedEngine] dumpStackForWarnings]);
            break;
            
        case kConsole_glVendorString:
            *value = OOJSValueFromNativeObject(context, [[OOOpenGLExtensionManager sharedManager] vendorString]);
            break;
            
        case kConsole_glRendererString:
            *value = OOJSValueFromNativeObject(context, [[OOOpenGLExtensionManager sharedManager] rendererString]);
            break;
            
        case kConsole_glFixedFunctionTextureUnitCount:
            *value = INT_TO_JSVAL([[OOOpenGLExtensionManager sharedManager] textureUnitCount]);
            break;
            
        case kConsole_glFragmentShaderTextureUnitCount:
            *value = INT_TO_JSVAL([[OOOpenGLExtensionManager sharedManager] textureImageUnitCount]);
            break;
            
#define DEBUG_FLAG_CASE(x) case kConsole_##x: *value = INT_TO_JSVAL(x); break;
        DEBUG_FLAG_CASE(DEBUG_LINKED_LISTS);
        DEBUG_FLAG_CASE(DEBUG_COLLISIONS);
        DEBUG_FLAG_CASE(DEBUG_DOCKING);
        DEBUG_FLAG_CASE(DEBUG_OCTREE_LOGGING);
        DEBUG_FLAG_CASE(DEBUG_BOUNDING_BOXES);
        DEBUG_FLAG_CASE(DEBUG_OCTREE_DRAW);
        DEBUG_FLAG_CASE(DEBUG_DRAW_NORMALS);
        DEBUG_FLAG_CASE(DEBUG_NO_DUST);
        DEBUG_FLAG_CASE(DEBUG_NO_SHADER_FALLBACK);
        DEBUG_FLAG_CASE(DEBUG_SHADER_VALIDATION);
        
        DEBUG_FLAG_CASE(DEBUG_MISC);
#undef DEBUG_FLAG_CASE
            
        default:
            OOJSReportBadPropertySelector(context, this, propID, sConsoleProperties);
            return NO;
    }
    
    return YES;
    
    OOJS_NATIVE_EXIT
}

References DEBUG_BOUNDING_BOXES, DEBUG_COLLISIONS, DEBUG_DOCKING, DEBUG_DRAW_NORMALS, DEBUG_FLAG_CASE, DEBUG_LINKED_LISTS, DEBUG_MISC, DEBUG_NO_DUST, DEBUG_NO_SHADER_FALLBACK, DEBUG_OCTREE_DRAW, DEBUG_OCTREE_LOGGING, DEBUG_SHADER_VALIDATION, gDebugFlags, kConsole_debugFlags, kConsole_detailLevel, kConsole_displayFPS, kConsole_dumpStackForErrors, kConsole_dumpStackForWarnings, kConsole_glFixedFunctionTextureUnitCount, kConsole_glFragmentShaderTextureUnitCount, kConsole_glRendererString, kConsole_glVendorString, kConsole_ignoreDroppedPackets, kConsole_maximumDetailLevel, kConsole_pedanticMode, kConsole_platformDescription, kConsole_showErrorLocations, OOOpenGLExtensionManager::maximumDetailLevel, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJSReportBadPropertySelector(), OOJSValueFromBOOL(), OOJSValueFromNativeObject(), OOPlatformDescription(), sConsoleProperties, OOOpenGLExtensionManager::sharedManager, and UNIVERSE.

Here is the call graph for this function:

ConsoleInspectEntity()

static JSBool ConsoleInspectEntity ( JSContext * context, uintN argc, jsval * vp )

static

Definition at line 725 of file OOJSConsole.m.

{
    OOJS_NATIVE_ENTER(context)
    
    Entity              *entity = nil;
    
    if (JSValueToEntity(context, OOJS_ARGV[0], &entity))
    {
        OOJS_BEGIN_FULL_NATIVE(context)
        if ([entity respondsToSelector:@selector(inspect)])
        {
            [entity inspect];
        }
        OOJS_END_FULL_NATIVE
    }
    
    OOJS_RETURN_VOID;
    
    OOJS_NATIVE_EXIT
}

References Entity::inspect, Entity(OODebugInspector)::inspect, JSValueToEntity(), nil, OOJS_ARGV, OOJS_BEGIN_FULL_NATIVE, OOJS_END_FULL_NATIVE, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, and OOJS_RETURN_VOID.

Here is the call graph for this function:

ConsoleIsExecutableJavaScript()

static JSBool ConsoleIsExecutableJavaScript ( JSContext * context, uintN argc, jsval * vp )

static

Definition at line 797 of file OOJSConsole.m.

{
    OOJS_NATIVE_ENTER(context)
    
    BOOL                    result = NO;
    JSObject                *target = NULL;
    
    if (argc < 2 || !JS_ValueToObject(context, OOJS_ARGV[0], &target) || !JSVAL_IS_STRING(OOJS_ARGV[1]))
    {
        OOJS_RETURN_BOOL(NO);   // Fail silently
    }
    
    // Not OOJS_BEGIN_FULL_NATIVE() - we use JSAPI while paused.
    OOJSPauseTimeLimiter();
    
    // FIXME: this must be possible using just JSAPI functions.
    NSString *string = OOStringFromJSValue(context, OOJS_ARGV[1]);
    NSData *stringData = [string dataUsingEncoding:NSUTF8StringEncoding];
    result = JS_BufferIsCompilableUnit(context, target, [stringData bytes], [stringData length]);
    
    OOJSResumeTimeLimiter();
    
    OOJS_RETURN_BOOL(result);
    
    OOJS_NATIVE_EXIT
}

References OOJS_ARGV, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJS_RETURN_BOOL, OOJSPauseTimeLimiter(), OOJSResumeTimeLimiter(), and OOStringFromJSValue().

Here is the call graph for this function:

ConsoleScriptStack()

static JSBool ConsoleScriptStack ( JSContext * context, uintN argc, jsval * vp )

static

Definition at line 714 of file OOJSConsole.m.

{
    OOJS_NATIVE_ENTER(context)
    
    OOJS_RETURN_OBJECT([OOJSScript scriptStack]);
    
    OOJS_NATIVE_EXIT
}

References OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, and OOJS_RETURN_OBJECT.

ConsoleSetDisplayMessagesInClass()

static JSBool ConsoleSetDisplayMessagesInClass ( JSContext * context, uintN argc, jsval * vp )

static

Definition at line 840 of file OOJSConsole.m.

{
    OOJS_NATIVE_ENTER(context)
    
    NSString                *messageClass = nil;
    JSBool                  flag;
    
    messageClass = OOStringFromJSValue(context, OOJS_ARGV[0]);
    if (messageClass != nil && JS_ValueToBoolean(context, OOJS_ARGV[1], &flag))
    {
        OOLogSetDisplayMessagesInClass(messageClass, flag);
    }
    OOJS_RETURN_VOID;
    
    OOJS_NATIVE_EXIT
}

References nil, OOJS_ARGV, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJS_RETURN_VOID, OOLogSetDisplayMessagesInClass(), and OOStringFromJSValue().

Here is the call graph for this function:

ConsoleSetProperty()

static JSBool ConsoleSetProperty ( JSContext * context, JSObject * this, jsid propID, JSBool strict, jsval * value )

static

Definition at line 403 of file OOJSConsole.m.

{
    if (!JSID_IS_INT(propID))  return YES;
    
    OOJS_NATIVE_ENTER(context)
    
    int32                       iValue;
    JSBool                      bValue = NO;
    NSString                    *sValue;
    
    switch (JSID_TO_INT(propID))
    {
#ifndef NDEBUG
        case kConsole_debugFlags:
            if (JS_ValueToInt32(context, *value, &iValue))
            {
                gDebugFlags = iValue;
            }
            break;
#endif      
        case kConsole_detailLevel:
            sValue = OOStringFromJSValue(context, *value);
            OOJS_BEGIN_FULL_NATIVE(context)
            [UNIVERSE setDetailLevel:OOGraphicsDetailFromString(sValue)];
            OOJS_END_FULL_NATIVE
            break;
            
        case kConsole_displayFPS:
            if (JS_ValueToBoolean(context, *value, &bValue))
            {
                [UNIVERSE setDisplayFPS:bValue];
            }
            break;
            
        case kConsole_pedanticMode:
            if (JS_ValueToBoolean(context, *value, &bValue))
            {
                uint32_t options = JS_GetOptions(context);
                if (bValue)  options |= JSOPTION_STRICT;
                else  options &= ~JSOPTION_STRICT;
                
                JS_SetOptions(context, options);
            }
            break;
            
        case kConsole_ignoreDroppedPackets:
            if (JS_ValueToBoolean(context, *value, &bValue))
            {
                [[OODebugMonitor sharedDebugMonitor] setTCPIgnoresDroppedPackets:bValue];
            }
            break;
            
        case kConsole_showErrorLocations:
            if (JS_ValueToBoolean(context, *value, &bValue))
            {
                [[OOJavaScriptEngine sharedEngine] setShowErrorLocations:bValue];
            }
            break;
            
        case kConsole_dumpStackForErrors:
            if (JS_ValueToBoolean(context, *value, &bValue))
            {
                [[OOJavaScriptEngine sharedEngine] setDumpStackForErrors:bValue];
            }
            break;
            
        case kConsole_dumpStackForWarnings:
            if (JS_ValueToBoolean(context, *value, &bValue))
            {
                [[OOJavaScriptEngine sharedEngine] setDumpStackForWarnings:bValue];
            }
            break;
            
        default:
            OOJSReportBadPropertySelector(context, this, propID, sConsoleProperties);
            return NO;
    }
    
    return YES;
    
    OOJS_NATIVE_EXIT
}

References gDebugFlags, kConsole_debugFlags, kConsole_detailLevel, kConsole_displayFPS, kConsole_dumpStackForErrors, kConsole_dumpStackForWarnings, kConsole_ignoreDroppedPackets, kConsole_pedanticMode, kConsole_showErrorLocations, OOJS_BEGIN_FULL_NATIVE, OOJS_END_FULL_NATIVE, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJSReportBadPropertySelector(), OOStringFromJSValue(), sConsoleProperties, OOJavaScriptEngine::setDumpStackForErrors:, OOJavaScriptEngine::setDumpStackForWarnings:, OOJavaScriptEngine::setShowErrorLocations:, OODebugMonitor::setTCPIgnoresDroppedPackets:, OODebugMonitor::sharedDebugMonitor, and OOJavaScriptEngine::sharedEngine.

Here is the call graph for this function:

ConsoleSettingsDeleteProperty()

static JSBool ConsoleSettingsDeleteProperty ( JSContext * context, JSObject * this, jsid propID, jsval * value )

static

Definition at line 529 of file OOJSConsole.m.

{
    OOJS_NATIVE_ENTER(context)
    
    NSString            *key = nil;
    id                  monitor = nil;
    
    if (!JSID_IS_STRING(propID))  return NO;
    key = OOStringFromJSString(context, JSID_TO_STRING(propID));
    
    monitor = OOJSNativeObjectFromJSObject(context, this);
    if (![monitor isKindOfClass:[OODebugMonitor class]])
    {
        OOJSReportError(context, @"Expected OODebugMonitor, got %@ in %s. %@", [monitor class], __PRETTY_FUNCTION__, @"This is an internal error, please report it.");
        return NO;
    }
    
    [monitor setConfigurationValue:nil forKey:key];
    *value = JSVAL_TRUE;
    return YES;
    
    OOJS_NATIVE_EXIT
}

References nil, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJSNativeObjectFromJSObject(), OOJSReportError(), and OOStringFromJSString().

Here is the call graph for this function:

ConsoleSettingsGetProperty()

static JSBool ConsoleSettingsGetProperty ( JSContext * context, JSObject * this, jsid propID, jsval * value )

static

Definition at line 554 of file OOJSConsole.m.

{
    if (!JSID_IS_STRING(propID))  return YES;
    
    OOJS_NATIVE_ENTER(context)
    
    NSString            *key = nil;
    id                  settingValue = nil;
    id                  monitor = nil;
    
    key = OOStringFromJSString(context, JSID_TO_STRING(propID));
    
    monitor = OOJSNativeObjectFromJSObject(context, this);
    if (![monitor isKindOfClass:[OODebugMonitor class]])
    {
        OOJSReportError(context, @"Expected OODebugMonitor, got %@ in %s. %@", [monitor class], __PRETTY_FUNCTION__, @"This is an internal error, please report it.");
        return NO;
    }
    
    settingValue = [monitor configurationValueForKey:key];
    if (settingValue != NULL)  *value = [settingValue oo_jsValueInContext:context];
    else  *value = JSVAL_VOID;
    
    return YES;
    
    OOJS_NATIVE_EXIT
}

References nil, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJSNativeObjectFromJSObject(), OOJSReportError(), and OOStringFromJSString().

Here is the call graph for this function:

ConsoleSettingsSetProperty()

static JSBool ConsoleSettingsSetProperty ( JSContext * context, JSObject * this, jsid propID, JSBool strict, jsval * value )

static

Definition at line 583 of file OOJSConsole.m.

{
    if (!JSID_IS_STRING(propID))  return YES;
    
    OOJS_NATIVE_ENTER(context)
    
    NSString            *key = nil;
    id                  settingValue = nil;
    id                  monitor = nil;
    
    key = OOStringFromJSString(context, JSID_TO_STRING(propID));
    
    monitor = OOJSNativeObjectFromJSObject(context, this);
    if (![monitor isKindOfClass:[OODebugMonitor class]])
    {
        OOJSReportError(context, @"Expected OODebugMonitor, got %@ in %s. %@", [monitor class], __PRETTY_FUNCTION__, @"This is an internal error, please report it.");
        return NO;
    }
    
    // Not OOJS_BEGIN_FULL_NATIVE() - we use JSAPI while paused.
    OOJSPauseTimeLimiter();
    if (JSVAL_IS_NULL(*value) || JSVAL_IS_VOID(*value))
    {
        [monitor setConfigurationValue:nil forKey:key];
    }
    else
    {
        settingValue = OOJSNativeObjectFromJSValue(context, *value);
        if (settingValue != nil)
        {
            [monitor setConfigurationValue:settingValue forKey:key];
        }
        else
        {
            OOJSReportWarning(context, @"debugConsole.settings: could not convert %@ to native object.", OOStringFromJSValue(context, *value));
        }
    }
    OOJSResumeTimeLimiter();
    
    return YES;
    
    OOJS_NATIVE_EXIT
}

References nil, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJSNativeObjectFromJSObject(), OOJSNativeObjectFromJSValue(), OOJSPauseTimeLimiter(), OOJSReportError(), OOJSReportWarning(), OOJSResumeTimeLimiter(), OOStringFromJSString(), and OOStringFromJSValue().

Here is the call graph for this function:

ConsoleWriteJSMemoryStats()

static JSBool ConsoleWriteJSMemoryStats ( JSContext * context, uintN argc, jsval * vp )

static

Definition at line 886 of file OOJSConsole.m.

{
    OOJS_NATIVE_ENTER(context)
    
    OOJS_BEGIN_FULL_NATIVE(context)
    [[OODebugMonitor sharedDebugMonitor] dumpJSMemoryStatistics];
    OOJS_END_FULL_NATIVE
    
    OOJS_RETURN_VOID;
    
    OOJS_NATIVE_EXIT
}

References OODebugMonitor::dumpJSMemoryStatistics, OOJS_BEGIN_FULL_NATIVE, OOJS_END_FULL_NATIVE, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJS_RETURN_VOID, and OODebugMonitor::sharedDebugMonitor.

Here is the call graph for this function:

ConsoleWriteLogMarker()

static JSBool ConsoleWriteLogMarker ( JSContext * context, uintN argc, jsval * vp )

static

Definition at line 859 of file OOJSConsole.m.

{
    OOJS_NATIVE_ENTER(context)
    
    OOLogInsertMarker();
    OOJS_RETURN_VOID;
    
    OOJS_NATIVE_EXIT
}

References OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJS_RETURN_VOID, and OOLogInsertMarker().

Here is the call graph for this function:

ConsoleWriteMemoryStats()

static JSBool ConsoleWriteMemoryStats ( JSContext * context, uintN argc, jsval * vp )

static

Definition at line 871 of file OOJSConsole.m.

{
    OOJS_NATIVE_ENTER(context)
    
    OOJS_BEGIN_FULL_NATIVE(context)
    [[OODebugMonitor sharedDebugMonitor] dumpMemoryStatistics];
    OOJS_END_FULL_NATIVE
    
    OOJS_RETURN_VOID;
    
    OOJS_NATIVE_EXIT
}

References OODebugMonitor::dumpMemoryStatistics, OOJS_BEGIN_FULL_NATIVE, OOJS_END_FULL_NATIVE, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJS_RETURN_VOID, and OODebugMonitor::sharedDebugMonitor.

Here is the call graph for this function:

DebugMonitorToJSConsole()

JSObject * DebugMonitorToJSConsole	(	JSContext *	context,
		OODebugMonitor *	monitor )

Definition at line 255 of file OOJSConsole.m.

{
    OOJS_PROFILE_ENTER
    
    OOJavaScriptEngine      *engine = nil;
    JSObject                *object = NULL;
    JSObject                *settingsObject = NULL;
    jsval                   value;
    
    NSCAssert(JS_EnterLocalRootScope(context), @"Failed to create JS GC root scope");
    engine = [OOJavaScriptEngine sharedEngine];
    
    if (sConsolePrototype == NULL)
    {
        InitOOJSConsole(context, [engine globalObject]);
    }
    
    // Create Console object
    object = JS_NewObject(context, &sConsoleClass, sConsolePrototype, NULL);
    if (object != NULL)
    {
        if (!JS_SetPrivate(context, object, [monitor weakRetain]))  object = NULL;
    }
    
    if (object != NULL)
    {
        // Create ConsoleSettings object
        settingsObject = JS_NewObject(context, &sConsoleSettingsClass, sConsoleSettingsPrototype, NULL);
        if (settingsObject != NULL)
        {
            if (!JS_SetPrivate(context, settingsObject, [monitor weakRetain]))  settingsObject = NULL;
        }
        if (settingsObject != NULL)
        {
            value = OBJECT_TO_JSVAL(settingsObject);
            if (!JS_SetProperty(context, object, "settings", &value))
            {
                settingsObject = NULL;
            }
        }
 
        if (settingsObject == NULL)  object = NULL;
    }
    
    JS_LeaveLocalRootScope(context);
    
    return object;
    // Analyzer: object leaked. (x2) [Expected, objects are retained by JS object.]
    
    OOJS_PROFILE_EXIT
}

References InitOOJSConsole(), nil, OOJS_PROFILE_ENTER, OOJS_PROFILE_EXIT, sConsoleClass, sConsolePrototype, sConsoleSettingsClass, sConsoleSettingsPrototype, and OOJavaScriptEngine::sharedEngine.

Here is the call graph for this function:

DoWeDefineAllDebugFlags()

static BOOL DoWeDefineAllDebugFlags ( enum OODebugFlags flags )

static

Definition at line 488 of file OOJSConsole.m.

{
    /*  This function doesn't do anything, but will generate a warning
        (Enumeration value 'DEBUG_FOO' not handled in switch) if a debug flag
        is added without updating it. The point is that if you get such a
        warning, you should first add a JS symbolic constant for the flag,
        then add it to the switch to suppress the warning.
        NOTE: don't add a default: to this switch, or I will have to hurt you.
        -- Ahruman 2010-04-11
    */
    switch (flags)
    {
        case DEBUG_LINKED_LISTS:
        case DEBUG_COLLISIONS:
        case DEBUG_DOCKING:
        case DEBUG_OCTREE_LOGGING:
        case DEBUG_BOUNDING_BOXES:
        case DEBUG_OCTREE_DRAW:
        case DEBUG_DRAW_NORMALS:
        case DEBUG_NO_DUST:
        case DEBUG_NO_SHADER_FALLBACK:
        case DEBUG_SHADER_VALIDATION:
        case DEBUG_MISC:
            return YES;
    }
    
    return NO;
}

References DEBUG_BOUNDING_BOXES, DEBUG_COLLISIONS, DEBUG_DOCKING, DEBUG_DRAW_NORMALS, DEBUG_LINKED_LISTS, DEBUG_MISC, DEBUG_NO_DUST, DEBUG_NO_SHADER_FALLBACK, DEBUG_OCTREE_DRAW, DEBUG_OCTREE_LOGGING, and DEBUG_SHADER_VALIDATION.

InitOOJSConsole()

static void InitOOJSConsole ( JSContext * context, JSObject * global )

static

Definition at line 239 of file OOJSConsole.m.

{
    sConsolePrototype = JS_InitClass(context, global, NULL, &sConsoleClass, OOJSUnconstructableConstruct, 0, sConsoleProperties, sConsoleMethods, NULL, NULL);
    OOJSRegisterObjectConverter(&sConsoleClass, OOJSBasicPrivateObjectConverter);
    
    sConsoleSettingsPrototype = JS_InitClass(context, global, NULL, &sConsoleSettingsClass, OOJSUnconstructableConstruct, 0, NULL, NULL, NULL, NULL);
    OOJSRegisterObjectConverter(&sConsoleSettingsClass, OOJSBasicPrivateObjectConverter);
}

References OOJSBasicPrivateObjectConverter(), OOJSRegisterObjectConverter(), OOJSUnconstructableConstruct(), sConsoleClass, sConsoleMethods, sConsoleProperties, sConsolePrototype, sConsoleSettingsClass, and sConsoleSettingsPrototype.

Referenced by DebugMonitorToJSConsole().

Here is the call graph for this function:

Here is the caller graph for this function:

OOJSConsoleDestroy()

void OOJSConsoleDestroy

(

void

)

Definition at line 249 of file OOJSConsole.m.

{
    sConsolePrototype = NULL;
}

References sConsolePrototype.

OOPlatformDescription()

NSString * OOPlatformDescription

(

void

)

Definition at line 185 of file OOLogHeader.m.

{
    #if OOLITE_MAC_OS_X
        NSString *systemString = [NSString stringWithFormat:@OS_TYPE_STRING " %@", [[NSProcessInfo processInfo] operatingSystemVersionString]];
    #else
        #define systemString @OS_TYPE_STRING
    #endif
    
    return [NSString stringWithFormat:@"%@ ("CPU_TYPE_STRING RELEASE_VARIANT_STRING")", systemString];
}

Referenced by ConsoleGetProperty().

Here is the caller graph for this function:

Variable Documentation

sConsoleClass

JSClass sConsoleClass

static

Initial value:

=
{
    "Console",
    JSCLASS_HAS_PRIVATE,
    
    JS_PropertyStub,                
    JS_PropertyStub,                
    ConsoleGetProperty,             
    ConsoleSetProperty,             
    JS_EnumerateStub,               
    JS_ResolveStub,                 
    JS_ConvertStub,                 
    ConsoleFinalize,                
    JSCLASS_NO_OPTIONAL_MEMBERS
}

Definition at line 103 of file OOJSConsole.m.

{
    "Console",
    JSCLASS_HAS_PRIVATE,
    
    JS_PropertyStub,                // addProperty
    JS_PropertyStub,                // delProperty
    ConsoleGetProperty,             // getProperty
    ConsoleSetProperty,             // setProperty
    JS_EnumerateStub,               // enumerate
    JS_ResolveStub,                 // resolve
    JS_ConvertStub,                 // convert
    ConsoleFinalize,                // finalize
    JSCLASS_NO_OPTIONAL_MEMBERS
};

Referenced by DebugMonitorToJSConsole(), and InitOOJSConsole().

sConsoleMethods

JSFunctionSpec sConsoleMethods[]

static

Initial value:

=
{
    
    { "consoleMessage",                 ConsoleConsoleMessage,              2 },
    { "clearConsole",                   ConsoleClearConsole,                0 },
    { "scriptStack",                    ConsoleScriptStack,                 0 },
    { "inspectEntity",                  ConsoleInspectEntity,               1 },
 
 
 
    { "isExecutableJavaScript",         ConsoleIsExecutableJavaScript,      2 },
    { "displayMessagesInClass",         ConsoleDisplayMessagesInClass,      1 },
    { "setDisplayMessagesInClass",      ConsoleSetDisplayMessagesInClass,   2 },
    { "writeLogMarker",                 ConsoleWriteLogMarker,              0 },
    { "writeMemoryStats",               ConsoleWriteMemoryStats,            0 },
    { "writeJSMemoryStats",             ConsoleWriteJSMemoryStats,          0 },
    { "garbageCollect",                 ConsoleGarbageCollect,              0 },
 
 
 
 
 
 
 
 
 
    { 0 }
}

Definition at line 192 of file OOJSConsole.m.

{
    // JS name                          Function                            min args
    { "consoleMessage",                 ConsoleConsoleMessage,              2 },
    { "clearConsole",                   ConsoleClearConsole,                0 },
    { "scriptStack",                    ConsoleScriptStack,                 0 },
    { "inspectEntity",                  ConsoleInspectEntity,               1 },
#if OO_DEBUG
    { "__setUpCallObjC",                ConsoleSetUpCallObjC,               1 },
#endif
    { "isExecutableJavaScript",         ConsoleIsExecutableJavaScript,      2 },
    { "displayMessagesInClass",         ConsoleDisplayMessagesInClass,      1 },
    { "setDisplayMessagesInClass",      ConsoleSetDisplayMessagesInClass,   2 },
    { "writeLogMarker",                 ConsoleWriteLogMarker,              0 },
    { "writeMemoryStats",               ConsoleWriteMemoryStats,            0 },
    { "writeJSMemoryStats",             ConsoleWriteJSMemoryStats,          0 },
    { "garbageCollect",                 ConsoleGarbageCollect,              0 },
#if DEBUG
    { "dumpNamedRoots",                 ConsoleDumpNamedRoots,              0 },
    { "dumpHeap",                       ConsoleDumpHeap,                    0 },
#endif
#if OOJS_PROFILE
    { "profile",                        ConsoleProfile,                     1 },
    { "getProfile",                     ConsoleGetProfile,                  1 },
    { "trace",                          ConsoleTrace,                       1 },
#endif
    { 0 }
};

Referenced by InitOOJSConsole().

sConsoleProperties

JSPropertySpec sConsoleProperties[]

static

Definition at line 155 of file OOJSConsole.m.

{
    // JS name                              ID                                          flags
    { "debugFlags",                         kConsole_debugFlags,                        OOJS_PROP_READWRITE_CB },
    { "detailLevel",                        kConsole_detailLevel,                       OOJS_PROP_READWRITE_CB },
    { "maximumDetailLevel",                 kConsole_maximumDetailLevel,                OOJS_PROP_READONLY_CB },
    { "displayFPS",                         kConsole_displayFPS,                        OOJS_PROP_READWRITE_CB },
    { "platformDescription",                kConsole_platformDescription,               OOJS_PROP_READONLY_CB },
    { "pedanticMode",                       kConsole_pedanticMode,                      OOJS_PROP_READWRITE_CB },
    { "ignoreDroppedPackets",               kConsole_ignoreDroppedPackets,              OOJS_PROP_READWRITE_CB },
    { "__showErrorLocations",               kConsole_showErrorLocations,                OOJS_PROP_HIDDEN_READWRITE_CB },
    { "__dumpStackForErrors",               kConsole_dumpStackForErrors,                OOJS_PROP_HIDDEN_READWRITE_CB },
    { "__dumpStackForWarnings",             kConsole_dumpStackForWarnings,              OOJS_PROP_HIDDEN_READWRITE_CB },
    { "glVendorString",                     kConsole_glVendorString,                    OOJS_PROP_READONLY_CB },
    { "glRendererString",                   kConsole_glRendererString,                  OOJS_PROP_READONLY_CB },
    { "glFixedFunctionTextureUnitCount",    kConsole_glFixedFunctionTextureUnitCount,   OOJS_PROP_READONLY_CB },
    { "glFragmentShaderTextureUnitCount",   kConsole_glFragmentShaderTextureUnitCount,  OOJS_PROP_READONLY_CB },
    
#define DEBUG_FLAG_DECL(x) { #x, kConsole_##x, OOJS_PROP_READONLY_CB }
    DEBUG_FLAG_DECL(DEBUG_LINKED_LISTS),
    DEBUG_FLAG_DECL(DEBUG_COLLISIONS),
    DEBUG_FLAG_DECL(DEBUG_DOCKING),
    DEBUG_FLAG_DECL(DEBUG_OCTREE_LOGGING),
    DEBUG_FLAG_DECL(DEBUG_BOUNDING_BOXES),
    DEBUG_FLAG_DECL(DEBUG_OCTREE_DRAW),
    DEBUG_FLAG_DECL(DEBUG_DRAW_NORMALS),
    DEBUG_FLAG_DECL(DEBUG_NO_DUST),
    DEBUG_FLAG_DECL(DEBUG_NO_SHADER_FALLBACK),
    DEBUG_FLAG_DECL(DEBUG_SHADER_VALIDATION),
    
    DEBUG_FLAG_DECL(DEBUG_MISC),
#undef DEBUG_FLAG_DECL
    
    { 0 }
};

Referenced by ConsoleGetProperty(), ConsoleSetProperty(), and InitOOJSConsole().

sConsolePrototype

JSObject* sConsolePrototype = NULL

static

Definition at line 60 of file OOJSConsole.m.

Referenced by DebugMonitorToJSConsole(), InitOOJSConsole(), and OOJSConsoleDestroy().

sConsoleSettingsClass

JSClass sConsoleSettingsClass

static

Initial value:

=
{
    "ConsoleSettings",
    JSCLASS_HAS_PRIVATE,
    
    JS_PropertyStub,                
    ConsoleSettingsDeleteProperty,  
    ConsoleSettingsGetProperty,     
    ConsoleSettingsSetProperty,     
    JS_EnumerateStub,               
    JS_ResolveStub,                 
    JS_ConvertStub,                 
    ConsoleFinalize,                
    JSCLASS_NO_OPTIONAL_MEMBERS
}

Definition at line 222 of file OOJSConsole.m.

{
    "ConsoleSettings",
    JSCLASS_HAS_PRIVATE,
    
    JS_PropertyStub,                // addProperty
    ConsoleSettingsDeleteProperty,  // delProperty
    ConsoleSettingsGetProperty,     // getProperty
    ConsoleSettingsSetProperty,     // setProperty
    JS_EnumerateStub,               // enumerate. FIXME: this should work.
    JS_ResolveStub,                 // resolve
    JS_ConvertStub,                 // convert
    ConsoleFinalize,                // finalize (same as Console)
    JSCLASS_NO_OPTIONAL_MEMBERS
};

Referenced by DebugMonitorToJSConsole(), and InitOOJSConsole().

sConsoleSettingsPrototype

JSObject* sConsoleSettingsPrototype = NULL

static

Definition at line 61 of file OOJSConsole.m.

Referenced by DebugMonitorToJSConsole(), and InitOOJSConsole().