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

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2.  * @file llinstancetracker.h
  3.  * @brief LLInstanceTracker is a mixin class that automatically tracks object
  4.  *        instances with or without an associated key
  5.  *
  6.  * $LicenseInfo:firstyear=2000&license=viewergpl$
  7.  * 
  8.  * Copyright (c) 2000-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_LLINSTANCETRACKER_H
  34. #define LL_LLINSTANCETRACKER_H
  35. #include <map>
  36. #include "string_table.h"
  37. #include <boost/utility.hpp>
  38. #include <boost/function.hpp>
  39. #include <boost/bind.hpp>
  40. #include <boost/iterator/transform_iterator.hpp>
  41. #include <boost/iterator/indirect_iterator.hpp>
  42. /// This mix-in class adds support for tracking all instances of the specified class parameter T
  43. /// The (optional) key associates a value of type KEY with a given instance of T, for quick lookup
  44. /// If KEY is not provided, then instances are stored in a simple set
  45. /// @NOTE: see explicit specialization below for default KEY==T* case
  46. template<typename T, typename KEY = T*>
  47. class LLInstanceTracker : boost::noncopyable
  48. {
  49. typedef typename std::map<KEY, T*> InstanceMap;
  50. typedef boost::function<const KEY&(typename InstanceMap::value_type&)> KeyGetter;
  51. typedef boost::function<T*(typename InstanceMap::value_type&)> InstancePtrGetter;
  52. public:
  53. /// Dereferencing key_iter gives you a const KEY&
  54. typedef boost::transform_iterator<KeyGetter, typename InstanceMap::iterator> key_iter;
  55. /// Dereferencing instance_iter gives you a T&
  56. typedef boost::indirect_iterator< boost::transform_iterator<InstancePtrGetter, typename InstanceMap::iterator> > instance_iter;
  57. static T* getInstance(const KEY& k)
  58. {
  59. typename InstanceMap::const_iterator found = getMap_().find(k);
  60. return (found == getMap_().end()) ? NULL : found->second;
  61. }
  62. static key_iter beginKeys()
  63. {
  64. return boost::make_transform_iterator(getMap_().begin(),
  65.   boost::bind(&InstanceMap::value_type::first, _1));
  66. }
  67. static key_iter endKeys()
  68. {
  69. return boost::make_transform_iterator(getMap_().end(),
  70.   boost::bind(&InstanceMap::value_type::first, _1));
  71. }
  72. static instance_iter beginInstances()
  73. {
  74. return instance_iter(boost::make_transform_iterator(getMap_().begin(),
  75. boost::bind(&InstanceMap::value_type::second, _1)));
  76. }
  77. static instance_iter endInstances()
  78. {
  79. return instance_iter(boost::make_transform_iterator(getMap_().end(),
  80. boost::bind(&InstanceMap::value_type::second, _1)));
  81. }
  82. static S32 instanceCount() { return getMap_().size(); }
  83. protected:
  84. LLInstanceTracker(KEY key) { add_(key); }
  85. virtual ~LLInstanceTracker() { remove_(); }
  86. virtual void setKey(KEY key) { remove_(); add_(key); }
  87. virtual const KEY& getKey() const { return mKey; }
  88. private:
  89. void add_(KEY key) 
  90. mKey = key; 
  91. getMap_()[key] = static_cast<T*>(this); 
  92. }
  93. void remove_()
  94. {
  95. getMap_().erase(mKey);
  96. }
  97.     static InstanceMap& getMap_()
  98.     {
  99.         if (! sInstances)
  100.         {
  101.             sInstances = new InstanceMap;
  102.         }
  103.         return *sInstances;
  104.     }
  105. private:
  106. KEY mKey;
  107. static InstanceMap* sInstances;
  108. };
  109. /// explicit specialization for default case where KEY is T*
  110. /// use a simple std::set<T*>
  111. template<typename T>
  112. class LLInstanceTracker<T, T*>
  113. {
  114. typedef typename std::set<T*> InstanceSet;
  115. public:
  116. /// Dereferencing key_iter gives you a T* (since T* is the key)
  117. typedef typename InstanceSet::iterator key_iter;
  118. /// Dereferencing instance_iter gives you a T&
  119. typedef boost::indirect_iterator<key_iter> instance_iter;
  120. /// for completeness of analogy with the generic implementation
  121. static T* getInstance(T* k) { return k; }
  122. static S32 instanceCount() { return getSet_().size(); }
  123. // Instantiate this to get access to iterators for this type.  It's a 'guard' in the sense
  124. // that it treats deletes of this type as errors as long as there is an instance of
  125. // this class alive in scope somewhere (i.e. deleting while iterating is bad).
  126. class LLInstanceTrackerScopedGuard
  127. {
  128. public:
  129. LLInstanceTrackerScopedGuard()
  130. {
  131. ++sIterationNestDepth;
  132. }
  133. ~LLInstanceTrackerScopedGuard()
  134. {
  135. --sIterationNestDepth;
  136. }
  137. static instance_iter beginInstances() { return instance_iter(getSet_().begin()); }
  138. static instance_iter endInstances() { return instance_iter(getSet_().end()); }
  139. static key_iter beginKeys() { return getSet_().begin(); }
  140. static key_iter endKeys()   { return getSet_().end(); }
  141. };
  142. protected:
  143. LLInstanceTracker()
  144. {
  145. // it's safe but unpredictable to create instances of this type while all instances are being iterated over.  I hate unpredictable.  This assert will probably be turned on early in the next development cycle.
  146. //llassert(sIterationNestDepth == 0);
  147. getSet_().insert(static_cast<T*>(this));
  148. }
  149. virtual ~LLInstanceTracker()
  150. {
  151. // it's unsafe to delete instances of this type while all instances are being iterated over.
  152. llassert(sIterationNestDepth == 0);
  153. getSet_().erase(static_cast<T*>(this));
  154. }
  155. LLInstanceTracker(const LLInstanceTracker& other)
  156. {
  157. //llassert(sIterationNestDepth == 0);
  158. getSet_().insert(static_cast<T*>(this));
  159. }
  160. static InstanceSet& getSet_()
  161. {
  162. if (! sInstances)
  163. {
  164. sInstances = new InstanceSet;
  165. }
  166. return *sInstances;
  167. }
  168. static InstanceSet* sInstances;
  169. static S32 sIterationNestDepth;
  170. };
  171. template <typename T, typename KEY> typename LLInstanceTracker<T, KEY>::InstanceMap* LLInstanceTracker<T, KEY>::sInstances = NULL;
  172. template <typename T> typename LLInstanceTracker<T, T*>::InstanceSet* LLInstanceTracker<T, T*>::sInstances = NULL;
  173. template <typename T> S32 LLInstanceTracker<T, T*>::sIterationNestDepth = 0;
  174. #endif