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

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2. * @file llservicebuilder.h
  3. * @brief Declaration of the LLServiceBuilder class.
  4. *
  5. * $LicenseInfo:firstyear=2007&license=viewergpl$
  6. * Copyright (c) 2007-2010, Linden Research, Inc.
  7. * Second Life Viewer Source Code
  8. * The source code in this file ("Source Code") is provided by Linden Lab
  9. * to you under the terms of the GNU General Public License, version 2.0
  10. * ("GPL"), unless you have obtained a separate licensing agreement
  11. * ("Other License"), formally executed by you and Linden Lab.  Terms of
  12. * the GPL can be found in doc/GPL-license.txt in this distribution, or
  13. * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
  14. * There are special exceptions to the terms and conditions of the GPL as
  15. * it is applied to this Source Code. View the full text of the exception
  16. * in the file doc/FLOSS-exception.txt in this software distribution, or
  17. * online at
  18. * http://secondlifegrid.net/programs/open_source/licensing/flossexception
  19. * By copying, modifying or distributing this software, you acknowledge
  20. * that you have read and understood your obligations described above,
  21. * and agree to abide by those obligations.
  22. * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
  23. * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
  24. * COMPLETENESS OR PERFORMANCE.
  25. * $/LicenseInfo$
  26. */
  27. #ifndef LLSERVICEBUILDER_H
  28. #define LLSERVICEBUILDER_H
  29. #include <string>
  30. #include <map>
  31. #include "llerror.h"
  32. class LLSD;
  33. /**
  34.  * @brief  Format format string according to rules for RUSS.
  35.  *
  36.  * This function appears alongside the service builder since the
  37.  * algorithm was originally implemented there. This can eventually be
  38.  * moved when someone wants to take the time.
  39.  * @see https://osiris.lindenlab.com/mediawiki/index.php/Recursive_URL_Substitution_Syntax
  40.  * @param format_str The input string to format.
  41.  * @param context A map used for string substitutions.
  42.  * @return Returns the formatted string. If no match is found for a
  43.  * substitution target, the braces remain intact.
  44.  */
  45. std::string russ_format(const std::string& format_str, const LLSD& context);
  46. /** 
  47.  * @class LLServiceBuilder
  48.  * @brief This class builds urls for us to use when making web service calls.
  49.  */
  50. class LLServiceBuilder
  51. {
  52. LOG_CLASS(LLServiceBuilder);
  53. public:
  54. LLServiceBuilder(void) {}
  55. ~LLServiceBuilder(void) {}
  56. /** 
  57.  * @brief Initialize this object with the service definitions.
  58.  *
  59.  * @param service_filename The services definition files -- services.xml.
  60.  */
  61. void loadServiceDefinitionsFromFile(const std::string& service_filename);
  62. /** 
  63.  * @brief Build a service url if the url needs no construction parameters.
  64.  *
  65.  * @param service_name The name of the service you want to call.
  66.  */
  67. std::string buildServiceURI(const std::string& service_name) const;
  68. /** 
  69.  * @brief Build a service url if the url with construction parameters.
  70.  *
  71.  * The parameter substitution supports string substituition from RUSS:
  72.  * [[Recursive_URL_Substitution_Syntax]]
  73.  * @param service_name The name of the service you want to call.
  74.  * @param option_map The parameters in a map of name:value for the service.
  75.  */
  76. std::string buildServiceURI(
  77. const std::string& service_name,
  78. const LLSD& option_map) const;
  79. public:
  80. /** 
  81.  * @brief Helper method which builds construction state for a service
  82.  *
  83.  * This method should probably be protected, but we need to test this
  84.  * method.
  85.  */
  86. void createServiceDefinition(
  87. const std::string& service_name,
  88. LLSD& service_url);
  89. protected:
  90. std::map<std::string, std::string> mServiceMap;
  91. };
  92. #endif