source: trunk/yat/utility/OptionSwitch.h @ 981

Last change on this file since 981 was 981, checked in by Peter, 14 years ago

adding convenient class for help option

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 2.0 KB
Line 
1#ifndef _theplu_yat_utility_option_switch_
2#define _theplu_yat_utility_option_switch_
3
4// $Id: OptionSwitch.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 "Option.h"
28
29#include <string>
30
31namespace theplu {
32namespace yat {
33namespace utility {
34
35  class CommandLine;
36  /**
37     \brief Class for switch option
38   */
39  class OptionSwitch : public Option
40  {
41  public:
42    /**
43       \brief Constructor
44       
45       \param cmd Commandline Option is associated with
46       \param name string such as "help" for --help, "h" for -h or
47       "h,help" for having both short and long option name
48       \param desc string used in help display
49       \param def default value for switch
50    */
51    OptionSwitch(CommandLine& cmd, std::string name, 
52                 std::string desc, bool def=false); 
53
54
55    /**
56       \brief return value
57     */
58    bool value(void) const;
59
60  private:
61    /**
62     */
63    void do_parse(std::vector<std::string>::iterator, 
64                  std::vector<std::string>::iterator);
65
66    /**
67       called inside do_parse and allows inherited classes to add
68       stuff to do_parse.
69     */
70    virtual void do_parse2(std::vector<std::string>::iterator, 
71                           std::vector<std::string>::iterator);
72
73    /**
74     */
75    std::string print2(void) const;
76
77    /**
78     */
79    void do_validate(void) const;
80
81  private:
82    bool def_;
83    bool switch_;
84  };
85
86}}} // of namespace utility, yat, and theplu
87
88#endif
Note: See TracBrowser for help on using the repository browser.