1 | #ifndef _theplu_yat_utility_option_help_ |
---|
2 | #define _theplu_yat_utility_option_help_ |
---|
3 | |
---|
4 | // $Id: OptionHelp.h 981 2007-10-22 04:18:40Z peter $ |
---|
5 | |
---|
6 | /* |
---|
7 | Copyright (C) 2007 Peter Johansson |
---|
8 | |
---|
9 | This file is part of the yat library, http://trac.thep.lu.se/trac/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 2 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 this program; if not, write to the Free Software |
---|
23 | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA |
---|
24 | 02111-1307, USA. |
---|
25 | */ |
---|
26 | |
---|
27 | #include "OptionSwitch.h" |
---|
28 | |
---|
29 | #include <string> |
---|
30 | |
---|
31 | namespace theplu { |
---|
32 | namespace yat { |
---|
33 | namespace utility { |
---|
34 | |
---|
35 | class CommandLine; |
---|
36 | /** |
---|
37 | \brief Class for help option |
---|
38 | |
---|
39 | When this option is found in parsing of commandline, it displays |
---|
40 | a help output exits. |
---|
41 | */ |
---|
42 | class OptionHelp : public OptionSwitch |
---|
43 | { |
---|
44 | public: |
---|
45 | /** |
---|
46 | \brief Constructor |
---|
47 | |
---|
48 | \param cmd Commandline Option is associated with |
---|
49 | \param name string such as "help" for --help, "h" for -h or |
---|
50 | "h,help" (default) for having both short and long option name |
---|
51 | \param desc string used in help display |
---|
52 | \param def default value for switch |
---|
53 | */ |
---|
54 | OptionHelp(CommandLine& cmd, std::string name="h,help", |
---|
55 | std::string desc="display this help and exit"); |
---|
56 | |
---|
57 | /** |
---|
58 | Text to be displayed after list of arguments. |
---|
59 | */ |
---|
60 | std::string& post_arguments(void); |
---|
61 | |
---|
62 | /** |
---|
63 | Text to be displayed in help output after usage() |
---|
64 | */ |
---|
65 | std::string& synopsis(void); |
---|
66 | |
---|
67 | /** |
---|
68 | First line to be displayed in help output. Default this string |
---|
69 | is set to "Usage: <program_name> [OPTION]...\n\n" |
---|
70 | */ |
---|
71 | std::string& usage(void); |
---|
72 | |
---|
73 | private: |
---|
74 | std::string usage_; |
---|
75 | std::string synopsis_; |
---|
76 | std::string post_cmd_; |
---|
77 | |
---|
78 | /** |
---|
79 | */ |
---|
80 | void do_parse2(std::vector<std::string>::iterator, |
---|
81 | std::vector<std::string>::iterator); |
---|
82 | |
---|
83 | }; |
---|
84 | |
---|
85 | }}} // of namespace utility, yat, and theplu |
---|
86 | |
---|
87 | #endif |
---|