Mac Dev Center Mac OS X Reference Library Networking, Internet, & Web JavaScriptCore Framework Reference

Overview

Use the links in the table of contents to the left to access the documentation.

Functions

JSCheckScriptSyntax

Checks for syntax errors in a string of JavaScript.

JSEvaluateScript

Evaluates a string of JavaScript.

JSGarbageCollect

Performs a JavaScript garbage collection.

Checks for syntax errors in a string of JavaScript.

JS_EXPORT bool JSCheckScriptSyntax(
    JSContextRef ctx,
    JSStringRef script,
    JSStringRef sourceURL,
    int startingLineNumber,
    JSValueRef *exception);  

Parameters

Return Value

true if the script is syntactically correct, otherwise false.

Evaluates a string of JavaScript.

JS_EXPORT JSValueRef JSEvaluateScript(
    JSContextRef ctx,
    JSStringRef script,
    JSObjectRef thisObject,
    JSStringRef sourceURL,
    int startingLineNumber,
    JSValueRef *exception);  

Parameters

Return Value

The JSValue that results from evaluating script, or NULL if an exception is thrown.

Performs a JavaScript garbage collection.

JS_EXPORT void JSGarbageCollect(
    JSContextRef ctx);  

Parameters

Discussion

JavaScript values that are on the machine stack, in a register, protected by JSValueProtect, set as the global object of an execution context, or reachable from any such value will not be collected.

During JavaScript execution, you are not required to call this function; the JavaScript engine will garbage collect as needed. JavaScript values created within a context group are automatically destroyed when the last reference to the context group is released.

Typedefs

JSClassRef

JSContextGroupRef

JSContextRef

JSGlobalContextRef

JSObjectRef

JSPropertyNameAccumulatorRef

JSPropertyNameArrayRef

JSStringRef

JSValueRef

typedef struct OpaqueJSClass* JSClassRef;  

Discussion

A JavaScript class. Used with JSObjectMake to construct objects with custom behavior.

typedef const struct OpaqueJSContextGroup* JSContextGroupRef;  

Discussion

A group that associates JavaScript contexts with one another. Contexts in the same group may share and exchange JavaScript objects.

typedef const struct OpaqueJSContext* JSContextRef;  

Discussion

A JavaScript execution context. Holds the global object and other execution state.

typedef struct OpaqueJSContext* JSGlobalContextRef;  

Discussion

A global JavaScript execution context. A JSGlobalContext is a JSContext.

typedef struct OpaqueJSValue* JSObjectRef;  

Discussion

A JavaScript object. A JSObject is a JSValue.

typedef struct OpaqueJSPropertyNameAccumulator* JSPropertyNameAccumulatorRef;  

Discussion

An ordered set used to collect the names of a JavaScript object's properties.

typedef struct OpaqueJSPropertyNameArray* JSPropertyNameArrayRef;  

Discussion

An array of JavaScript property names.

typedef struct OpaqueJSString* JSStringRef;  

Discussion

A UTF16 character buffer. The fundamental string representation in JavaScript.

typedef const struct OpaqueJSValue* JSValueRef;  

Discussion

A JavaScript value. The base type for all JavaScript values, and polymorphic functions on them.