source: trunk/yat/utility/OptionHelp.h @ 1707

Last change on this file since 1707 was 1487, checked in by Jari Häkkinen, 13 years ago

Addresses #436. GPL license copy reference should also be updated.

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