DDS  ver. 2.0
dds-agent/src/Options.h
Go to the documentation of this file.
1 // Copyright 2014 GSI, Inc. All rights reserved.
2 //
3 //
4 //
5 #ifndef DDSOPTIONS_H
6 #define DDSOPTIONS_H
7 //=============================================================================
8 // STD
9 #include <stdexcept>
10 #include <string>
11 // BOOST
12 #include <boost/program_options/options_description.hpp>
13 #include <boost/program_options/parsers.hpp>
14 // DDS
15 #include "Logger.h"
16 #include "Res.h"
17 #include "UserDefaults.h"
18 #include "version.h"
19 //=============================================================================
20 namespace bpo = boost::program_options;
21 //=============================================================================
22 namespace dds
23 {
24  namespace agent_cmd
25  {
27  typedef struct SOptions
28  {
29  enum ECommands
30  {
34  };
37  {
38  }
39 
40  static ECommands getCommandByName(const std::string& _name)
41  {
42  if ("start" == _name)
43  return cmd_start;
44  else if ("clean" == _name)
45  return cmd_clean;
46 
47  return cmd_unknown;
48  }
49 
51  } SOptions_t;
52  //=============================================================================
53  inline void PrintVersion()
54  {
55  LOG(MiscCommon::log_stdout) << PROJECT_NAME << " v" << PROJECT_VERSION_STRING << "\n"
56  << "DDS configuration"
57  << " v" << USER_DEFAULTS_CFG_VERSION << "\n"
59  }
60  //=============================================================================
61  // Command line parser
62  inline bool ParseCmdLine(int _argc, char* _argv[], SOptions* _options)
63  {
64  if (nullptr == _options)
65  throw std::runtime_error("Internal error: options' container is empty.");
66 
67  // Generic options
68  bpo::options_description options("dds-agent options");
69  options.add_options()("help,h", "Produce help message");
70  options.add_options()("version,v", "Version information");
71  options.add_options()("command",
72  bpo::value<std::string>(),
73  "The command is a name of dds-agent command."
74  " Can be one of the following: start, clean.\n"
75  "For user's convenience it is allowed to call dds-agent without \"--command\" option"
76  " by just specifying the command name directly, like:\ndds-agent start.\n\n"
77  "Commands:\n"
78  " start: \tStart dds-agent\n"
79  " clean: \tCleaning");
80 
81  //...positional
82  bpo::positional_options_description pd;
83  pd.add("command", 1);
84 
85  // Parsing command-line
86  bpo::variables_map vm;
87  bpo::store(bpo::command_line_parser(_argc, _argv).options(options).positional(pd).run(), vm);
88  bpo::notify(vm);
89 
90  if (vm.count("help") || vm.empty())
91  {
92  LOG(MiscCommon::log_stdout) << options;
93  return false;
94  }
95  if (vm.count("version"))
96  {
97  PrintVersion();
98  return false;
99  }
100 
101  // Command
102  if (vm.count("command"))
103  {
104  if (SOptions::cmd_unknown == SOptions::getCommandByName(vm["command"].as<std::string>()))
105  {
107  << PROJECT_NAME << " error: unknown command: " << vm["command"].as<std::string>() << "\n\n"
108  << options;
109  return false;
110  }
111  }
112  else
113  {
114  LOG(MiscCommon::log_stderr) << PROJECT_NAME << ": Nothing to do\n\n" << options;
115  return false;
116  }
117 
118  _options->m_Command = SOptions::getCommandByName(vm["command"].as<std::string>());
119 
120  return true;
121  }
122  }
123 }
124 #endif
Definition: def.h:156
void PrintVersion()
Definition: dds-agent/src/Options.h:53
Definition: def.h:154
SOptions()
Definition: dds-agent/src/Options.h:35
#define LOG(severity)
Definition: Logger.h:54
struct dds::agent_cmd::SOptions SOptions_t
dds-commander&#39;s container of options
const LPCSTR g_cszReportBugsAddr("Report bugs/comments to fairroot@gsi.de")
Definition: dds-agent/src/AgentConnectionManager.h:18
dds-commander&#39;s container of options
Definition: dds-agent/src/Options.h:27
bool ParseCmdLine(int _argc, char *_argv[], SOptions *_options)
Definition: dds-agent/src/Options.h:62
Definition: dds-agent/src/Options.h:31
static ECommands getCommandByName(const std::string &_name)
Definition: dds-agent/src/Options.h:40
Definition: dds-agent/src/Options.h:33
ECommands m_Command
Definition: dds-agent/src/Options.h:50
Definition: dds-agent/src/Options.h:32
ECommands
Definition: dds-agent/src/Options.h:29