cli4cpp - A command-line parser library for C++

00001 /*
00002  * Copyright (c) 2005 John H. Poplett. All rights reserved.
00003  * 
00004  * This software is provided 'as-is', without any express or implied
00005  * warranty. In no event will the authors be held liable for any damages
00006  * arising from the use of this software.
00007  * 
00008  * Permission is granted to anyone to use this software for any purpose,
00009  * including commercial applications, and to alter it and redistribute it
00010  * freely, subject to the following restrictions:
00011  * 
00012  *     1. The origin of this software must not be misrepresented; you must
00013  *     not claim that you wrote the original software. If you use this
00014  *     software in a product, an acknowledgment in the product documentation
00015  *     would be appreciated but is not required.
00016  * 
00017  *     2. Altered source versions must be plainly marked as such, and must
00018  *     not be misrepresented as being the original software.
00019  * 
00020  *     3. This notice may not be removed or altered from any source
00021  *     distribution.
00022  */
00023 #ifndef _help_formatter_h_included
00024 #define  _help_formatter_h_included
00025 
00026 #include "Options.h"
00027 
00028 namespace CLI {
00029 
00036 class HelpFormatter {
00037     public:
00038         HelpFormatter();
00039         HelpFormatter(const HelpFormatter&);
00040         HelpFormatter& operator=(const HelpFormatter&);
00041         ~HelpFormatter();
00042         void printHelp(const char* const banner, const Options& opt);
00043     private:
00044         class Implementation;
00045         Implementation* impl_;
00046 };
00047 
00048 } 
00049 
00050 #endif // #ifndef _help_formatter_h_included
HelpFormatter.h
