src/include/common/client/OptionParser.h

00001 /*
00002  * Funambol is a mobile platform developed by Funambol, Inc. 
00003  * Copyright (C) 2008 Funambol, Inc.
00004  * 
00005  * This program is free software; you can redistribute it and/or modify it under
00006  * the terms of the GNU Affero General Public License version 3 as published by
00007  * the Free Software Foundation with the addition of the following permission 
00008  * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
00009  * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE 
00010  * WARRANTY OF NON INFRINGEMENT  OF THIRD PARTY RIGHTS.
00011  * 
00012  * This program is distributed in the hope that it will be useful, but WITHOUT
00013  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00014  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
00015  * details.
00016  * 
00017  * You should have received a copy of the GNU Affero General Public License 
00018  * along with this program; if not, see http://www.gnu.org/licenses or write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
00020  * MA 02110-1301 USA.
00021  * 
00022  * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite 
00023  * 305, Redwood City, CA 94063, USA, or at email address info@funambol.com.
00024  * 
00025  * The interactive user interfaces in modified source and object code versions
00026  * of this program must display Appropriate Legal Notices, as required under
00027  * Section 5 of the GNU Affero General Public License version 3.
00028  * 
00029  * In accordance with Section 7(b) of the GNU Affero General Public License
00030  * version 3, these Appropriate Legal Notices must retain the display of the
00031  * "Powered by Funambol" logo. If the display of the logo is not reasonably 
00032  * feasible for technical reasons, the Appropriate Legal Notices must display
00033  * the words "Powered by Funambol".
00034  */
00035 
00036 #ifndef INCL_OPTION_PARSE
00037 #define INCL_OPTION_PARSE
00038 
00039 #include "base/fscapi.h"
00040 #include "base/util/StringBuffer.h"
00041 #include "base/util/ArrayList.h"
00042 #include "base/util/StringMap.h"
00043 
00044 BEGIN_NAMESPACE
00045 
00049 class OptionParser {
00050 
00051     private:
00052         
00054         StringBuffer programName;
00055 
00059         ArrayList options;
00060 
00066         ArrayList arguments;
00067 
00069         StringBuffer errMsg;
00070 
00071     public:
00072 
00077         OptionParser(const char* progname); 
00078 
00089         bool addOption(char sn, const char *ln, const char *hm, bool hasArg=false);
00090 
00098         bool removeOption(const char *ln);
00099 
00106         int findOption(const char *ln, bool shortName=false) const;
00107 
00118         int addArgument(const char *name, const char *help, bool mandatory=true);
00119 
00123         void clearArguments();
00124 
00135         bool parse(int argc, const char** argv, StringMap& opts, ArrayList& args);
00136 
00140         void usage();
00141 
00143         const StringBuffer& getErrMsg() const { return errMsg; }
00144 
00145         const StringBuffer& getProgramName() const { return programName; };
00146 
00147 };
00148 
00149 END_NAMESPACE
00150 
00151 #endif

Generated on Wed Jan 14 17:15:36 2009 for Funambol C++ Client Library by  doxygen 1.5.2