refPtr.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Christophe GONZALES and Pierre-Henri WUILLEMIN  *
 *   {prenom.nom}_at_lip6.fr                                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program 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 General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef GUM_REFPTR_H
#define GUM_REFPTR_H

#include <new>

#include <agrum/agrum.h>

namespace gum {

#ifndef DOXYGEN_SHOULD_SKIP_THIS

  template < typename Val >
  class RefPtr;

  template < typename Val >
  class HashFunc;
#endif

  /* DOXYGEN does not like template functions...
   *
   * @brief Swap the contents of two RefPtr.
   * @tparam Val The type referenced by both gum::RefPtr.
   * @param ptr1 The smart pointer the content of which we swap with that of
   * ptr2.
   * @param ptr2 The smart pointer the content of which we replace with that of
   * ptr1.
   */
  template < typename Val >
  void swap(RefPtr< Val >& ptr1, RefPtr< Val >& ptr2);

  // ===========================================================================
  // ===                           SMART POINTERS                            ===
  // ===========================================================================
  template < typename Val >
  class RefPtr {
    public:
    friend void swap<>(RefPtr< Val >&, RefPtr< Val >&);

    // ============================================================================
    // ============================================================================

    explicit RefPtr(Val* val = 0);

    RefPtr(const RefPtr< Val >& from);

    template < typename DownVal >
    RefPtr(const RefPtr< DownVal >& from);

    ~RefPtr();

    // ============================================================================
    // ============================================================================

    operator bool() const;

    void clear();

    unsigned int refCount() const;

    // ============================================================================
    // ============================================================================

    RefPtr< Val >& operator=(const RefPtr< Val >& from);

    RefPtr< Val >& operator=(Val* from);

    template < typename DownVal >
    RefPtr< Val >& operator=(const RefPtr< DownVal >& from);

    bool operator==(const RefPtr< Val >& from) const;

    bool operator!=(const RefPtr< Val >& from) const;

    Val* operator->() const;

    Val& operator*();

    const Val& operator*() const;

    // ============================================================================
    // ============================================================================
    private:
    template < typename T >
    friend class RefPtr;

    template < typename T >
    friend class HashFunc;

    Val* __val;

    unsigned int* __refcount;

    void __destroy(unsigned int*, Val*);

    unsigned int* __refCountPtr() const;
  };

} /* namespace gum */


#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#  ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#    ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
extern template class gum::RefPtr< int >;
#    endif
#  endif
#endif
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#  ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#    ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
extern template class gum::RefPtr< long >;
#    endif
#  endif
#endif

#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#  ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#    ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
extern template class gum::RefPtr< double >;
#    endif
#  endif
#endif


// always include the _tpl.h as it contains only templates
#include <agrum/core/refPtr_tpl.h>

#endif /* GUM_REFPTR_H */