From 37d204fa9a64e18081eb997c1d2602ebbd2df196 Mon Sep 17 00:00:00 2001
From: Thraix <thraix@hotmail.com>
Date: Fri, 11 Oct 2019 19:01:30 +0200
Subject: [PATCH] Simplify logging of help commands

---
 src/ConfigCLI.cpp | 189 ++++++++++++++++++++++++----------------------
 src/main.cpp      |  58 +++++++-------
 2 files changed, 127 insertions(+), 120 deletions(-)

diff --git a/src/ConfigCLI.cpp b/src/ConfigCLI.cpp
index 7e70407..b188905 100644
--- a/src/ConfigCLI.cpp
+++ b/src/ConfigCLI.cpp
@@ -7,139 +7,144 @@
 
 void ConfigCLI::DisplayCLIHelp()
 {
-  LOG_INFO("MakeGen conf is used to create, modify and query the makegen.conf file.");
-  LOG_INFO("");
-  LOG_INFO("Usage: makegen conf <command> [<args>] [--help] ");
-  LOG_INFO("");
-  LOG_INFO("Generating config files");
-  LOG_INFO("  gen             Prompt the user to enter information to create config");
-  LOG_INFO("");
+  LOG_INFO(1+(char*)R"(
+MakeGen conf is used to create, modify and query the makegen.conf file.
 
-  LOG_INFO("Modifying config settings");
-  LOG_INFO("  add             Add values to config settings which support multiple arguments");
-  LOG_INFO("  remove          Remove values to config settings which support multiple");
-  LOG_INFO("                   arguments");
-  LOG_INFO("  set             Set value to config settings which support only one argument");
-  LOG_INFO("");
+Usage: makegen conf <command> [<args>] [--help]
 
-  LOG_INFO("Querying config settings");
-  LOG_INFO("  get             Get value of the config setting");
+Generating config files
+  gen             Prompt the user to enter information to create config
+
+Modifying config settings
+  add           Add values to config settings which support multiple arguments
+  remove        Remove values to config settings which support multiple
+                 arguments
+  set           Set value to config settings which support only one argument
+
+
+Querying config settings
+  get             Get value of the config setting)");
 }
 
 void ConfigCLI::DisplayGenHelp()
 {
-  LOG_INFO("Generate a config file from prompts");
-  LOG_INFO("");
-  LOG_INFO("Usage: makegen conf gen <option>");
-  LOG_INFO("");
-  LOG_INFO("options:");
-  LOG_INFO("  prompt           Prompt the user for all needed settings");
-  LOG_INFO("  default          Generate a default config file. Source directory is set to");
-  LOG_INFO("                    src/, outputdir is set to bin/ and project name is set to");
-  LOG_INFO("                    the current directory name.");
+  LOG_INFO(1+(char*)R"(
+Generate a config file from prompts
+
+Usage: makegen conf gen <option>
+
+options:
+  prompt        Prompt the user for all needed settings
+  default       Generate a default config file. Source directory is set to
+                 src/, outputdir is set to bin/ and project name is set to
+                 the current directory name.)");
 }
 
 void ConfigCLI::DisplayAddHelp()
 {
-  LOG_INFO("Add values to config settings which support multiple arguments");
-  LOG_INFO("");
-  LOG_INFO("Usage: makegen conf add <setting> <value> [<values>]");
-  LOG_INFO("");
-  LOG_INFO("Valid settings are:");
-  LOG_INFO("  library       Library");
-  LOG_INFO("  libdir        Library directory");
-  LOG_INFO("  includedir    Include directory");
-  LOG_INFO("  define        Preprocessor define");
-  LOG_INFO("  cflag         g++ compiler flags");
-  LOG_INFO("  dependency    Project which current project depends on");
+  LOG_INFO(1+(char*)R"(
+Add values to config settings which support multiple arguments
+
+Usage: makegen conf add <setting> <value> [<values>]
+
+Valid settings are:
+  library       Library
+  libdir        Library directory
+  includedir    Include directory
+  define        Preprocessor define
+  cflag         g++ compiler flags
+  dependency    Project which current project depends on)");
 }
 
 void ConfigCLI::DisplayRemoveHelp()
 {
-  LOG_INFO("Remove values to config settings which support multiple arguments");
-  LOG_INFO("");
-  LOG_INFO("Usage: makegen conf remove <setting> <value> [<values>]");
-  LOG_INFO("");
-  LOG_INFO("Valid settings are:");
-  LOG_INFO("  library       Library name");
-  LOG_INFO("  libdir        Library directory");
-  LOG_INFO("  includedir    Include directory");
-  LOG_INFO("  define        Preprocessor define");
-  LOG_INFO("  cflag         g++ compiler flags");
-  LOG_INFO("  dependency    Project which current project depends on");
+  LOG_INFO(1+(char*)R"(
+Remove values to config settings which support multiple
+
+Usage: makegen conf remove <setting> <value> [<
+
+Valid settings are
+  library       Library name
+  libdir        Library directory
+  includedir    Include directory
+  define        Preprocessor define
+  cflag         g++ compiler flags
+  dependency    Project which current project depends on)");
 }
 
 void ConfigCLI::DisplaySetHelp()
 {
-  LOG_INFO("Set value to config settings which only support one argument");
-  LOG_INFO("");
-  LOG_INFO("Usage: makegen conf set <setting> <value>");
-  LOG_INFO("");
-  LOG_INFO("Valid string settings are:");
-  LOG_INFO("  outputdir     Directory of the compiled output");
-  LOG_INFO("  output        Name of the output executable/library");
-  LOG_INFO("  name          Name of the project");
-  LOG_INFO("  hfile         Name of the generated project h-file");
-  LOG_INFO("");
-  LOG_INFO("Valid boolean settings are:");
-  LOG_INFO("  executable    Specifies if the project be compiled as executable or library");
-  LOG_INFO("  shared        Specifies if the library should be compiled as shared.");
-  LOG_INFO("  genhfile      Specifies if MakeGen should generate a project h-file");
-  LOG_INFO("");
-  LOG_INFO("Boolean values can be set to either true/t/yes/y or false/f/no/n");
+  LOG_INFO(1+(char*)R"(
+Set value to config settings which only support one argument
+
+Usage: makegen conf set <setting> <value>
+
+Valid string settings are:
+  outputdir     Directory of the compiled output
+  output        Name of the output executable/library
+  name          Name of the project
+  hfile         Name of the generated project h-file
+
+Valid boolean settings are:
+  executable    Specifies if the project be compiled as executable or library
+  shared        Specifies if the library should be compiled as shared.
+  genhfile      Specifies if MakeGen should generate a project h-file
+
+Boolean values can be set to either true/t/yes/y or false/f/no/n)");
 }
 
 void ConfigCLI::DisplayGetHelp()
 {
-  LOG_INFO("Get value of the config setting");
-  LOG_INFO("");
-  LOG_INFO("Usage: makegen conf get <setting>");
-  LOG_INFO("");
-  LOG_INFO("Valid settings are:");
-  LOG_INFO("  library       Library name");
-  LOG_INFO("  libdir        Library directory");
-  LOG_INFO("  includedir    Include directory");
-  LOG_INFO("  define        Preprocessor define");
-  LOG_INFO("  cflag         g++ compiler flags");
-  LOG_INFO("  dependency    Project which current project depends on");
-  LOG_INFO("  outputdir     Directory of the compiled output");
-  LOG_INFO("  output        Name of the output executable/library");
-  LOG_INFO("  name          Name of the project");
-  LOG_INFO("  hfile         Name of the generated project h-file");
-  LOG_INFO("  executable    Specifies if the project be compiled as executable or library");
-  LOG_INFO("  shared        Specifies if the library should be compiled as shared.");
-  LOG_INFO("  genhfile      Specifies if MakeGen should generate a project h-file");
+  LOG_INFO(1+(char*)R"(
+Get value of the config setting
+
+Usage: makegen conf get <setting>
+
+Valid settings are:
+  library       Library name
+  libdir        Library directory
+  includedir    Include directory
+  define        Preprocessor define
+  cflag         g++ compiler flags
+  dependency    Project which current project depends on
+  outputdir     Directory of the compiled output
+  output        Name of the output executable/library
+  name          Name of the project
+  hfile         Name of the generated project h-file
+  executable    Specifies if the project be compiled as executable or library
+  shared        Specifies if the library should be compiled as shared.
+  genhfile      Specifies if MakeGen should generate a project h-file)");
 }
 
 std::map<std::string, std::vector<std::string>*> ConfigCLI::GetSettingVectorMap(ConfigFile& config)
 {
   return {
     {"library",&config.libs},
-      {"libdir",&config.libdirs},
-      {"includedir",&config.includedirs},
-      {"define",&config.defines},
-      {"cflag",&config.flags},
-      {"dependency",&config.dependencies}
+    {"libdir",&config.libdirs},
+    {"includedir",&config.includedirs},
+    {"define",&config.defines},
+    {"cflag",&config.flags},
+    {"dependency",&config.dependencies}
   };
 }
 
 
-std::map<std::string, std::string*> ConfigCLI::GetSettingStringMap(ConfigFile& config) 
+std::map<std::string, std::string*> ConfigCLI::GetSettingStringMap(ConfigFile& config)
 {
   return {
     {"outputdir", &config.outputdir},
-      {"output", &config.outputname},
-      {"name", &config.projectname},
-      {"hfile", &config.hFile},
+    {"output", &config.outputname},
+    {"name", &config.projectname},
+    {"hfile", &config.hFile},
   };
 }
 
-std::map<std::string, bool*> ConfigCLI::GetSettingBoolMap(ConfigFile& config) 
+std::map<std::string, bool*> ConfigCLI::GetSettingBoolMap(ConfigFile& config)
 {
   return {
     {"executable", &config.executable},
-      {"shared", &config.shared},
-      {"genhfile", &config.generateHFile}
+    {"shared", &config.shared},
+    {"genhfile", &config.generateHFile}
   };
 }
 
diff --git a/src/main.cpp b/src/main.cpp
index dcb043e..ea1f7ae 100755
--- a/src/main.cpp
+++ b/src/main.cpp
@@ -15,34 +15,36 @@
 
 void PrintHelp()
 {
-  LOG_INFO("MakeGen ", MAKEGEN_VERSION);
-  LOG_INFO("");
-  LOG_INFO("MakeGen is a utility tool to generate and run Makefiles in a simple manner.\nBy default it always compiles code with parallell jobs.");
-  LOG_INFO("");
-  LOG_INFO("Usage: makegen [options]");
-  LOG_INFO("");
-  LOG_INFO("  Options:");
-  LOG_INFO("    -h,     --help        Displays this information");
-  LOG_INFO("    -v,     --version     Displays the version of this program");
-  LOG_INFO("    -m,-a,  make, all     Generates a Makefile and runs");
-  LOG_INFO("                           make all");
-  LOG_INFO("    -i,     install       Generates a Makefile and runs");
-  LOG_INFO("                           make all && make install");
-  LOG_INFO("    -c,     clean         Generates a Makefile and runs");
-  LOG_INFO("                           make clean");
-  LOG_INFO("    -r,     rebuild       Generates a Makefile and runs");
-  LOG_INFO("                           make clean && make all");
-  LOG_INFO("    -e,     run, execute  Generates a Makefile and runs");
-  LOG_INFO("                           make all && make run");
-  LOG_INFO("    -s,     single        Runs additional makegen options as single thread");
-  LOG_INFO("                           (no --jobs=X flag)");
-  LOG_INFO("            --simple      Creates a simple Makefile without include dependencies");
-  LOG_INFO("                           (no --jobs=X flag)");
-  LOG_INFO("");
-  LOG_INFO("  If no option is given it will run \"make all\"");
-  LOG_INFO("");
-  LOG_INFO("  If multiple make options are given it will run in the following order:");
-  LOG_INFO("    clean all install run, rebuild will be translated to \"clean make\"");
+  LOG_INFO(1+(char*)R"(
+MakeGen ", MAKEGEN_VERSIO
+
+MakeGen is a utility tool to generate and run Makefiles in a simple manner.
+By default it always compiles code with parallell jobs.
+
+Usage: makegen [options]
+
+  Options:
+    -h,     --help        Displays this information
+    -v,     --version     Displays the version of this program
+    -m,-a,  make, all     Generates a Makefile and runs
+                           make all
+    -i,     install       Generates a Makefile and runs
+                           make all && make install
+    -c,     clean         Generates a Makefile and runs
+                           make clean
+    -r,     rebuild       Generates a Makefile and runs
+                           make clean && make all
+    -e,     run, execute  Generates a Makefile and runs
+                           make all && make run
+    -s,     single        Runs additional makegen options as single thread
+                           (no --jobs=X flag)
+            --simple      Creates a simple Makefile without include dependencies
+                           (no --jobs=X flag)
+
+  If no option is given it will run \"make all\"
+
+  If multiple make options are given it will run in the following order:
+    clean all install run, rebuild will be translated to \"clean make\")");
 }
 
 void GenMakefile(const ConfigFile& conf, unsigned int flags)