source: trunk/lib/OptionHelp.h @ 745

Last change on this file since 745 was 705, checked in by Peter Johansson, 13 years ago

importing classes for commandline parsing from yat. This fixes #349 and #265

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 2.1 KB
Line 
1#ifndef _theplu_svndigest_option_help_
2#define _theplu_svndigest_option_help_
3
4// $Id: OptionHelp.h 705 2008-11-25 23:33:26Z peter $
5
6/*
7  Copyright (C) 2008 Peter Johansson
8
9  This file is part of svndigest, http://trac.thep.lu.se/svndigest
10
11  svndigest is free software; you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation; either version 2 of the License, or
14  (at your option) any later version.
15
16  svndigest is distributed in the hope that it will be useful, but
17  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
31namespace theplu {
32namespace svndigest {
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 exits.
40   */
41  class OptionHelp : public OptionSwitch
42  {
43  public:
44    /**
45       \brief Constructor
46       
47       \param cmd Commandline Option is associated with
48       \param name string such as "help" for --help, "h" for -h or
49       "h,help" (default) for having both short and long option name
50       \param desc string used in help display
51    */
52    OptionHelp(CommandLine& cmd, std::string name="h,help", 
53               std::string desc="display this help and exit"); 
54
55    /**
56       Text to be displayed after list of arguments.
57     */
58    std::string& post_arguments(void);
59
60    /**
61       Text to be displayed in help output after usage()
62    */
63    std::string& synopsis(void);
64
65    /**
66       First line to be displayed in help output. Default this string
67       is set to "Usage: <program_name> [OPTION]...\n\n"
68     */
69    std::string& usage(void);
70
71  private:
72    std::string usage_;
73    std::string synopsis_;
74    std::string post_cmd_;
75
76    /**
77     */
78    void do_parse2(std::vector<std::string>::iterator, 
79                   std::vector<std::string>::iterator);
80
81  };
82
83}} // of namespace svndigest and theplu
84
85#endif
Note: See TracBrowser for help on using the repository browser.