CLI extraction concept (#14)

Author: mj-xmr

src/lib-base/src/CLI.cpp

@@ -0,0 +1,77 @@
+#include "CLI.h"
+#include "CLIResult.h"
+#include "ConfigTS.h"
+//#include "TSXformTypeString.h"
+#include <Util/CoutBuf.hpp>
+
+#include <EnjoLibBoost/ProgramOptions.hpp>
+
+using namespace EnjoLib;
+
+CLI::CLI(){}
+CLI::~CLI(){}
+
+EnjoLib::Result<CLIResult> CLI::GetConfigs(int argc, char ** argv) const
+{
+    //const char * OPT_PLUGIN  = "plugin";
+
+    const char * OPT_MIN_MONTH = "min-month";
+    const char * OPT_MIN_YEAR  = "min-year";
+    const char * OPT_MAX_MONTH = "max-month";
+    const char * OPT_MAX_YEAR  = "max-year";
+    //const char * OPT_LATEST_DATE = "latest-date";
+    const char * OPT_SYMBOL = "sym";
+    const char * OPT_PERIOD  = "per";
+
+    EnjoLib::ProgramOptionsState popState;
+    ////popState.AddStr(OPT_PLUGIN,    "Plugin name");
+    popState.AddInt(OPT_MIN_MONTH,  "Start month"); /// TODO: Option Add(char*, char*, int & refVal);. A new class beside the old one or replace the old one?
+    popState.AddInt(OPT_MIN_YEAR,   "Start year");
+    popState.AddInt(OPT_MAX_MONTH,  "End month");
+    popState.AddInt(OPT_MAX_YEAR,   "End year");
+    popState.AddStr(OPT_SYMBOL,     "Symbol name");
+    popState.AddStr(OPT_PERIOD,     "Period name");
+
+    popState.ReadArgs(argc, argv);
+    const EnjoLib::ProgramOptions pops(popState);
+    
+    ConfigSym confSym;
+
+    if (pops.IsHelpRequested())
+    {
+        /// TODO: Try also to react also on -h by adding here:
+        /**
+        bool ProgramOptions::IsHelpRequested() const
+        {
+            return GetBoolFromMap(ProgramOptionsState::OPT_HELP);
+        }
+        return GetBoolFromMap(ProgramOptionsState::OPT_HELP || return GetBoolFromMap(ProgramOptionsState::OPT_HELP_MIN););
+        const char * OPT_HELP_MIN = "h";
+        */
+        ELO
+        LOG << pops.GetHelp() << Nl;
+
+        LOG << GetAdditionalHelp();
+        LOG << Nl;
+        LOG << "The default path of the script is: " << ConfigTS::DEFAULT_SCRIPT_FILE_NAME << Nl;
+        LOG << "\n(C) 2012-2022 mj-xmr. Licensed under AGPLv3.\n";
+        LOG << "https://github.com/mj-xmr/tsqsim\n";
+        LOG << "\nRemember to be happy.\n\n";
+        return EnjoLib::Result<CLIResult>(CLIResult(confSym), false);
+    }
+    
+    confSym.dates.Set0();
+
+    confSym.dates.monthStart 	= pops.GetIntFromMap(OPT_MIN_MONTH);
+    confSym.dates.yearStart  	= pops.GetIntFromMap(OPT_MIN_YEAR);
+    confSym.dates.monthEnd   	= pops.GetIntFromMap(OPT_MAX_MONTH);
+    confSym.dates.yearEnd    	= pops.GetIntFromMap(OPT_MAX_YEAR);
+    confSym.symbol     		    = pops.GetStrFromMap(OPT_SYMBOL);
+    confSym.period     		    = pops.GetStrFromMap(OPT_PERIOD);
+    
+    //auto pluginName = pops.GetStrFromMap (OPT_PLUGIN);
+    
+    CLIResult res(confSym);
+    
+    return EnjoLib::Result<CLIResult>(CLIResult(confSym), true);
+}

src/lib-base/src/CLI.h

@@ -0,0 +1,24 @@
+#ifndef CLI_H
+#define CLI_H
+
+#include <Util/Str.hpp>
+#include <Util/Result.hpp>
+
+struct CLIResult;
+
+class CLI
+{
+    public:
+        CLI();
+        virtual ~CLI();
+        
+        EnjoLib::Result<CLIResult> GetConfigs(int argc, char ** argv) const;
+        
+        virtual EnjoLib::Str GetAdditionalHelp() const = 0;
+
+    protected:
+
+    private:
+};
+
+#endif // CLI_H

src/lib-base/src/CLIResult.cpp

@@ -0,0 +1 @@
+#include "CLIResult.h"

src/lib-base/src/CLIResult.h

@@ -0,0 +1,18 @@
+#ifndef CLIRESULT_H
+#define CLIRESULT_H
+
+#include "ConfigSym.h"
+
+struct CLIResult
+{
+    CLIResult(const ConfigSym & confSym)
+    : m_confSym(confSym)
+    {
+        
+    }
+    
+    ConfigSym m_confSym;
+    
+};
+
+#endif // CLIRESULT_H

src/lib-base/src/ConfigSym.cpp

@@ -54,6 +54,13 @@ void ConfigSym::RegisterAndReadStrs(EnjoLib::Istream & f)
     RegisterAndReadStr(f, period, "h8");
 }
 
+void ConfigSym::UpdateFromOther(const ConfigSym & cfgSymCmdLine)
+{
+    dates.UpdateIfNot0(cfgSymCmdLine.dates);
+    if (cfgSymCmdLine.symbol.size()) symbol = cfgSymCmdLine.symbol;
+    if (cfgSymCmdLine.period.size()) period = cfgSymCmdLine.period;
+}
+
 /*
 void ConfigSym::SetStandardVals()
 {

src/lib-base/src/ConfigSym.h

@@ -20,6 +20,8 @@ class ConfigSym : public ConfigBase
         void RegisterAndReadInts(EnjoLib::Istream & ifs) override;
         void RegisterAndReadFloats(EnjoLib::Istream & ifs) override;
         void RegisterAndReadStrs(EnjoLib::Istream & ifs) override;
+        
+        void UpdateFromOther(const ConfigSym & cfgSymCmdLine);
 
         //void SetStandardVals();
         bool ShiftRange(int shift);

src/tsqsim-lib/src/CLITsq.cpp

@@ -0,0 +1,23 @@
+#include "CLITsq.h"
+#include "TSXformTypeString.h"
+
+#include <Ios/Osstream.hpp>
+#include <Template/Array.hpp>
+
+using namespace EnjoLib;
+
+CLITsq::CLITsq(){}
+CLITsq::~CLITsq(){}
+
+EnjoLib::Str CLITsq::GetAdditionalHelp() const
+{
+    Osstream oss;
+    const TSXformTypeString types;
+    oss << "Available transformations for text-based scripting:\n";
+    for (const Str & name : types.GetNames())
+    {
+        oss << name << " ";
+    }
+    
+    return oss.str();
+}

src/tsqsim-lib/src/CLITsq.h

@@ -0,0 +1,24 @@
+#ifndef CLITSQ_H
+#define CLITSQ_H
+
+#include "CLI.h"
+
+#include <Util/Str.hpp>
+#include <Util/Result.hpp>
+
+struct CLIResult;
+
+class CLITsq : public CLI
+{
+    public:
+        CLITsq();
+        virtual ~CLITsq();
+
+        EnjoLib::Str GetAdditionalHelp() const override;
+
+    protected:
+
+    private:
+};
+
+#endif // CLITSQ_H

src/tsqsim-qt/src/main.cpp

@@ -26,6 +26,8 @@
 
 #include "MyMainWindow.h"
 #include "Monster.h"
+#include "CLITsq.h"
+#include "CLIResult.h"
 #include <StrategyFactoryDummy.h>
 #include <SymbolFactoryClean.h>
 #include <ConfigMan.h>
@@ -50,7 +52,15 @@ int main(int argc, char *argv[])
     int mode = 0;
     if (argc > 1)
     {
-        mode = CharManipulations().ToInt(argv[1]);
+        /// TODO: Restore?
+        //mode = CharManipulations().ToInt(argv[1]);
+    }
+    // Experiment:
+    const CLITsq cli;
+    const EnjoLib::Result<CLIResult> & result = cli.GetConfigs(argc, argv);
+    if (not result.isSuccess)
+    {
+        return 0;
     }
     //screenShot = true;
     const EnjoLib::Str screenShotOutDir  = argc > 2 ? argv[2] : "";
@@ -88,6 +98,7 @@ int main(int argc, char *argv[])
 #if QT_VERSION < QT_VERSION_CHECK(5, 0, 0)
     QApplication::setGraphicsSystem("raster");
 #endif
+    /// TODO: Check it it's useful:
     QApplication a(argc, argv);
 
     //cout << "mode = " << mode << "\nscreenShotOutDir = " << screenShotOutDir << "\nscreenShotSymbol = " << screenShotSymbol << "\nscreenShotPeriod = " << screenShotPeriod << "\ndataInputFileName = " << dataInputFileName << endl;

src/tsqsim/CMakeLists.txt

@@ -11,6 +11,7 @@ enjoSetupTarget(${PROJECT_NAME})
 tsqSetupSymlinks(${PROJECT_NAME})
 
 # TODO: Rather copy than symlink?
+# TODO: Move scripts to tsqsim-lib
 enjoSymlink(${PROJECT_NAME} ${CMAKE_CURRENT_SOURCE_DIR}/scripts ${CMAKE_BINARY_DIR}/../scripts)
 
 target_link_libraries(${PROJECT_NAME} tsqsim-lib)