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

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

Updating copyright statements.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 2.2 KB
Line 
1#ifndef _theplu_yat_utility_option_help_
2#define _theplu_yat_utility_option_help_
3
4// $Id: OptionHelp.h 1275 2008-04-11 06:10:12Z 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://trac.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 2 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 this program; if not, write to the Free Software
24  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
25  02111-1307, USA.
26*/
27
28#include "OptionSwitch.h"
29
30#include <string>
31
32namespace theplu {
33namespace yat {
34namespace utility {
35
36  class CommandLine;
37  /**
38     \brief Class for help option
39
40     When this option is found in parsing of commandline, it displays
41     a help output exits.
42   */
43  class OptionHelp : public OptionSwitch
44  {
45  public:
46    /**
47       \brief Constructor
48       
49       \param cmd Commandline Option is associated with
50       \param name string such as "help" for --help, "h" for -h or
51       "h,help" (default) for having both short and long option name
52       \param desc string used in help display
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
Note: See TracBrowser for help on using the repository browser.