OOJavaScriptEngine.m File Reference

#include <jsdbgapi.h>
import "OOJavaScriptEngine.h"
import "OOJSEngineTimeManagement.h"
import "OOJSScript.h"
import "OOCollectionExtractors.h"
import "Universe.h"
import "OOPlanetEntity.h"
import "NSStringOOExtensions.h"
import "OOWeakReference.h"
import "EntityOOJavaScriptExtensions.h"
import "ResourceManager.h"
import "NSNumberOOExtensions.h"
import "OOConstToJSString.h"
import "OOVisualEffectEntity.h"
import "OOWaypointEntity.h"
import "OOJSGlobal.h"
import "OOJSMissionVariables.h"
import "OOJSMission.h"
import "OOJSVector.h"
import "OOJSQuaternion.h"
import "OOJSEntity.h"
import "OOJSShip.h"
import "OOJSStation.h"
import "OOJSDock.h"
import "OOJSVisualEffect.h"
import "OOJSExhaustPlume.h"
import "OOJSFlasher.h"
import "OOJSWormhole.h"
import "OOJSWaypoint.h"
import "OOJSPlayer.h"
import "OOJSPlayerShip.h"
import "OOJSManifest.h"
import "OOJSPlanet.h"
import "OOJSSystem.h"
import "OOJSOolite.h"
import "OOJSTimer.h"
import "OOJSClock.h"
import "OOJSSun.h"
import "OOJSWorldScripts.h"
import "OOJSSound.h"
import "OOJSSoundSource.h"
import "OOJSSpecialFunctions.h"
import "OOJSSystemInfo.h"
import "OOJSEquipmentInfo.h"
import "OOJSShipGroup.h"
import "OOJSFrameCallbacks.h"
import "OOJSFont.h"
import "OOProfilingStopwatch.h"
import "OOLoggingExtended.h"
#include <stdlib.h>

Include dependency graph for OOJavaScriptEngine.m:

Go to the source code of this file.

Classes
category	OOJavaScriptEngine(Private)

Macros
#define	OOJSENGINE_JSVERSION   JSVERSION_ECMA_5
#define	JIT_OPTIONS   JSOPTION_JIT | JSOPTION_METHODJIT | JSOPTION_PROFILING
#define	OOJSENGINE_CONTEXT_OPTIONS   JSOPTION_VAROBJFIX | JSOPTION_RELIMIT | JSOPTION_ANONFUNFIX | JIT_OPTIONS
#define	OOJS_STACK_SIZE   8192
#define	OOJS_RUNTIME_SIZE_MiB   32

Functions
static void	ReportJSError (JSContext *context, const char *message, JSErrorReport *report)
static id	JSArrayConverter (JSContext *context, JSObject *object)
static id	JSStringConverter (JSContext *context, JSObject *object)
static id	JSNumberConverter (JSContext *context, JSObject *object)
static id	JSBooleanConverter (JSContext *context, JSObject *object)
static void	UnregisterObjectConverters (void)
static void	UnregisterSubclasses (void)
static void	DumpVariable (JSContext *context, JSPropertyDesc *prop)
void	OOJSDumpStack (JSContext *context)
static void	GetLocationNameAndLine (JSContext *context, JSStackFrame *stackFrame, const char **name, NSUInteger *line)
NSString *	OOJSDescribeLocation (JSContext *context, JSStackFrame *stackFrame)
void	OOJSMarkConsoleEvalLocation (JSContext *context, JSStackFrame *stackFrame)
void	OOJSInitJSIDCachePRIVATE (const char *name, jsid *idCache)
jsid	OOJSIDFromString (NSString *string)
NSString *	OOStringFromJSID (jsid propID)
static NSString *	CallerPrefix (NSString *scriptClass, NSString *function)
void	OOJSReportError (JSContext *context, NSString *format,...)
void	OOJSReportErrorForCaller (JSContext *context, NSString *scriptClass, NSString *function, NSString *format,...)
void	OOJSReportErrorWithArguments (JSContext *context, NSString *format, va_list args)
void	OOJSReportWrappedException (JSContext *context, id exception)
void	OOJSUnreachable (const char *function, const char *file, unsigned line)
void	OOJSReportWarning (JSContext *context, NSString *format,...)
void	OOJSReportWarningForCaller (JSContext *context, NSString *scriptClass, NSString *function, NSString *format,...)
void	OOJSReportWarningWithArguments (JSContext *context, NSString *format, va_list args)
void	OOJSReportBadPropertySelector (JSContext *context, JSObject *thisObj, jsid propID, JSPropertySpec *propertySpec)
void	OOJSReportBadPropertyValue (JSContext *context, JSObject *thisObj, jsid propID, JSPropertySpec *propertySpec, jsval value)
void	OOJSReportBadArguments (JSContext *context, NSString *scriptClass, NSString *function, uintN argc, jsval *argv, NSString *message, NSString *expectedArgsDescription)
void	OOJSSetWarningOrErrorStackSkip (unsigned skip)
BOOL	OOJSArgumentListGetNumber (JSContext *context, NSString *scriptClass, NSString *function, uintN argc, jsval *argv, double *outNumber, uintN *outConsumed)
BOOL	OOJSArgumentListGetNumberNoError (JSContext *context, uintN argc, jsval *argv, double *outNumber, uintN *outConsumed)
static JSObject *	JSArrayFromNSArray (JSContext *context, NSArray *array)
static BOOL	JSNewNSArrayValue (JSContext *context, NSArray *array, jsval *value)
static JSObject *	JSObjectFromNSDictionary (JSContext *context, NSDictionary *dictionary)
static BOOL	JSNewNSDictionaryValue (JSContext *context, NSDictionary *dictionary, jsval *value)
JSObject *	OOJSObjectFromNativeObject (JSContext *context, id object)
void	OOJSStrLiteralCachePRIVATE (const char *string, jsval *strCache, BOOL *inited)
NSString *	OOStringFromJSString (JSContext *context, JSString *string)
NSString *	OOStringFromJSValueEvenIfNull (JSContext *context, jsval value)
NSString *	OOStringFromJSValue (JSContext *context, jsval value)
NSString *	OOStringFromJSPropertyIDAndSpec (JSContext *context, jsid propID, JSPropertySpec *propertySpec)
static NSString *	DescribeValue (JSContext *context, jsval value, BOOL abbreviateObjects, BOOL recursing)
NSString *	OOJSDescribeValue (JSContext *context, jsval value, BOOL abbreviateObjects)
JSBool	OOJSUnconstructableConstruct (JSContext *context, uintN argc, jsval *vp)
void	OOJSObjectWrapperFinalize (JSContext *context, JSObject *this)
JSBool	OOJSObjectWrapperToString (JSContext *context, uintN argc, jsval *vp)
BOOL	JSFunctionPredicate (Entity *entity, void *parameter)
BOOL	JSEntityIsJavaScriptVisiblePredicate (Entity *entity, void *parameter)
BOOL	JSEntityIsJavaScriptSearchablePredicate (Entity *entity, void *parameter)
BOOL	JSEntityIsDemoShipPredicate (Entity *entity, void *parameter)
void	OOJSRegisterSubclass (JSClass *subclass, JSClass *superclass)
BOOL	OOJSIsSubclass (JSClass *putativeSubclass, JSClass *superclass)
BOOL	OOJSObjectGetterImplPRIVATE (JSContext *context, JSObject *object, JSClass *requiredJSClass, Class requiredObjCClass, const char *name, id *outObject)
NSDictionary *	OOJSDictionaryFromJSValue (JSContext *context, jsval value)
NSDictionary *	OOJSDictionaryFromJSObject (JSContext *context, JSObject *object)
NSDictionary *	OOJSDictionaryFromStringTable (JSContext *context, jsval tableValue)
id	OOJSNativeObjectFromJSValue (JSContext *context, jsval value)
id	OOJSNativeObjectFromJSObject (JSContext *context, JSObject *tableObject)
id	OOJSNativeObjectOfClassFromJSValue (JSContext *context, jsval value, Class requiredClass)
id	OOJSNativeObjectOfClassFromJSObject (JSContext *context, JSObject *object, Class requiredClass)
id	OOJSBasicPrivateObjectConverter (JSContext *context, JSObject *object)
void	OOJSRegisterObjectConverter (JSClass *theClass, OOJSClassConverterCallback converter)

Variables
static OOJavaScriptEngine *	sSharedEngine = nil
static unsigned	sErrorHandlerStackSkip = 0
JSContext *	gOOJSMainThreadContext = NULL
NSString *const	kOOJavaScriptEngineWillResetNotification = @"org.aegidian.oolite OOJavaScriptEngine will reset"
NSString *const	kOOJavaScriptEngineDidResetNotification = @"org.aegidian.oolite OOJavaScriptEngine did reset"
static const char *	sConsoleScriptName
static NSUInteger	sConsoleEvalLineNo
static NSMapTable *	sRegisteredSubClasses
static NSMutableDictionary *	sObjectConverters

Macro Definition Documentation

JIT_OPTIONS

#define JIT_OPTIONS   JSOPTION_JIT | JSOPTION_METHODJIT | JSOPTION_PROFILING

Definition at line 85 of file OOJavaScriptEngine.m.

OOJS_RUNTIME_SIZE_MiB

#define OOJS_RUNTIME_SIZE_MiB   32

Definition at line 91 of file OOJavaScriptEngine.m.

OOJS_STACK_SIZE

#define OOJS_STACK_SIZE   8192

Definition at line 90 of file OOJavaScriptEngine.m.

OOJSENGINE_CONTEXT_OPTIONS

#define OOJSENGINE_CONTEXT_OPTIONS   JSOPTION_VAROBJFIX | JSOPTION_RELIMIT | JSOPTION_ANONFUNFIX | JIT_OPTIONS

Definition at line 87 of file OOJavaScriptEngine.m.

OOJSENGINE_JSVERSION

#define OOJSENGINE_JSVERSION   JSVERSION_ECMA_5

Definition at line 81 of file OOJavaScriptEngine.m.

Function Documentation

CallerPrefix()

static NSString * CallerPrefix ( NSString * scriptClass, NSString * function )

static

Definition at line 992 of file OOJavaScriptEngine.m.

{
    if (function == nil)  return @"";
    if (scriptClass == nil)  return [function stringByAppendingString:@": "];
    return  [NSString stringWithFormat:@"%@.%@: ", scriptClass, function];
}

References nil.

Referenced by OOJSReportErrorForCaller(), and OOJSReportWarningForCaller().

Here is the caller graph for this function:

DescribeValue()

static NSString * DescribeValue ( JSContext * context, jsval value, BOOL abbreviateObjects, BOOL recursing )

static

Definition at line 1634 of file OOJavaScriptEngine.m.

{
    OOJS_PROFILE_ENTER
    
    NSCParameterAssert(context != NULL && JS_IsInRequest(context));
    
    if (OOJSValueIsFunction(context, value))
    {
        JSString *name = JS_GetFunctionId(JS_ValueToFunction(context, value));
        if (name != NULL)  return [NSString stringWithFormat:@"function %@", OOStringFromJSString(context, name)];
        else  return @"function";
    }
    
    NSString            *result = nil;
    JSClass             *class = NULL;
    OOJavaScriptEngine  *jsEng = [OOJavaScriptEngine sharedEngine];
    
    if (JSVAL_IS_OBJECT(value) && !JSVAL_IS_NULL(value))
    {
        class = OOJSGetClass(context, JSVAL_TO_OBJECT(value));
    }
    
    // Convert String objects to strings.
    if (class == [jsEng stringClass])
    {
        value = STRING_TO_JSVAL(JS_ValueToString(context, value));
    }
    
    if (JSVAL_IS_STRING(value))
    {
        enum { kMaxLength = 200 };
        
        JSString *string = JSVAL_TO_STRING(value);
        size_t length;
        const jschar *chars = JS_GetStringCharsAndLength(context, string, &length);
        
        result = [NSString stringWithCharacters:chars length:MIN(length, (size_t)kMaxLength)];
        result = [NSString stringWithFormat:@"\"%@%@\"", [result escapedForJavaScriptLiteral], (length > kMaxLength) ? @"..." : @""];
    }
    else if (class == [jsEng arrayClass])
    {
        // Descibe up to four elements of an array.
        jsuint count;
        JSObject *obj = JSVAL_TO_OBJECT(value);
        if (JS_GetArrayLength(context, obj, &count))
        {
            if (!recursing)
            {
                NSMutableString *arrayDesc = [NSMutableString stringWithString:@"["];
                jsuint i, effectiveCount = MIN(count, (jsuint)4);
                for (i = 0; i < effectiveCount; i++)
                {
                    jsval item;
                    NSString *itemDesc = @"?";
                    if (JS_GetElement(context, obj, i, &item))
                    {
                        itemDesc = DescribeValue(context, item, YES /* always abbreviate objects in arrays */, YES);
                    }
                    if (i != 0)  [arrayDesc appendString:@", "];
                    [arrayDesc appendString:itemDesc];
                }
                if (effectiveCount != count)
                {
                    [arrayDesc appendFormat:@", ... <%u items total>]", count];
                }
                else
                {
                    [arrayDesc appendString:@"]"];
                }
                
                result = arrayDesc;
            }
            else
            {
                result = [NSString stringWithFormat:@"[<%u items>]", count];
            }
        }
        else
        {
            result = @"[...]";
        }
 
    }
    
    if (result == nil)
    {
        result = OOStringFromJSValueEvenIfNull(context, value);
        
        if (abbreviateObjects && class == [jsEng objectClass] && [result isEqualToString:@"[object Object]"])
        {
            result = @"{...}";
        }
        
        if (result == nil)  result = @"?";
    }
    
    return result;
    
    OOJS_PROFILE_EXIT
}

References count, DescribeValue(), JS_IsInRequest, MIN, nil, OOJS_PROFILE_ENTER, OOJS_PROFILE_EXIT, OOJSGetClass(), OOJSValueIsFunction(), OOStringFromJSValueEvenIfNull(), and OOJavaScriptEngine::sharedEngine.

Referenced by DescribeValue(), and OOJSDescribeValue().

Here is the call graph for this function:

Here is the caller graph for this function:

DumpVariable()

static void DumpVariable ( JSContext * context, JSPropertyDesc * prop )

static

Definition at line 711 of file OOJavaScriptEngine.m.

{
    NSString *name = OOStringFromJSValueEvenIfNull(context, prop->id);
    NSString *value = OOJSDescribeValue(context, prop->value, YES);
    
    enum
    {
        kInterestingFlags = ~(JSPD_ENUMERATE | JSPD_PERMANENT | JSPD_VARIABLE | JSPD_ARGUMENT)
    };
    
    NSString *flagStr = @"";
    if ((prop->flags & kInterestingFlags) != 0)
    {
        NSMutableArray *flags = [NSMutableArray array];
        if (prop->flags & JSPD_READONLY)  [flags addObject:@"read-only"];
        if (prop->flags & JSPD_ALIAS)  [flags addObject:[NSString stringWithFormat:@"alias (%@)", OOJSDescribeValue(context, prop->alias, YES)]];
        if (prop->flags & JSPD_EXCEPTION)  [flags addObject:@"exception"];
        if (prop->flags & JSPD_ERROR)  [flags addObject:@"error"];
        
        flagStr = [NSString stringWithFormat:@" [%@]", [flags componentsJoinedByString:@", "]];
    }
    
    OOLog(@"script.javaScript.stackTrace", @"    %@: %@%@", name, value, flagStr);
}

References OOJSDescribeValue(), OOLog, and OOStringFromJSValueEvenIfNull().

Referenced by OOJSDumpStack().

Here is the call graph for this function:

Here is the caller graph for this function:

GetLocationNameAndLine()

static void GetLocationNameAndLine ( JSContext * context, JSStackFrame * stackFrame, const char ** name, NSUInteger * line )

static

Definition at line 870 of file OOJavaScriptEngine.m.

{
    NSCParameterAssert(context != NULL && stackFrame != NULL && name != NULL && line != NULL);
    
    *name = NULL;
    *line = 0;
    
    JSScript *script = JS_GetFrameScript(context, stackFrame);
    if (script != NULL)
    {
        *name = JS_GetScriptFilename(context, script);
        if (name != NULL)
        {
            jsbytecode *PC = JS_GetFramePC(context, stackFrame);
            *line = JS_PCToLineNumber(context, script, PC);
        }
    }
    else if (JS_IsDebuggerFrame(context, stackFrame))
    {
        *name = "<debugger frame>";
    }
}

Referenced by OOJSDescribeLocation(), and OOJSMarkConsoleEvalLocation().

Here is the caller graph for this function:

JSArrayConverter()

static id JSArrayConverter ( JSContext * context, JSObject * object )

static

Definition at line 2481 of file OOJavaScriptEngine.m.

{
    jsuint                      i, count;
    id                          *values = NULL;
    jsval                       value = JSVAL_VOID;
    id                          object = nil;
    NSArray                     *result = nil;
    
    // Convert a JS array to an NSArray by calling OOJSNativeObjectFromJSValue() on all its elements.
    if (!JS_IsArrayObject(context, array)) return nil;
    if (!JS_GetArrayLength(context, array, &count)) return nil;
    
    if (count == 0)  return [NSArray array];
    
    values = calloc(count, sizeof *values);
    if (values == NULL)  return nil;
    
    for (i = 0; i != count; ++i)
    {
        value = JSVAL_VOID;
        if (!JS_GetElement(context, array, i, &value))  value = JSVAL_VOID;
        
        object = OOJSNativeObjectFromJSValue(context, value);
        if (object == nil)  object = [NSNull null];
        values[i] = object;
    }
    
    result = [NSArray arrayWithObjects:values count:count];
    free(values);
    return result;
}

References count, nil, and OOJSNativeObjectFromJSValue().

Here is the call graph for this function:

JSArrayFromNSArray()

static JSObject * JSArrayFromNSArray ( JSContext * context, NSArray * array )

static

Definition at line 1201 of file OOJavaScriptEngine.m.

{
    OOJS_PROFILE_ENTER
    
    JSObject                *result = NULL;
    
    if (array == nil)  return NULL;
    
    @try
    {
        NSUInteger fullCount = [array count];
        if (EXPECT_NOT(fullCount > INT32_MAX))
        {
            return NULL;
        }
        
        uint32_t i, count = (int32_t)fullCount;
        
        result = JS_NewArrayObject(context, 0, NULL);
        if (result != NULL)
        {
            for (i = 0; i != count; ++i)
            {
                jsval value = [[array objectAtIndex:i] oo_jsValueInContext:context];
                BOOL OK = JS_SetElement(context, result, i, &value);
                
                if (EXPECT_NOT(!OK))
                {
                    result = NULL;
                    break;
                }
            }
        }
    }
    @catch (id ex)
    {
        result = NULL;
    }
    
    return (JSObject *)result;
    
    OOJS_PROFILE_EXIT
}

References count, EXPECT_NOT, nil, OOJS_PROFILE_ENTER, and OOJS_PROFILE_EXIT.

Referenced by JSNewNSArrayValue().

Here is the caller graph for this function:

JSBooleanConverter()

static id JSBooleanConverter ( JSContext * context, JSObject * object )

static

Definition at line 2531 of file OOJavaScriptEngine.m.

{
    /*  Fun With JavaScript: Boolean(false) is a truthy value, since it's a
        non-null object. JS_ValueToBoolean() therefore reports true.
        However, Boolean objects are transformed to numbers sanely, so this
        works.
    */
    jsdouble value;
    if (JS_ValueToNumber(context, OBJECT_TO_JSVAL(object), &value))
    {
        return [NSNumber numberWithBool:(value != 0)];
    }
    return nil;
}

JSEntityIsDemoShipPredicate()

BOOL JSEntityIsDemoShipPredicate	(	Entity *	entity,
		void *	parameter )

Definition at line 2134 of file OOJavaScriptEngine.m.

{
    return ([entity isVisibleToScripts] && [entity isShip] && [entity status] == STATUS_COCKPIT_DISPLAY && ![entity isSubEntity]);
}

JSEntityIsJavaScriptSearchablePredicate()

BOOL JSEntityIsJavaScriptSearchablePredicate	(	Entity *	entity,
		void *	parameter )

Definition at line 2100 of file OOJavaScriptEngine.m.

{
    OOJS_PROFILE_ENTER
    
    if (![entity isVisibleToScripts])  return NO;
    if ([entity isShip])
    {
        if ([entity isSubEntity])  return NO;
        if ([entity status] == STATUS_COCKPIT_DISPLAY)  return NO;  // Demo ship
        return YES;
    }
    else if ([entity isPlanet])
    {
        switch ([(OOPlanetEntity *)entity planetType])
        {
            case STELLAR_TYPE_MOON:
            case STELLAR_TYPE_NORMAL_PLANET:
            case STELLAR_TYPE_SUN:
                return YES;
                
#if !NEW_PLANETS
            case STELLAR_TYPE_ATMOSPHERE:
#endif
            case STELLAR_TYPE_MINIATURE:
                return NO;
        }
    }
    
    return YES; // would happen if we added a new script-visible class
    
    OOJS_PROFILE_EXIT
}

References OOJS_PROFILE_ENTER, OOJS_PROFILE_EXIT, STELLAR_TYPE_ATMOSPHERE, STELLAR_TYPE_MINIATURE, STELLAR_TYPE_MOON, STELLAR_TYPE_NORMAL_PLANET, and STELLAR_TYPE_SUN.

Referenced by FindJSVisibleEntities().

Here is the caller graph for this function:

JSEntityIsJavaScriptVisiblePredicate()

BOOL JSEntityIsJavaScriptVisiblePredicate	(	Entity *	entity,
		void *	parameter )

Definition at line 2090 of file OOJavaScriptEngine.m.

{
    OOJS_PROFILE_ENTER
    
    return [entity isVisibleToScripts];
    
    OOJS_PROFILE_EXIT
}

References Entity::isVisibleToScripts, OOJS_PROFILE_ENTER, and OOJS_PROFILE_EXIT.

Here is the call graph for this function:

JSFunctionPredicate()

BOOL JSFunctionPredicate	(	Entity *	entity,
		void *	parameter )

Definition at line 2047 of file OOJavaScriptEngine.m.

{
    OOJS_PROFILE_ENTER
    
    JSFunctionPredicateParameter    *param = parameter;
    jsval                           args[1];
    jsval                           rval = JSVAL_VOID;
    JSBool                          result = NO;
    
    NSCParameterAssert(entity != nil && param != NULL);
    NSCParameterAssert(param->context != NULL && JS_IsInRequest(param->context));
    NSCParameterAssert(OOJSValueIsFunction(param->context, param->function));
    
    if (EXPECT_NOT(param->errorFlag))  return NO;
    
    args[0] = [entity oo_jsValueInContext:param->context];  // entity is required to be non-nil (asserted above), so oo_jsValueInContext: is safe.
    
    OOJSStartTimeLimiter();
    OOJSResumeTimeLimiter();
    BOOL success = JS_CallFunctionValue(param->context, param->jsThis, param->function, 1, args, &rval);
    OOJSPauseTimeLimiter();
    OOJSStopTimeLimiter();
    
    if (success)
    {
        if (!JS_ValueToBoolean(param->context, rval, &result))  result = NO;
        if (JS_IsExceptionPending(param->context))
        {
            JS_ReportPendingException(param->context);
            param->errorFlag = YES;
        }
    }
    else
    {
        param->errorFlag = YES;
    }
    
    return result;
    
    OOJS_PROFILE_EXIT
}

References EXPECT_NOT, JS_IsInRequest, nil, Entity::oo_jsValueInContext:, OOJS_PROFILE_ENTER, OOJS_PROFILE_EXIT, OOJSPauseTimeLimiter(), OOJSResumeTimeLimiter(), OOJSStartTimeLimiter, OOJSStopTimeLimiter, and OOJSValueIsFunction().

Referenced by SystemFilteredEntities().

Here is the call graph for this function:

Here is the caller graph for this function:

JSNewNSArrayValue()

static BOOL JSNewNSArrayValue ( JSContext * context, NSArray * array, jsval * value )

static

Definition at line 1246 of file OOJavaScriptEngine.m.

{
    OOJS_PROFILE_ENTER
    
    JSObject                *object = NULL;
    BOOL                    OK = YES;
    
    if (value == NULL)  return NO;
    
    // NOTE: should be called within a local root scope or have *value be a set root for GC reasons.
    if (!JS_EnterLocalRootScope(context))  return NO;
    
    object = JSArrayFromNSArray(context, array);
    if (object == NULL)
    {
        *value = JSVAL_VOID;
        OK = NO;
    }
    else
    {
        *value = OBJECT_TO_JSVAL(object);
    }
    
    JS_LeaveLocalRootScopeWithResult(context, *value);
    return OK;
    
    OOJS_PROFILE_EXIT
}

References JSArrayFromNSArray(), OOJS_PROFILE_ENTER, and OOJS_PROFILE_EXIT.

Here is the call graph for this function:

JSNewNSDictionaryValue()

static BOOL JSNewNSDictionaryValue ( JSContext * context, NSDictionary * dictionary, jsval * value )

static

Definition at line 1359 of file OOJavaScriptEngine.m.

{
    OOJS_PROFILE_ENTER
    
    JSObject                *object = NULL;
    BOOL                    OK = YES;
    
    if (value == NULL)  return NO;
    
    // NOTE: should be called within a local root scope or have *value be a set root for GC reasons.
    if (!JS_EnterLocalRootScope(context))  return NO;
    
    object = JSObjectFromNSDictionary(context, dictionary);
    if (object == NULL)
    {
        *value = JSVAL_VOID;
        OK = NO;
    }
    else
    {
        *value = OBJECT_TO_JSVAL(object);
    }
    
    JS_LeaveLocalRootScopeWithResult(context, *value);
    return OK;
    
    OOJS_PROFILE_EXIT
}

References JSObjectFromNSDictionary(), OOJS_PROFILE_ENTER, and OOJS_PROFILE_EXIT.

Here is the call graph for this function:

JSNumberConverter()

static id JSNumberConverter ( JSContext * context, JSObject * object )

static

Definition at line 2520 of file OOJavaScriptEngine.m.

{
    jsdouble value;
    if (JS_ValueToNumber(context, OBJECT_TO_JSVAL(object), &value))
    {
        return [NSNumber numberWithDouble:value];
    }
    return nil;
}

References nil.

JSObjectFromNSDictionary()

static JSObject * JSObjectFromNSDictionary ( JSContext * context, NSDictionary * dictionary )

static

Definition at line 1280 of file OOJavaScriptEngine.m.

{
    OOJS_PROFILE_ENTER
    
    JSObject                *result = NULL;
    BOOL                    OK = YES;
    NSEnumerator            *keyEnum = nil;
    id                      key = nil;
    jsval                   value;
    jsint                   index;
    
    if (dictionary == nil)  return NULL;
    
    @try
    {
        result = JS_NewObject(context, NULL, NULL, NULL);   // create object of class Object
        if (result != NULL)
        {
            for (keyEnum = [dictionary keyEnumerator]; (key = [keyEnum nextObject]); )
            {
                if ([key isKindOfClass:[NSString class]] && [key length] != 0)
                {
#ifndef __GNUC__
                    value = [[dictionary objectForKey:key] oo_jsValueInContext:context];
#else
#if __GNUC__ > 4 || __GNUC_MINOR__ > 6
                    value = [[dictionary objectForKey:key] oo_jsValueInContext:context];
#else
                    // GCC before 4.7 seems to have problems with this
                    // bit if the object is a weakref, causing crashes
                    // in docking code.
                    id tmp = [dictionary objectForKey:key];
                    if ([tmp respondsToSelector:@selector(weakRefUnderlyingObject)])
                    {
                        tmp = [tmp weakRefUnderlyingObject];
                    }
                    value = [tmp oo_jsValueInContext:context];
#endif
#endif
                    if (!JSVAL_IS_VOID(value))
                    {
                        OK = JS_SetPropertyById(context, result, OOJSIDFromString(key), &value);
                        if (EXPECT_NOT(!OK))  break;
                    }
                }
                else if ([key isKindOfClass:[NSNumber class]])
                {
                    index = [key intValue];
                    if (0 < index)
                    {
                        value = [[dictionary objectForKey:key] oo_jsValueInContext:context];
                        if (!JSVAL_IS_VOID(value))
                        {
                            OK = JS_SetElement(context, (JSObject *)result, index, &value);
                            if (EXPECT_NOT(!OK))  break;
                        }
                    }
                }
                
                if (EXPECT_NOT(!OK))  break;
            }
        }
    }
    @catch (id exception)
    {
        OK = NO;
    }
    
    if (EXPECT_NOT(!OK))
    {
        result = NULL;
    }
    
    return (JSObject *)result;
    
    OOJS_PROFILE_EXIT
}

References EXPECT_NOT, nil, OOJS_PROFILE_ENTER, OOJS_PROFILE_EXIT, and OOJSIDFromString().

Referenced by JSNewNSDictionaryValue().

Here is the call graph for this function:

Here is the caller graph for this function:

JSStringConverter()

static id JSStringConverter ( JSContext * context, JSObject * object )

static

Definition at line 2514 of file OOJavaScriptEngine.m.

{
    return OOStringFromJSValue(context, OBJECT_TO_JSVAL(object));
}

References OOStringFromJSValue().

Here is the call graph for this function:

OOJSArgumentListGetNumber()

BOOL OOJSArgumentListGetNumber	(	JSContext *	context,
		NSString *	scriptClass,
		NSString *	function,
		uintN	argc,
		jsval *	argv,
		double *	outNumber,
		uintN *	outConsumed )

Definition at line 1162 of file OOJavaScriptEngine.m.

{
    if (OOJSArgumentListGetNumberNoError(context, argc, argv, outNumber, outConsumed))
    {
        return YES;
    }
    else
    {
        OOJSReportBadArguments(context, scriptClass, function, argc, argv,
                                       @"Expected number, got", NULL);
        return NO;
    }
}

References OOJSArgumentListGetNumberNoError(), and OOJSReportBadArguments().

Referenced by QuaternionRotate(), QuaternionRotateX(), QuaternionRotateY(), QuaternionRotateZ(), SoundStaticPlayMusic(), VectorMultiply(), VectorRotationTo(), and VectorStaticInterpolate().

Here is the call graph for this function:

Here is the caller graph for this function:

OOJSArgumentListGetNumberNoError()

BOOL OOJSArgumentListGetNumberNoError	(	JSContext *	context,
		uintN	argc,
		jsval *	argv,
		double *	outNumber,
		uintN *	outConsumed )

Definition at line 1177 of file OOJavaScriptEngine.m.

{
    OOJS_PROFILE_ENTER
    
    double                  value;
    
    NSCParameterAssert(context != NULL && (argv != NULL || argc == 0) && outNumber != NULL);
    
    // Get value, if possible.
    if (EXPECT_NOT(!JS_ValueToNumber(context, argv[0], &value) || isnan(value)))
    {
        if (outConsumed != NULL)  *outConsumed = 0;
        return NO;
    }
    
    // Success.
    *outNumber = value;
    if (outConsumed != NULL)  *outConsumed = 1;
    return YES;
    
    OOJS_PROFILE_EXIT
}

References EXPECT_NOT, OOJS_PROFILE_ENTER, and OOJS_PROFILE_EXIT.

Referenced by OOJSArgumentListGetNumber(), VectorStaticRandom(), VectorStaticRandomDirection(), and VectorStaticRandomDirectionAndLength().

Here is the caller graph for this function:

OOJSBasicPrivateObjectConverter()

id OOJSBasicPrivateObjectConverter	(	JSContext *	context,
		JSObject *	object )

Definition at line 2441 of file OOJavaScriptEngine.m.

{
    id                      result;
    
    /*  This will do the right thing - for non-OOWeakReferences,
        weakRefUnderlyingObject returns the object itself. For nil, of course,
        it returns nil.
    */
    result = JS_GetPrivate(context, object);
    return [result weakRefUnderlyingObject];
}

Referenced by InitOOJSConsole(), InitOOJSDock(), InitOOJSEntity(), InitOOJSEquipmentInfo(), InitOOJSExhaustPlume(), InitOOJSFlasher(), InitOOJSManifest(), InitOOJSPlanet(), InitOOJSPlayer(), InitOOJSPlayerShip(), InitOOJSScript(), InitOOJSShip(), InitOOJSShipGroup(), InitOOJSSound(), InitOOJSSoundSource(), InitOOJSStation(), InitOOJSSun(), InitOOJSSystemInfo(), InitOOJSTimer(), InitOOJSVisualEffect(), InitOOJSWaypoint(), and InitOOJSWormhole().

Here is the caller graph for this function:

OOJSDescribeLocation()

NSString * OOJSDescribeLocation	(	JSContext *	context,
		JSStackFrame *	stackFrame )

Definition at line 894 of file OOJavaScriptEngine.m.

{
    NSCParameterAssert(context != NULL && stackFrame != NULL);
    
    const char  *fileName;
    NSUInteger  lineNo;
    GetLocationNameAndLine(context, stackFrame, &fileName, &lineNo);
    if (fileName == NULL)  return nil;
    
    // If this stops working, we probably need to switch to strcmp().
    if (fileName == sConsoleScriptName && lineNo >= sConsoleEvalLineNo)  return @"<console input>";
    
    // Objectify it.
    NSString    *fileNameObj = [NSString stringWithUTF8String:fileName];
    if (fileNameObj == nil)  fileNameObj = [NSString stringWithCString:fileName encoding:NSISOLatin1StringEncoding];
    if (fileNameObj == nil)  return nil;
    
    NSString    *shortFileName = [fileNameObj lastPathComponent];
    if (![[shortFileName lowercaseString] isEqualToString:@"script.js"])  fileNameObj = shortFileName;
    
    return [NSString stringWithFormat:@"%@:%lu", fileNameObj, lineNo];
}

References GetLocationNameAndLine(), nil, sConsoleEvalLineNo, and sConsoleScriptName.

Referenced by OOJSDumpStack().

Here is the call graph for this function:

Here is the caller graph for this function:

OOJSDescribeValue()

NSString * OOJSDescribeValue	(	JSContext *	context,
		jsval	value,
		BOOL	abbreviateObjects )

Definition at line 1736 of file OOJavaScriptEngine.m.

{
    return DescribeValue(context, value, abbreviateObjects, NO);
}

References DescribeValue().

Referenced by DumpVariable(), and OOJSReportBadPropertyValue().

Here is the call graph for this function:

Here is the caller graph for this function:

OOJSDictionaryFromJSObject()

NSDictionary * OOJSDictionaryFromJSObject	(	JSContext *	context,
		JSObject *	object )

Definition at line 2247 of file OOJavaScriptEngine.m.

{
    OOJS_PROFILE_ENTER
    
    JSIdArray                   *ids = NULL;
    jsint                       i;
    NSMutableDictionary         *result = nil;
    jsval                       value = JSVAL_VOID;
    id                          objKey = nil;
    id                          objValue = nil;
    
    ids = JS_Enumerate(context, object);
    if (EXPECT_NOT(ids == NULL))
    {
        return nil;
    }
    
    result = [NSMutableDictionary dictionaryWithCapacity:ids->length];
    for (i = 0; i != ids->length; ++i)
    {
        jsid thisID = ids->vector[i];
        
        if (JSID_IS_STRING(thisID))
        {
            objKey = OOStringFromJSString(context, JSID_TO_STRING(thisID));
        }
        else if (JSID_IS_INT(thisID))
        {
            /* this causes problems with native functions which expect string keys
             * e.g. in mission.runScreen with the 'choices' parameter
             * should this instead be making the objKey a string?
             * is there anything that relies on the current behaviour?
             * - CIM 15/2/13 */
            objKey = [NSNumber numberWithInt:JSID_TO_INT(thisID)];
        }
        else
        {
            objKey = nil;
        }
        
        value = JSVAL_VOID;
        if (objKey != nil && !JS_LookupPropertyById(context, object, thisID, &value))  value = JSVAL_VOID;
        
        if (objKey != nil && !JSVAL_IS_VOID(value))
        {
            objValue = OOJSNativeObjectFromJSValue(context, value);
            if (objValue != nil)
            {
                [result setObject:objValue forKey:objKey];
            }
        }
    }
    
    JS_DestroyIdArray(context, ids);
    return result;
    
    OOJS_PROFILE_EXIT
}

References EXPECT_NOT, nil, OOJS_PROFILE_ENTER, OOJS_PROFILE_EXIT, OOJSNativeObjectFromJSValue(), and OOStringFromJSString().

Referenced by OOJSDictionaryFromJSValue().

Here is the call graph for this function:

Here is the caller graph for this function:

OOJSDictionaryFromJSValue()

NSDictionary * OOJSDictionaryFromJSValue	(	JSContext *	context,
		jsval	value )

Definition at line 2232 of file OOJavaScriptEngine.m.

{
    OOJS_PROFILE_ENTER
    
    JSObject *object = NULL;
    if (EXPECT_NOT(!JS_ValueToObject(context, value, &object) || object == NULL))
    {
        return nil;
    }
    return OOJSDictionaryFromJSObject(context, object);
    
    OOJS_PROFILE_EXIT
}

References EXPECT_NOT, nil, OOJS_PROFILE_ENTER, OOJS_PROFILE_EXIT, and OOJSDictionaryFromJSObject().

Here is the call graph for this function:

OOJSDictionaryFromStringTable()

NSDictionary * OOJSDictionaryFromStringTable	(	JSContext *	context,
		jsval	tableValue )

Definition at line 2307 of file OOJavaScriptEngine.m.

{
    OOJS_PROFILE_ENTER
    
    JSObject                    *tableObject = NULL;
    JSIdArray                   *ids;
    jsint                       i;
    NSMutableDictionary         *result = nil;
    jsval                       value = JSVAL_VOID;
    id                          objKey = nil;
    id                          objValue = nil;
    
    if (EXPECT_NOT(JSVAL_IS_NULL(tableValue) || !JS_ValueToObject(context, tableValue, &tableObject)))
    {
        return nil;
    }
    
    ids = JS_Enumerate(context, tableObject);
    if (EXPECT_NOT(ids == NULL))
    {
        return nil;
    }
    
    result = [NSMutableDictionary dictionaryWithCapacity:ids->length];
    for (i = 0; i != ids->length; ++i)
    {
        jsid thisID = ids->vector[i];
        
        if (JSID_IS_STRING(thisID))
        {
            objKey = OOStringFromJSString(context, JSID_TO_STRING(thisID));
        }
        else
        {
            objKey = nil;
        }
        
        value = JSVAL_VOID;
        if (objKey != nil && !JS_LookupPropertyById(context, tableObject, thisID, &value))  value = JSVAL_VOID;
        
        if (objKey != nil && !JSVAL_IS_VOID(value))
        {
            objValue = OOStringFromJSValueEvenIfNull(context, value);
            
            if (objValue != nil)
            {
                [result setObject:objValue forKey:objKey];
            }
        }
    }
    
    JS_DestroyIdArray(context, ids);
    return result;
    
    OOJS_PROFILE_EXIT
}

References EXPECT_NOT, nil, OOJS_PROFILE_ENTER, OOJS_PROFILE_EXIT, OOStringFromJSString(), and OOStringFromJSValueEvenIfNull().

Referenced by GlobalExpandDescription(), and GlobalExpandMissionText().

Here is the call graph for this function:

Here is the caller graph for this function:

OOJSDumpStack()

void OOJSDumpStack

(

JSContext *

context

)

Definition at line 737 of file OOJavaScriptEngine.m.

{
    NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
    
    @try
    {
        JSStackFrame    *frame = NULL;
        unsigned        idx = 0;
        unsigned        skip = sErrorHandlerStackSkip;
        
        while (JS_FrameIterator(context, &frame) != NULL)
        {
            JSScript            *script = JS_GetFrameScript(context, frame);
            NSString            *desc = nil;
            JSPropertyDescArray properties = { 0 , NULL };
            BOOL                gotProperties = NO;
            
            idx++;
            
            if (!JS_IsScriptFrame(context, frame))
            {
                continue;
            }
            
            if (skip != 0)
            {
                skip--;
                continue;
            }
            
            if (script != NULL)
            {
                NSString    *location = OOJSDescribeLocation(context, frame);
                JSObject    *scope = JS_GetFrameScopeChain(context, frame);
                
                if (scope != NULL)  gotProperties = JS_GetPropertyDescArray(context, scope, &properties);
                
                NSString *funcDesc = nil;
                JSFunction *function = JS_GetFrameFunction(context, frame);
                if (function != NULL)
                {
                    JSString *funcName = JS_GetFunctionId(function);
                    if (funcName != NULL)
                    {
                        funcDesc = OOStringFromJSString(context, funcName);
                        if (!JS_IsConstructorFrame(context, frame))
                        {
                            funcDesc = [funcDesc stringByAppendingString:@"()"];
                        }
                        else
                        {
                            funcDesc = [NSString stringWithFormat:@"new %@()", funcDesc];
                        }
                        
                    }
                    else
                    {
                        funcDesc = @"<anonymous function>";
                    }
                }
                else
                {
                    funcDesc = @"<not a function frame>";
                }
                
                desc = [NSString stringWithFormat:@"(%@) %@", location, funcDesc];
            }
            else if (JS_IsDebuggerFrame(context, frame))
            {
                desc = @"<debugger frame>";
            }
            else
            {
                desc = @"<Oolite native>";
            }
            
            OOLog(@"script.javaScript.stackTrace", @"%2u %@", idx - 1, desc);
            
            if (gotProperties)
            {
                jsval this;
                if (JS_GetFrameThis(context, frame, &this))
                {
                    static BOOL haveThis = NO;
                    static jsval thisAtom;
                    if (EXPECT_NOT(!haveThis))
                    {
                        thisAtom = STRING_TO_JSVAL(JS_InternString(context, "this"));
                        haveThis = YES;
                    }
                    JSPropertyDesc thisDesc = { .id = thisAtom, .value = this };
                    DumpVariable(context, &thisDesc);
                }
                
                // Dump arguments.
                unsigned i;
                for (i = 0; i < properties.length; i++)
                {
                    JSPropertyDesc *prop = &properties.array[i];
                    if (prop->flags & JSPD_ARGUMENT)  DumpVariable(context, prop);
                }
                
                // Dump locals.
                for (i = 0; i < properties.length; i++)
                {
                    JSPropertyDesc *prop = &properties.array[i];
                    if (prop->flags & JSPD_VARIABLE)  DumpVariable(context, prop);
                }
                
                // Dump anything else.
                for (i = 0; i < properties.length; i++)
                {
                    JSPropertyDesc *prop = &properties.array[i];
                    if (!(prop->flags & (JSPD_ARGUMENT | JSPD_VARIABLE)))  DumpVariable(context, prop);
                }
                
                JS_PutPropertyDescArray(context, &properties);
            }
        }
    }
    @catch (NSException *exception)
    {
        OOLog(kOOLogException, @"Exception during JavaScript stack trace: %@:%@", [exception name], [exception reason]);
    }
    
    [pool release];
}

References DumpVariable(), EXPECT_NOT, kOOLogException, nil, OOJSDescribeLocation(), OOLog, OOStringFromJSString(), and sErrorHandlerStackSkip.

Referenced by NSString(OOJavaScriptExtensions)::concatenationOfStringsFromJavaScriptValues:count:separator:inContext:, OperationCallback(), and ReportJSError().

Here is the call graph for this function:

Here is the caller graph for this function:

OOJSIDFromString()

jsid OOJSIDFromString

(

NSString *

string

)

Definition at line 943 of file OOJavaScriptEngine.m.

{
    if (EXPECT_NOT(string == nil))  return JSID_VOID;
    
    JSContext *context = OOJSAcquireContext();
    
    enum { kStackBufSize = 1024 };
    unichar stackBuf[kStackBufSize];
    unichar *buffer;
    size_t length = [string length];
    if (length < kStackBufSize)
    {
        buffer = stackBuf;
    }
    else
    {
        buffer = malloc(sizeof (unichar) * length);
        if (EXPECT_NOT(buffer == NULL))  return JSID_VOID;
    }
    [string getCharacters:buffer];
    
    JSString *jsString = JS_InternUCStringN(context, buffer, length);
    
    if (EXPECT_NOT(buffer != stackBuf))  free(buffer);
    
    OOJSRelinquishContext(context);
    
    if (EXPECT(jsString != NULL))  return INTERNED_STRING_TO_JSID(jsString);
    else  return JSID_VOID;
}

References EXPECT, EXPECT_NOT, nil, OOJSAcquireContext(), and OOJSRelinquishContext().

Referenced by JSObjectFromNSDictionary().

Here is the call graph for this function:

Here is the caller graph for this function:

OOJSInitJSIDCachePRIVATE()

void OOJSInitJSIDCachePRIVATE	(	const char *	name,
		jsid *	idCache )

Definition at line 925 of file OOJavaScriptEngine.m.

{
    NSCParameterAssert(name != NULL && name[0] != '\0' && idCache != NULL);
    
    JSContext *context = OOJSAcquireContext();
    
    JSString *string = JS_InternString(context, name);
    if (EXPECT_NOT(string == NULL))
    {
        [NSException raise:NSGenericException format:@"Failed to initialize JS ID cache for \"%s\".", name];
    }
    
    *idCache = INTERNED_STRING_TO_JSID(string);
    
    OOJSRelinquishContext(context);
}

References EXPECT_NOT, OOJSAcquireContext(), and OOJSRelinquishContext().

Here is the call graph for this function:

OOJSIsSubclass()

BOOL OOJSIsSubclass	(	JSClass *	putativeSubclass,
		JSClass *	superclass )

Definition at line 2163 of file OOJavaScriptEngine.m.

{
    NSCParameterAssert(putativeSubclass != NULL && superclass != NULL);
    NSCAssert(sRegisteredSubClasses != NULL, @"OOJSIsSubclass() called before any subclasses registered (disallowed for hot path efficiency).");
    
    do
    {
        if (putativeSubclass == superclass)  return YES;
        
        putativeSubclass = NSMapGet(sRegisteredSubClasses, putativeSubclass);
    }
    while (putativeSubclass != NULL);
    
    return NO;
}

References sRegisteredSubClasses.

Referenced by OOJSIsMemberOfSubclass(), and OOJSObjectGetterImplPRIVATE().

Here is the caller graph for this function:

OOJSMarkConsoleEvalLocation()

void OOJSMarkConsoleEvalLocation	(	JSContext *	context,
		JSStackFrame *	stackFrame )

Definition at line 918 of file OOJavaScriptEngine.m.

{
    GetLocationNameAndLine(context, stackFrame, &sConsoleScriptName, &sConsoleEvalLineNo);
}

References GetLocationNameAndLine(), sConsoleEvalLineNo, and sConsoleScriptName.

Referenced by SpecialMarkConsoleEntryPoint().

Here is the call graph for this function:

Here is the caller graph for this function:

OOJSNativeObjectFromJSObject()

id OOJSNativeObjectFromJSObject	(	JSContext *	context,
		JSObject *	tableObject )

Definition at line 2400 of file OOJavaScriptEngine.m.

{
    OOJS_PROFILE_ENTER
    
    NSValue                 *wrappedClass = nil;
    NSValue                 *wrappedConverter = nil;
    OOJSClassConverterCallback converter = NULL;
    JSClass                 *class = NULL;
    
    if (tableObject == NULL)  return nil;
    
    class = OOJSGetClass(context, tableObject);
    wrappedClass = [NSValue valueWithPointer:class];
    if (wrappedClass != nil)  wrappedConverter = [sObjectConverters objectForKey:wrappedClass];
    if (wrappedConverter != nil)
    {
        converter = [wrappedConverter pointerValue];
        return converter(context, tableObject);
    }
    return nil;
    
    OOJS_PROFILE_EXIT
}

References nil, OOJS_PROFILE_ENTER, OOJS_PROFILE_EXIT, and OOJSGetClass().

Referenced by ConsoleClearConsole(), ConsoleSettingsDeleteProperty(), ConsoleSettingsGetProperty(), ConsoleSettingsSetProperty(), GetParameterDictionary(), GlobalSetExtraGuiScreenKeys(), MissionMarkSystem(), MissionUnmarkSystem(), OOJSNativeObjectFromJSValue(), OOJSNativeObjectOfClassFromJSObject(), OOJSObjectWrapperToString(), ShipSetCrew(), ShipSetMaterialsInternal(), ShipStaticSetShipDataForKey(), StationAddShipToShipyard(), SystemSetPopulator(), and VisualEffectSetMaterialsInternal().

Here is the call graph for this function:

Here is the caller graph for this function:

OOJSNativeObjectFromJSValue()

id OOJSNativeObjectFromJSValue	(	JSContext *	context,
		jsval	value )

Definition at line 2368 of file OOJavaScriptEngine.m.

{
    OOJS_PROFILE_ENTER
    
    if (JSVAL_IS_NULL(value) || JSVAL_IS_VOID(value))  return nil;
    
    if (JSVAL_IS_INT(value))
    {
        return [NSNumber numberWithInt:JSVAL_TO_INT(value)];
    }
    if (JSVAL_IS_DOUBLE(value))
    {
        return [NSNumber numberWithDouble:JSVAL_TO_DOUBLE(value)];
    }
    if (JSVAL_IS_BOOLEAN(value))
    {
        return [NSNumber numberWithBool:JSVAL_TO_BOOLEAN(value)];
    }
    if (JSVAL_IS_STRING(value))
    {
        return OOStringFromJSValue(context, value);
    }
    if (JSVAL_IS_OBJECT(value))
    {
        return OOJSNativeObjectFromJSObject(context, JSVAL_TO_OBJECT(value));
    }
    return nil;
    
    OOJS_PROFILE_EXIT
}

References nil, OOJS_PROFILE_ENTER, OOJS_PROFILE_EXIT, OOJSNativeObjectFromJSObject(), and OOStringFromJSValue().

Referenced by ConsoleSettingsSetProperty(), JSArrayConverter(), JSValueToEquipmentKeyRelaxed(), MissionSetInstructionsInternal(), OOJSDictionaryFromJSObject(), OOJSNativeObjectOfClassFromJSValue(), OoliteCompareVersion(), PlayerSetEscapePodDestination(), PlayerShipSetCustomHUDDial(), ShipRunLegacyScriptActions(), SystemInfoSetPropertyMethod(), and SystemInfoStaticSetInterstellarProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

OOJSNativeObjectOfClassFromJSObject()

id OOJSNativeObjectOfClassFromJSObject	(	JSContext *	context,
		JSObject *	object,
		Class	requiredClass )

Definition at line 2433 of file OOJavaScriptEngine.m.

{
    id result = OOJSNativeObjectFromJSObject(context, object);
    if (![result isKindOfClass:requiredClass])  result = nil;
    return result;
}

References nil, and OOJSNativeObjectFromJSObject().

Referenced by ConsoleConsoleMessage(), ScriptAddProperty(), SystemInfoGetProperty(), and SystemInfoSetProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

OOJSNativeObjectOfClassFromJSValue()

id OOJSNativeObjectOfClassFromJSValue	(	JSContext *	context,
		jsval	value,
		Class	requiredClass )

Definition at line 2425 of file OOJavaScriptEngine.m.

{
    id result = OOJSNativeObjectFromJSValue(context, value);
    if (![result isKindOfClass:requiredClass])  result = nil;
    return result;
}

References nil, and OOJSNativeObjectFromJSValue().

Referenced by OOShipGroup(OOJavaScriptExtensions)::oo_clearJSSelf:, PlayerShipCancelDockingRequest(), PlayerShipEngageAutopilotToStation(), PlayerShipRequestDockingClearance(), ShipGroupAddShip(), ShipGroupConstruct(), ShipGroupRemoveShip(), ShipGroupSetProperty(), ShipSetProperty(), and SoundFromJSValue().

Here is the call graph for this function:

Here is the caller graph for this function:

OOJSObjectFromNativeObject()

JSObject * OOJSObjectFromNativeObject	(	JSContext *	context,
		id	object )

Definition at line 1442 of file OOJavaScriptEngine.m.

{
    jsval value = OOJSValueFromNativeObject(context, object);
    JSObject *result = NULL;
    if (JS_ValueToObject(context, value, &result))  return result;
    return NULL;
}

References OOJSValueFromNativeObject().

Here is the call graph for this function:

OOJSObjectGetterImplPRIVATE()

BOOL OOJSObjectGetterImplPRIVATE	(	JSContext *	context,
		JSObject *	object,
		JSClass *	requiredJSClass,
		Class	requiredObjCClass,
		const char *	name,
		id *	outObject )

Definition at line 2180 of file OOJavaScriptEngine.m.

{
#ifndef NDEBUG
    OOJS_PROFILE_ENTER_NAMED(name)
    NSCParameterAssert(requiredObjCClass != Nil);
    NSCParameterAssert(context != NULL && object != NULL && requiredJSClass != NULL && outObject != NULL);
#else
    OOJS_PROFILE_ENTER
#endif
    
    /*
        Ensure it's a valid type of JS object. This is absolutely necessary,
        because if we don't check it we'll crash trying to get the private
        field of something that isn't an ObjC object wrapper - for example,
        Ship.setAI.call(new Vector3D, "") is valid JavaScript.
        
        Alternatively, we could abuse JSCLASS_PRIVATE_IS_NSISUPPORTS as a
        flag for ObjC object wrappers (SpiderMonkey only uses it internally
        in a debug function we don't use), but we'd still need to do an
        Objective-C class test, and I don't think that's any faster.
        TODO: profile.
    */
    JSClass *actualClass = OOJSGetClass(context, object);
    if (EXPECT_NOT(!OOJSIsSubclass(actualClass, requiredJSClass)))
    {
        OOJSReportError(context, @"Native method expected %s, got %@.", requiredJSClass->name, OOStringFromJSValue(context, OBJECT_TO_JSVAL(object)));
        return NO;
    }
    NSCAssert(actualClass->flags & JSCLASS_HAS_PRIVATE, @"Native object accessor requires JS class with private storage.");
    
    // Get the underlying object.
    *outObject = [(id)JS_GetPrivate(context, object) weakRefUnderlyingObject];
    
#ifndef NDEBUG
    // Double-check that the underlying object is of the expected ObjC class.
    if (EXPECT_NOT(*outObject != nil && ![*outObject isKindOfClass:requiredObjCClass]))
    {
        OOJSReportError(context, @"Native method expected %@ from %s and got correct JS type but incorrect native object %@", requiredObjCClass, requiredJSClass->name, *outObject);
        return NO;
    }
#endif
    
    return YES;
    
    OOJS_PROFILE_EXIT
}

References EXPECT_NOT, nil, OOJS_PROFILE_ENTER, OOJS_PROFILE_EXIT, OOJSGetClass(), OOJSIsSubclass(), OOJSReportError(), and OOStringFromJSValue().

Here is the call graph for this function:

OOJSObjectWrapperFinalize()

void OOJSObjectWrapperFinalize	(	JSContext *	context,
		JSObject *	this )

Definition at line 2001 of file OOJavaScriptEngine.m.

{
    OOJS_PROFILE_ENTER
    
    id object = JS_GetPrivate(context, this);
    if (object != nil)
    {
        [[object weakRefUnderlyingObject] oo_clearJSSelf:this];
        [object release];
        JS_SetPrivate(context, this, nil);
    }
    
    OOJS_PROFILE_EXIT_VOID
}

References nil, OOJS_PROFILE_ENTER, and OOJS_PROFILE_EXIT_VOID.

OOJSObjectWrapperToString()

JSBool OOJSObjectWrapperToString	(	JSContext *	context,
		uintN	argc,
		jsval *	vp )

Definition at line 2017 of file OOJavaScriptEngine.m.

{
    OOJS_NATIVE_ENTER(context)
    
    id                      object = nil;
    NSString                *description = nil;
    JSClass                 *jsClass = NULL;
    
    object = OOJSNativeObjectFromJSObject(context, OOJS_THIS);
    if (object != nil)
    {
        description = [object oo_jsDescription];
        if (description == nil)  description = [object description];
    }
    if (description == nil)
    {
        jsClass = OOJSGetClass(context, OOJS_THIS);
        if (jsClass != NULL)
        {
            description = [NSString stringWithFormat:@"[object %@]", [NSString stringWithUTF8String:jsClass->name]];
        }
    }
    if (description == nil)  description = @"[object]";
    
    OOJS_RETURN_OBJECT(description);
    
    OOJS_NATIVE_EXIT
}

References nil, OOJS_NATIVE_ENTER, OOJS_NATIVE_EXIT, OOJS_RETURN_OBJECT, OOJS_THIS, OOJSGetClass(), and OOJSNativeObjectFromJSObject().

Here is the call graph for this function:

OOJSRegisterObjectConverter()

void OOJSRegisterObjectConverter	(	JSClass *	theClass,
		OOJSClassConverterCallback	converter )

Definition at line 2454 of file OOJavaScriptEngine.m.

{
    NSValue                 *wrappedClass = nil;
    NSValue                 *wrappedConverter = nil;
    
    if (theClass == NULL)  return;
    if (sObjectConverters == nil)  sObjectConverters = [[NSMutableDictionary alloc] init];
    
    wrappedClass = [NSValue valueWithPointer:theClass];
    if (converter != NULL)
    {
        wrappedConverter = [NSValue valueWithPointer:converter];
        [sObjectConverters setObject:wrappedConverter forKey:wrappedClass];
    }
    else
    {
        [sObjectConverters removeObjectForKey:wrappedClass];
    }
}

References nil, and sObjectConverters.

Referenced by InitOOJSConsole(), InitOOJSDock(), InitOOJSEntity(), InitOOJSEquipmentInfo(), InitOOJSExhaustPlume(), InitOOJSFlasher(), InitOOJSManifest(), InitOOJSMissionVariables(), InitOOJSPlanet(), InitOOJSPlayer(), InitOOJSPlayerShip(), InitOOJSScript(), InitOOJSShip(), InitOOJSShipGroup(), InitOOJSSound(), InitOOJSSoundSource(), InitOOJSStation(), InitOOJSSun(), InitOOJSSystemInfo(), InitOOJSTimer(), InitOOJSVisualEffect(), InitOOJSWaypoint(), and InitOOJSWormhole().

Here is the caller graph for this function:

OOJSRegisterSubclass()

void OOJSRegisterSubclass	(	JSClass *	subclass,
		JSClass *	superclass )

Definition at line 2141 of file OOJavaScriptEngine.m.

{
    NSCParameterAssert(subclass != NULL && superclass != NULL);
    
    if (sRegisteredSubClasses == NULL)
    {
        sRegisteredSubClasses = NSCreateMapTable(NSNonOwnedPointerMapKeyCallBacks, NSNonOwnedPointerMapValueCallBacks, 0);
    }
    
    NSCAssert(NSMapGet(sRegisteredSubClasses, subclass) == NULL, @"A JS class cannot be registered as a subclass of multiple classes.");
    
    NSMapInsertKnownAbsent(sRegisteredSubClasses, subclass, superclass);
}

References sRegisteredSubClasses.

Referenced by InitOOJSDock(), InitOOJSExhaustPlume(), InitOOJSFlasher(), InitOOJSPlanet(), InitOOJSPlayerShip(), InitOOJSShip(), InitOOJSStation(), InitOOJSSun(), InitOOJSVisualEffect(), InitOOJSWaypoint(), and InitOOJSWormhole().

Here is the caller graph for this function:

OOJSReportBadArguments()

void OOJSReportBadArguments	(	JSContext *	context,
		NSString *	scriptClass,
		NSString *	function,
		uintN	argc,
		jsval *	argv,
		NSString *	message,
		NSString *	expectedArgsDescription )

Definition at line 1139 of file OOJavaScriptEngine.m.

{
    @try
    {
        if (message == nil)  message = @"Invalid arguments";
        message = [NSString stringWithFormat:@"%@ %@", message, [NSString stringWithJavaScriptParameters:argv count:argc inContext:context]];
        if (expectedArgsDescription != nil)  message = [NSString stringWithFormat:@"%@ -- expected %@", message, expectedArgsDescription];
        
        OOJSReportErrorForCaller(context, scriptClass, function, @"%@.", message);
    }
    @catch (id exception)
    {
        // Squash any secondary errors during error handling.
    }
}

References nil, and OOJSReportErrorForCaller().

Referenced by ClockAddSeconds(), ClockClockStringForTime(), OOManifest::dealloc, FontMeasureString(), DockEntity(OOJavaScriptExtensions)::getJSClass:andPrototype:, StationEntity(OOJavaScriptExtensions)::getJSClass:andPrototype:, GetRelativeToAndRange(), GetThisQuaternion(), GetThisVector(), GlobalAddFrameCallback(), GlobalAutoAIForRole(), GlobalClearExtraGuiScreenKeys(), GlobalDisplayNameForCommodity(), GlobalExpandDescription(), GlobalExpandMissionText(), GlobalGetGuiColorSettingForKey(), GlobalGetScreenBackgroundForKey(), GlobalIsValidFrameCallback(), GlobalKeyBindingDescription(), GlobalRandomInhabitantsDescription(), GlobalRemoveFrameCallback(), GlobalSetExtraGuiScreenKeys(), GlobalSetGuiColorSettingForKey(), GlobalSetScreenBackground(), GlobalSetScreenBackgroundForKey(), GlobalSetScreenOverlay(), GlobalTakeSnapShot(), PlayerEntity(OOJavaScriptExtensions)::javaScriptEngineWillReset:, ManifestComment(), ManifestSetComment(), ManifestShortComment(), MissionMarkSystem(), MissionRunScreen(), MissionSetInstructionsInternal(), MissionUnmarkSystem(), OOEquipmentType(OOJavaScriptExtensions)::oo_clearJSSelf:, OOShipGroup(OOJavaScriptExtensions)::oo_clearJSSelf:, OOSound(OOJavaScriptExtentions)::oo_jsClassName, OOJSArgumentListGetNumber(), PlayerAddMessageToArrivalReport(), PlayerAudioMessage(), PlayerCommsMessage(), PlayerConsoleMessage(), PlayerEndScenario(), PlayerReplaceShip(), PlayerSetEscapePodDestination(), PlayerSetPlayerRole(), PlayerShipAddParcel(), PlayerShipAddPassenger(), PlayerShipAwardContract(), PlayerShipAwardEquipmentToCurrentPylon(), PlayerShipBeginGalacticHyperspaceCountdown(), PlayerShipBeginHyperspaceCountdown(), PlayerShipCancelDockingRequest(), PlayerShipEngageAutopilotToStation(), PlayerShipHideHUDSelector(), PlayerShipRemoveContract(), PlayerShipRemoveParcel(), PlayerShipRemovePassenger(), PlayerShipRequestDockingClearance(), PlayerShipSetCustomHUDDial(), PlayerShipSetCustomView(), PlayerShipSetMultiFunctionDisplay(), PlayerShipSetMultiFunctionText(), PlayerShipSetPrimedEquipment(), PlayerShipShowHUDSelector(), PlayerShipUseSpecialCargo(), QuaternionConstruct(), QuaternionFromArgumentList(), ShipAddCargoEntity(), ShipAddCollisionException(), ShipAddDefenseTarget(), ShipAdjustCargo(), ShipAwardEquipment(), ShipCanAwardEquipment(), ShipCheckScanner(), ShipCommsMessage(), ShipDealEnergyDamage(), ShipDumpCargo(), ShipEjectItem(), ShipEjectSpecificItem(), ShipEnterWormhole(), ShipEquipmentStatus(), ShipExitSystem(), ShipGroupAddShip(), ShipGroupConstruct(), ShipGroupRemoveShip(), ShipHasEquipmentProviding(), ShipHasRole(), ShipOfferToEscort(), ShipPatrolReportIn(), ShipReactToAIMessage(), ShipRemove(), ShipRemoveCollisionException(), ShipRemoveDefenseTarget(), ShipRemoveEquipment(), ShipRunLegacyScriptActions(), ShipSendAIMessage(), ShipSetAI(), ShipSetBounty(), ShipSetCargo(), ShipSetCargoType(), ShipSetCrew(), ShipSetEquipmentStatus(), ShipSetMaterials(), ShipSetScript(), ShipSetShaders(), ShipSpawn(), ShipStaticKeysForRole(), ShipStaticRoleIsInCategory(), ShipStaticSetShipDataForKey(), ShipStaticShipDataForKey(), ShipSwitchAI(), ShipThreatAssessment(), SoundSourcePlay(), SoundStaticLoad(), SoundStaticPlayMusic(), SpecialJSWarning(), StationAbortDockingForShip(), StationAddShipToShipyard(), StationCanDockShip(), StationLaunchShipWithRole(), StationSetInterface(), StationSetMarketPrice(), StationSetMarketQuantity(), SystemAddMoon(), SystemAddPlanet(), SystemAddShipsOrGroup(), SystemAddShipsOrGroupToRoute(), SystemAddVisualEffect(), SystemCountEntitiesWithScanClass(), SystemCountShipsWithPrimaryRole(), SystemCountShipsWithRole(), SystemEntitiesWithScanClass(), SystemFilteredEntities(), SystemInfoDistanceToSystem(), SystemInfoRouteToSystem(), SystemInfoSamplePrice(), SystemInfoSetPropertyMethod(), SystemInfoStaticFilteredSystems(), SystemInfoStaticSetInterstellarProperty(), SystemLegacyAddShips(), SystemLegacyAddShipsAt(), SystemLegacyAddShipsAtPrecisely(), SystemLegacyAddShipsWithinRadius(), SystemLegacyAddSystemShips(), SystemLegacySpawnShip(), SystemLocationFromCode(), SystemSetPopulator(), SystemSetWaypoint(), SystemShipsWithPrimaryRole(), SystemShipsWithRole(), SystemStaticInfoForSystem(), SystemStaticSystemIDForName(), SystemStaticSystemNameForID(), TimerConstruct(), VectorConstruct(), VectorFromArgumentList(), VectorFromCoordinateSystem(), VectorStaticInterpolate(), VectorToCoordinateSystem(), VisualEffectScale(), VisualEffectSetMaterials(), and VisualEffectSetShaders().

Here is the call graph for this function:

OOJSReportBadPropertySelector()

void OOJSReportBadPropertySelector	(	JSContext *	context,
		JSObject *	thisObj,
		jsid	propID,
		JSPropertySpec *	propertySpec )

Definition at line 1120 of file OOJavaScriptEngine.m.

{
    NSString    *propName = OOStringFromJSPropertyIDAndSpec(context, propID, propertySpec);
    const char  *className = OOJSGetClass(context, thisObj)->name;
    
    OOJSReportError(context, @"Invalid property identifier %@ for instance of %s.", propName, className);
}

References OOJSGetClass(), OOJSReportError(), and OOStringFromJSPropertyIDAndSpec().

Referenced by ClockGetProperty(), ConsoleGetProperty(), ConsoleSetProperty(), DockGetProperty(), DockSetProperty(), EntityGetProperty(), EntitySetProperty(), EquipmentInfoGetProperty(), EquipmentInfoSetProperty(), ExhaustPlumeGetProperty(), ExhaustPlumeSetProperty(), FlasherGetProperty(), FlasherSetProperty(), OOPlanetEntity(OOJavaScriptExtensions)::getJSClass:andPrototype:, OOWaypointEntity(OOJavaScriptExtensions)::getJSClass:andPrototype:, WormholeEntity(OOJavaScriptExtensions)::getJSClass:andPrototype:, GlobalGetProperty(), GlobalSetProperty(), ManifestGetProperty(), MissionGetProperty(), MissionSetProperty(), OoliteGetProperty(), PlanetGetProperty(), PlayerGetProperty(), PlayerSetProperty(), PlayerShipGetProperty(), PlayerShipSetProperty(), QuaternionGetProperty(), QuaternionSetProperty(), ShipGetProperty(), ShipGroupGetProperty(), ShipGroupSetProperty(), ShipSetProperty(), SoundGetProperty(), SoundSourceGetProperty(), SoundSourceSetProperty(), StationGetProperty(), StationSetProperty(), SunGetProperty(), SystemGetProperty(), SystemInfoGetProperty(), SystemSetProperty(), TimerGetProperty(), TimerSetProperty(), VectorGetProperty(), VectorSetProperty(), VisualEffectGetProperty(), VisualEffectSetProperty(), WaypointGetProperty(), and WormholeGetProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

OOJSReportBadPropertyValue()

void OOJSReportBadPropertyValue	(	JSContext *	context,
		JSObject *	thisObj,
		jsid	propID,
		JSPropertySpec *	propertySpec,
		jsval	value )

Definition at line 1129 of file OOJavaScriptEngine.m.

{
    NSString    *propName = OOStringFromJSPropertyIDAndSpec(context, propID, propertySpec);
    const char  *className = OOJSGetClass(context, thisObj)->name;
    NSString    *valueDesc = OOJSDescribeValue(context, value, YES);
    
    OOJSReportError(context, @"Cannot set property %@ of instance of %s to invalid value %@.", propName, className, valueDesc);
}

References OOJSDescribeValue(), OOJSGetClass(), OOJSReportError(), and OOStringFromJSPropertyIDAndSpec().

Referenced by DockSetProperty(), EntitySetProperty(), EquipmentInfoSetProperty(), ExhaustPlumeSetProperty(), FlasherSetProperty(), OOPlanetEntity(OOJavaScriptExtensions)::getJSClass:andPrototype:, OOWaypointEntity(OOJavaScriptExtensions)::getJSClass:andPrototype:, WormholeEntity(OOJavaScriptExtensions)::getJSClass:andPrototype:, GlobalSetProperty(), ManifestSetProperty(), MissionSetProperty(), PlayerSetProperty(), PlayerShipSetProperty(), QuaternionSetProperty(), ShipGroupSetProperty(), ShipSetProperty(), SoundSourceSetProperty(), StationSetProperty(), SystemSetProperty(), TimerSetProperty(), VectorSetProperty(), and VisualEffectSetProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

OOJSReportError()

void OOJSReportError	(	JSContext *	context,
		NSString *	format,
			... )

Definition at line 1000 of file OOJavaScriptEngine.m.

{
    va_list                 args;
    
    va_start(args, format);
    OOJSReportErrorWithArguments(context, format, args);
    va_end(args);
}

References OOJSReportErrorWithArguments().

Referenced by ConsoleClearConsole(), ConsoleConsoleMessage(), ConsoleSettingsDeleteProperty(), ConsoleSettingsGetProperty(), ConsoleSettingsSetProperty(), EntitySetProperty(), GlobalAddFrameCallback(), MissionVariablesSetProperty(), OOJSCallObjCObjectMethod(), OOJSObjectGetterImplPRIVATE(), OOJSReportBadPropertySelector(), OOJSReportBadPropertyValue(), OOJSReportErrorForCaller(), OOJSReportWrappedException(), OOJSUnconstructableConstruct(), PlayerReplaceShip(), PlayerSetEscapePodDestination(), PlayerShipRemoveAllCargo(), PlayerShipResetCustomView(), PlayerShipSetCustomView(), PlayerShipSetProperty(), RemoveOrExplodeShip(), ShipAdjustCargo(), ShipEnterWormhole(), ShipGroupConstruct(), ShipRemove(), ShipSetProperty(), SoundSourceConstruct(), SystemInfoGetProperty(), and TimerConstruct().

Here is the call graph for this function:

Here is the caller graph for this function:

OOJSReportErrorForCaller()

void OOJSReportErrorForCaller	(	JSContext *	context,
		NSString *	scriptClass,
		NSString *	function,
		NSString *	format,
			... )

Definition at line 1010 of file OOJavaScriptEngine.m.

{
    va_list                 args;
    NSString                *msg = nil;
    
    @try
    {
        va_start(args, format);
        msg = [[NSString alloc] initWithFormat:format arguments:args];
        va_end(args);
        
        OOJSReportError(context, @"%@%@", CallerPrefix(scriptClass, function), msg);
    }
    @catch (id exception)
    {
        // Squash any secondary errors during error handling.
    }
    [msg release];
}

References CallerPrefix(), nil, and OOJSReportError().

Referenced by OOJSReportBadArguments(), ShipExitAI(), ShipExitSystem(), ShipReactToAIMessage(), ShipSendAIMessage(), ShipSetAI(), ShipSetEquipmentStatus(), ShipSetScript(), ShipSwitchAI(), SystemInfoDistanceToSystem(), SystemInfoRouteToSystem(), and SystemInfoSamplePrice().

Here is the call graph for this function:

Here is the caller graph for this function:

OOJSReportErrorWithArguments()

void OOJSReportErrorWithArguments	(	JSContext *	context,
		NSString *	format,
		va_list	args )

Definition at line 1031 of file OOJavaScriptEngine.m.

{
    NSString                *msg = nil;
    
    NSCParameterAssert(JS_IsInRequest(context));
    
    @try
    {
        msg = [[NSString alloc] initWithFormat:format arguments:args];
        JS_ReportError(context, "%s", [msg UTF8String]);
    }
    @catch (id exception)
    {
        // Squash any secondary errors during error handling.
    }
    [msg release];
}

References JS_IsInRequest, and nil.

Referenced by OOJSReportError().

Here is the caller graph for this function:

OOJSReportWarning()

void OOJSReportWarning	(	JSContext *	context,
		NSString *	format,
			... )

Definition at line 1072 of file OOJavaScriptEngine.m.

{
    va_list                 args;
    
    va_start(args, format);
    OOJSReportWarningWithArguments(context, format, args);
    va_end(args);
}

References OOJSReportWarningWithArguments().

Referenced by ConsoleConsoleMessage(), ConsoleSettingsSetProperty(), EntityFromArgumentList(), EquipmentInfoSetProperty(), OOPlanetEntity(OOJavaScriptExtensions)::getJSClass:andPrototype:, GetJSSystemInfoForSystem(), GlobalRemoveFrameCallback(), GlobalSetScreenBackground(), GlobalSetScreenOverlay(), GlobalTakeSnapShot(), ManifestSetProperty(), MissionRunScreen(), MissionRunShipLibrary(), MissionSetInstructionsInternal(), OOJSReportWarningForCaller(), PlayerShipSetProperty(), ScriptAddProperty(), ShipFireECM(), ShipSetMaterialsInternal(), ShipSetShaders(), SpecialJSWarning(), TimerSetProperty(), VisualEffectSetMaterialsInternal(), and VisualEffectSetShaders().

Here is the call graph for this function:

Here is the caller graph for this function:

OOJSReportWarningForCaller()

void OOJSReportWarningForCaller	(	JSContext *	context,
		NSString *	scriptClass,
		NSString *	function,
		NSString *	format,
			... )

Definition at line 1082 of file OOJavaScriptEngine.m.

{
    va_list                 args;
    NSString                *msg = nil;
    
    @try
    {
        va_start(args, format);
        msg = [[NSString alloc] initWithFormat:format arguments:args];
        va_end(args);
        
        OOJSReportWarning(context, @"%@%@", CallerPrefix(scriptClass, function), msg);
    }
    @catch (id exception)
    {
        // Squash any secondary errors during error handling.
    }
    [msg release];
}

References CallerPrefix(), nil, and OOJSReportWarning().

Referenced by StationEntity(OOJavaScriptExtensions)::getJSClass:andPrototype:, ShipAddCargoEntity(), ShipDumpCargo(), ShipExitAI(), ShipGroupAddShip(), ShipSetEquipmentStatus(), and StationAddShipToShipyard().

Here is the call graph for this function:

Here is the caller graph for this function:

OOJSReportWarningWithArguments()

void OOJSReportWarningWithArguments	(	JSContext *	context,
		NSString *	format,
		va_list	args )

Definition at line 1103 of file OOJavaScriptEngine.m.

{
    NSString                *msg = nil;
    
    @try
    {
        msg = [[NSString alloc] initWithFormat:format arguments:args];
        JS_ReportWarning(context, "%s", [msg UTF8String]);
    }
    @catch (id exception)
    {
        // Squash any secondary errors during error handling.
    }
    [msg release];
}

References nil.

Referenced by OOJSReportWarning(), and SyntaxIssue().

Here is the caller graph for this function:

OOJSReportWrappedException()

void OOJSReportWrappedException	(	JSContext *	context,
		id	exception )

Definition at line 1050 of file OOJavaScriptEngine.m.

{
    if (!JS_IsExceptionPending(context))
    {
        if ([exception isKindOfClass:[NSException class]])  OOJSReportError(context, @"Native exception: %@", [exception reason]);
        else  OOJSReportError(context, @"Unidentified native exception");
    }
    // Else, let the pending exception propagate.
}

References OOJSReportError().

Here is the call graph for this function:

OOJSSetWarningOrErrorStackSkip()

void OOJSSetWarningOrErrorStackSkip

(

unsigned

skip

)

Definition at line 1156 of file OOJavaScriptEngine.m.

{
    sErrorHandlerStackSkip = skip;
}

References sErrorHandlerStackSkip.

Referenced by SpecialJSWarning().

Here is the caller graph for this function:

OOJSStrLiteralCachePRIVATE()

void OOJSStrLiteralCachePRIVATE	(	const char *	string,
		jsval *	strCache,
		BOOL *	inited )

Definition at line 1543 of file OOJavaScriptEngine.m.

{
    NSCParameterAssert(string != NULL && strCache != NULL && inited != NULL && !*inited);
    
    JSContext *context = OOJSAcquireContext();
    
    JSString *jsString = JS_InternString(context, string);
    if (EXPECT_NOT(string == NULL))
    {
        [NSException raise:NSGenericException format:@"Failed to initialize JavaScript string literal cache for \"%@\".", [[NSString stringWithUTF8String:string] escapedForJavaScriptLiteral]];
    }
    
    *strCache = STRING_TO_JSVAL(jsString);
    *inited = YES;
    
    OOJSRelinquishContext(context);
}

References EXPECT_NOT, OOJSAcquireContext(), and OOJSRelinquishContext().

Here is the call graph for this function:

OOJSUnconstructableConstruct()

JSBool OOJSUnconstructableConstruct	(	JSContext *	context,
		uintN	argc,
		jsval *	vp )

Definition at line 1987 of file OOJavaScriptEngine.m.

{
    OOJS_NATIVE_ENTER(context)
    
    JSFunction *function = JS_ValueToFunction(context, JS_CALLEE(context, vp));
    NSString *name = OOStringFromJSString(context, JS_GetFunctionId(function));
    
    OOJSReportError(context, @"%@ cannot be used as a constructor.", name);
    return NO;
    
    OOJS_NATIVE_EXIT
}

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

Referenced by InitOOJSClock(), InitOOJSConsole(), InitOOJSDock(), InitOOJSEntity(), InitOOJSEquipmentInfo(), InitOOJSExhaustPlume(), InitOOJSFlasher(), InitOOJSManifest(), InitOOJSMission(), InitOOJSOolite(), InitOOJSPlanet(), InitOOJSPlayer(), InitOOJSPlayerShip(), InitOOJSScript(), InitOOJSShip(), InitOOJSSound(), InitOOJSStation(), InitOOJSSun(), InitOOJSSystem(), InitOOJSSystemInfo(), InitOOJSVisualEffect(), InitOOJSWaypoint(), and InitOOJSWormhole().

Here is the call graph for this function:

Here is the caller graph for this function:

OOJSUnreachable()

void OOJSUnreachable	(	const char *	function,
		const char *	file,
		unsigned	line )

Definition at line 1063 of file OOJavaScriptEngine.m.

{
    OOLog(@"fatal.unreachable", @"Supposedly unreachable statement reached in %s (%@:%u) -- terminating.", function, OOLogAbbreviatedFileName(file), line);
    abort();
}

References OOLog, and OOLogAbbreviatedFileName().

Here is the call graph for this function:

OOStringFromJSID()

NSString * OOStringFromJSID

(

jsid

propID

)

Definition at line 975 of file OOJavaScriptEngine.m.

{
    JSContext *context = OOJSAcquireContext();
    
    jsval       value;
    NSString    *result = nil;
    if (JS_IdToValue(context, propID, &value))
    {
        result = OOStringFromJSString(context, JS_ValueToString(context, value));
    }
    
    OOJSRelinquishContext(context);
    
    return result;
}

References nil, OOJSAcquireContext(), OOJSRelinquishContext(), and OOStringFromJSString().

Referenced by MissionVariablesSetProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

OOStringFromJSPropertyIDAndSpec()

NSString * OOStringFromJSPropertyIDAndSpec	(	JSContext *	context,
		jsid	propID,
		JSPropertySpec *	propertySpec )

Definition at line 1611 of file OOJavaScriptEngine.m.

{
    if (JSID_IS_STRING(propID))
    {
        return OOStringFromJSString(context, JSID_TO_STRING(propID));
    }
    else if (JSID_IS_INT(propID) && propertySpec != NULL)
    {
        int tinyid = JSID_TO_INT(propID);
        
        while (propertySpec->name != NULL)
        {
            if (propertySpec->tinyid == tinyid)  return [NSString stringWithUTF8String:propertySpec->name];
            propertySpec++;
        }
    }
    
    jsval value;
    if (!JS_IdToValue(context, propID, &value))  return @"unknown";
    return OOStringFromJSString(context, JS_ValueToString(context, value));
}

References OOStringFromJSString().

Referenced by OOJSReportBadPropertySelector(), OOJSReportBadPropertyValue(), and ShipSetProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

OOStringFromJSString()

NSString * OOStringFromJSString	(	JSContext *	context,
		JSString *	string )

Definition at line 1562 of file OOJavaScriptEngine.m.

{
    OOJS_PROFILE_ENTER
    
    if (EXPECT_NOT(string == NULL))  return nil;
    
    size_t length;
    const jschar *chars = JS_GetStringCharsAndLength(context, string, &length);
    
    if (EXPECT(chars != NULL))
    {
        return [NSString stringWithCharacters:chars length:length];
    }
    else
    {
        return nil;
    }
    
    OOJS_PROFILE_EXIT
}

References EXPECT, EXPECT_NOT, nil, OOJS_PROFILE_ENTER, and OOJS_PROFILE_EXIT.

Referenced by ConsoleSettingsDeleteProperty(), ConsoleSettingsGetProperty(), ConsoleSettingsSetProperty(), KeyForPropertyID(), ManifestGetProperty(), ManifestSetProperty(), OOJSDictionaryFromJSObject(), OOJSDictionaryFromStringTable(), OOJSDumpStack(), OOJSUnconstructableConstruct(), OOStringFromJSID(), OOStringFromJSPropertyIDAndSpec(), OOStringFromJSValueEvenIfNull(), SystemInfoGetProperty(), SystemInfoSetProperty(), and WorldScriptsGetProperty().

Here is the caller graph for this function:

OOStringFromJSValue()

NSString * OOStringFromJSValue	(	JSContext *	context,
		jsval	value )

Definition at line 1597 of file OOJavaScriptEngine.m.

{
    OOJS_PROFILE_ENTER
    
    if (EXPECT(!JSVAL_IS_NULL(value) && !JSVAL_IS_VOID(value)))
    {
        return OOStringFromJSValueEvenIfNull(context, value);
    }
    return nil;
    
    OOJS_PROFILE_EXIT
}

References EXPECT, nil, OOJS_PROFILE_ENTER, OOJS_PROFILE_EXIT, and OOStringFromJSValueEvenIfNull().

Referenced by ConsoleConsoleMessage(), ConsoleDisplayMessagesInClass(), ConsoleIsExecutableJavaScript(), ConsoleSetDisplayMessagesInClass(), ConsoleSetProperty(), ConsoleSettingsSetProperty(), OOManifest::dealloc, FontMeasureString(), OOPlanetEntity(OOJavaScriptExtensions)::getJSClass:andPrototype:, OOWaypointEntity(OOJavaScriptExtensions)::getJSClass:andPrototype:, GetParameterString(), GlobalAutoAIForRole(), GlobalClearExtraGuiScreenKeys(), GlobalDisplayNameForCommodity(), GlobalExpandDescription(), GlobalExpandMissionText(), GlobalGetGuiColorSettingForKey(), GlobalGetScreenBackgroundForKey(), GlobalKeyBindingDescription(), GlobalLog(), GlobalSetExtraGuiScreenKeys(), GlobalSetGuiColorSettingForKey(), GlobalSetScreenBackgroundForKey(), GlobalTakeSnapShot(), JSStringConverter(), JSValueToEquipmentType(), ManifestComment(), ManifestSetComment(), ManifestShortComment(), MissionAddMessageText(), MissionRunScreen(), MissionSetInstructionsInternal(), MissionVariablesSetProperty(), OOEquipmentType(OOJavaScriptExtensions)::oo_clearJSSelf:, OOSound(OOJavaScriptExtentions)::oo_jsClassName, OOJSCallObjCObjectMethod(), OOJSNativeObjectFromJSValue(), OOJSObjectGetterImplPRIVATE(), OOStringFromDeciCredits(), PlayerAddMessageToArrivalReport(), PlayerAudioMessage(), PlayerCommsMessage(), PlayerConsoleMessage(), PlayerEndScenario(), PlayerReplaceShip(), PlayerSetPlayerRole(), PlayerSetProperty(), PlayerShipAddParcel(), PlayerShipAddPassenger(), PlayerShipAwardContract(), PlayerShipHideHUDSelector(), PlayerShipRemoveContract(), PlayerShipRemoveParcel(), PlayerShipRemovePassenger(), PlayerShipSetCustomHUDDial(), PlayerShipSetCustomView(), PlayerShipSetMultiFunctionDisplay(), PlayerShipSetMultiFunctionText(), PlayerShipSetPrimedEquipment(), PlayerShipSetProperty(), PlayerShipShowHUDSelector(), PlayerShipUseSpecialCargo(), ShipAdjustCargo(), ShipCanAwardEquipment(), ShipCommsMessage(), ShipDumpCargo(), ShipEjectItem(), ShipEjectSpecificItem(), ShipExitAI(), ShipGroupConstruct(), ShipHasEquipmentProviding(), ShipHasRole(), ShipReactToAIMessage(), ShipSendAIMessage(), ShipSetAI(), ShipSetBounty(), ShipSetCargo(), ShipSetCargoType(), ShipSetEquipmentStatus(), ShipSetProperty(), ShipSetScript(), ShipSpawn(), ShipStaticKeysForRole(), ShipStaticRoleIsInCategory(), ShipStaticSetShipDataForKey(), ShipStaticShipDataForKey(), ShipSwitchAI(), SoundFromJSValue(), SoundStaticLoad(), SoundStaticPlayMusic(), SpecialJSWarning(), StationLaunchShipWithRole(), StationSetInterface(), StationSetMarketPrice(), StationSetMarketQuantity(), StationSetProperty(), SystemAddMoon(), SystemAddPlanet(), SystemAddShipsOrGroup(), SystemAddShipsOrGroupToRoute(), SystemAddVisualEffect(), SystemCountShipsWithPrimaryRole(), SystemCountShipsWithRole(), SystemInfoRouteToSystem(), SystemInfoSamplePrice(), SystemInfoSetPropertyMethod(), SystemInfoStaticSetInterstellarProperty(), SystemLegacyAddShips(), SystemLegacyAddShipsAt(), SystemLegacyAddShipsAtPrecisely(), SystemLegacyAddShipsWithinRadius(), SystemLegacyAddSystemShips(), SystemLegacySpawnShip(), SystemLocationFromCode(), SystemSetPopulator(), SystemSetProperty(), SystemSetWaypoint(), SystemShipsWithPrimaryRole(), SystemShipsWithRole(), SystemStaticSystemIDForName(), VectorFromCoordinateSystem(), VectorToCoordinateSystem(), and VisualEffectSetProperty().

Here is the call graph for this function:

OOStringFromJSValueEvenIfNull()

NSString * OOStringFromJSValueEvenIfNull	(	JSContext *	context,
		jsval	value )

Definition at line 1584 of file OOJavaScriptEngine.m.

{
    OOJS_PROFILE_ENTER
    
    NSCParameterAssert(context != NULL && JS_IsInRequest(context));
    
    JSString *string = JS_ValueToString(context, value);    // Calls the value's toString method if needed.
    return OOStringFromJSString(context, string);
    
    OOJS_PROFILE_EXIT
}

References JS_IsInRequest, OOJS_PROFILE_ENTER, OOJS_PROFILE_EXIT, and OOStringFromJSString().

Referenced by DescribeValue(), DumpVariable(), GlobalLog(), MissionSetInstructionsInternal(), OOJSDictionaryFromStringTable(), OOStringFromJSValue(), ShipSetMaterialsInternal(), ShipSetShaders(), VisualEffectSetMaterialsInternal(), and VisualEffectSetShaders().

Here is the call graph for this function:

Here is the caller graph for this function:

ReportJSError()

static void ReportJSError ( JSContext * context, const char * message, JSErrorReport * report )

static

Definition at line 144 of file OOJavaScriptEngine.m.

{
    NSString            *severity = @"error";
    NSString            *messageText = nil;
    NSString            *lineBuf = nil;
    NSString            *messageClass = nil;
    NSString            *highlight = @"*****";
    NSString            *activeScript = nil;
    OOJavaScriptEngine  *jsEng = [OOJavaScriptEngine sharedEngine];
    BOOL                showLocation = [jsEng showErrorLocations];
    
    // Not OOJS_BEGIN_FULL_NATIVE() - we use JSAPI while paused.
    OOJSPauseTimeLimiter();
    
    jschar empty[1] = { 0 };
    JSErrorReport blankReport =
    {
        .filename = "<unspecified file>",
        .linebuf = "",
        .uclinebuf = empty,
        .uctokenptr = empty,
        .ucmessage = empty
    };
    if (EXPECT_NOT(report == NULL))  report = &blankReport;
    if (EXPECT_NOT(message == NULL || *message == '\0'))  message = "<unspecified error>";
    
    // Type of problem: error, warning or exception? (Strict flag wilfully ignored.)
    if (report->flags & JSREPORT_EXCEPTION) severity = @"exception";
    else if (report->flags & JSREPORT_WARNING)
    {
        severity = @"warning";
        highlight = @"-----";
    }
    
    // The error message itself
    messageText = [NSString stringWithUTF8String:message];
    
    // Get offending line, if present, and trim trailing line breaks
    lineBuf = [NSString stringWithUTF16String:report->uclinebuf];
    while ([lineBuf hasSuffix:@"\n"] || [lineBuf hasSuffix:@"\r"])  lineBuf = [lineBuf substringToIndex:[lineBuf length] - 1];
    
    // Get string for error number, for useful log message classes
    NSDictionary *errorNames = [ResourceManager dictionaryFromFilesNamed:@"javascript-errors.plist" inFolder:@"Config" andMerge:YES];
    NSString *errorNumberStr = [NSString stringWithFormat:@"%u", report->errorNumber];
    NSString *errorName = [errorNames oo_stringForKey:errorNumberStr];
    if (errorName == nil)  errorName = errorNumberStr;
    
    // Log message class
    messageClass = [NSString stringWithFormat:@"script.javaScript.%@.%@", severity, errorName];
    
    // Skip the rest if this is a warning being ignored.
    if ((report->flags & JSREPORT_WARNING) == 0 || OOLogWillDisplayMessagesInClass(messageClass))
    {
        // First line: problem description
        // avoid windows DEP exceptions!
        OOJSScript *thisScript = [[OOJSScript currentlyRunningScript] weakRetain];
        activeScript = [[thisScript weakRefUnderlyingObject] displayName];
        [thisScript release];
        
        if (activeScript == nil)  activeScript = @"<unidentified script>";
        OOLog(messageClass, @"%@ JavaScript %@ (%@): %@", highlight, severity, activeScript, messageText);
        
        if (showLocation && sErrorHandlerStackSkip == 0 && report->filename != NULL)
        {
            // Second line: where error occured, and line if provided. (The line is only provided for compile-time errors, not run-time errors.)
            if ([lineBuf length] != 0)
            {
                OOLog(messageClass, @"      %s, line %d: %@", report->filename, report->lineno, lineBuf);
            }
            else
            {
                OOLog(messageClass, @"      %s, line %d.", report->filename, report->lineno);
            }
        }
        
#ifndef NDEBUG
        BOOL dump;
        if (report->flags & JSREPORT_WARNING)  dump = [jsEng dumpStackForWarnings];
        else  dump = [jsEng dumpStackForErrors];
        if (dump)  OOJSDumpStack(context);
#endif
        
#if OOJSENGINE_MONITOR_SUPPORT
        JSExceptionState *exState = JS_SaveExceptionState(context);
        [[OOJavaScriptEngine sharedEngine] sendMonitorError:report
                                                withMessage:messageText
                                                  inContext:context];
        JS_RestoreExceptionState(context, exState);
#endif
    }
    
    OOJSResumeTimeLimiter();
}

References OOJSScript::currentlyRunningScript, ResourceManager::dictionaryFromFilesNamed:inFolder:andMerge:, OOJavaScriptEngine::dumpStackForErrors, OOJavaScriptEngine::dumpStackForWarnings, EXPECT_NOT, nil, OOJSDumpStack(), OOJSPauseTimeLimiter(), OOJSResumeTimeLimiter(), OOLog, OOLogWillDisplayMessagesInClass(), sErrorHandlerStackSkip, OOJavaScriptEngine::sharedEngine, OOJavaScriptEngine::showErrorLocations, and OOJSScript::weakRetain.

Here is the call graph for this function:

UnregisterObjectConverters()

static void UnregisterObjectConverters ( void )

static

Definition at line 2475 of file OOJavaScriptEngine.m.

{
    DESTROY(sObjectConverters);
}

References DESTROY, and sObjectConverters.

UnregisterSubclasses()

static void UnregisterSubclasses ( void )

static

Definition at line 2156 of file OOJavaScriptEngine.m.

{
    NSFreeMapTable(sRegisteredSubClasses);
    sRegisteredSubClasses = NULL;
}

References sRegisteredSubClasses.

Variable Documentation

gOOJSMainThreadContext

JSContext* gOOJSMainThreadContext = NULL

Definition at line 97 of file OOJavaScriptEngine.m.

Referenced by OOJSAcquireContext(), and OOJSRelinquishContext().

kOOJavaScriptEngineDidResetNotification

NSString* const kOOJavaScriptEngineDidResetNotification = @"org.aegidian.oolite OOJavaScriptEngine did reset"

Definition at line 101 of file OOJavaScriptEngine.m.

kOOJavaScriptEngineWillResetNotification

NSString* const kOOJavaScriptEngineWillResetNotification = @"org.aegidian.oolite OOJavaScriptEngine will reset"

Definition at line 100 of file OOJavaScriptEngine.m.

sConsoleEvalLineNo

NSUInteger sConsoleEvalLineNo

static

Definition at line 867 of file OOJavaScriptEngine.m.

Referenced by OOJSDescribeLocation(), and OOJSMarkConsoleEvalLocation().

sConsoleScriptName

const char* sConsoleScriptName

static

Definition at line 866 of file OOJavaScriptEngine.m.

Referenced by OOJSDescribeLocation(), and OOJSMarkConsoleEvalLocation().

sErrorHandlerStackSkip

unsigned sErrorHandlerStackSkip = 0

static

Definition at line 95 of file OOJavaScriptEngine.m.

Referenced by OOJSDumpStack(), OOJSSetWarningOrErrorStackSkip(), and ReportJSError().

sObjectConverters

NSMutableDictionary* sObjectConverters

static

Definition at line 2365 of file OOJavaScriptEngine.m.

Referenced by OOJSRegisterObjectConverter(), and UnregisterObjectConverters().

sRegisteredSubClasses

NSMapTable* sRegisteredSubClasses

static

Definition at line 2139 of file OOJavaScriptEngine.m.

Referenced by OOJSIsSubclass(), OOJSRegisterSubclass(), and UnregisterSubclasses().

sSharedEngine

OOJavaScriptEngine* sSharedEngine = nil

static

Definition at line 94 of file OOJavaScriptEngine.m.