Convert all locals and parameter names to snake_case (#193)

boingoing · jasongin · commit fb8ced493fe5 · 2017-03-23T11:27:16.000-07:00
* Convert all locals and parameter names to snake_case

Standardize some parameter names across the N-API surface such as ```napi_env env``` and ```size_t length```. Make all the parameter names in the header match the cc file and expand some parameter names from single characters into meaningful words.

Also addresses a couple of minor PR feedback items:
 - Rename ```napi_reference_addref``` and ```napi_reference_release``` to ```napi_reference_ref``` and ```napi_reference_unref``` (respectively)
 - Rename ```Reference::AddRef``` and ```Reference::Release``` to ```Reference::Ref``` and ```Reference::Unref``` (respectively)
 - Remove ```napi_create_boolean```, ```napi_get_true```, and ```napi_get_false``` and replace them with ```napi_get_boolean```
 - Rename ```napi_get_type_of_value``` to ```napi_typeof```
 - Add a ```result_data``` out parameter to ```napi_create_buffer_copy``` which returns the data pointer of the new buffer
 - Change ```napi_get_value_string_utf8``` and ```napi_get_value_string_utf16``` to accept a null output buffer and return the length of the source string in that case via the ```result``` parameter
 - Remove ```napi_get_value_string_utf8_length``` and ```napi_get_value_string_utf16_length``` due to the above
 - Change ```Reference``` ctor and dtor to be protected and added public ```static Reference* Reference::New``` and ```static void Reference::Delete``` methods to make it more clear how the ```Reference``` objects are allocated and cleaned-up
 - Add a type check to ``napi_get_array_length``` which returns an error if the argument is not an array object
 - Change ```napi_create_symbol``` to take a ```napi_value``` instead of a ```const char*``` for the symbol description string. The API now throws if description is not a string but NULL is allowed.

* Remove UTF-8 BOM characters and other non-ANSI whitespace

* Change parameter names for create string APIs and address other feedback

* Fixes for unit tests

* Fix lint errors found via CI
diff --git a/src/node_api.cc b/src/node_api.cc
diff --git a/src/node_api.h b/src/node_api.h
@@ -105,9 +105,10 @@ NAPI_EXTERN const napi_extended_error_info* napi_get_last_error_info();
 // Getters for defined singletons
 NAPI_EXTERN napi_status napi_get_undefined(napi_env env, napi_value* result);
 NAPI_EXTERN napi_status napi_get_null(napi_env env, napi_value* result);
-NAPI_EXTERN napi_status napi_get_false(napi_env env, napi_value* result);
-NAPI_EXTERN napi_status napi_get_true(napi_env env, napi_value* result);
 NAPI_EXTERN napi_status napi_get_global(napi_env env, napi_value* result);
+NAPI_EXTERN napi_status napi_get_boolean(napi_env env,
+                                         bool value,
+                                         napi_value* result);
 
 // Methods to create Primitive types/Objects
 NAPI_EXTERN napi_status napi_create_object(napi_env env, napi_value* result);
@@ -116,21 +117,18 @@ NAPI_EXTERN napi_status napi_create_array_with_length(napi_env env,
                                                       size_t length,
                                                       napi_value* result);
 NAPI_EXTERN napi_status napi_create_number(napi_env env,
-                                           double val,
+                                           double value,
                                            napi_value* result);
 NAPI_EXTERN napi_status napi_create_string_utf8(napi_env env,
-                                                const char* s,
+                                                const char* str,
                                                 size_t length,
                                                 napi_value* result);
 NAPI_EXTERN napi_status napi_create_string_utf16(napi_env env,
-                                                 const char16_t* s,
+                                                 const char16_t* str,
                                                  size_t length,
                                                  napi_value* result);
-NAPI_EXTERN napi_status napi_create_boolean(napi_env env,
-                                            bool b,
-                                            napi_value* result);
 NAPI_EXTERN napi_status napi_create_symbol(napi_env env,
-                                           const char* s,
+                                           napi_value description,
                                            napi_value* result);
 NAPI_EXTERN napi_status napi_create_function(napi_env env,
                                              const char* utf8name,
@@ -148,9 +146,9 @@ NAPI_EXTERN napi_status napi_create_range_error(napi_env env,
                                                 napi_value* result);
 
 // Methods to get the the native napi_value from Primitive type
-NAPI_EXTERN napi_status napi_get_type_of_value(napi_env env,
-                                               napi_value value,
-                                               napi_valuetype* result);
+NAPI_EXTERN napi_status napi_typeof(napi_env env,
+                                    napi_value value,
+                                    napi_valuetype* result);
 NAPI_EXTERN napi_status napi_get_value_double(napi_env env,
                                               napi_value value,
                                               double* result);
@@ -172,24 +170,13 @@ NAPI_EXTERN napi_status napi_get_value_string_length(napi_env env,
                                                      napi_value value,
                                                      size_t* result);
 
-// Gets the number of BYTES in the UTF-8 encoded representation of the string.
-NAPI_EXTERN napi_status napi_get_value_string_utf8_length(napi_env env,
-                                                          napi_value value,
-                                                          size_t* result);
-
 // Copies UTF-8 encoded bytes from a string into a buffer.
 NAPI_EXTERN napi_status napi_get_value_string_utf8(napi_env env,
                                                    napi_value value,
                                                    char* buf,
                                                    size_t bufsize,
                                                    size_t* result);
 
-// Gets the number of 2-byte code units in the UTF-16 encoded
-// representation of the string.
-NAPI_EXTERN napi_status napi_get_value_string_utf16_length(napi_env env,
-                                                           napi_value value,
-                                                           size_t* result);
-
 // Copies UTF-16 encoded bytes from a string into a buffer.
 NAPI_EXTERN napi_status napi_get_value_string_utf16(napi_env env,
                                                     napi_value value,
@@ -317,8 +304,8 @@ NAPI_EXTERN napi_status napi_get_cb_args_length(napi_env env,
                                                 size_t* result);
 NAPI_EXTERN napi_status napi_get_cb_args(napi_env env,
                                          napi_callback_info cbinfo,
-                                         napi_value* buffer,
-                                         size_t bufferlength);
+                                         napi_value* buf,
+                                         size_t bufsize);
 NAPI_EXTERN napi_status napi_get_cb_this(napi_env env,
                                          napi_callback_info cbinfo,
                                          napi_value* result);
@@ -343,13 +330,13 @@ napi_define_class(napi_env env,
 
 // Methods to work with external data objects
 NAPI_EXTERN napi_status napi_wrap(napi_env env,
-                                  napi_value jsObject,
-                                  void* nativeObj,
+                                  napi_value js_object,
+                                  void* native_object,
                                   napi_finalize finalize_cb,
                                   void* finalize_hint,
                                   napi_ref* result);
 NAPI_EXTERN napi_status napi_unwrap(napi_env env,
-                                    napi_value jsObject,
+                                    napi_value js_object,
                                     void** result);
 NAPI_EXTERN napi_status napi_create_external(napi_env env,
                                              void* data,
@@ -375,23 +362,23 @@ NAPI_EXTERN napi_status napi_delete_reference(napi_env env, napi_ref ref);
 // Increments the reference count, optionally returning the resulting count.
 // After this call the  reference will be a strong reference because its
 // refcount is >0, and the referenced object is effectively "pinned".
-// Calling this when the refcount is 0 and the object isunavailable
+// Calling this when the refcount is 0 and the object is unavailable
 // results in an error.
-NAPI_EXTERN napi_status napi_reference_addref(napi_env env,
-                                              napi_ref ref,
-                                              int* result);
+NAPI_EXTERN napi_status napi_reference_ref(napi_env env,
+                                           napi_ref ref,
+                                           int* result);
 
 // Decrements the reference count, optionally returning the resulting count.
 // If the result is 0 the reference is now weak and the object may be GC'd
 // at any time if there are no other references. Calling this when the
-// refcount is already 0 results in an error.
-NAPI_EXTERN napi_status napi_reference_release(napi_env env,
-                                               napi_ref ref,
-                                               int* result);
+// refcount is already 0 results in an error.
+NAPI_EXTERN napi_status napi_reference_unref(napi_env env,
+                                             napi_ref ref,
+                                             int* result);
 
 // Attempts to get a referenced value. If the reference is weak,
 // the value might no longer be available, in that case the call
-// is still successful but the result is NULL.
+// is still successful but the result is NULL.
 NAPI_EXTERN napi_status napi_get_reference_value(napi_env env,
                                                  napi_ref ref,
                                                  napi_value* result);
@@ -428,18 +415,19 @@ NAPI_EXTERN napi_status napi_get_and_clear_last_exception(napi_env env,
 
 // Methods to provide node::Buffer functionality with napi types
 NAPI_EXTERN napi_status napi_create_buffer(napi_env env,
-                                           size_t size,
+                                           size_t length,
                                            void** data,
                                            napi_value* result);
 NAPI_EXTERN napi_status napi_create_external_buffer(napi_env env,
-                                                    size_t size,
+                                                    size_t length,
                                                     void* data,
                                                     napi_finalize finalize_cb,
                                                     void* finalize_hint,
                                                     napi_value* result);
 NAPI_EXTERN napi_status napi_create_buffer_copy(napi_env env,
+                                                size_t length,
                                                 const void* data,
-                                                size_t size,
+                                                void** result_data,
                                                 napi_value* result);
 NAPI_EXTERN napi_status napi_is_buffer(napi_env env,
                                        napi_value value,
diff --git a/src/node_api_types.h b/src/node_api_types.h
@@ -78,6 +78,7 @@ typedef enum {
   napi_function_expected,
   napi_number_expected,
   napi_boolean_expected,
+  napi_array_expected,
   napi_generic_failure,
   napi_pending_exception,
   napi_status_last
diff --git a/test/addons-napi/2_function_arguments/binding.c b/test/addons-napi/2_function_arguments/binding.c
@@ -17,11 +17,11 @@ void Add(napi_env env, napi_callback_info info) {
   if (status != napi_ok) return;
 
   napi_valuetype valuetype0;
-  status = napi_get_type_of_value(env, args[0], &valuetype0);
+  status = napi_typeof(env, args[0], &valuetype0);
   if (status != napi_ok) return;
 
   napi_valuetype valuetype1;
-  status = napi_get_type_of_value(env, args[1], &valuetype1);
+  status = napi_typeof(env, args[1], &valuetype1);
   if (status != napi_ok) return;
 
   if (valuetype0 != napi_number || valuetype1 != napi_number) {
diff --git a/test/addons-napi/6_object_wrap/myobject.cc b/test/addons-napi/6_object_wrap/myobject.cc
@@ -50,7 +50,7 @@ void MyObject::New(napi_env env, napi_callback_info info) {
     double value = 0;
 
     napi_valuetype valuetype;
-    status = napi_get_type_of_value(env, args[0], &valuetype);
+    status = napi_typeof(env, args[0], &valuetype);
     if (status != napi_ok) return;
 
     if (valuetype != napi_undefined) {
@@ -164,7 +164,7 @@ void MyObject::Multiply(napi_env env, napi_callback_info info) {
   if (status != napi_ok) return;
 
   napi_valuetype valuetype;
-  status = napi_get_type_of_value(env, args[0], &valuetype);
+  status = napi_typeof(env, args[0], &valuetype);
   if (status != napi_ok) return;
 
   double multiple = 1;
diff --git a/test/addons-napi/7_factory_wrap/myobject.cc b/test/addons-napi/7_factory_wrap/myobject.cc
@@ -38,7 +38,7 @@ void MyObject::New(napi_env env, napi_callback_info info) {
   if (status != napi_ok) return;
 
   napi_valuetype valuetype;
-  status = napi_get_type_of_value(env, args[0], &valuetype);
+  status = napi_typeof(env, args[0], &valuetype);
   if (status != napi_ok) return;
 
   MyObject* obj = new MyObject();
diff --git a/test/addons-napi/8_passing_wrapped/myobject.cc b/test/addons-napi/8_passing_wrapped/myobject.cc
@@ -33,7 +33,7 @@ void MyObject::New(napi_env env, napi_callback_info info) {
   MyObject* obj = new MyObject();
 
   napi_valuetype valuetype;
-  status = napi_get_type_of_value(env, args[0], &valuetype);
+  status = napi_typeof(env, args[0], &valuetype);
   if (status != napi_ok) return;
 
   if (valuetype == napi_undefined) {
diff --git a/test/addons-napi/test_array/test_array.c b/test/addons-napi/test_array/test_array.c
@@ -18,7 +18,7 @@ void Test(napi_env env, napi_callback_info info) {
   if (status != napi_ok) return;
 
   napi_valuetype valuetype0;
-  status = napi_get_type_of_value(env, args[0], &valuetype0);
+  status = napi_typeof(env, args[0], &valuetype0);
   if (status != napi_ok) return;
 
   if (valuetype0 != napi_object) {
@@ -28,7 +28,7 @@ void Test(napi_env env, napi_callback_info info) {
   }
 
   napi_valuetype valuetype1;
-  status = napi_get_type_of_value(env, args[1], &valuetype1);
+  status = napi_typeof(env, args[1], &valuetype1);
   if (status != napi_ok) return;
 
   if (valuetype1 != napi_number) {
@@ -88,7 +88,7 @@ void New(napi_env env, napi_callback_info info) {
   if (status != napi_ok) return;
 
   napi_valuetype valuetype;
-  status = napi_get_type_of_value(env, args[0], &valuetype);
+  status = napi_typeof(env, args[0], &valuetype);
   if (status != napi_ok) return;
 
   if (valuetype != napi_object) {
diff --git a/test/addons-napi/test_buffer/test_buffer.c b/test/addons-napi/test_buffer/test_buffer.c
@@ -72,8 +72,8 @@ void getDeleterCallCount(napi_env env, napi_callback_info info) {
 
 void copyBuffer(napi_env env, napi_callback_info info) {
   napi_value theBuffer;
-  NAPI_CALL(env,
-            napi_create_buffer_copy(env, theText, sizeof(theText), &theBuffer));
+  NAPI_CALL(env, napi_create_buffer_copy(
+    env, sizeof(theText), theText, NULL, &theBuffer));
   NAPI_CALL(env, napi_set_return_value(env, info, theBuffer));
 }
 
@@ -85,14 +85,14 @@ void bufferHasInstance(napi_env env, napi_callback_info info) {
   NAPI_CALL(env, napi_get_cb_args(env, info, &theBuffer, 1));
   bool hasInstance;
   napi_valuetype theType;
-  NAPI_CALL(env, napi_get_type_of_value(env, theBuffer, &theType));
+  NAPI_CALL(env, napi_typeof(env, theBuffer, &theType));
   JS_ASSERT(env,
             theType == napi_object,
             "bufferHasInstance: instance is not an object");
   NAPI_CALL(env, napi_is_buffer(env, theBuffer, &hasInstance));
   JS_ASSERT(env, hasInstance, "bufferHasInstance: instance is not a buffer");
   napi_value returnValue;
-  NAPI_CALL(env, napi_create_boolean(env, hasInstance, &returnValue));
+  NAPI_CALL(env, napi_get_boolean(env, hasInstance, &returnValue));
   NAPI_CALL(env, napi_set_return_value(env, info, returnValue));
 }
 
@@ -110,7 +110,7 @@ void bufferInfo(napi_env env, napi_callback_info info) {
                 theBuffer,
                 (void **)(&bufferData),
                 &bufferLength));
-  NAPI_CALL(env, napi_create_boolean(env,
+  NAPI_CALL(env, napi_get_boolean(env,
     !strcmp(bufferData, theText) && bufferLength == sizeof(theText),
     &returnValue));
   NAPI_CALL(env, napi_set_return_value(env, info, returnValue));
@@ -122,7 +122,7 @@ void staticBuffer(napi_env env, napi_callback_info info) {
       env,
       napi_create_external_buffer(env,
                                   sizeof(theText),
-                                  (const char *)(theText),
+                                  theText,
                                   noopDeleter,
                                   NULL,  // finalize_hint
                                   &theBuffer));
diff --git a/test/addons-napi/test_error/test_error.cc b/test/addons-napi/test_error/test_error.cc
@@ -12,11 +12,7 @@ void checkError(napi_env e, napi_callback_info info) {
   if (status != napi_ok) return;
 
   napi_value result;
-  if (r) {
-      status = napi_get_true(e, &result);
-  } else {
-      status = napi_get_false(e, &result);
-  }
+  status = napi_get_boolean(e, r, &result);
   if (status != napi_ok) return;
 
   status = napi_set_return_value(e, info, result);
diff --git a/test/addons-napi/test_exception/test_exception.c b/test/addons-napi/test_exception/test_exception.c
@@ -48,7 +48,7 @@ void wasPending(napi_env env, napi_callback_info info) {
   napi_status status;
 
   napi_value result;
-  status = napi_create_boolean(env, exceptionWasPending, &result);
+  status = napi_get_boolean(env, exceptionWasPending, &result);
   if (status != napi_ok) return;
 
   status = napi_set_return_value(env, info, result);
diff --git a/test/addons-napi/test_function/test_function.c b/test/addons-napi/test_function/test_function.c
@@ -17,7 +17,7 @@ void Test(napi_env env, napi_callback_info info) {
   if (status != napi_ok) return;
 
   napi_valuetype valuetype;
-  status = napi_get_type_of_value(env, args[0], &valuetype);
+  status = napi_typeof(env, args[0], &valuetype);
   if (status != napi_ok) return;
 
   if (valuetype != napi_function) {
diff --git a/test/addons-napi/test_instanceof/test_instanceof.c b/test/addons-napi/test_instanceof/test_instanceof.c
@@ -14,7 +14,7 @@ void doInstanceOf(napi_env env, napi_callback_info info) {
   if (status != napi_ok) return;
 
   napi_value result;
-  status = napi_create_boolean(env, instanceof, &result);
+  status = napi_get_boolean(env, instanceof, &result);
   if (status != napi_ok) return;
 
   status = napi_set_return_value(env, info, result);
diff --git a/test/addons-napi/test_number/test_number.c b/test/addons-napi/test_number/test_number.c
@@ -17,7 +17,7 @@ void Test(napi_env env, napi_callback_info info) {
   if (status != napi_ok) return;
 
   napi_valuetype valuetype;
-  status = napi_get_type_of_value(env, args[0], &valuetype);
+  status = napi_typeof(env, args[0], &valuetype);
   if (status != napi_ok) return;
 
   if (valuetype != napi_number) {
diff --git a/test/addons-napi/test_object/test_object.c b/test/addons-napi/test_object/test_object.c
diff --git a/test/addons-napi/test_string/test_string.c b/test/addons-napi/test_string/test_string.c
diff --git a/test/addons-napi/test_symbol/test_symbol.c b/test/addons-napi/test_symbol/test_symbol.c
diff --git a/test/addons-napi/test_typedarray/test_typedarray.c b/test/addons-napi/test_typedarray/test_typedarray.c
