.clang-format

+# This file should be kept in sync with the one in dynare.git (which also
+# contains more explanations).
+Language: Cpp
+Standard: c++20
+ColumnLimit: 100
+BasedOnStyle: GNU
+AllowShortFunctionsOnASingleLine: None
+AlwaysBreakTemplateDeclarations: Yes
+BreakConstructorInitializers: AfterColon
+BreakInheritanceList: AfterColon
+Cpp11BracedListStyle: true
+DeriveLineEnding: false
+IndentPPDirectives: AfterHash
+PackConstructorInitializers: NextLine
+PPIndentWidth: 1
+PointerAlignment: Left
+SpaceAfterTemplateKeyword: false
+SpaceBeforeParens: ControlStatements
+SpaceBeforeCpp11BracedList: true

.clang-tidy

+# TODO: add the following check families:
+# - bugprone-*
+# - cppcoreguidelines-
+
+# NB: as of clang-tidy 16, we get several false positives inside boost, notably this one:
+#  https://github.com/llvm/llvm-project/issues/40486
+
+Checks: 'performance-*,modernize-*,-modernize-use-trailing-return-type,-clang-diagnostic-unqualified-std-cast-call'

.gitlab-ci.yml

 variables:
   TERM: linux
-  MINGW32_BOOST_VERSION: 1.81.0-7
-  MINGW64_BOOST_VERSION: 1.81.0-7
+  MINGW32_BOOST_VERSION: 1.84.0-1
+  MINGW64_BOOST_VERSION: 1.84.0-1
   WGET_OPTIONS: '--no-verbose --no-use-server-timestamps --retry-connrefused --retry-on-host-error'
+  # To ensure that "false && true" fails, see https://gitlab.com/gitlab-org/gitlab-runner/-/issues/25394#note_412609647
+  FF_ENABLE_BASH_EXIT_CODE_CHECK: 'true'
 
 build_linux_x86_64:
   stage: build
@@ -63,3 +65,10 @@ build_macos_arm64:
   artifacts:
     paths:
       - build/src/dynare-preprocessor
+
+test_clang_format:
+  stage: test
+  script:
+    - meson setup build-clang-format
+    - ninja -C build-clang-format clang-format-check
+  needs: []

meson.build

@@ -2,7 +2,8 @@
 # It is not used when building Dynare as a whole.
 
 project('dynare-preprocessor', 'cpp',
-        version : '6-unstable',
+        version : '7-unstable',
+        # NB: update C++ standard in .clang-format whenever the following is modified
         default_options : [ 'cpp_std=gnu++20', 'warning_level=2' ],
         meson_version : '>=0.64.0')
 

src/Bytecode.cc

 /*
- * Copyright © 2022-2023 Dynare Team
+ * Copyright © 2022-2024 Dynare Team
  *
  * This file is part of Dynare.
  *
@@ -17,14 +17,17 @@
  * along with Dynare.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-#include <iostream>
-#include <ios>
-#include <cstdlib>
 #include <algorithm>
+#include <cstdlib>
+#include <ios>
+#include <iostream>
 
 #include "Bytecode.hh"
 
-BytecodeWriter::BytecodeWriter(const filesystem::path &filename)
+namespace Bytecode
+{
+
+Writer::Writer(const filesystem::path& filename)
 {
   open(filename, ios::out | ios::binary);
   if (!is_open())
@@ -35,17 +38,16 @@ BytecodeWriter::BytecodeWriter(const filesystem::path &filename)
 }
 
 template<>
-BytecodeWriter &
-operator<<(BytecodeWriter &code_file, const FCALL_ &instr)
+Writer&
+operator<<(Writer& code_file, const FCALL& instr)
 {
   code_file.instructions_positions.push_back(code_file.tellp());
 
-  auto write_member = [&code_file](const auto &member)
-  {
-    code_file.write(reinterpret_cast<const char *>(&member), sizeof member);
+  auto write_member = [&code_file](const auto& member) {
+    code_file.write(reinterpret_cast<const char*>(&member), sizeof member);
   };
 
-  write_member(instr.op_code);
+  write_member(instr.tag);
   write_member(instr.nb_output_arguments);
   write_member(instr.nb_input_arguments);
   write_member(instr.indx);
@@ -56,33 +58,32 @@ operator<<(BytecodeWriter &code_file, const FCALL_ &instr)
 
   int size = static_cast<int>(instr.func_name.size());
   write_member(size);
-  code_file.write(instr.func_name.c_str(), size+1);
+  code_file.write(instr.func_name.c_str(), size + 1);
 
   size = static_cast<int>(instr.arg_func_name.size());
   write_member(size);
-  code_file.write(instr.arg_func_name.c_str(), size+1);
+  code_file.write(instr.arg_func_name.c_str(), size + 1);
 
   return code_file;
 }
 
 template<>
-BytecodeWriter &
-operator<<(BytecodeWriter &code_file, const FBEGINBLOCK_ &instr)
+Writer&
+operator<<(Writer& code_file, const FBEGINBLOCK& instr)
 {
   code_file.instructions_positions.push_back(code_file.tellp());
 
-  auto write_member = [&code_file](const auto &member)
-  {
-    code_file.write(reinterpret_cast<const char *>(&member), sizeof member);
+  auto write_member = [&code_file](const auto& member) {
+    code_file.write(reinterpret_cast<const char*>(&member), sizeof member);
   };
 
-  write_member(instr.op_code);
+  write_member(instr.tag);
   write_member(instr.size);
   write_member(instr.type);
   for (int i = 0; i < instr.size; i++)
     {
-      write_member(instr.variable[i]);
-      write_member(instr.equation[i]);
+      write_member(instr.variables[i]);
+      write_member(instr.equations[i]);
     }
   if (instr.type == BlockSimulationType::solveTwoBoundariesSimple
       || instr.type == BlockSimulationType::solveTwoBoundariesComplete
@@ -101,3 +102,5 @@ operator<<(BytecodeWriter &code_file, const FBEGINBLOCK_ &instr)
 
   return code_file;
 }
+
+}

src/CommonEnums.hh

 /*
- * Copyright © 2007-2022 Dynare Team
+ * Copyright © 2007-2023 Dynare Team
  *
  * This file is part of Dynare.
  *
@@ -17,133 +17,138 @@
  * along with Dynare.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-#ifndef _COMMON_ENUMS_HH
-#define _COMMON_ENUMS_HH
+#ifndef COMMON_ENUMS_HH
+#define COMMON_ENUMS_HH
 
 //! Enumeration of possible symbol types
-/*! Warning: do not to change existing values for 0 to 4: the values matter for homotopy_setup command */
+/*! Warning: do not to change existing values for 0 to 4: the values matter for homotopy_setup
+ * command */
 enum class SymbolType
-  {
-   endogenous = 0, //!< Endogenous
-   exogenous = 1, //!< Exogenous
-   exogenousDet = 2, //!< Exogenous deterministic
-   parameter = 4, //!< Parameter
-   modelLocalVariable = 10, //!< Local variable whose scope is model (pound expression)
-   modFileLocalVariable = 11, //!< Local variable whose scope is mod file (model excluded)
-   externalFunction = 12, //!< External (user-defined) function
-   trend = 13, //!< Trend variable
-   statementDeclaredVariable = 14, //!< Local variable assigned within a Statement (see subsample statement for example)
-   logTrend = 15, //!< Log-trend variable
-   unusedEndogenous = 16, //!< Type to mark unused endogenous variables when `nostrict` option is passed
+{
+  endogenous = 0,            //!< Endogenous
+  exogenous = 1,             //!< Exogenous
+  exogenousDet = 2,          //!< Exogenous deterministic
+  parameter = 4,             //!< Parameter
+  modelLocalVariable = 10,   //!< Local variable whose scope is model (pound expression)
+  modFileLocalVariable = 11, //!< Local variable whose scope is mod file (model excluded)
+  externalFunction = 12,     //!< External (user-defined) function
+  trend = 13,                //!< Trend variable
+  statementDeclaredVariable
+  = 14, //!< Local variable assigned within a Statement (see subsample statement for example)
+  logTrend = 15, //!< Log-trend variable
+  unusedEndogenous
+  = 16, //!< Type to mark unused endogenous variables when `nostrict` option is passed
 
-   // Value 17 is unused for the time being (but could be reused)
+  // Value 17 is unused for the time being (but could be reused)
 
-   epilogue = 18, //!< Variables created in epilogue block
-   excludedVariable = 19 //!< Variable excluded via model_remove/var_remove/include_eqs/exclude_eqs
-  };
+  epilogue = 18,        //!< Variables created in epilogue block
+  excludedVariable = 19 //!< Variable excluded via model_remove/var_remove/include_eqs/exclude_eqs
+};
 
 enum class UnaryOpcode
-  {
-   uminus,
-   exp,
-   log,
-   log10,
-   cos,
-   sin,
-   tan,
-   acos,
-   asin,
-   atan,
-   cosh,
-   sinh,
-   tanh,
-   acosh,
-   asinh,
-   atanh,
-   sqrt,
-   cbrt,
-   abs,
-   sign,
-   steadyState,
-   steadyStateParamDeriv, // for the derivative of the STEADY_STATE operator w.r.t. to a parameter
-   steadyStateParam2ndDeriv, // for the 2nd derivative of the STEADY_STATE operator w.r.t. to a parameter
-   expectation,
-   erf,
-   erfc,
-   diff,
-   adl
-  };
+{
+  uminus,
+  exp,
+  log,
+  log10,
+  cos,
+  sin,
+  tan,
+  acos,
+  asin,
+  atan,
+  cosh,
+  sinh,
+  tanh,
+  acosh,
+  asinh,
+  atanh,
+  sqrt,
+  cbrt,
+  abs,
+  sign,
+  steadyState,
+  steadyStateParamDeriv,    // for the derivative of the STEADY_STATE operator w.r.t. to a parameter
+  steadyStateParam2ndDeriv, // for the 2nd derivative of the STEADY_STATE operator w.r.t. to a
+                            // parameter
+  expectation,
+  erf,
+  erfc,
+  diff,
+  adl
+};
 
 enum class BinaryOpcode
-  {
-   plus,
-   minus,
-   times,
-   divide,
-   power,
-   powerDeriv, // for the derivative of the power function (see trac ticket #78)
-   equal,
-   max,
-   min,
-   less,
-   greater,
-   lessEqual,
-   greaterEqual,
-   equalEqual,
-   different
-  };
+{
+  plus,
+  minus,
+  times,
+  divide,
+  power,
+  powerDeriv, // for the derivative of the power function (see trac ticket #78)
+  equal,
+  max,
+  min,
+  less,
+  greater,
+  lessEqual,
+  greaterEqual,
+  equalEqual,
+  different
+};
 
 // Small number value used when evaluating powerDeriv opcodes.
 // Put here instead of inside BinaryOpNode class, because needed by bytecode MEX.
-constexpr double power_deriv_near_zero{1e-12};
+constexpr double power_deriv_near_zero {1e-12};
 
 enum class TrinaryOpcode
-  {
-   normcdf,
-   normpdf
-  };
+{
+  normcdf,
+  normpdf
+};
 
 enum class PriorDistributions
-  {
-   noShape = 0,
-   beta = 1,
-   gamma = 2,
-   normal = 3,
-   invGamma = 4,
-   invGamma1 = 4,
-   uniform = 5,
-   invGamma2 = 6,
-   dirichlet = 7,
-   weibull = 8
-  };
+{
+  noShape = 0,
+  beta = 1,
+  gamma = 2,
+  normal = 3,
+  invGamma = 4,
+  invGamma1 = 4,
+  uniform = 5,
+  invGamma2 = 6,
+  dirichlet = 7,
+  weibull = 8
+};
 
 enum class EquationType
-  {
-   unknown, //!< Unknown equation type
-   evaluate, //!< Simple evaluation, normalized variable on left-hand side (written as such by the user)
-   evaluateRenormalized, //!< Simple evaluation, normalized variable on left-hand side (normalization computed by the preprocessor)
-   solve //!< No simple evaluation of the equation, it has to be solved
-  };
+{
+  evaluate, //!< Simple evaluation, normalized variable on left-hand side (written as such by the
+            //!< user)
+  evaluateRenormalized, //!< Simple evaluation, normalized variable on left-hand side (normalization
+                        //!< computed by the preprocessor)
+  solve                 //!< No simple evaluation of the equation, it has to be solved
+};
 
 enum class BlockSimulationType
-  {
-   unknown, //!< Unknown simulation type
-   evaluateForward, //!< Simple evaluation, normalized variable on left-hand side, forward
-   evaluateBackward, //!< Simple evaluation, normalized variable on left-hand side, backward
-   solveForwardSimple, //!< Block of one equation, newton solver needed, forward
-   solveBackwardSimple, //!< Block of one equation, newton solver needed, backward
-   solveTwoBoundariesSimple, //!< Block of one equation, Newton solver needed, forward and backward
-   solveForwardComplete, //!< Block of several equations, Newton solver needed, forward
-   solveBackwardComplete, //!< Block of several equations, Newton solver needed, backward
-   solveTwoBoundariesComplete //!< Block of several equations, Newton solver needed, forward and backwar
-  };
+{
+  evaluateForward = 1,       //!< Simple evaluation, normalized variable on left-hand side, forward
+  evaluateBackward,          //!< Simple evaluation, normalized variable on left-hand side, backward
+  solveForwardSimple,        //!< Block of one equation, newton solver needed, forward
+  solveBackwardSimple,       //!< Block of one equation, newton solver needed, backward
+  solveTwoBoundariesSimple,  //!< Block of one equation, Newton solver needed, forward and backward
+  solveForwardComplete,      //!< Block of several equations, Newton solver needed, forward
+  solveBackwardComplete,     //!< Block of several equations, Newton solver needed, backward
+  solveTwoBoundariesComplete //!< Block of several equations, Newton solver needed, forward and
+                             //!< backwar
+};
 
 enum class PacTargetKind
-  {
-    unspecified, // Must be the first one, because it’s the default initializer
-    ll,
-    dl,
-    dd
-  };
+{
+  unspecified, // Must be the first one, because it’s the default initializer
+  ll,
+  dl,
+  dd
+};
 
-#endif // _COMMON_ENUMS_HH
+#endif

src/ConfigFile.hh → src/Configuration.hh

@@ -17,122 +17,110 @@
  * along with Dynare.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-#ifndef _CONFIG_FILE_HH
-#define _CONFIG_FILE_HH
+#ifndef CONFIGURATION_HH
+#define CONFIGURATION_HH
 
+#include <filesystem>
 #include <map>
 #include <vector>
-#include <filesystem>
 
 #include "WarningConsolidation.hh"
 
 using namespace std;
 
-using member_nodes_t = map<string, double>;
-
-class Hook
+/* The abstract representation of the configuration.
+   Merges information from the command-line and from the configuration file. */
+class Configuration
 {
 public:
-  explicit Hook(string global_init_file_arg);
+  Configuration(bool parallel_arg, bool parallel_test_arg, bool parallel_follower_open_mode_arg,
+                bool parallel_use_psexec_arg, string cluster_name);
+
 private:
-  map<string, string> hooks;
-public:
-  map<string, string>
-  get_hooks() const
+  using member_nodes_t = map<string, double>;
+
+  class Path
   {
-    return hooks;
+  public:
+    explicit Path(vector<string> includepath_arg);
+    [[nodiscard]] map<string, vector<string>>
+    get_paths() const
+    {
+      return paths;
+    };
+
+  private:
+    map<string, vector<string>> paths;
   };
-};
 
-class Path
-{
-public:
-  explicit Path(vector<string> includepath_arg);
-private:
-  map<string, vector<string>> paths;
-public:
-  map<string, vector<string>>
-  get_paths() const
+  struct FollowerNode
   {
-    return paths;
+    FollowerNode(string computerName_arg, string port_arg, int minCpuNbr_arg, int maxCpuNbr_arg,
+                 string userName_arg, string password_arg, string remoteDrive_arg,
+                 string remoteDirectory_arg, string programPath_arg, string programConfig_arg,
+                 string matlabOctavePath_arg, bool singleCompThread_arg,
+                 int numberOfThreadsPerJob_arg, string operatingSystem_arg);
+    const string computerName, port;
+    int minCpuNbr, maxCpuNbr;
+    const string userName, password;
+    const string remoteDrive, remoteDirectory;
+    const string programPath, programConfig, matlabOctavePath;
+    const bool singleCompThread;
+    const int numberOfThreadsPerJob;
+    const string operatingSystem;
   };
-};
 
-class FollowerNode
-{
-  friend class ConfigFile;
-public:
-  FollowerNode(string computerName_arg, string port_arg, int minCpuNbr_arg, int maxCpuNbr_arg, string userName_arg,
-               string password_arg, string remoteDrive_arg, string remoteDirectory_arg,
-               string programPath_arg, string programConfig_arg, string matlabOctavePath_arg, bool singleCompThread_arg,
-               int numberOfThreadsPerJob_arg, string operatingSystem_arg);
-
-protected:
-  const string computerName, port;
-  int minCpuNbr, maxCpuNbr;
-  const string userName, password;
-  const string remoteDrive, remoteDirectory;
-  const string programPath, programConfig, matlabOctavePath;
-  const bool singleCompThread;
-  const int numberOfThreadsPerJob;
-  const string operatingSystem;
-};
-
-class Cluster
-{
-  friend class ConfigFile;
-public:
-  explicit Cluster(member_nodes_t member_nodes_arg);
-
-protected:
-  member_nodes_t member_nodes;
-};
-
-//! The abstract representation of a "config" file
-class ConfigFile
-{
-public:
-  ConfigFile(bool parallel_arg, bool parallel_test_arg, bool parallel_follower_open_mode_arg,
-             bool parallel_use_psexec_arg, string cluster_name);
+  struct Cluster
+  {
+    explicit Cluster(member_nodes_t member_nodes_arg);
+    member_nodes_t member_nodes;
+  };
 
-private:
   const bool parallel, parallel_test, parallel_follower_open_mode, parallel_use_psexec;
   const string cluster_name;
   string firstClusterName;
   //! Hooks
-  vector<Hook> hooks;
+  string global_init_file;
   //! Paths
   vector<Path> paths;
   //! Cluster Table
   map<string, Cluster> clusters;
   //! Node Map
   map<string, FollowerNode> follower_nodes;
-  //! Add Hooks
-  void addHooksConfFileElement(string global_init_file);
   //! Add Paths
   void addPathsConfFileElement(vector<string> includepath);
   //! Add a FollowerNode or a Cluster object
-  void addParallelConfFileElement(bool inNode, bool inCluster, const member_nodes_t &member_nodes, const string &name,
-                                  const string &computerName, const string &port, int minCpuNbr, int maxCpuNbr,
-                                  const string &userName, const string &password, const string &remoteDrive,
-                                  const string &remoteDirectory, const string &programPath, const string &programConfig,
-                                  const string &matlabOctavePath, bool singleCompThread, int numberOfThreadsPerJob,
-                                  const string &operatingSystem);
+  void addParallelConfFileElement(bool inNode, bool inCluster, const member_nodes_t& member_nodes,
+                                  const string& name, const string& computerName,
+                                  const string& port, int minCpuNbr, int maxCpuNbr,
+                                  const string& userName, const string& password,
+                                  const string& remoteDrive, const string& remoteDirectory,
+                                  const string& programPath, const string& programConfig,
+                                  const string& matlabOctavePath, bool singleCompThread,
+                                  int numberOfThreadsPerJob, const string& operatingSystem);
+  /* Given a filename (e.g. dynare.ini), looks for it in the configuration directory:
+     – if under Linux or macOS, look into the “dynare” subdirectory of the XDG
+       configuration directories (following the default values and the precedence order specified in
+       the XDG specification)
+     – if under Windows, look into %APPDATA%\dynare\
+     The returned path will be empty if the file is not found. */
+  [[nodiscard]] static filesystem::path findConfigFile(const string& filename);
+
 public:
   //! Parse config file
-  void getConfigFileInfo(const filesystem::path &parallel_config_file);
+  void getConfigFileInfo(const filesystem::path& conffile_option, WarningConsolidation& warnings);
   //! Check Pass
-  void checkPass(WarningConsolidation &warnings) const;
+  void checkPass(WarningConsolidation& warnings) const;
   //! Check Pass
   void transformPass();
   //! Get Path Info
-  vector<filesystem::path> getIncludePaths() const;
+  [[nodiscard]] vector<filesystem::path> getIncludePaths() const;
   //! Write any hooks
-  void writeHooks(ostream &output) const;
+  void writeHooks(ostream& output) const;
   //! Create options_.parallel structure, write options
-  void writeCluster(ostream &output) const;
+  void writeCluster(ostream& output) const;
   //! Close follower nodes if needed
-  void writeEndParallel(ostream &output) const;
+  void writeEndParallel(ostream& output) const;
 };
 
-#endif // ! CONFIG_FILE_HH
+#endif