@lynx-js/lynx-library-headers 0.0.1-alpha.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (135) hide show
  1. package/README.md +53 -0
  2. package/include/base/include/value/lynx_api_types.h +57 -0
  3. package/include/base/include/value/lynx_value_api.h +204 -0
  4. package/include/base/include/value/lynx_value_types.h +73 -0
  5. package/include/capi/lynx_env_capi.h +47 -0
  6. package/include/capi/lynx_event_reporter_service_capi.h +67 -0
  7. package/include/capi/lynx_export.h +27 -0
  8. package/include/capi/lynx_extension_module_capi.h +148 -0
  9. package/include/capi/lynx_extension_module_types_capi.h +17 -0
  10. package/include/capi/lynx_generic_resource_fetcher_capi.h +124 -0
  11. package/include/capi/lynx_group_capi.h +42 -0
  12. package/include/capi/lynx_http_service_capi.h +113 -0
  13. package/include/capi/lynx_load_meta_capi.h +52 -0
  14. package/include/capi/lynx_log_capi.h +69 -0
  15. package/include/capi/lynx_memory_capi.h +28 -0
  16. package/include/capi/lynx_native_module_capi.h +51 -0
  17. package/include/capi/lynx_native_view_capi.h +163 -0
  18. package/include/capi/lynx_resource_request_capi.h +71 -0
  19. package/include/capi/lynx_resource_response_capi.h +92 -0
  20. package/include/capi/lynx_runtime_lifecycle_observer_capi.h +62 -0
  21. package/include/capi/lynx_security_service_capi.h +52 -0
  22. package/include/capi/lynx_service_center_capi.h +50 -0
  23. package/include/capi/lynx_template_bundle_capi.h +39 -0
  24. package/include/capi/lynx_template_data_capi.h +33 -0
  25. package/include/capi/lynx_trace_capi.h +62 -0
  26. package/include/capi/lynx_trail_service_capi.h +35 -0
  27. package/include/capi/lynx_types.h +750 -0
  28. package/include/capi/lynx_update_meta_capi.h +33 -0
  29. package/include/capi/lynx_view_builder_capi.h +113 -0
  30. package/include/capi/lynx_view_capi.h +174 -0
  31. package/include/capi/lynx_view_client_capi.h +81 -0
  32. package/include/capi/lynx_vsync_monitor_capi.h +38 -0
  33. package/include/capi/lynx_windowless_renderer_capi.h +213 -0
  34. package/include/js_native_api.h +608 -0
  35. package/include/js_native_api_types.h +202 -0
  36. package/include/lynx/base/include/value/lynx_api_types.h +57 -0
  37. package/include/lynx/base/include/value/lynx_value_api.h +204 -0
  38. package/include/lynx/base/include/value/lynx_value_types.h +73 -0
  39. package/include/lynx/extension.h +6 -0
  40. package/include/lynx/platform/embedder/public/capi/lynx_env_capi.h +47 -0
  41. package/include/lynx/platform/embedder/public/capi/lynx_event_reporter_service_capi.h +67 -0
  42. package/include/lynx/platform/embedder/public/capi/lynx_export.h +27 -0
  43. package/include/lynx/platform/embedder/public/capi/lynx_extension_module_capi.h +148 -0
  44. package/include/lynx/platform/embedder/public/capi/lynx_extension_module_types_capi.h +17 -0
  45. package/include/lynx/platform/embedder/public/capi/lynx_generic_resource_fetcher_capi.h +124 -0
  46. package/include/lynx/platform/embedder/public/capi/lynx_group_capi.h +42 -0
  47. package/include/lynx/platform/embedder/public/capi/lynx_http_service_capi.h +113 -0
  48. package/include/lynx/platform/embedder/public/capi/lynx_load_meta_capi.h +52 -0
  49. package/include/lynx/platform/embedder/public/capi/lynx_log_capi.h +69 -0
  50. package/include/lynx/platform/embedder/public/capi/lynx_memory_capi.h +28 -0
  51. package/include/lynx/platform/embedder/public/capi/lynx_native_module_capi.h +51 -0
  52. package/include/lynx/platform/embedder/public/capi/lynx_native_view_capi.h +163 -0
  53. package/include/lynx/platform/embedder/public/capi/lynx_resource_request_capi.h +71 -0
  54. package/include/lynx/platform/embedder/public/capi/lynx_resource_response_capi.h +92 -0
  55. package/include/lynx/platform/embedder/public/capi/lynx_runtime_lifecycle_observer_capi.h +62 -0
  56. package/include/lynx/platform/embedder/public/capi/lynx_security_service_capi.h +52 -0
  57. package/include/lynx/platform/embedder/public/capi/lynx_service_center_capi.h +50 -0
  58. package/include/lynx/platform/embedder/public/capi/lynx_template_bundle_capi.h +39 -0
  59. package/include/lynx/platform/embedder/public/capi/lynx_template_data_capi.h +33 -0
  60. package/include/lynx/platform/embedder/public/capi/lynx_trace_capi.h +62 -0
  61. package/include/lynx/platform/embedder/public/capi/lynx_trail_service_capi.h +35 -0
  62. package/include/lynx/platform/embedder/public/capi/lynx_types.h +750 -0
  63. package/include/lynx/platform/embedder/public/capi/lynx_update_meta_capi.h +33 -0
  64. package/include/lynx/platform/embedder/public/capi/lynx_view_builder_capi.h +113 -0
  65. package/include/lynx/platform/embedder/public/capi/lynx_view_capi.h +174 -0
  66. package/include/lynx/platform/embedder/public/capi/lynx_view_client_capi.h +81 -0
  67. package/include/lynx/platform/embedder/public/capi/lynx_vsync_monitor_capi.h +38 -0
  68. package/include/lynx/platform/embedder/public/capi/lynx_windowless_renderer_capi.h +213 -0
  69. package/include/lynx/platform/embedder/public/lynx_env.h +104 -0
  70. package/include/lynx/platform/embedder/public/lynx_event_reporter_service.h +96 -0
  71. package/include/lynx/platform/embedder/public/lynx_event_simulation_proxy.h +31 -0
  72. package/include/lynx/platform/embedder/public/lynx_extension_module.h +521 -0
  73. package/include/lynx/platform/embedder/public/lynx_generic_resource_fetcher.h +178 -0
  74. package/include/lynx/platform/embedder/public/lynx_group.h +70 -0
  75. package/include/lynx/platform/embedder/public/lynx_http_service.h +211 -0
  76. package/include/lynx/platform/embedder/public/lynx_load_meta.h +120 -0
  77. package/include/lynx/platform/embedder/public/lynx_native_module.h +9 -0
  78. package/include/lynx/platform/embedder/public/lynx_native_view.h +201 -0
  79. package/include/lynx/platform/embedder/public/lynx_resource_request.h +56 -0
  80. package/include/lynx/platform/embedder/public/lynx_resource_response.h +63 -0
  81. package/include/lynx/platform/embedder/public/lynx_runtime_lifecycle_observer.h +102 -0
  82. package/include/lynx/platform/embedder/public/lynx_security_service.h +78 -0
  83. package/include/lynx/platform/embedder/public/lynx_service_center.h +64 -0
  84. package/include/lynx/platform/embedder/public/lynx_template_bundle.h +65 -0
  85. package/include/lynx/platform/embedder/public/lynx_template_data.h +104 -0
  86. package/include/lynx/platform/embedder/public/lynx_trail_service.h +81 -0
  87. package/include/lynx/platform/embedder/public/lynx_update_meta.h +56 -0
  88. package/include/lynx/platform/embedder/public/lynx_value.h +270 -0
  89. package/include/lynx/platform/embedder/public/lynx_view.h +364 -0
  90. package/include/lynx/platform/embedder/public/lynx_view_client.h +226 -0
  91. package/include/lynx/platform/embedder/public/lynx_vsync_monitor.h +70 -0
  92. package/include/lynx/platform/embedder/public/lynx_windowless_renderer.h +302 -0
  93. package/include/lynx/registration.h +178 -0
  94. package/include/lynx_env.h +104 -0
  95. package/include/lynx_event_reporter_service.h +96 -0
  96. package/include/lynx_event_simulation_proxy.h +31 -0
  97. package/include/lynx_extension.h +10 -0
  98. package/include/lynx_extension_module.h +521 -0
  99. package/include/lynx_generic_resource_fetcher.h +178 -0
  100. package/include/lynx_group.h +70 -0
  101. package/include/lynx_http_service.h +211 -0
  102. package/include/lynx_load_meta.h +120 -0
  103. package/include/lynx_native_module.h +9 -0
  104. package/include/lynx_native_view.h +201 -0
  105. package/include/lynx_resource_request.h +56 -0
  106. package/include/lynx_resource_response.h +63 -0
  107. package/include/lynx_runtime_lifecycle_observer.h +102 -0
  108. package/include/lynx_security_service.h +78 -0
  109. package/include/lynx_service_center.h +64 -0
  110. package/include/lynx_template_bundle.h +65 -0
  111. package/include/lynx_template_data.h +104 -0
  112. package/include/lynx_trail_service.h +81 -0
  113. package/include/lynx_update_meta.h +56 -0
  114. package/include/lynx_value.h +270 -0
  115. package/include/lynx_view.h +364 -0
  116. package/include/lynx_view_client.h +226 -0
  117. package/include/lynx_vsync_monitor.h +70 -0
  118. package/include/lynx_windowless_renderer.h +302 -0
  119. package/include/napi-inl.deprecated.h +186 -0
  120. package/include/napi-inl.h +6607 -0
  121. package/include/napi.h +3208 -0
  122. package/include/node_api.h +276 -0
  123. package/include/node_api_types.h +59 -0
  124. package/include/third_party/weak-node-api/headers/js_native_api.h +608 -0
  125. package/include/third_party/weak-node-api/headers/js_native_api_types.h +202 -0
  126. package/include/third_party/weak-node-api/headers/napi-inl.deprecated.h +186 -0
  127. package/include/third_party/weak-node-api/headers/napi-inl.h +6607 -0
  128. package/include/third_party/weak-node-api/headers/napi.h +3208 -0
  129. package/include/third_party/weak-node-api/headers/node_api.h +276 -0
  130. package/include/third_party/weak-node-api/headers/node_api_types.h +59 -0
  131. package/include/third_party/weak-node-api/headers/weak_napi_defines.h +331 -0
  132. package/include/third_party/weak-node-api/headers/weak_napi_undefs.h +282 -0
  133. package/include/weak_napi_defines.h +331 -0
  134. package/include/weak_napi_undefs.h +282 -0
  135. package/package.json +29 -0
@@ -0,0 +1,608 @@
1
+ #ifndef WEAK_NODE_API_SRC_JS_NATIVE_API_H_
2
+ #define WEAK_NODE_API_SRC_JS_NATIVE_API_H_
3
+
4
+ // This file needs to be compatible with C compilers.
5
+ #include <stdbool.h> // NOLINT(modernize-deprecated-headers)
6
+ #include <stddef.h> // NOLINT(modernize-deprecated-headers)
7
+
8
+ // Use INT_MAX, this should only be consumed by the pre-processor anyway.
9
+ #define NAPI_VERSION_EXPERIMENTAL 2147483647
10
+ #ifndef NAPI_VERSION
11
+ // The baseline version for N-API.
12
+ // The NAPI_VERSION controls which version will be used by default when
13
+ // compilling a native addon. If the addon developer specifically wants to use
14
+ // functions available in a new version of N-API that is not yet ported in all
15
+ // LTS versions, they can set NAPI_VERSION knowing that they have specifically
16
+ // depended on that version.
17
+ #define NAPI_VERSION 8
18
+ #endif
19
+
20
+ #include "./js_native_api_types.h"
21
+ #if defined(USE_WEAK_SUFFIX_NAPI) || defined(OS_HARMONY)
22
+ #include "weak_napi_defines.h"
23
+ #endif
24
+
25
+ // If you need __declspec(dllimport), either include <node_api.h> instead, or
26
+ // define WEAK_NAPI_EXTERN as __declspec(dllimport) on the compiler's command line.
27
+ #ifndef WEAK_NAPI_EXTERN
28
+ #ifdef _WIN32
29
+ #define WEAK_NAPI_EXTERN __declspec(dllexport)
30
+ #elif defined(__wasm__)
31
+ #define WEAK_NAPI_EXTERN \
32
+ __attribute__((visibility("default"))) \
33
+ __attribute__((__import_module__("napi")))
34
+ #else
35
+ #define WEAK_NAPI_EXTERN __attribute__((visibility("default")))
36
+ #endif
37
+ #endif
38
+
39
+ #define NAPI_AUTO_LENGTH SIZE_MAX
40
+
41
+ #ifdef __cplusplus
42
+ #define EXTERN_C_START extern "C" {
43
+ #define EXTERN_C_END }
44
+ #else
45
+ #define EXTERN_C_START
46
+ #define EXTERN_C_END
47
+ #endif
48
+
49
+ EXTERN_C_START
50
+
51
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_get_last_error_info(
52
+ node_api_basic_env env, const napi_extended_error_info** result);
53
+
54
+ // Getters for defined singletons
55
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_get_undefined(napi_env env,
56
+ napi_value* result);
57
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_get_null(napi_env env,
58
+ napi_value* result);
59
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_get_global(napi_env env,
60
+ napi_value* result);
61
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_get_boolean(napi_env env,
62
+ bool value,
63
+ napi_value* result);
64
+
65
+ // Methods to create Primitive types/Objects
66
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_create_object(napi_env env,
67
+ napi_value* result);
68
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_create_array(napi_env env,
69
+ napi_value* result);
70
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL
71
+ napi_create_array_with_length(napi_env env, size_t length, napi_value* result);
72
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_create_double(napi_env env,
73
+ double value,
74
+ napi_value* result);
75
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_create_int32(napi_env env,
76
+ int32_t value,
77
+ napi_value* result);
78
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_create_uint32(napi_env env,
79
+ uint32_t value,
80
+ napi_value* result);
81
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_create_int64(napi_env env,
82
+ int64_t value,
83
+ napi_value* result);
84
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_create_string_latin1(
85
+ napi_env env, const char* str, size_t length, napi_value* result);
86
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_create_string_utf8(napi_env env,
87
+ const char* str,
88
+ size_t length,
89
+ napi_value* result);
90
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_create_string_utf16(napi_env env,
91
+ const char16_t* str,
92
+ size_t length,
93
+ napi_value* result);
94
+ #if NAPI_VERSION >= 10
95
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL node_api_create_external_string_latin1(
96
+ napi_env env,
97
+ char* str,
98
+ size_t length,
99
+ node_api_basic_finalize finalize_callback,
100
+ void* finalize_hint,
101
+ napi_value* result,
102
+ bool* copied);
103
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL
104
+ node_api_create_external_string_utf16(napi_env env,
105
+ char16_t* str,
106
+ size_t length,
107
+ node_api_basic_finalize finalize_callback,
108
+ void* finalize_hint,
109
+ napi_value* result,
110
+ bool* copied);
111
+
112
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL node_api_create_property_key_latin1(
113
+ napi_env env, const char* str, size_t length, napi_value* result);
114
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL node_api_create_property_key_utf8(
115
+ napi_env env, const char* str, size_t length, napi_value* result);
116
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL node_api_create_property_key_utf16(
117
+ napi_env env, const char16_t* str, size_t length, napi_value* result);
118
+ #endif // NAPI_VERSION >= 10
119
+
120
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_create_symbol(napi_env env,
121
+ napi_value description,
122
+ napi_value* result);
123
+ #if NAPI_VERSION >= 9
124
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL
125
+ node_api_symbol_for(napi_env env,
126
+ const char* utf8description,
127
+ size_t length,
128
+ napi_value* result);
129
+ #endif // NAPI_VERSION >= 9
130
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_create_function(napi_env env,
131
+ const char* utf8name,
132
+ size_t length,
133
+ napi_callback cb,
134
+ void* data,
135
+ napi_value* result);
136
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_create_error(napi_env env,
137
+ napi_value code,
138
+ napi_value msg,
139
+ napi_value* result);
140
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_create_type_error(napi_env env,
141
+ napi_value code,
142
+ napi_value msg,
143
+ napi_value* result);
144
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_create_range_error(napi_env env,
145
+ napi_value code,
146
+ napi_value msg,
147
+ napi_value* result);
148
+ #if NAPI_VERSION >= 9
149
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL node_api_create_syntax_error(
150
+ napi_env env, napi_value code, napi_value msg, napi_value* result);
151
+ #endif // NAPI_VERSION >= 9
152
+
153
+ // Methods to get the native napi_value from Primitive type
154
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_typeof(napi_env env,
155
+ napi_value value,
156
+ napi_valuetype* result);
157
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_get_value_double(napi_env env,
158
+ napi_value value,
159
+ double* result);
160
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_get_value_int32(napi_env env,
161
+ napi_value value,
162
+ int32_t* result);
163
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_get_value_uint32(napi_env env,
164
+ napi_value value,
165
+ uint32_t* result);
166
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_get_value_int64(napi_env env,
167
+ napi_value value,
168
+ int64_t* result);
169
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_get_value_bool(napi_env env,
170
+ napi_value value,
171
+ bool* result);
172
+
173
+ // Copies LATIN-1 encoded bytes from a string into a buffer.
174
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_get_value_string_latin1(
175
+ napi_env env, napi_value value, char* buf, size_t bufsize, size_t* result);
176
+
177
+ // Copies UTF-8 encoded bytes from a string into a buffer.
178
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_get_value_string_utf8(
179
+ napi_env env, napi_value value, char* buf, size_t bufsize, size_t* result);
180
+
181
+ // Copies UTF-16 encoded bytes from a string into a buffer.
182
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_get_value_string_utf16(napi_env env,
183
+ napi_value value,
184
+ char16_t* buf,
185
+ size_t bufsize,
186
+ size_t* result);
187
+
188
+ // Methods to coerce values
189
+ // These APIs may execute user scripts
190
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_coerce_to_bool(napi_env env,
191
+ napi_value value,
192
+ napi_value* result);
193
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_coerce_to_number(napi_env env,
194
+ napi_value value,
195
+ napi_value* result);
196
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_coerce_to_object(napi_env env,
197
+ napi_value value,
198
+ napi_value* result);
199
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_coerce_to_string(napi_env env,
200
+ napi_value value,
201
+ napi_value* result);
202
+
203
+ // Methods to work with Objects
204
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_get_prototype(napi_env env,
205
+ napi_value object,
206
+ napi_value* result);
207
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_get_property_names(napi_env env,
208
+ napi_value object,
209
+ napi_value* result);
210
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_set_property(napi_env env,
211
+ napi_value object,
212
+ napi_value key,
213
+ napi_value value);
214
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_has_property(napi_env env,
215
+ napi_value object,
216
+ napi_value key,
217
+ bool* result);
218
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_get_property(napi_env env,
219
+ napi_value object,
220
+ napi_value key,
221
+ napi_value* result);
222
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_delete_property(napi_env env,
223
+ napi_value object,
224
+ napi_value key,
225
+ bool* result);
226
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_has_own_property(napi_env env,
227
+ napi_value object,
228
+ napi_value key,
229
+ bool* result);
230
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_set_named_property(napi_env env,
231
+ napi_value object,
232
+ const char* utf8name,
233
+ napi_value value);
234
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_has_named_property(napi_env env,
235
+ napi_value object,
236
+ const char* utf8name,
237
+ bool* result);
238
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_get_named_property(napi_env env,
239
+ napi_value object,
240
+ const char* utf8name,
241
+ napi_value* result);
242
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_set_element(napi_env env,
243
+ napi_value object,
244
+ uint32_t index,
245
+ napi_value value);
246
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_has_element(napi_env env,
247
+ napi_value object,
248
+ uint32_t index,
249
+ bool* result);
250
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_get_element(napi_env env,
251
+ napi_value object,
252
+ uint32_t index,
253
+ napi_value* result);
254
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_delete_element(napi_env env,
255
+ napi_value object,
256
+ uint32_t index,
257
+ bool* result);
258
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL
259
+ napi_define_properties(napi_env env,
260
+ napi_value object,
261
+ size_t property_count,
262
+ const napi_property_descriptor* properties);
263
+
264
+ // Methods to work with Arrays
265
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_is_array(napi_env env,
266
+ napi_value value,
267
+ bool* result);
268
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_get_array_length(napi_env env,
269
+ napi_value value,
270
+ uint32_t* result);
271
+
272
+ // Methods to compare values
273
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_strict_equals(napi_env env,
274
+ napi_value lhs,
275
+ napi_value rhs,
276
+ bool* result);
277
+
278
+ // Methods to work with Functions
279
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_call_function(napi_env env,
280
+ napi_value recv,
281
+ napi_value func,
282
+ size_t argc,
283
+ const napi_value* argv,
284
+ napi_value* result);
285
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_new_instance(napi_env env,
286
+ napi_value constructor,
287
+ size_t argc,
288
+ const napi_value* argv,
289
+ napi_value* result);
290
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_instanceof(napi_env env,
291
+ napi_value object,
292
+ napi_value constructor,
293
+ bool* result);
294
+
295
+ // Methods to work with napi_callbacks
296
+
297
+ // Gets all callback info in a single call. (Ugly, but faster.)
298
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_get_cb_info(
299
+ napi_env env, // [in] Node-API environment handle
300
+ napi_callback_info cbinfo, // [in] Opaque callback-info handle
301
+ size_t* argc, // [in-out] Specifies the size of the provided argv array
302
+ // and receives the actual count of args.
303
+ napi_value* argv, // [out] Array of values
304
+ napi_value* this_arg, // [out] Receives the JS 'this' arg for the call
305
+ void** data); // [out] Receives the data pointer for the callback.
306
+
307
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_get_new_target(
308
+ napi_env env, napi_callback_info cbinfo, napi_value* result);
309
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL
310
+ napi_define_class(napi_env env,
311
+ const char* utf8name,
312
+ size_t length,
313
+ napi_callback constructor,
314
+ void* data,
315
+ size_t property_count,
316
+ const napi_property_descriptor* properties,
317
+ napi_value* result);
318
+
319
+ // Methods to work with external data objects
320
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL
321
+ napi_wrap(napi_env env,
322
+ napi_value js_object,
323
+ void* native_object,
324
+ node_api_basic_finalize finalize_cb,
325
+ void* finalize_hint,
326
+ napi_ref* result);
327
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_unwrap(napi_env env,
328
+ napi_value js_object,
329
+ void** result);
330
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_remove_wrap(napi_env env,
331
+ napi_value js_object,
332
+ void** result);
333
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL
334
+ napi_create_external(napi_env env,
335
+ void* data,
336
+ node_api_basic_finalize finalize_cb,
337
+ void* finalize_hint,
338
+ napi_value* result);
339
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_get_value_external(napi_env env,
340
+ napi_value value,
341
+ void** result);
342
+
343
+ // Methods to control object lifespan
344
+
345
+ // Set initial_refcount to 0 for a weak reference, >0 for a strong reference.
346
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL
347
+ napi_create_reference(napi_env env,
348
+ napi_value value,
349
+ uint32_t initial_refcount,
350
+ napi_ref* result);
351
+
352
+ // Deletes a reference. The referenced value is released, and may
353
+ // be GC'd unless there are other references to it.
354
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_delete_reference(napi_env env,
355
+ napi_ref ref);
356
+
357
+ // Increments the reference count, optionally returning the resulting count.
358
+ // After this call the reference will be a strong reference because its
359
+ // refcount is >0, and the referenced object is effectively "pinned".
360
+ // Calling this when the refcount is 0 and the object is unavailable
361
+ // results in an error.
362
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_reference_ref(napi_env env,
363
+ napi_ref ref,
364
+ uint32_t* result);
365
+
366
+ // Decrements the reference count, optionally returning the resulting count.
367
+ // If the result is 0 the reference is now weak and the object may be GC'd
368
+ // at any time if there are no other references. Calling this when the
369
+ // refcount is already 0 results in an error.
370
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_reference_unref(napi_env env,
371
+ napi_ref ref,
372
+ uint32_t* result);
373
+
374
+ // Attempts to get a referenced value. If the reference is weak,
375
+ // the value might no longer be available, in that case the call
376
+ // is still successful but the result is NULL.
377
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_get_reference_value(napi_env env,
378
+ napi_ref ref,
379
+ napi_value* result);
380
+
381
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL
382
+ napi_open_handle_scope(napi_env env, napi_handle_scope* result);
383
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL
384
+ napi_close_handle_scope(napi_env env, napi_handle_scope scope);
385
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_open_escapable_handle_scope(
386
+ napi_env env, napi_escapable_handle_scope* result);
387
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_close_escapable_handle_scope(
388
+ napi_env env, napi_escapable_handle_scope scope);
389
+
390
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL
391
+ napi_escape_handle(napi_env env,
392
+ napi_escapable_handle_scope scope,
393
+ napi_value escapee,
394
+ napi_value* result);
395
+
396
+ // Methods to support error handling
397
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_throw(napi_env env, napi_value error);
398
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_throw_error(napi_env env,
399
+ const char* code,
400
+ const char* msg);
401
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_throw_type_error(napi_env env,
402
+ const char* code,
403
+ const char* msg);
404
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_throw_range_error(napi_env env,
405
+ const char* code,
406
+ const char* msg);
407
+ #if NAPI_VERSION >= 9
408
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL node_api_throw_syntax_error(napi_env env,
409
+ const char* code,
410
+ const char* msg);
411
+ #endif // NAPI_VERSION >= 9
412
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_is_error(napi_env env,
413
+ napi_value value,
414
+ bool* result);
415
+
416
+ // Methods to support catching exceptions
417
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_is_exception_pending(napi_env env,
418
+ bool* result);
419
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL
420
+ napi_get_and_clear_last_exception(napi_env env, napi_value* result);
421
+
422
+ // Methods to work with array buffers and typed arrays
423
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_is_arraybuffer(napi_env env,
424
+ napi_value value,
425
+ bool* result);
426
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_create_arraybuffer(napi_env env,
427
+ size_t byte_length,
428
+ void** data,
429
+ napi_value* result);
430
+ #ifndef NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED
431
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL
432
+ napi_create_external_arraybuffer(napi_env env,
433
+ void* external_data,
434
+ size_t byte_length,
435
+ node_api_basic_finalize finalize_cb,
436
+ void* finalize_hint,
437
+ napi_value* result);
438
+ #endif // NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED
439
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_get_arraybuffer_info(
440
+ napi_env env, napi_value arraybuffer, void** data, size_t* byte_length);
441
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_is_typedarray(napi_env env,
442
+ napi_value value,
443
+ bool* result);
444
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL
445
+ napi_create_typedarray(napi_env env,
446
+ napi_typedarray_type type,
447
+ size_t length,
448
+ napi_value arraybuffer,
449
+ size_t byte_offset,
450
+ napi_value* result);
451
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL
452
+ napi_get_typedarray_info(napi_env env,
453
+ napi_value typedarray,
454
+ napi_typedarray_type* type,
455
+ size_t* length,
456
+ void** data,
457
+ napi_value* arraybuffer,
458
+ size_t* byte_offset);
459
+
460
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_create_dataview(napi_env env,
461
+ size_t length,
462
+ napi_value arraybuffer,
463
+ size_t byte_offset,
464
+ napi_value* result);
465
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_is_dataview(napi_env env,
466
+ napi_value value,
467
+ bool* result);
468
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL
469
+ napi_get_dataview_info(napi_env env,
470
+ napi_value dataview,
471
+ size_t* bytelength,
472
+ void** data,
473
+ napi_value* arraybuffer,
474
+ size_t* byte_offset);
475
+
476
+ // version management
477
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_get_version(node_api_basic_env env,
478
+ uint32_t* result);
479
+
480
+ // Promises
481
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_create_promise(napi_env env,
482
+ napi_deferred* deferred,
483
+ napi_value* promise);
484
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_resolve_deferred(napi_env env,
485
+ napi_deferred deferred,
486
+ napi_value resolution);
487
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_reject_deferred(napi_env env,
488
+ napi_deferred deferred,
489
+ napi_value rejection);
490
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_is_promise(napi_env env,
491
+ napi_value value,
492
+ bool* is_promise);
493
+
494
+ // Running a script
495
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_run_script(napi_env env,
496
+ napi_value script,
497
+ napi_value* result);
498
+
499
+ // Memory management
500
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_adjust_external_memory(
501
+ node_api_basic_env env, int64_t change_in_bytes, int64_t* adjusted_value);
502
+
503
+ #if NAPI_VERSION >= 5
504
+
505
+ // Dates
506
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_create_date(napi_env env,
507
+ double time,
508
+ napi_value* result);
509
+
510
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_is_date(napi_env env,
511
+ napi_value value,
512
+ bool* is_date);
513
+
514
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_get_date_value(napi_env env,
515
+ napi_value value,
516
+ double* result);
517
+
518
+ // Add finalizer for pointer
519
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL
520
+ napi_add_finalizer(napi_env env,
521
+ napi_value js_object,
522
+ void* finalize_data,
523
+ node_api_basic_finalize finalize_cb,
524
+ void* finalize_hint,
525
+ napi_ref* result);
526
+
527
+ #endif // NAPI_VERSION >= 5
528
+
529
+
530
+ #if NAPI_VERSION >= 6
531
+
532
+ // BigInt
533
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_create_bigint_int64(napi_env env,
534
+ int64_t value,
535
+ napi_value* result);
536
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL
537
+ napi_create_bigint_uint64(napi_env env, uint64_t value, napi_value* result);
538
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL
539
+ napi_create_bigint_words(napi_env env,
540
+ int sign_bit,
541
+ size_t word_count,
542
+ const uint64_t* words,
543
+ napi_value* result);
544
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_get_value_bigint_int64(napi_env env,
545
+ napi_value value,
546
+ int64_t* result,
547
+ bool* lossless);
548
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_get_value_bigint_uint64(
549
+ napi_env env, napi_value value, uint64_t* result, bool* lossless);
550
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL
551
+ napi_get_value_bigint_words(napi_env env,
552
+ napi_value value,
553
+ int* sign_bit,
554
+ size_t* word_count,
555
+ uint64_t* words);
556
+
557
+ // Object
558
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL
559
+ napi_get_all_property_names(napi_env env,
560
+ napi_value object,
561
+ napi_key_collection_mode key_mode,
562
+ napi_key_filter key_filter,
563
+ napi_key_conversion key_conversion,
564
+ napi_value* result);
565
+
566
+ // Instance data
567
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL
568
+ napi_set_instance_data(node_api_basic_env env,
569
+ void* data,
570
+ napi_finalize finalize_cb,
571
+ void* finalize_hint);
572
+
573
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL
574
+ napi_get_instance_data(node_api_basic_env env, void** data);
575
+ #endif // NAPI_VERSION >= 6
576
+
577
+ #if NAPI_VERSION >= 7
578
+ // ArrayBuffer detaching
579
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL
580
+ napi_detach_arraybuffer(napi_env env, napi_value arraybuffer);
581
+
582
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL
583
+ napi_is_detached_arraybuffer(napi_env env, napi_value value, bool* result);
584
+ #endif // NAPI_VERSION >= 7
585
+
586
+ #if NAPI_VERSION >= 8
587
+ // Type tagging
588
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_type_tag_object(
589
+ napi_env env, napi_value value, const napi_type_tag* type_tag);
590
+
591
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL
592
+ napi_check_object_type_tag(napi_env env,
593
+ napi_value value,
594
+ const napi_type_tag* type_tag,
595
+ bool* result);
596
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_object_freeze(napi_env env,
597
+ napi_value object);
598
+ WEAK_NAPI_EXTERN napi_status NAPI_CDECL napi_object_seal(napi_env env,
599
+ napi_value object);
600
+ #endif // NAPI_VERSION >= 8
601
+
602
+ EXTERN_C_END
603
+
604
+ #endif // SRC_JS_NATIVE_API_H_
605
+
606
+ #if defined(USE_WEAK_SUFFIX_NAPI) || defined(OS_HARMONY)
607
+ #include "weak_napi_undefs.h"
608
+ #endif