appclienums.inl

//##################################################################################################
//  ALib C++ Framework
//  Configuration Sample
//
//  Copyright 2025 A-Worx GmbH, Germany
//  Published under Boost Software License (a free software license, see LICENSE.txt)
//##################################################################################################
 
//==================================================================================================
/// This is the reference documentation of sub-namespace \c app of the \aliblink, which
/// holds types of library module \alib_app_nl.
///
/// Besides this reference documentation, further documentation and source code samples for this
/// module is provided with #"alib_mod_app;ALib Module App - Programmer's Manual".
//==================================================================================================
ALIB_EXPORT namespace alib::app {
 
/// Built-in commands used with class #"AppCli".
enum class Commands {
    Help                 = 1, ///< Show help text.
    Version              = 2, ///< Show version information.
    Info                 = 3, ///< Show info and configuration details.
    SetVariables         = 4, ///< Store a variable persistently in the configuration file.
};
 
/// Built-in options used with class #"AppCli".
enum class Options {
    Help                  = 1, ///< Alternative to command 'help' as many people are used to
                               ///< pass the help command as an option.
    Version               = 2, ///< Alternative to command 'version' as many people are used to
                               ///< pass the version command as an option.
    DryRun                = 3, ///< Show help text.
    Config                = 4, ///< Change name of config file(s).
    Verbose               = 5, ///< Be verbose.
};
 
/// Built-in parameters of commands and options used with class #"AppCli".
enum class Parameters {
    Topic                 = 1, ///< Used with command \e help to optionally denote a help topic.
    DryRunMode            = 2, ///< Used with command \e dryrun to optionally denote level.
};
 
/// Built-in exit-code used with class #"AppCli".
enum class ExitCodes {
    ErrNoCmdGiven         =   1, ///< No command given.
    ErrUnknownCommand     =   2, ///< Unknown command.
    ErrParsingOption      =   3, ///< Error when parsing an option.
    ErrParsingCommand     =   4, ///< Error when parsing a command.
    ErrMissingCmdParam    =   5, ///< Missing parameter of a command.
    ErrMissingOptParam    =   6, ///< Missing parameter of an option.
    ErrBadParamValue      =   7, ///< Bad parameter value.
};
 
 
} // namespace [alib::app]
 
// assigning ALib enum records
// Specifying our custom module to hold resources of our enum records
ALIB_CAMP_ENUM( alib::app::Commands             , alib::cli::ERCommandDecl   , alib::APPCLI_CAMP , "Commands"   )
ALIB_CAMP_ENUM( alib::app::Options              , alib::cli::EROptionDecl    , alib::APPCLI_CAMP , "Options"    )
ALIB_CAMP_ENUM( alib::app::Parameters           , alib::cli::ERParameterDecl , alib::APPCLI_CAMP , "Parameters" )
ALIB_CAMP_ENUM( alib::app::ExitCodes            , alib::cli::ERExitCodeDecl  , alib::APPCLI_CAMP , "ExitCodes"  )
ALIB_CAMP_ENUM( alib::app::App::BuiltInExitCodes, alib::cli::ERExitCodeDecl  , alib::APPCLI_CAMP , "BIExitCodes"  )