Don't include solver headers verbatim.

src/codegen/codegen_coreneuron_cpp_visitor.cpp

@@ -21,7 +21,6 @@
 #include "config/config.h"
 #include "lexer/token_mapping.hpp"
 #include "parser/c11_driver.hpp"
-#include "solver/solver.hpp"
 #include "utils/logger.hpp"
 #include "utils/string_utils.hpp"
 #include "visitors/defuse_analyze_visitor.hpp"
@@ -1005,7 +1004,7 @@
         #include <coreneuron/utils/randoms/nrnran123.h>
     )CODE");
     if (info.eigen_newton_solver_exist) {
-        printer->add_multi_line(nmodl::solvers::newton_hpp);
+        printer->add_line("#include \"solver/newton.hpp\"");
     }
     if (info.eigen_linear_solver_exist) {
         if (std::accumulate(info.state_vars.begin(),
@@ -1014,7 +1013,7 @@
                             [](int l, const SymbolType& variable) {
                                 return l += variable->get_length();
                             }) > 4) {
-            printer->add_multi_line(nmodl::solvers::crout_hpp);
+            printer->add_line("#include \"solver/crout.hpp\"");
         } else {
             printer->add_line("#include <Eigen/Dense>");
             printer->add_line("#include <Eigen/LU>");

src/codegen/codegen_neuron_cpp_visitor.cpp

@@ -20,7 +20,6 @@
 #include "codegen/codegen_utils.hpp"
 #include "codegen_naming.hpp"
 #include "config/config.h"
-#include "solver/solver.hpp"
 #include "utils/string_utils.hpp"
 #include "visitors/rename_visitor.hpp"
 #include "visitors/var_usage_visitor.hpp"
@@ -754,7 +753,7 @@
         #include <vector>
     )CODE");
     if (info.eigen_newton_solver_exist) {
-        printer->add_multi_line(nmodl::solvers::newton_hpp);
+        printer->add_line("#include \"solver/newton.hpp\"");
     }
 }
 
@@ -1321,7 +1320,7 @@
 
 void CodegenNeuronCppVisitor::print_mechanism_range_var_structure(bool print_initializers) {
     auto const value_initialize = print_initializers ? "{}" : "";
     auto int_type = default_int_data_type();
     printer->add_newline(2);
     printer->add_line("/** all mechanism instance variables and global variables */");
     printer->fmt_push_block("struct {} ", instance_struct());
@@ -1620,7 +1619,7 @@
             }
             const auto& var_name = var->get_name();
             auto var_pos = position_of_float_var(var_name);
             double var_value = var->get_value() == nullptr ? 0.0 : *var->get_value();
 
             printer->fmt_line("_lmc.template fpfield<{}>(_iml) = {}; /* {} */",
                               var_pos,

src/main.cpp

@@ -5,11 +5,12 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+#include <filesystem>
+#include <fstream>
 #include <string>
 #include <vector>
 
 #include <CLI/CLI.hpp>
-#include <filesystem>
 
 #include "ast/program.hpp"
 #include "codegen/codegen_acc_visitor.hpp"
@@ -20,6 +21,7 @@
 #include "config/config.h"
 #include "parser/nmodl_driver.hpp"
 #include "pybind/pyembed.hpp"
+#include "solver/solver.hpp"
 #include "utils/common_utils.hpp"
 #include "utils/logger.hpp"
 #include "visitors/after_cvode_to_cnexp_visitor.hpp"
@@ -60,6 +62,26 @@
 using namespace visitor;
 using nmodl::parser::NmodlDriver;
 
+fs::path get_solver_path(const fs::path& directory, const std::string& solver) {
+    auto path = directory / "solver" / solver;
+    path += ".hpp";
+    return path;
+}
+
+void write_shared_headers(const std::string& directory,
+                          const std::vector<std::string>& solvers = nmodl::solver::get_names()) {
+    fs::path output(directory);
+
+    for (const auto& solver: solvers) {
+        const auto& path = get_solver_path(directory, solver);
+        fs::create_directories(path.parent_path());
+
+        std::ofstream fout(path);
+        fout << nmodl::solver::get_hpp(solver);
+        logger->info("Generated {}", path.string());
+    }
+}
+
 // NOLINTNEXTLINE(readability-function-cognitive-complexity)
 int main(int argc, const char* argv[]) {
     CLI::App app{fmt::format("NMODL : Source-to-Source Code Generation Framework [{}]",
@@ -180,6 +202,17 @@
     app.add_option("-o,--output", output_dir, "Directory for backend code output")
         ->capture_default_str()
         ->ignore_case();
+
+    app.add_option_function<std::vector<std::string>>(
+           "--write-shared-headers",
+           [&](const std::vector<std::string>& solvers) {
+               write_shared_headers(output_dir, solvers);
+               exit(0);
+           },
+           "Create solver headers in directory and exit")
+        ->expected(1, 2)
+        ->check(CLI::IsMember(nmodl::solver::get_names()));
+
     app.add_option("--scratch", scratch_dir, "Directory for intermediate code output")
         ->capture_default_str()
         ->ignore_case();

src/solver/CMakeLists.txt

@@ -1,15 +1,11 @@
 # Read headers, remove everything up to and including "#pragma once", then remove header includes.
-file(READ ${CMAKE_CURRENT_SOURCE_DIR}/crout/crout.hpp NMODL_CROUT_HPP_RAW)
-string(REGEX REPLACE ".*#pragma once[ \t\r\n]*" "" NMODL_CROUT_HPP "${NMODL_CROUT_HPP_RAW}")
-file(READ ${CMAKE_CURRENT_SOURCE_DIR}/newton/newton.hpp NMODL_NEWTON_HPP_RAW)
-string(REGEX REPLACE ".*#pragma once[ \t\r\n]*" "" NMODL_NEWTON_HPP_TMP "${NMODL_NEWTON_HPP_RAW}")
-string(REGEX REPLACE "#include <crout/crout.hpp>[ \t\r\n]*" "" NMODL_NEWTON_HPP
-                     "${NMODL_NEWTON_HPP_TMP}")
+file(READ ${CMAKE_CURRENT_SOURCE_DIR}/crout.hpp NMODL_CROUT_HPP)
+file(READ ${CMAKE_CURRENT_SOURCE_DIR}/newton.hpp NMODL_NEWTON_HPP)
 set_property(
   DIRECTORY
   APPEND
-  PROPERTY CMAKE_CONFIGURE_DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/crout/crout.hpp
-           ${CMAKE_CURRENT_SOURCE_DIR}/newton/newton.hpp)
+  PROPERTY CMAKE_CONFIGURE_DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/crout.hpp
+           ${CMAKE_CURRENT_SOURCE_DIR}/newton.hpp)
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/solver.hpp.inc ${CMAKE_CURRENT_BINARY_DIR}/solver.hpp)
 
 add_custom_target(nmodl_copy_solver_files ALL DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/solver.hpp")

src/solver/newton/newton.hpp → src/solver/newton.hpp

@@ -15,7 +15,7 @@
  * \brief Implementation of Newton method for solving system of non-linear equations
  */
 
-#include <crout/crout.hpp>
+#include "crout.hpp"
 
 #include <Eigen/Dense>
 #include <Eigen/LU>

src/solver/solver.hpp.inc

@@ -1,4 +1,5 @@
 #include <string>
+#include <vector>
 
 // This file is generated from `crout/crout.hpp` and `newton/newton.hpp`.
 //
@@ -8,13 +9,19 @@
 // However, because we want to be able to test the headers separately we can't
 // move them here.
 
-namespace nmodl::solvers {
-const std::string crout_hpp = R"jiowi(
-@NMODL_CROUT_HPP@
-)jiowi";
-const std::string newton_hpp = R"jiowi(
-@NMODL_CROUT_HPP@
-@NMODL_NEWTON_HPP@
-)jiowi";
+namespace nmodl::solver {
+const std::vector<std::string> get_names() {
+    return {"crout", "newton"};
+}
+
+const std::string get_hpp(const std::string& solver) {
+    if (solver == "crout") {
+        return R"jiowi(@NMODL_CROUT_HPP@)jiowi";
+    } else if (solver == "newton") {
+        return R"jiowi(@NMODL_NEWTON_HPP@)jiowi";
+    } else {
+        throw std::runtime_error("unknown solver '" + solver + "'");
+    }
+};
 
 }

test/unit/crout/crout.cpp

@@ -5,7 +5,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include "crout/crout.hpp"
+#include "crout.hpp"
 
 #include <catch2/catch_test_macros.hpp>
 

test/unit/newton/newton.cpp

@@ -5,7 +5,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include "newton/newton.hpp"
+#include "newton.hpp"
 
 #include <catch2/catch_test_macros.hpp>
 #include <catch2/matchers/catch_matchers_floating_point.hpp>