Merge pull request #616 from zeromq/build-improve

Build improvements and fixes

.clang-format

@@ -56,13 +56,27 @@ SpaceBeforeAssignmentOperators: true
 SpaceBeforeParens: ControlStatements
 SpaceInEmptyParentheses: false
 SpacesBeforeTrailingComments: 2
-SpacesInAngles: false
+SpacesInAngles: "Never"
 SpacesInContainerLiterals: true
 SpacesInCStyleCastParentheses: false
 SpacesInParentheses: false
 SpacesInSquareBrackets: false
 Standard: Auto
 TabWidth: 4
 UseTab: Never
----
 
+IncludeBlocks: Regroup
+IncludeCategories:
+  # # Specific external headers in <> to put first
+  - Regex: "<(catch2|gtest).*>"
+    Priority: 1
+  # External headers in <> with extension or /
+  - Regex: '<[-\w\/-_]+[\.\/][-\w\/-_]+>'
+    Priority: 2
+  # Standard headers in <>
+  - Regex: '<[-\w\/-_]+>'
+    Priority: 3
+  # Local headers in ""
+  - Regex: '"[-\w\/-_]*"'
+    Priority: 4
+SortUsingDeclarations: true

.clangd

@@ -0,0 +1,2 @@
+CompileFlags:
+  CompilationDatabase: build/Debug

.eslintrc

@@ -13,6 +13,8 @@
     "v5-compat.d.ts",
     "draft.d.ts",
     "script/*.js",
-    "script/*.d.ts"
+    "script/*.d.ts",
+    "docs/",
+    "docs-raw/"
   ]
 }

.prettierignore

@@ -4,3 +4,4 @@
 /prebuilds
 /node_modules
 pnpm-lock.yaml
+/build

package.json

@@ -31,7 +31,6 @@
     "@types/node": "^18.19.34",
     "@types/semver": "^7.5.8",
     "@types/shelljs": "^0.8.15",
-    "@types/weak-napi": "^2.0.3",
     "@types/which": "^2.0.2",
     "benchmark": "^2.1.4",
     "chai": "^4.4.1",
@@ -54,7 +53,6 @@
     "ts-node": "~10.9.2",
     "typedoc": "^0.25.13",
     "typescript": "~4.9.5",
-    "weak-napi": "^2.0.2",
     "which": "^3.0.1"
   },
   "pnpm": {
@@ -91,13 +89,14 @@
     "build.doc": "typedoc --options ./typedoc.json && minify-all -s docs-raw -d docs --jsCompressor terser",
     "deploy.doc": "run-s build.doc && gh-pages --dist \"./docs\"",
     "prebuild": "run-s build.js && node ./script/prebuild.js",
-    "build.native": "node-gyp configure --release && node-gyp build --release",
-    "build.native.debug": "cross-env CMAKE_BUILD_TYPE=Debug node-gyp configure --debug && cross-env CMAKE_BUILD_TYPE=Debug node-gyp build --debug",
+    "build.native": "node-gyp configure --release && node-gyp configure --release -- -f compile_commands_json && node-gyp build --release",
+    "build.native.debug": "node-gyp configure --debug && node-gyp configure --debug -- -f compile_commands_json && cross-env CMAKE_BUILD_TYPE=Debug node-gyp build --debug",
     "build": "run-s build.js build.native",
     "build.debug": "run-s build.js build.native.debug",
-    "test": "run-s build && mocha --exit",
-    "test.skip_gc_tests": "run-s build.debug && cross-env SKIP_GC_TESTS=true mocha --exit",
-    "test.electron.main": "run-s build && electron-mocha",
+    "test.deps": "cd test && pnpm install && cd ..",
+    "test": "run-s test.deps build && mocha --exit",
+    "test.skip_gc_tests": "run-s test.deps build.debug && cross-env SKIP_GC_TESTS=true mocha --exit",
+    "test.electron.main": "run-s test.deps build && electron-mocha",
     "format": "prettier --write .",
     "test.electron.renderer": "run-s build && electron-mocha --renderer",
     "lint.clang-format": "clang-format -i -style=file ./src/*.cc ./src/*.h ./src/util/*.h",

script/build.ts

@@ -82,7 +82,7 @@ function main() {
   console.log(cmake_configure)
   exec(cmake_configure, execOptions)
 
-  const cmake_build = `cmake --build ./build --config ${CMAKE_BUILD_TYPE} --target install`
+  const cmake_build = `cmake --build ./build --config ${CMAKE_BUILD_TYPE} --target install --parallel`
   console.log(cmake_build)
   exec(cmake_build, execOptions)
 

src/closable.h

@@ -0,0 +1,9 @@
+#pragma once
+
+/* A thing that can be closed. Simple interface to allow us to correctly clean
+   up ZMQ resources at agent exit. */
+namespace zmq {
+struct Closable {
+    virtual void Close() = 0;
+};
+}

src/context.cc

@@ -1,9 +1,11 @@
 /* Copyright (c) 2017-2019 Rolf Timmermans */
-#include "context.h"
-#include "module.h"
-#include "socket.h"
+#include "./context.h"
 
-#include "util/uvwork.h"
+#include "./module.h"
+#include "./socket.h"
+#include "util/arguments.h"
+#include "util/error.h"
+#include "util/object.h"
 
 namespace zmq {
 Context::Context(const Napi::CallbackInfo& info)

src/context.h

@@ -1,7 +1,9 @@
 /* Copyright (c) 2017-2019 Rolf Timmermans */
 #pragma once
 
-#include "prefix.h"
+#include <napi.h>
+
+#include "closable.h"
 
 namespace zmq {
 class Module;

src/incoming_msg.cc

@@ -1,5 +1,7 @@
 /* Copyright (c) 2017-2019 Rolf Timmermans */
-#include "incoming_msg.h"
+#include "./incoming_msg.h"
+
+#include <cassert>
 
 #include "util/electron_helper.h"
 #include "util/error.h"

src/incoming_msg.h

@@ -1,7 +1,9 @@
 /* Copyright (c) 2017-2019 Rolf Timmermans */
 #pragma once
 
-#include "prefix.h"
+#include <napi.h>
+
+#include "./zmq_inc.h"
 
 namespace zmq {
 class IncomingMsg {

src/inline.h

@@ -0,0 +1,7 @@
+#pragma once
+
+#ifdef _MSC_VER
+#define force_inline inline __forceinline
+#else
+#define force_inline inline __attribute__((always_inline))
+#endif

src/module.cc

@@ -1,10 +1,13 @@
 /* Copyright (c) 2017-2019 Rolf Timmermans */
-#include "module.h"
-#include "context.h"
-#include "observer.h"
-#include "outgoing_msg.h"
-#include "proxy.h"
-#include "socket.h"
+#include "./module.h"
+
+#include "./context.h"
+#include "./observer.h"
+#include "./outgoing_msg.h"
+#include "./proxy.h"
+#include "./socket.h"
+#include "util/error.h"
+#include "util/to_string.h"
 
 namespace zmq {
 static inline Napi::String Version(const Napi::Env& env) {

src/module.h

@@ -1,21 +1,14 @@
 /* Copyright (c) 2017-2019 Rolf Timmermans */
 #pragma once
 
-#include "prefix.h"
-
-#include "outgoing_msg.h"
+#include <cstdio>
+#include <future>
 
-#include "util/arguments.h"
-#include "util/error.h"
-#include "util/object.h"
+#include "./closable.h"
+#include "./outgoing_msg.h"
 #include "util/reaper.h"
-#include "util/to_string.h"
 #include "util/trash.h"
 
-#include <chrono>
-#include <cstdio>
-#include <future>
-
 namespace zmq {
 class Context;
 class Socket;

src/observer.cc

@@ -1,15 +1,14 @@
 /* Copyright (c) 2017-2019 Rolf Timmermans */
-#include "observer.h"
-#include "context.h"
-#include "module.h"
-#include "socket.h"
+#include "./observer.h"
 
-#include "incoming_msg.h"
+#include "./context.h"
+#include "./module.h"
+#include "./socket.h"
+#include "util/arguments.h"
 #include "util/async_scope.h"
+#include "util/error.h"
 #include "util/take.h"
 
-#include <array>
-
 namespace zmq {
 static inline constexpr const char* EventName(uint32_t val) {
     switch (val) {

src/observer.h

@@ -1,12 +1,14 @@
 /* Copyright (c) 2017-2019 Rolf Timmermans */
 #pragma once
 
-#include "prefix.h"
-
-#include "poller.h"
+#include <napi.h>
 
 #include <optional>
 
+#include "./closable.h"
+#include "./inline.h"
+#include "./poller.h"
+
 namespace zmq {
 class Module;
 

src/outgoing_msg.cc

@@ -1,7 +1,7 @@
 /* Copyright (c) 2017-2019 Rolf Timmermans */
-#include "outgoing_msg.h"
-#include "module.h"
+#include "./outgoing_msg.h"
 
+#include "./module.h"
 #include "util/error.h"
 
 namespace zmq {

src/outgoing_msg.h

@@ -1,10 +1,12 @@
 /* Copyright (c) 2017-2019 Rolf Timmermans */
 #pragma once
 
-#include "prefix.h"
+#include <napi.h>
 
 #include <forward_list>
 
+#include "./zmq_inc.h"
+
 namespace zmq {
 class Module;
 

src/proxy.cc

@@ -1,9 +1,9 @@
 /* Copyright (c) 2017-2019 Rolf Timmermans */
-#include "proxy.h"
-#include "context.h"
-#include "module.h"
-#include "socket.h"
+#include "./proxy.h"
 
+#include "./context.h"
+#include "./module.h"
+#include "./socket.h"
 #include "util/arguments.h"
 #include "util/async_scope.h"
 #include "util/error.h"