buffer: make additional changes to native API

Address comments and deprecations left in source files. These changes include: * Remove the deprecated API. * Change Buffer::New() that did a copy of the data to Buffer::Copy() * Change Buffer::Use() to Buffer::New() PR-URL: #1825 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
nodejs · Aug 4, 2015 · 8664084 · 8664084
1 parent 36f78f4
commit 8664084
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 46 deletions.
diff --git a/src/node_buffer.cc b/src/node_buffer.cc
@@ -255,7 +255,7 @@ MaybeLocal<Object> New(Isolate* isolate,
   }
 
   Local<Object> buf;
-  if (Use(isolate, data, actual).ToLocal(&buf))
+  if (New(isolate, data, actual).ToLocal(&buf))
     return scope.Escape(buf);
 
   // Object failed to be created. Clean up resources.
@@ -319,7 +319,7 @@ MaybeLocal<Object> New(Environment* env, size_t length) {
 }
 
 
-MaybeLocal<Object> New(Isolate* isolate, const char* data, size_t length) {
+MaybeLocal<Object> Copy(Isolate* isolate, const char* data, size_t length) {
   Environment* env = Environment::GetCurrent(isolate);
   EscapableHandleScope handle_scope(env->isolate());
   Local<Object> obj;
@@ -435,11 +435,11 @@ MaybeLocal<Object> New(Environment* env,
 }
 
 
-MaybeLocal<Object> Use(Isolate* isolate, char* data, size_t length) {
+MaybeLocal<Object> New(Isolate* isolate, char* data, size_t length) {
   Environment* env = Environment::GetCurrent(isolate);
   EscapableHandleScope handle_scope(env->isolate());
   Local<Object> obj;
-  if (Buffer::Use(env, data, length).ToLocal(&obj))
+  if (Buffer::New(env, data, length).ToLocal(&obj))
     return handle_scope.Escape(obj);
   return Local<Object>();
 }

diff --git a/src/node_buffer.h b/src/node_buffer.h
@@ -23,55 +23,30 @@ NODE_EXTERN char* Data(v8::Handle<v8::Object> val);
 NODE_EXTERN size_t Length(v8::Handle<v8::Value> val);
 NODE_EXTERN size_t Length(v8::Handle<v8::Object> val);
 
+// public constructor - data is copied
+NODE_EXTERN v8::MaybeLocal<v8::Object> Copy(v8::Isolate* isolate,
+                                            const char* data,
+                                            size_t len);
+
 // public constructor
 NODE_EXTERN v8::MaybeLocal<v8::Object> New(v8::Isolate* isolate, size_t length);
-NODE_DEPRECATED("Use New(isolate, ...)",
-                inline v8::MaybeLocal<v8::Object> New(size_t length) {
-  return New(v8::Isolate::GetCurrent(), length);
-})
+
 // public constructor from string
 NODE_EXTERN v8::MaybeLocal<v8::Object> New(v8::Isolate* isolate,
                                            v8::Handle<v8::String> string,
                                            enum encoding enc = UTF8);
-NODE_DEPRECATED("Use New(isolate, ...)",
-                inline v8::MaybeLocal<v8::Object> New(
-                    v8::Handle<v8::String> string,
-                    enum encoding enc = UTF8) {
-  return New(v8::Isolate::GetCurrent(), string, enc);
-})
-// public constructor - data is copied
-// TODO(trevnorris): should be something like Copy()
-NODE_EXTERN v8::MaybeLocal<v8::Object> New(v8::Isolate* isolate,
-                                           const char* data,
-                                           size_t len);
-NODE_DEPRECATED("Use New(isolate, ...)",
-                inline v8::MaybeLocal<v8::Object> New(const char* data,
-                                                      size_t len) {
-  return New(v8::Isolate::GetCurrent(), data, len);
-})
+
 // public constructor - data is used, callback is passed data on object gc
 NODE_EXTERN v8::MaybeLocal<v8::Object> New(v8::Isolate* isolate,
                                            char* data,
                                            size_t length,
                                            FreeCallback callback,
                                            void* hint);
-NODE_DEPRECATED("Use New(isolate, ...)",
-                inline v8::MaybeLocal<v8::Object> New(char* data,
-                                                      size_t length,
-                                                      FreeCallback callback,
-                                                      void* hint) {
-  return New(v8::Isolate::GetCurrent(), data, length, callback, hint);
-})
 
 // public constructor - data is used.
-// TODO(trevnorris): should be New() for consistency
-NODE_EXTERN v8::MaybeLocal<v8::Object> Use(v8::Isolate* isolate,
+NODE_EXTERN v8::MaybeLocal<v8::Object> New(v8::Isolate* isolate,
                                            char* data,
                                            size_t len);
-NODE_DEPRECATED("Use Use(isolate, ...)",
-                inline v8::MaybeLocal<v8::Object> Use(char* data, size_t len) {
-  return Use(v8::Isolate::GetCurrent(), data, len);
-})
 
 // This is verbose to be explicit with inline commenting
 static inline bool IsWithinBounds(size_t off, size_t len, size_t max) {

diff --git a/src/node_crypto.cc b/src/node_crypto.cc
@@ -2899,7 +2899,7 @@ void CipherBase::GetAuthTag(const FunctionCallbackInfo<Value>& args) {
   unsigned int out_len = 0;
 
   if (cipher->GetAuthTag(&out, &out_len)) {
-    Local<Object> buf = Buffer::Use(env, out, out_len).ToLocalChecked();
+    Local<Object> buf = Buffer::New(env, out, out_len).ToLocalChecked();
     args.GetReturnValue().Set(buf);
   } else {
     env->ThrowError("Attempting to get auth tag in unsupported state");
@@ -4373,7 +4373,7 @@ void ECDH::ComputeSecret(const FunctionCallbackInfo<Value>& args) {
     return env->ThrowError("Failed to compute ECDH key");
   }
 
-  Local<Object> buf = Buffer::Use(env, out, out_len).ToLocalChecked();
+  Local<Object> buf = Buffer::New(env, out, out_len).ToLocalChecked();
   args.GetReturnValue().Set(buf);
 }
 
@@ -4411,7 +4411,7 @@ void ECDH::GetPublicKey(const FunctionCallbackInfo<Value>& args) {
   }
 
   Local<Object> buf =
-      Buffer::Use(env, reinterpret_cast<char*>(out), size).ToLocalChecked();
+      Buffer::New(env, reinterpret_cast<char*>(out), size).ToLocalChecked();
   args.GetReturnValue().Set(buf);
 }
 
@@ -4438,7 +4438,7 @@ void ECDH::GetPrivateKey(const FunctionCallbackInfo<Value>& args) {
   }
 
   Local<Object> buf =
-      Buffer::Use(env, reinterpret_cast<char*>(out), size).ToLocalChecked();
+      Buffer::New(env, reinterpret_cast<char*>(out), size).ToLocalChecked();
   args.GetReturnValue().Set(buf);
 }
 
@@ -4841,7 +4841,7 @@ void RandomBytesCheck(RandomBytesRequest* req, Local<Value> argv[2]) {
     size_t size;
     req->return_memory(&data, &size);
     argv[0] = Null(req->env()->isolate());
-    argv[1] = Buffer::Use(req->env(), data, size).ToLocalChecked();
+    argv[1] = Buffer::New(req->env(), data, size).ToLocalChecked();
   }
 }
 

diff --git a/src/stream_wrap.cc b/src/stream_wrap.cc
@@ -223,7 +223,7 @@ void StreamWrap::OnReadImpl(ssize_t nread,
     CHECK_EQ(pending, UV_UNKNOWN_HANDLE);
   }
 
-  Local<Object> obj = Buffer::Use(env, base, nread).ToLocalChecked();
+  Local<Object> obj = Buffer::New(env, base, nread).ToLocalChecked();
   wrap->EmitData(nread, obj, pending_obj);
 }
 

diff --git a/src/string_bytes.cc b/src/string_bytes.cc
@@ -704,7 +704,8 @@ Local<Value> StringBytes::Encode(Isolate* isolate,
   switch (encoding) {
     case BUFFER:
       {
-        Local<Object> vbuf = Buffer::New(isolate, buf, buflen).ToLocalChecked();
+        Local<Object> vbuf =
+            Buffer::Copy(isolate, buf, buflen).ToLocalChecked();
         return scope.Escape(vbuf);
       }
 

diff --git a/src/tls_wrap.cc b/src/tls_wrap.cc
@@ -660,7 +660,7 @@ void TLSWrap::OnReadSelf(ssize_t nread,
   TLSWrap* wrap = static_cast<TLSWrap*>(ctx);
   Local<Object> buf_obj;
   if (buf != nullptr)
-    buf_obj = Buffer::Use(wrap->env(), buf->base, buf->len).ToLocalChecked();
+    buf_obj = Buffer::New(wrap->env(), buf->base, buf->len).ToLocalChecked();
   wrap->EmitData(nread, buf_obj, Local<Object>());
 }
 

diff --git a/src/udp_wrap.cc b/src/udp_wrap.cc
@@ -408,7 +408,7 @@ void UDPWrap::OnRecv(uv_udp_t* handle,
   }
 
   char* base = static_cast<char*>(realloc(buf->base, nread));
-  argv[2] = Buffer::Use(env, base, nread).ToLocalChecked();
+  argv[2] = Buffer::New(env, base, nread).ToLocalChecked();
   argv[3] = AddressToJS(env, addr);
   wrap->MakeCallback(env->onmessage_string(), ARRAY_SIZE(argv), argv);
 }