import "OOCocoa.h"
import "Universe.h"
import "PlayerEntity.h"
import "PlayerEntityLegacyScriptEngine.h"
#include <jsapi.h>
import "OOJSPropID.h"
import "OOJSEngineNativeWrappers.h"

Include dependency graph for OOJavaScriptEngine.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	OOJavaScriptEngine

category	NSObject(OOJavaScript)

class	OOJSValue

category	NSString(OOJavaScriptExtensions)

struct	JSFunctionPredicateParameter

Macros
#define	OOJSENGINE_MONITOR_SUPPORT OOLITE_DEBUG

#define	JS_IsInRequest(context) (((void)(context)), YES)

#define	JS_BeginRequest(context) do {} while (0)

#define	JS_EndRequest(context) do {} while (0)

#define	OOJSSTR(str) ({ static jsval strCache; static BOOL inited; if (EXPECT_NOT(!inited)) OOJSStrLiteralCachePRIVATE(""str, &strCache, &inited); strCache; })

#define	DEFINE_JS_OBJECT_GETTER(NAME, JSCLASS, JSPROTO, OBJCCLASSNAME)

#define	OOJSAddGCValueRoot(context, root, name) JS_AddNamedValueRoot((context), (root), "" name)

#define	OOJSAddGCStringRoot(context, root, name) JS_AddNamedStringRoot((context), (root), "" name)

#define	OOJSAddGCObjectRoot(context, root, name) JS_AddNamedObjectRoot((context), (root), "" name)

#define	OOJSAddGCThingRoot(context, root, name) JS_AddNamedGCThingRoot((context), (root), "" name)

#define	OOJS_PROP_READWRITE (JSPROP_PERMANENT \| JSPROP_ENUMERATE)

#define	OOJS_PROP_READONLY (JSPROP_PERMANENT \| JSPROP_ENUMERATE \| JSPROP_READONLY)

#define	OOJS_PROP_HIDDEN_READWRITE (JSPROP_PERMANENT)

#define	OOJS_PROP_HIDDEN_READONLY (JSPROP_PERMANENT \| JSPROP_READONLY)

#define	OOJS_METHOD_READONLY OOJS_PROP_HIDDEN_READONLY

#define	OOJS_PROP_READWRITE_CB (OOJS_PROP_READWRITE \| JSPROP_SHARED)

#define	OOJS_PROP_READONLY_CB (OOJS_PROP_READONLY \| JSPROP_SHARED)

#define	OOJS_PROP_HIDDEN_READWRITE_CB (OOJS_PROP_HIDDEN_READWRITE \| JSPROP_SHARED)

#define	OOJS_PROP_HIDDEN_READONLY_CB (OOJS_PROP_HIDDEN_READONLY \| JSPROP_SHARED)

#define	OOJS_THIS JS_THIS_OBJECT(context, vp)

#define	OOJS_ARGV JS_ARGV(context, vp)

#define	OOJS_RVAL JS_RVAL(context, vp)

#define	OOJS_SET_RVAL(v) JS_SET_RVAL(context, vp, v)

#define	OOJS_RETURN(v) do { OOJS_SET_RVAL(v); return YES; } while (0)

#define	OOJS_RETURN_JSOBJECT(o) OOJS_RETURN(OBJECT_TO_JSVAL(o))

#define	OOJS_RETURN_VOID OOJS_RETURN(JSVAL_VOID)

#define	OOJS_RETURN_NULL OOJS_RETURN(JSVAL_NULL)

#define	OOJS_RETURN_BOOL(v) OOJS_RETURN(OOJSValueFromBOOL(v))

#define	OOJS_RETURN_INT(v) OOJS_RETURN(INT_TO_JSVAL(v))

#define	OOJS_RETURN_OBJECT(o) OOJS_RETURN(OOJSValueFromNativeObject(context, o))

#define	OOJS_RETURN_WITH_HELPER(helper, value)

#define	OOJS_RETURN_VECTOR(value) OOJS_RETURN_WITH_HELPER(VectorToJSValue, value)

#define	OOJS_RETURN_HPVECTOR(value) OOJS_RETURN_WITH_HELPER(HPVectorToJSValue, value)

#define	OOJS_RETURN_QUATERNION(value) OOJS_RETURN_WITH_HELPER(QuaternionToJSValue, value)

#define	OOJS_RETURN_DOUBLE(value) OOJS_RETURN_WITH_HELPER(JS_NewNumberValue, value)

Typedefs
typedef id(*	OOJSClassConverterCallback) (JSContext context, JSObject object)

Functions
OOINLINE JSContext *	OOJSAcquireContext (void)

OOINLINE void	OOJSRelinquishContext (JSContext *context)

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

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

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

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

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

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

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)

OOINLINE jsval	OOJSValueFromBOOL (int b) INLINE_CONST_FUNC

OOINLINE jsval	OOJSValueFromNativeObject (JSContext *context, id object)

JSObject *	OOJSObjectFromNativeObject (JSContext *context, id object)

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

NSString *	OOStringFromJSString (JSContext context, JSString string)

NSString *	OOStringFromJSValue (JSContext *context, jsval value)

NSString *	OOStringFromJSValueEvenIfNull (JSContext *context, jsval value)

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

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

NSString *	OOStringFromJSID (jsid propID)

jsid	OOJSIDFromString (NSString *string)

BOOL	JSFunctionPredicate (Entity entity, void parameter)

BOOL	JSEntityIsJavaScriptVisiblePredicate (Entity entity, void parameter)

BOOL	JSEntityIsJavaScriptSearchablePredicate (Entity entity, void parameter)

BOOL	JSEntityIsDemoShipPredicate (Entity entity, void parameter)

id	OOJSNativeObjectFromJSValue (JSContext *context, jsval value)

id	OOJSNativeObjectFromJSObject (JSContext context, JSObject object)

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

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

OOINLINE JSClass *	OOJSGetClass (JSContext cx, JSObject obj) ALWAYS_INLINE_FUNC

OOINLINE BOOL	OOJSValueIsFunction (JSContext *context, jsval value)

OOINLINE BOOL	OOJSValueIsArray (JSContext *context, jsval value)

NSDictionary *	OOJSDictionaryFromJSValue (JSContext *context, jsval value)

NSDictionary *	OOJSDictionaryFromJSObject (JSContext context, JSObject object)

NSDictionary *	OOJSDictionaryFromStringTable (JSContext *context, jsval value)

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

void	OOJSRegisterSubclass (JSClass subclass, JSClass superclass)

BOOL	OOJSIsSubclass (JSClass putativeSubclass, JSClass superclass)

OOINLINE BOOL	OOJSIsMemberOfSubclass (JSContext context, JSObject object, JSClass *superclass)

id	OOJSBasicPrivateObjectConverter (JSContext context, JSObject object)

void	OOJSRegisterObjectConverter (JSClass *theClass, OOJSClassConverterCallback converter)

void	OOJSPauseTimeLimiter (void)

void	OOJSResumeTimeLimiter (void)

void	OOJSDumpStack (JSContext *context)

NSString *	OOJSDescribeLocation (JSContext context, JSStackFrame stackFrame)

void	OOJSMarkConsoleEvalLocation (JSContext context, JSStackFrame stackFrame)

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

void	OOJSObjectWrapperFinalize (JSContext context, JSObject this)

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

Variables
NSString *const	kOOJavaScriptEngineWillResetNotification

NSString *const	kOOJavaScriptEngineDidResetNotification

Macro Definition Documentation

◆ DEFINE_JS_OBJECT_GETTER

#define DEFINE_JS_OBJECT_GETTER	(	NAME,
		JSCLASS,
		JSPROTO,
		OBJCCLASSNAME
	)

Value:

static BOOL NAME(JSContext *context, JSObject *inObject, OBJCCLASSNAME **outObject)  GCC_ATTR((unused)); \
static BOOL NAME(JSContext *context, JSObject *inObject, OBJCCLASSNAME **outObject) \
{ \
    NSCParameterAssert(outObject != NULL); \
    static Class cls = Nil; \
    if (EXPECT_NOT(cls == Nil))  cls = [OBJCCLASSNAME class]; \
    return OOJSObjectGetterImplPRIVATE(context, inObject, JSCLASS, cls, #NAME, (id *)outObject); \
}

Definition at line 448 of file OOJavaScriptEngine.h.

{ \
    NSCParameterAssert(outObject != NULL); \
    static Class cls = Nil; \
    if (EXPECT_NOT(cls == Nil))  cls = [OBJCCLASSNAME class]; \
    return OOJSObjectGetterImplPRIVATE(context, inObject, JSCLASS, cls, #NAME, (id *)outObject); \
}

◆ JS_BeginRequest

#define JS_BeginRequest ( context ) do {} while (0)

Definition at line 112 of file OOJavaScriptEngine.h.

◆ JS_EndRequest

#define JS_EndRequest ( context ) do {} while (0)

Definition at line 113 of file OOJavaScriptEngine.h.

◆ JS_IsInRequest

#define JS_IsInRequest ( context ) (((void)(context)), YES)

Definition at line 111 of file OOJavaScriptEngine.h.

◆ OOJS_ARGV

#define OOJS_ARGV JS_ARGV(context, vp)

Definition at line 661 of file OOJavaScriptEngine.h.

◆ OOJS_METHOD_READONLY

#define OOJS_METHOD_READONLY OOJS_PROP_HIDDEN_READONLY

Definition at line 647 of file OOJavaScriptEngine.h.

◆ OOJS_PROP_HIDDEN_READONLY

#define OOJS_PROP_HIDDEN_READONLY (JSPROP_PERMANENT | JSPROP_READONLY)

Definition at line 644 of file OOJavaScriptEngine.h.

◆ OOJS_PROP_HIDDEN_READONLY_CB

#define OOJS_PROP_HIDDEN_READONLY_CB (OOJS_PROP_HIDDEN_READONLY | JSPROP_SHARED)

Definition at line 654 of file OOJavaScriptEngine.h.

◆ OOJS_PROP_HIDDEN_READWRITE

#define OOJS_PROP_HIDDEN_READWRITE (JSPROP_PERMANENT)

Definition at line 643 of file OOJavaScriptEngine.h.

◆ OOJS_PROP_HIDDEN_READWRITE_CB

#define OOJS_PROP_HIDDEN_READWRITE_CB (OOJS_PROP_HIDDEN_READWRITE | JSPROP_SHARED)

Definition at line 653 of file OOJavaScriptEngine.h.

◆ OOJS_PROP_READONLY

#define OOJS_PROP_READONLY (JSPROP_PERMANENT | JSPROP_ENUMERATE | JSPROP_READONLY)

Definition at line 640 of file OOJavaScriptEngine.h.

◆ OOJS_PROP_READONLY_CB

#define OOJS_PROP_READONLY_CB (OOJS_PROP_READONLY | JSPROP_SHARED)

Definition at line 651 of file OOJavaScriptEngine.h.

◆ OOJS_PROP_READWRITE

#define OOJS_PROP_READWRITE (JSPROP_PERMANENT | JSPROP_ENUMERATE)

Definition at line 639 of file OOJavaScriptEngine.h.

◆ OOJS_PROP_READWRITE_CB

#define OOJS_PROP_READWRITE_CB (OOJS_PROP_READWRITE | JSPROP_SHARED)

Definition at line 650 of file OOJavaScriptEngine.h.

◆ OOJS_RETURN

#define OOJS_RETURN ( v ) do { OOJS_SET_RVAL(v); return YES; } while (0)

Definition at line 665 of file OOJavaScriptEngine.h.

◆ OOJS_RETURN_BOOL

#define OOJS_RETURN_BOOL ( v ) OOJS_RETURN(OOJSValueFromBOOL(v))

Definition at line 669 of file OOJavaScriptEngine.h.

◆ OOJS_RETURN_DOUBLE

#define OOJS_RETURN_DOUBLE ( value ) OOJS_RETURN_WITH_HELPER(JS_NewNumberValue, value)

Definition at line 683 of file OOJavaScriptEngine.h.

◆ OOJS_RETURN_HPVECTOR

#define OOJS_RETURN_HPVECTOR ( value ) OOJS_RETURN_WITH_HELPER(HPVectorToJSValue, value)

Definition at line 681 of file OOJavaScriptEngine.h.

◆ OOJS_RETURN_INT

#define OOJS_RETURN_INT ( v ) OOJS_RETURN(INT_TO_JSVAL(v))

Definition at line 670 of file OOJavaScriptEngine.h.

◆ OOJS_RETURN_JSOBJECT

#define OOJS_RETURN_JSOBJECT ( o ) OOJS_RETURN(OBJECT_TO_JSVAL(o))

Definition at line 666 of file OOJavaScriptEngine.h.

◆ OOJS_RETURN_NULL

#define OOJS_RETURN_NULL OOJS_RETURN(JSVAL_NULL)

Definition at line 668 of file OOJavaScriptEngine.h.

◆ OOJS_RETURN_OBJECT

#define OOJS_RETURN_OBJECT ( o ) OOJS_RETURN(OOJSValueFromNativeObject(context, o))

Definition at line 671 of file OOJavaScriptEngine.h.

◆ OOJS_RETURN_QUATERNION

#define OOJS_RETURN_QUATERNION ( value ) OOJS_RETURN_WITH_HELPER(QuaternionToJSValue, value)

Definition at line 682 of file OOJavaScriptEngine.h.

◆ OOJS_RETURN_VECTOR

#define OOJS_RETURN_VECTOR ( value ) OOJS_RETURN_WITH_HELPER(VectorToJSValue, value)

Definition at line 680 of file OOJavaScriptEngine.h.

◆ OOJS_RETURN_VOID

#define OOJS_RETURN_VOID OOJS_RETURN(JSVAL_VOID)

Definition at line 667 of file OOJavaScriptEngine.h.

◆ OOJS_RETURN_WITH_HELPER

#define OOJS_RETURN_WITH_HELPER	(	helper,
		value
	)

Value:

do { \
    jsval jsresult; \
    BOOL OK = helper(context, value, &jsresult); \
    JS_SET_RVAL(context, vp, jsresult); return OK; \
} while (0)

Definition at line 673 of file OOJavaScriptEngine.h.

   { \
    jsval jsresult; \
    BOOL OK = helper(context, value, &jsresult); \
    JS_SET_RVAL(context, vp, jsresult); return OK; \
} while (0)

◆ OOJS_RVAL

#define OOJS_RVAL JS_RVAL(context, vp)

Definition at line 662 of file OOJavaScriptEngine.h.

◆ OOJS_SET_RVAL

#define OOJS_SET_RVAL ( v ) JS_SET_RVAL(context, vp, v)

Definition at line 663 of file OOJavaScriptEngine.h.

◆ OOJS_THIS

#define OOJS_THIS JS_THIS_OBJECT(context, vp)

Definition at line 660 of file OOJavaScriptEngine.h.

◆ OOJSAddGCObjectRoot

#define OOJSAddGCObjectRoot	(	context,
		root,
		name
	)	JS_AddNamedObjectRoot((context), (root), "" name)

Definition at line 535 of file OOJavaScriptEngine.h.

◆ OOJSAddGCStringRoot

#define OOJSAddGCStringRoot	(	context,
		root,
		name
	)	JS_AddNamedStringRoot((context), (root), "" name)

Definition at line 534 of file OOJavaScriptEngine.h.

◆ OOJSAddGCThingRoot

#define OOJSAddGCThingRoot	(	context,
		root,
		name
	)	JS_AddNamedGCThingRoot((context), (root), "" name)

Definition at line 536 of file OOJavaScriptEngine.h.

◆ OOJSAddGCValueRoot

#define OOJSAddGCValueRoot	(	context,
		root,
		name
	)	JS_AddNamedValueRoot((context), (root), "" name)

Definition at line 533 of file OOJavaScriptEngine.h.

◆ OOJSENGINE_MONITOR_SUPPORT

#define OOJSENGINE_MONITOR_SUPPORT OOLITE_DEBUG

Definition at line 33 of file OOJavaScriptEngine.h.

◆ OOJSSTR

#define OOJSSTR ( str ) ({ static jsval strCache; static BOOL inited; if (EXPECT_NOT(!inited)) OOJSStrLiteralCachePRIVATE(""str, &strCache, &inited); strCache; })

Definition at line 283 of file OOJavaScriptEngine.h.

Typedef Documentation

◆ OOJSClassConverterCallback

typedef id(* OOJSClassConverterCallback) (JSContext *context, JSObject *object)

Definition at line 512 of file OOJavaScriptEngine.h.

Function Documentation

◆ JSEntityIsDemoShipPredicate()

BOOL JSEntityIsDemoShipPredicate	(	Entity *	entity,
		void *	parameter
	)

Definition at line 2133 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 2099 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 2089 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 2046 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:

◆ OOJSAcquireContext()

OOINLINE JSContext * OOJSAcquireContext ( void )

Definition at line 118 of file OOJavaScriptEngine.h.

{
    extern JSContext *gOOJSMainThreadContext;
    NSCAssert(gOOJSMainThreadContext != NULL, @"Attempt to use JavaScript context before JavaScript engine is initialized.");
    JS_BeginRequest(gOOJSMainThreadContext);
    return gOOJSMainThreadContext;
}

References gOOJSMainThreadContext, and JS_BeginRequest.

Referenced by JSValueToStrDbg(), MissionRunCallback(), OOJSFrameCallbacksInvoke(), OOJSFrameCallbacksRemoveAll(), OOJSIDFromString(), OOJSInitJSIDCachePRIVATE(), OOJSStrLiteralCachePRIVATE(), OOStringFromDeciCredits(), OOStringFromJSID(), and SyntaxIssue().

Here is the caller 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 2440 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:@"%@:%llu", 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 1735 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 2246 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 2231 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	value
	)

Definition at line 2306 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:

◆ OOJSGetClass()

OOINLINE JSClass * OOJSGetClass	(	JSContext *	cx,
		JSObject *	obj
	)

Definition at line 367 of file OOJavaScriptEngine.h.

{
#if JS_THREADSAFE
    return JS_GetClass(cx, obj);
#else
    return JS_GetClass(obj);
#endif
}

Referenced by DescribeValue(), JSIDToStrSafeDbg(), JSValueTypeDbg(), OOJSIsMemberOfSubclass(), OOJSNativeObjectFromJSObject(), OOJSObjectGetterImplPRIVATE(), OOJSObjectWrapperToString(), OOJSReportBadPropertySelector(), and OOJSReportBadPropertyValue().

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:

◆ OOJSIsMemberOfSubclass()

OOINLINE BOOL OOJSIsMemberOfSubclass	(	JSContext *	context,
		JSObject *	object,
		JSClass *	superclass
	)

Definition at line 494 of file OOJavaScriptEngine.h.

{
    return OOJSIsSubclass(OOJSGetClass(context, object), superclass);
}

References OOJSGetClass(), and OOJSIsSubclass().

Referenced by JSObjectGetQuaternion(), and JSObjectGetVector().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OOJSIsSubclass()

BOOL OOJSIsSubclass	(	JSClass *	putativeSubclass,
		JSClass *	superclass
	)

Definition at line 2162 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 *	object
	)

Definition at line 2399 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 2367 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 2432 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 2424 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 1441 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 2179 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 2000 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 2016 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:

◆ OOJSPauseTimeLimiter()

void OOJSPauseTimeLimiter ( void )

Definition at line 133 of file OOJSEngineTimeManagement.m.

{
    if (sLimiterPauseDepth++ == 0)
    {
        OODisposeHighResTime(sLimiterPauseStart);
        sLimiterPauseStart = OOGetHighResTime();
    }
}

References OODisposeHighResTime, OOGetHighResTime, sLimiterPauseDepth, and sLimiterPauseStart.

Referenced by NSString(OOJavaScriptExtensions)::concatenationOfStringsFromJavaScriptValues:count:separator:inContext:, ConsoleConsoleMessage(), ConsoleIsExecutableJavaScript(), ConsoleSettingsSetProperty(), OOPlanetEntity(OOJavaScriptExtensions)::getJSClass:andPrototype:, JSFunctionPredicate(), MissionRunScreen(), ReportJSError(), SoundFromJSValue(), SystemFilteredEntities(), and SystemInfoStaticFilteredSystems().

Here is the caller graph for this function:

◆ OOJSRegisterObjectConverter()

void OOJSRegisterObjectConverter	(	JSClass *	theClass,
		OOJSClassConverterCallback	converter
	)

Definition at line 2453 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 2140 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:

◆ OOJSRelinquishContext()

OOINLINE void OOJSRelinquishContext ( JSContext * context )

Definition at line 128 of file OOJavaScriptEngine.h.

{
#ifndef NDEBUG
    extern JSContext *gOOJSMainThreadContext;
    NSCParameterAssert(context == gOOJSMainThreadContext && JS_IsInRequest(context));
#endif
    JS_EndRequest(context);
}

References gOOJSMainThreadContext, JS_EndRequest, and JS_IsInRequest.

Referenced by JSValueToStrDbg(), MissionRunCallback(), OOJSFrameCallbacksInvoke(), OOJSFrameCallbacksRemoveAll(), OOJSIDFromString(), OOJSInitJSIDCachePRIVATE(), OOJSStrLiteralCachePRIVATE(), OOStringFromDeciCredits(), OOStringFromJSID(), and SyntaxIssue().

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(), OoliteSetProperty(), 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(), OoliteSetProperty(), 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(), OoliteSetProperty(), 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:

◆ OOJSResumeTimeLimiter()

void OOJSResumeTimeLimiter ( void )

Definition at line 143 of file OOJSEngineTimeManagement.m.

{
    if (--sLimiterPauseDepth == 0)
        
    {
        OOHighResTimeValue now = OOGetHighResTime();
        OOTimeDelta elapsed = OOHighResTimeDeltaInSeconds(sLimiterPauseStart, now);
        OODisposeHighResTime(now);
        
        sLimiterTimeLimit += elapsed;
    }
}

References OODisposeHighResTime, OOGetHighResTime, OOHighResTimeDeltaInSeconds(), sLimiterPauseDepth, sLimiterPauseStart, and sLimiterTimeLimit.

Referenced by NSString(OOJavaScriptExtensions)::concatenationOfStringsFromJavaScriptValues:count:separator:inContext:, ConsoleConsoleMessage(), ConsoleIsExecutableJavaScript(), ConsoleSettingsSetProperty(), OOPlanetEntity(OOJavaScriptExtensions)::getJSClass:andPrototype:, JSFunctionPredicate(), MissionRunScreen(), ReportJSError(), SoundFromJSValue(), SystemFilteredEntities(), and SystemInfoStaticFilteredSystems().

Here is the call graph for this function:

Here is the caller 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 1542 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 1986 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:

◆ OOJSValueFromBOOL()

OOINLINE jsval OOJSValueFromBOOL ( int b )

Definition at line 189 of file OOJavaScriptEngine.h.

{
    return BOOLEAN_TO_JSVAL(b != NO);
}

Referenced by ClockGetProperty(), ConsoleGetProperty(), DockGetProperty(), EntityGetProperty(), EquipmentInfoGetProperty(), FlasherGetProperty(), OOStringFromDeciCredits(), PlanetGetProperty(), PlayerGetProperty(), PlayerShipGetProperty(), ShipGetProperty(), SoundSourceGetProperty(), StationGetProperty(), SunGetProperty(), SystemGetProperty(), TimerGetProperty(), and VisualEffectGetProperty().

Here is the caller graph for this function:

◆ OOJSValueFromNativeObject()

OOINLINE jsval OOJSValueFromNativeObject	(	JSContext *	context,
		id	object
	)

Definition at line 238 of file OOJavaScriptEngine.h.

{
    if (object != nil)  return [object oo_jsValueInContext:context];
    return  JSVAL_NULL;
}

References nil.

Referenced by ClockGetProperty(), ConsoleGetProperty(), EntityGetProperty(), EquipmentInfoGetAllEqipment(), EquipmentInfoGetProperty(), ExhaustPlumeGetProperty(), FlasherGetProperty(), GetJSSystemInfoForSystem(), ManifestGetProperty(), MissionGetProperty(), MissionRunCallback(), MissionRunScreen(), MissionVariablesGetProperty(), OOJSObjectFromNativeObject(), OoliteGetProperty(), PlanetGetProperty(), PlayerGetProperty(), PlayerShipGetProperty(), RunDeferredOperations(), ShipGetProperty(), ShipGroupGetProperty(), SoundGetProperty(), SoundSourceGetProperty(), StationGetProperty(), SunGetProperty(), SystemGetProperty(), SystemInfoStaticFilteredSystems(), VisualEffectGetProperty(), WaypointGetProperty(), and WormholeGetProperty().

Here is the caller graph for this function:

◆ OOJSValueIsArray()

OOINLINE BOOL OOJSValueIsArray	(	JSContext *	context,
		jsval	value
	)

Definition at line 397 of file OOJavaScriptEngine.h.

{
    return JSVAL_IS_OBJECT(value) && !JSVAL_IS_NULL(value) && JS_IsArrayObject(context, JSVAL_TO_OBJECT(value));
}

◆ OOJSValueIsFunction()

OOINLINE BOOL OOJSValueIsFunction	(	JSContext *	context,
		jsval	value
	)

Definition at line 383 of file OOJavaScriptEngine.h.

{
    return JSVAL_IS_OBJECT(value) && !JSVAL_IS_NULL(value) && JS_ObjectIsFunction(context, JSVAL_TO_OBJECT(value));
}

Referenced by DescribeValue(), GlobalAddFrameCallback(), GlobalSetExtraGuiScreenKeys(), JSFunctionPredicate(), MissionRunScreen(), StationSetInterface(), SystemFilteredEntities(), and SystemInfoStaticFilteredSystems().

Here is the caller 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 1610 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 1561 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 1596 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(), OoliteSetProperty(), 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 1583 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:

Variable Documentation

◆ kOOJavaScriptEngineDidResetNotification

NSString* const kOOJavaScriptEngineDidResetNotification

extern

Definition at line 101 of file OOJavaScriptEngine.m.

◆ kOOJavaScriptEngineWillResetNotification

NSString* const kOOJavaScriptEngineWillResetNotification

extern

Definition at line 100 of file OOJavaScriptEngine.m.

Classes

Macros

Typedefs

Functions

Variables

Macro Definition Documentation

◆ DEFINE_JS_OBJECT_GETTER

◆ JS_BeginRequest

◆ JS_EndRequest

◆ JS_IsInRequest

◆ OOJS_ARGV

◆ OOJS_METHOD_READONLY

◆ OOJS_PROP_HIDDEN_READONLY

◆ OOJS_PROP_HIDDEN_READONLY_CB

◆ OOJS_PROP_HIDDEN_READWRITE

◆ OOJS_PROP_HIDDEN_READWRITE_CB

◆ OOJS_PROP_READONLY

◆ OOJS_PROP_READONLY_CB

◆ OOJS_PROP_READWRITE

◆ OOJS_PROP_READWRITE_CB

◆ OOJS_RETURN

◆ OOJS_RETURN_BOOL

◆ OOJS_RETURN_DOUBLE

◆ OOJS_RETURN_HPVECTOR

◆ OOJS_RETURN_INT

◆ OOJS_RETURN_JSOBJECT

◆ OOJS_RETURN_NULL

◆ OOJS_RETURN_OBJECT

◆ OOJS_RETURN_QUATERNION

◆ OOJS_RETURN_VECTOR

◆ OOJS_RETURN_VOID

◆ OOJS_RETURN_WITH_HELPER

◆ OOJS_RVAL

◆ OOJS_SET_RVAL

◆ OOJS_THIS

◆ OOJSAddGCObjectRoot

◆ OOJSAddGCStringRoot

◆ OOJSAddGCThingRoot

◆ OOJSAddGCValueRoot

◆ OOJSENGINE_MONITOR_SUPPORT

◆ OOJSSTR

Typedef Documentation

◆ OOJSClassConverterCallback

Function Documentation

◆ JSEntityIsDemoShipPredicate()

◆ JSEntityIsJavaScriptSearchablePredicate()

◆ JSEntityIsJavaScriptVisiblePredicate()

◆ JSFunctionPredicate()

◆ OOJSAcquireContext()

◆ OOJSArgumentListGetNumber()

◆ OOJSArgumentListGetNumberNoError()

◆ OOJSBasicPrivateObjectConverter()

◆ OOJSDescribeLocation()

◆ OOJSDescribeValue()

◆ OOJSDictionaryFromJSObject()

◆ OOJSDictionaryFromJSValue()

◆ OOJSDictionaryFromStringTable()

◆ OOJSDumpStack()

◆ OOJSGetClass()

◆ OOJSIDFromString()

◆ OOJSIsMemberOfSubclass()

◆ OOJSIsSubclass()

◆ OOJSMarkConsoleEvalLocation()

◆ OOJSNativeObjectFromJSObject()

◆ OOJSNativeObjectFromJSValue()

◆ OOJSNativeObjectOfClassFromJSObject()

◆ OOJSNativeObjectOfClassFromJSValue()

◆ OOJSObjectFromNativeObject()

◆ OOJSObjectGetterImplPRIVATE()

◆ OOJSObjectWrapperFinalize()

◆ OOJSObjectWrapperToString()

◆ OOJSPauseTimeLimiter()

◆ OOJSRegisterObjectConverter()

◆ OOJSRegisterSubclass()

◆ OOJSRelinquishContext()

◆ OOJSReportBadArguments()

◆ OOJSReportBadPropertySelector()

◆ OOJSReportBadPropertyValue()

◆ OOJSReportError()

◆ OOJSReportErrorForCaller()