Add common/singleton_object_pool.h

dyninst · Apr 3, 2024 · a5450e4 · a5450e4
1 parent 571c742
commit a5450e4
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 2 deletions.
diff --git a/common/src/singleton_object_pool.h b/common/src/singleton_object_pool.h
@@ -35,7 +35,6 @@
 #include "dthread.h"
 #include "compiler_annotations.h"
 
-// This is only safe for objects with nothrow constructors...
 template <typename T, typename Alloc = std::allocator<T> >
 class singleton_object_pool : public Alloc
 {

diff --git a/docs/common/developer/singleton_object_pool.h.rst b/docs/common/developer/singleton_object_pool.h.rst
@@ -3,5 +3,19 @@
 singleton_object_pool.h
 #######################
 
-.. cpp:namespace:: Dyninst
+.. warning:: This is only safe for objects with nothrow constructors.
 
+.. cpp:class:: template <typename T, typename Alloc = std::allocator<T>> singleton_object_pool : public Alloc
+
+  .. cpp:function:: static pointer allocate( size_type n )
+  .. cpp:function:: static void deallocate( pointer p )
+  .. cpp:function:: template<typename... Args> static T* construct(Args&&... args)
+  .. cpp:function:: static void destroy(pointer p)
+
+.. cpp:function:: template <typename T, typename Alloc> typename singleton_object_pool<T, Alloc>::pointer singleton_object_pool<T, Alloc>::allocate( size_type n )
+
+.. cpp:struct template <typename T> PoolDestructor
+
+  .. cpp:function:: void operator()(T* e)
+
+.. cpp:function:: template <typename T> boost::shared_ptr<T> make_shared(T* t)