Showing preview only (811K chars total). Download the full file or copy to clipboard to get everything.
Repository: tondrej/chakracore-delphi
Branch: master
Commit: e01131b55694
Files: 77
Total size: 779.4 KB
Directory structure:
gitextract_l0pubcul/
├── .github/
│ └── FUNDING.yml
├── .gitignore
├── .gitmodules
├── LICENSE
├── README.md
├── include/
│ ├── ChakraCommon.h
│ ├── ChakraCore.h
│ ├── ChakraCoreVersion.h
│ └── ChakraDebug.h
├── packages.config
├── samples/
│ ├── HostSample/
│ │ ├── ChakraCoreHostMainData.dfm
│ │ ├── ChakraCoreHostMainData.pas
│ │ ├── ChakraCoreHostSample.XE.dproj
│ │ ├── ChakraCoreHostSample.dof
│ │ ├── ChakraCoreHostSample.dpr
│ │ ├── ChakraCoreHostSample.lpi
│ │ ├── ChakraCoreHostSample.res
│ │ ├── Console.pas
│ │ └── scripts/
│ │ ├── json2.js
│ │ └── main.js
│ ├── NodeSample/
│ │ ├── EventEmitter.pas
│ │ ├── NodeMainData.dfm
│ │ ├── NodeMainData.pas
│ │ ├── NodeProcess.pas
│ │ ├── NodeSample.XE.dproj
│ │ ├── NodeSample.dof
│ │ ├── NodeSample.dpr
│ │ ├── NodeSample.lpi
│ │ ├── NodeSample.res
│ │ ├── README.md
│ │ ├── demo_commonmark.js
│ │ ├── demo_graphql.js
│ │ ├── demo_json-query.js
│ │ ├── demo_lodash.js
│ │ └── demo_moment.js
│ ├── Samples.XE.groupproj
│ ├── Samples.bpg
│ ├── Samples.lpg
│ ├── SimpleHostSample/
│ │ ├── SimpleHost.XE.dproj
│ │ ├── SimpleHost.dof
│ │ ├── SimpleHost.dpr
│ │ ├── SimpleHost.lpi
│ │ ├── SimpleHost.res
│ │ └── scripts/
│ │ └── hello.js
│ └── WasmSample/
│ ├── README.md
│ ├── WasmMainData.dfm
│ ├── WasmMainData.pas
│ ├── WasmMainForm.dfm
│ ├── WasmMainForm.pas
│ ├── WasmSample.XE.dproj
│ ├── WasmSample.dof
│ ├── WasmSample.dpr
│ ├── WasmSample.lpi
│ ├── WasmSample.res
│ └── scripts/
│ ├── main.js
│ └── main.wasm
├── src/
│ ├── ChakraCommon.pas
│ ├── ChakraCore.pas
│ ├── ChakraCoreClasses.pas
│ ├── ChakraCoreUtils.pas
│ ├── ChakraCoreVersion.pas
│ ├── ChakraDebug.pas
│ ├── Compat.pas
│ └── common.inc
└── tests/
├── ChakraCoreTests.XE.dproj
├── ChakraCoreTests.dof
├── ChakraCoreTests.dpr
├── ChakraCoreTests.lpi
├── ChakraCoreTests.res
├── ChakraCoreTestsUI.XE.dproj
├── ChakraCoreTestsUI.dof
├── ChakraCoreTestsUI.dpr
├── ChakraCoreTestsUI.lpi
├── ChakraCoreTestsUI.res
├── Test_ChakraCore.pas
├── Test_Classes.pas
└── tests.sh
================================================
FILE CONTENTS
================================================
================================================
FILE: .github/FUNDING.yml
================================================
github: tondrej
================================================
FILE: .gitignore
================================================
# Uncomment these types if you want even more clean repository. But be careful.
# It can make harm to an existing project source. Read explanations below.
#
# Resource files are binaries containing manifest, project icon and version info.
# They can not be viewed as text or compared by diff-tools. Consider replacing them with .rc files.
#*.res
#
# Type library file (binary). In old Delphi versions it should be stored.
# Since Delphi 2009 it is produced from .ridl file and can safely be ignored.
#*.tlb
#
# Diagram Portfolio file. Used by the diagram editor up to Delphi 7.
# Uncomment this if you are not using diagrams or use newer Delphi version.
#*.ddp
#
# Visual LiveBindings file. Added in Delphi XE2.
# Uncomment this if you are not using LiveBindings Designer.
#*.vlb
#
# Deployment Manager configuration file for your project. Added in Delphi XE2.
# Uncomment this if it is not mobile development and you do not use remote debug feature.
#*.deployproj
#
# C++ object files produced when C/C++ Output file generation is configured.
# Uncomment this if you are not using external objects (zlib library for example).
#*.obj
#
# Delphi compiler-generated binaries (safe to delete)
*.exe
*.dll
*.bpl
*.bpi
*.dcp
*.so
*.apk
*.drc
*.map
*.dres
*.rsm
*.tds
*.dcu
*.lib
*.a
*.o
*.ocx
*.otares
# Delphi autogenerated files (duplicated info)
*.cfg
*.ddp
*.hpp
*Resource.rc
# Delphi local files (user-specific info)
*.local
*.identcache
*.projdata
*.tvsconfig
*.dsk
# Delphi history and backups
__history/
__recovery/
*.~*
# Castalia statistics file (since XE7 Castalia is distributed with Delphi)
*.stat
# FPC local files (user-specific info)
*.lps
# chakracore-delphi-specific paths
/bin
/lib
================================================
FILE: .gitmodules
================================================
[submodule "ext/jedi"]
path = ext/jedi
url = https://github.com/tondrej/jedi
================================================
FILE: LICENSE
================================================
MIT License
Copyright (c) 2021 Ondrej Kelle
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
================================================
FILE: README.md
================================================
# chakracore-delphi
[](https://github.com/tondrej/chakracore-delphi/blob/master/LICENSE)
[Delphi](https://www.embarcadero.com/products/delphi) and [Free Pascal](https://www.freepascal.org) bindings and classes for Microsoft's [ChakraCore](https://github.com/Microsoft/ChakraCore) library.
ChakraCore version: **1.11.24**
Supported compilers:
- Delphi 7 or newer
- Free Pascal 3.0.4 or newer
Supported target platforms:
- i386-win32 (Delphi 7 or newer, Free Pascal)
- x86_64-win64 (Delphi XE2 or newer, Free Pascal)
- x86_64-linux (Free Pascal)
- x86_64-darwin (Free Pascal)
Installation:
1. Clone this repository:
```bash
git clone https://github.com/tondrej/chakracore-delphi.git
cd chakracore-delphi
git submodule update --init
```
or
```bash
git clone --recurse-submodules https://github.com/tondrej/chakracore-delphi.git
```
2. Download the binaries from the ChakraCore [Release](https://github.com/Microsoft/ChakraCore/releases/tag/v1.11.24) page
3. Enjoy!
================================================
FILE: include/ChakraCommon.h
================================================
//-------------------------------------------------------------------------------------------------------
// Copyright (C) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE.txt file in the project root for full license information.
//-------------------------------------------------------------------------------------------------------
/// \mainpage Chakra Hosting API Reference
///
/// Chakra is Microsoft's JavaScript engine. It is an integral part of Internet Explorer but can
/// also be hosted independently by other applications. This reference describes the APIs available
/// to applications to host Chakra.
///
/// This file contains the common API set shared among all Chakra releases. For Windows-specific
/// releases, see chakrart.h.
/// \file
/// \brief The base Chakra hosting API.
///
/// This file contains a flat C API layer. This is the API exported by chakra.dll.
#ifdef _MSC_VER
#pragma once
#endif // _MSC_VER
#ifndef _CHAKRACOMMON_H_
#define _CHAKRACOMMON_H_
// Platform specific code
#if defined(_WIN32) && defined(_MSC_VER)
#include <oaidl.h>
// Header macros
#define CHAKRA_CALLBACK CALLBACK
#define CHAKRA_API STDAPI_(JsErrorCode)
typedef DWORD_PTR ChakraCookie;
typedef BYTE* ChakraBytePtr;
#else // Non-Windows VC++
// SAL compat
#define _Return_type_success_(x)
#define _In_
#define _In_z_
#define _In_opt_
#define _Inout_
#define _Out_
#define _Out_opt_
#define _In_reads_(x)
#define _Pre_maybenull_
#define _Pre_writable_byte_size_(byteLength)
#define _Outptr_result_buffer_(byteLength)
#define _Outptr_result_bytebuffer_(byteLength)
#define _Outptr_result_maybenull_
#define _Outptr_result_z_
#define _Ret_maybenull_
#define _Out_writes_(size)
#define _Out_writes_to_opt_(byteLength, byteLength2)
// Header macros
#ifdef __i386___
#define CHAKRA_CALLBACK __attribute__((cdecl))
#else // non-32 bit x86 doesn't have cdecl support
#define CHAKRA_CALLBACK
#endif // __i386__
#ifndef _WIN32
#define SET_API_VISIBILITY __attribute__((visibility("default")))
#else
#define SET_API_VISIBILITY
#endif
#ifdef __cplusplus
#define CHAKRA_API extern "C" SET_API_VISIBILITY JsErrorCode
#else
#define CHAKRA_API extern SET_API_VISIBILITY JsErrorCode
#include <stdbool.h>
#endif
#include <stddef.h> // for size_t
#include <stdint.h> // for uintptr_t
typedef uintptr_t ChakraCookie;
typedef unsigned char* ChakraBytePtr;
// xplat-todo: try reduce usage of following types
#if !defined(__MSTYPES_DEFINED)
typedef uint32_t UINT32;
typedef int64_t INT64;
typedef void* HANDLE;
typedef unsigned char BYTE;
typedef BYTE byte;
typedef UINT32 DWORD;
typedef unsigned short WCHAR;
#endif
#endif // defined(_WIN32) && defined(_MSC_VER)
#if (defined(_MSC_VER) && _MSC_VER <= 1900) || (!defined(_MSC_VER) && __cplusplus <= 199711L) // !C++11
typedef unsigned short uint16_t;
#else
#include <stdint.h>
#endif
/// <summary>
/// An error code returned from a Chakra hosting API.
/// </summary>
typedef _Return_type_success_(return == 0) enum _JsErrorCode
{
/// <summary>
/// Success error code.
/// </summary>
JsNoError = 0,
/// <summary>
/// Category of errors that relates to incorrect usage of the API itself.
/// </summary>
JsErrorCategoryUsage = 0x10000,
/// <summary>
/// An argument to a hosting API was invalid.
/// </summary>
JsErrorInvalidArgument,
/// <summary>
/// An argument to a hosting API was null in a context where null is not allowed.
/// </summary>
JsErrorNullArgument,
/// <summary>
/// The hosting API requires that a context be current, but there is no current context.
/// </summary>
JsErrorNoCurrentContext,
/// <summary>
/// The engine is in an exception state and no APIs can be called until the exception is
/// cleared.
/// </summary>
JsErrorInExceptionState,
/// <summary>
/// A hosting API is not yet implemented.
/// </summary>
JsErrorNotImplemented,
/// <summary>
/// A hosting API was called on the wrong thread.
/// </summary>
JsErrorWrongThread,
/// <summary>
/// A runtime that is still in use cannot be disposed.
/// </summary>
JsErrorRuntimeInUse,
/// <summary>
/// A bad serialized script was used, or the serialized script was serialized by a
/// different version of the Chakra engine.
/// </summary>
JsErrorBadSerializedScript,
/// <summary>
/// The runtime is in a disabled state.
/// </summary>
JsErrorInDisabledState,
/// <summary>
/// Runtime does not support reliable script interruption.
/// </summary>
JsErrorCannotDisableExecution,
/// <summary>
/// A heap enumeration is currently underway in the script context.
/// </summary>
JsErrorHeapEnumInProgress,
/// <summary>
/// A hosting API that operates on object values was called with a non-object value.
/// </summary>
JsErrorArgumentNotObject,
/// <summary>
/// A script context is in the middle of a profile callback.
/// </summary>
JsErrorInProfileCallback,
/// <summary>
/// A thread service callback is currently underway.
/// </summary>
JsErrorInThreadServiceCallback,
/// <summary>
/// Scripts cannot be serialized in debug contexts.
/// </summary>
JsErrorCannotSerializeDebugScript,
/// <summary>
/// The context cannot be put into a debug state because it is already in a debug state.
/// </summary>
JsErrorAlreadyDebuggingContext,
/// <summary>
/// The context cannot start profiling because it is already profiling.
/// </summary>
JsErrorAlreadyProfilingContext,
/// <summary>
/// Idle notification given when the host did not enable idle processing.
/// </summary>
JsErrorIdleNotEnabled,
/// <summary>
/// The context did not accept the enqueue callback.
/// </summary>
JsCannotSetProjectionEnqueueCallback,
/// <summary>
/// Failed to start projection.
/// </summary>
JsErrorCannotStartProjection,
/// <summary>
/// The operation is not supported in an object before collect callback.
/// </summary>
JsErrorInObjectBeforeCollectCallback,
/// <summary>
/// Object cannot be unwrapped to IInspectable pointer.
/// </summary>
JsErrorObjectNotInspectable,
/// <summary>
/// A hosting API that operates on symbol property ids but was called with a non-symbol property id.
/// The error code is returned by JsGetSymbolFromPropertyId if the function is called with non-symbol property id.
/// </summary>
JsErrorPropertyNotSymbol,
/// <summary>
/// A hosting API that operates on string property ids but was called with a non-string property id.
/// The error code is returned by existing JsGetPropertyNamefromId if the function is called with non-string property id.
/// </summary>
JsErrorPropertyNotString,
/// <summary>
/// Module evaluation is called in wrong context.
/// </summary>
JsErrorInvalidContext,
/// <summary>
/// Module evaluation is called in wrong context.
/// </summary>
JsInvalidModuleHostInfoKind,
/// <summary>
/// Module was parsed already when JsParseModuleSource is called.
/// </summary>
JsErrorModuleParsed,
/// <summary>
/// Argument passed to JsCreateWeakReference is a primitive that is not managed by the GC.
/// No weak reference is required, the value will never be collected.
/// </summary>
JsNoWeakRefRequired,
/// <summary>
/// The <c>Promise</c> object is still in the pending state.
/// </summary>
JsErrorPromisePending,
/// <summary>
/// Module was not yet evaluated when JsGetModuleNamespace was called.
/// </summary>
JsErrorModuleNotEvaluated,
/// <summary>
/// Category of errors that relates to errors occurring within the engine itself.
/// </summary>
JsErrorCategoryEngine = 0x20000,
/// <summary>
/// The Chakra engine has run out of memory.
/// </summary>
JsErrorOutOfMemory,
/// <summary>
/// The Chakra engine failed to set the Floating Point Unit state.
/// </summary>
JsErrorBadFPUState,
/// <summary>
/// Category of errors that relates to errors in a script.
/// </summary>
JsErrorCategoryScript = 0x30000,
/// <summary>
/// A JavaScript exception occurred while running a script.
/// </summary>
JsErrorScriptException,
/// <summary>
/// JavaScript failed to compile.
/// </summary>
JsErrorScriptCompile,
/// <summary>
/// A script was terminated due to a request to suspend a runtime.
/// </summary>
JsErrorScriptTerminated,
/// <summary>
/// A script was terminated because it tried to use <c>eval</c> or <c>function</c> and eval
/// was disabled.
/// </summary>
JsErrorScriptEvalDisabled,
/// <summary>
/// Category of errors that are fatal and signify failure of the engine.
/// </summary>
JsErrorCategoryFatal = 0x40000,
/// <summary>
/// A fatal error in the engine has occurred.
/// </summary>
JsErrorFatal,
/// <summary>
/// A hosting API was called with object created on different javascript runtime.
/// </summary>
JsErrorWrongRuntime,
/// <summary>
/// Category of errors that are related to failures during diagnostic operations.
/// </summary>
JsErrorCategoryDiagError = 0x50000,
/// <summary>
/// The object for which the debugging API was called was not found
/// </summary>
JsErrorDiagAlreadyInDebugMode,
/// <summary>
/// The debugging API can only be called when VM is in debug mode
/// </summary>
JsErrorDiagNotInDebugMode,
/// <summary>
/// The debugging API can only be called when VM is at a break
/// </summary>
JsErrorDiagNotAtBreak,
/// <summary>
/// Debugging API was called with an invalid handle.
/// </summary>
JsErrorDiagInvalidHandle,
/// <summary>
/// The object for which the debugging API was called was not found
/// </summary>
JsErrorDiagObjectNotFound,
/// <summary>
/// VM was unable to perform the request action
/// </summary>
JsErrorDiagUnableToPerformAction,
} JsErrorCode;
/// <summary>
/// A handle to a Chakra runtime.
/// </summary>
/// <remarks>
/// <para>
/// Each Chakra runtime has its own independent execution engine, JIT compiler, and garbage
/// collected heap. As such, each runtime is completely isolated from other runtimes.
/// </para>
/// <para>
/// Runtimes can be used on any thread, but only one thread can call into a runtime at any
/// time.
/// </para>
/// <para>
/// NOTE: A <c>JsRuntimeHandle</c>, unlike other object references in the Chakra hosting API,
/// is not garbage collected since it contains the garbage collected heap itself. A runtime
/// will continue to exist until <c>JsDisposeRuntime</c> is called.
/// </para>
/// </remarks>
typedef void *JsRuntimeHandle;
/// <summary>
/// An invalid runtime handle.
/// </summary>
#ifdef __cplusplus
const JsRuntimeHandle JS_INVALID_RUNTIME_HANDLE = 0;
#else
#define JS_INVALID_RUNTIME_HANDLE (JsRuntimeHandle)0
#endif
/// <summary>
/// A reference to an object owned by the Chakra garbage collector.
/// </summary>
/// <remarks>
/// A Chakra runtime will automatically track <c>JsRef</c> references as long as they are
/// stored in local variables or in parameters (i.e. on the stack). Storing a <c>JsRef</c>
/// somewhere other than on the stack requires calling <c>JsAddRef</c> and <c>JsRelease</c> to
/// manage the lifetime of the object, otherwise the garbage collector may free the object
/// while it is still in use.
/// </remarks>
typedef void *JsRef;
/// <summary>
/// An invalid reference.
/// </summary>
#ifdef __cplusplus
const JsRef JS_INVALID_REFERENCE = 0;
#else
#define JS_INVALID_REFERENCE (JsRef)0
#endif
/// <summary>
/// A reference to a script context.
/// </summary>
/// <remarks>
/// <para>
/// Each script context contains its own global object, distinct from the global object in
/// other script contexts.
/// </para>
/// <para>
/// Many Chakra hosting APIs require an "active" script context, which can be set using
/// <c>JsSetCurrentContext</c>. Chakra hosting APIs that require a current context to be set
/// will note that explicitly in their documentation.
/// </para>
/// </remarks>
typedef JsRef JsContextRef;
/// <summary>
/// A reference to a JavaScript value.
/// </summary>
/// <remarks>
/// A JavaScript value is one of the following types of values: undefined, null, Boolean,
/// string, number, or object.
/// </remarks>
typedef JsRef JsValueRef;
/// <summary>
/// A cookie that identifies a script for debugging purposes.
/// </summary>
typedef ChakraCookie JsSourceContext;
/// <summary>
/// An empty source context.
/// </summary>
#ifdef __cplusplus
const JsSourceContext JS_SOURCE_CONTEXT_NONE = (JsSourceContext)-1;
#else
#define JS_SOURCE_CONTEXT_NONE (JsSourceContext)-1
#endif
/// <summary>
/// A property identifier.
/// </summary>
/// <remarks>
/// Property identifiers are used to refer to properties of JavaScript objects instead of using
/// strings.
/// </remarks>
typedef JsRef JsPropertyIdRef;
/// <summary>
/// Attributes of a runtime.
/// </summary>
typedef enum _JsRuntimeAttributes
{
/// <summary>
/// No special attributes.
/// </summary>
JsRuntimeAttributeNone = 0x00000000,
/// <summary>
/// The runtime will not do any work (such as garbage collection) on background threads.
/// </summary>
JsRuntimeAttributeDisableBackgroundWork = 0x00000001,
/// <summary>
/// The runtime should support reliable script interruption. This increases the number of
/// places where the runtime will check for a script interrupt request at the cost of a
/// small amount of runtime performance.
/// </summary>
JsRuntimeAttributeAllowScriptInterrupt = 0x00000002,
/// <summary>
/// Host will call <c>JsIdle</c>, so enable idle processing. Otherwise, the runtime will
/// manage memory slightly more aggressively.
/// </summary>
JsRuntimeAttributeEnableIdleProcessing = 0x00000004,
/// <summary>
/// Runtime will not generate native code.
/// </summary>
JsRuntimeAttributeDisableNativeCodeGeneration = 0x00000008,
/// <summary>
/// Using <c>eval</c> or <c>function</c> constructor will throw an exception.
/// </summary>
JsRuntimeAttributeDisableEval = 0x00000010,
/// <summary>
/// Runtime will enable all experimental features.
/// </summary>
JsRuntimeAttributeEnableExperimentalFeatures = 0x00000020,
/// <summary>
/// Calling <c>JsSetException</c> will also dispatch the exception to the script debugger
/// (if any) giving the debugger a chance to break on the exception.
/// </summary>
JsRuntimeAttributeDispatchSetExceptionsToDebugger = 0x00000040,
/// <summary>
/// Disable Failfast fatal error on OOM
/// </summary>
JsRuntimeAttributeDisableFatalOnOOM = 0x00000080,
/// <summary>
/// Runtime will not allocate executable code pages
/// This also implies that Native Code generation will be turned off
/// Note that this will break JavaScript stack decoding in tools
// like WPA since they rely on allocation of unique thunks to
// interpret each function and allocation of those thunks will be
// disabled as well
/// </summary>
JsRuntimeAttributeDisableExecutablePageAllocation = 0x00000100,
} JsRuntimeAttributes;
/// <summary>
/// The type of a typed JavaScript array.
/// </summary>
typedef enum _JsTypedArrayType
{
/// <summary>
/// An int8 array.
/// </summary>
JsArrayTypeInt8,
/// <summary>
/// An uint8 array.
/// </summary>
JsArrayTypeUint8,
/// <summary>
/// An uint8 clamped array.
/// </summary>
JsArrayTypeUint8Clamped,
/// <summary>
/// An int16 array.
/// </summary>
JsArrayTypeInt16,
/// <summary>
/// An uint16 array.
/// </summary>
JsArrayTypeUint16,
/// <summary>
/// An int32 array.
/// </summary>
JsArrayTypeInt32,
/// <summary>
/// An uint32 array.
/// </summary>
JsArrayTypeUint32,
/// <summary>
/// A float32 array.
/// </summary>
JsArrayTypeFloat32,
/// <summary>
/// A float64 array.
/// </summary>
JsArrayTypeFloat64
} JsTypedArrayType;
/// <summary>
/// Allocation callback event type.
/// </summary>
typedef enum _JsMemoryEventType
{
/// <summary>
/// Indicates a request for memory allocation.
/// </summary>
JsMemoryAllocate = 0,
/// <summary>
/// Indicates a memory freeing event.
/// </summary>
JsMemoryFree = 1,
/// <summary>
/// Indicates a failed allocation event.
/// </summary>
JsMemoryFailure = 2
} JsMemoryEventType;
/// <summary>
/// Attribute mask for JsParseScriptWithAttributes
/// </summary>
typedef enum _JsParseScriptAttributes {
/// <summary>
/// Default attribute
/// </summary>
JsParseScriptAttributeNone = 0x0,
/// <summary>
/// Specified script is internal and non-user code. Hidden from debugger
/// </summary>
JsParseScriptAttributeLibraryCode = 0x1,
/// <summary>
/// ChakraCore assumes ExternalArrayBuffer is Utf8 by default.
/// This one needs to be set for Utf16
/// </summary>
JsParseScriptAttributeArrayBufferIsUtf16Encoded = 0x2,
} JsParseScriptAttributes;
/// <summary>
/// Type enumeration of a JavaScript property
/// </summary>
typedef enum _JsPropertyIdType {
/// <summary>
/// Type enumeration of a JavaScript string property
/// </summary>
JsPropertyIdTypeString,
/// <summary>
/// Type enumeration of a JavaScript symbol property
/// </summary>
JsPropertyIdTypeSymbol
} JsPropertyIdType;
/// <summary>
/// The JavaScript type of a JsValueRef.
/// </summary>
typedef enum _JsValueType
{
/// <summary>
/// The value is the <c>undefined</c> value.
/// </summary>
JsUndefined = 0,
/// <summary>
/// The value is the <c>null</c> value.
/// </summary>
JsNull = 1,
/// <summary>
/// The value is a JavaScript number value.
/// </summary>
JsNumber = 2,
/// <summary>
/// The value is a JavaScript string value.
/// </summary>
JsString = 3,
/// <summary>
/// The value is a JavaScript Boolean value.
/// </summary>
JsBoolean = 4,
/// <summary>
/// The value is a JavaScript object value.
/// </summary>
JsObject = 5,
/// <summary>
/// The value is a JavaScript function object value.
/// </summary>
JsFunction = 6,
/// <summary>
/// The value is a JavaScript error object value.
/// </summary>
JsError = 7,
/// <summary>
/// The value is a JavaScript array object value.
/// </summary>
JsArray = 8,
/// <summary>
/// The value is a JavaScript symbol value.
/// </summary>
JsSymbol = 9,
/// <summary>
/// The value is a JavaScript ArrayBuffer object value.
/// </summary>
JsArrayBuffer = 10,
/// <summary>
/// The value is a JavaScript typed array object value.
/// </summary>
JsTypedArray = 11,
/// <summary>
/// The value is a JavaScript DataView object value.
/// </summary>
JsDataView = 12,
} JsValueType;
/// <summary>
/// User implemented callback routine for memory allocation events
/// </summary>
/// <remarks>
/// Use <c>JsSetRuntimeMemoryAllocationCallback</c> to register this callback.
/// </remarks>
/// <param name="callbackState">
/// The state passed to <c>JsSetRuntimeMemoryAllocationCallback</c>.
/// </param>
/// <param name="allocationEvent">The type of type allocation event.</param>
/// <param name="allocationSize">The size of the allocation.</param>
/// <returns>
/// For the <c>JsMemoryAllocate</c> event, returning <c>true</c> allows the runtime to continue
/// with the allocation. Returning false indicates the allocation request is rejected. The
/// return value is ignored for other allocation events.
/// </returns>
typedef bool (CHAKRA_CALLBACK * JsMemoryAllocationCallback)(_In_opt_ void *callbackState, _In_ JsMemoryEventType allocationEvent, _In_ size_t allocationSize);
/// <summary>
/// A callback called before collection.
/// </summary>
/// <remarks>
/// Use <c>JsSetBeforeCollectCallback</c> to register this callback.
/// </remarks>
/// <param name="callbackState">The state passed to <c>JsSetBeforeCollectCallback</c>.</param>
typedef void (CHAKRA_CALLBACK *JsBeforeCollectCallback)(_In_opt_ void *callbackState);
/// <summary>
/// A callback called before collecting an object.
/// </summary>
/// <remarks>
/// Use <c>JsSetObjectBeforeCollectCallback</c> to register this callback.
/// </remarks>
/// <param name="ref">The object to be collected.</param>
/// <param name="callbackState">The state passed to <c>JsSetObjectBeforeCollectCallback</c>.</param>
typedef void (CHAKRA_CALLBACK *JsObjectBeforeCollectCallback)(_In_ JsRef ref, _In_opt_ void *callbackState);
/// <summary>
/// A background work item callback.
/// </summary>
/// <remarks>
/// This is passed to the host's thread service (if provided) to allow the host to
/// invoke the work item callback on the background thread of its choice.
/// </remarks>
/// <param name="callbackState">Data argument passed to the thread service.</param>
typedef void (CHAKRA_CALLBACK *JsBackgroundWorkItemCallback)(_In_opt_ void *callbackState);
/// <summary>
/// A thread service callback.
/// </summary>
/// <remarks>
/// The host can specify a background thread service when calling <c>JsCreateRuntime</c>. If
/// specified, then background work items will be passed to the host using this callback. The
/// host is expected to either begin executing the background work item immediately and return
/// true or return false and the runtime will handle the work item in-thread.
/// </remarks>
/// <param name="callback">The callback for the background work item.</param>
/// <param name="callbackState">The data argument to be passed to the callback.</param>
typedef bool (CHAKRA_CALLBACK *JsThreadServiceCallback)(_In_ JsBackgroundWorkItemCallback callback, _In_opt_ void *callbackState);
/// <summary>
/// Called by the runtime when it is finished with all resources related to the script execution.
/// The caller should free the source if loaded, the byte code, and the context at this time.
/// </summary>
/// <param name="sourceContext">The context passed to Js[Parse|Run]SerializedScriptWithCallback</param>
typedef void (CHAKRA_CALLBACK * JsSerializedScriptUnloadCallback)(_In_ JsSourceContext sourceContext);
/// <summary>
/// A finalizer callback.
/// </summary>
/// <param name="data">
/// The external data that was passed in when creating the object being finalized.
/// </param>
typedef void (CHAKRA_CALLBACK *JsFinalizeCallback)(_In_opt_ void *data);
/// <summary>
/// A function callback.
/// </summary>
/// <param name="callee">
/// A function object that represents the function being invoked.
/// </param>
/// <param name="isConstructCall">Indicates whether this is a regular call or a 'new' call.</param>
/// <param name="arguments">The arguments to the call.</param>
/// <param name="argumentCount">The number of arguments.</param>
/// <param name="callbackState">
/// The state passed to <c>JsCreateFunction</c>.
/// </param>
/// <returns>The result of the call, if any.</returns>
typedef _Ret_maybenull_ JsValueRef(CHAKRA_CALLBACK * JsNativeFunction)(_In_ JsValueRef callee, _In_ bool isConstructCall, _In_ JsValueRef *arguments, _In_ unsigned short argumentCount, _In_opt_ void *callbackState);
/// <summary>
/// A promise continuation callback.
/// </summary>
/// <remarks>
/// The host can specify a promise continuation callback in <c>JsSetPromiseContinuationCallback</c>. If
/// a script creates a task to be run later, then the promise continuation callback will be called with
/// the task and the task should be put in a FIFO queue, to be run when the current script is
/// done executing.
/// </remarks>
/// <param name="task">The task, represented as a JavaScript function.</param>
/// <param name="callbackState">The data argument to be passed to the callback.</param>
typedef void (CHAKRA_CALLBACK *JsPromiseContinuationCallback)(_In_ JsValueRef task, _In_opt_ void *callbackState);
/// <summary>
/// Creates a new runtime.
/// </summary>
/// <param name="attributes">The attributes of the runtime to be created.</param>
/// <param name="threadService">The thread service for the runtime. Can be null.</param>
/// <param name="runtime">The runtime created.</param>
/// <remarks>In the edge-mode binary, chakra.dll, this function lacks the <c>runtimeVersion</c>
/// parameter (compare to jsrt9.h).</remarks>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsCreateRuntime(
_In_ JsRuntimeAttributes attributes,
_In_opt_ JsThreadServiceCallback threadService,
_Out_ JsRuntimeHandle *runtime);
/// <summary>
/// Performs a full garbage collection.
/// </summary>
/// <param name="runtime">The runtime in which the garbage collection will be performed.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsCollectGarbage(
_In_ JsRuntimeHandle runtime);
/// <summary>
/// Disposes a runtime.
/// </summary>
/// <remarks>
/// Once a runtime has been disposed, all resources owned by it are invalid and cannot be used.
/// If the runtime is active (i.e. it is set to be current on a particular thread), it cannot
/// be disposed.
/// </remarks>
/// <param name="runtime">The runtime to dispose.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsDisposeRuntime(
_In_ JsRuntimeHandle runtime);
/// <summary>
/// Gets the current memory usage for a runtime.
/// </summary>
/// <remarks>
/// Memory usage can be always be retrieved, regardless of whether or not the runtime is active
/// on another thread.
/// </remarks>
/// <param name="runtime">The runtime whose memory usage is to be retrieved.</param>
/// <param name="memoryUsage">The runtime's current memory usage, in bytes.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetRuntimeMemoryUsage(
_In_ JsRuntimeHandle runtime,
_Out_ size_t *memoryUsage);
/// <summary>
/// Gets the current memory limit for a runtime.
/// </summary>
/// <remarks>
/// The memory limit of a runtime can be always be retrieved, regardless of whether or not the
/// runtime is active on another thread.
/// </remarks>
/// <param name="runtime">The runtime whose memory limit is to be retrieved.</param>
/// <param name="memoryLimit">
/// The runtime's current memory limit, in bytes, or -1 if no limit has been set.
/// </param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetRuntimeMemoryLimit(
_In_ JsRuntimeHandle runtime,
_Out_ size_t *memoryLimit);
/// <summary>
/// Sets the current memory limit for a runtime.
/// </summary>
/// <remarks>
/// <para>
/// A memory limit will cause any operation which exceeds the limit to fail with an "out of
/// memory" error. Setting a runtime's memory limit to -1 means that the runtime has no memory
/// limit. New runtimes default to having no memory limit. If the new memory limit exceeds
/// current usage, the call will succeed and any future allocations in this runtime will fail
/// until the runtime's memory usage drops below the limit.
/// </para>
/// <para>
/// A runtime's memory limit can be always be set, regardless of whether or not the runtime is
/// active on another thread.
/// </para>
/// </remarks>
/// <param name="runtime">The runtime whose memory limit is to be set.</param>
/// <param name="memoryLimit">
/// The new runtime memory limit, in bytes, or -1 for no memory limit.
/// </param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsSetRuntimeMemoryLimit(
_In_ JsRuntimeHandle runtime,
_In_ size_t memoryLimit);
/// <summary>
/// Sets a memory allocation callback for specified runtime
/// </summary>
/// <remarks>
/// <para>
/// Registering a memory allocation callback will cause the runtime to call back to the host
/// whenever it acquires memory from, or releases memory to, the OS. The callback routine is
/// called before the runtime memory manager allocates a block of memory. The allocation will
/// be rejected if the callback returns false. The runtime memory manager will also invoke the
/// callback routine after freeing a block of memory, as well as after allocation failures.
/// </para>
/// <para>
/// The callback is invoked on the current runtime execution thread, therefore execution is
/// blocked until the callback completes.
/// </para>
/// <para>
/// The return value of the callback is not stored; previously rejected allocations will not
/// prevent the runtime from invoking the callback again later for new memory allocations.
/// </para>
/// </remarks>
/// <param name="runtime">The runtime for which to register the allocation callback.</param>
/// <param name="callbackState">
/// User provided state that will be passed back to the callback.
/// </param>
/// <param name="allocationCallback">
/// Memory allocation callback to be called for memory allocation events.
/// </param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsSetRuntimeMemoryAllocationCallback(
_In_ JsRuntimeHandle runtime,
_In_opt_ void *callbackState,
_In_ JsMemoryAllocationCallback allocationCallback);
/// <summary>
/// Sets a callback function that is called by the runtime before garbage collection.
/// </summary>
/// <remarks>
/// <para>
/// The callback is invoked on the current runtime execution thread, therefore execution is
/// blocked until the callback completes.
/// </para>
/// <para>
/// The callback can be used by hosts to prepare for garbage collection. For example, by
/// releasing unnecessary references on Chakra objects.
/// </para>
/// </remarks>
/// <param name="runtime">The runtime for which to register the allocation callback.</param>
/// <param name="callbackState">
/// User provided state that will be passed back to the callback.
/// </param>
/// <param name="beforeCollectCallback">The callback function being set.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsSetRuntimeBeforeCollectCallback(
_In_ JsRuntimeHandle runtime,
_In_opt_ void *callbackState,
_In_ JsBeforeCollectCallback beforeCollectCallback);
/// <summary>
/// Adds a reference to a garbage collected object.
/// </summary>
/// <remarks>
/// This only needs to be called on <c>JsRef</c> handles that are not going to be stored
/// somewhere on the stack. Calling <c>JsAddRef</c> ensures that the object the <c>JsRef</c>
/// refers to will not be freed until <c>JsRelease</c> is called.
/// </remarks>
/// <param name="ref">The object to add a reference to.</param>
/// <param name="count">The object's new reference count (can pass in null).</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsAddRef(
_In_ JsRef ref,
_Out_opt_ unsigned int *count);
/// <summary>
/// Releases a reference to a garbage collected object.
/// </summary>
/// <remarks>
/// Removes a reference to a <c>JsRef</c> handle that was created by <c>JsAddRef</c>.
/// </remarks>
/// <param name="ref">The object to add a reference to.</param>
/// <param name="count">The object's new reference count (can pass in null).</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsRelease(
_In_ JsRef ref,
_Out_opt_ unsigned int *count);
/// <summary>
/// Sets a callback function that is called by the runtime before garbage collection of
/// an object.
/// </summary>
/// <remarks>
/// <para>
/// The callback is invoked on the current runtime execution thread, therefore execution is
/// blocked until the callback completes.
/// </para>
/// </remarks>
/// <param name="ref">The object for which to register the callback.</param>
/// <param name="callbackState">
/// User provided state that will be passed back to the callback.
/// </param>
/// <param name="objectBeforeCollectCallback">The callback function being set. Use null to clear
/// previously registered callback.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsSetObjectBeforeCollectCallback(
_In_ JsRef ref,
_In_opt_ void *callbackState,
_In_ JsObjectBeforeCollectCallback objectBeforeCollectCallback);
/// <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>
/// <param name="runtime">The runtime the script context is being created in.</param>
/// <param name="newContext">The created script context.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsCreateContext(
_In_ JsRuntimeHandle runtime,
_Out_ JsContextRef *newContext);
/// <summary>
/// Gets the current script context on the thread.
/// </summary>
/// <param name="currentContext">
/// The current script context on the thread, null if there is no current script context.
/// </param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetCurrentContext(
_Out_ JsContextRef *currentContext);
/// <summary>
/// Sets the current script context on the thread.
/// </summary>
/// <param name="context">The script context to make current.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsSetCurrentContext(
_In_ JsContextRef context);
/// <summary>
/// Gets the script context that the object belongs to.
/// </summary>
/// <param name="object">The object to get the context from.</param>
/// <param name="context">The context the object belongs to.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetContextOfObject(
_In_ JsValueRef object,
_Out_ JsContextRef *context);
/// <summary>
/// Gets the internal data set on JsrtContext.
/// </summary>
/// <param name="context">The context to get the data from.</param>
/// <param name="data">The pointer to the data where data will be returned.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetContextData(
_In_ JsContextRef context,
_Out_ void **data);
/// <summary>
/// Sets the internal data of JsrtContext.
/// </summary>
/// <param name="context">The context to set the data to.</param>
/// <param name="data">The pointer to the data to be set.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsSetContextData(
_In_ JsContextRef context,
_In_ void *data);
/// <summary>
/// Gets the runtime that the context belongs to.
/// </summary>
/// <param name="context">The context to get the runtime from.</param>
/// <param name="runtime">The runtime the context belongs to.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetRuntime(
_In_ JsContextRef context,
_Out_ JsRuntimeHandle *runtime);
/// <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>JsIdle</c> will
/// inform the current runtime that the host is idle and that the runtime can perform
/// memory cleanup tasks.
/// </para>
/// <para>
/// <c>JsIdle</c> can also return the number of system ticks until there will be more idle work
/// for the runtime to do. Calling <c>JsIdle</c> before this number of ticks has passed will do
/// no work.
/// </para>
/// <para>
/// Requires an active script context.
/// </para>
/// </remarks>
/// <param name="nextIdleTick">
/// The next system tick when there will be more idle work to do. Can be null. Returns the
/// maximum number of ticks if there no upcoming idle work to do.
/// </param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsIdle(
_Out_opt_ unsigned int *nextIdleTick);
/// <summary>
/// Gets the symbol associated with the property ID.
/// </summary>
/// <remarks>
/// <para>
/// Requires an active script context.
/// </para>
/// </remarks>
/// <param name="propertyId">The property ID to get the symbol of.</param>
/// <param name="symbol">The symbol associated with the property ID.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetSymbolFromPropertyId(
_In_ JsPropertyIdRef propertyId,
_Out_ JsValueRef *symbol);
/// <summary>
/// Gets the type of property
/// </summary>
/// <remarks>
/// <para>
/// Requires an active script context.
/// </para>
/// </remarks>
/// <param name="propertyId">The property ID to get the type of.</param>
/// <param name="propertyIdType">The JsPropertyIdType of the given property ID</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetPropertyIdType(
_In_ JsPropertyIdRef propertyId,
_Out_ JsPropertyIdType* propertyIdType);
/// <summary>
/// Gets the property ID associated with the symbol.
/// </summary>
/// <remarks>
/// <para>
/// Property IDs are specific to a context and cannot be used across contexts.
/// </para>
/// <para>
/// Requires an active script context.
/// </para>
/// </remarks>
/// <param name="symbol">
/// The symbol whose property ID is being retrieved.
/// </param>
/// <param name="propertyId">The property ID for the given symbol.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetPropertyIdFromSymbol(
_In_ JsValueRef symbol,
_Out_ JsPropertyIdRef *propertyId);
/// <summary>
/// Creates a Javascript symbol.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="description">The string description of the symbol. Can be null.</param>
/// <param name="result">The new symbol.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsCreateSymbol(
_In_ JsValueRef description,
_Out_ JsValueRef *result);
/// <summary>
/// Gets the list of all symbol properties on the object.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="object">The object from which to get the property symbols.</param>
/// <param name="propertySymbols">An array of property symbols.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetOwnPropertySymbols(
_In_ JsValueRef object,
_Out_ JsValueRef *propertySymbols);
/// <summary>
/// Gets the value of <c>undefined</c> in the current script context.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="undefinedValue">The <c>undefined</c> value.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetUndefinedValue(
_Out_ JsValueRef *undefinedValue);
/// <summary>
/// Gets the value of <c>null</c> in the current script context.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="nullValue">The <c>null</c> value.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetNullValue(
_Out_ JsValueRef *nullValue);
/// <summary>
/// Gets the value of <c>true</c> in the current script context.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="trueValue">The <c>true</c> value.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetTrueValue(
_Out_ JsValueRef *trueValue);
/// <summary>
/// Gets the value of <c>false</c> in the current script context.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="falseValue">The <c>false</c> value.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetFalseValue(
_Out_ JsValueRef *falseValue);
/// <summary>
/// Creates a Boolean value from a <c>bool</c> value.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="value">The value to be converted.</param>
/// <param name="booleanValue">The converted value.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsBoolToBoolean(
_In_ bool value,
_Out_ JsValueRef *booleanValue);
/// <summary>
/// Retrieves the <c>bool</c> value of a Boolean value.
/// </summary>
/// <param name="value">The value to be converted.</param>
/// <param name="boolValue">The converted value.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsBooleanToBool(
_In_ JsValueRef value,
_Out_ bool *boolValue);
/// <summary>
/// Converts the value to Boolean using standard JavaScript semantics.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="value">The value to be converted.</param>
/// <param name="booleanValue">The converted value.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsConvertValueToBoolean(
_In_ JsValueRef value,
_Out_ JsValueRef *booleanValue);
/// <summary>
/// Gets the JavaScript type of a JsValueRef.
/// </summary>
/// <param name="value">The value whose type is to be returned.</param>
/// <param name="type">The type of the value.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetValueType(
_In_ JsValueRef value,
_Out_ JsValueType *type);
/// <summary>
/// Creates a number value from a <c>double</c> value.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="doubleValue">The <c>double</c> to convert to a number value.</param>
/// <param name="value">The new number value.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsDoubleToNumber(
_In_ double doubleValue,
_Out_ JsValueRef *value);
/// <summary>
/// Creates a number value from an <c>int</c> value.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="intValue">The <c>int</c> to convert to a number value.</param>
/// <param name="value">The new number value.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsIntToNumber(
_In_ int intValue,
_Out_ JsValueRef *value);
/// <summary>
/// Retrieves the <c>double</c> value of a number value.
/// </summary>
/// <remarks>
/// This function retrieves the value of a number value. It will fail with
/// <c>JsErrorInvalidArgument</c> if the type of the value is not number.
/// </remarks>
/// <param name="value">The number value to convert to a <c>double</c> value.</param>
/// <param name="doubleValue">The <c>double</c> value.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsNumberToDouble(
_In_ JsValueRef value,
_Out_ double *doubleValue);
/// <summary>
/// Retrieves the <c>int</c> value of a number value.
/// </summary>
/// <remarks>
/// This function retrieves the value of a number value and converts to an <c>int</c> value.
/// It will fail with <c>JsErrorInvalidArgument</c> if the type of the value is not number.
/// </remarks>
/// <param name="value">The number value to convert to an <c>int</c> value.</param>
/// <param name="intValue">The <c>int</c> value.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsNumberToInt(
_In_ JsValueRef value,
_Out_ int *intValue);
/// <summary>
/// Converts the value to number using standard JavaScript semantics.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="value">The value to be converted.</param>
/// <param name="numberValue">The converted value.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsConvertValueToNumber(
_In_ JsValueRef value,
_Out_ JsValueRef *numberValue);
/// <summary>
/// Gets the length of a string value.
/// </summary>
/// <param name="stringValue">The string value to get the length of.</param>
/// <param name="length">The length of the string.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetStringLength(
_In_ JsValueRef stringValue,
_Out_ int *length);
/// <summary>
/// Converts the value to string using standard JavaScript semantics.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="value">The value to be converted.</param>
/// <param name="stringValue">The converted value.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsConvertValueToString(
_In_ JsValueRef value,
_Out_ JsValueRef *stringValue);
/// <summary>
/// Gets the global object in the current script context.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="globalObject">The global object.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetGlobalObject(
_Out_ JsValueRef *globalObject);
/// <summary>
/// Creates a new object.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="object">The new object.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsCreateObject(
_Out_ JsValueRef *object);
/// <summary>
/// Creates a new object 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="finalizeCallback">
/// A callback for when the object is finalized. May be null.
/// </param>
/// <param name="object">The new object.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsCreateExternalObject(
_In_opt_ void *data,
_In_opt_ JsFinalizeCallback finalizeCallback,
_Out_ JsValueRef *object);
/// <summary>
/// Converts the value to object using standard JavaScript semantics.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="value">The value to be converted.</param>
/// <param name="object">The converted value.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsConvertValueToObject(
_In_ JsValueRef value,
_Out_ JsValueRef *object);
/// <summary>
/// Returns the prototype of an object.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="object">The object whose prototype is to be returned.</param>
/// <param name="prototypeObject">The object's prototype.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetPrototype(
_In_ JsValueRef object,
_Out_ JsValueRef *prototypeObject);
/// <summary>
/// Sets the prototype of an object.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="object">The object whose prototype is to be changed.</param>
/// <param name="prototypeObject">The object's new prototype.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsSetPrototype(
_In_ JsValueRef object,
_In_ JsValueRef prototypeObject);
/// <summary>
/// Performs JavaScript "instanceof" operator test.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="object">The object to test.</param>
/// <param name="constructor">The constructor function to test against.</param>
/// <param name="result">Whether "object instanceof constructor" is true.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsInstanceOf(
_In_ JsValueRef object,
_In_ JsValueRef constructor,
_Out_ bool *result);
/// <summary>
/// Returns a value that indicates whether an object is extensible or not.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="object">The object to test.</param>
/// <param name="value">Whether the object is extensible or not.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetExtensionAllowed(
_In_ JsValueRef object,
_Out_ bool *value);
/// <summary>
/// Makes an object non-extensible.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="object">The object to make non-extensible.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsPreventExtension(
_In_ JsValueRef object);
/// <summary>
/// Gets an object's property.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="object">The object that contains the property.</param>
/// <param name="propertyId">The ID of the property.</param>
/// <param name="value">The value of the property.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetProperty(
_In_ JsValueRef object,
_In_ JsPropertyIdRef propertyId,
_Out_ JsValueRef *value);
/// <summary>
/// Gets a property descriptor for an object's own property.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="object">The object that has the property.</param>
/// <param name="propertyId">The ID of the property.</param>
/// <param name="propertyDescriptor">The property descriptor.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetOwnPropertyDescriptor(
_In_ JsValueRef object,
_In_ JsPropertyIdRef propertyId,
_Out_ JsValueRef *propertyDescriptor);
/// <summary>
/// Gets the list of all properties on the object.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="object">The object from which to get the property names.</param>
/// <param name="propertyNames">An array of property names.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetOwnPropertyNames(
_In_ JsValueRef object,
_Out_ JsValueRef *propertyNames);
/// <summary>
/// Puts an object's property.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="object">The object that contains the property.</param>
/// <param name="propertyId">The ID of the property.</param>
/// <param name="value">The new value of the property.</param>
/// <param name="useStrictRules">The property set should follow strict mode rules.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsSetProperty(
_In_ JsValueRef object,
_In_ JsPropertyIdRef propertyId,
_In_ JsValueRef value,
_In_ bool useStrictRules);
/// <summary>
/// Determines whether an object has a property.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="object">The object that may contain the property.</param>
/// <param name="propertyId">The ID of the property.</param>
/// <param name="hasProperty">Whether the object (or a prototype) has the property.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsHasProperty(
_In_ JsValueRef object,
_In_ JsPropertyIdRef propertyId,
_Out_ bool *hasProperty);
/// <summary>
/// Deletes an object's property.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="object">The object that contains the property.</param>
/// <param name="propertyId">The ID of the property.</param>
/// <param name="useStrictRules">The property set should follow strict mode rules.</param>
/// <param name="result">Whether the property was deleted.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsDeleteProperty(
_In_ JsValueRef object,
_In_ JsPropertyIdRef propertyId,
_In_ bool useStrictRules,
_Out_ JsValueRef *result);
/// <summary>
/// Defines a new object's own property from a property descriptor.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="object">The object that has the property.</param>
/// <param name="propertyId">The ID of the property.</param>
/// <param name="propertyDescriptor">The property descriptor.</param>
/// <param name="result">Whether the property was defined.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsDefineProperty(
_In_ JsValueRef object,
_In_ JsPropertyIdRef propertyId,
_In_ JsValueRef propertyDescriptor,
_Out_ bool *result);
/// <summary>
/// Tests whether an object has a value at the specified index.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="object">The object to operate on.</param>
/// <param name="index">The index to test.</param>
/// <param name="result">Whether the object has a value at the specified index.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsHasIndexedProperty(
_In_ JsValueRef object,
_In_ JsValueRef index,
_Out_ bool *result);
/// <summary>
/// Retrieve the value at the specified index of an object.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="object">The object to operate on.</param>
/// <param name="index">The index to retrieve.</param>
/// <param name="result">The retrieved value.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetIndexedProperty(
_In_ JsValueRef object,
_In_ JsValueRef index,
_Out_ JsValueRef *result);
/// <summary>
/// Set the value at the specified index of an object.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="object">The object to operate on.</param>
/// <param name="index">The index to set.</param>
/// <param name="value">The value to set.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsSetIndexedProperty(
_In_ JsValueRef object,
_In_ JsValueRef index,
_In_ JsValueRef value);
/// <summary>
/// Delete the value at the specified index of an object.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="object">The object to operate on.</param>
/// <param name="index">The index to delete.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsDeleteIndexedProperty(
_In_ JsValueRef object,
_In_ JsValueRef index);
/// <summary>
/// Determines whether an object has its indexed properties in external data.
/// </summary>
/// <param name="object">The object.</param>
/// <param name="value">Whether the object has its indexed properties in external data.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsHasIndexedPropertiesExternalData(
_In_ JsValueRef object,
_Out_ bool* value);
/// <summary>
/// Retrieves an object's indexed properties external data information.
/// </summary>
/// <param name="object">The object.</param>
/// <param name="data">The external data back store for the object's indexed properties.</param>
/// <param name="arrayType">The array element type in external data.</param>
/// <param name="elementLength">The number of array elements in external data.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetIndexedPropertiesExternalData(
_In_ JsValueRef object,
_Out_ void** data,
_Out_ JsTypedArrayType* arrayType,
_Out_ unsigned int* elementLength);
/// <summary>
/// Sets an object's indexed properties to external data. The external data will be used as back
/// store for the object's indexed properties and accessed like a typed array.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="object">The object to operate on.</param>
/// <param name="data">The external data to be used as back store for the object's indexed properties.</param>
/// <param name="arrayType">The array element type in external data.</param>
/// <param name="elementLength">The number of array elements in external data.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsSetIndexedPropertiesToExternalData(
_In_ JsValueRef object,
_In_ void* data,
_In_ JsTypedArrayType arrayType,
_In_ unsigned int elementLength);
/// <summary>
/// Compare two JavaScript values for equality.
/// </summary>
/// <remarks>
/// <para>
/// This function is equivalent to the <c>==</c> operator in Javascript.
/// </para>
/// <para>
/// Requires an active script context.
/// </para>
/// </remarks>
/// <param name="object1">The first object to compare.</param>
/// <param name="object2">The second object to compare.</param>
/// <param name="result">Whether the values are equal.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsEquals(
_In_ JsValueRef object1,
_In_ JsValueRef object2,
_Out_ bool *result);
/// <summary>
/// Compare two JavaScript values for strict equality.
/// </summary>
/// <remarks>
/// <para>
/// This function is equivalent to the <c>===</c> operator in Javascript.
/// </para>
/// <para>
/// Requires an active script context.
/// </para>
/// </remarks>
/// <param name="object1">The first object to compare.</param>
/// <param name="object2">The second object to compare.</param>
/// <param name="result">Whether the values are strictly equal.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsStrictEquals(
_In_ JsValueRef object1,
_In_ JsValueRef object2,
_Out_ bool *result);
/// <summary>
/// Determines whether an object is an external object.
/// </summary>
/// <param name="object">The object.</param>
/// <param name="value">Whether the object is an external object.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsHasExternalData(
_In_ JsValueRef object,
_Out_ bool *value);
/// <summary>
/// Retrieves the data from an external object.
/// </summary>
/// <param name="object">The external object.</param>
/// <param name="externalData">
/// The external data stored in the object. Can be null if no external data is stored in the
/// object.
/// </param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetExternalData(
_In_ JsValueRef object,
_Out_ void **externalData);
/// <summary>
/// Sets the external data on an external object.
/// </summary>
/// <param name="object">The external object.</param>
/// <param name="externalData">
/// The external data to be stored in the object. Can be null if no external data is
/// to be stored in the object.
/// </param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsSetExternalData(
_In_ JsValueRef object,
_In_opt_ void *externalData);
/// <summary>
/// Creates a Javascript array object.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="length">The initial length of the array.</param>
/// <param name="result">The new array object.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsCreateArray(
_In_ unsigned int length,
_Out_ JsValueRef *result);
/// <summary>
/// Creates a Javascript ArrayBuffer object.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="byteLength">
/// The number of bytes in the ArrayBuffer.
/// </param>
/// <param name="result">The new ArrayBuffer object.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsCreateArrayBuffer(
_In_ unsigned int byteLength,
_Out_ JsValueRef *result);
/// <summary>
/// Creates a Javascript ArrayBuffer object to access external memory.
/// </summary>
/// <remarks>Requires an active script context.</remarks>
/// <param name="data">A pointer to the external memory.</param>
/// <param name="byteLength">The number of bytes in the external memory.</param>
/// <param name="finalizeCallback">A callback for when the object is finalized. May be null.</param>
/// <param name="callbackState">User provided state that will be passed back to finalizeCallback.</param>
/// <param name="result">The new ArrayBuffer object.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsCreateExternalArrayBuffer(
_Pre_maybenull_ _Pre_writable_byte_size_(byteLength) void *data,
_In_ unsigned int byteLength,
_In_opt_ JsFinalizeCallback finalizeCallback,
_In_opt_ void *callbackState,
_Out_ JsValueRef *result);
/// <summary>
/// Creates a Javascript typed array object.
/// </summary>
/// <remarks>
/// <para>
/// The <c>baseArray</c> can be an <c>ArrayBuffer</c>, another typed array, or a JavaScript
/// <c>Array</c>. The returned typed array will use the baseArray if it is an ArrayBuffer, or
/// otherwise create and use a copy of the underlying source array.
/// </para>
/// <para>
/// Requires an active script context.
/// </para>
/// </remarks>
/// <param name="arrayType">The type of the array to create.</param>
/// <param name="baseArray">
/// The base array of the new array. Use <c>JS_INVALID_REFERENCE</c> if no base array.
/// </param>
/// <param name="byteOffset">
/// The offset in bytes from the start of baseArray (ArrayBuffer) for result typed array to reference.
/// Only applicable when baseArray is an ArrayBuffer object. Must be 0 otherwise.
/// </param>
/// <param name="elementLength">
/// The number of elements in the array. Only applicable when creating a new typed array without
/// baseArray (baseArray is <c>JS_INVALID_REFERENCE</c>) or when baseArray is an ArrayBuffer object.
/// Must be 0 otherwise.
/// </param>
/// <param name="result">The new typed array object.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsCreateTypedArray(
_In_ JsTypedArrayType arrayType,
_In_ JsValueRef baseArray,
_In_ unsigned int byteOffset,
_In_ unsigned int elementLength,
_Out_ JsValueRef *result);
/// <summary>
/// Creates a Javascript DataView object.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="arrayBuffer">
/// An existing ArrayBuffer object to use as the storage for the result DataView object.
/// </param>
/// <param name="byteOffset">
/// The offset in bytes from the start of arrayBuffer for result DataView to reference.
/// </param>
/// <param name="byteLength">
/// The number of bytes in the ArrayBuffer for result DataView to reference.
/// </param>
/// <param name="result">The new DataView object.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsCreateDataView(
_In_ JsValueRef arrayBuffer,
_In_ unsigned int byteOffset,
_In_ unsigned int byteLength,
_Out_ JsValueRef *result);
/// <summary>
/// Obtains frequently used properties of a typed array.
/// </summary>
/// <param name="typedArray">The typed array instance.</param>
/// <param name="arrayType">The type of the array.</param>
/// <param name="arrayBuffer">The ArrayBuffer backstore of the array.</param>
/// <param name="byteOffset">The offset in bytes from the start of arrayBuffer referenced by the array.</param>
/// <param name="byteLength">The number of bytes in the array.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetTypedArrayInfo(
_In_ JsValueRef typedArray,
_Out_opt_ JsTypedArrayType *arrayType,
_Out_opt_ JsValueRef *arrayBuffer,
_Out_opt_ unsigned int *byteOffset,
_Out_opt_ unsigned int *byteLength);
/// <summary>
/// Obtains the underlying memory storage used by an <c>ArrayBuffer</c>.
/// </summary>
/// <param name="arrayBuffer">The ArrayBuffer instance.</param>
/// <param name="buffer">
/// The ArrayBuffer's buffer. The lifetime of the buffer returned is the same as the lifetime of the
/// the ArrayBuffer. The buffer pointer does not count as a reference to the ArrayBuffer for the purpose
/// of garbage collection.
/// </param>
/// <param name="bufferLength">The number of bytes in the buffer.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetArrayBufferStorage(
_In_ JsValueRef arrayBuffer,
_Outptr_result_bytebuffer_(*bufferLength) ChakraBytePtr *buffer,
_Out_ unsigned int *bufferLength);
/// <summary>
/// Obtains the underlying memory storage used by a typed array.
/// </summary>
/// <param name="typedArray">The typed array instance.</param>
/// <param name="buffer">
/// The array's buffer. The lifetime of the buffer returned is the same as the lifetime of the
/// the array. The buffer pointer does not count as a reference to the array for the purpose
/// of garbage collection.
/// </param>
/// <param name="bufferLength">The number of bytes in the buffer.</param>
/// <param name="arrayType">The type of the array.</param>
/// <param name="elementSize">
/// The size of an element of the array.
/// </param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetTypedArrayStorage(
_In_ JsValueRef typedArray,
_Outptr_result_bytebuffer_(*bufferLength) ChakraBytePtr *buffer,
_Out_ unsigned int *bufferLength,
_Out_opt_ JsTypedArrayType *arrayType,
_Out_opt_ int *elementSize);
/// <summary>
/// Obtains the underlying memory storage used by a DataView.
/// </summary>
/// <param name="dataView">The DataView instance.</param>
/// <param name="buffer">
/// The DataView's buffer. The lifetime of the buffer returned is the same as the lifetime of the
/// the DataView. The buffer pointer does not count as a reference to the DataView for the purpose
/// of garbage collection.
/// </param>
/// <param name="bufferLength">The number of bytes in the buffer.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetDataViewStorage(
_In_ JsValueRef dataView,
_Outptr_result_bytebuffer_(*bufferLength) ChakraBytePtr *buffer,
_Out_ unsigned int *bufferLength);
/// <summary>
/// Invokes a function.
/// </summary>
/// <remarks>
/// Requires thisArg as first argument of arguments.
/// Requires an active script context.
/// </remarks>
/// <param name="function">The function to invoke.</param>
/// <param name="arguments">The arguments to the call.</param>
/// <param name="argumentCount">The number of arguments being passed in to the function.</param>
/// <param name="result">The value returned from the function invocation, if any.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsCallFunction(
_In_ JsValueRef function,
_In_reads_(argumentCount) JsValueRef *arguments,
_In_ unsigned short argumentCount,
_Out_opt_ JsValueRef *result);
/// <summary>
/// Invokes a function as a constructor.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="function">The function to invoke as a constructor.</param>
/// <param name="arguments">The arguments to the call.</param>
/// <param name="argumentCount">The number of arguments being passed in to the function.</param>
/// <param name="result">The value returned from the function invocation.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsConstructObject(
_In_ JsValueRef function,
_In_reads_(argumentCount) JsValueRef *arguments,
_In_ unsigned short argumentCount,
_Out_ JsValueRef *result);
/// <summary>
/// Creates a new JavaScript function.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="nativeFunction">The method to call when the function is invoked.</param>
/// <param name="callbackState">
/// User provided state that will be passed back to the callback.
/// </param>
/// <param name="function">The new function object.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsCreateFunction(
_In_ JsNativeFunction nativeFunction,
_In_opt_ void *callbackState,
_Out_ JsValueRef *function);
/// <summary>
/// Creates a new JavaScript function with name.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="name">The name of this function that will be used for diagnostics and stringification purposes.</param>
/// <param name="nativeFunction">The method to call when the function is invoked.</param>
/// <param name="callbackState">
/// User provided state that will be passed back to the callback.
/// </param>
/// <param name="function">The new function object.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsCreateNamedFunction(
_In_ JsValueRef name,
_In_ JsNativeFunction nativeFunction,
_In_opt_ void *callbackState,
_Out_ JsValueRef *function);
/// <summary>
/// Creates a new JavaScript error object
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="message">Message for the error object.</param>
/// <param name="error">The new error object.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsCreateError(
_In_ JsValueRef message,
_Out_ JsValueRef *error);
/// <summary>
/// Creates a new JavaScript RangeError error object
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="message">Message for the error object.</param>
/// <param name="error">The new error object.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsCreateRangeError(
_In_ JsValueRef message,
_Out_ JsValueRef *error);
/// <summary>
/// Creates a new JavaScript ReferenceError error object
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="message">Message for the error object.</param>
/// <param name="error">The new error object.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsCreateReferenceError(
_In_ JsValueRef message,
_Out_ JsValueRef *error);
/// <summary>
/// Creates a new JavaScript SyntaxError error object
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="message">Message for the error object.</param>
/// <param name="error">The new error object.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsCreateSyntaxError(
_In_ JsValueRef message,
_Out_ JsValueRef *error);
/// <summary>
/// Creates a new JavaScript TypeError error object
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="message">Message for the error object.</param>
/// <param name="error">The new error object.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsCreateTypeError(
_In_ JsValueRef message,
_Out_ JsValueRef *error);
/// <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>
/// <param name="error">The new error object.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsCreateURIError(
_In_ JsValueRef message,
_Out_ JsValueRef *error);
/// <summary>
/// Determines whether the runtime of the current context is in an exception state.
/// </summary>
/// <remarks>
/// <para>
/// If a call into the runtime results in an exception (either as the result of running a
/// script or due to something like a conversion failure), the runtime is placed into an
/// "exception state." All calls into any context created by the runtime (except for the
/// exception APIs) will fail with <c>JsErrorInExceptionState</c> until the exception is
/// cleared.
/// </para>
/// <para>
/// If the runtime of the current context is in the exception state when a callback returns
/// into the engine, the engine will automatically rethrow the exception.
/// </para>
/// <para>
/// Requires an active script context.
/// </para>
/// </remarks>
/// <param name="hasException">
/// Whether the runtime of the current context is in the exception state.
/// </param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsHasException(
_Out_ bool *hasException);
/// <summary>
/// Returns the 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 return
/// <c>JsErrorInvalidArgument</c>. 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>
/// <param name="exception">The exception for the runtime of the current context.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetAndClearException(
_Out_ JsValueRef *exception);
/// <summary>
/// Sets the runtime of the current context to an exception state.
/// </summary>
/// <remarks>
/// <para>
/// If the runtime of the current context is already in an exception state, this API will
/// return <c>JsErrorInExceptionState</c>.
/// </para>
/// <para>
/// Requires an active script context.
/// </para>
/// </remarks>
/// <param name="exception">
/// The JavaScript exception to set for the runtime of the current context.
/// </param>
/// <returns>
/// JsNoError if the engine was set into an exception state, a failure code otherwise.
/// </returns>
CHAKRA_API
JsSetException(
_In_ JsValueRef exception);
/// <summary>
/// Suspends script execution and terminates any running scripts in a runtime.
/// </summary>
/// <remarks>
/// <para>
/// Calls to a suspended runtime will fail until <c>JsEnableRuntimeExecution</c> is called.
/// </para>
/// <para>
/// This API does not have to be called on the thread the runtime is active on. Although the
/// runtime will be set into a suspended state, an executing script may not be suspended
/// immediately; a running script will be terminated with an uncatchable exception as soon as
/// possible.
/// </para>
/// <para>
/// Suspending execution in a runtime that is already suspended is a no-op.
/// </para>
/// </remarks>
/// <param name="runtime">The runtime to be suspended.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsDisableRuntimeExecution(
_In_ JsRuntimeHandle runtime);
/// <summary>
/// Enables script execution in a runtime.
/// </summary>
/// <remarks>
/// Enabling script execution in a runtime that already has script execution enabled is a
/// no-op.
/// </remarks>
/// <param name="runtime">The runtime to be enabled.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsEnableRuntimeExecution(
_In_ JsRuntimeHandle runtime);
/// <summary>
/// Returns a value that indicates whether script execution is disabled in the runtime.
/// </summary>
/// <param name="runtime">Specifies the runtime to check if execution is disabled.</param>
/// <param name="isDisabled">If execution is disabled, <c>true</c>, <c>false</c> otherwise.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsIsRuntimeExecutionDisabled(
_In_ JsRuntimeHandle runtime,
_Out_ bool *isDisabled);
/// <summary>
/// Sets a promise continuation callback function that is called by the context when a task
/// needs to be queued for future execution
/// </summary>
/// <remarks>
/// <para>
/// Requires an active script context.
/// </para>
/// </remarks>
/// <param name="promiseContinuationCallback">The callback function being set.</param>
/// <param name="callbackState">
/// User provided state that will be passed back to the callback.
/// </param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsSetPromiseContinuationCallback(
_In_opt_ JsPromiseContinuationCallback promiseContinuationCallback,
_In_opt_ void *callbackState);
#ifdef _WIN32
#include "ChakraCommonWindows.h"
#endif // _WIN32
#endif // _CHAKRACOMMON_H_
================================================
FILE: include/ChakraCore.h
================================================
//-------------------------------------------------------------------------------------------------------
// Copyright (C) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE.txt file in the project root for full license information.
//-------------------------------------------------------------------------------------------------------
/// \mainpage Chakra Hosting API Reference
///
/// Chakra is Microsoft's JavaScript engine. It is an integral part of Internet Explorer but can
/// also be hosted independently by other applications. This reference describes the APIs available
/// to applications to host Chakra.
///
/// \file
/// \brief The Chakra Core hosting API.
///
/// This file contains a flat C API layer. This is the API exported by ChakraCore.dll.
#ifdef _MSC_VER
#pragma once
#endif // _MSC_VER
#ifndef _CHAKRACORE_H_
#define _CHAKRACORE_H_
#if !defined(NTBUILD) && !defined(_CHAKRACOREBUILD)
#define _CHAKRACOREBUILD
#endif
#include "ChakraCommon.h"
#include "ChakraDebug.h"
// Begin ChakraCore only APIs
#ifdef _CHAKRACOREBUILD
/// <summary>
/// A reference to an ES module.
/// </summary>
/// <remarks>
/// A module record represents an ES module.
/// </remarks>
typedef void* JsModuleRecord;
/// <summary>
/// A reference to an object owned by the SharedArrayBuffer.
/// </summary>
/// <remarks>
/// This represents SharedContents which is heap allocated object, it can be passed through
/// different runtimes to share the underlying buffer.
/// </remarks>
typedef void *JsSharedArrayBufferContentHandle;
/// <summary>
/// Flags for parsing a module.
/// </summary>
typedef enum JsParseModuleSourceFlags
{
/// <summary>
/// Module source is UTF16.
/// </summary>
JsParseModuleSourceFlags_DataIsUTF16LE = 0x00000000,
/// <summary>
/// Module source is UTF8.
/// </summary>
JsParseModuleSourceFlags_DataIsUTF8 = 0x00000001
} JsParseModuleSourceFlags;
/// <summary>
/// The types of host info that can be set on a module record with JsSetModuleHostInfo.
/// </summary>
/// <remarks>
/// For more information see JsSetModuleHostInfo.
/// </remarks>
typedef enum JsModuleHostInfoKind
{
/// <summary>
/// An exception object - e.g. if the module file cannot be found.
/// </summary>
JsModuleHostInfo_Exception = 0x01,
/// <summary>
/// Host defined info.
/// </summary>
JsModuleHostInfo_HostDefined = 0x02,
/// <summary>
/// Callback for receiving notification when module is ready.
/// </summary>
JsModuleHostInfo_NotifyModuleReadyCallback = 0x3,
/// <summary>
/// Callback for receiving notification to fetch a dependent module.
/// </summary>
JsModuleHostInfo_FetchImportedModuleCallback = 0x4,
/// <summary>
/// Callback for receiving notification for calls to ```import()```
/// </summary>
JsModuleHostInfo_FetchImportedModuleFromScriptCallback = 0x5,
/// <summary>
/// URL for use in error stack traces and debugging.
/// </summary>
JsModuleHostInfo_Url = 0x6
} JsModuleHostInfoKind;
/// <summary>
/// The possible states for a Promise object.
/// </summary>
typedef enum _JsPromiseState
{
JsPromiseStatePending = 0x0,
JsPromiseStateFulfilled = 0x1,
JsPromiseStateRejected = 0x2
} JsPromiseState;
/// <summary>
/// User implemented callback to fetch additional imported modules in ES modules.
/// </summary>
/// <remarks>
/// The callback is invoked on the current runtime execution thread, therefore execution is blocked until
/// the callback completes. Notify the host to fetch the dependent module. This is the "import" part
/// before HostResolveImportedModule in ES6 spec. This notifies the host that the referencing module has
/// the specified module dependency, and the host needs to retrieve the module back.
///
/// Callback should:
/// 1. Check if the requested module has been requested before - if yes return the existing
/// module record
/// 2. If no create and initialize a new module record with JsInitializeModuleRecord to
/// return and schedule a call to JsParseModuleSource for the new record.
/// </remarks>
/// <param name="referencingModule">The referencing module that is requesting the dependent module.</param>
/// <param name="specifier">The specifier coming from the module source code.</param>
/// <param name="dependentModuleRecord">The ModuleRecord of the dependent module. If the module was requested
/// before from other source, return the existing ModuleRecord, otherwise
/// return a newly created ModuleRecord.</param>
/// <returns>
/// Returns a <c>JsNoError</c> if the operation succeeded an error code otherwise.
/// </returns>
typedef JsErrorCode(CHAKRA_CALLBACK * FetchImportedModuleCallBack)(_In_ JsModuleRecord referencingModule, _In_ JsValueRef specifier, _Outptr_result_maybenull_ JsModuleRecord* dependentModuleRecord);
/// <summary>
/// User implemented callback to fetch imported modules dynamically in scripts.
/// </summary>
/// <remarks>
/// The callback is invoked on the current runtime execution thread, therefore execution is blocked untill
/// the callback completes. Notify the host to fetch the dependent module. This is used for the dynamic
/// import() syntax.
///
/// Callback should:
/// 1. Check if the requested module has been requested before - if yes return the existing module record
/// 2. If no create and initialize a new module record with JsInitializeModuleRecord to return and
/// schedule a call to JsParseModuleSource for the new record.
/// </remarks>
/// <param name="dwReferencingSourceContext">The referencing script context that calls import()</param>
/// <param name="specifier">The specifier provided to the import() call.</param>
/// <param name="dependentModuleRecord">The ModuleRecord of the dependent module. If the module was requested
/// before from other source, return the existing ModuleRecord, otherwise
/// return a newly created ModuleRecord.</param>
/// <returns>
/// Returns <c>JsNoError</c> if the operation succeeded or an error code otherwise.
/// </returns>
typedef JsErrorCode(CHAKRA_CALLBACK * FetchImportedModuleFromScriptCallBack)(_In_ JsSourceContext dwReferencingSourceContext, _In_ JsValueRef specifier, _Outptr_result_maybenull_ JsModuleRecord* dependentModuleRecord);
/// <summary>
/// User implemented callback to get notification when the module is ready.
/// </summary>
/// <remarks>
/// The callback is invoked on the current runtime execution thread, therefore execution is blocked until the
/// callback completes. This callback should schedule a call to JsEvaluateModule to run the module that has been loaded.
/// </remarks>
/// <param name="referencingModule">The referencing module that has finished running ModuleDeclarationInstantiation step.</param>
/// <param name="exceptionVar">If nullptr, the module is successfully initialized and host should queue the execution job
/// otherwise it's the exception object.</param>
/// <returns>
/// Returns a JsErrorCode - note, the return value is ignored.
/// </returns>
typedef JsErrorCode(CHAKRA_CALLBACK * NotifyModuleReadyCallback)(_In_opt_ JsModuleRecord referencingModule, _In_opt_ JsValueRef exceptionVar);
/// <summary>
/// A structure containing information about a native function callback.
/// </summary>
typedef struct JsNativeFunctionInfo
{
JsValueRef thisArg;
JsValueRef newTargetArg;
bool isConstructCall;
}JsNativeFunctionInfo;
/// <summary>
/// A function callback.
/// </summary>
/// <param name="callee">
/// A function object that represents the function being invoked.
/// </param>
/// <param name="arguments">The arguments to the call.</param>
/// <param name="argumentCount">The number of arguments.</param>
/// <param name="info">Additional information about this function call.</param>
/// <param name="callbackState">
/// The state passed to <c>JsCreateFunction</c>.
/// </param>
/// <returns>The result of the call, if any.</returns>
typedef _Ret_maybenull_ JsValueRef(CHAKRA_CALLBACK * JsEnhancedNativeFunction)(_In_ JsValueRef callee, _In_ JsValueRef *arguments, _In_ unsigned short argumentCount, _In_ JsNativeFunctionInfo *info, _In_opt_ void *callbackState);
/// <summary>
/// A Promise Rejection Tracker callback.
/// </summary>
/// <remarks>
/// The host can specify a promise rejection tracker callback in <c>JsSetHostPromiseRejectionTracker</c>.
/// If a promise is rejected with no reactions or a reaction is added to a promise that was rejected
/// before it had reactions by default nothing is done.
/// A Promise Rejection Tracker callback may be set - which will then be called when this occurs.
/// Note - per draft ECMASpec 2018 25.4.1.9 this function should not set or return an exception
/// Note also the promise and reason parameters may be garbage collected after this function is called
/// if you wish to make further use of them you will need to use JsAddRef to preserve them
/// However if you use JsAddRef you must also call JsRelease and not hold unto them after
/// a handled notification (both per spec and to avoid memory leaks)
/// </remarks>
/// <param name="promise">The promise object, represented as a JsValueRef.</param>
/// <param name="reason">The value/cause of the rejection, represented as a JsValueRef.</param>
/// <param name="handled">Boolean - false for promiseRejected: i.e. if the promise has just been rejected with no handler,
/// true for promiseHandled: i.e. if it was rejected before without a handler and is now being handled.</param>
/// <param name="callbackState">The state passed to <c>JsSetHostPromiseRejectionTracker</c>.</param>
typedef void (CHAKRA_CALLBACK *JsHostPromiseRejectionTrackerCallback)(_In_ JsValueRef promise, _In_ JsValueRef reason, _In_ bool handled, _In_opt_ void *callbackState);
/// <summary>
/// Creates a new enhanced JavaScript function.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="nativeFunction">The method to call when the function is invoked.</param>
/// <param name="metadata">If this is not <c>JS_INVALID_REFERENCE</c>, it is converted to a string and used as the name of the function.</param>
/// <param name="callbackState">
/// User provided state that will be passed back to the callback.
/// </param>
/// <param name="function">The new function object.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsCreateEnhancedFunction(
_In_ JsEnhancedNativeFunction nativeFunction,
_In_opt_ JsValueRef metadata,
_In_opt_ void *callbackState,
_Out_ JsValueRef *function);
/// <summary>
/// Initialize a ModuleRecord from host
/// </summary>
/// <remarks>
/// Bootstrap the module loading process by creating a new module record.
/// </remarks>
/// <param name="referencingModule">The parent module of the new module - nullptr for a root module.</param>
/// <param name="normalizedSpecifier">The normalized specifier for the module.</param>
/// <param name="moduleRecord">The new module record. The host should not try to call this API twice
/// with the same normalizedSpecifier.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsInitializeModuleRecord(
_In_opt_ JsModuleRecord referencingModule,
_In_ JsValueRef normalizedSpecifier,
_Outptr_result_maybenull_ JsModuleRecord* moduleRecord);
/// <summary>
/// Parse the source for an ES module
/// </summary>
/// <remarks>
/// This is basically ParseModule operation in ES6 spec. It is slightly different in that:
/// a) The ModuleRecord was initialized earlier, and passed in as an argument.
/// b) This includes a check to see if the module being Parsed is the last module in the
/// dependency tree. If it is it automatically triggers Module Instantiation.
/// </remarks>
/// <param name="requestModule">The ModuleRecord being parsed.</param>
/// <param name="sourceContext">A cookie identifying the script that can be used by debuggable script contexts.</param>
/// <param name="script">The source script to be parsed, but not executed in this code.</param>
/// <param name="scriptLength">The length of sourceText in bytes. As the input might contain a embedded null.</param>
/// <param name="sourceFlag">The type of the source code passed in. It could be utf16 or utf8 at this time.</param>
/// <param name="exceptionValueRef">The error object if there is parse error.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsParseModuleSource(
_In_ JsModuleRecord requestModule,
_In_ JsSourceContext sourceContext,
_In_ BYTE* script,
_In_ unsigned int scriptLength,
_In_ JsParseModuleSourceFlags sourceFlag,
_Outptr_result_maybenull_ JsValueRef* exceptionValueRef);
/// <summary>
/// Execute module code.
/// </summary>
/// <remarks>
/// This method implements 15.2.1.1.6.5, "ModuleEvaluation" concrete method.
/// This method should be called after the engine notifies the host that the module is ready.
/// This method only needs to be called on root modules - it will execute all of the dependent modules.
///
/// One moduleRecord will be executed only once. Additional execution call on the same moduleRecord will fail.
/// </remarks>
/// <param name="requestModule">The ModuleRecord being executed.</param>
/// <param name="result">The return value of the module.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsModuleEvaluation(
_In_ JsModuleRecord requestModule,
_Outptr_result_maybenull_ JsValueRef* result);
/// <summary>
/// Set host info for the specified module.
/// </summary>
/// <remarks>
/// This is used for four things:
/// 1. Setting up the callbacks for module loading - note these are actually
/// set on the current Context not the module so only have to be set for
/// the first root module in any given context.
/// 2. Setting host defined info on a module record - can be anything that
/// you wish to associate with your modules.
/// 3. Setting a URL for a module to be used for stack traces/debugging -
/// note this must be set before calling JsParseModuleSource on the module
/// or it will be ignored.
/// 4. Setting an exception on the module object - only relevant prior to it being Parsed.
/// </remarks>
/// <param name="requestModule">The request module.</param>
/// <param name="moduleHostInfo">The type of host info to be set.</param>
/// <param name="hostInfo">The host info to be set.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsSetModuleHostInfo(
_In_ JsModuleRecord requestModule,
_In_ JsModuleHostInfoKind moduleHostInfo,
_In_ void* hostInfo);
/// <summary>
/// Retrieve the host info for the specified module.
/// </summary>
/// <remarks>
/// This can used to retrieve info previously set with JsSetModuleHostInfo.
/// </remarks>
/// <param name="requestModule">The request module.</param>
/// <param name="moduleHostInfo">The type of host info to be retrieved.</param>
/// <param name="hostInfo">The retrieved host info for the module.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetModuleHostInfo(
_In_ JsModuleRecord requestModule,
_In_ JsModuleHostInfoKind moduleHostInfo,
_Outptr_result_maybenull_ void** hostInfo);
/// <summary>
/// Returns 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 return
/// <c>JsErrorInvalidArgument</c>. 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>
/// <param name="metadata">The exception metadata for the runtime of the current context.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetAndClearExceptionWithMetadata(
_Out_ JsValueRef *metadata);
/// <summary>
/// Called by the runtime to load the source code of the serialized script.
/// </summary>
/// <param name="sourceContext">The context passed to Js[Parse|Run]SerializedScriptCallback</param>
/// <param name="script">The script returned.</param>
/// <returns>
/// true if the operation succeeded, false otherwise.
/// </returns>
typedef bool (CHAKRA_CALLBACK * JsSerializedLoadScriptCallback)
(JsSourceContext sourceContext, _Out_ JsValueRef *value,
_Out_ JsParseScriptAttributes *parseAttributes);
/// <summary>
/// Create JavascriptString variable from ASCII or Utf8 string
/// </summary>
/// <remarks>
/// <para>
/// Requires an active script context.
/// </para>
/// <para>
/// Input string can be either ASCII or Utf8
/// </para>
/// </remarks>
/// <param name="content">Pointer to string memory.</param>
/// <param name="length">Number of bytes within the string</param>
/// <param name="value">JsValueRef representing the JavascriptString</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsCreateString(
_In_ const char *content,
_In_ size_t length,
_Out_ JsValueRef *value);
/// <summary>
/// Create JavascriptString variable from Utf16 string
/// </summary>
/// <remarks>
/// <para>
/// Requires an active script context.
/// </para>
/// <para>
/// Expects Utf16 string
/// </para>
/// </remarks>
/// <param name="content">Pointer to string memory.</param>
/// <param name="length">Number of characters within the string</param>
/// <param name="value">JsValueRef representing the JavascriptString</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsCreateStringUtf16(
_In_ const uint16_t *content,
_In_ size_t length,
_Out_ JsValueRef *value);
/// <summary>
/// Write JavascriptString value into C string buffer (Utf8)
/// </summary>
/// <remarks>
/// <para>
/// When size of the `buffer` is unknown,
/// `buffer` argument can be nullptr.
/// In that case, `length` argument will return the length needed.
/// </para>
/// </remarks>
/// <param name="value">JavascriptString value</param>
/// <param name="buffer">Pointer to buffer</param>
/// <param name="bufferSize">Buffer size</param>
/// <param name="length">Total number of characters needed or written</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsCopyString(
_In_ JsValueRef value,
_Out_opt_ char* buffer,
_In_ size_t bufferSize,
_Out_opt_ size_t* length);
/// <summary>
/// Write string value into Utf16 string buffer
/// </summary>
/// <remarks>
/// <para>
/// When size of the `buffer` is unknown,
/// `buffer` argument can be nullptr.
/// In that case, `written` argument will return the length needed.
/// </para>
/// <para>
/// when start is out of range or < 0, returns JsErrorInvalidArgument
/// and `written` will be equal to 0.
/// If calculated length is 0 (It can be due to string length or `start`
/// and length combination), then `written` will be equal to 0 and call
/// returns JsNoError
/// </para>
/// </remarks>
/// <param name="value">JavascriptString value</param>
/// <param name="start">start offset of buffer</param>
/// <param name="length">length to be written</param>
/// <param name="buffer">Pointer to buffer</param>
/// <param name="written">Total number of characters written</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsCopyStringUtf16(
_In_ JsValueRef value,
_In_ int start,
_In_ int length,
_Out_opt_ uint16_t* buffer,
_Out_opt_ size_t* written);
/// <summary>
/// Parses a script and returns a function representing the script.
/// </summary>
/// <remarks>
/// <para>
/// Requires an active script context.
/// </para>
/// <para>
/// Script source can be either JavascriptString or JavascriptExternalArrayBuffer.
/// In case it is an ExternalArrayBuffer, and the encoding of the buffer is Utf16,
/// JsParseScriptAttributeArrayBufferIsUtf16Encoded is expected on parseAttributes.
/// </para>
/// <para>
/// Use JavascriptExternalArrayBuffer with Utf8/ASCII script source
/// for better performance and smaller memory footprint.
/// </para>
/// </remarks>
/// <param name="script">The script to run.</param>
/// <param name="sourceContext">
/// A cookie identifying the script that can be used by debuggable script contexts.
/// </param>
/// <param name="sourceUrl">The location the script came from.</param>
/// <param name="parseAttributes">Attribute mask for parsing the script</param>
/// <param name="result">The result of the compiled script.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsParse(
_In_ JsValueRef script,
_In_ JsSourceContext sourceContext,
_In_ JsValueRef sourceUrl,
_In_ JsParseScriptAttributes parseAttributes,
_Out_ JsValueRef *result);
/// <summary>
/// Executes a script.
/// </summary>
/// <remarks>
/// <para>
/// Requires an active script context.
/// </para>
/// <para>
/// Script source can be either JavascriptString or JavascriptExternalArrayBuffer.
/// In case it is an ExternalArrayBuffer, and the encoding of the buffer is Utf16,
/// JsParseScriptAttributeArrayBufferIsUtf16Encoded is expected on parseAttributes.
/// </para>
/// <para>
/// Use JavascriptExternalArrayBuffer with Utf8/ASCII script source
/// for better performance and smaller memory footprint.
/// </para>
/// </remarks>
/// <param name="script">The script to run.</param>
/// <param name="sourceContext">
/// A cookie identifying the script that can be used by debuggable script contexts.
/// </param>
/// <param name="sourceUrl">The location the script came from</param>
/// <param name="parseAttributes">Attribute mask for parsing the script</param>
/// <param name="result">The result of the script, if any. This parameter can be null.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsRun(
_In_ JsValueRef script,
_In_ JsSourceContext sourceContext,
_In_ JsValueRef sourceUrl,
_In_ JsParseScriptAttributes parseAttributes,
_Out_ JsValueRef *result);
/// <summary>
/// Creates the property ID associated with the name.
/// </summary>
/// <remarks>
/// <para>
/// Property IDs are specific to a context and cannot be used across contexts.
/// </para>
/// <para>
/// Requires an active script context.
/// </para>
/// </remarks>
/// <param name="name">
/// The name of the property ID to get or create. The name may consist of only digits.
/// The string is expected to be ASCII / utf8 encoded.
/// </param>
/// <param name="length">length of the name in bytes</param>
/// <param name="propertyId">The property ID in this runtime for the given name.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsCreatePropertyId(
_In_z_ const char *name,
_In_ size_t length,
_Out_ JsPropertyIdRef *propertyId);
/// <summary>
/// Copies the name associated with the property ID into a buffer.
/// </summary>
/// <remarks>
/// <para>
/// Requires an active script context.
/// </para>
/// <para>
/// When size of the `buffer` is unknown,
/// `buffer` argument can be nullptr.
/// `length` argument will return the size needed.
/// </para>
/// </remarks>
/// <param name="propertyId">The property ID to get the name of.</param>
/// <param name="buffer">The buffer holding the name associated with the property ID, encoded as utf8</param>
/// <param name="bufferSize">Size of the buffer.</param>
/// <param name="written">Total number of characters written or to be written</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsCopyPropertyId(
_In_ JsPropertyIdRef propertyId,
_Out_ char* buffer,
_In_ size_t bufferSize,
_Out_ size_t* length);
/// <summary>
/// Serializes a parsed script to a buffer than can be reused.
/// </summary>
/// <remarks>
/// <para>
/// <c>JsSerializeScript</c> parses a script and then stores the parsed form of the script in a
/// runtime-independent format. The serialized script then can be deserialized in any
/// runtime without requiring the script to be re-parsed.
/// </para>
/// <para>
/// Requires an active script context.
/// </para>
/// <para>
/// Script source can be either JavascriptString or JavascriptExternalArrayBuffer.
/// In case it is an ExternalArrayBuffer, and the encoding of the buffer is Utf16,
/// JsParseScriptAttributeArrayBufferIsUtf16Encoded is expected on parseAttributes.
/// </para>
/// <para>
/// Use JavascriptExternalArrayBuffer with Utf8/ASCII script source
/// for better performance and smaller memory footprint.
/// </para>
/// </remarks>
/// <param name="script">The script to serialize</param>
/// <param name="buffer">ArrayBuffer</param>
/// <param name="parseAttributes">Encoding for the script.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsSerialize(
_In_ JsValueRef script,
_Out_ JsValueRef *buffer,
_In_ JsParseScriptAttributes parseAttributes);
/// <summary>
/// Parses a serialized script and returns a function representing the script.
/// Provides the ability to lazy load the script source only if/when it is needed.
/// </summary>
/// <remarks>
/// <para>
/// Requires an active script context.
/// </para>
/// </remarks>
/// <param name="buffer">The serialized script as an ArrayBuffer (preferably ExternalArrayBuffer).</param>
/// <param name="scriptLoadCallback">
/// Callback called when the source code of the script needs to be loaded.
/// This is an optional parameter, set to null if not needed.
/// </param>
/// <param name="sourceContext">
/// A cookie identifying the script that can be used by debuggable script contexts.
/// This context will passed into scriptLoadCallback.
/// </param>
/// <param name="sourceUrl">The location the script came from.</param>
/// <param name="result">A function representing the script code.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsParseSerialized(
_In_ JsValueRef buffer,
_In_ JsSerializedLoadScriptCallback scriptLoadCallback,
_In_ JsSourceContext sourceContext,
_In_ JsValueRef sourceUrl,
_Out_ JsValueRef *result);
/// <summary>
/// Runs a serialized script.
/// Provides the ability to lazy load the script source only if/when it is needed.
/// </summary>
/// <remarks>
/// <para>
/// Requires an active script context.
/// </para>
/// <para>
/// The runtime will detach the data from the buffer and hold on to it until all
/// instances of any functions created from the buffer are garbage collected.
/// </para>
/// </remarks>
/// <param name="buffer">The serialized script as an ArrayBuffer (preferably ExternalArrayBuffer).</param>
/// <param name="scriptLoadCallback">Callback called when the source code of the script needs to be loaded.</param>
/// <param name="sourceContext">
/// A cookie identifying the script that can be used by debuggable script contexts.
/// This context will passed into scriptLoadCallback.
/// </param>
/// <param name="sourceUrl">The location the script came from.</param>
/// <param name="result">
/// The result of running the script, if any. This parameter can be null.
/// </param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsRunSerialized(
_In_ JsValueRef buffer,
_In_ JsSerializedLoadScriptCallback scriptLoadCallback,
_In_ JsSourceContext sourceContext,
_In_ JsValueRef sourceUrl,
_Out_ JsValueRef *result);
/// <summary>
/// Gets the state of a given Promise object.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="promise">The Promise object.</param>
/// <param name="state">The current state of the Promise.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetPromiseState(
_In_ JsValueRef promise,
_Out_ JsPromiseState *state);
/// <summary>
/// Gets the result of a given Promise object.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="promise">The Promise object.</param>
/// <param name="result">The result of the Promise.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetPromiseResult(
_In_ JsValueRef promise,
_Out_ JsValueRef *result);
/// <summary>
/// Creates a new JavaScript Promise object.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="promise">The new Promise object.</param>
/// <param name="resolveFunction">The function called to resolve the created Promise object.</param>
/// <param name="rejectFunction">The function called to reject the created Promise object.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsCreatePromise(
_Out_ JsValueRef *promise,
_Out_ JsValueRef *resolveFunction,
_Out_ JsValueRef *rejectFunction);
/// <summary>
/// A weak reference to a JavaScript value.
/// </summary>
/// <remarks>
/// A value with only weak references is available for garbage-collection. A strong reference
/// to the value (<c>JsValueRef</c>) may be obtained from a weak reference if the value happens
/// to still be available.
/// </remarks>
typedef JsRef JsWeakRef;
/// <summary>
/// Creates a weak reference to a value.
/// </summary>
/// <param name="value">The value to be referenced.</param>
/// <param name="weakRef">Weak reference to the value.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsCreateWeakReference(
_In_ JsValueRef value,
_Out_ JsWeakRef* weakRef);
/// <summary>
/// Gets a strong reference to the value referred to by a weak reference.
/// </summary>
/// <param name="weakRef">A weak reference.</param>
/// <param name="value">Reference to the value, or <c>JS_INVALID_REFERENCE</c> if the value is
/// no longer available.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetWeakReferenceValue(
_In_ JsWeakRef weakRef,
_Out_ JsValueRef* value);
/// <summary>
/// Creates a Javascript SharedArrayBuffer object with shared content get from JsGetSharedArrayBufferContent.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="sharedContents">
/// The storage object of a SharedArrayBuffer which can be shared between multiple thread.
/// </param>
/// <param name="result">The new SharedArrayBuffer object.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsCreateSharedArrayBufferWithSharedContent(
_In_ JsSharedArrayBufferContentHandle sharedContents,
_Out_ JsValueRef *result);
/// <summary>
/// Get the storage object from a SharedArrayBuffer.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="sharedArrayBuffer">The SharedArrayBuffer object.</param>
/// <param name="sharedContents">
/// The storage object of a SharedArrayBuffer which can be shared between multiple thread.
/// User should call JsReleaseSharedArrayBufferContentHandle after finished using it.
/// </param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetSharedArrayBufferContent(
_In_ JsValueRef sharedArrayBuffer,
_Out_ JsSharedArrayBufferContentHandle *sharedContents);
/// <summary>
/// Decrease the reference count on a SharedArrayBuffer storage object.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="sharedContents">
/// The storage object of a SharedArrayBuffer which can be shared between multiple thread.
/// </param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsReleaseSharedArrayBufferContentHandle(
_In_ JsSharedArrayBufferContentHandle sharedContents);
/// <summary>
/// Determines whether an object has a non-inherited property.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="object">The object that may contain the property.</param>
/// <param name="propertyId">The ID of the property.</param>
/// <param name="hasOwnProperty">Whether the object has the non-inherited property.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsHasOwnProperty(
_In_ JsValueRef object,
_In_ JsPropertyIdRef propertyId,
_Out_ bool *hasOwnProperty);
/// <summary>
/// Write JS string value into char string buffer without a null terminator
/// </summary>
/// <remarks>
/// <para>
/// When size of the `buffer` is unknown,
/// `buffer` argument can be nullptr.
/// In that case, `written` argument will return the length needed.
/// </para>
/// <para>
/// When start is out of range or < 0, returns JsErrorInvalidArgument
/// and `written` will be equal to 0.
/// If calculated length is 0 (It can be due to string length or `start`
/// and length combination), then `written` will be equal to 0 and call
/// returns JsNoError
/// </para>
/// <para>
/// The JS string `value` will be converted one utf16 code point at a time,
/// and if it has code points that do not fit in one byte, those values
/// will be truncated.
/// </para>
/// </remarks>
/// <param name="value">JavascriptString value</param>
/// <param name="start">Start offset of buffer</param>
/// <param name="length">Number of characters to be written</param>
/// <param name="buffer">Pointer to buffer</param>
/// <param name="written">Total number of characters written</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsCopyStringOneByte(
_In_ JsValueRef value,
_In_ int start,
_In_ int length,
_Out_opt_ char* buffer,
_Out_opt_ size_t* written);
/// <summary>
/// Obtains frequently used properties of a data view.
/// </summary>
/// <param name="dataView">The data view instance.</param>
/// <param name="arrayBuffer">The ArrayBuffer backstore of the view.</param>
/// <param name="byteOffset">The offset in bytes from the start of arrayBuffer referenced by the array.</param>
/// <param name="byteLength">The number of bytes in the array.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetDataViewInfo(
_In_ JsValueRef dataView,
_Out_opt_ JsValueRef *arrayBuffer,
_Out_opt_ unsigned int *byteOffset,
_Out_opt_ unsigned int *byteLength);
/// <summary>
/// Determine if one JavaScript value is less than another JavaScript value.
/// </summary>
/// <remarks>
/// <para>
/// This function is equivalent to the <c><</c> operator in Javascript.
/// </para>
/// <para>
/// Requires an active script context.
/// </para>
/// </remarks>
/// <param name="object1">The first object to compare.</param>
/// <param name="object2">The second object to compare.</param>
/// <param name="result">Whether object1 is less than object2.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsLessThan(
_In_ JsValueRef object1,
_In_ JsValueRef object2,
_Out_ bool *result);
/// <summary>
/// Determine if one JavaScript value is less than or equal to another JavaScript value.
/// </summary>
/// <remarks>
/// <para>
/// This function is equivalent to the <c><=</c> operator in Javascript.
/// </para>
/// <para>
/// Requires an active script context.
/// </para>
/// </remarks>
/// <param name="object1">The first object to compare.</param>
/// <param name="object2">The second object to compare.</param>
/// <param name="result">Whether object1 is less than or equal to object2.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsLessThanOrEqual(
_In_ JsValueRef object1,
_In_ JsValueRef object2,
_Out_ bool *result);
/// <summary>
/// Creates a new object (with prototype) 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="finalizeCallback">
/// A callback for when the object is finalized. May be null.
/// </param>
/// <param name="prototype">Prototype object or nullptr.</param>
/// <param name="object">The new object.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsCreateExternalObjectWithPrototype(
_In_opt_ void *data,
_In_opt_ JsFinalizeCallback finalizeCallback,
_In_opt_ JsValueRef prototype,
_Out_ JsValueRef *object);
/// <summary>
/// Gets an object's property.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="object">The object that contains the property.</param>
/// <param name="key">The key (JavascriptString or JavascriptSymbol) to the property.</param>
/// <param name="value">The value of the property.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsObjectGetProperty(
_In_ JsValueRef object,
_In_ JsValueRef key,
_Out_ JsValueRef *value);
/// <summary>
/// Puts an object's property.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="object">The object that contains the property.</param>
/// <param name="key">The key (JavascriptString or JavascriptSymbol) to the property.</param>
/// <param name="value">The new value of the property.</param>
/// <param name="useStrictRules">The property set should follow strict mode rules.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsObjectSetProperty(
_In_ JsValueRef object,
_In_ JsValueRef key,
_In_ JsValueRef value,
_In_ bool useStrictRules);
/// <summary>
/// Determines whether an object has a property.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="object">The object that may contain the property.</param>
/// <param name="key">The key (JavascriptString or JavascriptSymbol) to the property.</param>
/// <param name="hasProperty">Whether the object (or a prototype) has the property.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsObjectHasProperty(
_In_ JsValueRef object,
_In_ JsValueRef key,
_Out_ bool *hasProperty);
/// <summary>
/// Defines a new object's own property from a property descriptor.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="object">The object that has the property.</param>
/// <param name="key">The key (JavascriptString or JavascriptSymbol) to the property.</param>
/// <param name="propertyDescriptor">The property descriptor.</param>
/// <param name="result">Whether the property was defined.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsObjectDefineProperty(
_In_ JsValueRef object,
_In_ JsValueRef key,
_In_ JsValueRef propertyDescriptor,
_Out_ bool *result);
/// <summary>
/// Deletes an object's property.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="object">The object that contains the property.</param>
/// <param name="key">The key (JavascriptString or JavascriptSymbol) to the property.</param>
/// <param name="useStrictRules">The property set should follow strict mode rules.</param>
/// <param name="result">Whether the property was deleted.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsObjectDeleteProperty(
_In_ JsValueRef object,
_In_ JsValueRef key,
_In_ bool useStrictRules,
_Out_ JsValueRef *result);
/// <summary>
/// Gets a property descriptor for an object's own property.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="object">The object that has the property.</param>
/// <param name="key">The key (JavascriptString or JavascriptSymbol) to the property.</param>
/// <param name="propertyDescriptor">The property descriptor.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsObjectGetOwnPropertyDescriptor(
_In_ JsValueRef object,
_In_ JsValueRef key,
_Out_ JsValueRef *propertyDescriptor);
/// <summary>
/// Determines whether an object has a non-inherited property.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="object">The object that may contain the property.</param>
/// <param name="key">The key (JavascriptString or JavascriptSymbol) to the property.</param>
/// <param name="hasOwnProperty">Whether the object has the non-inherited property.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsObjectHasOwnProperty(
_In_ JsValueRef object,
_In_ JsValueRef key,
_Out_ bool *hasOwnProperty);
/// <summary>
/// Sets whether any action should be taken when a promise is rejected with no reactions
/// or a reaction is added to a promise that was rejected before it had reactions.
/// By default in either of these cases nothing occurs.
/// This function allows you to specify if something should occur and provide a callback
/// to implement whatever should occur.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// </remarks>
/// <param name="promiseRejectionTrackerCallback">The callback function being set.</param>
/// <param name="callbackState">
/// User provided state that will be passed back to the callback.
/// </param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsSetHostPromiseRejectionTracker(
_In_ JsHostPromiseRejectionTrackerCallback promiseRejectionTrackerCallback,
_In_opt_ void *callbackState);
/// <summary>
/// Retrieve the namespace object for a module.
/// </summary>
/// <remarks>
/// Requires an active script context and that the module has already been evaluated.
/// </remarks>
/// <param name="requestModule">The JsModuleRecord for which the namespace is being requested.</param>
/// <param name="moduleNamespace">A JsValueRef - the requested namespace object.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetModuleNamespace(
_In_ JsModuleRecord requestModule,
_Outptr_result_maybenull_ JsValueRef *moduleNamespace);
/// <summary>
/// Determines if a provided object is a JavscriptProxy Object and
/// provides references to a Proxy's target and handler.
/// </summary>
/// <remarks>
/// Requires an active script context.
/// If object is not a Proxy object the target and handler parameters are not touched.
/// If nullptr is supplied for target or handler the function returns after
/// setting the isProxy value.
/// If the object is a revoked Proxy target and handler are set to JS_INVALID_REFERENCE.
/// If it is a Proxy object that has not been revoked target and handler are set to the
/// the object's target and handler.
/// </remarks>
/// <param name="object">The object that may be a Proxy.</param>
/// <param name="isProxy">Pointer to a Boolean - is the object a proxy?</param>
/// <param name="target">Pointer to a JsValueRef - the object's target.</param>
/// <param name="handler">Pointer to a JsValueRef - the object's handler.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsGetProxyProperties(
_In_ JsValueRef object,
_Out_ bool* isProxy,
_Out_opt_ JsValueRef* target,
_Out_opt_ JsValueRef* handler);
/// <summary>
/// Parses a script and stores the generated parser state cache into a buffer which can be reused.
/// </summary>
/// <remarks>
/// <para>
/// <c>JsSerializeParserState</c> parses a script and then stores a cache of the parser state
/// in a runtime-independent format. The parser state may be deserialized in any runtime along
/// with the same script to skip the initial parse phase.
/// </para>
/// <para>
/// Requires an active script context.
/// </para>
/// <para>
/// Script source can be either JavascriptString or JavascriptExternalArrayBuffer.
/// In case it is an ExternalArrayBuffer, and the encoding of the buffer is Utf16,
/// JsParseScriptAttributeArrayBufferIsUtf16Encoded is expected on parseAttributes.
/// </para>
/// <para>
/// Use JavascriptExternalArrayBuffer with Utf8/ASCII script source
/// for better performance and smaller memory footprint.
/// </para>
/// </remarks>
/// <param name="scriptVal">The script to parse.</param>
/// <param name="bufferVal">The buffer to put the serialized parser state cache into.</param>
/// <param name="parseAttributes">Encoding for the script.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsSerializeParserState(
_In_ JsValueRef scriptVal,
_Out_ JsValueRef *bufferVal,
_In_ JsParseScriptAttributes parseAttributes);
/// <summary>
/// Deserializes the cache of initial parser state and (along with the same
/// script source) executes the script and returns the result.
/// </summary>
/// <remarks>
/// <para>
/// Requires an active script context.
/// </para>
/// <para>
/// Script source can be either JavascriptString or JavascriptExternalArrayBuffer.
/// In case it is an ExternalArrayBuffer, and the encoding of the buffer is Utf16,
/// JsParseScriptAttributeArrayBufferIsUtf16Encoded is expected on parseAttributes.
/// </para>
/// <para>
/// Use JavascriptExternalArrayBuffer with Utf8/ASCII script source
/// for better performance and smaller memory footprint.
/// </para>
/// </remarks>
/// <param name="script">The script to run.</param>
/// <param name="sourceContext">
/// A cookie identifying the script that can be used by debuggable script contexts.
/// </param>
/// <param name="sourceUrl">The location the script came from</param>
/// <param name="parseAttributes">Attribute mask for parsing the script</param>
/// <param name="parserState">
/// A buffer containing a cache of the parser state generated by <c>JsSerializeParserState</c>.
/// </param>
/// <param name="result">The result of the script, if any. This parameter can be null.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsRunScriptWithParserState(
_In_ JsValueRef script,
_In_ JsSourceContext sourceContext,
_In_ JsValueRef sourceUrl,
_In_ JsParseScriptAttributes parseAttributes,
_In_ JsValueRef parserState,
_Out_ JsValueRef * result);
#endif // _CHAKRACOREBUILD
#endif // _CHAKRACORE_H_
================================================
FILE: include/ChakraCoreVersion.h
================================================
//-------------------------------------------------------------------------------------------------------
// Copyright (C) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE.txt file in the project root for full license information.
//-------------------------------------------------------------------------------------------------------
#pragma once
// NOTE: When changing this file, you may need to update the GUID in ByteCodeCacheReleaseFileVersion.h
// Please update the GUID when:
// * CHAKRA_CORE_VERSION_RELEASE is changed to 1
// * CHAKRA_CORE_VERSION_RELEASE is currently set to 1 and the bytecode changes
// See notes below about ReleaseVersioningScheme.
// --------------
// VERSION NUMBER
// --------------
// ChakraCore version number definitions (used in ChakraCore binary metadata)
#define CHAKRA_CORE_MAJOR_VERSION 1
#define CHAKRA_CORE_MINOR_VERSION 11
#define CHAKRA_CORE_PATCH_VERSION 24
#define CHAKRA_CORE_VERSION_RELEASE_QFE 0 // Redundant with PATCH_VERSION. Keep this value set to 0.
// -------------
// RELEASE FLAGS
// -------------
// NOTE: CHAKRA_CORE_VERSION_PRERELEASE can only be set to 1 when
// CHAKRA_CORE_VERSION_RELEASE is set to 1, or there is no effect.
// Here are the meanings of the various combinations:
//
// RELEASE** PRERELEASE
// DEVELOPMENT 0 0
// <INVALID> 0 1 # INVALID but identical to DEVELOPMENT
// RELEASE** 1 0 #
// PRERELEASE 1 1
// ** Release flags are not related to build type (e.g. x64_release)
//
// Unless otherwise noted, the code affected by these flags lies mostly in bin/CoreCommon.ver
//
// DEVELOPMENT:
// * Uses EngineeringVersioningScheme (see lib/Runtime/ByteCode/ByteCodeSerializer.cpp)
// * Sets file flag VS_FF_PRIVATEBUILD
// * Adds "Private" to the file description
//
// RELEASE** and PRERELEASE (i.e. controlled by CHAKRA_CORE_VERSION_RELEASE flag):
// * Uses ReleaseVersioningScheme (see lib/Runtime/ByteCode/ByteCodeSerializer.cpp)
//
// PRERELEASE (preparing for release but not yet ready to release):
// * Sets file flag VS_FF_PRERELEASE
// * Adds "Pre-release" to the file description
//
// RELEASE** (code is ready to release)
// * Sets neither of the file flags noted above
// * Does not add anything to the file description
// ChakraCore RELEASE and PRERELEASE flags
#define CHAKRA_CORE_VERSION_RELEASE 1
#define CHAKRA_CORE_VERSION_PRERELEASE 0
// Chakra RELEASE flag
// Mostly redundant with CHAKRA_CORE_VERSION_RELEASE,
// but semantically refers to Chakra rather than ChakraCore.
#define CHAKRA_VERSION_RELEASE 0
================================================
FILE: include/ChakraDebug.h
================================================
//-------------------------------------------------------------------------------------------------------
// Copyright (C) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE.txt file in the project root for full license information.
//-------------------------------------------------------------------------------------------------------
/// \mainpage Chakra Hosting Debugging API Reference
///
/// Chakra is Microsoft's JavaScript engine. It is an integral part of Internet Explorer but can
/// also be hosted independently by other applications. This reference describes the APIs available
/// to applications to debug JavaScript.
/// \file
/// \brief The Chakra hosting debugging API.
///
/// This file contains a flat C API layer. This is the API exported by ChakraCore.dll.
#ifdef _MSC_VER
#pragma once
#endif // _MSC_VER
#ifndef _CHAKRADEBUG_H_
#define _CHAKRADEBUG_H_
#ifdef _WIN32
//Other platforms already include <stdint.h> and have this defined automatically
typedef __int64 int64_t;
typedef unsigned __int32 uint32_t;
#endif
/// <summary>
/// Debug events reported from ChakraCore engine.
/// </summary>
typedef enum _JsDiagDebugEvent
{
/// <summary>
/// Indicates a new script being compiled, this includes script, eval, new function.
/// </summary>
JsDiagDebugEventSourceCompile = 0,
/// <summary>
/// Indicates compile error for a script.
/// </summary>
JsDiagDebugEventCompileError = 1,
/// <summary>
/// Indicates a break due to a breakpoint.
/// </summary>
JsDiagDebugEventBreakpoint = 2,
/// <summary>
/// Indicates a break after completion of step action.
/// </summary>
JsDiagDebugEventStepComplete = 3,
/// <summary>
/// Indicates a break due to debugger statement.
/// </summary>
JsDiagDebugEventDebuggerStatement = 4,
/// <summary>
/// Indicates a break due to async break.
/// </summary>
JsDiagDebugEventAsyncBreak = 5,
/// <summary>
/// Indicates a break due to a runtime script exception.
/// </summary>
JsDiagDebugEventRuntimeException = 6
} JsDiagDebugEvent;
/// <summary>
/// Break on Exception attributes.
/// </summary>
typedef enum _JsDiagBreakOnExceptionAttributes
{
/// <summary>
/// Don't break on any exception.
/// </summary>
JsDiagBreakOnExceptionAttributeNone = 0x0,
/// <summary>
/// Break on uncaught exception.
/// </summary>
JsDiagBreakOnExceptionAttributeUncaught = 0x1,
/// <summary>
/// Break on first chance exception.
/// </summary>
JsDiagBreakOnExceptionAttributeFirstChance = 0x2
} JsDiagBreakOnExceptionAttributes;
/// <summary>
/// Stepping types.
/// </summary>
typedef enum _JsDiagStepType
{
/// <summary>
/// Perform a step operation to next statement.
/// </summary>
JsDiagStepTypeStepIn = 0,
/// <summary>
/// Perform a step out from the current function.
/// </summary>
JsDiagStepTypeStepOut = 1,
/// <summary>
/// Perform a single step over after a debug break if the next statement is a function call, else behaves as a stepin.
/// </summary>
JsDiagStepTypeStepOver = 2,
/// <summary>
/// Perform a single step back to the previous statement (only applicable in TTD mode).
/// </summary>
JsDiagStepTypeStepBack = 3,
/// <summary>
/// Perform a reverse continue operation (only applicable in TTD mode).
/// </summary>
JsDiagStepTypeReverseContinue = 4,
/// <summary>
/// Perform a forward continue operation. Clears any existing step value.
/// </summary>
JsDiagStepTypeContinue = 5
} JsDiagStepType;
/// <summary>
/// User implemented callback routine for debug events.
/// </summary>
/// <remarks>
/// Use <c>JsDiagStartDebugging</c> to register the callback.
/// </remarks>
/// <param name="debugEvent">The type of JsDiagDebugEvent event.</param>
/// <param name="eventData">Additional data related to the debug event.</param>
/// <param name="callbackState">The state passed to <c>JsDiagStartDebugging</c>.</param>
typedef void (CHAKRA_CALLBACK * JsDiagDebugEventCallback)(_In_ JsDiagDebugEvent debugEvent, _In_ JsValueRef eventData, _In_opt_ void* callbackState);
/// <summary>
/// Starts debugging in the given runtime.
/// </summary>
/// <param name="runtimeHandle">Runtime to put into debug mode.</param>
/// <param name="debugEventCallback">Registers a callback to be called on every JsDiagDebugEvent.</param>
/// <param name="callbackState">User provided state that will be passed back to the callback.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
/// <remarks>
/// The runtime should be active on the current thread and should not be in debug state.
/// </remarks>
CHAKRA_API
JsDiagStartDebugging(
_In_ JsRuntimeHandle runtimeHandle,
_In_ JsDiagDebugEventCallback debugEventCallback,
_In_opt_ void* callbackState);
/// <summary>
/// Stops debugging in the given runtime.
/// </summary>
/// <param name="runtimeHandle">Runtime to stop debugging.</param>
/// <param name="callbackState">User provided state that was passed in JsDiagStartDebugging.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
/// <remarks>
/// The runtime should be active on the current thread and in debug state.
/// </remarks>
CHAKRA_API
JsDiagStopDebugging(
_In_ JsRuntimeHandle runtimeHandle,
_Out_opt_ void** callbackState);
/// <summary>
/// Request the runtime to break on next JavaScript statement.
/// </summary>
/// <param name="runtimeHandle">Runtime to request break.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
/// <remarks>
/// The runtime should be in debug state. This API can be called from another runtime.
/// </remarks>
CHAKRA_API
JsDiagRequestAsyncBreak(
_In_ JsRuntimeHandle runtimeHandle);
/// <summary>
/// List all breakpoints in the current runtime.
/// </summary>
/// <param name="breakpoints">Array of breakpoints.</param>
/// <remarks>
/// <para>
/// [{
/// "breakpointId" : 1,
/// "scriptId" : 1,
/// "line" : 0,
/// "column" : 62
/// }]
/// </para>
/// </remarks>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
/// <remarks>
/// The current runtime should be in debug state. This API can be called when runtime is at a break or running.
/// </remarks>
CHAKRA_API
JsDiagGetBreakpoints(
_Out_ JsValueRef *breakpoints);
/// <summary>
/// Sets breakpoint in the specified script at give location.
/// </summary>
/// <param name="scriptId">Id of script from JsDiagGetScripts or JsDiagGetSource to put breakpoint.</param>
/// <param name="lineNumber">0 based line number to put breakpoint.</param>
/// <param name="columnNumber">0 based column number to put breakpoint.</param>
/// <param name="breakpoint">Breakpoint object with id, line and column if success.</param>
/// <remarks>
/// <para>
/// {
/// "breakpointId" : 1,
/// "line" : 2,
/// "column" : 4
/// }
/// </para>
/// </remarks>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
/// <remarks>
/// The current runtime should be in debug state. This API can be called when runtime is at a break or running.
/// </remarks>
CHAKRA_API
JsDiagSetBreakpoint(
_In_ unsigned int scriptId,
_In_ unsigned int lineNumber,
_In_ unsigned int columnNumber,
_Out_ JsValueRef *breakpoint);
/// <summary>
/// Remove a breakpoint.
/// </summary>
/// <param name="breakpointId">Breakpoint id returned from JsDiagSetBreakpoint.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
/// <remarks>
/// The current runtime should be in debug state. This API can be called when runtime is at a break or running.
/// </remarks>
CHAKRA_API
JsDiagRemoveBreakpoint(
_In_ unsigned int breakpointId);
/// <summary>
/// Sets break on exception handling.
/// </summary>
/// <param name="runtimeHandle">Runtime to set break on exception attributes.</param>
/// <param name="exceptionAttributes">Mask of JsDiagBreakOnExceptionAttributes to set.</param>
/// <remarks>
/// <para>
/// If this API is not called the default value is set to JsDiagBreakOnExceptionAttributeUncaught in the runtime.
/// </para>
/// </remarks>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
/// <remarks>
/// The runtime should be in debug state. This API can be called from another runtime.
/// </remarks>
CHAKRA_API
JsDiagSetBreakOnException(
_In_ JsRuntimeHandle runtimeHandle,
_In_ JsDiagBreakOnExceptionAttributes exceptionAttributes);
/// <summary>
/// Gets break on exception setting.
/// </summary>
/// <param name="runtimeHandle">Runtime from which to get break on exception attributes, should be in debug mode.</param>
/// <param name="exceptionAttributes">Mask of JsDiagBreakOnExceptionAttributes.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
/// <remarks>
/// The runtime should be in debug state. This API can be called from another runtime.
/// </remarks>
CHAKRA_API
JsDiagGetBreakOnException(
_In_ JsRuntimeHandle runtimeHandle,
_Out_ JsDiagBreakOnExceptionAttributes* exceptionAttributes);
/// <summary>
/// Sets the step type in the runtime after a debug break.
/// </summary>
/// <remarks>
/// Requires to be at a debug break.
/// </remarks>
/// <param name="resumeType">Type of JsDiagStepType.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
/// <remarks>
/// The current runtime should be in debug state. This API can only be called when runtime is at a break.
/// </remarks>
CHAKRA_API
JsDiagSetStepType(
_In_ JsDiagStepType stepType);
/// <summary>
/// Gets list of scripts.
/// </summary>
/// <param name="scriptsArray">Array of script objects.</param>
/// <remarks>
/// <para>
/// [{
/// "scriptId" : 2,
/// "fileName" : "c:\\Test\\Test.js",
/// "lineCount" : 4,
/// "sourceLength" : 111
/// }, {
/// "scriptId" : 3,
/// "parentScriptId" : 2,
/// "scriptType" : "eval code",
/// "lineCount" : 1,
/// "sourceLength" : 12
/// }]
/// </para>
/// </remarks>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
/// <remarks>
/// The current runtime should be in debug state. This API can be called when runtime is at a break or running.
/// </remarks>
CHAKRA_API
JsDiagGetScripts(
_Out_ JsValueRef *scriptsArray);
/// <summary>
/// Gets source for a specific script identified by scriptId from JsDiagGetScripts.
/// </summary>
/// <param name="scriptId">Id of the script.</param>
/// <param name="source">Source object.</param>
/// <remarks>
/// <para>
/// {
/// "scriptId" : 1,
/// "fileName" : "c:\\Test\\Test.js",
/// "lineCount" : 12,
/// "sourceLength" : 15154,
/// "source" : "var x = 1;"
/// }
/// </para>
/// </remarks>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
/// <remarks>
/// The current runtime should be in debug state. This API can be called when runtime is at a break or running.
/// </remarks>
CHAKRA_API
JsDiagGetSource(
_In_ unsigned int scriptId,
_Out_ JsValueRef *source);
/// <summary>
/// Gets the source information for a function object.
/// </summary>
/// <param name="function">JavaScript function.</param>
/// <param name="functionPosition">Function position - scriptId, start line, start column, line number of first statement, column number of first statement.</param>
/// <remarks>
/// <para>
/// {
/// "scriptId" : 1,
/// "fileName" : "c:\\Test\\Test.js",
/// "line" : 1,
/// "column" : 2,
/// "firstStatementLine" : 6,
/// "firstStatementColumn" : 0
/// }
/// </para>
/// </remarks>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
/// <remarks>
/// This API can be called when runtime is at a break or running.
/// </remarks>
CHAKRA_API
JsDiagGetFunctionPosition(
_In_ JsValueRef function,
_Out_ JsValueRef *functionPosition);
/// <summary>
/// Gets the stack trace information.
/// </summary>
/// <param name="stackTrace">Stack trace information.</param>
/// <remarks>
/// <para>
/// [{
/// "index" : 0,
/// "scriptId" : 2,
/// "line" : 3,
/// "column" : 0,
/// "sourceLength" : 9,
/// "sourceText" : "var x = 1",
/// "functionHandle" : 1
/// }]
/// </para>
/// </remarks>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
/// <remarks>
/// The current runtime should be in debug state. This API can only be called when runtime is at a break.
/// </remarks>
CHAKRA_API
JsDiagGetStackTrace(
_Out_ JsValueRef *stackTrace);
/// <summary>
/// Gets the list of properties corresponding to the frame.
/// </summary>
/// <param name="stackFrameIndex">Index of stack frame from JsDiagGetStackTrace.</param>
/// <param name="properties">Object of properties array (properties, scopes and globals).</param>
/// <remarks>
/// <para>
/// propertyAttributes is a bit mask of
/// NONE = 0x1,
/// HAVE_CHILDRENS = 0x2,
/// READ_ONLY_VALUE = 0x4,
/// IN_TDZ = 0x8,
/// </para>
/// <para>
/// {
/// "thisObject": {
/// "name": "this",
/// "type" : "object",
/// "className" : "Object",
/// "display" : "{...}",
/// "propertyAttributes" : 1,
/// "handle" : 306
/// },
/// "exception" : {
/// "name" : "{exception}",
/// "type" : "object",
/// "display" : "'a' is undefined",
/// "className" : "Error",
/// "propertyAttributes" : 1,
/// "handle" : 307
/// }
/// "arguments" : {
/// "name" : "arguments",
/// "type" : "object",
/// "display" : "{...}",
/// "className" : "Object",
/// "propertyAttributes" : 1,
/// "handle" : 190
/// },
/// "returnValue" : {
/// "name" : "[Return value]",
/// "type" : "undefined",
/// "propertyAttributes" : 0,
/// "handle" : 192
/// },
/// "functionCallsReturn" : [{
/// "name" : "[foo1 returned]",
/// "type" : "number",
/// "value" : 1,
/// "propertyAttributes" : 2,
/// "handle" : 191
/// }
/// ],
/// "locals" : [],
/// "scopes" : [{
/// "index" : 0,
/// "handle" : 193
/// }
/// ],
/// "globals" : {
/// "handle" : 194
/// }
/// }
/// </para>
/// </remarks>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
/// <remarks>
/// The current runtime should be in debug state. This API can only be called when runtime is at a break.
/// </remarks>
CHAKRA_API
JsDiagGetStackProperties(
_In_ unsigned int stackFrameIndex,
_Out_ JsValueRef *properties);
/// <summary>
/// Gets the list of children of a handle.
/// </summary>
/// <param name="objectHandle">Handle of object.</param>
/// <param name="fromCount">0-based from count of properties, usually 0.</param>
/// <param name="totalCount">Number of properties to return.</param>
/// <param name="propertiesObject">Array of properties.</param>
/// <remarks>Handle should be from objects returned from call to JsDiagGetStackProperties.</remarks>
/// <remarks>For scenarios where object have large number of properties totalCount can be used to control how many properties are given.</remarks>
/// <remarks>
/// <para>
/// {
/// "totalPropertiesOfObject": 10,
/// "properties" : [{
/// "name" : "__proto__",
/// "type" : "object",
/// "display" : "{...}",
/// "className" : "Object",
/// "propertyAttributes" : 1,
/// "handle" : 156
/// }
/// ],
/// "debuggerOnlyProperties" : [{
/// "name" : "[Map]",
/// "type" : "string",
/// "value" : "size = 0",
/// "propertyAttributes" : 2,
/// "handle" : 157
/// }
/// ]
/// }
/// </para>
/// </remarks>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
/// <remarks>
/// The current runtime should be in debug state. This API can only be called when runtime is at a break.
/// </remarks>
CHAKRA_API
JsDiagGetProperties(
_In_ unsigned int objectHandle,
_In_ unsigned int fromCount,
_In_ unsigned int totalCount,
_Out_ JsValueRef *propertiesObject);
/// <summary>
/// Gets the object corresponding to handle.
/// </summary>
/// <param name="objectHandle">Handle of object.</param>
/// <param name="handleObject">Object corresponding to the handle.</param>
/// <remarks>
/// <para>
/// {
/// "scriptId" : 24,
/// "line" : 1,
/// "column" : 63,
/// "name" : "foo",
/// "type" : "function",
/// "handle" : 2
/// }
/// </para>
/// </remarks>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
/// <remarks>
/// The current runtime should be in debug state. This API can only be called when runtime is at a break.
/// </remarks>
CHAKRA_API
JsDiagGetObjectFromHandle(
_In_ unsigned int objectHandle,
_Out_ JsValueRef *handleObject);
/// <summary>
/// Evaluates an expression on given frame.
/// </summary>
/// <param name="expression">
/// Javascript String or ArrayBuffer (incl. ExternalArrayBuffer).
/// </param>
/// <param name="stackFrameIndex">Index of stack frame on which to evaluate the expression.</param>
/// <param name="parseAttributes">
/// Defines how `expression` (JsValueRef) should be parsed.
/// - `JsParseScriptAttributeNone` when `expression` is a Utf8 encoded ArrayBuffer and/or a Javascript String (encoding independent)
/// - `JsParseScriptAttributeArrayBufferIsUtf16Encoded` when `expression` is Utf16 Encoded ArrayBuffer
/// - `JsParseScriptAttributeLibraryCode` has no use for this function and has similar effect with `JsParseScriptAttributeNone`
/// </param>
/// <param name="forceSetValueProp">Forces the result to contain the raw value of the expression result.</param>
/// <param name="evalResult">Result of evaluation.</param>
/// <remarks>
/// <para>
/// evalResult when evaluating 'this' and return is JsNoError
/// {
/// "name" : "this",
/// "type" : "object",
/// "className" : "Object",
/// "display" : "{...}",
/// "propertyAttributes" : 1,
/// "handle" : 18
/// }
///
/// evalResult when evaluating a script which throws JavaScript error and return is JsErrorScriptException
/// {
/// "name" : "a.b.c",
/// "type" : "object",
/// "className" : "Error",
/// "display" : "'a' is undefined",
/// "propertyAttributes" : 1,
/// "handle" : 18
/// }
/// </para>
/// </remarks>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, evalResult will contain the result
/// The code <c>JsErrorScriptException</c> if evaluate generated a JavaScript exception, evalResult will contain the error details
/// Other error code for invalid parameters or API was not called at break
/// </returns>
/// <remarks>
/// The current runtime should be in debug state. This API can only be called when runtime is at a break.
/// </remarks>
CHAKRA_API
JsDiagEvaluate(
_In_ JsValueRef expression,
_In_ unsigned int stackFrameIndex,
_In_ JsParseScriptAttributes parseAttributes,
_In_ bool forceSetValueProp,
_Out_ JsValueRef *evalResult);
/////////////////////
/// <summary>
/// TimeTravel move options as bit flag enum.
/// </summary>
typedef enum _JsTTDMoveModes
{
/// <summary>
/// Indicates no special actions needed for move.
/// </summary>
JsTTDMoveNone = 0x0,
/// <summary>
/// Indicates that we want to move to the first event.
/// </summary>
JsTTDMoveFirstEvent = 0x1,
/// <summary>
/// Indicates that we want to move to the last event.
/// </summary>
JsTTDMoveLastEvent = 0x2,
/// <summary>
/// Indicates that we want to move to the kth event -- top 32 bits are event count.
/// </summary>
JsTTDMoveKthEvent = 0x4,
/// <summary>
/// Indicates if we are doing the scan for a continue operation
/// </summary>
JsTTDMoveScanIntervalForContinue = 0x10,
/// <summary>
/// Indicates if we are doing the scan for a continue operation and are in the time-segment where the active breakpoint was
/// </summary>
JsTTDMoveScanIntervalForContinueInActiveBreakpointSegment = 0x20,
/// <summary>
/// Indicates if we want to set break on entry or just run and let something else trigger breakpoints.
/// </summary>
JsTTDMoveBreakOnEntry = 0x100
} JsTTDMoveMode;
/// <summary>
/// A handle for URI's that TTD information is written to/read from.
/// </summary>
typedef void* JsTTDStreamHandle;
/// <summary>
/// TTD API -- may change in future versions:
/// Construct a JsTTDStreamHandle that will be used to read/write the event log portion of the TTD data based on the uri
/// provided by JsTTDInitializeUriCallback.
/// </summary>
/// <remarks>
/// <para>Exactly one of read or write will be set to true.</para>
/// </remarks>
/// <param name="uriLength">The length of the uri array that the host passed in for storing log info.</param>
/// <param name="uri">The URI that the host passed in for storing log info.</param>
/// <param name="asciiNameLength">The length of the ascii name array that the host passed in for storing log info.</param>
/// <param name="asciiResourceName">An optional ascii string giving a unique name to the resource that the JsTTDStreamHandle will be created for.</param>
/// <param name="read">If the handle should be opened for reading.</param>
/// <param name="write">If the handle should be opened for writing.</param>
/// <returns>A JsTTDStreamHandle opened in read/write mode as specified.</returns>
typedef JsTTDStreamHandle (CHAKRA_CALLBACK *TTDOpenResourceStreamCallback)(_In_ size_t uriLength, _In_reads_(uriLength) const char* uri, _In_ size_t asciiNameLength, _In_reads_(asciiNameLength) const char* asciiResourceName, _In_ bool read, _In_ bool write);
/// <summary>
/// TTD API -- may change in future versions:
/// A callback for reading data from a handle.
/// </summary>
/// <param name="handle">The JsTTDStreamHandle to read the data from.</param>
/// <param name="buff">The buffer to place the data into.</param>
/// <param name="size">The max number of bytes that should be read.</param>
/// <param name="readCount">The actual number of bytes read and placed in the buffer.</param>
/// <returns>true if the read was successful false otherwise.</returns>
typedef bool (CHAKRA_CALLBACK *JsTTDReadBytesFromStreamCallback)(_In_ JsTTDStreamHandle handle, _Out_writes_(size) byte* buff, _In_ size_t size, _Out_ size_t* readCount);
/// <summary>
/// TTD API -- may change in future versions:
/// A callback for writing data to a handle.
/// </summary>
/// <param name="handle">The JsTTDStreamHandle to write the data to.</param>
/// <param name="buff">The buffer to copy the data from.</param>
/// <param name="size">The max number of bytes that should be written.</param>
/// <param name="readCount">The actual number of bytes written to the HANDLE.</param>
/// <returns>true if the write was successful false otherwise.</returns>
typedef bool (CHAKRA_CALLBACK *JsTTDWriteBytesToStreamCallback)(_In_ JsTTDStreamHandle handle, _In_reads_(size) const byte* buff, _In_ size_t size, _Out_ size_t* writtenCount);
/// <summary>
/// TTD API -- may change in future versions:
/// Flush and close the stream represented by the HANDLE as needed.
/// </summary>
/// <remarks>
/// <para>Exactly one of read or write will be set to true.</para>
/// </remarks>
/// <param name="handle">The JsTTDStreamHandle to close.</param>
/// <param name="read">If the handle was opened for reading.</param>
/// <param name="write">If the handle was opened for writing.</param>
typedef void (CHAKRA_CALLBACK *JsTTDFlushAndCloseStreamCallback)(_In_ JsTTDStreamHandle handle, _In_ bool read, _In_ bool write);
/// <summary>
/// TTD API -- may change in future versions:
/// Creates a new runtime in Record Mode.
/// </summary>
/// <param name="attributes">The attributes of the runtime to be created.</param>
/// <param name="enableDebugging">A flag to enable debugging during record.</param>
/// <param name="snapInterval">The interval to wait between snapshots (measured in millis).</param>
/// <param name="snapHistoryLength">The amount of history to maintain before discarding -- measured in number of snapshots and controls how far back in time a trace can be reversed.</param>
/// <param name="openResourceStream">The <c>TTDOpenResourceStreamCallback</c> function for generating a JsTTDStreamHandle to read/write serialized data.</param>
/// <param name="writeBytesToStream">The <c>JsTTDWriteBytesToStreamCallback</c> function for writing bytes to a JsTTDStreamHandle.</param>
/// <param name="flushAndCloseStream">The <c>JsTTDFlushAndCloseStreamCallback</c> function for flushing and closing a JsTTDStreamHandle as needed.</param>
/// <param name="threadService">The thread service for the runtime. Can be null.</param>
/// <param name="runtime">The runtime created.</param>
/// <remarks>
/// <para>See <c>JsCreateRuntime</c> for additional information.</para>
/// </remarks>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsTTDCreateRecordRuntime(
_In_ JsRuntimeAttributes attributes,
_In_ bool enableDebugging,
_In_ size_t snapInterval,
_In_ size_t snapHistoryLength,
_In_ TTDOpenResourceStreamCallback openResourceStream,
_In_ JsTTDWriteBytesToStreamCallback writeBytesToStream,
_In_ JsTTDFlushAndCloseStreamCallback flushAndCloseStream,
_In_opt_ JsThreadServiceCallback threadService,
_Out_ JsRuntimeHandle *runtime);
/// <summary>
/// TTD API -- may change in future versions:
/// Creates a new runtime in Debug Mode.
/// </summary>
/// <param name="attributes">The attributes of the runtime to be created.</param>
/// <param name="infoUri">The uri where the recorded Time-Travel data should be loaded from.</param>
/// <param name="enableDebugging">A flag to enable additional debugging operation support during replay.</param>
/// <param name="openResourceStream">The <c>TTDOpenResourceStreamCallback</c> function for generating a JsTTDStreamHandle to read/write serialized data.</param>
/// <param name="readBytesFromStream">The <c>JsTTDReadBytesFromStreamCallback</c> function for reading bytes from a JsTTDStreamHandle.</param>
/// <param name="flushAndCloseStream">The <c>JsTTDFlushAndCloseStreamCallback</c> function for flushing and closing a JsTTDStreamHandle as needed.</param>
/// <param name="threadService">The thread service for the runtime. Can be null.</param>
/// <param name="runtime">The runtime created.</param>
/// <remarks>
/// <para>See <c>JsCreateRuntime</c> for additional information.</para>
/// </remarks>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API
JsTTDCreateReplayRuntime(
_In_ JsRuntimeAttributes attributes,
_In_reads_(infoUriCount) const char* infoUri,
_In_ size_t infoUriCount,
_In_ bool enableDebugging,
_In_ TTDOpenResourceStreamCallback openResourceStream,
_In_ JsTTDReadBytesFromStreamCallback readBytesFromStream,
_In_ JsTTDFlushAndCloseStreamCallback flushAndCloseStream,
_In_opt_ JsThreadServiceCallback threadService,
_Out_ JsRuntimeHandle *runtime);
/// <summary>
/// TTD API -- may change in future versions:
/// Creates a script context that takes the TTD mode from the log or explicitly is not in TTD mode (regular takes mode from currently active script).
/// </summary>
/// <param name="runtime">The runtime the script context is being created in.</param>
/// <param name="useRuntimeTTDMode">Set to true to use runtime TTD mode false to explicitly be non-TTD context.</param>
/// <param name="newContext">The created script context.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API JsTTDCreateContext(
_In_ JsRuntimeHandle runtimeHandle,
_In_ bool useRuntimeTTDMode,
_Out_ JsContextRef *newContext);
/// <summary>
/// TTD API -- may change in future versions:
/// Notify the time-travel system that a context has been identified as dead by the gc (and is being de-allocated).
/// </summary>
/// <param name="context">The script context that is now dead.</param>
/// <returns>
/// The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.
/// </returns>
CHAKRA_API JsTTDNotifyContextDestroy(
_In_ JsContextRef context);
/// <summary>
/// TTD API -- may change in future versions:
/// Start Time-Travel record or replay at next turn of event loop.
/// </summary>
/// <returns>The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.</returns>
CHAKRA_API
JsTTDStart();
/// <summary>
/// TTD API -- may change in future versions:
/// Stop Time-Travel record or replay.
/// </summary>
/// <returns>The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.</returns>
CHAKRA_API
JsTTDStop();
/// <summary>
/// TTD API -- may change in future versions:
/// Pause Time-Travel recording before executing code on behalf of debugger or other diagnostic/telemetry.
/// </summary>
/// <returns>The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.</returns>
CHAKRA_API
JsTTDPauseTimeTravelBeforeRuntimeOperation();
/// <summary>
/// TTD API -- may change in future versions:
/// ReStart Time-Travel recording after executing code on behalf of debugger or other diagnostic/telemetry.
/// </summary>
/// <returns>The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.</returns>
CHAKRA_API
JsTTDReStartTimeTravelAfterRuntimeOperation();
/// <summary>
/// TTD API -- may change in future versions:
/// Notify the Js runtime we are at a safe yield point in the event loop (i.e. no locals on the stack and we can process as desired).
/// </summary>
/// <returns>The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.</returns>
CHAKRA_API
JsTTDNotifyYield();
/// <summary>
/// TTD API -- may change in future versions:
/// Notify the TTD runtime that we are doing a weak add on a reference (we may use this in external API calls and the release will happen in a GC callback).
/// </summary>
/// <param name="value">The value we are adding the ref to.</param>
/// <returns>The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.</returns>
CHAKRA_API
JsTTDNotifyLongLivedReferenceAdd(_In_ JsValueRef value);
/// <summary>
/// TTD API -- may change in future versions:
/// Notify the Js runtime the host is aborting the process and what the status code is.
/// </summary>
/// <param name="statusCode">The exit status code.</param>
/// <returns>The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.</returns>
CHAKRA_API
JsTTDHostExit(_In_ int statusCode);
/// <summary>
/// TTD API -- may change in future versions:
/// Notify the event log that the contents of one buffer have been copied to a second buffer.
/// </summary>
/// <param name="dst">The buffer that was written into.</param>
/// <param name="dstIndex">The first index modified.</param>
/// <param name="src">The buffer that was copied from.</param>
/// <param name="srcIndex">The first index copied.</param>
/// <param name="count">The number of bytes copied.</param>
/// <returns>The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.</returns>
CHAKRA_API
JsTTDRawBufferCopySyncIndirect(
_In_ JsValueRef dst,
_In_ size_t dstIndex,
_In_ JsValueRef src,
_In_ size_t srcIndex,
_In_ size_t count);
/// <summary>
/// TTD API -- may change in future versions:
/// Notify the event log that the contents of a naked byte* buffer passed to the host have been modified synchronously.
/// </summary>
/// <param name="buffer">The buffer that was modified.</param>
/// <param name="index">The first index modified.</param>
/// <param name="count">The number of bytes written.</param>
/// <returns>The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.</returns>
CHAKRA_API
JsTTDRawBufferModifySyncIndirect(
_In_ JsValueRef buffer,
_In_ size_t index,
_In_ size_t count);
/// <summary>
/// TTD API -- may change in future versions:
/// Get info for notifying the TTD system that a raw buffer it shares with the host has been modified.
/// </summary>
/// <param name="instance">The array buffer we want to monitor for contents modification.</param>
/// <param name="initialModPos">The first position in the buffer that may be modified.</param>
/// <returns>The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.</returns>
CHAKRA_API
JsTTDRawBufferAsyncModificationRegister(
_In_ JsValueRef instance,
_In_ byte* initialModPos);
/// <summary>
/// TTD API -- may change in future versions:
/// Notify the event log that the contents of a naked byte* buffer passed to the host have been modified asynchronously.
/// </summary>
/// <param name="finalModPos">One past the last modified position in the buffer.</param>
/// <returns>The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.</returns>
CHAKRA_API
JsTTDRawBufferAsyncModifyComplete(
_In_ byte* finalModPos);
/// <summary>
/// TTD API -- may change in future versions:
/// A check for unimplemented TTD actions in the host.
/// This API is a TEMPORARY API while we complete the implementation of TTD support in the Node host and will be deleted once that is complete.
/// </summary>
/// <param name="msg">The message to print if we should be catching this as a TTD operation.</param>
/// <returns>The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.</returns>
CHAKRA_API
JsTTDCheckAndAssertIfTTDRunning(
_In_ const char* msg);
/// <summary>
/// TTD API -- may change in future versions:
/// Before calling JsTTDMoveToTopLevelEvent (which inflates a snapshot and replays) check to see if we want to reset the script context.
/// We reset the script context if the move will require inflating from a different snapshot that the last one.
/// </summary>
/// <param name="runtimeHandle">The runtime handle that the script is executing in.</param>
/// <param name="moveMode">Flags controlling the way the move it performed and how other parameters are interpreted.</param>
/// <param name="kthEvent">When <c>moveMode == JsTTDMoveKthEvent</c> indicates which event, otherwise this parameter is ignored.</param>
/// <param name="targetEventTime">The event time we want to move to or -1 if not relevant.</param>
/// <param name="targetStartSnapTime">Out parameter with the event time of the snapshot that we should inflate from.</param>
/// <param name="targetEndSnapTime">Optional Out parameter with the snapshot time following the event.</param>
/// <returns>The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.</returns>
CHAKRA_API JsTTDGetSnapTimeTopLevelEventMove(
_In_ JsRuntimeHandle runtimeHandle,
_In_ JsTTDMoveMode moveMode,
_In_opt_ uint32_t kthEvent,
_Inout_ int64_t* targetEventTime,
_Out_ int64_t* targetStartSnapTime,
_Out_opt_ int64_t* targetEndSnapTime);
/// <summary>
/// TTD API -- may change in future versions:
/// Get the snapshot interval that bounds the target event time.
/// </summary>
/// <param name="runtimeHandle">The runtime handle that the script is executing in.</param>
/// <param name="targetEventTime">The event time we want to get the interval for.</param>
/// <param name="startSnapTime">The snapshot time that comes before the desired event.</param>
/// <param name="endSnapTime">The snapshot time that comes after the desired event (-1 if the leg ends before a snapshot appears).</param>
/// <returns>The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.</returns>
CHAKRA_API JsTTDGetSnapShotBoundInterval(
_In_ JsRuntimeHandle runtimeHandle,
_In_ int64_t targetEventTime,
_Out_ int64_t* startSnapTime,
_Out_ int64_t* endSnapTime);
/// <summary>
/// TTD API -- may change in future versions:
/// Get the snapshot interval that precedes the one given by currentSnapStartTime (or -1 if there is no such interval).
/// </summary>
/// <param name="runtimeHandle">The runtime handle that the script is executing in.</param>
/// <param name="currentSnapStartTime">The current snapshot interval start time.</param>
/// <param name="previousSnapTime">The resulting previous snapshot interval start time or -1 if no such time.</param>
/// <returns>The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.</returns>
CHAKRA_API JsTTDGetPreviousSnapshotInterval(
_In_ JsRuntimeHandle runtimeHandle,
_In_ int64_t currentSnapStartTime,
_Out_ int64_t* previousSnapTime);
/// <summary>
/// TTD API -- may change in future versions:
/// During debug operations some additional information is populated during replay. This runs the code between the given
/// snapshots to populate this information which may be needed by the debugger to determine time-travel jump targets.
/// </summary>
/// <param name="runtimeHandle">The runtime handle that the script is executing in.</param>
///<param name = "startSnapTime">The snapshot time that we will start executing from.< / param>
///<param name = "endSnapTime">The snapshot time that we will stop at (or -1 if we want to run to the end).< / param>
/// <param name="moveMode">Additional flags for controling how the move is done.</param>
/// <param name="newTargetEventTime">The updated target event time set according to the moveMode (-1 if not found).</param>
/// <returns>The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.</returns>
CHAKRA_API JsTTDPreExecuteSnapShotInterval(
_In_ JsRuntimeHandle runtimeHandle,
_In_ int64_t startSnapTime,
_In_ int64_t endSnapTime,
_In_ JsTTDMoveMode moveMode,
_Out_ int64_t* newTargetEventTime);
/// <summary>
/// TTD API -- may change in future versions:
/// Move to the given top-level call event time (assuming JsTTDPrepContextsForTopLevelEventMove) was called previously to reset any script contexts.
/// This also computes the ready-to-run snapshot if needed.
/// </summary>
/// <param name="runtimeHandle">The runtime handle that the script is executing in.</param>
/// <param name="moveMode">Additional flags for controling how the move is done.</param>
/// <param name="snapshotTime">The event time that we will start executing from to move to the given target time.</param>
/// <param name="eventTime">The event that we want to move to.</param>
/// <returns>The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.</returns>
CHAKRA_API
JsTTDMoveToTopLevelEvent(
_In_ JsRuntimeHandle runtimeHandle,
_In_ JsTTDMoveMode moveMode,
_In_ int64_t snapshotTime,
_In_ int64_t eventTime);
/// <summary>
/// TTD API -- may change in future versions:
/// Execute from the current point in the log to the end returning the error code.
/// </summary>
/// <param name="moveMode">Additional flags for controling how the move is done.</param>
/// <param name="rootEventTime">The event time that we should move to next or notification (-1) that replay has ended.</param>
/// <returns>
/// If the debugger requested an abort the code is JsNoError -- rootEventTime is the target event time we need to move to and re - execute from.
/// If we aborted at the end of the replay log the code is JsNoError -- rootEventTime is -1.
/// If there was an unhandled script exception the code is JsErrorCategoryScript.
/// </returns>
CHAKRA_API
JsTTDReplayExecution(
_Inout_ JsTTDMoveMode* moveMode,
_Out_ int64_t* rootEventTime);
/// <summary>
/// TTD API -- may change in future versions:
/// Enable or disable autotrace ability from JsRT.
/// </summary>
/// <param name="status">True to enable autotracing false to disable it.</param>
/// <returns>The code <c>JsNoError</c> if the operation succeeded, a failure code otherwise.</returns>
C
gitextract_l0pubcul/
├── .github/
│ └── FUNDING.yml
├── .gitignore
├── .gitmodules
├── LICENSE
├── README.md
├── include/
│ ├── ChakraCommon.h
│ ├── ChakraCore.h
│ ├── ChakraCoreVersion.h
│ └── ChakraDebug.h
├── packages.config
├── samples/
│ ├── HostSample/
│ │ ├── ChakraCoreHostMainData.dfm
│ │ ├── ChakraCoreHostMainData.pas
│ │ ├── ChakraCoreHostSample.XE.dproj
│ │ ├── ChakraCoreHostSample.dof
│ │ ├── ChakraCoreHostSample.dpr
│ │ ├── ChakraCoreHostSample.lpi
│ │ ├── ChakraCoreHostSample.res
│ │ ├── Console.pas
│ │ └── scripts/
│ │ ├── json2.js
│ │ └── main.js
│ ├── NodeSample/
│ │ ├── EventEmitter.pas
│ │ ├── NodeMainData.dfm
│ │ ├── NodeMainData.pas
│ │ ├── NodeProcess.pas
│ │ ├── NodeSample.XE.dproj
│ │ ├── NodeSample.dof
│ │ ├── NodeSample.dpr
│ │ ├── NodeSample.lpi
│ │ ├── NodeSample.res
│ │ ├── README.md
│ │ ├── demo_commonmark.js
│ │ ├── demo_graphql.js
│ │ ├── demo_json-query.js
│ │ ├── demo_lodash.js
│ │ └── demo_moment.js
│ ├── Samples.XE.groupproj
│ ├── Samples.bpg
│ ├── Samples.lpg
│ ├── SimpleHostSample/
│ │ ├── SimpleHost.XE.dproj
│ │ ├── SimpleHost.dof
│ │ ├── SimpleHost.dpr
│ │ ├── SimpleHost.lpi
│ │ ├── SimpleHost.res
│ │ └── scripts/
│ │ └── hello.js
│ └── WasmSample/
│ ├── README.md
│ ├── WasmMainData.dfm
│ ├── WasmMainData.pas
│ ├── WasmMainForm.dfm
│ ├── WasmMainForm.pas
│ ├── WasmSample.XE.dproj
│ ├── WasmSample.dof
│ ├── WasmSample.dpr
│ ├── WasmSample.lpi
│ ├── WasmSample.res
│ └── scripts/
│ ├── main.js
│ └── main.wasm
├── src/
│ ├── ChakraCommon.pas
│ ├── ChakraCore.pas
│ ├── ChakraCoreClasses.pas
│ ├── ChakraCoreUtils.pas
│ ├── ChakraCoreVersion.pas
│ ├── ChakraDebug.pas
│ ├── Compat.pas
│ └── common.inc
└── tests/
├── ChakraCoreTests.XE.dproj
├── ChakraCoreTests.dof
├── ChakraCoreTests.dpr
├── ChakraCoreTests.lpi
├── ChakraCoreTests.res
├── ChakraCoreTestsUI.XE.dproj
├── ChakraCoreTestsUI.dof
├── ChakraCoreTestsUI.dpr
├── ChakraCoreTestsUI.lpi
├── ChakraCoreTestsUI.res
├── Test_ChakraCore.pas
├── Test_Classes.pas
└── tests.sh
SYMBOL INDEX (39 symbols across 6 files)
FILE: include/ChakraCommon.h
type DWORD_PTR (line 34) | typedef DWORD_PTR ChakraCookie;
type BYTE (line 35) | typedef BYTE* ChakraBytePtr;
type ChakraCookie (line 79) | typedef uintptr_t ChakraCookie;
type UINT32 (line 84) | typedef uint32_t UINT32;
type INT64 (line 85) | typedef int64_t INT64;
type BYTE (line 87) | typedef unsigned char BYTE;
type BYTE (line 88) | typedef BYTE byte;
type UINT32 (line 89) | typedef UINT32 DWORD;
type WCHAR (line 90) | typedef unsigned short WCHAR;
type JsRef (line 382) | typedef JsRef JsContextRef;
type JsRef (line 391) | typedef JsRef JsValueRef;
type ChakraCookie (line 396) | typedef ChakraCookie JsSourceContext;
type JsRef (line 414) | typedef JsRef JsPropertyIdRef;
type JsRuntimeAttributes (line 419) | typedef enum _JsRuntimeAttributes
type JsTypedArrayType (line 476) | typedef enum _JsTypedArrayType
type JsMemoryEventType (line 519) | typedef enum _JsMemoryEventType
type JsParseScriptAttributes (line 538) | typedef enum _JsParseScriptAttributes {
type JsPropertyIdType (line 557) | typedef enum _JsPropertyIdType {
type JsValueType (line 571) | typedef enum _JsValueType
type _Ret_maybenull_ (line 715) | typedef _Ret_maybenull_ JsValueRef(CHAKRA_CALLBACK * JsNativeFunction)(_...
FILE: include/ChakraCore.h
type JsParseModuleSourceFlags (line 54) | typedef enum JsParseModuleSourceFlags
type JsModuleHostInfoKind (line 72) | typedef enum JsModuleHostInfoKind
type JsPromiseState (line 103) | typedef enum _JsPromiseState
type JsNativeFunctionInfo (line 176) | typedef struct JsNativeFunctionInfo
type _Ret_maybenull_ (line 196) | typedef _Ret_maybenull_ JsValueRef(CHAKRA_CALLBACK * JsEnhancedNativeFun...
type JsRef (line 780) | typedef JsRef JsWeakRef;
FILE: include/ChakraDebug.h
type __int64 (line 25) | typedef __int64 int64_t;
type JsDiagDebugEvent (line 32) | typedef enum _JsDiagDebugEvent
type JsDiagBreakOnExceptionAttributes (line 67) | typedef enum _JsDiagBreakOnExceptionAttributes
type JsDiagStepType (line 86) | typedef enum _JsDiagStepType
type JsTTDMoveMode (line 614) | typedef enum _JsTTDMoveModes
FILE: samples/HostSample/scripts/json2.js
function f (line 168) | function f(n) {
function this_value (line 175) | function this_value() {
function quote (line 204) | function quote(string) {
function str (line 223) | function str(key, holder) {
function walk (line 427) | function walk(holder, key) {
FILE: samples/NodeSample/demo_graphql.js
method resolve (line 11) | resolve() {
function run (line 19) | function run(query) {
FILE: samples/WasmSample/scripts/main.js
constant DIMENSIONS (line 1) | const DIMENSIONS = 50;
Condensed preview — 77 files, each showing path, character count, and a content snippet. Download the .json file or copy for the full structured content (832K chars).
[
{
"path": ".github/FUNDING.yml",
"chars": 15,
"preview": "github: tondrej"
},
{
"path": ".gitignore",
"chars": 1704,
"preview": "# Uncomment these types if you want even more clean repository. But be careful.\n# It can make harm to an existing projec"
},
{
"path": ".gitmodules",
"chars": 79,
"preview": "[submodule \"ext/jedi\"]\n\tpath = ext/jedi\n\turl = https://github.com/tondrej/jedi\n"
},
{
"path": "LICENSE",
"chars": 1069,
"preview": "MIT License\n\nCopyright (c) 2021 Ondrej Kelle\n\nPermission is hereby granted, free of charge, to any person obtaining a co"
},
{
"path": "README.md",
"chars": 1130,
"preview": "# chakracore-delphi\n\n[](https://gith"
},
{
"path": "include/ChakraCommon.h",
"chars": 93799,
"preview": "//-------------------------------------------------------------------------------------------------------\n// Copyright ("
},
{
"path": "include/ChakraCore.h",
"chars": 52075,
"preview": "//-------------------------------------------------------------------------------------------------------\n// Copyright ("
},
{
"path": "include/ChakraCoreVersion.h",
"chars": 2659,
"preview": "//-------------------------------------------------------------------------------------------------------\n// Copyright ("
},
{
"path": "include/ChakraDebug.h",
"chars": 47103,
"preview": "//-------------------------------------------------------------------------------------------------------\n// Copyright ("
},
{
"path": "packages.config",
"chars": 180,
"preview": "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<packages>\n <package id=\"Microsoft.ChakraCore.vc140\" version=\"1.11.24\" targetFr"
},
{
"path": "samples/HostSample/ChakraCoreHostMainData.dfm",
"chars": 159,
"preview": "object DataModuleMain: TDataModuleMain\n OldCreateOrder = False\n OnCreate = DataModuleCreate\n OnDestroy = DataModuleDe"
},
{
"path": "samples/HostSample/ChakraCoreHostMainData.pas",
"chars": 9277,
"preview": "(*\n\nMIT License\n\nCopyright (c) 2021 Ondrej Kelle\n\nPermission is hereby granted, free of charge, to any person obtaining "
},
{
"path": "samples/HostSample/ChakraCoreHostSample.XE.dproj",
"chars": 5453,
"preview": "\t<Project xmlns=\"http://schemas.microsoft.com/developer/msbuild/2003\">\n\t\t<PropertyGroup>\n\t\t\t<ProjectGuid>{2b63895c-8001"
},
{
"path": "samples/HostSample/ChakraCoreHostSample.dof",
"chars": 2708,
"preview": "[FileVersion]\nVersion=7.0\n[Compiler]\nA=8\nB=0\nC=1\nD=1\nE=0\nF=0\nG=1\nH=1\nI=1\nJ=0\nK=0\nL=1\nM=0\nN=1\nO=0\nP=1\nQ=0\nR=0\nS=0\nT=0\nU=0"
},
{
"path": "samples/HostSample/ChakraCoreHostSample.dpr",
"chars": 2582,
"preview": "(*\n\nMIT License\n\nCopyright (c) 2021 Ondrej Kelle\n\nPermission is hereby granted, free of charge, to any person obtaining "
},
{
"path": "samples/HostSample/ChakraCoreHostSample.lpi",
"chars": 3447,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<CONFIG>\n <ProjectOptions>\n <Version Value=\"10\"/>\n <General>\n <Flags>"
},
{
"path": "samples/HostSample/Console.pas",
"chars": 6570,
"preview": "(*\n\nMIT License\n\nCopyright (c) 2021 Ondrej Kelle\n\nPermission is hereby granted, free of charge, to any person obtaining "
},
{
"path": "samples/HostSample/scripts/json2.js",
"chars": 18432,
"preview": "// json2.js\n// 2016-10-28\n// Public Domain.\n// NO WARRANTY EXPRESSED OR IMPLIED. USE AT YOUR OWN RISK.\n// See http:"
},
{
"path": "samples/HostSample/scripts/main.js",
"chars": 1292,
"preview": "var p = new Promise((resolve, reject) => {\n\tsetTimeout(c => {\n\t\tresolve(\"Success!\");\n\t}, 100, console);\n});\np.then(\n r "
},
{
"path": "samples/NodeSample/EventEmitter.pas",
"chars": 18777,
"preview": "(*\n\nMIT License\n\nCopyright (c) 2021 Ondrej Kelle\n\nPermission is hereby granted, free of charge, to any person obtaining "
},
{
"path": "samples/NodeSample/NodeMainData.dfm",
"chars": 159,
"preview": "object DataModuleMain: TDataModuleMain\n OldCreateOrder = False\n OnCreate = DataModuleCreate\n OnDestroy = DataModuleDe"
},
{
"path": "samples/NodeSample/NodeMainData.pas",
"chars": 18499,
"preview": "(*\n\nMIT License\n\nCopyright (c) 2021 Ondrej Kelle\n\nPermission is hereby granted, free of charge, to any person obtaining "
},
{
"path": "samples/NodeSample/NodeProcess.pas",
"chars": 4271,
"preview": "(*\n\nMIT License\n\nCopyright (c) 2021 Ondrej Kelle\n\nPermission is hereby granted, free of charge, to any person obtaining "
},
{
"path": "samples/NodeSample/NodeSample.XE.dproj",
"chars": 5542,
"preview": "\t<Project xmlns=\"http://schemas.microsoft.com/developer/msbuild/2003\">\n\t\t<PropertyGroup>\n\t\t\t<ProjectGuid>{36d30f07-2980"
},
{
"path": "samples/NodeSample/NodeSample.dof",
"chars": 2652,
"preview": "[FileVersion]\nVersion=7.0\n[Compiler]\nA=8\nB=0\nC=1\nD=1\nE=0\nF=0\nG=1\nH=1\nI=1\nJ=0\nK=0\nL=1\nM=0\nN=1\nO=1\nP=1\nQ=0\nR=0\nS=0\nT=0\nU=0"
},
{
"path": "samples/NodeSample/NodeSample.dpr",
"chars": 2456,
"preview": "(*\n\nMIT License\n\nCopyright (c) 2021 Ondrej Kelle\n\nPermission is hereby granted, free of charge, to any person obtaining "
},
{
"path": "samples/NodeSample/NodeSample.lpi",
"chars": 3448,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<CONFIG>\n <ProjectOptions>\n <Version Value=\"11\"/>\n <General>\n <Flags>"
},
{
"path": "samples/NodeSample/README.md",
"chars": 238,
"preview": "Limited support for [Node](https://nodejs.org/en/) [modules](https://nodejs.org/api/modules.html).\n\nBlog post: [Node mod"
},
{
"path": "samples/NodeSample/demo_commonmark.js",
"chars": 511,
"preview": "console.log('***** commonmark demo *****');\n\nvar commonmark = require('commonmark');\n\nvar reader = new commonmark.Parser"
},
{
"path": "samples/NodeSample/demo_graphql.js",
"chars": 830,
"preview": "console.log('***** graphql demo *****');\n\nvar graphql = require('graphql');\n\nvar schema = new graphql.GraphQLSchema({\n "
},
{
"path": "samples/NodeSample/demo_json-query.js",
"chars": 425,
"preview": "console.log('***** json-query *****');\n\nvar jsonQuery = require('json-query');\n\nvar data = {\n people: [\n {name: 'Mat"
},
{
"path": "samples/NodeSample/demo_lodash.js",
"chars": 415,
"preview": "console.log('***** lodash demo *****');\n\nvar lodash = require('lodash');\n\nvar users = [\n { 'user': 'fred', 'age': 48 "
},
{
"path": "samples/NodeSample/demo_moment.js",
"chars": 228,
"preview": "console.log('***** moment demo *****');\n\nvar moment = require('moment');\n\nvar now = moment();\nvar fmt = 'dddd MMMM Do YY"
},
{
"path": "samples/Samples.XE.groupproj",
"chars": 3865,
"preview": "\t<Project xmlns=\"http://schemas.microsoft.com/developer/msbuild/2003\">\n\t\t<PropertyGroup>\n\t\t\t<ProjectGuid>{AB33209C-912B"
},
{
"path": "samples/Samples.bpg",
"chars": 1159,
"preview": "#------------------------------------------------------------------------------\nVERSION = BWS.01\n#----------------------"
},
{
"path": "samples/Samples.lpg",
"chars": 1246,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<CONFIG>\n <ProjectGroup FileVersion=\"1\">\n <Targets Count=\"6\">\n <Target0 "
},
{
"path": "samples/SimpleHostSample/SimpleHost.XE.dproj",
"chars": 5251,
"preview": "\t<Project xmlns=\"http://schemas.microsoft.com/developer/msbuild/2003\">\n\t\t<PropertyGroup>\n\t\t\t<ProjectGuid>{01f91de3-a053"
},
{
"path": "samples/SimpleHostSample/SimpleHost.dof",
"chars": 2716,
"preview": "[FileVersion]\nVersion=7.0\n[Compiler]\nA=8\nB=0\nC=1\nD=1\nE=0\nF=0\nG=1\nH=1\nI=1\nJ=0\nK=0\nL=1\nM=0\nN=1\nO=1\nP=1\nQ=0\nR=0\nS=0\nT=0\nU=0"
},
{
"path": "samples/SimpleHostSample/SimpleHost.dpr",
"chars": 3302,
"preview": "(*\n\nMIT License\n\nCopyright (c) 2021 Ondrej Kelle\n\nPermission is hereby granted, free of charge, to any person obtaining "
},
{
"path": "samples/SimpleHostSample/SimpleHost.lpi",
"chars": 3147,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<CONFIG>\n <ProjectOptions>\n <Version Value=\"10\"/>\n <General>\n <Flags>"
},
{
"path": "samples/SimpleHostSample/scripts/hello.js",
"chars": 29,
"preview": "console.log(\"Hello, world!\");"
},
{
"path": "samples/WasmSample/README.md",
"chars": 497,
"preview": "Based on Colin Eberhardt's [Writing WebAssembly By Hand](https://blog.scottlogic.com/2018/04/26/webassembly-by-hand.html"
},
{
"path": "samples/WasmSample/WasmMainData.dfm",
"chars": 334,
"preview": "object DataModuleMain: TDataModuleMain\n OldCreateOrder = False\n OnCreate = DataModuleCreate\n Height = 265\n Width = 3"
},
{
"path": "samples/WasmSample/WasmMainData.pas",
"chars": 10525,
"preview": "(*\n\nMIT License\n\nCopyright (c) 2021 Ondrej Kelle\n\nPermission is hereby granted, free of charge, to any person obtaining "
},
{
"path": "samples/WasmSample/WasmMainForm.dfm",
"chars": 11467,
"preview": "object FormMain: TFormMain\n Left = 192\n Top = 124\n Width = 464\n Height = 639\n Caption = 'FormMain'\n Color = clBtnF"
},
{
"path": "samples/WasmSample/WasmMainForm.pas",
"chars": 5246,
"preview": "(*\n\nMIT License\n\nCopyright (c) 2021 Ondrej Kelle\n\nPermission is hereby granted, free of charge, to any person obtaining "
},
{
"path": "samples/WasmSample/WasmSample.XE.dproj",
"chars": 5532,
"preview": "\t<Project xmlns=\"http://schemas.microsoft.com/developer/msbuild/2003\">\n\t\t<PropertyGroup>\n\t\t\t<ProjectGuid>{6508e7aa-0c87"
},
{
"path": "samples/WasmSample/WasmSample.dof",
"chars": 2738,
"preview": "[FileVersion]\nVersion=7.0\n[Compiler]\nA=8\nB=0\nC=1\nD=1\nE=0\nF=0\nG=1\nH=1\nI=1\nJ=0\nK=0\nL=1\nM=0\nN=1\nO=0\nP=1\nQ=0\nR=0\nS=0\nT=0\nU=0"
},
{
"path": "samples/WasmSample/WasmSample.dpr",
"chars": 2060,
"preview": "(*\n\nMIT License\n\nCopyright (c) 2021 Ondrej Kelle\n\nPermission is hereby granted, free of charge, to any person obtaining "
},
{
"path": "samples/WasmSample/WasmSample.lpi",
"chars": 4222,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<CONFIG>\n <ProjectOptions>\n <Version Value=\"11\"/>\n <General>\n <Flags>"
},
{
"path": "samples/WasmSample/scripts/main.js",
"chars": 871,
"preview": "const DIMENSIONS = 50;\nconst verbose = false; // true;\n\nconst rand = () => Math.floor(Math.random() * DIMENSIONS);\n\nWebA"
},
{
"path": "src/ChakraCommon.pas",
"chars": 96464,
"preview": "(*\n\nMIT License\n\nCopyright (c) 2021 Ondrej Kelle\n\nPermission is hereby granted, free of charge, to any person obtaining "
},
{
"path": "src/ChakraCore.pas",
"chars": 58980,
"preview": "(*\n\nMIT License\n\nCopyright (c) 2021 Ondrej Kelle\n\nPermission is hereby granted, free of charge, to any person obtaining "
},
{
"path": "src/ChakraCoreClasses.pas",
"chars": 53553,
"preview": "(*\n\nMIT License\n\nCopyright (c) 2021 Ondrej Kelle\n\nPermission is hereby granted, free of charge, to any person obtaining "
},
{
"path": "src/ChakraCoreUtils.pas",
"chars": 47150,
"preview": "(*\n\nMIT License\n\nCopyright (c) 2021 Ondrej Kelle\n\nPermission is hereby granted, free of charge, to any person obtaining "
},
{
"path": "src/ChakraCoreVersion.pas",
"chars": 3767,
"preview": "(*\n\nMIT License\n\nCopyright (c) 2021 Ondrej Kelle\n\nPermission is hereby granted, free of charge, to any person obtaining "
},
{
"path": "src/ChakraDebug.pas",
"chars": 49231,
"preview": "(*\n\nMIT License\n\nCopyright (c) 2021 Ondrej Kelle\n\nPermission is hereby granted, free of charge, to any person obtaining "
},
{
"path": "src/Compat.pas",
"chars": 7363,
"preview": "(*\n\nMIT License\n\nCopyright (c) 2021 Ondrej Kelle\n\nPermission is hereby granted, free of charge, to any person obtaining "
},
{
"path": "src/common.inc",
"chars": 1671,
"preview": "(*\n\nMIT License\n\nCopyright (c) 2021 Ondrej Kelle\n\nPermission is hereby granted, free of charge, to any person obtaining "
},
{
"path": "tests/ChakraCoreTests.XE.dproj",
"chars": 5195,
"preview": "\t<Project xmlns=\"http://schemas.microsoft.com/developer/msbuild/2003\">\n\t\t<PropertyGroup>\n\t\t\t<ProjectGuid>{31F06C91-6ED6"
},
{
"path": "tests/ChakraCoreTests.dof",
"chars": 2642,
"preview": "[FileVersion]\nVersion=7.0\n[Compiler]\nA=8\nB=0\nC=1\nD=1\nE=0\nF=0\nG=1\nH=1\nI=1\nJ=0\nK=0\nL=1\nM=0\nN=1\nO=1\nP=1\nQ=0\nR=0\nS=0\nT=0\nU=0"
},
{
"path": "tests/ChakraCoreTests.dpr",
"chars": 2009,
"preview": "(*\n\nMIT License\n\nCopyright (c) 2021 Ondrej Kelle\n\nPermission is hereby granted, free of charge, to any person obtaining "
},
{
"path": "tests/ChakraCoreTests.lpi",
"chars": 4097,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<CONFIG>\n <ProjectOptions>\n <Version Value=\"10\"/>\n <General>\n <Sessio"
},
{
"path": "tests/ChakraCoreTestsUI.XE.dproj",
"chars": 5160,
"preview": "\t<Project xmlns=\"http://schemas.microsoft.com/developer/msbuild/2003\">\n\t\t<PropertyGroup>\n\t\t\t<ProjectGuid>{0BA6D13A-3E85"
},
{
"path": "tests/ChakraCoreTestsUI.dof",
"chars": 2640,
"preview": "[FileVersion]\nVersion=7.0\n[Compiler]\nA=8\nB=0\nC=1\nD=1\nE=0\nF=0\nG=1\nH=1\nI=1\nJ=0\nK=0\nL=1\nM=0\nN=1\nO=1\nP=1\nQ=0\nR=0\nS=0\nT=0\nU=0"
},
{
"path": "tests/ChakraCoreTestsUI.dpr",
"chars": 2661,
"preview": "(*\n\nMIT License\n\nCopyright (c) 2021 Ondrej Kelle\n\nPermission is hereby granted, free of charge, to any person obtaining "
},
{
"path": "tests/ChakraCoreTestsUI.lpi",
"chars": 4199,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<CONFIG>\n <ProjectOptions>\n <Version Value=\"11\"/>\n <General>\n <Sessio"
},
{
"path": "tests/Test_ChakraCore.pas",
"chars": 38197,
"preview": "(*\n\nMIT License\n\nCopyright (c) 2021 Ondrej Kelle\n\nPermission is hereby granted, free of charge, to any person obtaining "
},
{
"path": "tests/Test_Classes.pas",
"chars": 34011,
"preview": "(*\n\nMIT License\n\nCopyright (c) 2021 Ondrej Kelle\n\nPermission is hereby granted, free of charge, to any person obtaining "
},
{
"path": "tests/tests.sh",
"chars": 6730,
"preview": "#!/bin/bash\n\nfunction GetChakraCoreLibDir {\n CPU_TARGET=$1\n OS_TARGET=$2\n local __RESULT=$3\n \n eval $__RESULT=$BASE"
}
]
// ... and 7 more files (download for full content)
About this extraction
This page contains the full source code of the tondrej/chakracore-delphi GitHub repository, extracted and formatted as plain text for AI agents and large language models (LLMs). The extraction includes 77 files (779.4 KB), approximately 207.2k tokens, and a symbol index with 39 extracted functions, classes, methods, constants, and types. Use this with OpenClaw, Claude, ChatGPT, Cursor, Windsurf, or any other AI tool that accepts text input. You can copy the full output to your clipboard or download it as a .txt file.
Extracted by GitExtract — free GitHub repo to text converter for AI. Built by Nikandr Surkov.