INTEGRATION: CWS presfixes10 (1.1.2); FILE ADDED

2005/11/22 17:12:40 dbo 1.1.2.1: shifted internal allocator.hxx => rtl/allocator.hxx

1 files changed, 200 insertions, 0 deletions

diff --git a/sal/inc/rtl/allocator.hxx b/sal/inc/rtl/allocator.hxx
new file mode 100644
index 000000000000..77b0fa98c5a5
--- /dev/null
+++ b/sal/inc/rtl/allocator.hxx
@@ -0,0 +1,200 @@
+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: allocator.hxx,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: rt $ $Date: 2006-07-26 07:42:32 $
+ *
+ *  The Contents of this file are made available subject to
+ *  the terms of GNU Lesser General Public License Version 2.1.
+ *
+ *
+ *    GNU Lesser General Public License Version 2.1
+ *    =============================================
+ *    Copyright 2005 by Sun Microsystems, Inc.
+ *    901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *    This library is free software; you can redistribute it and/or
+ *    modify it under the terms of the GNU Lesser General Public
+ *    License version 2.1, as published by the Free Software Foundation.
+ *
+ *    This library is distributed in the hope that it will be useful,
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *    Lesser General Public License for more details.
+ *
+ *    You should have received a copy of the GNU Lesser General Public
+ *    License along with this library; if not, write to the Free Software
+ *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *    MA  02111-1307  USA
+ *
+ ************************************************************************/
+#if !defined INCLUDED_RTL_ALLOCATOR_HXX
+#define INCLUDED_RTL_ALLOCATOR_HXX
+
+#if ! defined(_SAL_TYPES_H_)
+#include "sal/types.h"
+#endif
+#if ! defined(_RTL_ALLOC_H_)
+#include "rtl/alloc.h"
+#endif
+
+#include <cstddef>
+
+//######################################################
+// This is no general purpose STL allocator but one
+// necessary to use STL for some implementation but
+// avoid linking sal against the STLPort library!!!
+// For more information on when and how to define a
+// custom stl allocator have a look at Scott Meyers:
+// "Effective STL", Nicolai M. Josuttis:
+// "The C++ Standard Library - A Tutorial and Reference"
+// and at http://www.josuttis.com/cppcode/allocator.html
+
+namespace rtl {
+
+/** @internal */
+template<class T>
+class Allocator
+{
+public:
+    typedef T value_type;
+    typedef T* pointer;
+    typedef const T* const_pointer;
+    typedef T& reference;
+    typedef const T& const_reference;
+    typedef ::std::size_t size_type;
+    typedef ::std::ptrdiff_t difference_type;
+
+    //-----------------------------------------
+    template<class U>
+    struct rebind
+    {
+        typedef Allocator<U> other;
+    };
+
+    //-----------------------------------------
+    pointer address (reference value) const
+    {
+        return &value;
+    }
+
+    //-----------------------------------------
+    const_pointer address (const_reference value) const
+    {
+        return &value;
+    }
+
+    //-----------------------------------------
+    Allocator() SAL_THROW(())
+    {}
+
+    //-----------------------------------------
+    template<class U>
+    Allocator (const Allocator<U>&) SAL_THROW(())
+    {}
+
+    //-----------------------------------------
+    Allocator(const Allocator&) SAL_THROW(())
+    {}
+
+    //-----------------------------------------
+    ~Allocator() SAL_THROW(())
+    {}
+
+    //-----------------------------------------
+    size_type max_size() const SAL_THROW(())
+    {
+        return size_type(-1)/sizeof(T);
+    }
+
+    //-----------------------------------------
+    /* Normally the code for allocate should
+       throw a std::bad_alloc exception if the
+       requested memory could not be allocated:
+       (C++ standard 20.4.1.1):
+
+       pointer allocate (size_type n, const void* hint = 0)
+       {
+         pointer p = reinterpret_cast<pointer>(
+             rtl_allocateMemory(sal_uInt32(n * sizeof(T))));
+
+         if (NULL == p)
+             throw ::std::bad_alloc();
+
+         return p;
+       }
+
+       but some compilers do not compile it if exceptions
+       are not enabled, e.g. GCC under Linux and it is
+       in general not desired to compile sal with exceptions
+       enabled. */
+    pointer allocate (size_type n, const void* hint = 0)
+    {
+        hint = hint; /* avoid warnings */
+        return reinterpret_cast<pointer>(
+            rtl_allocateMemory(sal_uInt32(n * sizeof(T))));
+    }
+
+    //-----------------------------------------
+    void deallocate (pointer p, size_type /* n */)
+    {
+        rtl_freeMemory(p);
+    }
+
+    //-----------------------------------------
+    void construct (pointer p, const T& value)
+    {
+        new ((void*)p)T(value);
+    }
+
+    //-----------------------------------------
+    void destroy (pointer p)
+    {
+        p->~T();
+    }
+};
+
+//######################################################
+// Custom STL allocators must be stateless (see
+// references above) that's why the operators below
+// return always true or false
+
+/** @internal */
+template<class T, class U>
+inline bool operator== (const Allocator<T>&, const Allocator<U>&) SAL_THROW(())
+{
+    return true;
+}
+
+/** @internal */
+template<class T, class U>
+inline bool operator!= (const Allocator<T>&, const Allocator<U>&) SAL_THROW(())
+{
+    return false;
+}
+
+} /* namespace rtl */
+
+//######################################################
+/** REQUIRED BY STLPort (see stlport '_alloc.h'):
+    Hack for compilers that do not support member
+    template classes (e.g. MSVC 6)
+
+    @internal
+*/
+namespace _STL
+{
+    /** @internal */
+    template<class T, class U>
+    inline ::rtl::Allocator<U> & __stl_alloc_rebind (::rtl::Allocator<T> & a, U const *)
+    {
+        return (::rtl::Allocator<U>&)(a);
+    }
+}
+
+#endif /* INCLUDED_RTL_ALLOCATOR_HXX */
+