Teuchos_RefCountPtrDecl.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
// 
//                    Teuchos: Common Tools Package
//                 Copyright (2004) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// 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
// Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef TEUCHOS_REFCOUNTPTR_DECL_H
#define TEUCHOS_REFCOUNTPTR_DECL_H

#include "Teuchos_any.hpp"

#ifdef REFCOUNTPTR_INLINE_FUNCS
#define REFCOUNTPTR_INLINE inline
#else
#define REFCOUNTPTR_INLINE
#endif

#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace MemMngPack {} // ToDo: Take out latter!
#endif

namespace Teuchos {

namespace PrivateUtilityPack {
  class RefCountPtr_node;
}


enum ENull { null };

enum EPrePostDestruction { PRE_DESTROY, POST_DESTROY };

template<class T>
class DeallocDelete
{
public:
  typedef T ptr_t;
  void free( T* ptr ) { if(ptr) delete ptr; }
};

template<class T>
class DeallocArrayDelete
{
public:
  typedef T ptr_t;
  void free( T* ptr ) { if(ptr) delete [] ptr; }
};

template<class T>
class RefCountPtr {
public:
  typedef T element_type;
  RefCountPtr( ENull null_arg = null );
  RefCountPtr(const RefCountPtr<T>& r_ptr);
  template<class T2>
  RefCountPtr(const RefCountPtr<T2>& r_ptr);
  ~RefCountPtr();
  RefCountPtr<T>& operator=(const RefCountPtr<T>& r_ptr);
  T* operator->() const;
  T& operator*() const;
  T* get() const;
  T* release();
  int count() const;
  void set_has_ownership();
  bool has_ownership() const;
  bool shares_resource(const RefCountPtr<T>& r_ptr) const;
  const RefCountPtr<T>& assert_not_null() const;

private:

  // //////////////////////////////////////
  // Private types

  typedef PrivateUtilityPack::RefCountPtr_node      node_t;

  // //////////////////////////////////////////////////////////////
  // Private data members

  T       *ptr_;  // NULL if this pointer is null
  node_t  *node_; // NULL if this pointer is null

public:
#ifndef DOXYGEN_COMPILE
  // These constructors should be private but I have not had good luck making
  // this portable (i.e. using friendship etc.) in the past
  RefCountPtr( T* p, bool has_ownership );
  template<class Dealloc_T>
  RefCountPtr( T* p, Dealloc_T dealloc, bool has_ownership );
  // This is a very bad breach of encapsulation that is needed since MS VC++ 5.0 will
  // not allow me to declare template functions as friends.
  RefCountPtr( T* p, node_t* node);
  T*&           access_ptr();
  node_t*&      access_node();
  node_t*       access_node() const;
#endif

};  // end class RefCountPtr<...>

template<class T>
RefCountPtr<T> rcp( T* p, bool owns_mem
#ifndef __sun
  = true
#endif
  );
#ifdef __sun // RAB: 20040303: Sun needs to fix their compiler
template<class T> inline RefCountPtr<T> rcp( T* p ) { return rcp(p,true); }
#endif

template<class T, class Dealloc_T>
RefCountPtr<T> rcp( T* p, Dealloc_T dealloc, bool owns_mem );

template<class T>
bool is_null( const RefCountPtr<T> &p );

template<class T>
bool operator==( const RefCountPtr<T> &p, ENull );

template<class T>
bool operator!=( const RefCountPtr<T> &p, ENull );

template<class T1, class T2>
bool operator==( const RefCountPtr<T1> &p1, const RefCountPtr<T2> &p2 );

template<class T1, class T2>
bool operator!=( const RefCountPtr<T1> &p1, const RefCountPtr<T2> &p2 );

template<class T2, class T1>
RefCountPtr<T2> rcp_implicit_cast(const RefCountPtr<T1>& p1);

template<class T2, class T1>
RefCountPtr<T2> rcp_static_cast(const RefCountPtr<T1>& p1);

template<class T2, class T1>
RefCountPtr<T2> rcp_const_cast(const RefCountPtr<T1>& p1);

template<class T2, class T1>
RefCountPtr<T2> rcp_dynamic_cast(
  const RefCountPtr<T1>& p1
  ,bool throw_on_fail
#ifndef __sun
  = false
#endif
  );
#ifdef __sun // RAB: 20041019: Sun needs to fix their compiler
template<class T2, class T1> inline RefCountPtr<T2> rcp_dynamic_cast( const RefCountPtr<T1>& p1 )
{ return rcp_dynamic_cast<T2>(p1,false); }
#endif

template<class T1, class T2>
void set_extra_data( const T1 &extra_data, const std::string& name, RefCountPtr<T2> *p, bool force_unique
#ifndef __sun
                     = true
#endif
                     ,EPrePostDestruction destroy_when
#ifndef __sun
                     = POST_DESTROY
#endif
  );
#ifdef __sun
template<class T1, class T2>
inline void set_extra_data( const T1 &extra_data, const std::string& name, RefCountPtr<T2> *p )
{ set_extra_data( extra_data, name, p, true, POST_DESTROY ); }
template<class T1, class T2>
inline void set_extra_data( const T1 &extra_data, const std::string& name, RefCountPtr<T2> *p, bool force_unique )
{ set_extra_data( extra_data, name, p, force_unique, POST_DESTROY ); }
#endif

template<class T1, class T2>
T1& get_extra_data( RefCountPtr<T2>& p, const std::string& name );

template<class T1, class T2>
const T1& get_extra_data( const RefCountPtr<T2>& p, const std::string& name );

template<class T1, class T2>
T1* get_optional_extra_data( RefCountPtr<T2>& p, const std::string& name );

template<class T1, class T2>
const T1* get_optional_extra_data( const RefCountPtr<T2>& p, const std::string& name );

template<class Dealloc_T, class T>
Dealloc_T& get_dealloc( RefCountPtr<T>& p );

template<class Dealloc_T, class T>
const Dealloc_T& get_dealloc( const RefCountPtr<T>& p );

template<class Dealloc_T, class T>
Dealloc_T* get_optional_dealloc( RefCountPtr<T>& p );

template<class Dealloc_T, class T>
const Dealloc_T* get_optional_dealloc( const RefCountPtr<T>& p );


} // end namespace Teuchos

#endif  // TEUCHOS_REFCOUNTPTR_DECL_H

---