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

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2.  * @file llurlregistry.h
  3.  * @author Martin Reddy
  4.  * @brief Contains a set of Url types that can be matched in a string
  5.  *
  6.  * $LicenseInfo:firstyear=2009&license=viewergpl$
  7.  * 
  8.  * Copyright (c) 2009-2010, Linden Research, Inc.
  9.  * 
  10.  * Second Life Viewer Source Code
  11.  * The source code in this file ("Source Code") is provided by Linden Lab
  12.  * to you under the terms of the GNU General Public License, version 2.0
  13.  * ("GPL"), unless you have obtained a separate licensing agreement
  14.  * ("Other License"), formally executed by you and Linden Lab.  Terms of
  15.  * the GPL can be found in doc/GPL-license.txt in this distribution, or
  16.  * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
  17.  * 
  18.  * There are special exceptions to the terms and conditions of the GPL as
  19.  * it is applied to this Source Code. View the full text of the exception
  20.  * in the file doc/FLOSS-exception.txt in this software distribution, or
  21.  * online at
  22.  * http://secondlifegrid.net/programs/open_source/licensing/flossexception
  23.  * 
  24.  * By copying, modifying or distributing this software, you acknowledge
  25.  * that you have read and understood your obligations described above,
  26.  * and agree to abide by those obligations.
  27.  * 
  28.  * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
  29.  * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
  30.  * COMPLETENESS OR PERFORMANCE.
  31.  * $/LicenseInfo$
  32.  */
  33. #ifndef LL_LLURLREGISTRY_H
  34. #define LL_LLURLREGISTRY_H
  35. #include "llurlentry.h"
  36. #include "llurlmatch.h"
  37. #include "llsingleton.h"
  38. #include "llstring.h"
  39. #include <string>
  40. #include <vector>
  41. /// This default callback for findUrl() simply ignores any label updates
  42. void LLUrlRegistryNullCallback(const std::string &url, const std::string &label);
  43. ///
  44. /// LLUrlRegistry is a singleton that contains a set of Url types that
  45. /// can be matched in string. E.g., http:// or secondlife:// Urls.
  46. ///
  47. /// Clients call the findUrl() method on a string to locate the first
  48. /// occurence of a supported Urls in that string. If findUrl() returns
  49. /// true, the LLUrlMatch object will be updated to describe the Url
  50. /// that was matched, including a label that can be used to hyperlink
  51. /// the Url, an icon to display next to the Url, and a XUI menu that
  52. /// can be used as a popup context menu for that Url.
  53. ///
  54. /// New Url types can be added to the registry with the registerUrl
  55. /// method. E.g., to add support for a new secondlife:///app/ Url.
  56. ///
  57. /// Computing the label for a Url could involve a roundtrip request
  58. /// to the server (e.g., to find the actual agent or group name).
  59. /// As such, you can provide a callback method that will get invoked
  60. /// when a new label is available for one of your matched Urls.
  61. ///
  62. class LLUrlRegistry : public LLSingleton<LLUrlRegistry>
  63. {
  64. public:
  65. ~LLUrlRegistry();
  66. /// add a new Url handler to the registry (will be freed on destruction)
  67. void registerUrl(LLUrlEntryBase *url);
  68. /// get the next Url in an input string, starting at a given character offset
  69. /// your callback is invoked if the matched Url's label changes in the future
  70. bool findUrl(const std::string &text, LLUrlMatch &match,
  71.  const LLUrlLabelCallback &cb = &LLUrlRegistryNullCallback);
  72. /// a slightly less efficient version of findUrl for wide strings
  73. bool findUrl(const LLWString &text, LLUrlMatch &match,
  74.  const LLUrlLabelCallback &cb = &LLUrlRegistryNullCallback);
  75. // return true if the given string contains a URL that findUrl would match
  76. bool hasUrl(const std::string &text);
  77. bool hasUrl(const LLWString &text);
  78. // return true if the given string is a URL that findUrl would match
  79. bool isUrl(const std::string &text);
  80. bool isUrl(const LLWString &text);
  81. private:
  82. LLUrlRegistry();
  83. friend class LLSingleton<LLUrlRegistry>;
  84. std::vector<LLUrlEntryBase *> mUrlEntry;
  85. };
  86. #endif