Heed::PassivePtr< X > Class Template Reference

#include <AbsPtr.h>

Public Member Functions
X *	get (void) const
void	put (X *fptr)
	PassivePtr (void)
	PassivePtr (X *fptr)
	PassivePtr (X &fptr)
	PassivePtr (const PassivePtr< X > &f)
PassivePtr< X > &	operator= (const PassivePtr< X > &f)
PassivePtr< X > &	operator= (X *f)
template<class Y >
	PassivePtr (const PassivePtr< Y > &f)
void	move_pointer (PassivePtr< X > &f)
X *	operator-> (void) const
X &	operator* (void) const
X *	getver (void) const
long	get_total_number_of_references (void) const
void	print (std::ostream &file, int l=1) const
virtual PassivePtr *	copy () const
virtual	~PassivePtr ()

Friends
class	RegPassivePtr

Detailed Description

template<class X>
class Heed::PassivePtr< X >

Definition at line 833 of file AbsPtr.h.

Constructor & Destructor Documentation

PassivePtr() [1/5]

template<class X >

Heed::PassivePtr< X >::PassivePtr ( void  )

inline

Definition at line 869 of file AbsPtr.h.

      : cpp(NULL)
#ifdef USE_DOUBLE_PTR_IN_PASSIVEPTR
        ,
        ptr(NULL)
#endif
  {
  }

PassivePtr() [2/5]

template<class X >

Heed::PassivePtr< X >::PassivePtr ( X *  fptr )

inline

Definition at line 877 of file AbsPtr.h.

                             {
    if (fptr != NULL)
      cpp = fptr->book();
    else
      cpp = NULL;
#ifdef USE_DOUBLE_PTR_IN_PASSIVEPTR
    ptr = fptr;
#endif
  }

PassivePtr() [3/5]

template<class X >

Heed::PassivePtr< X >::PassivePtr ( X &  fptr )

inline

Definition at line 886 of file AbsPtr.h.

                             {
    cpp = fptr.book();
#ifdef USE_DOUBLE_PTR_IN_PASSIVEPTR
    ptr = &fptr;
#endif
  }

PassivePtr() [4/5]

template<class X >

Heed::PassivePtr< X >::PassivePtr ( const PassivePtr< X > &  f )

inline

Definition at line 1000 of file AbsPtr.h.

                                                       {
  if (f.cpp != NULL) {
    f.cpp->book();
    cpp = f.cpp;
  } else
    cpp = NULL;
#ifdef USE_DOUBLE_PTR_IN_PASSIVEPTR
  ptr = f.ptr;
#endif
}

PassivePtr() [5/5]

template<class X >

template<class Y >

Heed::PassivePtr< X >::PassivePtr

(

const PassivePtr< Y > &

f

)

Definition at line 931 of file AbsPtr.h.

    : cpp(NULL) {
  put((f.get()));
}

~PassivePtr()

template<class X >

Heed::PassivePtr< X >::~PassivePtr

virtual

Definition at line 1309 of file AbsPtr.h.

                           {
  if (cpp) {
#ifdef USE_DELETE_AT_ZERO_COUNT
    const RegPassivePtr* arptr;
    if ((arptr = cpp->get_rpp()) != NULL &&
#ifdef USE_PRIVATE_PARAM_IN_PASSIVEPTR
        arptr->get_s_allow_del_at_zero_count() == 1 &&
#else
        arptr->s_allow_del_at_zero_count == 1 &&
#endif
        cpp->get_number_of_booked() == 1)
      delete arptr;
#endif
    cpp->unbook();
    // mcout<<"PassivePtr<X>::~PassivePtr(): &ptr="<<&ptr<<" *ptr="<<*ptr<<'\n';
    if (cpp->get_rpp() == NULL && cpp->get_number_of_booked() == 0) {
      delete cpp;
      cpp = NULL;
    }
  }
}

Member Function Documentation

copy()

template<class X >

virtual PassivePtr * Heed::PassivePtr< X >::copy ( ) const

inlinevirtual

Definition at line 919 of file AbsPtr.h.

{ return new PassivePtr(*this); }

get()

template<class X >

X * Heed::PassivePtr< X >::get ( void  ) const

inline

Definition at line 837 of file AbsPtr.h.

                            {
    if (cpp == NULL) return NULL;
#ifdef USE_DOUBLE_PTR_IN_PASSIVEPTR
 
    if (cpp->get_rpp() == NULL) return NULL;
#ifdef USE_CHECK_DOUBLE_PTR_IN_PASSIVEPTR
    X* temp_ptr = dynamic_cast<X*>(const_cast<RegPassivePtr*>(cpp->get_rpp()));
    if (ptr != temp_ptr) {
      mcerr << "Error in inline X* PassivePtr::get(void):\n";
      mcerr << "ptr != temp_ptr\n";
      spexit(mcerr);
    }
#endif
    return ptr;
#else  // for ifdef USE_DOUBLE_PTR_IN_PASSIVEPTR
    else
      return (X*)(cpp->get_rpp());
#endif  // for ifdef USE_DOUBLE_PTR_IN_PASSIVEPTR
  }

Referenced by Heed::operator<(), Heed::operator<<(), Heed::PassivePtr< X >::operator=(), Heed::operator==(), and Heed::PassivePtr< X >::PassivePtr().

get_total_number_of_references()

template<class X >

long Heed::PassivePtr< X >::get_total_number_of_references ( void  ) const

inline

Definition at line 912 of file AbsPtr.h.

                                                  {
    if (cpp == NULL)
      return 0;
    else
      return cpp->get_number_of_booked();
  }

Referenced by Heed::operator<<().

getver()

template<class X >

X * Heed::PassivePtr< X >::getver ( void  ) const

inline

Definition at line 1181 of file AbsPtr.h.

                                          {
#ifdef USE_DOUBLE_PTR_IN_PASSIVEPTR
#ifdef SKIP_CHECKS_NULL
  return ptr;
#else
  if (cpp == NULL) {
    mcerr << "Error in X* PassivePtr<X>::getver(void) const: cpp == NULL\n";
    mcerr << "This means that the pointer is emtpy, "
          << "there is no addressed object.\n";
    mcerr << "Type of X is (in internal notations) " << typeid(X).name()
          << '\n';
    spexit(mcerr);
  }
  if (cpp->get_rpp() == NULL) {
    mcerr << "Error in X* PassivePtr<X>::getver(void) const: cpp->get_rpp() == "
             "NULL\n";
    mcerr << "This means that the pointer is emtpy, "
          << "there is no addressed object.\n";
    mcerr << "Type of X is (in internal notations) " << typeid(X).name()
          << '\n';
    spexit(mcerr);
  }
#ifdef USE_CHECK_DOUBLE_PTR_IN_PASSIVEPTR
  X* temp_ptr = dynamic_cast<X*>(const_cast<RegPassivePtr*>(cpp->get_rpp()));
  if (ptr != temp_ptr) {
    mcerr << "Error in inline X* PassivePtr::getver(void):\n";
    mcerr << "ptr != temp_ptr\n";
    spexit(mcerr);
  }
#endif
  return ptr;
#endif  // for ifdef SKIP_CHECKS_NULL
#else   // for ifdef USE_DOUBLE_PTR_IN_PASSIVEPTR
#ifdef SKIP_CHECKS_NULL
  const RegPassivePtr* rpp = cpp->get_rpp();
#else
  if (cpp == NULL) {
    mcerr << "Error in X* PassivePtr<X>::getver(void) const: cpp == NULL\n";
    mcerr << "This means that the pointer is emtpy, "
          << "there is no addressed object.\n";
    mcerr << "Type of X is (in internal notations) " << typeid(X).name()
          << '\n';
    spexit(mcerr);
  }
  const RegPassivePtr* rpp;
  if ((rpp = cpp->get_rpp()) == NULL) {
    mcerr << "Error in X* PassivePtr<X>::getver(void) const: cpp->get_rpp() == "
             "NULL\n";
    mcerr << "This means that the pointer is emtpy, "
          << "there is no addressed object.\n";
    mcerr << "Type of X is (in internal notations) " << typeid(X).name()
          << '\n';
    spexit(mcerr);
  }
#endif
  return (X*)(rpp);
#endif  // for ifdef USE_DOUBLE_PTR_IN_PASSIVEPTR
}

move_pointer()

template<class X >

void Heed::PassivePtr< X >::move_pointer ( PassivePtr< X > &  f )

inline

Definition at line 1023 of file AbsPtr.h.

                                                        {
  if (cpp != NULL) {
#ifdef USE_DELETE_AT_ZERO_COUNT
    const RegPassivePtr* arptr;
    if ((arptr = cpp->get_rpp()) != NULL &&
#ifdef USE_PRIVATE_PARAM_IN_PASSIVEPTR
        arptr->get_s_allow_del_at_zero_count() == 1 &&
#else
        arptr->s_allow_del_at_zero_count == 1 &&
#endif
        cpp->get_number_of_booked() == 1)
      delete arptr;
// fptr should not be part of old object!
#endif
    cpp->unbook();
    if (cpp->get_rpp() == NULL && cpp->get_number_of_booked() == 0) {
      delete cpp;
      cpp = NULL;
    }
  }
  cpp = f.cpp;
  if (cpp != NULL) cpp->book();
#ifdef USE_DOUBLE_PTR_IN_PASSIVEPTR
  ptr = f.ptr;
#endif
  f.put(NULL);
}

operator*()

template<class X >

X & Heed::PassivePtr< X >::operator* ( void  ) const

inline

Definition at line 1112 of file AbsPtr.h.

                                             {
#ifdef USE_DOUBLE_PTR_IN_PASSIVEPTR
#ifdef SKIP_CHECKS_NULL
  return *ptr;
#else
  if (cpp == NULL) {
    mcerr << "Error in X& PassivePtr<X>::operator*(void) const: cpp == NULL\n";
    mcerr << "This means that the pointer is emtpy, "
          << "there is no addressed object.\n";
    mcerr << "Type of X is (in internal notations) " << typeid(X).name()
          << '\n';
    spexit(mcerr);
  }
  if (cpp->get_rpp() == NULL) {
    mcerr << "Error in X& PassivePtr<X>::operator*(void) const: cpp->get_rpp() "
             "== NULL\n";
    mcerr << "This means that the pointer is emtpy, "
          << "there is no addressed object.\n";
    mcerr << "Type of X is (in internal notations) " << typeid(X).name()
          << '\n';
    spexit(mcerr);
  }
#ifdef USE_CHECK_DOUBLE_PTR_IN_PASSIVEPTR
  X* temp_ptr = dynamic_cast<X*>(const_cast<RegPassivePtr*>(cpp->get_rpp()));
  if (ptr != temp_ptr) {
    mcerr << "Error in inline X& PassivePtr::operator*(void):\n";
    mcerr << "ptr != temp_ptr\n";
    spexit(mcerr);
  }
#endif
  return *ptr;
#endif  // for ifdef SKIP_CHECKS_NULL
#else   // for ifdef USE_DOUBLE_PTR_IN_PASSIVEPTR
#ifdef SKIP_CHECKS_NULL
  static const RegPassivePtr* rpp = cpp->get_rpp();
#else
  if (cpp == NULL) {
    mcerr << "Error in X& PassivePtr<X>::operator*(void) const: cpp == NULL\n";
    mcerr << "This means that the pointer is emtpy, "
          << "there is no addressed object.\n";
    mcerr << "Type of X is (in internal notations) " << typeid(X).name()
          << '\n';
    spexit(mcerr);
  }
  static const RegPassivePtr* rpp;
  // I have put static here only to avoid
  // perhaps erroneous warning which appear
  // in compiler : gcc version egcs-2.91.66 19990314/Linux (egcs-1.1.2 release)
  // This is old compiler. At newer ones there is no problems.
  // The message is
  // AbsPtr.h:997: warning: reference to local variable `rpp' returned
  // This is in fact wrong statement, but so as not to make users thinking
  // about it, I made this variable static.
 
  if ((rpp = cpp->get_rpp()) == NULL) {
    mcerr << "Error in X& PassivePtr<X>::operator*(void) const: cpp->get_rpp() "
             "== NULL\n";
    mcerr << "This means that the pointer is emtpy, "
          << "there is no addressed object.\n";
    mcerr << "Type of X is (in internal notations) " << typeid(X).name()
          << '\n';
    spexit(mcerr);
  }
#endif
  return *((X*)(rpp));
#endif  // for ifdef USE_DOUBLE_PTR_IN_PASSIVEPTR
}

operator->()

template<class X >

X * Heed::PassivePtr< X >::operator-> ( void  ) const

inline

Definition at line 1052 of file AbsPtr.h.

                                              {
#ifdef USE_DOUBLE_PTR_IN_PASSIVEPTR
#ifdef SKIP_CHECKS_NULL
  return ptr;
#else
  if (cpp == NULL) {
    mcerr << "Error in X* PassivePtr<X>::operator->(void) const: cpp == NULL\n";
    mcerr << "This means that the pointer is emtpy, "
          << "there is no addressed object.\n";
    mcerr << "Type of X is (in internal notations) " << typeid(X).name()
          << '\n';
    spexit(mcerr);
  }
  if (cpp->get_rpp() == NULL) {
    mcerr << "Error in X* PassivePtr<X>::operator->(void) const: "
             "cpp->get_rpp() == NULL\n";
    mcerr << "This means that the pointer is emtpy, "
          << "there is no addressed object.\n";
    mcerr << "Type of X is (in internal notations) " << typeid(X).name()
          << '\n';
    spexit(mcerr);
  }
#ifdef USE_CHECK_DOUBLE_PTR_IN_PASSIVEPTR
  X* temp_ptr = dynamic_cast<X*>(const_cast<RegPassivePtr*>(cpp->get_rpp()));
  if (ptr != temp_ptr) {
    mcerr << "Error in inline X* PassivePtr::operator->(void):\n";
    mcerr << "ptr != temp_ptr\n";
    spexit(mcerr);
  }
#endif
  return ptr;
#endif  // for ifdef SKIP_CHECKS_NULL
#else   // for ifdef USE_DOUBLE_PTR_IN_PASSIVEPTR
#ifdef SKIP_CHECKS_NULL
  const RegPassivePtr* rpp = cpp->get_rpp();
#else
  if (cpp == NULL) {
    mcerr << "Error in X* PassivePtr<X>::operator->(void) const: cpp == NULL\n";
    mcerr << "This means that the pointer is emtpy, "
          << "there is no addressed object.\n";
    mcerr << "Type of X is (in internal notations) " << typeid(X).name()
          << '\n';
    spexit(mcerr);
  }
  const RegPassivePtr* rpp;
  if ((rpp = cpp->get_rpp()) == NULL) {
    mcerr << "Error in X* PassivePtr<X>::operator->(void) const: "
             "cpp->get_rpp() == NULL\n";
    mcerr << "This means that the pointer is emtpy, "
          << "there is no addressed object.\n";
    mcerr << "Type of X is (in internal notations) " << typeid(X).name()
          << '\n';
    spexit(mcerr);
  }
#endif
  return (X*)(rpp);
#endif  // for ifdef USE_DOUBLE_PTR_IN_PASSIVEPTR
}

operator=() [1/2]

template<class X >

PassivePtr< X > & Heed::PassivePtr< X >::operator= ( const PassivePtr< X > &  f )

inline

Definition at line 1011 of file AbsPtr.h.

                                                                     {
  if (this != &f) put(f.get());
  return *this;
}

operator=() [2/2]

template<class X >

PassivePtr< X > & Heed::PassivePtr< X >::operator= ( X *  f )

inline

Definition at line 1017 of file AbsPtr.h.

                                                   {
  put(f);
  return *this;
}

print()

template<class X >

void Heed::PassivePtr< X >::print	(	std::ostream &	file,
		int	l = 1
	)		const

Definition at line 937 of file AbsPtr.h.

                                                       {
  Ifile << "PassivePtr<X>:";
  if (get() == NULL)
    file << " pointer is NULL, no object, number of ref's is "
         << get_total_number_of_references() << "\n";
  else {
    file << noindent;
    get()->print(file, l);
    file << yesindent;
    indn.n += 2;
    Ifile << "number of ref's is " << get_total_number_of_references() << '\n';
    indn.n -= 2;
  }
}

put()

template<class X >

void Heed::PassivePtr< X >::put ( X *  fptr )

inline

Definition at line 970 of file AbsPtr.h.

                                      {
  // unregister old registered object and pass fptr to this.
  if (cpp != NULL) {
#ifdef USE_DELETE_AT_ZERO_COUNT
    const RegPassivePtr* arptr;
    if ((arptr = cpp->get_rpp()) != NULL &&
#ifdef USE_PRIVATE_PARAM_IN_PASSIVEPTR
        arptr->get_s_allow_del_at_zero_count() == 1 &&
#else
        arptr->s_allow_del_at_zero_count == 1 &&
#endif
        cpp->get_number_of_booked() == 1)
      delete arptr;
// fptr should not be part of old object!
#endif
    cpp->unbook();
    if (cpp->get_rpp() == NULL && cpp->get_number_of_booked() == 0)
      // there is no referred object and no other references
      delete cpp;
  }
  if (fptr != NULL)
    cpp = fptr->book();
  else
    cpp = NULL;
#ifdef USE_DOUBLE_PTR_IN_PASSIVEPTR
  ptr = fptr;
#endif
}

Referenced by Heed::PassivePtr< X >::move_pointer(), and Heed::PassivePtr< X >::PassivePtr().

Friends And Related Function Documentation

RegPassivePtr

template<class X >

friend class RegPassivePtr

friend

Definition at line 835 of file AbsPtr.h.

---

The documentation for this class was generated from the following file:

• AbsPtr.h