GeezerVison is showing github.com — JavaScriptKit/Sources/_CJavaScriptKit/include/_CJavaScriptKit.h at main · aehlke/JavaScriptKit

Expand file tree

_CJavaScriptKit.h

Copy path

More file actions

Latest commit

History

363 lines (320 loc) · 19.6 KB

_CJavaScriptKit.h

Copy path

File metadata and controls

363 lines (320 loc) · 19.6 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

#ifndef _CJavaScriptKit_h

#define _CJavaScriptKit_h

#if __has_include("stdlib.h")

#include <stdlib.h>

#else

#include <stddef.h>

#endif

#include <stdbool.h>

#include <stdint.h>

/// `JavaScriptObjectRef` represents JavaScript object reference that is referenced by Swift side.

/// This value is an address of `SwiftRuntimeHeap`.

typedef unsigned int JavaScriptObjectRef;

/// `JavaScriptHostFuncRef` represents Swift closure that is referenced by JavaScript side.

/// This value is produced by `JSClosure`.

typedef uintptr_t JavaScriptHostFuncRef;

/// `JavaScriptValueKind` represents the kind of JavaScript primitive value.

typedef enum __attribute__((enum_extensibility(closed))) {

JavaScriptValueKindBoolean = 0,

JavaScriptValueKindString = 1,

JavaScriptValueKindNumber = 2,

JavaScriptValueKindObject = 3,

JavaScriptValueKindNull = 4,

JavaScriptValueKindUndefined = 5,

JavaScriptValueKindSymbol = 7,

JavaScriptValueKindBigInt = 8,

} JavaScriptValueKind;

typedef uint32_t JavaScriptRawValueKindAndFlags;

typedef unsigned JavaScriptPayload1;

typedef double JavaScriptPayload2;

/// `RawJSValue` is abstract representation of JavaScript primitive value.

///

/// For boolean value:

/// payload1: 1 or 0

/// payload2: 0

///

/// For string value:

/// payload1: `JavaScriptObjectRef` of string

/// payload2: 0

///

/// For number value:

/// payload1: 0

/// payload2: double number

///

/// For object value:

/// payload1: `JavaScriptObjectRef`

/// payload2: 0

/// For null value:

/// payload1: 0

/// payload2: 0

///

/// For undefined value:

/// payload1: 0

/// payload2: 0

///

/// For function value:

/// payload1: the target `JavaScriptHostFuncRef`

/// payload2: 0

///

/// For symbol and bigint values:

/// payload1: `JavaScriptObjectRef`

/// payload2: 0

///

typedef struct {

JavaScriptValueKind kind;

JavaScriptPayload1 payload1;

JavaScriptPayload2 payload2;

} RawJSValue;

#if __wasm32__

# define IMPORT_JS_FUNCTION(name, returns, args) \

__attribute__((__import_module__("javascript_kit"), __import_name__(#name))) extern returns name args;

#else

# define IMPORT_JS_FUNCTION(name, returns, args) \

static inline returns name args { \

abort(); \

}

#endif

/// Sets a value of `_this` JavaScript object.

///

/// @param _this The target JavaScript object to set the given value.

/// @param prop A JavaScript string object to reference a member of `_this` object.

/// @param kind A kind of JavaScript value to set the target object.

/// @param payload1 The first payload of JavaScript value to set the target object.

/// @param payload2 The second payload of JavaScript value to set the target object.

IMPORT_JS_FUNCTION(swjs_set_prop, void, (const JavaScriptObjectRef _this,

const JavaScriptObjectRef prop,

const JavaScriptValueKind kind,

const JavaScriptPayload1 payload1,

const JavaScriptPayload2 payload2))

/// Gets a value of `_this` JavaScript object.

///

/// @param _this The target JavaScript object to get its member value.

/// @param prop A JavaScript string object to reference a member of `_this` object.

/// @param payload1 A result pointer of first payload of JavaScript value to set the target object.

/// @param payload2 A result pointer of second payload of JavaScript value to set the target object.

/// @return A `JavaScriptValueKind` bits represented as 32bit integer for the returned value.

IMPORT_JS_FUNCTION(swjs_get_prop, uint32_t, (const JavaScriptObjectRef _this,

const JavaScriptObjectRef prop,

JavaScriptPayload1 * _Nonnull payload1,

JavaScriptPayload2 * _Nonnull payload2))

/// Sets a value of `_this` JavaScript object.

///

/// @param _this The target JavaScript object to set its member value.

/// @param index A subscript index to set value.

/// @param kind A kind of JavaScript value to set the target object.

/// @param payload1 The first payload of JavaScript value to set the target object.

/// @param payload2 The second payload of JavaScript value to set the target object.

IMPORT_JS_FUNCTION(swjs_set_subscript, void, (const JavaScriptObjectRef _this,

const int index,

const JavaScriptValueKind kind,

const JavaScriptPayload1 payload1,

const JavaScriptPayload2 payload2))

/// Gets a value of `_this` JavaScript object.

///

/// @param _this The target JavaScript object to get its member value.

/// @param index A subscript index to get value.

/// @param payload1 A result pointer of first payload of JavaScript value to get the target object.

/// @param payload2 A result pointer of second payload of JavaScript value to get the target object.

/// @return A `JavaScriptValueKind` bits represented as 32bit integer for the returned value.

/// get a value of `_this` JavaScript object.

IMPORT_JS_FUNCTION(swjs_get_subscript, uint32_t, (const JavaScriptObjectRef _this,

const int index,

JavaScriptPayload1 * _Nonnull payload1,

JavaScriptPayload2 * _Nonnull payload2))

/// Encodes the `str_obj` to bytes sequence and returns the length of bytes.

///

/// @param str_obj A JavaScript string object ref to encode.

/// @param bytes_result A result pointer of bytes sequence representation in JavaScript.

/// This value will be used to load the actual bytes using `_load_string`.

/// @result The length of bytes sequence. This value will be used to allocate Swift side string buffer to load the actual bytes.

IMPORT_JS_FUNCTION(swjs_encode_string, int, (const JavaScriptObjectRef str_obj, JavaScriptObjectRef * _Nonnull bytes_result))

/// Decodes the given bytes sequence into JavaScript string object.

///

/// @param bytes_ptr A `uint8_t` byte sequence to decode.

/// @param length The length of `bytes_ptr`.

/// @result The decoded JavaScript string object.

IMPORT_JS_FUNCTION(swjs_decode_string, JavaScriptObjectRef, (const unsigned char * _Nonnull bytes_ptr, const int length))

/// Loads the actual bytes sequence of `bytes` into `buffer` which is a Swift side memory address.

///

/// @param bytes A bytes sequence representation in JavaScript to load. This value should be derived from `_encode_string`.

/// @param buffer A Swift side string buffer to load the bytes.

IMPORT_JS_FUNCTION(swjs_load_string, void, (const JavaScriptObjectRef bytes, unsigned char * _Nonnull buffer))

/// Converts the provided Int64 or UInt64 to a BigInt in slow path by splitting 64bit integer to two 32bit integers

/// to avoid depending on [JS-BigInt-integration](https://github.com/WebAssembly/JS-BigInt-integration) feature

///

/// @param lower The lower 32bit of the value to convert.

/// @param upper The upper 32bit of the value to convert.

/// @param is_signed Whether to treat the value as a signed integer or not.

IMPORT_JS_FUNCTION(swjs_i64_to_bigint_slow, JavaScriptObjectRef, (unsigned int lower, unsigned int upper, bool is_signed))

/// Calls JavaScript function with given arguments list.

///

/// @param ref The target JavaScript function to call.

/// @param argv A list of `RawJSValue` arguments to apply.

/// @param argc The length of `argv``.

/// @param result_payload1 A result pointer of first payload of JavaScript value of returned result or thrown exception.

/// @param result_payload2 A result pointer of second payload of JavaScript value of returned result or thrown exception.

/// @return A `JavaScriptValueKindAndFlags` bits represented as 32bit integer for the returned value.

IMPORT_JS_FUNCTION(swjs_call_function, uint32_t, (const JavaScriptObjectRef ref,

const RawJSValue * _Nullable argv,

const int argc,

JavaScriptPayload1 * _Nonnull result_payload1,

JavaScriptPayload2 * _Nonnull result_payload2))

/// Calls JavaScript function with given arguments list without capturing any exception

///

/// @param ref The target JavaScript function to call.

/// @param argv A list of `RawJSValue` arguments to apply.

/// @param argc The length of `argv``.

/// @param result_payload1 A result pointer of first payload of JavaScript value of returned result or thrown exception.

/// @param result_payload2 A result pointer of second payload of JavaScript value of returned result or thrown exception.

/// @return A `JavaScriptValueKindAndFlags` bits represented as 32bit integer for the returned value.

IMPORT_JS_FUNCTION(swjs_call_function_no_catch, uint32_t, (const JavaScriptObjectRef ref,

const RawJSValue * _Nullable argv,

const int argc,

JavaScriptPayload1 * _Nonnull result_payload1,

JavaScriptPayload2 * _Nonnull result_payload2))

/// Calls JavaScript function with given arguments list and given `_this`.

///

/// @param _this The value of `this` provided for the call to `func_ref`.

/// @param func_ref The target JavaScript function to call.

/// @param argv A list of `RawJSValue` arguments to apply.

/// @param argc The length of `argv``.

/// @param result_payload1 A result pointer of first payload of JavaScript value of returned result or thrown exception.

/// @param result_payload2 A result pointer of second payload of JavaScript value of returned result or thrown exception.

/// @return A `JavaScriptValueKindAndFlags` bits represented as 32bit integer for the returned value.

IMPORT_JS_FUNCTION(swjs_call_function_with_this, uint32_t, (const JavaScriptObjectRef _this,

const JavaScriptObjectRef func_ref,

const RawJSValue * _Nullable argv,

const int argc,

JavaScriptPayload1 * _Nonnull result_payload1,

JavaScriptPayload2 * _Nonnull result_payload2))

/// Calls JavaScript function with given arguments list and given `_this` without capturing any exception.

///

/// @param _this The value of `this` provided for the call to `func_ref`.

/// @param func_ref The target JavaScript function to call.

/// @param argv A list of `RawJSValue` arguments to apply.

/// @param argc The length of `argv``.

/// @param result_payload1 A result pointer of first payload of JavaScript value of returned result or thrown exception.

/// @param result_payload2 A result pointer of second payload of JavaScript value of returned result or thrown exception.

/// @return A `JavaScriptValueKindAndFlags` bits represented as 32bit integer for the returned value.

IMPORT_JS_FUNCTION(swjs_call_function_with_this_no_catch, uint32_t, (const JavaScriptObjectRef _this,

const JavaScriptObjectRef func_ref,

const RawJSValue * _Nullable argv,

const int argc,

JavaScriptPayload1 * _Nonnull result_payload1,

JavaScriptPayload2 * _Nonnull result_payload2))

/// Calls JavaScript object constructor with given arguments list.

///

/// @param ref The target JavaScript constructor to call.

/// @param argv A list of `RawJSValue` arguments to apply.

/// @param argc The length of `argv``.

/// @returns A reference to the constructed object.

IMPORT_JS_FUNCTION(swjs_call_new, JavaScriptObjectRef, (const JavaScriptObjectRef ref,

const RawJSValue * _Nullable argv,

const int argc))

/// Calls JavaScript object constructor with given arguments list.

///

/// @param ref The target JavaScript constructor to call.

/// @param argv A list of `RawJSValue` arguments to apply.

/// @param argc The length of `argv``.

/// @param exception_kind A result pointer of JavaScript value kind of thrown exception.

/// @param exception_payload1 A result pointer of first payload of JavaScript value of thrown exception.

/// @param exception_payload2 A result pointer of second payload of JavaScript value of thrown exception.

/// @returns A reference to the constructed object.

IMPORT_JS_FUNCTION(swjs_call_throwing_new, JavaScriptObjectRef, (const JavaScriptObjectRef ref,

const RawJSValue * _Nullable argv,

const int argc,

JavaScriptRawValueKindAndFlags * _Nonnull exception_kind,

JavaScriptPayload1 * _Nonnull exception_payload1,

JavaScriptPayload2 * _Nonnull exception_payload2))

/// Acts like JavaScript `instanceof` operator.

///

/// @param obj The target object to check its prototype chain.

/// @param constructor The `constructor` object to check against.

/// @result Return `true` if `constructor` appears anywhere in the prototype chain of `obj`. Return `false` if not.

IMPORT_JS_FUNCTION(swjs_instanceof, bool, (const JavaScriptObjectRef obj,

const JavaScriptObjectRef constructor))

/// Acts like JavaScript `==` operator.

/// Performs "==" comparison, a.k.a the "Abstract Equality Comparison"

/// algorithm defined in the ECMAScript.

/// https://262.ecma-international.org/11.0/#sec-abstract-equality-comparison

///

/// @param lhs The left-hand side value to compare.

/// @param rhs The right-hand side value to compare.

/// @result Return `true` if `lhs` is `==` to `rhs`. Return `false` if not.

IMPORT_JS_FUNCTION(swjs_value_equals, bool, (const JavaScriptObjectRef lhs, const JavaScriptObjectRef rhs))

/// Creates a JavaScript thunk function that calls Swift side closure.

/// See also comments on JSFunction.swift

///

/// @param host_func_id The target Swift side function called by the created thunk function.

/// @param line The line where the function is created. Will be used for diagnostics

/// @param file The file name where the function is created. Will be used for diagnostics

/// @returns A reference to the newly-created JavaScript thunk function

IMPORT_JS_FUNCTION(swjs_create_function, JavaScriptObjectRef, (const JavaScriptHostFuncRef host_func_id,

unsigned int line,

JavaScriptObjectRef file))

/// Creates a oneshot JavaScript thunk function that calls Swift side closure.

///

/// @param host_func_id The target Swift side function called by the created thunk function.

/// @param line The line where the function is created. Will be used for diagnostics

/// @param file The file name where the function is created. Will be used for diagnostics

/// @returns A reference to the newly-created JavaScript thunk function

IMPORT_JS_FUNCTION(swjs_create_oneshot_function, JavaScriptObjectRef, (const JavaScriptHostFuncRef host_func_id,

unsigned int line,

JavaScriptObjectRef file))

/// Instantiates a new `TypedArray` object with given elements

/// This is used to provide an efficient way to create `TypedArray`.

///

/// @param constructor The `TypedArray` constructor.

/// @param elements_ptr The elements pointer to initialize. They are assumed to be the same size of `constructor` elements size.

/// @param length The length of `elements_ptr`

/// @returns A reference to the constructed typed array

IMPORT_JS_FUNCTION(swjs_create_typed_array, JavaScriptObjectRef, (const JavaScriptObjectRef constructor,

const void * _Nullable elements_ptr,

const int length))

/// Copies the byte contents of a typed array into a Swift side memory buffer.

///

/// @param ref A JavaScript typed array object.

/// @param buffer A Swift side buffer into which to copy the bytes.

IMPORT_JS_FUNCTION(swjs_load_typed_array, void, (const JavaScriptObjectRef ref, unsigned char * _Nonnull buffer))

/// Decrements reference count of `ref` retained by `SwiftRuntimeHeap` in JavaScript side.

///

/// @param ref The target JavaScript object.

IMPORT_JS_FUNCTION(swjs_release, void, (const JavaScriptObjectRef ref))

/// Decrements reference count of `ref` retained by `SwiftRuntimeHeap` in `object_tid` thread.

///

/// @param object_tid The TID of the thread that owns the target object.

/// @param ref The target JavaScript object.

IMPORT_JS_FUNCTION(swjs_release_remote, void, (int object_tid, const JavaScriptObjectRef ref))

/// Yields current program control by throwing `UnsafeEventLoopYield` JavaScript exception.

/// See note on `UnsafeEventLoopYield` for more details

///

/// @note This function never returns

IMPORT_JS_FUNCTION(swjs_unsafe_event_loop_yield, void, (void))

IMPORT_JS_FUNCTION(swjs_send_job_to_main_thread, void, (uintptr_t job))

IMPORT_JS_FUNCTION(swjs_listen_message_from_main_thread, void, (void))

IMPORT_JS_FUNCTION(swjs_wake_up_worker_thread, void, (int tid))

IMPORT_JS_FUNCTION(swjs_listen_message_from_worker_thread, void, (int tid))

IMPORT_JS_FUNCTION(swjs_terminate_worker_thread, void, (int tid))

IMPORT_JS_FUNCTION(swjs_get_worker_thread_id, int, (void))

IMPORT_JS_FUNCTION(swjs_create_object, JavaScriptObjectRef, (void))

#define SWJS_MAIN_THREAD_ID -1

int swjs_get_worker_thread_id_cached(void);

/// Requests sending a JavaScript object to another worker thread.

///

/// This must be called from the destination thread of the transfer.

IMPORT_JS_FUNCTION(swjs_request_sending_object, void, (JavaScriptObjectRef sending_object,

const JavaScriptObjectRef * _Nonnull transferring_objects,

int transferring_objects_count,

int object_source_tid,

void * _Nonnull sending_context))

IMPORT_JS_FUNCTION(swjs_request_sending_objects, void, (const JavaScriptObjectRef * _Nonnull sending_objects,

int sending_objects_count,

const JavaScriptObjectRef * _Nonnull transferring_objects,

int transferring_objects_count,

int object_source_tid,

void * _Nonnull sending_context))

/// Requests invoking a Swift closure associated with `invocation_context` on `object_source_tid`.

/// This must be called from a non-owner thread and will asynchronously notify completion.

IMPORT_JS_FUNCTION(swjs_request_remote_jsobject_body, void, (int object_source_tid,

void * _Nonnull invocation_context))

#endif /* _CJavaScriptKit_h */