source: trunk/lib/yat/OptionHelp.h @ 1027

Last change on this file since 1027 was 983, checked in by Peter Johansson, 12 years ago

fetch yat files. refs #429

  • Property svn:eol-style set to native
File size: 2.8 KB
Line 
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
29namespace theplu {
30namespace yat {
31namespace utility {
32
33  class CommandLine;
34  /**
35     \brief Class for help option
36
37     When this option is found in parsing of commandline, it displays
38     a help output and exits. A typical output looks like:
39
40     \verbatim
41     Usage: foo [OPTION]...
42
43     SYNOPSIS
44
45     Available options are:
46     -h, --help      display this help and exit
47     -v, --verbose   explain what is being done
48
49     Some extra information explaining something.
50     \endverbatim
51
52     The output consist of four blocks. The first block can be
53     modified with usage(void) function. The second is block is
54     typically a one-liner explaining the application and can be
55     modified with the synopsis(void) function. The third block
56     contain the description of the different options, see
57     operator<<(std::ostream&, const CommandLine&) for further
58     details. The last block can be modified with post_arguments(void)
59     function.
60   */
61  class OptionHelp : public OptionSwitch
62  {
63  public:
64    /**
65       \brief Constructor
66       
67       \param cmd Commandline Option is associated with
68       \param name string such as "help" for --help, "h" for -h or
69       "h,help" (default) for having both short and long option name
70       \param desc string used in help display
71    */
72    OptionHelp(CommandLine& cmd, std::string name="h,help", 
73               std::string desc="display this help and exit"); 
74
75    /**
76       Text to be displayed after list of arguments.
77     */
78    std::string& post_arguments(void);
79
80    /**
81       Text to be displayed in help output after usage()
82    */
83    std::string& synopsis(void);
84
85    /**
86       First line to be displayed in help output. Default this string
87       is set to "Usage: <program_name> [OPTION]...\n\n"
88     */
89    std::string& usage(void);
90
91  private:
92    std::string usage_;
93    std::string synopsis_;
94    std::string post_cmd_;
95
96    /**
97     */
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
Note: See TracBrowser for help on using the repository browser.