yat  0.21pre
OptionHelp.h
1 #ifndef _theplu_yat_utility_option_help_
2 #define _theplu_yat_utility_option_help_
3 
4 // $Id: OptionHelp.h 4207 2022-08-26 04:36:28Z peter $
5 
6 /*
7  Copyright (C) 2007, 2008 Jari Häkkinen, Peter Johansson
8  Copyright (C) 2022 Peter Johansson
9 
10  This file is part of the yat library, http://dev.thep.lu.se/yat
11 
12  The yat library is free software; you can redistribute it and/or
13  modify it under the terms of the GNU General Public License as
14  published by the Free Software Foundation; either version 3 of the
15  License, or (at your option) any later version.
16 
17  The yat library is distributed in the hope that it will be useful,
18  but WITHOUT ANY WARRANTY; without even the implied warranty of
19  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20  General Public License for more details.
21 
22  You should have received a copy of the GNU General Public License
23  along with yat. If not, see <http://www.gnu.org/licenses/>.
24 */
25 
26 #include "OptionSwitch.h"
27 
28 #include <string>
29 
30 namespace theplu {
31 namespace yat {
32 namespace utility {
33 
34  class CommandLine;
62  class OptionHelp : public OptionSwitch
63  {
64  public:
73  OptionHelp(CommandLine& cmd, std::string name="h,help",
74  std::string desc="display this help and exit");
75 
79  std::string& post_arguments(void);
80 
84  std::string& synopsis(void);
85 
90  std::string& usage(void);
91 
92  private:
93  std::string usage_;
94  std::string synopsis_;
95  std::string post_cmd_;
96 
99  void do_parse2(std::vector<std::string>::iterator,
100  std::vector<std::string>::iterator);
101 
102  };
103 
104 }}} // of namespace utility, yat, and theplu
105 
106 #endif
The Department of Theoretical Physics namespace as we define it.
Class for help option.
Definition: OptionHelp.h:62
Class for switch option.
Definition: OptionSwitch.h:38
std::string & synopsis(void)
std::string & post_arguments(void)
Class for parsing the command line.
Definition: CommandLine.h:98
OptionHelp(CommandLine &cmd, std::string name="h,help", std::string desc="display this help and exit")
Constructor.
const CommandLine & cmd(void) const

Generated on Wed Jan 25 2023 03:34:29 for yat by  doxygen 1.8.14