appclicamp.cpp

//--------------------------------------------------------------------------------------------------
//  ALib C++ Framework
//  Configuration Sample
//
//  Copyright 2025 A-Worx GmbH, Germany
//  Published under Boost Software License (a free software license, see LICENSE.txt)
//--------------------------------------------------------------------------------------------------
#include "alib_precompile.hpp"
#if !defined(ALIB_C20_MODULES) || ((ALIB_C20_MODULES != 0) && (ALIB_C20_MODULES != 1))
#   error "Configuration MACRO ALIB_C20_MODULES has to be given to the compiler as either 0 or 1"
#endif
#if ALIB_C20_MODULES
    module;
#endif
 
//========================================= Global Fragment ========================================
#include "alib/strings/strings.prepro.hpp"
#include "alib/app/app.prepro.hpp"
#include "ALib.Monomem.StdContainers.H"
//============================================== Module ============================================
#if ALIB_C20_MODULES
    module ALib.App;
    import   ALib.App.Impl;
    import   ALib.Lang;
    import   ALib.Strings;
    import   ALib.Boxing;
    import   ALib.EnumRecords;
    import   ALib.EnumRecords.Bootstrap;
    import   ALib.Variables;
#else
#   include "ALib.App.CLI.H"
#endif
 
//========================================== Implementation ========================================
namespace alib { app::AppCliCamp APPCLI_CAMP; }
 
namespace alib::app {
 
void AppCliCamp::Bootstrap() {
    if( GetBootstrapState() == BootstrapPhases::PrepareResources) {
        // Add bulk !
        resourcePool->BootstrapBulk( ResourceCategory,
        #define EOS ,
 
//TODO Hier gehts weiter: Was muss sonst noch rüber ins Demo???
 
//------------------------------------------ Single Strings ----------------------------------------
"AppVersion",           A_CHAR("V.{}."),
//"AppInfo", A_CHAR( "@HL-"
//                   "Command line tool 'date'. V. {}.{} (in fact a sample application only)\n"
//                   "(c) 2023-{} AWorx GmbH. Published under MIT License (Open Source).\n"
//                   "For more information, see: https://alib.dev\n"
//                   "@HL-"),
 
"USAGEFOLLOWS", A_CHAR(" Usage information follows:") ,
 
 
//--------------------------------------------- Commands -------------------------------------------
"Commands<", A_CHAR("Commands::"),
"Commands" , A_CHAR(
//enum   ident          minread     Params
"1,"    "help"          ",1"        ",TOPIC"     ","
"2,"    "version"       ",3"        ","          ","
"3,"    "info"          ",4"        ","          ","
"4,"    "setvariables"  ",4"        ","               ) EOS
 
 
"THlpCmdSht_help",
"Shows general help, help on topics and tests custom expressions",
"THlpCmdLng_help",
"Shows general help, respectively detail help on the optionally given TOPIC(s), which "
"can be a command or an option - or a parameter of such.\n"
"If command 'help' is given, no further CLI commands are processed and execution is stopped "
"with the display of the result.\n"
"\n"
"Besides AWax options, commands and parameter names, the following special topics are "
"available in addition:\n"
"\n@*>"
"Variables@p"
"Lists AWax configuration variables which are defaulted in software, configurable with "
"INI-files (see option --config) and can be overridden using environment variables or "
"CLI arguments.\n"
"@<*" EOS
 
"THlpCmdSht_version", "todo",
"THlpCmdLng_version", "todo",
"THlpCmdSht_info", "todo",
"THlpCmdLng_info", "todo",
"THlpCmdSht_setvariables", "todo",
"THlpCmdLng_setvariables", "todo",
 
 
//--------------------------------------------- Options --------------------------------------------
"Options", A_CHAR(
//enum  ident        minread    identChar   in-arg-separ.   args to consume    ShortcutTo
"1,"  "help"        ",4,"        "h,"        "="             ",0,"           ","
"2,"  "version"     ",7,"        ","         ""              ",0,"           ","
"3,"  "dryrun"      ",6,"        "d,"        "="             ",0,"           ","
"4,"  "config"      ",6,"        "c,"        "="             ",1,"           ","
"5,"  "verbose"     ",7,"        "v,"        "="             ",0,"          )EOS
 
"Options<",A_CHAR("Options::"),
"TOptUsg_help"     ,A_CHAR("--help[[=]TOPIC]")                                                     ,
"TOptHlp_help"     ,A_CHAR("Displays usage information.")                                          ,
"TOptUsg_version"  ,A_CHAR("--version")                                                            ,
"TOptHlp_version"  ,A_CHAR("Displays the version of this software.")                               ,
"TOptUsg_dryrun"   ,A_CHAR("-d|--dryrun[=][DRYRUNMODE]")                                           ,
"TOptHlp_dryrun"   ,A_CHAR("Enables dryrun-mode for sandbox testing. No changes are performed.")   ,
"TOptUsg_config"   ,A_CHAR("--config=filename1[[,filename2],filename3]...")                        ,
"TOptHlp_config"   ,A_CHAR("Allows to change the name (and path) of the configuration file(s)")    ,
"TOptUsg_verbose"  ,A_CHAR("--verbose[=\"level\"]")                                                ,
"TOptHlp_verbose"  ,A_CHAR("Changes verbosity to 'VERBOSE' or the optionally given preset. )")   EOS
 
//-------------------------------------------- Parameters ------------------------------------------
"Parameters",  A_CHAR(
//enum  name           minIdentLen   identifier          in-arg-sep   delim   args to consume  isOptional
//                                   (if empty -> mandatory!)
"0,"  "FILENAME"         ",1,"        ""                 ","          "="  ","  ",-1"          ",0"     ","
"1,"  "TOPIC"            ",1,"        ""                 ","          "="  ","  ",-1"          ",1"   ) EOS
 
"Parameters<",           A_CHAR("Parameters::"),
"THlpParSht_TOPIC"   ,   A_CHAR("Optional parameter of command (or option) 'help'."),
"THlpParLng_TOPIC"   ,   A_CHAR("Denotes a specific topic that the help command should be verbose about.")
EOS
 
//-------------------------------------------- ExitCodes -------------------------------------------
"BIExitCodes",  A_CHAR(
//enum  name                       assoc. cli exception
  "0,"  "OK"                         ",-1,"
 "10,"  "ErrConfigFileNotFound"      ",-1,"
 "11,"  "ErrConfigFileNotWritable"   ",-1,"
"127,"  "UnknownError"               ",-1"  ) EOS
 
"BIExitCodes<",  A_CHAR("ExitCodes::")
 
,  "TExit0", A_CHAR("Success (no error).")
, "TExit10", A_CHAR("Configuration file {!Q} not found.")     // todo {!Q} not yet passed with exit
, "TExit11", A_CHAR("Configuration file {!Q} not writeable.") // todo {!Q} not yet passed with exit
,"TExit127", A_CHAR("An unexpected (unhandled) internal error occured.")
EOS
 
"ExitCodes",  A_CHAR(
//enum  name                  assoc. cli exception
"1,"  "ErrNoCmdGiven"         ",-1,"
"2,"  "ErrUnknownCommand"     ",-1,"
"3,"  "ErrParsingOption"      ",-1,"
"4,"  "ErrParsingCommand"     ",-1,"
"5,"  "ErrMissingCmdParam"    ",-1,"
"6,"  "ErrMissingOptParam"    ",-1,"
"7,"  "ErrBadParamValue"      ",-1") EOS
 
"ExitCodes<",  A_CHAR("ExitCodes::")
 
,"TExit1" ,  A_CHAR("No command given.")
,"TExit2" ,  A_CHAR("Unknown command {!Q} given.")
,"TExit3" ,  A_CHAR("Unknown option {!Q} was given.")
,"TExit4" ,  A_CHAR("An error occured when parsing the command {!Q}:")
,"TExit5" ,  A_CHAR("Missing a mandatory parameter {!Q} of the given command {!Q}.")
,"TExit6" ,  A_CHAR("Missing a mandatory parameter {!Q} of the given option {!Q}.")
,"TExit7" ,  A_CHAR("Parameter {!Q} is not suitable for command or option {!Q}.")
EOS
 
//-------------------------------------------- Help Texts ------------------------------------------
"HlpHdlOpts"   ,  A_CHAR("OPTIONS:"                ) EOS
"HlpHdlCmds"   ,  A_CHAR("COMMANDS:"               ) EOS
"HlpHdlExtCds" ,  A_CHAR("EXIT-CODES:"             ) EOS
"HlpHdlUsage"  ,  A_CHAR("USAGE:"                  ) EOS
"HlpHdlDscr"   ,  A_CHAR("DESCRIPTION:"            ) EOS
"HlpHdlPDscr"  ,  A_CHAR("PARAMETER DESCRIPTION:"  ) EOS
"HlpHdlTopic"  ,  A_CHAR("Help on {} {!Q<>}:\n"    ) EOS
 
 
 
        // end of BootstrapBulk()
        nullptr );
 
        ALIB_BOXING_BOOTSTRAP_REGISTER_FAPPEND_FOR_APPENDABLE_TYPE(Commands  )
        ALIB_BOXING_BOOTSTRAP_REGISTER_FAPPEND_FOR_APPENDABLE_TYPE(Parameters)
        ALIB_BOXING_BOOTSTRAP_REGISTER_FAPPEND_FOR_APPENDABLE_TYPE(Options   )
        ALIB_BOXING_BOOTSTRAP_REGISTER_FAPPEND_FOR_APPENDABLE_TYPE(ExitCodes )
        ALIB_BOXING_BOOTSTRAP_REGISTER_FAPPEND_FOR_APPENDABLE_TYPE(App::BuiltInExitCodes )
 
    }
 
    else if( GetBootstrapState() == BootstrapPhases::PrepareConfig ) {
        enumrecords::bootstrap::Bootstrap<Commands             >();
        enumrecords::bootstrap::Bootstrap<Parameters           >();
        enumrecords::bootstrap::Bootstrap<Options              >();
        enumrecords::bootstrap::Bootstrap<ExitCodes            >();
        enumrecords::bootstrap::Bootstrap<App::BuiltInExitCodes>();
}   }
 
} // namespace [alib::app]