コード例 #1
0
        /// <summary>
        /// Defines a new object's own property from a property descriptor
        /// </summary>
        /// <remarks>
        /// Requires an active script context.
        /// </remarks>
        /// <param name="propertyId">The ID of the property</param>
        /// <param name="propertyDescriptor">The property descriptor</param>
        /// <returns>Whether the property was defined</returns>
        public bool DefineProperty(JsPropertyId propertyId, JsValue propertyDescriptor)
        {
            bool result;

            JsErrorHelpers.ThrowIfError(NativeMethods.JsDefineProperty(this, propertyId, propertyDescriptor, out result));

            return(result);
        }
コード例 #2
0
        /// <summary>
        /// Converts a value to <c>Object</c> using regular JavaScript semantics
        /// </summary>
        /// <remarks>
        /// Requires an active script context.
        /// </remarks>
        /// <returns>The converted value</returns>
        public JsValue ConvertToObject()
        {
            JsValue objectReference;

            JsErrorHelpers.ThrowIfError(NativeMethods.JsConvertValueToObject(this, out objectReference));

            return(objectReference);
        }
コード例 #3
0
        /// <summary>
        /// Gets a list of all properties on the object
        /// </summary>
        /// <remarks>
        /// Requires an active script context.
        /// </remarks>
        /// <returns>An array of property names</returns>
        public JsValue GetOwnPropertyNames()
        {
            JsValue propertyNamesReference;

            JsErrorHelpers.ThrowIfError(NativeMethods.JsGetOwnPropertyNames(this, out propertyNamesReference));

            return(propertyNamesReference);
        }
コード例 #4
0
        /// <summary>
        /// Retrieves a <c>int</c> value of a <c>Number</c> value
        /// </summary>
        /// <remarks>
        /// <para>
        /// This function retrieves the value of a Number value. It will fail with
        /// <c>InvalidArgument</c> if the type of the value is not <c>Number</c>.
        /// </para>
        /// <para>
        /// Requires an active script context.
        /// </para>
        /// </remarks>
        /// <returns>The <c>int</c> value</returns>
        public int ToInt32()
        {
            int value;

            JsErrorHelpers.ThrowIfError(NativeMethods.JsNumberToInt(this, out value));

            return(value);
        }
コード例 #5
0
        /// <summary>
        /// Converts a value to <c>Number</c> using regular JavaScript semantics
        /// </summary>
        /// <remarks>
        /// Requires an active script context.
        /// </remarks>
        /// <returns>The converted value</returns>
        public JsValue ConvertToNumber()
        {
            JsValue numberReference;

            JsErrorHelpers.ThrowIfError(NativeMethods.JsConvertValueToNumber(this, out numberReference));

            return(numberReference);
        }
コード例 #6
0
        /// <summary>
        /// Adds a reference to the object
        /// </summary>
        /// <remarks>
        /// This only needs to be called on objects that are not going to be stored somewhere on
        /// the stack. Calling AddRef ensures that the JavaScript object the value refers to will not be freed
        /// until Release is called
        /// </remarks>
        /// <returns>The object's new reference count</returns>
        public uint AddRef()
        {
            uint count;

            JsErrorHelpers.ThrowIfError(NativeMethods.JsAddRef(this, out count));

            return(count);
        }
コード例 #7
0
        /// <summary>
        /// Retrieves a <c>bool</c> value of a <c>Boolean</c> value
        /// </summary>
        /// <remarks>
        /// Requires an active script context.
        /// </remarks>
        /// <returns>The converted value</returns>
        public bool ToBoolean()
        {
            bool value;

            JsErrorHelpers.ThrowIfError(NativeMethods.JsBooleanToBool(this, out value));

            return(value);
        }
コード例 #8
0
        /// <summary>
        /// Returns a exception that caused the runtime of the current context to be in the
        /// exception state and resets the exception state for that runtime
        /// </summary>
        /// <remarks>
        /// <para>
        /// If the runtime of the current context is not in an exception state, this API will throw
        /// <see cref="JsErrorCode.InvalidArgument"/>. If the runtime is disabled, this will return
        /// an exception indicating that the script was terminated, but it will not clear the exception
        /// (the exception will be cleared if the runtime is re-enabled using
        /// <c>JsEnableRuntimeExecution</c>).
        /// </para>
        /// <para>
        /// Requires an active script context.
        /// </para>
        /// </remarks>
        /// <returns>The exception for the runtime of the current context</returns>
        public static JsValue GetAndClearException()
        {
            JsValue exception;

            JsErrorHelpers.ThrowIfError(NativeMethods.JsGetAndClearException(out exception));

            return(exception);
        }
コード例 #9
0
        /// <summary>
        /// Returns a metadata relating to the exception that caused the runtime of the current context
        /// to be in the exception state and resets the exception state for that runtime. The metadata
        /// includes a reference to the exception itself.
        /// </summary>
        /// <remarks>
        /// <para>
        /// If the runtime of the current context is not in an exception state, this API will throw
        /// <see cref="JsErrorCode.InvalidArgument"/>. If the runtime is disabled, this will return
        /// an exception indicating that the script was terminated, but it will not clear the exception
        /// (the exception will be cleared if the runtime is re-enabled using
        /// <c>JsEnableRuntimeExecution</c>).
        /// </para>
        /// <para>
        /// The metadata value is a javascript object with the following properties: <c>exception</c>, the
        /// thrown exception object; <c>line</c>, the 0 indexed line number where the exception was thrown;
        /// <c>column</c>, the 0 indexed column number where the exception was thrown; <c>length</c>, the
        /// source-length of the cause of the exception; <c>source</c>, a string containing the line of
        /// source code where the exception was thrown; and <c>url</c>, a string containing the name of
        /// the script file containing the code that threw the exception.
        /// </para>
        /// <para>
        /// Requires an active script context.
        /// </para>
        /// </remarks>
        /// <returns>The exception metadata for the runtime of the current context</returns>
        public static JsValue JsGetAndClearExceptionWithMetadata()
        {
            JsValue metadata;

            JsErrorHelpers.ThrowIfError(NativeMethods.JsGetAndClearExceptionWithMetadata(out metadata));

            return(metadata);
        }
コード例 #10
0
        /// <summary>
        /// Creates a script context for running scripts
        /// </summary>
        /// <remarks>
        /// Each script context has its own global object that is isolated from all other script
        /// contexts.
        /// </remarks>
        /// <returns>The created script context</returns>
        public JsContext CreateContext()
        {
            JsContext reference;

            JsErrorHelpers.ThrowIfError(NativeMethods.JsCreateContext(this, out reference));

            return(reference);
        }
コード例 #11
0
        /// <summary>
        /// Tells the runtime to do any idle processing it need to do
        /// </summary>
        /// <remarks>
        /// <para>
        /// If idle processing has been enabled for the current runtime, calling <c>Idle</c> will
        /// inform the current runtime that the host is idle and that the runtime can perform
        /// memory cleanup tasks.
        /// </para>
        /// <para>
        /// <c>Idle</c> will also return the number of system ticks until there will be more idle work
        /// for the runtime to do. Calling <c>Idle</c> before this number of ticks has passed will do
        /// no work.
        /// </para>
        /// <para>
        /// Requires an active script context.
        /// </para>
        /// </remarks>
        /// <returns>
        /// The next system tick when there will be more idle work to do. Returns the
        /// maximum number of ticks if there no upcoming idle work to do.
        /// </returns>
        public static uint Idle()
        {
            uint ticks;

            JsErrorHelpers.ThrowIfError(NativeMethods.JsIdle(out ticks));

            return(ticks);
        }
コード例 #12
0
        /// <summary>
        /// Creates a new runtime
        /// </summary>
        /// <param name="attributes">The attributes of the runtime to be created</param>
        /// <param name="threadServiceCallback">The thread service for the runtime. Can be null</param>
        /// <returns>The runtime created</returns>
        public static JsRuntime Create(JsRuntimeAttributes attributes, JsThreadServiceCallback threadServiceCallback)
        {
            JsRuntime handle;

            JsErrorHelpers.ThrowIfError(NativeMethods.JsCreateRuntime(attributes, threadServiceCallback, out handle));

            return(handle);
        }
コード例 #13
0
        /// <summary>
        /// Retrieves a value at the specified index of an object
        /// </summary>
        /// <remarks>
        /// Requires an active script context.
        /// </remarks>
        /// <param name="index">The index to retrieve</param>
        /// <returns>The retrieved value</returns>
        public JsValue GetIndexedProperty(JsValue index)
        {
            JsValue propertyReference;

            JsErrorHelpers.ThrowIfError(NativeMethods.JsGetIndexedProperty(this, index, out propertyReference));

            return(propertyReference);
        }
コード例 #14
0
        /// <summary>
        /// Test if an object has a value at the specified index
        /// </summary>
        /// <remarks>
        /// Requires an active script context.
        /// </remarks>
        /// <param name="index">The index to test</param>
        /// <returns>Whether the object has an value at the specified index</returns>
        public bool HasIndexedProperty(JsValue index)
        {
            bool hasProperty;

            JsErrorHelpers.ThrowIfError(NativeMethods.JsHasIndexedProperty(this, index, out hasProperty));

            return(hasProperty);
        }
コード例 #15
0
        /// <summary>
        /// Creates a JavaScript array object
        /// </summary>
        /// <remarks>
        /// Requires an active script context.
        /// </remarks>
        /// <param name="length">The initial length of the array</param>
        /// <returns>The new array object</returns>
        public static JsValue CreateArray(uint length)
        {
            JsValue reference;

            JsErrorHelpers.ThrowIfError(NativeMethods.JsCreateArray(length, out reference));

            return(reference);
        }
コード例 #16
0
        /// <summary>
        /// Compare two JavaScript values for strict equality
        /// </summary>
        /// <remarks>
        /// <para>
        /// This function is equivalent to the "===" operator in JavaScript.
        /// </para>
        /// <para>
        /// Requires an active script context.
        /// </para>
        /// </remarks>
        /// <param name="other">The object to compare</param>
        /// <returns>Whether the values are strictly equal</returns>
        public bool StrictEquals(JsValue other)
        {
            bool equals;

            JsErrorHelpers.ThrowIfError(NativeMethods.JsStrictEquals(this, other, out equals));

            return(equals);
        }
コード例 #17
0
        /// <summary>
        /// Creates a new JavaScript URIError error object
        /// </summary>
        /// <remarks>
        /// Requires an active script context.
        /// </remarks>
        /// <param name="message">Message for the error object</param>
        /// <returns>The new error object</returns>
        public static JsValue CreateUriError(JsValue message)
        {
            JsValue reference;

            JsErrorHelpers.ThrowIfError(NativeMethods.JsCreateURIError(message, out reference));

            return(reference);
        }
コード例 #18
0
        /// <summary>
        /// Creates a <c>Boolean</c> value from a <c>bool</c> value
        /// </summary>
        /// <remarks>
        /// Requires an active script context.
        /// </remarks>
        /// <param name="value">The value to be converted</param>
        /// <returns>The converted value</returns>
        public static JsValue FromBoolean(bool value)
        {
            JsValue reference;

            JsErrorHelpers.ThrowIfError(NativeMethods.JsBoolToBoolean(value, out reference));

            return(reference);
        }
コード例 #19
0
        /// <summary>
        /// Releases a reference to the object
        /// </summary>
        /// <remarks>
        /// Removes a reference that was created by AddRef.
        /// </remarks>
        /// <returns>The object's new reference count</returns>
        public uint Release()
        {
            uint count;

            JsErrorHelpers.ThrowIfError(NativeMethods.JsRelease(this, out count));

            return(count);
        }
コード例 #20
0
        /// <summary>
        /// Creates a <c>Number</c> value from a <c>double</c> value
        /// </summary>
        /// <remarks>
        /// Requires an active script context.
        /// </remarks>
        /// <param name="value">The value to be converted</param>
        /// <returns>The new <c>Number</c> value</returns>
        public static JsValue FromDouble(double value)
        {
            JsValue reference;

            JsErrorHelpers.ThrowIfError(NativeMethods.JsDoubleToNumber(value, out reference));

            return(reference);
        }
コード例 #21
0
        /// <summary>
        /// Retrieves a <c>double</c> value of a <c>Number</c> value
        /// </summary>
        /// <remarks>
        /// <para>
        /// This function retrieves the value of a Number value. It will fail with
        /// <c>InvalidArgument</c> if the type of the value is not <c>Number</c>.
        /// </para>
        /// <para>
        /// Requires an active script context.
        /// </para>
        /// </remarks>
        /// <returns>The <c>double</c> value</returns>
        public double ToDouble()
        {
            double value;

            JsErrorHelpers.ThrowIfError(NativeMethods.JsNumberToDouble(this, out value));

            return(value);
        }
コード例 #22
0
        /// <summary>
        /// Creates a <c>Number</c> value from a <c>int</c> value
        /// </summary>
        /// <remarks>
        /// Requires an active script context.
        /// </remarks>
        /// <param name="value">The value to be converted</param>
        /// <returns>The new <c>Number</c> value</returns>
        public static JsValue FromInt32(int value)
        {
            JsValue reference;

            JsErrorHelpers.ThrowIfError(NativeMethods.JsIntToNumber(value, out reference));

            return(reference);
        }
コード例 #23
0
        /// <summary>
        /// Converts a value to <c>Boolean</c> using regular JavaScript semantics
        /// </summary>
        /// <remarks>
        /// Requires an active script context.
        /// </remarks>
        /// <returns>The converted value</returns>
        public JsValue ConvertToBoolean()
        {
            JsValue booleanReference;

            JsErrorHelpers.ThrowIfError(NativeMethods.JsConvertValueToBoolean(this, out booleanReference));

            return(booleanReference);
        }
コード例 #24
0
        /// <summary>
        /// Creates a new <c>Object</c>
        /// </summary>
        /// <remarks>
        /// Requires an active script context.
        /// </remarks>
        /// <returns>The new <c>Object</c></returns>
        public static JsValue CreateObject()
        {
            JsValue reference;

            JsErrorHelpers.ThrowIfError(NativeMethods.JsCreateObject(out reference));

            return(reference);
        }
コード例 #25
0
        /// <summary>
        /// Converts a value to <c>String</c> using regular JavaScript semantics
        /// </summary>
        /// <remarks>
        /// Requires an active script context.
        /// </remarks>
        /// <returns>The converted value</returns>
        public JsValue ConvertToString()
        {
            JsValue stringReference;

            JsErrorHelpers.ThrowIfError(NativeMethods.JsConvertValueToString(this, out stringReference));

            return(stringReference);
        }
コード例 #26
0
        /// <summary>
        /// Creates a new <c>Object</c> that stores some external data
        /// </summary>
        /// <remarks>
        /// Requires an active script context.
        /// </remarks>
        /// <param name="data">External data that the object will represent. May be null.</param>
        /// <param name="finalizer">The callback for when the object is finalized. May be null.</param>
        /// <returns>The new <c>Object</c></returns>
        public static JsValue CreateExternalObject(IntPtr data, JsFinalizeCallback finalizer)
        {
            JsValue reference;

            JsErrorHelpers.ThrowIfError(NativeMethods.JsCreateExternalObject(data, finalizer, out reference));

            return(reference);
        }
コード例 #27
0
        /// <summary>
        /// Gets a property descriptor for an object's own property
        /// </summary>
        /// <remarks>
        /// Requires an active script context.
        /// </remarks>
        /// <param name="propertyId">The ID of the property</param>
        /// <returns>The property descriptor</returns>
        public JsValue GetOwnPropertyDescriptor(JsPropertyId propertyId)
        {
            JsValue descriptorReference;

            JsErrorHelpers.ThrowIfError(NativeMethods.JsGetOwnPropertyDescriptor(this, propertyId, out descriptorReference));

            return(descriptorReference);
        }
コード例 #28
0
        /// <summary>
        /// Creates a new JavaScript function
        /// </summary>
        /// <remarks>
        /// Requires an active script context.
        /// </remarks>
        /// <param name="function">The method to call when the function is invoked</param>
        /// <param name="callbackData">Data to be provided to all function callbacks</param>
        /// <returns>The new function object</returns>
        public static JsValue CreateFunction(JsNativeFunction function, IntPtr callbackData)
        {
            JsValue reference;

            JsErrorHelpers.ThrowIfError(NativeMethods.JsCreateFunction(function, callbackData, out reference));

            return(reference);
        }
コード例 #29
0
        /// <summary>
        /// Determines whether an object has a property
        /// </summary>
        /// <remarks>
        /// Requires an active script context.
        /// </remarks>
        /// <param name="propertyId">The ID of the property</param>
        /// <returns>Whether the object (or a prototype) has the property</returns>
        public bool HasProperty(JsPropertyId propertyId)
        {
            bool hasProperty;

            JsErrorHelpers.ThrowIfError(NativeMethods.JsHasProperty(this, propertyId, out hasProperty));

            return(hasProperty);
        }
コード例 #30
0
        /// <summary>
        /// Deletes an object's property
        /// </summary>
        /// <remarks>
        /// Requires an active script context.
        /// </remarks>
        /// <param name="propertyId">The ID of the property</param>
        /// <param name="useStrictRules">The property set should follow strict mode rules</param>
        /// <returns>Whether the property was deleted</returns>
        public JsValue DeleteProperty(JsPropertyId propertyId, bool useStrictRules)
        {
            JsValue returnReference;

            JsErrorHelpers.ThrowIfError(NativeMethods.JsDeleteProperty(this, propertyId, useStrictRules, out returnReference));

            return(returnReference);
        }