Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit e6a4104

Browse filesBrowse files
gabrielschulhofmarco-ippolito
gabrielschulhof
authored and
marco-ippolito
committed
node-api: rename nogc to basic
Signed-off-by: Gabriel Schulhof <gabrielschulhof@gmail.com> PR-URL: #53830 Reviewed-By: Vladimir Morozov <vmorozov@microsoft.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com>
1 parent 496975e commit e6a4104
Copy full SHA for e6a4104

13 files changed

+157-147Lines changed: 157 additions & 147 deletions

File tree

Expand file treeCollapse file tree
Open diff view settings
Filter options
Expand file treeCollapse file tree
Open diff view settings
Collapse file

‎benchmark/napi/ref/addon.c‎

Copy file name to clipboardExpand all lines: benchmark/napi/ref/addon.c
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ SetCount(napi_env env, napi_callback_info info) {
3333
return NULL;
3434
}
3535

36-
static void IncrementCounter(node_api_nogc_env env, void* data, void* hint) {
36+
static void IncrementCounter(node_api_basic_env env, void* data, void* hint) {
3737
size_t* count = data;
3838
(*count) = (*count) + 1;
3939
}
Collapse file

‎doc/api/n-api.md‎

Copy file name to clipboardExpand all lines: doc/api/n-api.md
+31-31Lines changed: 31 additions & 31 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -477,7 +477,7 @@ napiVersion: 6
477477
-->
478478

479479
```c
480-
napi_status napi_set_instance_data(node_api_nogc_env env,
480+
napi_status napi_set_instance_data(node_api_basic_env env,
481481
void* data,
482482
napi_finalize finalize_cb,
483483
void* finalize_hint);
@@ -509,7 +509,7 @@ napiVersion: 6
509509
-->
510510

511511
```c
512-
napi_status napi_get_instance_data(node_api_nogc_env env,
512+
napi_status napi_get_instance_data(node_api_basic_env env,
513513
void** data);
514514
```
515515

@@ -611,16 +611,16 @@ when an instance of a native addon is unloaded. Notification of this event is
611611
delivered through the callbacks given to [`napi_add_env_cleanup_hook`][] and
612612
[`napi_set_instance_data`][].
613613

614-
### `node_api_nogc_env`
614+
### `node_api_basic_env`
615615

616616
> Stability: 1 - Experimental
617617

618618
This variant of `napi_env` is passed to synchronous finalizers
619-
([`node_api_nogc_finalize`][]). There is a subset of Node-APIs which accept
620-
a parameter of type `node_api_nogc_env` as their first argument. These APIs do
619+
([`node_api_basic_finalize`][]). There is a subset of Node-APIs which accept
620+
a parameter of type `node_api_basic_env` as their first argument. These APIs do
621621
not access the state of the JavaScript engine and are thus safe to call from
622622
synchronous finalizers. Passing a parameter of type `napi_env` to these APIs is
623-
allowed, however, passing a parameter of type `node_api_nogc_env` to APIs that
623+
allowed, however, passing a parameter of type `node_api_basic_env` to APIs that
624624
access the JavaScript engine state is not allowed. Attempting to do so without
625625
a cast will produce a compiler warning or an error when add-ons are compiled
626626
with flags which cause them to emit warnings and/or errors when incorrect
@@ -791,7 +791,7 @@ typedef napi_value (*napi_callback)(napi_env, napi_callback_info);
791791
Unless for reasons discussed in [Object Lifetime Management][], creating a
792792
handle and/or callback scope inside a `napi_callback` is not necessary.
793793

794-
#### `node_api_nogc_finalize`
794+
#### `node_api_basic_finalize`
795795

796796
<!-- YAML
797797
added: v20.12.0
@@ -803,11 +803,11 @@ Function pointer type for add-on provided functions that allow the user to be
803803
notified when externally-owned data is ready to be cleaned up because the
804804
object it was associated with has been garbage-collected. The user must provide
805805
a function satisfying the following signature which would get called upon the
806-
object's collection. Currently, `node_api_nogc_finalize` can be used for
806+
object's collection. Currently, `node_api_basic_finalize` can be used for
807807
finding out when objects that have external data are collected.
808808

809809
```c
810-
typedef void (*node_api_nogc_finalize)(node_api_nogc_env env,
810+
typedef void (*node_api_basic_finalize)(node_api_basic_env env,
811811
void* finalize_data,
812812
void* finalize_hint);
813813
```
@@ -817,7 +817,7 @@ handle and/or callback scope inside the function body is not necessary.
817817

818818
Since these functions may be called while the JavaScript engine is in a state
819819
where it cannot execute JavaScript code, only Node-APIs which accept a
820-
`node_api_nogc_env` as their first parameter may be called.
820+
`node_api_basic_env` as their first parameter may be called.
821821
[`node_api_post_finalizer`][] can be used to schedule Node-API calls that
822822
require access to the JavaScript engine's state to run after the current
823823
garbage collection cycle has completed.
@@ -831,10 +831,10 @@ Change History:
831831

832832
* experimental (`NAPI_EXPERIMENTAL`):
833833

834-
Only Node-API calls that accept a `node_api_nogc_env` as their first
834+
Only Node-API calls that accept a `node_api_basic_env` as their first
835835
parameter may be called, otherwise the application will be terminated with an
836836
appropriate error message. This feature can be turned off by defining
837-
`NODE_API_EXPERIMENTAL_NOGC_ENV_OPT_OUT`.
837+
`NODE_API_EXPERIMENTAL_BASIC_ENV_OPT_OUT`.
838838

839839
#### `napi_finalize`
840840

@@ -859,9 +859,9 @@ Change History:
859859
* experimental (`NAPI_EXPERIMENTAL` is defined):
860860

861861
A function of this type may no longer be used as a finalizer, except with
862-
[`node_api_post_finalizer`][]. [`node_api_nogc_finalize`][] must be used
862+
[`node_api_post_finalizer`][]. [`node_api_basic_finalize`][] must be used
863863
instead. This feature can be turned off by defining
864-
`NODE_API_EXPERIMENTAL_NOGC_ENV_OPT_OUT`.
864+
`NODE_API_EXPERIMENTAL_BASIC_ENV_OPT_OUT`.
865865

866866
#### `napi_async_execute_callback`
867867

@@ -1063,7 +1063,7 @@ napiVersion: 1
10631063

10641064
```c
10651065
napi_status
1066-
napi_get_last_error_info(node_api_nogc_env env,
1066+
napi_get_last_error_info(node_api_basic_env env,
10671067
const napi_extended_error_info** result);
10681068
```
10691069

@@ -1882,7 +1882,7 @@ napiVersion: 3
18821882
-->
18831883

18841884
```c
1885-
NODE_EXTERN napi_status napi_add_env_cleanup_hook(node_api_nogc_env env,
1885+
NODE_EXTERN napi_status napi_add_env_cleanup_hook(node_api_basic_env env,
18861886
napi_cleanup_hook fun,
18871887
void* arg);
18881888
```
@@ -1912,7 +1912,7 @@ napiVersion: 3
19121912
-->
19131913

19141914
```c
1915-
NAPI_EXTERN napi_status napi_remove_env_cleanup_hook(node_api_nogc_env env,
1915+
NAPI_EXTERN napi_status napi_remove_env_cleanup_hook(node_api_basic_env env,
19161916
void (*fun)(void* arg),
19171917
void* arg);
19181918
```
@@ -1941,7 +1941,7 @@ changes:
19411941

19421942
```c
19431943
NAPI_EXTERN napi_status napi_add_async_cleanup_hook(
1944-
node_api_nogc_env env,
1944+
node_api_basic_env env,
19451945
napi_async_cleanup_hook hook,
19461946
void* arg,
19471947
napi_async_cleanup_hook_handle* remove_handle);
@@ -5524,7 +5524,7 @@ napiVersion: 5
55245524
napi_status napi_add_finalizer(napi_env env,
55255525
napi_value js_object,
55265526
void* finalize_data,
5527-
node_api_nogc_finalize finalize_cb,
5527+
node_api_basic_finalize finalize_cb,
55285528
void* finalize_hint,
55295529
napi_ref* result);
55305530
```
@@ -5562,7 +5562,7 @@ added: v20.10.0
55625562
> Stability: 1 - Experimental
55635563

55645564
```c
5565-
napi_status node_api_post_finalizer(node_api_nogc_env env,
5565+
napi_status node_api_post_finalizer(node_api_basic_env env,
55665566
napi_finalize finalize_cb,
55675567
void* finalize_data,
55685568
void* finalize_hint);
@@ -5632,7 +5632,7 @@ Once created the async worker can be queued
56325632
for execution using the [`napi_queue_async_work`][] function:
56335633

56345634
```c
5635-
napi_status napi_queue_async_work(node_api_nogc_env env,
5635+
napi_status napi_queue_async_work(node_api_basic_env env,
56365636
napi_async_work work);
56375637
```
56385638

@@ -5724,7 +5724,7 @@ napiVersion: 1
57245724
-->
57255725

57265726
```c
5727-
napi_status napi_queue_async_work(node_api_nogc_env env,
5727+
napi_status napi_queue_async_work(node_api_basic_env env,
57285728
napi_async_work work);
57295729
```
57305730

@@ -5745,7 +5745,7 @@ napiVersion: 1
57455745
-->
57465746

57475747
```c
5748-
napi_status napi_cancel_async_work(node_api_nogc_env env,
5748+
napi_status napi_cancel_async_work(node_api_basic_env env,
57495749
napi_async_work work);
57505750
```
57515751

@@ -5949,7 +5949,7 @@ typedef struct {
59495949
const char* release;
59505950
} napi_node_version;
59515951

5952-
napi_status napi_get_node_version(node_api_nogc_env env,
5952+
napi_status napi_get_node_version(node_api_basic_env env,
59535953
const napi_node_version** version);
59545954
```
59555955

@@ -5972,7 +5972,7 @@ napiVersion: 1
59725972
-->
59735973

59745974
```c
5975-
napi_status napi_get_version(node_api_nogc_env env,
5975+
napi_status napi_get_version(node_api_basic_env env,
59765976
uint32_t* result);
59775977
```
59785978

@@ -6005,7 +6005,7 @@ napiVersion: 1
60056005
-->
60066006

60076007
```c
6008-
NAPI_EXTERN napi_status napi_adjust_external_memory(node_api_nogc_env env,
6008+
NAPI_EXTERN napi_status napi_adjust_external_memory(node_api_basic_env env,
60096009
int64_t change_in_bytes,
60106010
int64_t* result);
60116011
```
@@ -6222,7 +6222,7 @@ napiVersion: 2
62226222
-->
62236223

62246224
```c
6225-
NAPI_EXTERN napi_status napi_get_uv_event_loop(node_api_nogc_env env,
6225+
NAPI_EXTERN napi_status napi_get_uv_event_loop(node_api_basic_env env,
62266226
struct uv_loop_s** loop);
62276227
```
62286228

@@ -6542,7 +6542,7 @@ napiVersion: 4
65426542

65436543
```c
65446544
NAPI_EXTERN napi_status
6545-
napi_ref_threadsafe_function(node_api_nogc_env env, napi_threadsafe_function func);
6545+
napi_ref_threadsafe_function(node_api_basic_env env, napi_threadsafe_function func);
65466546
```
65476547

65486548
* `[in] env`: The environment that the API is invoked under.
@@ -6568,7 +6568,7 @@ napiVersion: 4
65686568

65696569
```c
65706570
NAPI_EXTERN napi_status
6571-
napi_unref_threadsafe_function(node_api_nogc_env env, napi_threadsafe_function func);
6571+
napi_unref_threadsafe_function(node_api_basic_env env, napi_threadsafe_function func);
65726572
```
65736573

65746574
* `[in] env`: The environment that the API is invoked under.
@@ -6594,7 +6594,7 @@ napiVersion: 9
65946594

65956595
```c
65966596
NAPI_EXTERN napi_status
6597-
node_api_get_module_file_name(node_api_nogc_env env, const char** result);
6597+
node_api_get_module_file_name(node_api_basic_env env, const char** result);
65986598

65996599
```
66006600

@@ -6719,10 +6719,10 @@ the add-on's file name during loading.
67196719
[`napi_wrap`]: #napi_wrap
67206720
[`node-addon-api`]: https://github.com/nodejs/node-addon-api
67216721
[`node_api.h`]: https://github.com/nodejs/node/blob/HEAD/src/node_api.h
6722+
[`node_api_basic_finalize`]: #node_api_basic_finalize
67226723
[`node_api_create_external_string_latin1`]: #node_api_create_external_string_latin1
67236724
[`node_api_create_external_string_utf16`]: #node_api_create_external_string_utf16
67246725
[`node_api_create_syntax_error`]: #node_api_create_syntax_error
6725-
[`node_api_nogc_finalize`]: #node_api_nogc_finalize
67266726
[`node_api_post_finalizer`]: #node_api_post_finalizer
67276727
[`node_api_throw_syntax_error`]: #node_api_throw_syntax_error
67286728
[`process.release`]: process.md#processrelease
Collapse file

‎src/js_native_api.h‎

Copy file name to clipboardExpand all lines: src/js_native_api.h
+26-25Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
EXTERN_C_START
5151

5252
NAPI_EXTERN napi_status NAPI_CDECL napi_get_last_error_info(
53-
node_api_nogc_env env, const napi_extended_error_info** result);
53+
node_api_basic_env env, const napi_extended_error_info** result);
5454

5555
// Getters for defined singletons
5656
NAPI_EXTERN napi_status NAPI_CDECL napi_get_undefined(napi_env env,
@@ -94,19 +94,19 @@ NAPI_EXTERN napi_status NAPI_CDECL napi_create_string_utf16(napi_env env,
9494
napi_value* result);
9595
#ifdef NAPI_EXPERIMENTAL
9696
#define NODE_API_EXPERIMENTAL_HAS_EXTERNAL_STRINGS
97-
NAPI_EXTERN napi_status NAPI_CDECL
98-
node_api_create_external_string_latin1(napi_env env,
99-
char* str,
100-
size_t length,
101-
node_api_nogc_finalize finalize_callback,
102-
void* finalize_hint,
103-
napi_value* result,
104-
bool* copied);
97+
NAPI_EXTERN napi_status NAPI_CDECL node_api_create_external_string_latin1(
98+
napi_env env,
99+
char* str,
100+
size_t length,
101+
node_api_basic_finalize finalize_callback,
102+
void* finalize_hint,
103+
napi_value* result,
104+
bool* copied);
105105
NAPI_EXTERN napi_status NAPI_CDECL
106106
node_api_create_external_string_utf16(napi_env env,
107107
char16_t* str,
108108
size_t length,
109-
node_api_nogc_finalize finalize_callback,
109+
node_api_basic_finalize finalize_callback,
110110
void* finalize_hint,
111111
napi_value* result,
112112
bool* copied);
@@ -318,12 +318,13 @@ napi_define_class(napi_env env,
318318
napi_value* result);
319319

320320
// Methods to work with external data objects
321-
NAPI_EXTERN napi_status NAPI_CDECL napi_wrap(napi_env env,
322-
napi_value js_object,
323-
void* native_object,
324-
node_api_nogc_finalize finalize_cb,
325-
void* finalize_hint,
326-
napi_ref* result);
321+
NAPI_EXTERN napi_status NAPI_CDECL
322+
napi_wrap(napi_env env,
323+
napi_value js_object,
324+
void* native_object,
325+
node_api_basic_finalize finalize_cb,
326+
void* finalize_hint,
327+
napi_ref* result);
327328
NAPI_EXTERN napi_status NAPI_CDECL napi_unwrap(napi_env env,
328329
napi_value js_object,
329330
void** result);
@@ -333,7 +334,7 @@ NAPI_EXTERN napi_status NAPI_CDECL napi_remove_wrap(napi_env env,
333334
NAPI_EXTERN napi_status NAPI_CDECL
334335
napi_create_external(napi_env env,
335336
void* data,
336-
node_api_nogc_finalize finalize_cb,
337+
node_api_basic_finalize finalize_cb,
337338
void* finalize_hint,
338339
napi_value* result);
339340
NAPI_EXTERN napi_status NAPI_CDECL napi_get_value_external(napi_env env,
@@ -432,7 +433,7 @@ NAPI_EXTERN napi_status NAPI_CDECL
432433
napi_create_external_arraybuffer(napi_env env,
433434
void* external_data,
434435
size_t byte_length,
435-
node_api_nogc_finalize finalize_cb,
436+
node_api_basic_finalize finalize_cb,
436437
void* finalize_hint,
437438
napi_value* result);
438439
#endif // NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED
@@ -474,7 +475,7 @@ napi_get_dataview_info(napi_env env,
474475
size_t* byte_offset);
475476

476477
// version management
477-
NAPI_EXTERN napi_status NAPI_CDECL napi_get_version(node_api_nogc_env env,
478+
NAPI_EXTERN napi_status NAPI_CDECL napi_get_version(node_api_basic_env env,
478479
uint32_t* result);
479480

480481
// Promises
@@ -498,7 +499,7 @@ NAPI_EXTERN napi_status NAPI_CDECL napi_run_script(napi_env env,
498499

499500
// Memory management
500501
NAPI_EXTERN napi_status NAPI_CDECL napi_adjust_external_memory(
501-
node_api_nogc_env env, int64_t change_in_bytes, int64_t* adjusted_value);
502+
node_api_basic_env env, int64_t change_in_bytes, int64_t* adjusted_value);
502503

503504
#if NAPI_VERSION >= 5
504505

@@ -520,7 +521,7 @@ NAPI_EXTERN napi_status NAPI_CDECL
520521
napi_add_finalizer(napi_env env,
521522
napi_value js_object,
522523
void* finalize_data,
523-
node_api_nogc_finalize finalize_cb,
524+
node_api_basic_finalize finalize_cb,
524525
void* finalize_hint,
525526
napi_ref* result);
526527

@@ -530,7 +531,7 @@ napi_add_finalizer(napi_env env,
530531
#define NODE_API_EXPERIMENTAL_HAS_POST_FINALIZER
531532

532533
NAPI_EXTERN napi_status NAPI_CDECL
533-
node_api_post_finalizer(node_api_nogc_env env,
534+
node_api_post_finalizer(node_api_basic_env env,
534535
napi_finalize finalize_cb,
535536
void* finalize_data,
536537
void* finalize_hint);
@@ -575,13 +576,13 @@ napi_get_all_property_names(napi_env env,
575576

576577
// Instance data
577578
NAPI_EXTERN napi_status NAPI_CDECL
578-
napi_set_instance_data(node_api_nogc_env env,
579+
napi_set_instance_data(node_api_basic_env env,
579580
void* data,
580581
napi_finalize finalize_cb,
581582
void* finalize_hint);
582583

583-
NAPI_EXTERN napi_status NAPI_CDECL napi_get_instance_data(node_api_nogc_env env,
584-
void** data);
584+
NAPI_EXTERN napi_status NAPI_CDECL
585+
napi_get_instance_data(node_api_basic_env env, void** data);
585586
#endif // NAPI_VERSION >= 6
586587

587588
#if NAPI_VERSION >= 7

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.