paludis  Version 2.6.0
args_dumper.hh
Go to the documentation of this file.
1 /* vim: set sw=4 sts=4 et foldmethod=syntax : */
2 
3 /*
4  * Copyright (c) 2006 Stephen Bennett
5  *
6  * This file is part of the Paludis package manager. Paludis is free software;
7  * you can redistribute it and/or modify it under the terms of the GNU General
8  * Public License, version 2, as published by the Free Software Foundation.
9  *
10  * Paludis is distributed in the hope that it will be useful, but WITHOUT ANY
11  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
13  * details.
14  *
15  * You should have received a copy of the GNU General Public License along with
16  * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
17  * Place, Suite 330, Boston, MA 02111-1307 USA
18  */
19 
20 #ifndef PALUDIS_GUARD_PALUDIS_ARGS_ARGS_DUMPER_HH
21 #define PALUDIS_GUARD_PALUDIS_ARGS_ARGS_DUMPER_HH 1
22 
23 #include <iosfwd>
25 
26 /** \file
27  * Declarations for the ArgsDumper class.
28  *
29  * \ingroup g_args
30  *
31  * \section Examples
32  *
33  * - None at this time.
34  */
35 
36 namespace paludis
37 {
38  namespace args
39  {
40  class ArgsOption;
41  class SwitchArg;
42  class StringArg;
43  class IntegerArg;
44  class AliasArg;
45  class EnumArg;
46 
47  /**
48  * Prints help text appropriate to each command line option.
49  *
50  * \ingroup g_args
51  */
53  {
54  private:
55  std::ostream & _os;
56 
57  void generic_visit(const ArgsOption &);
58 
59  public:
60  /**
61  * Constructor.
62  */
63  ArgsDumper(std::ostream & os);
64 
65  /// Visit a SwitchArg.
66  void visit(const SwitchArg &);
67 
68  /// Visit a StringArg.
69  void visit(const StringArg &);
70 
71  /// Visit an IntegerArg.
72  void visit(const IntegerArg &);
73 
74  /// Visit an AliasArg.
75  void visit(const AliasArg &);
76 
77  /// Visit an EnumArg.
78  void visit(const EnumArg &);
79 
80  /// Visit a StringSetArg.
81  void visit(const StringSetArg &);
82 
83  /// Visit a StringSequenceArg.
84  void visit(const StringSequenceArg &);
85  };
86  }
87 }
88 
89 #endif
Definition: args_option.hh:436
Definition: about_metadata-fwd.hh:23
Definition: args_dumper.hh:52
Definition: args_option.hh:544
Definition: args_option.hh:494
Definition: args_option.hh:204
Definition: args_option.hh:233
Definition: args_option.hh:74
Definition: args_option.hh:389
#define PALUDIS_VISIBLE
Definition: attributes.hh:59
Definition: args_option.hh:280