// @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.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER
#ifndef TEUCHOS_PTR_DECL_HPP
#define TEUCHOS_PTR_DECL_HPP
#include "Teuchos_RCPDecl.hpp"
#include "Teuchos_dyn_cast.hpp"
namespace Teuchos {
/** \brief Simple wrapper class for raw pointers to single objects where no
* persisting relationship exists.
*
* This class is meant to replace all but the lowest-level use of raw pointers
* that point to single objects where the use of RCP is not justified
* for performance or semantic reasons. When built in optimized mode, this
* class should impart little time overhead and should be exactly equivalent
* in the memory footprint to a raw C++ pointer and the only extra runtime
* overhead will be the default initalization to NULL.
*
* The main advantages of using this class over a raw pointer however are:
*
*
*
* - Ptr objects always default construct to null
*
*
- Ptr objects will throw exceptions on attempts to dereference
* the underlying null pointer when debugging support is compiled in.
*
*
- Ptr does not allow array-like operations like
* ptr[i], ++ptr or ptr+i that can only result in
* disaster when the a pointer points to only a single object that can not be
* assumed to be part of an array of objects.
*
*
- Ptr is part of a system of types defined in Teuchos
* that keeps your code away from raw pointers which are the cause of most
* defects in C++ code.
*
*
*
* Debugging support is compiled in when the macro TEUCHOS_DEBUG is
* defined which happens automatically when --enable-teuchos-debug is
* specified on the configure line. When debugging support is not compiled
* in, the only overhead imparted by this class is it's default initialization
* to null. Therefore, this class can provide for very high performance on
* optimized builds of the code.
*
* An implicit conversion from a raw pointer to a Ptr object is okay
* since we don't assume any ownership of the object, hense the constructor
* taking a raw pointer is not declared explicit. However, this class does
* not support an implicit conversion to a raw pointer since we want to limit
* the exposure of raw pointers in our software. If we have to convert back
* to a raw pointer, then we want to make that explicit by calling
* get().
*
* This class should be used to replace most raw uses of C++ pointers to
* single objects where using the RCP class is not appropriate,
* unless the runtime cost of null-initialization it too expensive.
*/
template
class Ptr {
public:
/** \brief Default construct to NULL.
*
* Postconditons:
*/
inline Ptr( ENull null_in = null );
/** \brief Construct given a raw pointer.
*
* Postconditons:
*
* Note: This constructor is declared explicit so there is no
* implicit conversion from a raw C++ pointer to a Ptr object.
* This is meant to avoid cases where an uninitialized pointer is used to
* implicitly initialize one of these objects.
*/
inline explicit Ptr( T *ptr );
/** \brief Copy construct from same type.
*
* Postconditons:
* - this->get() == ptr.get()
*
*/
inline Ptr(const Ptr& ptr);
/** \brief Copy construct from another type.
*
* Postconditons:
* - this->get() == ptr.get() (unless virtual base classes
* are involved)
*
*/
template
inline Ptr(const Ptr& ptr);
/** \brief Shallow copy of the underlying pointer.
*
* Postconditons:
* - this->get() == ptr.get()
*
*/
Ptr& operator=(const Ptr& ptr);
/** \brief Pointer (->) access to members of underlying object.
*
* Preconditions:
* - this->get() != NULL (throws std::logic_error)
*
*/
inline T* operator->() const;
/** \brief Dereference the underlying object.
*
* Preconditions:
* - this->get() != NULL (throws std::logic_error)
*
*/
inline T& operator*() const;
/** \brief Get the raw C++ pointer to the underlying object. */
inline T* get() const;
/** \brief Get the raw C++ pointer to the underlying object. */
inline T* getRawPtr() const;
/** \brief Throws std::logic_error if this->get()==NULL,
* otherwise returns reference to *this.
*/
inline const Ptr& assert_not_null() const;
/** \brief Return a copy of *this. */
inline const Ptr ptr() const;
/** \brief Return a Ptr version of *this. */
inline Ptr getConst() const;
private:
T *ptr_;
#ifdef TEUCHOS_DEBUG
RCP rcp_;
#endif
void debug_assert_not_null() const
{
#ifdef TEUCHOS_DEBUG
assert_not_null();
#endif
}
inline void debug_assert_valid_ptr() const;
public: // Bad bad bad
#ifdef TEUCHOS_DEBUG
Ptr( const RCP &p );
T* access_private_ptr() const
{ return ptr_; }
const RCP access_rcp() const
{ return rcp_; }
#endif
};
/** \brief create a non-persisting (required or optional) output
* argument for a function call.
*
* \relates Ptr
*/
template inline
Ptr outArg( T& arg )
{
return Ptr(&arg);
}
/** \brief create a non-persisting (required or optional) input/output
* argument for a function call.
*
* \relates Ptr
*/
template inline
Ptr inOutArg( T& arg )
{
return Ptr(&arg);
}
/** \brief create a non-persisting (required or optional) input/output
* argument for a function call.
*
* \relates Ptr
*/
template inline
Ptr inoutArg( T& arg )
{
return Ptr(&arg);
}
/** \brief create a general Ptr input argument for a function call
* from a reference.
*
* \relates Ptr
*/
template inline
Ptr ptrInArg( T& arg )
{
return Ptr(&arg);
}
/** \brief create a non-persisting non-const optional input argument
for a function call.
*
* \relates Ptr
*/
template inline
Ptr optInArg( T& arg )
{
return Ptr(&arg);
}
/** \brief create a non-persisting const optional input argument for a
function call.
*
* \relates Ptr
*/
template inline
Ptr constOptInArg( T& arg )
{
return Ptr(&arg);
}
/** \brief Create a pointer to a object from an object reference.
*
* \relates Ptr
*/
template inline
Ptr ptrFromRef( T& arg )
{
return Ptr(&arg);
}
/** \brief Create an RCP from a Ptr object.
*
* \relates RCP
*/
template inline
RCP rcpFromPtr( const Ptr& ptr )
{
if (is_null(ptr))
return null;
#ifdef TEUCHOS_DEBUG
// In a debug build, just grab out the WEAK RCP and return it. That way we
// can get dangling reference checking without having to turn on more
// expensive RCPNode tracing.
if (!is_null(ptr.access_rcp()))
return ptr.access_rcp();
#endif
return rcpFromRef(*ptr);
}
/** \brief Create a pointer to an object from a raw pointer.
*
* \relates Ptr
*/
template inline
Ptr ptr( T* p )
{
return Ptr(p);
}
/** \brief Create a pointer from a const object given a non-const object
* reference.
*
* Warning! Do not call this function if T is already const or
* a compilation error will occur!
*
* \relates Ptr
*/
template inline
Ptr constPtr( T& arg )
{
return Ptr(&arg);
}
/** \brief Returns true if p.get()==NULL.
*
* \relates Ptr
*/
template inline
bool is_null( const Ptr &p )
{
return p.get() == 0;
}
/** \brief Returns true if p.get()!=NULL
*
* \relates Ptr
*/
template inline
bool nonnull( const Ptr &p )
{
return p.get() != 0;
}
/** \brief Returns true if p.get()==NULL.
*
* \relates Ptr
*/
template inline
bool operator==( const Ptr &p, ENull )
{
return p.get() == 0;
}
/** \brief Returns true if p.get()!=NULL.
*
* \relates Ptr
*/
template
bool operator!=( const Ptr &p, ENull )
{
return p.get() != 0;
}
/** \brief Return true if two Ptr objects point to the same object.
*
* \relates Ptr
*/
template
bool operator==( const Ptr &p1, const Ptr &p2 )
{
return p1.get() == p2.get();
}
/** \brief Return true if two Ptr objects do not point to the same
* object.
*
* \relates Ptr
*/
template
bool operator!=( const Ptr &p1, const Ptr &p2 )
{
return p1.get() != p2.get();
}
/** \brief Implicit cast of underlying Ptr type from T1* to
* T2*.
*
* The function will compile only if (T2* p2 = p1.get();) compiles.
*
* This is to be used for conversions up an inheritance hierarchy and from
* non-const to const and any other standard implicit pointer conversions
* allowed by C++.
*
* \relates Ptr
*/
template
Ptr ptr_implicit_cast(const Ptr& p1)
{
return Ptr(p1.get()); // Will only compile if conversion is legal!
}
/** \brief Static cast of underlying Ptr type from T1* to
* T2*.
*
* The function will compile only if (static_cast(p1.get());)
* compiles.
*
* This can safely be used for conversion down an inheritance hierarchy with
* polymorphic types only if dynamic_cast(p1.get()) ==
* static_cast(p1.get()). If not then you have to use
* ptr_dynamic_cast(p1).
*
* \relates Ptr
*/
template
Ptr ptr_static_cast(const Ptr& p1)
{
return Ptr(static_cast(p1.get())); // Will only compile if conversion is legal!
}
/** \brief Constant cast of underlying Ptr type from T1* to
* T2*.
*
* This function will compile only if (const_cast(p1.get());)
* compiles.
*
* \relates Ptr
*/
template
Ptr ptr_const_cast(const Ptr& p1)
{
return Ptr(const_cast(p1.get())); // Will only compile if conversion is legal!
}
/** \brief Dynamic cast of underlying Ptr type from T1* to
* T2*.
*
* \param p1 [in] The smart pointer casting from
*
* \param throw_on_fail [in] If true then if the cast fails (for
* p1.get()!=NULL) then a std::bad_cast std::exception is thrown
* with a very informative error message.
*
* Postconditions:
* - If ( p1.get()!=NULL && throw_on_fail==true && dynamic_cast(p1.get())==NULL ) == true
* then an std::bad_cast std::exception is thrown with a very informative error message.
*
- If ( p1.get()!=NULL && dynamic_cast(p1.get())!=NULL ) == true
* then return.get() == dynamic_cast(p1.get()).
*
- If ( p1.get()!=NULL && throw_on_fail==false && dynamic_cast(p1.get())==NULL ) == true
* then return.get() == NULL.
*
- If ( p1.get()==NULL ) == true
* then return.get() == NULL.
*
*
* This function will compile only if (dynamic_cast(p1.get());)
* compiles.
*
* \relates Ptr
*/
template
Ptr ptr_dynamic_cast(
const Ptr& p1, bool throw_on_fail = false
)
{
if( p1.get() ) {
T2 *check = NULL;
if(throw_on_fail)
check = &dyn_cast(*p1);
else
check = dynamic_cast(p1.get());
if(check) {
return Ptr(check);
}
}
return null;
}
/** \brief Output stream inserter.
*
* The implementation of this function just print pointer addresses and
* therefore puts no restrictions on the data types involved.
*
* \relates Ptr
*/
template
std::ostream& operator<<( std::ostream& out, const Ptr& p );
} // namespace Teuchos
#endif // TEUCHOS_PTR_DECL_HPP