tclap 1.2.1

- Main Page
- Namespaces
- Classes
- Files

- File List
- File Members

HelpVisitor.h
Go to the documentation of this file.
1
2 /******************************************************************************
3 *
4 * file: HelpVisitor.h
5 *
6 * Copyright (c) 2003, Michael E. Smoot .
7 * All rights reverved.
8 *
9 * See the file COPYING in the top directory of this distribution for
10 * more information.
11 *
12 * THE SOFTWARE IS PROVIDED _AS IS_, WITHOUT WARRANTY OF ANY KIND, EXPRESS
13 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
14 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
15 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
16 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
17 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
18 * DEALINGS IN THE SOFTWARE.
19 *
20 *****************************************************************************/
21
22 #ifndef TCLAP_HELP_VISITOR_H
23 #define TCLAP_HELP_VISITOR_H
24
25 #include <tclap/CmdLineInterface.h>
26 #include <tclap/CmdLineOutput.h>
27 #include <tclap/Visitor.h>
28
29 namespace TCLAP {
30
35 class HelpVisitor: public Visitor
36 {
37 private:
41 HelpVisitor(const HelpVisitor& rhs);
42 HelpVisitor& operator=(const HelpVisitor& rhs);
43
44 protected:
45
49 CmdLineInterface* _cmd;
50
54 CmdLineOutput** _out;
55
56 public:
57
63 HelpVisitor(CmdLineInterface* cmd, CmdLineOutput** out)
64 : Visitor(), _cmd( cmd ), _out( out ) { }
65
70 void visit() { (*_out)->usage(*_cmd); throw ExitException(0); }
71
72 };
73
74 }
75
76 #endif
TCLAP::HelpVisitor::_out
CmdLineOutput ** _out
The output object.
Definition: HelpVisitor.h:54
CmdLineOutput.h
TCLAP::ExitException
Definition: ArgException.h:187
CmdLineInterface.h
TCLAP::HelpVisitor::visit
void visit()
Calls the usage method of the CmdLineOutput for the specified CmdLine.
Definition: HelpVisitor.h:70
TCLAP::HelpVisitor::_cmd
CmdLineInterface * _cmd
The CmdLine the output will be generated for.
Definition: HelpVisitor.h:49
TCLAP::Visitor
A base class that defines the interface for visitors.
Definition: Visitor.h:31
TCLAP::CmdLineInterface
The base class that manages the command line definition and passes along the parsing to the appropria...
Definition: CmdLineInterface.h:43
TCLAP::HelpVisitor
A Visitor object that calls the usage method of the given CmdLineOutput object for the specified CmdL...
Definition: HelpVisitor.h:35
TCLAP::HelpVisitor::HelpVisitor
HelpVisitor(CmdLineInterface *cmd, CmdLineOutput **out)
Constructor.
Definition: HelpVisitor.h:63
Visitor.h
TCLAP
Definition: Arg.h:57
TCLAP::CmdLineOutput
The interface that any output object must implement.
Definition: CmdLineOutput.h:41