Crate objc2_javascript_core

Bindings to the JavaScriptCore framework

See Apple’s docs and the general docs on framework crates for more information.

Structs

JSClassDefinitionJSBase and JSObjectRef and JSValueRef

This structure contains properties and callbacks that define a type of object. All fields other than the version field are optional. Any pointer may be NULL. Field: version The version number of this structure. The current version is 0. Field: attributes A logically ORed set of JSClassAttributes to give to the class. Field: className A null-terminated UTF8 string containing the class’s name. Field: parentClass A JSClass to set as the class’s parent class. Pass NULL use the default object class. Field: staticValues A JSStaticValue array containing the class’s statically declared value properties. Pass NULL to specify no statically declared value properties. The array must be terminated by a JSStaticValue whose name field is NULL. Field: staticFunctions A JSStaticFunction array containing the class’s statically declared function properties. Pass NULL to specify no statically declared function properties. The array must be terminated by a JSStaticFunction whose name field is NULL. Field: initialize The callback invoked when an object is first created. Use this callback to initialize the object. Field: finalize The callback invoked when an object is finalized (prepared for garbage collection). Use this callback to release resources allocated for the object, and perform other cleanup. Field: hasProperty The callback invoked when determining whether an object has a property. If this field is NULL, getProperty is called instead. The hasProperty callback enables optimization in cases where only a property’s existence needs to be known, not its value, and computing its value is expensive. Field: getProperty The callback invoked when getting a property’s value. Field: setProperty The callback invoked when setting a property’s value. Field: deleteProperty The callback invoked when deleting a property. Field: getPropertyNames The callback invoked when collecting the names of an object’s properties. Field: callAsFunction The callback invoked when an object is called as a function. Field: hasInstance The callback invoked when an object is used as the target of an ‘instanceof’ expression. Field: callAsConstructor The callback invoked when an object is used as a constructor in a ‘new’ expression. Field: convertToType The callback invoked when converting an object to a particular JavaScript type.

JSContextJSContext and objc2

A JSContext is a JavaScript execution environment. All JavaScript execution takes place within a context, and all JavaScript values are tied to a context.

JSManagedValueJSManagedValue and objc2

JSManagedValue represents a “conditionally retained” JSValue. “Conditionally retained” means that as long as the JSManagedValue’s JSValue is reachable through the JavaScript object graph, or through the Objective-C object graph reported to the JSVirtualMachine using addManagedReference:withOwner:, the corresponding JSValue will be retained. However, if neither graph reaches the JSManagedValue, the corresponding JSValue will be released and set to nil.

JSRelationConditionJSValueRef

A constant identifying the type of JavaScript relation condition.

JSStaticFunctionJSBase and JSObjectRef

This structure describes a statically declared function property. Field: name A null-terminated UTF8 string containing the property’s name. Field: callAsFunction A JSObjectCallAsFunctionCallback to invoke when the property is called as a function. Field: attributes A logically ORed set of JSPropertyAttributes to give to the property.

JSStaticValueJSBase and JSObjectRef

This structure describes a statically declared value property. Field: name A null-terminated UTF8 string containing the property’s name. Field: getProperty A JSObjectGetPropertyCallback to invoke when getting the property’s value. Field: setProperty A JSObjectSetPropertyCallback to invoke when setting the property’s value. May be NULL if the ReadOnly attribute is set. Field: attributes A logically ORed set of JSPropertyAttributes to give to the property.

JSTypeJSValueRef

A constant identifying the type of a JSValue.

JSTypedArrayTypeJSValueRef

A constant identifying the Typed Array type of a JSObjectRef.

JSValueJSValue and objc2

A JSValue is a reference to a JavaScript value. Every JSValue originates from a JSContext and holds a strong reference to it. When a JSValue instance method creates a new JSValue, the new value originates from the same JSContext.

JSVirtualMachineJSVirtualMachine and objc2

An instance of JSVirtualMachine represents a single JavaScript “object space” or set of execution resources. Thread safety is supported by locking the virtual machine, with concurrent JavaScript execution supported by allocating separate instances of JSVirtualMachine.

OpaqueJSClassJSBase

Apple’s documentation

OpaqueJSContextJSBase

Apple’s documentation

OpaqueJSContextGroupJSBase

Apple’s documentation

OpaqueJSPropertyNameAccumulatorJSBase

Apple’s documentation

OpaqueJSPropertyNameArrayJSBase

Apple’s documentation

OpaqueJSStringJSBase

Apple’s documentation

OpaqueJSValueJSBase

Apple’s documentation

Constants

kJSClassAttributeNoAutomaticPrototypeJSObjectRef

Apple’s documentation

kJSClassAttributeNoneJSObjectRef

Apple’s documentation

kJSPropertyAttributeDontDeleteJSObjectRef

Apple’s documentation

kJSPropertyAttributeDontEnumJSObjectRef

Apple’s documentation

kJSPropertyAttributeNoneJSObjectRef

Apple’s documentation

kJSPropertyAttributeReadOnlyJSObjectRef

Apple’s documentation

Statics

JSPropertyDescriptorConfigurableKey^⚠JSValue and objc2-foundation

Apple’s documentation

JSPropertyDescriptorEnumerableKey^⚠JSValue and objc2-foundation

Apple’s documentation

JSPropertyDescriptorGetKey^⚠JSValue and objc2-foundation

Apple’s documentation

JSPropertyDescriptorSetKey^⚠JSValue and objc2-foundation

Apple’s documentation

JSPropertyDescriptorValueKey^⚠JSValue and objc2-foundation

Apple’s documentation

JSPropertyDescriptorWritableKey^⚠JSValue and objc2-foundation

Property Descriptor Constants

kJSClassDefinitionEmpty^⚠JSBase and JSValueRef and JSObjectRef

A JSClassDefinition structure of the current version, filled with NULL pointers and having no attributes.

Traits

JSExportJSExport and objc2

JSExport provides a declarative way to export Objective-C objects and classes – including properties, instance methods, class methods, and initializers – to JavaScript.

Functions

JSBigIntCreateWithDouble^⚠JSValueRef and JSBase

Creates a JavaScript BigInt with a double.

JSBigIntCreateWithInt64^⚠JSValueRef and JSBase

Creates a JavaScript BigInt with a 64-bit signed integer.

JSBigIntCreateWithString^⚠JSValueRef and JSBase

Creates a JavaScript BigInt with an integer represented in string.

JSBigIntCreateWithUInt64^⚠JSValueRef and JSBase

Creates a JavaScript BigInt with a 64-bit unsigned integer.

JSCheckScriptSyntax^⚠JSBase

Checks for syntax errors in a string of JavaScript.

JSClassCreate^⚠JSBase and JSValueRef and JSObjectRef

Creates a JavaScript class suitable for use with JSObjectMake.

JSClassRelease^⚠JSObjectRef and JSBase

Releases a JavaScript class.

JSClassRetain^⚠JSObjectRef and JSBase

Retains a JavaScript class.

JSContextGetGlobalContext^⚠DeprecatedJSContextRef and JSBase

JSContextGetGlobalObject^⚠DeprecatedJSContextRef and JSBase

JSContextGetGroup^⚠DeprecatedJSContextRef and JSBase

JSContextGroupCreate^⚠DeprecatedJSContextRef and JSBase

JSContextGroupRelease^⚠DeprecatedJSContextRef and JSBase

JSContextGroupRetain^⚠DeprecatedJSContextRef and JSBase

JSEvaluateScript^⚠JSBase

Evaluates a string of JavaScript.

JSGarbageCollect^⚠JSBase

Performs a JavaScript garbage collection.

JSGlobalContextCopyName^⚠JSContextRef and JSBase

Gets a copy of the name of a context.

JSGlobalContextCreate^⚠JSContextRef and JSBase

Creates a global JavaScript execution context.

JSGlobalContextCreateInGroup^⚠JSContextRef and JSBase

Creates a global JavaScript execution context in the context group provided.

JSGlobalContextIsInspectable^⚠JSContextRef and JSBase

Gets whether the context is inspectable in Web Inspector.

JSGlobalContextRelease^⚠JSContextRef and JSBase

Releases a global JavaScript execution context.

JSGlobalContextRetain^⚠JSContextRef and JSBase

Retains a global JavaScript execution context.

JSGlobalContextSetInspectable^⚠JSContextRef and JSBase

Sets whether the context is inspectable in Web Inspector. Default value is NO.

JSGlobalContextSetName^⚠JSContextRef and JSBase

Sets the name exposed when inspecting a context.

JSObjectCallAsConstructor^⚠JSObjectRef and JSBase

Calls an object as a constructor.

JSObjectCallAsFunction^⚠JSObjectRef and JSBase

Calls an object as a function.

JSObjectCopyPropertyNames^⚠JSObjectRef and JSBase

Gets the names of an object’s enumerable properties.

JSObjectDeleteProperty^⚠JSObjectRef and JSBase

Deletes a property from an object.

JSObjectDeletePropertyForKey^⚠JSObjectRef and JSBase

Deletes a property from an object using a JSValueRef as the property key.

JSObjectGetArrayBufferByteLength^⚠JSTypedArray and JSBase

Returns the number of bytes in a JavaScript data object.

JSObjectGetArrayBufferBytesPtr^⚠JSTypedArray and JSBase

Returns a pointer to the data buffer that serves as the backing store for a JavaScript Typed Array object.

JSObjectGetPrivate^⚠JSObjectRef and JSBase

Gets an object’s private data.

JSObjectGetProperty^⚠JSObjectRef and JSBase

Gets a property from an object.

JSObjectGetPropertyAtIndex^⚠JSObjectRef and JSBase

Gets a property from an object by numeric index.

JSObjectGetPropertyForKey^⚠JSObjectRef and JSBase

Gets a property from an object using a JSValueRef as the property key.

JSObjectGetPrototype^⚠JSObjectRef and JSBase

Gets an object’s prototype.

JSObjectGetTypedArrayBuffer^⚠JSTypedArray and JSBase

Returns the JavaScript Array Buffer object that is used as the backing of a JavaScript Typed Array object.

JSObjectGetTypedArrayByteLength^⚠JSTypedArray and JSBase

Returns the byte length of a JavaScript Typed Array object.

JSObjectGetTypedArrayByteOffset^⚠JSTypedArray and JSBase

Returns the byte offset of a JavaScript Typed Array object.

JSObjectGetTypedArrayBytesPtr^⚠JSTypedArray and JSBase

Returns a temporary pointer to the backing store of a JavaScript Typed Array object.

JSObjectGetTypedArrayLength^⚠JSTypedArray and JSBase

Returns the length of a JavaScript Typed Array object.

JSObjectHasProperty^⚠JSObjectRef and JSBase

Tests whether an object has a given property.

JSObjectHasPropertyForKey^⚠JSObjectRef and JSBase

Tests whether an object has a given property using a JSValueRef as the property key.

JSObjectIsConstructor^⚠JSObjectRef and JSBase

Tests whether an object can be called as a constructor.

JSObjectIsFunction^⚠JSObjectRef and JSBase

Tests whether an object can be called as a function.

JSObjectMake^⚠JSObjectRef and JSBase

Creates a JavaScript object.

JSObjectMakeArray^⚠JSObjectRef and JSBase

Creates a JavaScript Array object.

JSObjectMakeArrayBufferWithBytesNoCopy^⚠JSTypedArray and JSBase

Creates a JavaScript Array Buffer object from an existing pointer.

JSObjectMakeConstructor^⚠JSObjectRef and JSBase

Convenience method for creating a JavaScript constructor.

JSObjectMakeDate^⚠JSObjectRef and JSBase

Creates a JavaScript Date object, as if by invoking the built-in Date constructor.

JSObjectMakeDeferredPromise^⚠JSObjectRef and JSBase

Creates a JavaScript promise object by invoking the provided executor.

JSObjectMakeError^⚠JSObjectRef and JSBase

Creates a JavaScript Error object, as if by invoking the built-in Error constructor.

JSObjectMakeFunction^⚠JSObjectRef and JSBase

Creates a function with a given script as its body.

JSObjectMakeFunctionWithCallback^⚠JSObjectRef and JSBase

Convenience method for creating a JavaScript function with a given callback as its implementation.

JSObjectMakeRegExp^⚠JSObjectRef and JSBase

Creates a JavaScript RegExp object, as if by invoking the built-in RegExp constructor.

JSObjectMakeTypedArray^⚠JSBase and JSValueRef and JSTypedArray

Creates a JavaScript Typed Array object with the given number of elements.

JSObjectMakeTypedArrayWithArrayBuffer^⚠JSBase and JSValueRef and JSTypedArray

Creates a JavaScript Typed Array object from an existing JavaScript Array Buffer object.

JSObjectMakeTypedArrayWithArrayBufferAndOffset^⚠JSBase and JSValueRef and JSTypedArray

Creates a JavaScript Typed Array object from an existing JavaScript Array Buffer object with the given offset and length.

JSObjectMakeTypedArrayWithBytesNoCopy^⚠JSBase and JSValueRef and JSTypedArray

Creates a JavaScript Typed Array object from an existing pointer.

JSObjectSetPrivate^⚠JSObjectRef and JSBase

Sets a pointer to private data on an object.

JSObjectSetProperty^⚠JSObjectRef and JSBase

Sets a property on an object.

JSObjectSetPropertyAtIndex^⚠JSObjectRef and JSBase

Sets a property on an object by numeric index.

JSObjectSetPropertyForKey^⚠JSObjectRef and JSBase

Sets a property on an object using a JSValueRef as the property key.

JSObjectSetPrototype^⚠JSObjectRef and JSBase

Sets an object’s prototype.

JSPropertyNameAccumulatorAddName^⚠JSObjectRef and JSBase

Adds a property name to a JavaScript property name accumulator.

JSPropertyNameArrayGetCount^⚠JSObjectRef and JSBase

Gets a count of the number of items in a JavaScript property name array.

JSPropertyNameArrayGetNameAtIndex^⚠JSObjectRef and JSBase

Gets a property name at a given index in a JavaScript property name array.

JSPropertyNameArrayRelease^⚠JSObjectRef and JSBase

Releases a JavaScript property name array.

JSPropertyNameArrayRetain^⚠JSObjectRef and JSBase

Retains a JavaScript property name array.

JSStringCopyCFString^⚠JSBase and JSStringRefCF and objc2-core-foundation

Creates a CFString from a JavaScript string.

JSStringCreateWithCFString^⚠JSBase and objc2-core-foundation and JSStringRefCF

Creates a JavaScript string from a CFString.

JSStringCreateWithCharacters^⚠JSStringRef and JSBase

Creates a JavaScript string from a buffer of Unicode characters.

JSStringCreateWithUTF8CString^⚠JSStringRef and JSBase

Creates a JavaScript string from a null-terminated UTF8 string.

JSStringGetCharactersPtr^⚠JSStringRef and JSBase

Returns a pointer to the Unicode character buffer that serves as the backing store for a JavaScript string.

JSStringGetLength^⚠JSStringRef and JSBase

Returns the number of Unicode characters in a JavaScript string.

JSStringGetMaximumUTF8CStringSize^⚠JSStringRef and JSBase

Returns the maximum number of bytes a JavaScript string will take up if converted into a null-terminated UTF8 string.

JSStringGetUTF8CString^⚠JSStringRef and JSBase

Converts a JavaScript string into a null-terminated UTF8 string, and copies the result into an external byte buffer.

JSStringIsEqual^⚠JSStringRef and JSBase

Tests whether two JavaScript strings match.

JSStringIsEqualToUTF8CString^⚠JSStringRef and JSBase

Tests whether a JavaScript string matches a null-terminated UTF8 string.

JSStringRelease^⚠JSStringRef and JSBase

Releases a JavaScript string.

JSStringRetain^⚠JSStringRef and JSBase

Retains a JavaScript string.

JSValueCompare^⚠DeprecatedJSValueRef and JSBase

JSValueCompareDouble^⚠DeprecatedJSValueRef and JSBase

JSValueCompareInt64^⚠DeprecatedJSValueRef and JSBase

JSValueCompareUInt64^⚠DeprecatedJSValueRef and JSBase

JSValueCreateJSONString^⚠DeprecatedJSValueRef and JSBase

JSValueGetType^⚠DeprecatedJSValueRef and JSBase

JSValueGetTypedArrayType^⚠DeprecatedJSValueRef and JSBase

JSValueIsArray^⚠DeprecatedJSValueRef and JSBase

JSValueIsBigInt^⚠DeprecatedJSValueRef and JSBase

JSValueIsBoolean^⚠DeprecatedJSValueRef and JSBase

JSValueIsDate^⚠DeprecatedJSValueRef and JSBase

JSValueIsEqual^⚠DeprecatedJSValueRef and JSBase

JSValueIsInstanceOfConstructor^⚠DeprecatedJSValueRef and JSBase

JSValueIsNull^⚠DeprecatedJSValueRef and JSBase

JSValueIsNumber^⚠DeprecatedJSValueRef and JSBase

JSValueIsObject^⚠DeprecatedJSValueRef and JSBase

JSValueIsObjectOfClass^⚠DeprecatedJSValueRef and JSBase

JSValueIsStrictEqual^⚠DeprecatedJSValueRef and JSBase

JSValueIsString^⚠DeprecatedJSValueRef and JSBase

JSValueIsSymbol^⚠DeprecatedJSValueRef and JSBase

JSValueIsUndefined^⚠DeprecatedJSValueRef and JSBase

JSValueMakeBoolean^⚠DeprecatedJSValueRef and JSBase

JSValueMakeFromJSONString^⚠DeprecatedJSValueRef and JSBase

JSValueMakeNull^⚠DeprecatedJSValueRef and JSBase

JSValueMakeNumber^⚠DeprecatedJSValueRef and JSBase

JSValueMakeString^⚠DeprecatedJSValueRef and JSBase

JSValueMakeSymbol^⚠DeprecatedJSValueRef and JSBase

JSValueMakeUndefined^⚠DeprecatedJSValueRef and JSBase

JSValueProtect^⚠DeprecatedJSValueRef and JSBase

JSValueToBoolean^⚠DeprecatedJSValueRef and JSBase

JSValueToInt32^⚠DeprecatedJSValueRef and JSBase

JSValueToInt64^⚠DeprecatedJSValueRef and JSBase

JSValueToNumber^⚠DeprecatedJSValueRef and JSBase

JSValueToObject^⚠DeprecatedJSValueRef and JSBase

JSValueToStringCopy^⚠DeprecatedJSValueRef and JSBase

JSValueToUInt32^⚠DeprecatedJSValueRef and JSBase

JSValueToUInt64^⚠DeprecatedJSValueRef and JSBase

JSValueUnprotect^⚠DeprecatedJSValueRef and JSBase

Type Aliases

JSCharJSStringRef

A UTF-16 code unit. One, or a sequence of two, can encode any Unicode character. As with all scalar types, endianness depends on the underlying architecture.

JSClassAttributesJSObjectRef

A set of JSClassAttributes. Combine multiple attributes by logically ORing them together.

JSClassRefJSBase

Apple’s documentation

JSContextGroupRefJSBase

Apple’s documentation

JSContextRefJSBase

Apple’s documentation

JSGlobalContextRefJSBase

Apple’s documentation

JSObjectCallAsConstructorCallbackJSBase and JSObjectRef

The callback invoked when an object is used as a constructor in a ‘new’ expression.

JSObjectCallAsFunctionCallbackJSBase and JSObjectRef

The callback invoked when an object is called as a function.

JSObjectConvertToTypeCallbackJSBase and JSObjectRef and JSValueRef

The callback invoked when converting an object to a particular JavaScript type.

JSObjectDeletePropertyCallbackJSBase and JSObjectRef

The callback invoked when deleting a property.

JSObjectFinalizeCallbackJSBase and JSObjectRef

The callback invoked when an object is finalized (prepared for garbage collection). An object may be finalized on any thread.

JSObjectGetPropertyCallbackJSBase and JSObjectRef

The callback invoked when getting a property’s value.

JSObjectGetPropertyNamesCallbackJSBase and JSObjectRef

The callback invoked when collecting the names of an object’s properties.

JSObjectHasInstanceCallbackJSBase and JSObjectRef

hasInstance The callback invoked when an object is used as the target of an ‘instanceof’ expression.

JSObjectHasPropertyCallbackJSBase and JSObjectRef

The callback invoked when determining whether an object has a property.

JSObjectInitializeCallbackJSBase and JSObjectRef

The callback invoked when an object is first created.

JSObjectRefJSBase

Apple’s documentation

JSObjectSetPropertyCallbackJSBase and JSObjectRef

The callback invoked when setting a property’s value.

JSPropertyAttributesJSObjectRef

A set of JSPropertyAttributes. Combine multiple attributes by logically ORing them together.

JSPropertyNameAccumulatorRefJSBase

Apple’s documentation

JSPropertyNameArrayRefJSBase

Apple’s documentation

JSStringRefJSBase

Apple’s documentation

JSTypedArrayBytesDeallocatorJSBase

Apple’s documentation

JSValuePropertyJSValue and objc2-foundation

Apple’s documentation

JSValueRefJSBase

Apple’s documentation