nixd: refactor into library-like structure (#387)

nix-community · Apr 8, 2024 · 83a1305 · 83a1305
1 parent 1066132
commit 83a1305
Show file tree

Hide file tree

Showing 36 changed files with 91 additions and 151 deletions.
diff --git a/nixd/tools/nixd/src/Controller.h → nixd/include/nixd/Controller/Controller.h b/nixd/tools/nixd/src/Controller.h → nixd/include/nixd/Controller/Controller.h
@@ -60,7 +60,7 @@ class Controller : public lspserver::LSPServer {
   Controller(std::unique_ptr<lspserver::InboundPort> In,
              std::unique_ptr<lspserver::OutboundPort> Out);
 
-  ~Controller() { Pool.join(); }
+  ~Controller() override { Pool.join(); }
 
   void setLitTest(bool LitTest) { this->LitTest = LitTest; }
 

diff --git a/nixd/tools/nixd/src/EvalClient.h → nixd/include/nixd/Controller/EvalClient.h b/nixd/tools/nixd/src/EvalClient.h → nixd/include/nixd/Controller/EvalClient.h
@@ -1,8 +1,8 @@
 #pragma once
 
-#include "nixd/rpc/Protocol.h"
+#include "nixd/Protocol/Protocol.h"
 
-#include "nixd/util/PipedProc.h"
+#include "nixd/Support/PipedProc.h"
 
 #include <lspserver/LSPServer.h>
 
@@ -23,8 +23,6 @@ class EvalClient : public lspserver::LSPServer {
   EvalClient(std::unique_ptr<lspserver::InboundPort> In,
              std::unique_ptr<lspserver::OutboundPort> Out);
 
-  virtual ~EvalClient() = default;
-
   void onReady(const int &Flags) {
     lspserver::log(
         "nix-node-eval({0}) reported it's ready for processing requests",
@@ -54,7 +52,7 @@ class OwnedEvalClient : public EvalClient {
 
   util::PipedProc &proc() { return *Proc; }
 
-  ~OwnedEvalClient() {
+  ~OwnedEvalClient() override {
     closeInbound();
     Input.join();
   }

diff --git a/nixd/tools/nixd/src/NixTU.h → nixd/include/nixd/Controller/NixTU.h b/nixd/tools/nixd/src/NixTU.h → nixd/include/nixd/Controller/NixTU.h
@@ -1,6 +1,6 @@
 #pragma once
 
-#include "nixd/util/OwnedRegion.h"
+#include "nixd/Support/OwnedRegion.h"
 
 #include "nixf/Basic/Diagnostic.h"
 #include "nixf/Basic/Nodes/Basic.h"

diff --git a/nixd/nix-node-eval/src/EvalProvider.h → nixd/include/nixd/Eval/EvalProvider.h b/nixd/nix-node-eval/src/EvalProvider.h → nixd/include/nixd/Eval/EvalProvider.h
@@ -1,6 +1,6 @@
 #pragma once
 
-#include "nixd/rpc/Protocol.h"
+#include "nixd/Protocol/Protocol.h"
 
 #include <lspserver/Function.h>
 #include <lspserver/LSPServer.h>

diff --git a/nixd/librpc/include/nixd/rpc/Protocol.h → nixd/include/nixd/Protocol/Protocol.h b/nixd/librpc/include/nixd/rpc/Protocol.h → nixd/include/nixd/Protocol/Protocol.h
diff --git a/nixd/libutil/include/nixd/util/AutoCloseFD.h → nixd/include/nixd/Support/AutoCloseFD.h b/nixd/libutil/include/nixd/util/AutoCloseFD.h → nixd/include/nixd/Support/AutoCloseFD.h
diff --git a/nixd/libutil/include/nixd/util/AutoHUPPID.h → nixd/include/nixd/Support/AutoHUPPID.h b/nixd/libutil/include/nixd/util/AutoHUPPID.h → nixd/include/nixd/Support/AutoHUPPID.h
diff --git a/...libutil/include/nixd/util/AutoRemoveShm.h → nixd/include/nixd/Support/AutoRemoveShm.h b/...libutil/include/nixd/util/AutoRemoveShm.h → nixd/include/nixd/Support/AutoRemoveShm.h
diff --git a/nixd/libutil/include/nixd/util/ForkPiped.h → nixd/include/nixd/Support/ForkPiped.h b/nixd/libutil/include/nixd/util/ForkPiped.h → nixd/include/nixd/Support/ForkPiped.h
diff --git a/nixd/libutil/include/nixd/util/OwnedRegion.h → nixd/include/nixd/Support/OwnedRegion.h b/nixd/libutil/include/nixd/util/OwnedRegion.h → nixd/include/nixd/Support/OwnedRegion.h
diff --git a/nixd/libutil/include/nixd/util/PipedProc.h → nixd/include/nixd/Support/PipedProc.h b/nixd/libutil/include/nixd/util/PipedProc.h → nixd/include/nixd/Support/PipedProc.h
diff --git a/nixd/tools/nixd/src/CodeAction.cpp → nixd/lib/Controller/CodeAction.cpp b/nixd/tools/nixd/src/CodeAction.cpp → nixd/lib/Controller/CodeAction.cpp
@@ -3,9 +3,10 @@
 /// [Code Action]:
 /// https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_codeAction
 
-#include "Controller.h"
 #include "Convert.h"
 
+#include "nixd/Controller/Controller.h"
+
 #include <boost/asio/post.hpp>
 
 namespace nixd {

diff --git a/nixd/tools/nixd/src/Convert.cpp → nixd/lib/Controller/Convert.cpp b/nixd/tools/nixd/src/Convert.cpp → nixd/lib/Controller/Convert.cpp
diff --git a/nixd/tools/nixd/src/Convert.h → nixd/lib/Controller/Convert.h b/nixd/tools/nixd/src/Convert.h → nixd/lib/Controller/Convert.h
diff --git a/nixd/tools/nixd/src/Diagnostics.cpp → nixd/lib/Controller/Diagnostics.cpp b/nixd/tools/nixd/src/Diagnostics.cpp → nixd/lib/Controller/Diagnostics.cpp
@@ -3,9 +3,10 @@
 /// [PublishDiagnostics Notification]:
 /// https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_publishDiagnostics
 
-#include "Controller.h"
 #include "Convert.h"
 
+#include "nixd/Controller/Controller.h"
+
 namespace nixd {
 
 using namespace llvm::json;

diff --git a/nixd/tools/nixd/src/EvalClient.cpp → nixd/lib/Controller/EvalClient.cpp b/nixd/tools/nixd/src/EvalClient.cpp → nixd/lib/Controller/EvalClient.cpp
@@ -1,8 +1,7 @@
 #include "nixd-config.h"
 
-#include "EvalClient.h"
-
-#include "nixd/util/ForkPiped.h"
+#include "nixd/Controller/EvalClient.h"
+#include "nixd/Support/ForkPiped.h"
 
 #include <bc/Read.h>
 #include <bc/Write.h>

diff --git a/nixd/tools/nixd/src/Hover.cpp → nixd/lib/Controller/Hover.cpp b/nixd/tools/nixd/src/Hover.cpp → nixd/lib/Controller/Hover.cpp
@@ -3,9 +3,10 @@
 /// [Hover Request]:
 /// https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_hover
 
-#include "Controller.h"
 #include "Convert.h"
 
+#include "nixd/Controller/Controller.h"
+
 #include <llvm/Support/Error.h>
 
 #include <boost/asio/post.hpp>

diff --git a/nixd/tools/nixd/src/LifeTime.cpp → nixd/lib/Controller/LifeTime.cpp b/nixd/tools/nixd/src/LifeTime.cpp → nixd/lib/Controller/LifeTime.cpp
@@ -5,10 +5,9 @@
 
 #include "nixd-config.h"
 
-#include "Controller.h"
-#include "EvalClient.h"
-
-#include "nixd/util/PipedProc.h"
+#include "nixd/Controller/Controller.h"
+#include "nixd/Controller/EvalClient.h"
+#include "nixd/Support/PipedProc.h"
 
 #include <cstring>
 

diff --git a/nixd/tools/nixd/src/Support.cpp → nixd/lib/Controller/Support.cpp b/nixd/tools/nixd/src/Support.cpp → nixd/lib/Controller/Support.cpp
@@ -1,7 +1,6 @@
-#include "Controller.h"
-
-#include "nixd/rpc/Protocol.h"
-#include "nixd/util/OwnedRegion.h"
+#include "nixd/Controller/Controller.h"
+#include "nixd/Protocol/Protocol.h"
+#include "nixd/Support/OwnedRegion.h"
 
 #include "nixf/Basic/Diagnostic.h"
 #include "nixf/Bytecode/Write.h"

diff --git a/nixd/tools/nixd/src/TextDocumentSync.cpp → nixd/lib/Controller/TextDocumentSync.cpp b/nixd/tools/nixd/src/TextDocumentSync.cpp → nixd/lib/Controller/TextDocumentSync.cpp
@@ -1,7 +1,7 @@
 /// \file
 /// \brief Implementation of the [text document
 /// sync](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_synchronization).
-#include "Controller.h"
+#include "nixd/Controller/Controller.h"
 
 #include "lspserver/SourceCode.h"
 

diff --git a/nixd/nix-node-eval/src/EvalProvider.cpp → nixd/lib/Eval/EvalProvider.cpp b/nixd/nix-node-eval/src/EvalProvider.cpp → nixd/lib/Eval/EvalProvider.cpp
@@ -1,6 +1,5 @@
-#include "EvalProvider.h"
-
-#include "nixd/rpc/Protocol.h"
+#include "nixd/Eval/EvalProvider.h"
+#include "nixd/Protocol/Protocol.h"
 
 #include <nixt/Deserialize.h>
 #include <nixt/HackCache.h>
@@ -31,8 +30,7 @@ using namespace rpc;
 EvalProvider::EvalProvider(std::unique_ptr<lspserver::InboundPort> In,
                            std::unique_ptr<lspserver::OutboundPort> Out)
     : lspserver::LSPServer(std::move(In), std::move(Out)),
-      State(std::unique_ptr<nix::EvalState>(
-          new nix::EvalState{{}, nix::openStore("dummy://")})) {
+      State(new nix::EvalState{{}, nix::openStore()}) {
   Registry.addMethod("exprValue", this, &EvalProvider::onExprValue);
   Registry.addNotification("registerBC", this, &EvalProvider::onRegisterBC);
 

diff --git a/nixd/lib/Eval/Main.cpp b/nixd/lib/Eval/Main.cpp
diff --git a/nixd/librpc/src/Protocol.cpp → nixd/lib/Protocol/Protocol.cpp b/nixd/librpc/src/Protocol.cpp → nixd/lib/Protocol/Protocol.cpp
@@ -1,12 +1,10 @@
-#include "nixd/rpc/Protocol.h"
+#include "nixd/Protocol/Protocol.h"
 
 #include <bc/Read.h>
 #include <bc/Write.h>
 
 namespace nixd::rpc {
 
-using bc::readBytecode;
-using bc::writeBytecode;
 using namespace llvm::json;
 
 Value toJSON(const RegisterBCParams &Params) {

diff --git a/nixd/libutil/src/AutoCloseFD.cpp → nixd/lib/Support/AutoCloseFD.cpp b/nixd/libutil/src/AutoCloseFD.cpp → nixd/lib/Support/AutoCloseFD.cpp
@@ -1,4 +1,4 @@
-#include "nixd/util/AutoCloseFD.h"
+#include "nixd/Support/AutoCloseFD.h"
 
 #include <unistd.h>
 

diff --git a/nixd/libutil/src/AutoRemoveShm.cpp → nixd/lib/Support/AutoRemoveShm.cpp b/nixd/libutil/src/AutoRemoveShm.cpp → nixd/lib/Support/AutoRemoveShm.cpp
@@ -1,4 +1,4 @@
-#include "nixd/util/AutoRemoveShm.h"
+#include "nixd/Support/AutoRemoveShm.h"
 
 namespace nixd::util {
 

diff --git a/nixd/libutil/src/ForkPiped.cpp → nixd/lib/Support/ForkPiped.cpp b/nixd/libutil/src/ForkPiped.cpp → nixd/lib/Support/ForkPiped.cpp
@@ -1,4 +1,4 @@
-#include "nixd/util/ForkPiped.h"
+#include "nixd/Support/ForkPiped.h"
 
 #include <cerrno>
 

diff --git a/nixd/librpc/meson.build b/nixd/librpc/meson.build
diff --git a/nixd/librpc/test/Transport.cpp b/nixd/librpc/test/Transport.cpp
diff --git a/nixd/libutil/meson.build b/nixd/libutil/meson.build
diff --git a/nixd/meson.build b/nixd/meson.build
@@ -1,4 +1,61 @@
-subdir('librpc')
-subdir('libutil')
-subdir('nix-node-eval')
-subdir('tools')
+libnixd_include = include_directories('include')
+
+libnixd_deps = [ nixd_lsp_server, nixf, llvm, nixt ]
+
+libnixd_lib = library(
+    'nixd',
+    'lib/Controller/CodeAction.cpp',
+    'lib/Controller/Convert.cpp',
+    'lib/Controller/Diagnostics.cpp',
+    'lib/Controller/EvalClient.cpp',
+    'lib/Controller/Hover.cpp',
+    'lib/Controller/LifeTime.cpp',
+    'lib/Controller/Support.cpp',
+    'lib/Controller/TextDocumentSync.cpp',
+    'lib/Eval/EvalProvider.cpp',
+    'lib/Protocol/Protocol.cpp',
+    'lib/Support/AutoCloseFD.cpp',
+    'lib/Support/AutoRemoveShm.cpp',
+    'lib/Support/ForkPiped.cpp',
+    dependencies: libnixd_deps,
+    include_directories: libnixd_include,
+    install: true
+)
+
+libnixd = declare_dependency(
+    include_directories: libnixd_include,
+    link_with: libnixd_lib,
+    dependencies: libnixd_deps
+)
+
+nixd = executable(
+    'nixd',
+    'tools/nixd.cpp',
+    install: true,
+    dependencies: libnixd
+)
+
+regression_env = environment()
+
+regression_env.append('PATH', meson.current_build_dir())
+regression_env.set('MESON_BUILD_ROOT', meson.current_build_dir())
+
+if lit.found()
+    test(
+        'regression/nixd',
+        lit,
+        env: regression_env,
+        args: [
+            '-vv',
+            meson.current_source_dir() + '/tools/nixd/test'
+        ],
+        depends: [ nixd ] )
+endif
+
+
+nix_node_eval = executable(
+    'nix-node-eval',
+    'tools/nix-node-eval.cpp',
+    install: true,
+    dependencies: libnixd
+)
diff --git a/nixd/nix-node-eval/README.md b/nixd/nix-node-eval/README.md
diff --git a/nixd/nix-node-eval/meson.build b/nixd/nix-node-eval/meson.build
diff --git a/nixd/tools/meson.build b/nixd/tools/meson.build
diff --git a/nixd/nix-node-eval/src/Main.cpp → nixd/tools/nix-node-eval.cpp b/nixd/nix-node-eval/src/Main.cpp → nixd/tools/nix-node-eval.cpp
@@ -1,5 +1,5 @@
 
-#include "EvalProvider.h"
+#include "nixd/Eval/EvalProvider.h"
 
 #include <lspserver/Connection.h>
 

diff --git a/nixd/tools/nixd/src/Main.cpp → nixd/tools/nixd.cpp b/nixd/tools/nixd/src/Main.cpp → nixd/tools/nixd.cpp
@@ -3,7 +3,7 @@
 #include "lspserver/Connection.h"
 #include "lspserver/Logger.h"
 
-#include "Controller.h"
+#include "nixd/Controller/Controller.h"
 
 #include <llvm/ADT/ArrayRef.h>
 #include <llvm/Support/CommandLine.h>

diff --git a/nixd/tools/nixd/meson.build b/nixd/tools/nixd/meson.build