src: remove util-inl.h from header files

sam-github · targos · commit ae8b64df7880 · 2019-05-14T17:33:07.000+02:00
Its intended that *-inl.h header files are only included into the src files that call the inline methods. Explicitly include it into the files that need it. PR-URL: #27631 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
diff --git a/src/aliased_buffer.h b/src/aliased_buffer.h
@@ -4,7 +4,7 @@
 #if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
 
 #include <cinttypes>
-#include "util-inl.h"
+#include "util.h"
 #include "v8.h"
 
 namespace node {
diff --git a/src/api/utils.cc b/src/api/utils.cc
@@ -1,5 +1,6 @@
 #include "node.h"
 #include "node_internals.h"
+#include "util-inl.h"
 
 #include <csignal>
 
diff --git a/src/base_object-inl.h b/src/base_object-inl.h
@@ -26,7 +26,7 @@
 
 #include "base_object.h"
 #include "env-inl.h"
-#include "util-inl.h"
+#include "util.h"
 #include "v8.h"
 
 namespace node {
diff --git a/src/debug_utils.cc b/src/debug_utils.cc
@@ -1,4 +1,5 @@
 #include "debug_utils.h"
+#include "util-inl.h"
 
 #ifdef __POSIX__
 #if defined(__linux__)
diff --git a/src/env.cc b/src/env.cc
@@ -13,6 +13,7 @@
 #include "node_worker.h"
 #include "tracing/agent.h"
 #include "tracing/traced_value.h"
+#include "util-inl.h"
 #include "v8-profiler.h"
 
 #include <algorithm>
diff --git a/src/heap_utils.cc b/src/heap_utils.cc
@@ -1,5 +1,6 @@
 #include "env-inl.h"
 #include "stream_base-inl.h"
+#include "util-inl.h"
 
 using v8::Array;
 using v8::Boolean;
diff --git a/src/inspector/tracing_agent.cc b/src/inspector/tracing_agent.cc
@@ -4,6 +4,7 @@
 #include "node_v8_platform-inl.h"
 
 #include "env-inl.h"
+#include "util-inl.h"
 #include "v8.h"
 
 #include <set>
diff --git a/src/inspector/worker_inspector.cc b/src/inspector/worker_inspector.cc
@@ -1,5 +1,6 @@
 #include "worker_inspector.h"
 #include "main_thread_interface.h"
+#include "util-inl.h"
 
 #include <memory>
 
diff --git a/src/inspector_agent.cc b/src/inspector_agent.cc
@@ -12,6 +12,7 @@
 #include "node_options-inl.h"
 #include "node_process.h"
 #include "node_url.h"
+#include "util-inl.h"
 #include "v8-inspector.h"
 #include "v8-platform.h"
 
diff --git a/src/inspector_io.cc b/src/inspector_io.cc
@@ -11,7 +11,7 @@
 #include "node_internals.h"
 #include "node_mutex.h"
 #include "v8-inspector.h"
-#include "util.h"
+#include "util-inl.h"
 #include "zlib.h"
 
 #include <deque>
diff --git a/src/inspector_js_api.cc b/src/inspector_js_api.cc
@@ -1,6 +1,7 @@
 #include "base_object-inl.h"
 #include "inspector_agent.h"
 #include "inspector_io.h"
+#include "util-inl.h"
 #include "v8.h"
 #include "v8-inspector.h"
 
diff --git a/src/inspector_profiler.cc b/src/inspector_profiler.cc
@@ -5,7 +5,7 @@
 #include "node_file.h"
 #include "node_internals.h"
 #include "v8-inspector.h"
-#include "util.h"
+#include "util-inl.h"
 
 namespace node {
 namespace profiler {
diff --git a/src/inspector_socket.h b/src/inspector_socket.h
@@ -3,7 +3,7 @@
 
 #if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
 
-#include "util-inl.h"
+#include "util.h"
 #include "uv.h"
 
 #include <string>
diff --git a/src/inspector_socket_server.cc b/src/inspector_socket_server.cc
@@ -1,6 +1,7 @@
 #include "inspector_socket_server.h"
 
 #include "node.h"
+#include "util-inl.h"
 #include "uv.h"
 #include "zlib.h"
 
diff --git a/src/js_native_api_v8.cc b/src/js_native_api_v8.cc
@@ -4,6 +4,7 @@
 #define NAPI_EXPERIMENTAL
 #include "js_native_api_v8.h"
 #include "js_native_api.h"
+#include "util-inl.h"
 
 #define CHECK_MAYBE_NOTHING(env, maybe, status) \
   RETURN_STATUS_IF_FALSE((env), !((maybe).IsNothing()), (status))
diff --git a/src/js_native_api_v8.h b/src/js_native_api_v8.h
@@ -150,7 +150,7 @@ inline napi_value JsValueFromV8LocalValue(v8::Local<v8::Value> local) {
 
 inline v8::Local<v8::Value> V8LocalValueFromJsValue(napi_value v) {
   v8::Local<v8::Value> local;
-  memcpy(&local, &v, sizeof(v));
+  memcpy(static_cast<void*>(&local), &v, sizeof(v));
   return local;
 }
 
diff --git a/src/js_stream.cc b/src/js_stream.cc
@@ -5,6 +5,7 @@
 #include "node_buffer.h"
 #include "node_errors.h"
 #include "stream_base-inl.h"
+#include "util-inl.h"
 #include "v8.h"
 
 namespace node {
diff --git a/src/node.cc b/src/node.cc
@@ -24,6 +24,7 @@
 // ========== local headers ==========
 
 #include "debug_utils.h"
+#include "env-inl.h"
 #include "node_binding.h"
 #include "node_internals.h"
 #include "node_main_instance.h"
diff --git a/src/node.h b/src/node.h
@@ -99,6 +99,14 @@
 # endif
 #endif
 
+#if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
+// Internally, do not include util-inl.h into files unless they need it's
+// inline definitions.
+#else
+// Externally, it must be included for backwards API compatibility.
+#  include <util-inl.h>
+#endif
+
 // Forward-declare libuv loop
 struct uv_loop_s;
 
diff --git a/src/node_api.cc b/src/node_api.cc
@@ -6,6 +6,7 @@
 #include "node_binding.h"
 #include "node_errors.h"
 #include "node_internals.h"
+#include "util-inl.h"
 
 #include <memory>
 
diff --git a/src/node_constants.cc b/src/node_constants.cc
@@ -21,6 +21,7 @@
 
 #include "node_constants.h"
 #include "node_internals.h"
+#include "util-inl.h"
 
 #include "zlib.h"
 
diff --git a/src/node_contextify.cc b/src/node_contextify.cc
@@ -27,6 +27,7 @@
 #include "node_context_data.h"
 #include "node_errors.h"
 #include "module_wrap.h"
+#include "util-inl.h"
 
 namespace node {
 namespace contextify {
diff --git a/src/node_credentials.cc b/src/node_credentials.cc
@@ -1,4 +1,5 @@
 #include "node_internals.h"
+#include "util-inl.h"
 
 #ifdef NODE_IMPLEMENTS_POSIX_CREDENTIALS
 #include <grp.h>  // getgrnam()
diff --git a/src/node_crypto_bio.h b/src/node_crypto_bio.h
@@ -26,8 +26,8 @@
 
 #include "node_crypto.h"
 #include "openssl/bio.h"
-#include "env-inl.h"
-#include "util-inl.h"
+#include "env.h"
+#include "util.h"
 #include "v8.h"
 
 namespace node {
diff --git a/src/node_crypto_clienthello-inl.h b/src/node_crypto_clienthello-inl.h
@@ -25,7 +25,7 @@
 #if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
 
 #include "node_crypto_clienthello.h"
-#include "util-inl.h"
+#include "util.h"
 
 namespace node {
 namespace crypto {
diff --git a/src/node_dtrace.cc b/src/node_dtrace.cc
@@ -42,6 +42,7 @@
 #define NODE_GC_DONE(arg0, arg1, arg2)
 #endif
 
+#include "env-inl.h"
 #include "node_errors.h"
 
 #include <cstring>
diff --git a/src/node_env_var.cc b/src/node_env_var.cc
@@ -1,6 +1,6 @@
+#include "env-inl.h"
 #include "node_errors.h"
 #include "node_process.h"
-#include "util.h"
 
 #ifdef __APPLE__
 #include <crt_externs.h>
diff --git a/src/node_errors.cc b/src/node_errors.cc
@@ -8,6 +8,7 @@
 #endif
 #include "node_process.h"
 #include "node_v8_platform-inl.h"
+#include "util-inl.h"
 
 namespace node {
 
diff --git a/src/node_errors.h b/src/node_errors.h
@@ -4,8 +4,8 @@
 #if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
 
 #include "node.h"
-#include "util-inl.h"
-#include "env-inl.h"
+#include "util.h"
+#include "env.h"
 #include "v8.h"
 
 // Use ostringstream to print exact-width integer types
diff --git a/src/node_file.cc b/src/node_file.cc
@@ -24,7 +24,7 @@
 #include "node_buffer.h"
 #include "node_process.h"
 #include "node_stat_watcher.h"
-#include "util.h"
+#include "util-inl.h"
 
 #include "tracing/trace_event.h"
 
diff --git a/src/node_http2.cc b/src/node_http2.cc
@@ -5,7 +5,7 @@
 #include "node_http2.h"
 #include "node_http2_state.h"
 #include "node_perf.h"
-#include "util.h"
+#include "util-inl.h"
 
 #include <algorithm>
 
diff --git a/src/node_http_parser_llhttp.cc b/src/node_http_parser_llhttp.cc
@@ -2,6 +2,7 @@
 
 #include "node_http_parser_impl.h"
 #include "node_metadata.h"
+#include "util-inl.h"
 
 namespace node {
 
diff --git a/src/node_http_parser_traditional.cc b/src/node_http_parser_traditional.cc
@@ -4,6 +4,7 @@
 
 #include "node_http_parser_impl.h"
 #include "node_metadata.h"
+#include "util-inl.h"
 
 namespace node {
 namespace per_process {
diff --git a/src/node_internals.h b/src/node_internals.h
@@ -29,7 +29,7 @@
 #include "node_binding.h"
 #include "node_mutex.h"
 #include "tracing/trace_event.h"
-#include "util-inl.h"
+#include "util.h"
 #include "uv.h"
 #include "v8.h"
 
diff --git a/src/node_main_instance.cc b/src/node_main_instance.cc
@@ -2,6 +2,7 @@
 #include "node_internals.h"
 #include "node_options-inl.h"
 #include "node_v8_platform-inl.h"
+#include "util-inl.h"
 
 namespace node {
 
diff --git a/src/node_messaging.cc b/src/node_messaging.cc
@@ -6,7 +6,7 @@
 #include "node_buffer.h"
 #include "node_errors.h"
 #include "node_process.h"
-#include "util.h"
+#include "util-inl.h"
 
 using node::contextify::ContextifyContext;
 using v8::Array;
diff --git a/src/node_os.cc b/src/node_os.cc
@@ -21,7 +21,6 @@
 
 #include "env-inl.h"
 #include "string_bytes.h"
-#include "util.h"
 
 #ifdef __MINGW32__
 # include <io.h>
diff --git a/src/node_perf.cc b/src/node_perf.cc
@@ -3,6 +3,7 @@
 #include "node_perf.h"
 #include "node_buffer.h"
 #include "node_process.h"
+#include "util-inl.h"
 
 #include <cinttypes>
 
diff --git a/src/node_platform.cc b/src/node_platform.cc
@@ -3,7 +3,6 @@
 
 #include "env-inl.h"
 #include "debug_utils.h"
-#include "util.h"
 #include <algorithm>
 #include <cmath>
 #include <memory>
diff --git a/src/node_report_module.cc b/src/node_report_module.cc
@@ -3,7 +3,7 @@
 #include "node_internals.h"
 #include "node_options.h"
 #include "node_report.h"
-#include "util.h"
+#include "util-inl.h"
 
 #include "handle_wrap.h"
 #include "node_buffer.h"
diff --git a/src/node_report_utils.cc b/src/node_report_utils.cc
@@ -1,5 +1,6 @@
 #include "node_internals.h"
 #include "node_report.h"
+#include "util-inl.h"
 
 namespace report {
 
diff --git a/src/node_serdes.cc b/src/node_serdes.cc
@@ -1,6 +1,7 @@
 #include "node_internals.h"
 #include "node_buffer.h"
 #include "node_errors.h"
+#include "util-inl.h"
 #include "base_object-inl.h"
 
 namespace node {
diff --git a/src/node_stat_watcher.cc b/src/node_stat_watcher.cc
@@ -23,7 +23,7 @@
 #include "async_wrap-inl.h"
 #include "env.h"
 #include "node_file.h"
-#include "util.h"
+#include "util-inl.h"
 
 #include <cstring>
 #include <cstdlib>
diff --git a/src/node_symbols.cc b/src/node_symbols.cc
@@ -1,5 +1,6 @@
 #include "env-inl.h"
 #include "node_binding.h"
+#include "util.h"
 
 namespace node {
 
diff --git a/src/node_task_queue.cc b/src/node_task_queue.cc
@@ -3,6 +3,7 @@
 #include "node_errors.h"
 #include "node_internals.h"
 #include "node_process.h"
+#include "util-inl.h"
 #include "v8.h"
 
 #include <atomic>
diff --git a/src/node_trace_events.cc b/src/node_trace_events.cc
@@ -4,6 +4,7 @@
 #include "node_internals.h"
 #include "node_v8_platform-inl.h"
 #include "tracing/agent.h"
+#include "util-inl.h"
 
 #include <set>
 #include <string>
diff --git a/src/node_url.cc b/src/node_url.cc
@@ -2,7 +2,7 @@
 #include "base_object-inl.h"
 #include "node_errors.h"
 #include "node_i18n.h"
-#include "util.h"
+#include "util-inl.h"
 
 #include <cmath>
 #include <cstdio>
diff --git a/src/node_util.cc b/src/node_util.cc
diff --git a/src/node_watchdog.cc b/src/node_watchdog.cc
diff --git a/src/node_worker.cc b/src/node_worker.cc
diff --git a/src/req_wrap-inl.h b/src/req_wrap-inl.h
diff --git a/src/sharedarraybuffer_metadata.cc b/src/sharedarraybuffer_metadata.cc
diff --git a/src/spawn_sync.cc b/src/spawn_sync.cc
diff --git a/src/stream_pipe.cc b/src/stream_pipe.cc
diff --git a/src/string_decoder.cc b/src/string_decoder.cc
diff --git a/src/timers.cc b/src/timers.cc
diff --git a/src/util.cc b/src/util.cc
diff --git a/src/uv.cc b/src/uv.cc
diff --git a/test/cctest/node_test_fixture.h b/test/cctest/node_test_fixture.h
diff --git a/test/cctest/test_inspector_socket.cc b/test/cctest/test_inspector_socket.cc
diff --git a/test/cctest/test_inspector_socket_server.cc b/test/cctest/test_inspector_socket_server.cc

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`#include "debug_utils.h"`
	`2`	`+#include "util-inl.h"`
`2`	`3`
`3`	`4`	`#ifdef __POSIX__`
`4`	`5`	`#if defined(__linux__)`
Original file line number	Diff line number	Diff line change
`@@ -150,7 +150,7 @@ inline napi_value JsValueFromV8LocalValue(v8::Local<v8::Value> local) {`
`150`	`150`
`151`	`151`	`inline v8::Local<v8::Value> V8LocalValueFromJsValue(napi_value v) {`
`152`	`152`	`v8::Local<v8::Value> local;`
`153`		`- memcpy(&local, &v, sizeof(v));`
	`153`	`+ memcpy(static_cast<void*>(&local), &v, sizeof(v));`
`154`	`154`	`return local;`
`155`	`155`	`}`
`156`	`156`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`#include "node_internals.h"`
	`2`	`+#include "util-inl.h"`
`2`	`3`
`3`	`4`	`#ifdef NODE_IMPLEMENTS_POSIX_CREDENTIALS`
`4`	`5`	`#include <grp.h> // getgrnam()`