]> Dogcows Code - chaz/yoink/blobdiff - src/stlplus/containers/smart_ptr.hpp
import stlplus 3.7
[chaz/yoink] / src / stlplus / containers / smart_ptr.hpp
index 0170771b663fb25ed7b73fb0dad7a23995865e68..18b496e5a70b832457aabceff10d2bb7d14d25d7 100644 (file)
-#ifndef STLPLUS_SMART_PTR
-#define STLPLUS_SMART_PTR
-////////////////////////////////////////////////////////////////////////////////
-
-//   Author:    Andy Rushton
-//   Copyright: (c) Southampton University 1999-2004
-//              (c) Andy Rushton           2004-2009
-//   License:   BSD License, see ../docs/license.html
-
-//   A smart pointer is a memory-managing pointer to an object. If you like, it
-//   is a zero-dimensional container.
-
-//   Assignment of smart pointers result in multiple aliases of the same object.
-//   The term alias is used to differentiate from conventional pointers because
-//   the semantics are different.
-
-//   Aliases can be turned into copies if the pointed-to class supports copying.
-
-//   The base class is smart_ptr_base which defines the common interface. Then
-//   there are three subclasses which have the same interface but different copy
-//   semantics:
-
-//   - smart_ptr        for simple types and classes which have copy constructors
-//   - smart_ptr_clone  for polymorphic class hierarchies which are copied using a clone method
-//   - smart_ptr_nocopy for any class that cannot or should not be copied
-
-////////////////////////////////////////////////////////////////////////////////
-#include "containers_fixes.hpp"
-#include "exceptions.hpp"
-#include "copy_functors.hpp"
-#include <map>
-#include <string>
-
-namespace stlplus
-{
-
-  ////////////////////////////////////////////////////////////////////////////////
-  // internals
-
-  template<typename T> class smart_ptr_holder;
-
-  ////////////////////////////////////////////////////////////////////////////////
-  // Base class
-  ////////////////////////////////////////////////////////////////////////////////
-
-  template<typename T, typename C>
-  class smart_ptr_base
-  {
-  public:
-    //////////////////////////////////////////////////////////////////////////////
-    // member type definitions
-
-    typedef T value_type;
-    typedef T& reference;
-    typedef const T& const_reference;
-    typedef C value_copy;
-
-    //////////////////////////////////////////////////////////////////////////////
-    // constructors and destructors
-
-    // create a null pointer
-    smart_ptr_base(void);
-
-    // create a pointer containing a *copy* of the object using the template parameter C
-    // this copy is taken because the pointer class maintains a dynamically allocated object
-    // and the T& may not be (usually is not) dynamically allocated
-    explicit smart_ptr_base(const T& data) throw(illegal_copy);
-
-    // create a pointer containing a dynamically created object
-    // Note: the object must be allocated *by the user* with new
-    // constructor form - must be called in the form smart_ptr_base<type> x(new type(args))
-    explicit smart_ptr_base(T* data);
-
-    // copy constructor implements aliasing so no copy is made
-    // note that the copy constructor should NOT be explicit, as this breaks
-    // the returning of pointer objects from functions (at least within GCC 4.4)
-    smart_ptr_base(const smart_ptr_base<T,C>& r);
-
-    // assignment operator - required, else the output of GCC suffers segmentation faults
-    smart_ptr_base<T,C>& operator=(const smart_ptr_base<T,C>& r);
-
-    // destructor decrements the reference count and delete only when the last reference is destroyed
-    ~smart_ptr_base(void);
-
-    //////////////////////////////////////////////////////////////////////////////
-    // logical tests to see if there is anything contained in the pointer since it can be null
-
-    // there are two forms:explicit and implicit
-    // implicit: if(!r) or if(r)
-    // explicit: if(r.null()) or if(r.present())
-    operator bool(void) const;
-    bool operator!(void) const;
-    bool present(void) const;
-    bool null(void) const;
-
-    //////////////////////////////////////////////////////////////////////////////
-    // dereference operators and functions
-
-    // dereference the smart pointer to get the object - use in the form *p1
-    T& operator*(void) throw(null_dereference);
-    const T& operator*(void) const throw(null_dereference);
-
-    // used as a prefix to a member access to the contained object e.g. p1->print() calls T::print()
-    T* operator->(void) throw(null_dereference);
-    const T* operator->(void) const throw(null_dereference);
-
-    //////////////////////////////////////////////////////////////////////////////
-    // explicit function forms of the above assignment and dereference operators
-
-    // set the value - note that this does a copy using the C template parameter
-    void set_value(const T& data) throw(illegal_copy);
-    // get the value
-    T& value(void) throw(null_dereference);
-    const T& value(void) const throw(null_dereference);
-
-    // set the pointer
-    // deletes the previous pointer and adopts the passed pointer instead
-    // Note: the object must be allocated *by the user* with new
-    // Warning: it is very easy to break the memory management with this operation
-    void set(T* data = 0);
-    // get the pointer
-    T* pointer(void);
-    const T* pointer(void) const;
-
-    //////////////////////////////////////////////////////////////////////////////
-    // functions to manage aliases
-
-    // make this an alias of the passed object
-    void alias(const smart_ptr_base<T,C>&);
-
-    // test whether two pointers point to the same object(known as aliasing the object)
-    // used in the form if(a.aliases(b))
-    bool aliases(const smart_ptr_base<T,C>&) const;
-
-    // find the number of aliases - used when you need to know whether an
-    // object is still referred to from elsewhere (rare!)
-    unsigned alias_count(void) const;
-
-    // delete the object and make the pointer null - does not make it unique
-    // first, so all other pointers to this will be null too
-    void clear(void);
-
-    // make the pointer unique and null in one step - does not affect other
-    // pointers that were pointing to the same object
-    void clear_unique(void);
-
-    //////////////////////////////////////////////////////////////////////////////
-    // functions that involve copying
-
-    // these functions use the copy functor passed as the template parameter C
-    // to copy the object with the right copy semantics. If the copy functor
-    // is no_copy, an exception will be thrown.
-
-    // make this pointer unique with respect to any other references to the same object
-    // if this pointer is already unique, it does nothing - otherwise it copies the object
-    void make_unique(void) throw(illegal_copy);
-
-    // make this pointer a unique copy of the parameter
-    // useful for expressions like p1.copy(p2) which makes p1 a pointer to a unique copy of the contents of p2
-    void copy(const smart_ptr_base<T,C>&) throw(illegal_copy);
-
-  protected:
-    smart_ptr_holder<T>* m_holder;
-
-  public:
-    // internal use only - had to make them public because they need to be
-    // accessed by routines that could not be made friends
-    smart_ptr_holder<T>* _handle(void) const;
-    void _make_alias(smart_ptr_holder<T>* handle);
-  };
-
-  ////////////////////////////////////////////////////////////////////////////////
-  // smart_ptr        for simple types and classes which have copy constructors
-
-  template <typename T>
-  class smart_ptr : public smart_ptr_base<T, constructor_copy<T> >
-  {
-  public:
-    smart_ptr(void) {}
-    explicit smart_ptr(const T& data) : smart_ptr_base<T, constructor_copy<T> >(data) {}
-    explicit smart_ptr(T* data) : smart_ptr_base<T, constructor_copy<T> >(data) {}
-    smart_ptr<T>& operator=(const T& data) {set_value(data); return *this;}
-    smart_ptr<T>& operator=(T* data) {set(data); return *this;}
-    ~smart_ptr(void) {}
-  };
-
-  ////////////////////////////////////////////////////////////////////////////////
-  // smart_ptr_clone  for polymorphic class hierarchies which have a clone method
-
-  template <typename T>
-  class smart_ptr_clone : public smart_ptr_base<T, clone_copy<T> >
-  {
-  public:
-    smart_ptr_clone(void) {}
-    explicit smart_ptr_clone(const T& data) : smart_ptr_base<T, clone_copy<T> >(data) {}
-    explicit smart_ptr_clone(T* data) : smart_ptr_base<T, clone_copy<T> >(data) {}
-    smart_ptr_clone<T>& operator=(const T& data) {set_value(data); return *this;}
-    smart_ptr_clone<T>& operator=(T* data) {set(data); return *this;}
-    ~smart_ptr_clone(void) {}
-  };
-
-  ////////////////////////////////////////////////////////////////////////////////
-  // smart_ptr_nocopy for any class that cannot or should not be copied
-
-  template <typename T>
-  class smart_ptr_nocopy : public smart_ptr_base<T, no_copy<T> >
-  {
-  public:
-    smart_ptr_nocopy(void) {}
-    explicit smart_ptr_nocopy(const T& data) : smart_ptr_base<T, no_copy<T> >(data) {}
-    explicit smart_ptr_nocopy(T* data) : smart_ptr_base<T, no_copy<T> >(data) {}
-    smart_ptr_nocopy<T>& operator=(const T& data) {set_value(data); return *this;}
-    smart_ptr_nocopy<T>& operator=(T* data) {set(data); return *this;}
-    ~smart_ptr_nocopy(void) {}
-  };
-
-  ////////////////////////////////////////////////////////////////////////////////
-
-} // end namespace stlplus
-
-#include "smart_ptr.tpp"
-#endif
+#ifndef STLPLUS_SMART_PTR\r
+#define STLPLUS_SMART_PTR\r
+////////////////////////////////////////////////////////////////////////////////\r
+\r
+//   Author:    Andy Rushton\r
+//   Copyright: (c) Southampton University 1999-2004\r
+//              (c) Andy Rushton           2004 onwards\r
+//   License:   BSD License, see ../docs/license.html\r
+\r
+//   A smart pointer is a memory-managing pointer to an object. If you like, it\r
+//   is a zero-dimensional container.\r
+\r
+//   Assignment of smart pointers result in multiple aliases of the same object.\r
+//   The term alias is used to differentiate from conventional pointers because\r
+//   the semantics are different.\r
+\r
+//   Aliases can be turned into copies if the pointed-to class supports copying.\r
+\r
+//   The base class is smart_ptr_base which defines the common interface. Then\r
+//   there are three subclasses which have the same interface but different copy\r
+//   semantics:\r
+\r
+//   - smart_ptr        for simple types and classes which have copy constructors\r
+//   - smart_ptr_clone  for polymorphic class hierarchies which are copied using a clone method\r
+//   - smart_ptr_nocopy for any class that cannot or should not be copied\r
+\r
+////////////////////////////////////////////////////////////////////////////////\r
+#include "containers_fixes.hpp"\r
+#include "exceptions.hpp"\r
+#include "copy_functors.hpp"\r
+#include <map>\r
+#include <string>\r
+\r
+namespace stlplus\r
+{\r
+\r
+  ////////////////////////////////////////////////////////////////////////////////\r
+  // internals\r
+\r
+  template<typename T> class smart_ptr_holder;\r
+\r
+  ////////////////////////////////////////////////////////////////////////////////\r
+  // Base class\r
+  ////////////////////////////////////////////////////////////////////////////////\r
+\r
+  template<typename T, typename C>\r
+  class smart_ptr_base\r
+  {\r
+  public:\r
+    //////////////////////////////////////////////////////////////////////////////\r
+    // member type definitions\r
+\r
+    typedef T value_type;\r
+    typedef T& reference;\r
+    typedef const T& const_reference;\r
+    typedef C value_copy;\r
+\r
+    //////////////////////////////////////////////////////////////////////////////\r
+    // constructors and destructors\r
+\r
+    // create a null pointer\r
+    smart_ptr_base(void);\r
+\r
+    // create a pointer containing a dynamically created object\r
+    // Note: the object must be allocated *by the user* with new\r
+    // constructor form - must be called in the form smart_ptr_base<type> x(new type(args))\r
+    explicit smart_ptr_base(T* data);\r
+\r
+    // copy constructor implements aliasing so no copy is made\r
+    // note that the copy constructor should NOT be explicit, as this breaks\r
+    // the returning of pointer objects from functions (at least within GCC 4.4)\r
+    smart_ptr_base(const smart_ptr_base<T,C>& r);\r
+\r
+    // assignment operator - required, else the output of GCC suffers segmentation faults\r
+    smart_ptr_base<T,C>& operator=(const smart_ptr_base<T,C>& r);\r
+\r
+    // destructor decrements the reference count and delete only when the last reference is destroyed\r
+    ~smart_ptr_base(void);\r
+\r
+    //////////////////////////////////////////////////////////////////////////////\r
+    // logical tests to see if there is anything contained in the pointer since it can be null\r
+\r
+    // there are two forms:explicit and implicit\r
+    // implicit: if(!r) or if(r)\r
+    // explicit: if(r.null()) or if(r.present())\r
+    operator bool(void) const;\r
+    bool operator!(void) const;\r
+    bool present(void) const;\r
+    bool null(void) const;\r
+\r
+    //////////////////////////////////////////////////////////////////////////////\r
+    // dereference operators and functions\r
+\r
+    // dereference the smart pointer to get the object - use in the form *p1\r
+    T& operator*(void) throw(null_dereference);\r
+    const T& operator*(void) const throw(null_dereference);\r
+\r
+    // used as a prefix to a member access to the contained object e.g. p1->print() calls T::print()\r
+    T* operator->(void) throw(null_dereference);\r
+    const T* operator->(void) const throw(null_dereference);\r
+\r
+    //////////////////////////////////////////////////////////////////////////////\r
+    // explicit function forms of the above assignment and dereference operators\r
+\r
+    // get the value\r
+    T& value(void) throw(null_dereference);\r
+    const T& value(void) const throw(null_dereference);\r
+\r
+    // set the pointer\r
+    // deletes the previous pointer and adopts the passed pointer instead\r
+    // Note: the object must be allocated *by the user* with new\r
+    // Warning: it is very easy to break the memory management with this operation\r
+    void set(T* data = 0);\r
+    // get the pointer\r
+    T* pointer(void);\r
+    const T* pointer(void) const;\r
+\r
+    //////////////////////////////////////////////////////////////////////////////\r
+    // functions to manage aliases\r
+\r
+    // make this an alias of the passed object\r
+    void alias(const smart_ptr_base<T,C>&);\r
+\r
+    // test whether two pointers point to the same object(known as aliasing the object)\r
+    // used in the form if(a.aliases(b))\r
+    bool aliases(const smart_ptr_base<T,C>&) const;\r
+\r
+    // find the number of aliases - used when you need to know whether an\r
+    // object is still referred to from elsewhere (rare!)\r
+    unsigned alias_count(void) const;\r
+\r
+    // delete the object and make the pointer null - does not make it unique\r
+    // first, so all other pointers to this will be null too\r
+    void clear(void);\r
+\r
+    // make the pointer unique and null in one step - does not affect other\r
+    // pointers that were pointing to the same object\r
+    void clear_unique(void);\r
+\r
+    //////////////////////////////////////////////////////////////////////////////\r
+    // functions that involve copying\r
+\r
+    // these functions use the copy functor passed as the template parameter C\r
+    // to copy the object with the right copy semantics. If the copy functor\r
+    // is no_copy, an exception will be thrown.\r
+\r
+    // create a pointer containing a *copy* of the object using the template parameter C\r
+    // this copy is taken because the pointer class maintains a dynamically allocated object\r
+    // and the T& may not be (usually is not) dynamically allocated\r
+    explicit smart_ptr_base(const T& data) throw(illegal_copy);\r
+\r
+    // set the value - note that this does a copy using the C template parameter\r
+    void set_value(const T& data) throw(illegal_copy);\r
+\r
+    // make this pointer unique with respect to any other references to the same object\r
+    // if this pointer is already unique, it does nothing - otherwise it copies the object\r
+    void make_unique(void) throw(illegal_copy);\r
+\r
+    // make this pointer a unique copy of the parameter\r
+    // useful for expressions like p1.copy(p2) which makes p1 a pointer to a unique copy of the contents of p2\r
+    void copy(const smart_ptr_base<T,C>&) throw(illegal_copy);\r
+\r
+  protected:\r
+    smart_ptr_holder<T>* m_holder;\r
+\r
+  public:\r
+    // internal use only - had to make them public because they need to be\r
+    // accessed by routines that could not be made friends\r
+    smart_ptr_holder<T>* _handle(void) const;\r
+    void _make_alias(smart_ptr_holder<T>* handle);\r
+  };\r
+\r
+  ////////////////////////////////////////////////////////////////////////////////\r
+  // smart_ptr        for simple types and classes which have copy constructors\r
+\r
+  template <typename T>\r
+  class smart_ptr : public smart_ptr_base<T, constructor_copy<T> >\r
+  {\r
+  public:\r
+    smart_ptr(void) {}\r
+    explicit smart_ptr(const T& data) : smart_ptr_base<T, constructor_copy<T> >(data) {}\r
+    explicit smart_ptr(T* data) : smart_ptr_base<T, constructor_copy<T> >(data) {}\r
+    smart_ptr<T>& operator=(const T& data) {set_value(data); return *this;}\r
+    smart_ptr<T>& operator=(T* data) {set(data); return *this;}\r
+    ~smart_ptr(void) {}\r
+  };\r
+\r
+  ////////////////////////////////////////////////////////////////////////////////\r
+  // smart_ptr_clone  for polymorphic class hierarchies which have a clone method\r
+\r
+  template <typename T>\r
+  class smart_ptr_clone : public smart_ptr_base<T, clone_copy<T> >\r
+  {\r
+  public:\r
+    smart_ptr_clone(void) {}\r
+    explicit smart_ptr_clone(const T& data) : smart_ptr_base<T, clone_copy<T> >(data) {}\r
+    explicit smart_ptr_clone(T* data) : smart_ptr_base<T, clone_copy<T> >(data) {}\r
+    smart_ptr_clone<T>& operator=(const T& data) {set_value(data); return *this;}\r
+    smart_ptr_clone<T>& operator=(T* data) {set(data); return *this;}\r
+    ~smart_ptr_clone(void) {}\r
+  };\r
+\r
+  ////////////////////////////////////////////////////////////////////////////////\r
+  // smart_ptr_nocopy for any class that cannot or should not be copied\r
+\r
+  template <typename T>\r
+  class smart_ptr_nocopy : public smart_ptr_base<T, no_copy<T> >\r
+  {\r
+  public:\r
+    smart_ptr_nocopy(void) {}\r
+    explicit smart_ptr_nocopy(T* data) : smart_ptr_base<T, no_copy<T> >(data) {}\r
+    smart_ptr_nocopy<T>& operator=(T* data) {set(data); return *this;}\r
+    ~smart_ptr_nocopy(void) {}\r
+  };\r
+\r
+  ////////////////////////////////////////////////////////////////////////////////\r
+\r
+} // end namespace stlplus\r
+\r
+#include "smart_ptr.tpp"\r
+#endif\r
This page took 0.02388 seconds and 4 git commands to generate.