Home

Libraries

Author

Links

---

smartptraids.hpp

Go to the documentation of this file.

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is the SysToMath C++ Libraries package (LibStmCpp).
 *
 * The Initial Developer of the Original Code is
 * Tom Michaelis, SysToMath.
 * Portions created by the Initial Developer are Copyright (C) 2005-2006
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

/******************************************************************************
 *                       First Release 2005-10-19
 ******************************************************************************/


#ifndef STM_SMARTPTRAIDS_HPP
#define STM_SMARTPTRAIDS_HPP


// Include header files for implementation.
#include <stm/impl/smartptrxaids.hpp>


// Include injective_ptr base class template implementation.
#include <stm/impl/smartptrxaids.hpp>


namespace stm
{


namespace smartptr
{






const stm::dword Surjective = 0x00000001;  
const stm::dword Multirange = 0x00000002;  



template <stm::dword Flags = 0>
struct policy
{
    typedef boost::mpl::bool_<(Flags & Surjective) == Surjective> surjective;

    typedef boost::mpl::bool_<(Flags & Multirange) == Multirange> multirange;
};


template <class Policy>
struct MakeSurjective
{
    typedef boost::mpl::true_ surjective;

    typedef typename Policy::multirange multirange;
};


template <class Policy>
struct MakeMultirange
{
    typedef typename Policy::surjective surjective;

    typedef boost::mpl::true_ multirange;
};


template
<
    class T,
    class Compare = std::less<T>,
    class Allocator = std::allocator<T>,
    class Policy = stm::smartptr::policy<>
>
class injective_ptr :
    private local::mapped_ptr
    <
        T,
        Compare,
        Allocator,
        Policy::surjective::value,
        Policy::multirange::value
    >
{
    typedef local::mapped_ptr
    <
        T,
        Compare,
        Allocator,
        Policy::surjective::value,
        Policy::multirange::value
    >
    mapped_ptr_impl;

    typedef typename mapped_ptr_impl::repository repository;

    friend class boost::serialization::access;

public:
    typedef T element_type;

    typedef typename mapped_ptr_impl::rangeid_type rangeid_type;

    typedef Compare compare_type;

    typedef Allocator allocator_type;

    typedef Policy policy_type;

    typedef long refcount_type;

    typedef typename repository::range_type range_type;

    injective_ptr ();

    injective_ptr (rangeid_type rangeid);

    injective_ptr (const typename range_type::iterator &it);

    injective_ptr (const element_type &value, bool store = true);

    injective_ptr (const element_type &value,
                   rangeid_type rangeid, bool store = true);

    injective_ptr (const injective_ptr &other);

    injective_ptr &operator= (const injective_ptr &other);

    injective_ptr &assign (const element_type &value);

    void reset ();

    void reset (const element_type &value);

    void swap (injective_ptr &other);

    operator bool () const;

    const element_type &operator* () const;

    const element_type *operator-> () const;

    const element_type *get () const;

    static bool is_surjective ();

    static bool is_multirange ();

    bool unique () const;

    refcount_type use_count () const;

    const range_type &range () const;

    rangeid_type rangeid () const;

    static rangeid_type define_range ();

    static void undefine_range (rangeid_type rangeid);

    static bool range_empty (rangeid_type rangeid);

    static bool range_defined (rangeid_type rangeid);

    static bool range_available (rangeid_type rangeid);
};


template <class T, class Compare, class Allocator, class Policy>
bool operator==
(
    const injective_ptr<T, Compare, Allocator, Policy> &ptr1,
    const injective_ptr<T, Compare, Allocator, Policy> &ptr2
);


template <class T, class Compare, class Allocator, class Policy>
bool operator!=
(
    const injective_ptr<T, Compare, Allocator, Policy> &ptr1,
    const injective_ptr<T, Compare, Allocator, Policy> &ptr2
);


template <class T, class Compare, class Allocator, class Policy>
bool operator<
(
    const injective_ptr<T, Compare, Allocator, Policy> &ptr1,
    const injective_ptr<T, Compare, Allocator, Policy> &ptr2
);


template <class T, class Compare, class Allocator, class Policy>
void swap
(
    injective_ptr<T, Compare, Allocator, Policy> &ptr1,
    injective_ptr<T, Compare, Allocator, Policy> &ptr2
);


template <class T, class Compare, class Allocator, class Policy>
const T *get_pointer
(
    const injective_ptr<T, Compare, Allocator, Policy> &ptr
);


template
<
    class OStreamT,
    class T,
    class Compare,
    class Allocator,
    class Policy
>
OStreamT &operator<<
(
    OStreamT &os,
    const injective_ptr<T, Compare, Allocator, Policy> &ptr
);


template
<
    class T,
    class Compare = std::less<T>,
    class Allocator = std::allocator<T>,
    class Policy = stm::smartptr::policy<stm::smartptr::Multirange>
>
class injective_set :
    private boost::noncopyable
{
public:
    typedef T value_type;

    typedef Compare compare_type;

    typedef Allocator allocator_type;

    typedef MakeMultirange<Policy> policy_type;

    typedef injective_ptr
    <
        T,
        Compare,
        Allocator,
        MakeMultirange<Policy>
    > injective_ptr_type;

    typedef typename injective_ptr_type::range_type range_type;

    class accessor :
        public injective_ptr_type
    {
    public:
        typedef injective_ptr_type base;

        accessor ();

        accessor (const accessor &other);

        accessor (const base &ptr);

        accessor (const typename range_type::iterator &it);

        accessor &operator= (const accessor &other);
    };

    injective_set ();

    ~injective_set ();

    accessor nil () const;

    accessor insert (const value_type &value);

    accessor insert (const value_type &value, bool &inserted);

    accessor find (const value_type &value) const;

    const range_type &range () const;

    typename range_type::iterator begin () const;

    typename range_type::iterator end () const;

    typename range_type::size_type size () const;

    bool empty () const;

private:
    typename injective_ptr_type::rangeid_type rangeid_;
};


template
<
    class T,
    class Compare = std::less<T>,
    class Allocator = std::allocator<T>,
    class Policy = stm::smartptr::policy<>
>
class injective
{
public:
    typedef injective_ptr<T, Compare, Allocator, Policy> ptr;

    typedef injective_set<T, Compare, Allocator, MakeMultirange<Policy> > set;

    typedef typename Policy::surjective surjective;
};


template
<
    class T,
    class Compare = std::less<T>,
    class Allocator = std::allocator<T>,
    class Policy = stm::smartptr::policy<stm::smartptr::Surjective>
>
class bijective
{
public:
    typedef injective_ptr<T, Compare, Allocator, MakeSurjective<Policy> > ptr;

    typedef injective_set<T, Compare, Allocator, MakeMultirange<MakeSurjective<Policy> > > set;

    typedef boost::mpl::true_ surjective;
};


}  // namespace smartptr


// Lift names to namespace stm.
using smartptr::injective_ptr;
using smartptr::injective_set;
using smartptr::injective;
using smartptr::bijective;


}  // namespace stm


// Include inline and template implementation.
#include <stm/impl/smartptrxaids.hpp>


#endif  // STM_SMARTPTRAIDS_HPP

---

© Copyright Tom Michaelis 2002-2007

Distributed under the SysToMath Software License (See the accompanying file license.txt or a copy at www.SysToMath.com).