/*************************************************************************
 *
 *  $RCSfile: rcptr.hxx,v $
 *
 *  $Revision: 1.1.1.1 $
 *
 *  last change: $Author: np $ $Date: 2002/03/08 14:25:39 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 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
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source 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.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/

#ifndef CSV_REFPTR_HXX
#define CSV_REFPTR_HXX


namespace csv
{


/** A refcounting pointer class.

    @tpl REF
    Has to provide the two methods:
        void    Acquire() const;
        void    Release() const;
    Has to handle deleting itself, when reference count reaches zero.
*/

template <class REF>
class RCPtr
{
  public:
    typedef RCPtr<REF> self;


    // LIFECYCLE
						RCPtr(
							DYN REF *		    i_pObject = 0);
                        RCPtr(
                            const self &        i_rOther );
						~RCPtr();

    self &              operator=(
                            const self &        i_rOther );

						operator bool() const;

    const REF *         operator->() const;
    REF *               operator->();
    const REF &         operator*() const;
    REF &               operator*();

    const REF *		    Ptr() const;
    REF *		        Ptr();
    REF *			    MutablePtr() const;


  private:
    void                Acquire() const;
    void                Release() const;

    // DATA
    REF *               pRef;
};




// IMPLEMENTATION

template <class REF>
inline void
RCPtr<REF>::Acquire() const
    { if (pRef != 0) pRef->Acquire(); }
template <class REF>
inline void
RCPtr<REF>::Release() const
    { if (pRef != 0) pRef->Release(); }

template <class REF>
inline
RCPtr<REF>::RCPtr( DYN REF * i_pObject )
    :   pRef(i_pObject) { Acquire(); }
template <class REF>
inline
RCPtr<REF>::RCPtr( const self & i_rOther )
    :   pRef(i_rOther.pRef) { Acquire(); }
template <class REF>
inline
RCPtr<REF>::~RCPtr()
    { Release(); }

template <class REF>
inline RCPtr<REF> &
RCPtr<REF>::operator=( const self & i_rOther )
    { i_rOther.Acquire(); Release(); pRef = i_rOther.pRef; }
template <class REF>
inline
RCPtr<REF>::operator bool() const
    { return pRef != 0; }

template <class REF>
inline const REF *
RCPtr<REF>::operator->() const
    { return pRef; }
template <class REF>
inline REF *
RCPtr<REF>::operator->()
    { return pRef; }

template <class REF>
inline const REF &
RCPtr<REF>::operator*() const
    { csv_assert(pRef != 0); return *pRef; }
template <class REF>
inline REF &
RCPtr<REF>::operator*()
    { csv_assert(pRef != 0); return *pRef; }

template <class REF>
inline const REF *
RCPtr<REF>::Ptr() const
    { return pRef; }
template <class REF>
inline REF *
RCPtr<REF>::Ptr()
    { return pRef; }
template <class REF>
inline REF *
RCPtr<REF>::MutablePtr() const
    { return const_cast< REF* >(pRef); }


}   // namespace csv


#endif

