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

游戏引擎

开发平台:

C++ Builder

  1. /**
  2.  * @file llfunctorregistry.h
  3.  * @author Kent Quirk
  4.  * @brief Maintains a registry of named callback functors taking a single LLSD parameter
  5.  *
  6.  * $LicenseInfo:firstyear=2008&license=viewergpl$
  7.  * 
  8.  * Copyright (c) 2008-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_LLFUNCTORREGISTRY_H
  34. #define LL_LLFUNCTORREGISTRY_H
  35. #include <string>
  36. #include <map>
  37. #include <boost/function.hpp>
  38. #include "llsd.h"
  39. #include "llsingleton.h"
  40. /**
  41.  * @class LLFunctorRegistry
  42.  * @brief Maintains a collection of named functors for remote binding
  43.  * (mainly for use in callbacks from notifications and other signals)
  44.  * @see LLNotifications
  45.  *
  46.  * This class maintains a collection of named functors in a singleton.
  47.  * We wanted to be able to persist notifications with their callbacks
  48.  * across restarts of the viewer; we couldn't store functors that way.
  49.  * Using this registry, systems that require a functor to be maintained
  50.  * long term can register it at system startup, and then pass in the
  51.  * functor by name. 
  52.  */
  53. template <typename FUNCTOR_TYPE>
  54. class LLFunctorRegistry : public LLSingleton<LLFunctorRegistry<FUNCTOR_TYPE> >
  55. {
  56. friend class LLSingleton<LLFunctorRegistry>;
  57. LOG_CLASS(LLFunctorRegistry);
  58. private:
  59. LLFunctorRegistry() : LOGFUNCTOR("LogFunctor"), DONOTHING("DoNothing")
  60. {
  61. mMap[LOGFUNCTOR] = log_functor;
  62. mMap[DONOTHING] = do_nothing;
  63. }
  64. public:
  65. typedef FUNCTOR_TYPE ResponseFunctor;
  66. typedef typename std::map<std::string, FUNCTOR_TYPE> FunctorMap;
  67. bool registerFunctor(const std::string& name, ResponseFunctor f)
  68. {
  69. bool retval = true;
  70. typename FunctorMap::iterator it = mMap.find(name);
  71. if (mMap.count(name) == 0)
  72. {
  73. mMap[name] = f;
  74. }
  75. else
  76. {
  77. llerrs << "attempt to store duplicate name '" << name << "' in LLFunctorRegistry. NOT ADDED." << llendl;
  78. retval = false;
  79. }
  80. return retval;
  81. }
  82. bool unregisterFunctor(const std::string& name)
  83. {
  84. if (mMap.count(name) == 0)
  85. {
  86. llwarns << "trying to remove '" << name << "' from LLFunctorRegistry but it's not there." << llendl;
  87. return false;
  88. }
  89. mMap.erase(name);
  90. return true;
  91. }
  92. FUNCTOR_TYPE getFunctor(const std::string& name)
  93. {
  94. typename FunctorMap::iterator it = mMap.find(name);
  95. if (mMap.count(name) != 0)
  96. {
  97. return mMap[name];
  98. }
  99. else
  100. {
  101. llwarns << "tried to find '" << name << "' in LLFunctorRegistry, but it wasn't there." << llendl;
  102. return mMap[LOGFUNCTOR];
  103. }
  104. }
  105. const std::string LOGFUNCTOR;
  106. const std::string DONOTHING;
  107. private:
  108. static void log_functor(const LLSD& notification, const LLSD& payload)
  109. {
  110. llwarns << "log_functor called with payload: " << payload << llendl;
  111. }
  112. static void do_nothing(const LLSD& notification, const LLSD& payload)
  113. {
  114. // what the sign sez
  115. }
  116. FunctorMap mMap;
  117. };
  118. template <typename FUNCTOR_TYPE>
  119. class LLFunctorRegistration
  120. {
  121. public:
  122. LLFunctorRegistration(const std::string& name, FUNCTOR_TYPE functor) 
  123. {
  124. LLFunctorRegistry<FUNCTOR_TYPE>::instance().registerFunctor(name, functor);
  125. }
  126. };
  127. #endif//LL_LLFUNCTORREGISTRY_H