LeaLeakChecker Class Reference

#include <LeaLeakChecker.h>

List of all members.

Public Types
typedef std::map< std::string, LeaClassMonitor * >::iterator	MapItr
typedef std::map< std::string, LeaClassMonitor * >::const_iterator	MapConstItr
Public Member Functions
virtual	~LeaLeakChecker ()
LeaClassMonitor *	GetExistingMonitor (const Char_t *name) const
UInt_t	GetNumActive (const Char_t *name=0) const
UInt_t	GetNumCreated (const Char_t *name=0) const
std::ostream &	Print (std::ostream &os)
Bool_t	Add (const Char_t *name, const void *addr)
LeaClassMonitor *	GetMonitor (const Char_t *name)
void	Reset (const Char_t *name=0)
Bool_t	Remove (const Char_t *name, const void *addr)
Static Public Member Functions
static LeaLeakChecker *	Instance ()
Private Member Functions
	LeaLeakChecker ()
Private Attributes
std::map< std::string, LeaClassMonitor * >	fMonitors
Static Private Attributes
static LeaLeakChecker *	fgInstance = 0
Friends
struct	Cleaner
Classes
struct	Cleaner

---

Detailed Description

Definition at line 33 of file LeaLeakChecker.h.

---

Member Typedef Documentation

typedef std::map<std::string,LeaClassMonitor*>::const_iterator LeaLeakChecker::MapConstItr

Definition at line 39 of file LeaLeakChecker.h.

typedef std::map<std::string,LeaClassMonitor*>::iterator LeaLeakChecker::MapItr

Definition at line 38 of file LeaLeakChecker.h.

---

Constructor & Destructor Documentation

LeaLeakChecker::~LeaLeakChecker

(

)

[virtual]

Definition at line 318 of file LeaLeakChecker.cxx.

References fgInstance, and fMonitors.

                                {


//  Purpose:  Destructor.

//  Arguments: 
//    None.

//  Return:   n/a

//  Contact:   N. West

//  Specification:-
//  =============

//  o Destroy LeaLeakChecker.

//  Program Notes:-
//  =============

//  None.

  cout << "LeakChecker shutting down ..." << endl;
   for ( MapItr itr = fMonitors.begin();
         itr != fMonitors.end();
         itr++) {
     LeaClassMonitor* mon = (*itr).second;
     delete mon;
   }
  cout << "LeakChecker shutdown complete." << endl;
  LeaLeakChecker::fgInstance = 0;
   
}

LeaLeakChecker::LeaLeakChecker

(

)

[private]

Definition at line 290 of file LeaLeakChecker.cxx.

References Msg::kDebug, and MSG.

Referenced by Instance().

                               {


//  Purpose:  Default constructor.

//  Arguments: 
//    None.

//  Return:   n/a

//  Contact:   N. West

//  Specification:-
//  =============

//  o Create LeaLeakChecker.

//  Program Notes:-
//  =============

//  None.

   MSG("Lea", Msg::kDebug) << "Creating LeaLeakChecker at "
                          << reinterpret_cast<void*>(this) << endl;

}

---

Member Function Documentation

Bool_t LeaLeakChecker::Add	(	const Char_t *	name,
		const void *	addr
	)

Definition at line 45 of file LeaLeakChecker.cxx.

                                                               {


//  Purpose:  Add named object to class monitor.

//  Arguments: 
//    name         in    String containing class name (can be file name).
//    addr         in    Address of object.

//  Return:    kTRUE always (reserved for future use).

//  Contact:   N. West

//  Specification:-
//  =============

//  o Get monitor for class and record object creation.

//  Program Notes:-
//  =============

//  None.

  return GetMonitor(name)->Add(addr);

}

LeaClassMonitor * LeaLeakChecker::GetExistingMonitor

(

const Char_t *

name

)

const

Definition at line 75 of file LeaLeakChecker.cxx.

References fMonitors.

Referenced by GetNumActive(), GetNumCreated(), and Reset().

                                                            {


//  Purpose:  Return monitor for this existing class.

//  Arguments: 
//    name         in    class name.

//  Return:    Class Monitor addr, or 0 if none.

//  Contact:   N. West

//  Specification:-
//  =============

//  o  Return the LeaClassMonitor for this class if any.

//  Program Notes:-
//  =============

//  None.


  std::string className = name;

//  Locate the associated class monitor.
  MapConstItr element = fMonitors.find(className);
  return ( element != fMonitors.end() ) ? (*element).second : 0;

}

LeaClassMonitor * LeaLeakChecker::GetMonitor

(

const Char_t *

name

)

Definition at line 108 of file LeaLeakChecker.cxx.

References fMonitors, Msg::kDebug, MSG, and LeaClassMonitor::SetName().

Referenced by Remove().

                                                              {


//  Purpose:  Return monitor for this class, creating if necessary

//  Arguments: 
//    name         in    class name or file name.

//  Return:    Class Monitor add.

//  Contact:   N. West

//  Specification:-
//  =============

//  o  Determine the class name if necessary from the file name.

//  o  Return, creating if necessary and required, the LeaClassMonitor
//     for this class.

//  Program Notes:-
//  =============

//  None.

//  Determine the class name from the file name by removing 
//  leading directory and any trailing extension.

  std::string className = name;
  if ( className.find(".") < className.size() ) {
    UInt_t locSlash = className.rfind("/");
    if ( locSlash < className.size() ) className.erase(0,locSlash+1);
    className.erase(className.find("."),className.size());
  }


//  Locate the associated class monitor and set its name if new.
  LeaClassMonitor* mon = fMonitors[className];
  if ( ! mon ) {
    mon = new LeaClassMonitor;
    fMonitors[className] = mon;
    mon->SetName(className.c_str());
  }

  MSG("Lea", Msg::kDebug) << "ClassMonitor: "
                         << className.c_str() << " found at "
                         << reinterpret_cast<void*> (mon)
                         << " set size " << fMonitors.size() << endl;
   
  return mon;
   

}

UInt_t LeaLeakChecker::GetNumActive

(

const Char_t *

name = 0

)

const

Definition at line 164 of file LeaLeakChecker.cxx.

References fMonitors, GetExistingMonitor(), and LeaClassMonitor::GetNumActive().

Referenced by NavValidate::RunAllTests(), and LeaValidate::Test_1().

                                                           {


//  Purpose:  Return the number of active objects of one or all
//            classes.

//  Arguments: 
//    name         in    Class name string or 0 (default) all classes.

//  Return:   Return the number of active objects of one or all
//            classes. 

//  Contact:   N. West

//  Specification:-
//  =============

//  o  Return the number of active objects of one or all classes.

//  Program Notes:-
//  =============

//  None.

//  If name supplied, just use, but don't create, it.

  if ( name ) {
    LeaClassMonitor* mon = GetExistingMonitor(name);
    return mon ? mon->GetNumActive() : 0;
  }

//  No name supplied, use all classs

  UInt_t num = 0;
  for ( MapConstItr itr = fMonitors.begin();
        itr != fMonitors.end();
        itr++) num += (*itr).second->GetNumActive();
  return num;

}

UInt_t LeaLeakChecker::GetNumCreated

(

const Char_t *

name = 0

)

const

Definition at line 206 of file LeaLeakChecker.cxx.

References fMonitors, GetExistingMonitor(), and LeaClassMonitor::GetNumCreated().

Referenced by NavValidate::RunAllTests(), and LeaValidate::Test_1().

                                                             {


//  Purpose:  Return the number of created objects of one or all
//            classes.

//  Arguments: 
//    name         in    Class name string or 0 (default) all classes.

//  Return:   Return the number of created objects of one or all
//            classes. 

//  Contact:   N. West

//  Specification:-
//  =============

//  o  Return the number of created objects of one or all classes.

//  Program Notes:-
//  =============

//  None.

//  If name supplied, just use, but don't create, it.

  if ( name ) {
    LeaClassMonitor* mon = GetExistingMonitor(name);
    return mon ? mon->GetNumCreated() : 0;
  }

//  No name supplied, use all classs

  UInt_t num = 0;
  for ( MapConstItr itr = fMonitors.begin();
        itr != fMonitors.end();
        itr++)  num += (*itr).second->GetNumCreated();
  return num;

}

LeaLeakChecker * LeaLeakChecker::Instance

(

)

[static]

Definition at line 248 of file LeaLeakChecker.cxx.

References LeaLeakChecker::Cleaner::ClassIsUsed(), fgInstance, Msg::kWarning, LeaLeakChecker(), and MSG.

Referenced by DbmModule::CheckMemory(), NavValidate::RunAllTests(), and LeaValidate::Test_1().

                                         {


//  Purpose:  Return a pointer to the sole instance of the LeaLeakChecker. 

//  Arguments: 
//   None

//  Return:  A pointer to the LeaLeakChecker. 

//  Contact:   N. West

//  Specification:-
//  =============

//  o Return a pointer to the sole instance of the LeaLeakChecker. 

//  Program Notes:-
//  =============

//  None.

  if ( ! fgInstance ) {

//  Helper class to handle delete
    static LeaLeakChecker::Cleaner c;
    c.ClassIsUsed();

    fgInstance = new LeaLeakChecker();

    MSG("Lea",Msg::kWarning) << "\n\n\n"
     << " WARNING:  The LeakChecker package has been activated.\n"
     << " *******   This can seriously degrade performance and should\n"
     << "           only be used for development and never production !!!\n\n\n";

  }

  return fgInstance;

}

std::ostream& LeaLeakChecker::Print

(

std::ostream &

os

)

Referenced by operator<<().

Bool_t LeaLeakChecker::Remove	(	const Char_t *	name,
		const void *	addr
	)

Definition at line 434 of file LeaLeakChecker.cxx.

References GetMonitor(), and LeaClassMonitor::Remove().

                                                                  {


//  Purpose:  Remove named object to class monitor.

//  Arguments: 
//    name         in    String containing class name (can be file name).
//    addr         in    Address of object.

//  Return:    kTRUE always (reserved for future use).

//  Contact:   N. West

//  Specification:-
//  =============

//  o Get monitor for class and record object destruction.

//  Program Notes:-
//  =============

//  None.

  return GetMonitor(name)->Remove(addr);

}

void LeaLeakChecker::Reset

(

const Char_t *

name = 0

)

Definition at line 395 of file LeaLeakChecker.cxx.

References fMonitors, GetExistingMonitor(), and LeaClassMonitor::Reset().

Referenced by NavValidate::RunAllTests(), and LeaValidate::Test_1().

                                             {


//  Purpose:  Clear the number of objects of one or all classes.

//  Arguments: 
//    name         in    Class name string or 0 (default) all classes.

//  Return:   None. 

//  Contact:   N. West

//  Specification:-
//  =============

//  o  Reseet the number of objects of one or all classes.

//  Program Notes:-
//  =============

//  None.

//  If name supplied, just use, but don't create, it.

  if ( name ) {
    LeaClassMonitor* mon = GetExistingMonitor(name);
    if ( mon ) mon->Reset();
  }

//  No name supplied, use all classs

  for ( MapConstItr itr = fMonitors.begin();
        itr != fMonitors.end();
        itr++) (*itr).second->Reset();

}

---

Friends And Related Function Documentation

friend struct Cleaner [friend]

Definition at line 70 of file LeaLeakChecker.h.

---

Member Data Documentation

LeaLeakChecker * LeaLeakChecker::fgInstance = 0 [static, private]

Definition at line 78 of file LeaLeakChecker.h.

Referenced by Instance(), LeaLeakChecker::Cleaner::~Cleaner(), and ~LeaLeakChecker().

std::map<std::string,LeaClassMonitor*> LeaLeakChecker::fMonitors [private]

Definition at line 76 of file LeaLeakChecker.h.

Referenced by GetExistingMonitor(), GetMonitor(), GetNumActive(), GetNumCreated(), Reset(), and ~LeaLeakChecker().

---

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

• LeaLeakChecker.h
• LeaLeakChecker.cxx

---