llcommandlineparser.h
上传用户:king477883
上传日期:2021-03-01
资源大小:9553k
文件大小:5k
源码类别:

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2.  * @file llcommandlineparser.h
  3.  * @brief LLCommandLineParser class declaration
  4.  *
  5.  * $LicenseInfo:firstyear=2007&license=viewergpl$
  6.  * 
  7.  * Copyright (c) 2007-2010, Linden Research, Inc.
  8.  * 
  9.  * Second Life Viewer Source Code
  10.  * The source code in this file ("Source Code") is provided by Linden Lab
  11.  * to you under the terms of the GNU General Public License, version 2.0
  12.  * ("GPL"), unless you have obtained a separate licensing agreement
  13.  * ("Other License"), formally executed by you and Linden Lab.  Terms of
  14.  * the GPL can be found in doc/GPL-license.txt in this distribution, or
  15.  * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
  16.  * 
  17.  * There are special exceptions to the terms and conditions of the GPL as
  18.  * it is applied to this Source Code. View the full text of the exception
  19.  * in the file doc/FLOSS-exception.txt in this software distribution, or
  20.  * online at
  21.  * http://secondlifegrid.net/programs/open_source/licensing/flossexception
  22.  * 
  23.  * By copying, modifying or distributing this software, you acknowledge
  24.  * that you have read and understood your obligations described above,
  25.  * and agree to abide by those obligations.
  26.  * 
  27.  * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
  28.  * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
  29.  * COMPLETENESS OR PERFORMANCE.
  30.  * $/LicenseInfo$
  31.  */
  32. #ifndef LL_LLCOMMANDLINEPARSER_H
  33. #define LL_LLCOMMANDLINEPARSER_H
  34. #include <boost/function/function1.hpp>
  35. // *NOTE:Mani The following is a forward decl of 
  36. // boost::program_options::command_line_parser
  37. // "yay" c++!
  38. namespace boost
  39. {
  40. namespace program_options
  41. {
  42. template <class charT> class basic_command_line_parser;
  43. typedef basic_command_line_parser<char> command_line_parser;
  44. }
  45. }
  46. /** 
  47.  * @class LLCommandLineParser
  48.  * @brief Handle defining and parsing the command line.
  49.  */
  50. class LLCommandLineParser
  51. {
  52. public:
  53. typedef std::vector< std::string > token_vector_t;
  54. /**
  55.  * @brief Add a value-less option to the command line description.
  56.  * @param option_name The long name of the cmd-line option. 
  57.  * @param description The text description of the option usage.
  58.  */
  59. void addOptionDesc(
  60.    const std::string& option_name, 
  61.    boost::function1<void, const token_vector_t&> notify_callback = 0,
  62.    unsigned int num_tokens = 0,
  63.    const std::string& description = LLStringUtil::null,
  64.    const std::string& short_name = LLStringUtil::null,
  65.    bool composing = false,
  66.    bool positional = false,
  67.    bool last_option = false);
  68. /** 
  69.  * @brief Parse the command line given by argc/argv.
  70.  */
  71. bool parseCommandLine(int argc, char **argv);
  72. /** 
  73.  * @brief Parse the command line contained by the given file.
  74.  */
  75. bool parseCommandLineString(const std::string& str);
  76. /** 
  77.  * @brief Parse the command line contained by the given file.
  78.  */
  79. bool parseCommandLineFile(const std::basic_istream< char >& file);
  80. /** 
  81.  * @brief Call callbacks associated with option descriptions.
  82.  * 
  83.  * Use this to handle the results of parsing. 
  84.  */
  85. void notify();
  86. /** @brief Print a description of the configured options.
  87.  *
  88.  * Use this to print a description of options to the
  89.  * given ostream. Useful for displaying usage info.
  90.  */
  91. std::ostream& printOptionsDesc(std::ostream& os) const;
  92. /** @brief Manual option setting accessors.
  93.  * 
  94.  * Use these to retrieve get the values set for an option.
  95.  * getOption will return an empty value if the option isn't
  96.  * set. 
  97.  */
  98. bool hasOption(const std::string& name) const;
  99. const token_vector_t& getOption(const std::string& name) const;
  100. /** @brief Print the list of configured options.
  101.  */
  102. void printOptions() const;
  103. /** @bried Get the error message, if it exists.
  104.  */
  105. const std::string& getErrorMessage() const { return mErrorMsg; }
  106. /** @brief Add a custom parser func to the parser.
  107.  *  
  108.  * Use this method to add a custom parser for parsing values
  109.  * the the simple parser may not handle.
  110.  * it will be applied to each parameter before the
  111.  * default parser gets a chance.
  112.  * The parser_func takes an input string, and should return a
  113.  * name/value pair as the result.
  114.  */
  115. typedef boost::function1<std::pair<std::string, std::string>, const std::string&> parser_func;
  116. void setCustomParser(parser_func f) { mExtraParser = f; }
  117. private:
  118. bool parseAndStoreResults(boost::program_options::command_line_parser& clp);
  119. std::string mErrorMsg;
  120. parser_func mExtraParser;
  121. };
  122. inline std::ostream& operator<<(std::ostream& out, const LLCommandLineParser& clp)
  123. {
  124.     return clp.printOptionsDesc(out);
  125. }
  126. class LLControlGroup; 
  127. /** 
  128.  * @class LLControlGroupCLP
  129.  * @brief Uses the CLP to configure an LLControlGroup
  130.  *
  131.  * 
  132.  */
  133. class LLControlGroupCLP : public LLCommandLineParser
  134. {
  135. public:
  136. /**
  137.  * @brief Configure the command line parser according the given config file.
  138.  *
  139.  * @param config_filename The name of the XML based LLSD config file. 
  140.  * @param clp A reference to the command line parser object to configure.
  141.  *
  142.  * *FIX:Mani Specify config file format.
  143.  */
  144. void configure(const std::string& config_filename, 
  145.    LLControlGroup* controlGroup);
  146. };
  147. #endif // LL_LLCOMMANDLINEPARSER_H