DDS  ver. 3.4
dds-commander/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 // BOOST
9 #include <boost/program_options/options_description.hpp>
10 #include <boost/program_options/parsers.hpp>
11 // DDS
12 #include "ProtocolCommands.h"
13 #include "Res.h"
14 #include "SubmitCmd.h"
15 #include "version.h"
16 //=============================================================================
17 namespace bpo = boost::program_options;
18 //=============================================================================
19 namespace dds
20 {
21  namespace commander_cmd
22  {
24  typedef struct SOptions
25  {
26  enum ECommands
27  {
32  };
35  , m_sid(boost::uuids::nil_uuid())
36  {
37  }
38 
39  static ECommands getCommandByName(const std::string& _name)
40  {
41  if ("start" == _name)
42  return cmd_start;
43  if ("stop" == _name)
44  return cmd_stop;
45  if ("prep-session" == _name)
46  return cmd_prep_session;
47 
48  return cmd_unknown;
49  }
50 
52  std::string m_sTopoFile;
53  std::string m_sRMS;
54  std::string m_sCfgFile;
55  boost::uuids::uuid m_sid;
56  } SOptions_t;
57  //=============================================================================
58  inline void PrintVersion()
59  {
60  LOG(MiscCommon::log_stdout) << " v" << PROJECT_VERSION_STRING << "\n"
61  << "DDS configuration"
62  << " v" << USER_DEFAULTS_CFG_VERSION << "\n"
64  }
65  //=============================================================================
66  // Command line parser
67  inline bool ParseCmdLine(int _argc, char* _argv[], SOptions* _options)
68  {
69  if (nullptr == _options)
70  throw std::runtime_error("Internal error: options' container is empty.");
71 
72  // Generic options
73  bpo::options_description options("dds-commander options");
74  options.add_options()("help,h", "Produce help message");
75  options.add_options()("version,v", "Version information");
76  options.add_options()(
77  "command",
78  bpo::value<std::string>(),
79  "The command is a name of a dds-commander command."
80  " Can be one of the following: start, stop, and prep-session.\n"
81  "For user's convenience it is allowed to call dds-commander without \"--command\" option"
82  " by just specifying the command name directly, like:\ndds-commander start or dds-commander stop.\n\n"
83  "Commands:\n"
84  " start: \tStart dds-commander daemon\n"
85  " stop: \tStop dds-commander daemon\n"
86  " prep-session: \tPrepares a DDS session and returns new session ID\n");
87  options.add_options()("session,s", bpo::value<std::string>(), "DDS Session ID");
88 
89  //...positional
90  bpo::positional_options_description pd;
91  pd.add("command", 1);
92 
93  // Parsing command-line
94  bpo::variables_map vm;
95  bpo::store(bpo::command_line_parser(_argc, _argv).options(options).positional(pd).run(), vm);
96  bpo::notify(vm);
97 
98  if (vm.count("help") || vm.empty())
99  {
100  LOG(MiscCommon::log_stdout) << options;
101  return false;
102  }
103  if (vm.count("version"))
104  {
105  PrintVersion();
106  return false;
107  }
108 
109  // Command
110  if (vm.count("command"))
111  {
112  if (SOptions::cmd_unknown == SOptions::getCommandByName(vm["command"].as<std::string>()))
113  {
114  LOG(MiscCommon::log_stderr) << "unknown command: " << vm["command"].as<std::string>() << "\n\n"
115  << options;
116  return false;
117  }
118  }
119  else
120  {
121  LOG(MiscCommon::log_stderr) << "Nothing to do\n\n" << options;
122  return false;
123  }
124 
125  if (vm.count("session"))
126  {
127  _options->m_sid = boost::uuids::string_generator()(vm["session"].as<std::string>());
128  }
129 
130  _options->m_Command = SOptions::getCommandByName(vm["command"].as<std::string>());
131 
132  return true;
133  }
134  } // namespace commander_cmd
135 } // namespace dds
136 #endif
Definition: def.h:156
Definition: def.h:154
boost::uuids::uuid m_sid
Definition: dds-commander/src/Options.h:55
SOptions()
Definition: dds-commander/src/Options.h:33
ECommands
Definition: dds-commander/src/Options.h:26
bool ParseCmdLine(int _argc, char *_argv[], SOptions *_options)
Definition: dds-commander/src/Options.h:67
#define LOG(severity)
Definition: Logger.h:56
std::string m_sRMS
Definition: dds-commander/src/Options.h:53
std::string m_sTopoFile
Definition: dds-commander/src/Options.h:52
const LPCSTR g_cszReportBugsAddr("Report bugs/comments to fairroot@gsi.de")
struct dds::commander_cmd::SOptions SOptions_t
dds-commander's container of options
Definition: AgentConnectionManager.h:13
Definition: dds-commander/src/Options.h:30
dds-commander's container of options
Definition: dds-commander/src/Options.h:24
void PrintVersion()
Definition: dds-commander/src/Options.h:58
std::string m_sCfgFile
Definition: dds-commander/src/Options.h:54
ECommands m_Command
Definition: dds-commander/src/Options.h:51
static ECommands getCommandByName(const std::string &_name)
Definition: dds-commander/src/Options.h:39
Definition: dds-commander/src/Options.h:29
Definition: dds-commander/src/Options.h:31
Definition: dds-commander/src/Options.h:28