Quit after command-line parses env var

.gitignore

@@ -56,3 +56,6 @@ testing/src/project_version.h
 .__tmp.log
 .check_syntax.tmp
 .check_syntax2.tmp
+*.venv
+__pycache__
+.DS_Store

core/command.h

@@ -24,6 +24,7 @@
 
 #include "app.h"
 #include "exec_version.h"
+#include "mrtrix.h"
 #ifdef MRTRIX_PROJECT
 namespace MR {
   namespace App {
@@ -98,6 +99,18 @@ int main (int cmdline_argc, char** cmdline_argv)
     ::MR::GUI::App app (cmdline_argc, cmdline_argv);
 #endif
     ::MR::App::parse ();
+
+    //ENVVAR name: MRTRIX_PARSE_ONLY
+    //ENVVAR Set the command to parse the provided inputs and then quit
+    //ENVVAR if it is 1. This can be used in the CI of wrapping code,
+    //ENVVAR such as the automatically generated Pydra interfaces
+    char* parse_only = std::getenv("MRTRIX_PARSE_ONLY");
+    if (parse_only && ::MR::to<int>(parse_only)) {
+      WARN(
+        "Quitting after parsing command-line arguments successfully because environment variable 'MRTRIX_PARSE_ONLY' is set to '1'"
+      );
+      return 0;
+    }
     run ();
   }
   catch (::MR::Exception& E) {

core/exception.h

@@ -68,11 +68,11 @@ namespace MR
    * debugging information; anything else: none. */
   extern void (*report_to_user_func) (const std::string& msg, int type);
 
-#define CONSOLE(msg) if (MR::App::log_level >= 1) report_to_user_func (msg, -1)
-#define FAIL(msg) if (MR::App::log_level >= 0) report_to_user_func (msg, 0)
-#define WARN(msg) if (MR::App::log_level >= 1) report_to_user_func (msg, 1)
-#define INFO(msg) if (MR::App::log_level >= 2) report_to_user_func (msg, 2)
-#define DEBUG(msg) if (MR::App::log_level >= 3) report_to_user_func (msg, 3)
+#define CONSOLE(msg) if (MR::App::log_level >= 1) MR::report_to_user_func (msg, -1)
+#define FAIL(msg) if (MR::App::log_level >= 0) MR::report_to_user_func (msg, 0)
+#define WARN(msg) if (MR::App::log_level >= 1) MR::report_to_user_func (msg, 1)
+#define INFO(msg) if (MR::App::log_level >= 2) MR::report_to_user_func (msg, 2)
+#define DEBUG(msg) if (MR::App::log_level >= 3) MR::report_to_user_func (msg, 3)
 
 
 

docs/reference/environment_variables.rst

@@ -53,6 +53,12 @@ List of MRtrix3 environment variables
      :option:`NumberOfThreads` setting in the configuration file, but
      will be overridden by the ENVVAR ``-nthreads`` command-line option.
 
+.. envvar:: MRTRIX_PARSE_ONLY
+
+     Set the command to parse the provided inputs and then quit
+     if it is 1. This can be used in the CI of wrapping code,
+     such as the automatically generated Pydra interfaces
+
 .. envvar:: MRTRIX_PRESERVE_PHILIPS_ISO
 
      Do not remove the synthetic isotropically-weighted diffusion