Elements  5.8
A C++ base framework for the Euclid Software.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Public Member Functions | Static Public Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
Elements::ProgramManager Class Reference

Class for managing all Elements programs. More...

#include <ProgramManager.h>

Collaboration diagram for Elements::ProgramManager:
[legend]

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 boost::filesystem::path & getProgramPath () const
 Getter. More...
 
const boost::filesystem::path & 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
boost::program_options::variables_map 
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
boost::filesystem::path 
getDefaultConfigFile (const boost::filesystem::path &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
boost::filesystem::path 
setProgramName (char *arg0)
 Strip the path from argv[0] to set the program name. More...
 
static const
boost::filesystem::path 
setProgramPath (char *arg0)
 Strip the name from argv[0] to set the program path. More...
 

Private Attributes

boost::program_options::variables_map m_variables_map {}
 
boost::filesystem::path m_program_name
 
boost::filesystem::path m_program_path
 
std::unique_ptr< Programm_program_ptr
 
std::string m_parent_project_version
 
std::string m_parent_project_name
 
std::string m_parent_project_vcs_version
 
std::string m_parent_module_version
 
std::string m_parent_module_name
 
std::vector< std::stringm_search_dirs
 
Environment m_env
 
log4cpp::Priority::Value m_elements_loglevel
 

Detailed Description

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 54 of file ProgramManager.h.

Constructor & Destructor Documentation

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.

Elements::ProgramManager::~ProgramManager ( )
virtual

Destructor.

Definition at line 517 of file ProgramManager.cpp.

Member Function Documentation

void Elements::ProgramManager::bootstrapEnvironment ( char *  arg0)
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::string::begin(), std::vector< T >::cbegin(), std::vector< T >::cend(), 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().

Here is the call graph for this function:

template<class charT >
void Elements::ProgramManager::checkCommandLineOptions ( const boost::program_options::basic_parsed_options< charT > &  cmd_line_options)
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().

const path Elements::ProgramManager::getDefaultConfigFile ( const boost::filesystem::path &  program_name,
const std::string module_name = "" 
)
staticprivate

Get a default configuration file name and path, to be used if not provided as a command line option.

Get default config file.

Returns
A complete name/path to the default configuration file
Todo:
check whether priotities are correct if more than one config file is found in pathSearchInEnvVariable

Definition at line 103 of file ProgramManager.cpp.

References std::string::empty(), Elements::getConfigurationLocations(), and Elements::getConfigurationPath().

Referenced by getProgramOptions().

Here is the call graph for this function:

const path & Elements::ProgramManager::getProgramName ( ) const
private

Getter.

Returns
The program name

Definition at line 93 of file ProgramManager.cpp.

References m_program_name.

Referenced by getProgramOptions().

const variables_map Elements::ProgramManager::getProgramOptions ( int  argc,
char *  argv[] 
)
private

Get the program options from the command line into thevariables_map.

Returns
A BOOST variable_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, Elements::OK, and std::exception::what().

Referenced by setup().

Here is the call graph for this function:

const path & Elements::ProgramManager::getProgramPath ( ) const
private

Getter.

Returns
The program path

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().

void Elements::ProgramManager::logAllOptions ( ) const
private

Log all program options.

Definition at line 326 of file ProgramManager.cpp.

References m_elements_loglevel, and m_variables_map.

Referenced by setup().

void Elements::ProgramManager::logFooter ( std::string  program_name) const
private

Log Footer.

Definition at line 315 of file ProgramManager.cpp.

References m_elements_loglevel.

Referenced by tearDown().

void Elements::ProgramManager::logHeader ( std::string  program_name) const
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().

void Elements::ProgramManager::logTheEnvironment ( ) const
private

Log the program environment.

Definition at line 400 of file ProgramManager.cpp.

References m_env, and Elements::Path::VARIABLE.

Referenced by setup().

void Elements::ProgramManager::onTerminate ( )
staticnoexcept

This is the set_terminate handler that is used in the MAIN_FOR macro.

Todo:
: set the exit code according to the type of exception if a clear match is found.

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(), std::exception::what(), and Elements::Exception::what().

Here is the call graph for this function:

ExitCode Elements::ProgramManager::run ( int  argc,
char *  argv[] 
)

This is the public entry point, i.e., the only method called from the main.

Parameters
argcCommand line argument number
argvCommand line arguments

Definition at line 498 of file ProgramManager.cpp.

References m_program_ptr, m_variables_map, setup(), and tearDown().

Here is the call graph for this function:

const path Elements::ProgramManager::setProgramName ( char *  arg0)
staticprivate

Strip the path from argv[0] to set the program name.

Parameters
arg0The first element of the command line, i.e., argv[0]
Returns
A BOOST path with the program name

Definition at line 134 of file ProgramManager.cpp.

References Elements::System::getExecutablePath().

Referenced by bootstrapEnvironment().

Here is the call graph for this function:

const path Elements::ProgramManager::setProgramPath ( char *  arg0)
staticprivate

Strip the name from argv[0] to set the program path.

Parameters
arg0The first element of the command line, i.e., argv[0]
Returns
A BOOST path with the program path

Definition at line 141 of file ProgramManager.cpp.

References Elements::System::getExecutablePath().

Referenced by bootstrapEnvironment().

Here is the call graph for this function:

void Elements::ProgramManager::setup ( int  argc,
char *  argv[] 
)
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, Elements::Exception::exitCode(), getProgramOptions(), logAllOptions(), logHeader(), logTheEnvironment(), m_program_name, m_variables_map, Elements::Logging::setLevel(), Elements::Logging::setLogFile(), and Elements::Exception::what().

Referenced by run().

Here is the call graph for this function:

void Elements::ProgramManager::tearDown ( const ExitCode c)
private

Definition at line 490 of file ProgramManager.cpp.

References logFooter(), and m_program_name.

Referenced by run().

Here is the call graph for this function:

Member Data Documentation

log4cpp::Priority::Value Elements::ProgramManager::m_elements_loglevel
private

default info level for the Elements internal logging messages

Definition at line 281 of file ProgramManager.h.

Referenced by logAllOptions(), logFooter(), and logHeader().

Environment Elements::ProgramManager::m_env
private

Local environment of the executable

Definition at line 276 of file ProgramManager.h.

Referenced by bootstrapEnvironment(), and logTheEnvironment().

std::string Elements::ProgramManager::m_parent_module_name
private

Name of the parent project.

Definition at line 263 of file ProgramManager.h.

Referenced by getProgramOptions().

std::string Elements::ProgramManager::m_parent_module_version
private

Version of the parent Elements module

Definition at line 258 of file ProgramManager.h.

std::string Elements::ProgramManager::m_parent_project_name
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 247 of file ProgramManager.h.

Referenced by getVersion().

std::string Elements::ProgramManager::m_parent_project_vcs_version
private

Internal version of the program. By convention, it is the same as the VCS version of the parent project

Definition at line 253 of file ProgramManager.h.

Referenced by getVersion().

std::string Elements::ProgramManager::m_parent_project_version
private

Internal version of the project

Definition at line 238 of file ProgramManager.h.

boost::filesystem::path Elements::ProgramManager::m_program_name
private

Name of the executable (from argv[0])

Definition at line 220 of file ProgramManager.h.

Referenced by bootstrapEnvironment(), getProgramName(), logHeader(), setup(), and tearDown().

boost::filesystem::path Elements::ProgramManager::m_program_path
private

Path of the executable (from argv[0])

Definition at line 225 of file ProgramManager.h.

Referenced by bootstrapEnvironment(), getProgramPath(), and logHeader().

std::unique_ptr<Program> Elements::ProgramManager::m_program_ptr
private

Pointer to a program interface, which provides two methods defineSpecificProgramOption() mainMethod()

Definition at line 233 of file ProgramManager.h.

Referenced by getProgramOptions(), and run().

std::vector<std::string> Elements::ProgramManager::m_search_dirs
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 271 of file ProgramManager.h.

Referenced by bootstrapEnvironment().

boost::program_options::variables_map Elements::ProgramManager::m_variables_map {}
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 215 of file ProgramManager.h.

Referenced by logAllOptions(), run(), and setup().


The documentation for this class was generated from the following files: