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