Elements
5.12.0
A C++ base framework for the Euclid Software.
|
Class for managing all Elements programs. More...
#include <ProgramManager.h>
Public Member Functions | |
ProgramManager (std::unique_ptr< Program > program_ptr, const std::string &parent_project_version="", const std::string &parent_project_name="", const std::string &parent_project_vcs_version="", const std::string &parent_module_version="", const std::string &parent_module_name="", const std::vector< std::string > &search_dirs={}, const log4cpp::Priority::Value &elements_loglevel=log4cpp::Priority::DEBUG) | |
Constructor. More... | |
virtual | ~ProgramManager () |
Destructor. More... | |
ExitCode | run (int argc, char *argv[]) |
This is the public entry point, i.e., the only method called from the main. More... | |
std::string | getVersion () const |
This function returns the version of the program computed at compile time. This is the same as the project version that contains the program. More... | |
Static Public Member Functions | |
static void | onTerminate () noexcept |
This is the set_terminate handler that is used in the MAIN_FOR macro. More... | |
Private Member Functions | |
const Path::Item & | getProgramPath () const |
Getter. More... | |
const Path::Item & | getProgramName () const |
Getter. More... | |
void | setup (int argc, char *argv[]) |
Program setup taking care of command line options and logging initialization. More... | |
void | tearDown (const ExitCode &) |
const Program::VariablesMap | getProgramOptions (int argc, char *argv[]) |
Get the program options from the command line into thevariables_map. More... | |
void | logHeader (std::string program_name) const |
Log Header. More... | |
void | logFooter (std::string program_name) const |
Log Footer. More... | |
void | logAllOptions () const |
Log all program options. More... | |
void | logTheEnvironment () const |
Log the program environment. More... | |
void | bootstrapEnvironment (char *arg0) |
Bootstrap the Environment from the executable location and the install path computed at install time. More... | |
template<class charT > | |
void | checkCommandLineOptions (const boost::program_options::basic_parsed_options< charT > &cmd_line_options) |
check the explicit command line arguments. For the moment, it only checks if the configuration file being passed does exist. It exits with ExitCode::CONFIG if the file cannot be found. More... | |
Static Private Member Functions | |
static const Path::Item | getDefaultConfigFile (const Path::Item &program_name, const std::string &module_name="") |
Get a default configuration file name and path, to be used if not provided as a command line option. More... | |
static const Path::Item | setProgramName (char *arg0) |
Strip the path from argv[0] to set the program name. More... | |
static const Path::Item | setProgramPath (char *arg0) |
Strip the name from argv[0] to set the program path. More... | |
Class for managing all Elements programs.
This base class offers solutions for the common needs of all Elements programs, such as those dealing with program options and logging.
Definition at line 55 of file ProgramManager.h.
Elements::ProgramManager::ProgramManager | ( | std::unique_ptr< Program > | program_ptr, |
const std::string & | parent_project_version = "" , |
||
const std::string & | parent_project_name = "" , |
||
const std::string & | parent_project_vcs_version = "" , |
||
const std::string & | parent_module_version = "" , |
||
const std::string & | parent_module_name = "" , |
||
const std::vector< std::string > & | search_dirs = {} , |
||
const log4cpp::Priority::Value & | elements_loglevel = log4cpp::Priority::DEBUG |
||
) |
Constructor.
Definition at line 69 of file ProgramManager.cpp.
|
virtual |
Destructor.
Definition at line 517 of file ProgramManager.cpp.
|
private |
Bootstrap the Environment from the executable location and the install path computed at install time.
Definition at line 415 of file ProgramManager.cpp.
References std::vector< T >::begin(), std::vector< T >::cbegin(), std::vector< T >::cend(), std::vector< T >::insert(), Elements::Path::joinPath(), m_env, m_program_name, m_program_path, m_search_dirs, Elements::Path::multiPathAppend(), Elements::Path::PATH_SEP, Elements::Units::s, setProgramName(), setProgramPath(), std::vector< T >::size(), Elements::Path::SUFFIXES, std::transform(), and Elements::Path::VARIABLE.
Referenced by setup().
|
private |
check the explicit command line arguments. For the moment, it only checks if the configuration file being passed does exist. It exits with ExitCode::CONFIG if the file cannot be found.
Definition at line 149 of file ProgramManager.cpp.
References Elements::CONFIG, and Elements::USAGE.
Referenced by getProgramOptions().
|
staticprivate |
Get a default configuration file name and path, to be used if not provided as a command line option.
Get default config file.
Definition at line 103 of file ProgramManager.cpp.
References std::string::empty(), Elements::getConfigurationLocations(), and Elements::getConfigurationPath().
Referenced by getProgramOptions().
|
private |
Getter.
Definition at line 93 of file ProgramManager.cpp.
References m_program_name.
Referenced by getProgramOptions().
|
private |
Get the program options from the command line into thevariables_map.
Definition at line 172 of file ProgramManager.cpp.
References checkCommandLineOptions(), Elements::Units::e, std::exit(), getDefaultConfigFile(), getProgramName(), getVersion(), m_parent_module_name, m_program_ptr, and Elements::OK.
Referenced by setup().
|
private |
Getter.
Definition at line 89 of file ProgramManager.cpp.
References m_program_path.
string Elements::ProgramManager::getVersion | ( | ) | const |
This function returns the version of the program computed at compile time. This is the same as the project version that contains the program.
Definition at line 510 of file ProgramManager.cpp.
References m_parent_project_name, and m_parent_project_vcs_version.
Referenced by getProgramOptions().
|
private |
Log all program options.
Definition at line 326 of file ProgramManager.cpp.
References m_elements_loglevel, and m_variables_map.
Referenced by setup().
|
private |
Log Footer.
Definition at line 315 of file ProgramManager.cpp.
References m_elements_loglevel.
Referenced by tearDown().
|
private |
Log Header.
Definition at line 305 of file ProgramManager.cpp.
References m_elements_loglevel, m_program_name, and m_program_path.
Referenced by setup().
|
private |
Log the program environment.
Definition at line 400 of file ProgramManager.cpp.
References m_env, and Elements::Path::VARIABLE.
Referenced by setup().
|
staticnoexcept |
This is the set_terminate handler that is used in the MAIN_FOR macro.
Definition at line 519 of file ProgramManager.cpp.
References std::_Exit(), Elements::System::backTrace(), std::current_exception(), Elements::Exception::exitCode(), Elements::NOT_OK, std::rethrow_exception(), Elements::Exception::what(), and std::exception::what().
ExitCode Elements::ProgramManager::run | ( | int | argc, |
char * | argv[] | ||
) |
This is the public entry point, i.e., the only method called from the main.
argc | Command line argument number |
argv | Command line arguments |
Definition at line 498 of file ProgramManager.cpp.
References m_program_ptr, m_variables_map, setup(), and tearDown().
|
staticprivate |
Strip the path from argv[0] to set the program name.
arg0 | The first element of the command line, i.e., argv[0] |
Definition at line 134 of file ProgramManager.cpp.
References Elements::System::getExecutablePath().
Referenced by bootstrapEnvironment().
|
staticprivate |
Strip the name from argv[0] to set the program path.
arg0 | The first element of the command line, i.e., argv[0] |
Definition at line 141 of file ProgramManager.cpp.
References Elements::System::getExecutablePath().
Referenced by bootstrapEnvironment().
|
private |
Program setup taking care of command line options and logging initialization.
Definition at line 450 of file ProgramManager.cpp.
References std::_Exit(), bootstrapEnvironment(), Elements::CONFIG, Elements::Units::e, getProgramOptions(), logAllOptions(), logHeader(), logTheEnvironment(), m_program_name, m_variables_map, Elements::Logging::setLevel(), and Elements::Logging::setLogFile().
Referenced by run().
|
private |
Definition at line 490 of file ProgramManager.cpp.
References logFooter(), and m_program_name.
Referenced by run().
|
private |
default info level for the Elements internal logging messages
Definition at line 282 of file ProgramManager.h.
Referenced by logAllOptions(), logFooter(), and logHeader().
|
private |
Local environment of the executable
Definition at line 277 of file ProgramManager.h.
Referenced by bootstrapEnvironment(), and logTheEnvironment().
|
private |
Name of the parent project.
Definition at line 264 of file ProgramManager.h.
Referenced by getProgramOptions().
|
private |
Version of the parent Elements module
Definition at line 259 of file ProgramManager.h.
|
private |
Name of the parent project. To avoid ambiguities and because a module can be moved from one project to another, the full version of the program will look like
m_parent_project_version [m_parent_project_name]
Definition at line 248 of file ProgramManager.h.
Referenced by getVersion().
|
private |
Internal version of the program. By convention, it is the same as the VCS version of the parent project
Definition at line 254 of file ProgramManager.h.
Referenced by getVersion().
|
private |
Internal version of the project
Definition at line 239 of file ProgramManager.h.
|
private |
Name of the executable (from argv[0])
Definition at line 221 of file ProgramManager.h.
Referenced by bootstrapEnvironment(), getProgramName(), logHeader(), setup(), and tearDown().
|
private |
Path of the executable (from argv[0])
Definition at line 226 of file ProgramManager.h.
Referenced by bootstrapEnvironment(), getProgramPath(), and logHeader().
|
private |
Pointer to a program interface, which provides two methods defineSpecificProgramOption() mainMethod()
Definition at line 234 of file ProgramManager.h.
Referenced by getProgramOptions(), and run().
|
private |
List of directories needed to update the runtime search environment (PATH, LD_LIBRARY_PATH, ELEMENTS_CONF_PATH, and ELEMENTS_AUX_PATH). This list contains the install locations of all the dependent projects.
Definition at line 272 of file ProgramManager.h.
Referenced by bootstrapEnvironment().
|
private |
This is the BOOST program options variable_map used to store all program options. It is similar to a std::map but the element can be of different types. See the pseudoMain() in ElementsProgramExample.cpp to see how to retrieve options from this map.
Definition at line 216 of file ProgramManager.h.
Referenced by logAllOptions(), run(), and setup().