ProgramManager.h

Go to the documentation of this file.

 
#ifndef ELEMENTSKERNEL_ELEMENTSKERNEL_PROGRAMMANAGER_H_
#define ELEMENTSKERNEL_ELEMENTSKERNEL_PROGRAMMANAGER_H_
 
#include <map>     // for map
#include <memory>  // for unique_ptr
#include <string>  // for string
#include <vector>  // for vector
 
#include <boost/program_options/parsers.hpp>
#include <log4cpp/Priority.hh>
 
#include "ElementsKernel/Environment.h"  // For Environment
#include "ElementsKernel/Exit.h"         // For ExitCode
#include "ElementsKernel/Export.h"       // ELEMENTS_API
#include "ElementsKernel/Path.h"         // for Path::Item
#include "ElementsKernel/Program.h"
 
namespace Elements {
 
class ELEMENTS_API ProgramManager {
 
public:
  explicit 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);
 
  virtual ~ProgramManager();
 
  ExitCode run(int argc, char* argv[]);
 
  std::string getVersion() const;
 
  static void onTerminate() noexcept;
 
private:
  const Path::Item& getProgramPath() const;
 
  const Path::Item& getProgramName() const;
 
  static const Path::Item getDefaultConfigFile(const Path::Item& program_name, const std::string& module_name = "");
 
  static const Path::Item setProgramName(char* arg0);
 
  static const Path::Item setProgramPath(char* arg0);
 
  void setup(int argc, char* argv[]);
 
  void tearDown(const ExitCode&);
 
  const Program::VariablesMap getProgramOptions(int argc, char* argv[]);
 
  void logHeader(std::string program_name) const;
 
  void logFooter(std::string program_name) const;
 
  void logAllOptions() const;
 
  void logTheEnvironment() const;
 
  void bootstrapEnvironment(char* arg0);
 
  template <class charT>
  void checkCommandLineOptions(const boost::program_options::basic_parsed_options<charT>& cmd_line_options);
 
private:
  Program::VariablesMap m_variables_map{};
 
  Path::Item m_program_name;
 
  Path::Item m_program_path;
 
  std::unique_ptr<Program> m_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::string> m_search_dirs;
 
  Environment m_env;
 
  log4cpp::Priority::Value m_elements_loglevel;
};
 
}  // namespace Elements
 
#endif  // ELEMENTSKERNEL_ELEMENTSKERNEL_PROGRAMMANAGER_H_