args_dumper.hh

Go to the documentation of this file.
00001 /* vim: set sw=4 sts=4 et foldmethod=syntax : */
00002 
00003 /*
00004  * Copyright (c) 2006 Stephen Bennett
00005  *
00006  * This file is part of the Paludis package manager. Paludis is free software;
00007  * you can redistribute it and/or modify it under the terms of the GNU General
00008  * Public License, version 2, as published by the Free Software Foundation.
00009  *
00010  * Paludis is distributed in the hope that it will be useful, but WITHOUT ANY
00011  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00012  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
00013  * details.
00014  *
00015  * You should have received a copy of the GNU General Public License along with
00016  * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
00017  * Place, Suite 330, Boston, MA  02111-1307  USA
00018  */
00019 
00020 #ifndef PALUDIS_GUARD_PALUDIS_ARGS_ARGS_DUMPER_HH
00021 #define PALUDIS_GUARD_PALUDIS_ARGS_ARGS_DUMPER_HH 1
00022 
00023 #include <iosfwd>
00024 #include <paludis/args/args_visitor.hh>
00025 
00026 /** \file
00027  * Declarations for the ArgsDumper class.
00028  *
00029  * \ingroup g_args
00030  *
00031  * \section Examples
00032  *
00033  * - None at this time.
00034  */
00035 
00036 namespace paludis
00037 {
00038     namespace args
00039     {
00040         class ArgsOption;
00041         class SwitchArg;
00042         class StringArg;
00043         class IntegerArg;
00044         class AliasArg;
00045         class EnumArg;
00046 
00047         /**
00048          * Prints help text appropriate to each command line option.
00049          *
00050          * \ingroup g_args
00051          */
00052         class PALUDIS_VISIBLE ArgsDumper
00053         {
00054             private:
00055                 std::ostream & _os;
00056 
00057                 void generic_visit(const ArgsOption &);
00058 
00059             public:
00060                 /**
00061                  * Constructor.
00062                  */
00063                 ArgsDumper(std::ostream & os);
00064 
00065                 /// Visit a SwitchArg.
00066                 void visit(const SwitchArg &);
00067 
00068                 /// Visit a StringArg.
00069                 void visit(const StringArg &);
00070 
00071                 /// Visit an IntegerArg.
00072                 void visit(const IntegerArg &);
00073 
00074                 /// Visit an AliasArg.
00075                 void visit(const AliasArg &);
00076 
00077                 /// Visit an EnumArg.
00078                 void visit(const EnumArg &);
00079 
00080                 /// Visit a StringSetArg.
00081                 void visit(const StringSetArg &);
00082 
00083                 /// Visit a StringSequenceArg.
00084                 void visit(const StringSequenceArg &);
00085         };
00086     }
00087 }
00088 
00089 #endif

Generated on Mon Sep 21 10:36:07 2009 for paludis by  doxygen 1.5.4