vtkGarbageCollector.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkGarbageCollector.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
#ifndef vtkGarbageCollector_h
#define vtkGarbageCollector_h
 
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkObject.h"
#include "vtkGarbageCollectorManager.h" // Needed for singleton initialization.
 
// This function is a friend of the collector so that it can call the
// internal report method.
void VTKCOMMONCORE_EXPORT
vtkGarbageCollectorReportInternal(vtkGarbageCollector*,
                                  vtkObjectBase*, void*,
                                  const char*);
 
// This allows vtkObjectBase to get at the methods it needs.
class vtkObjectBaseToGarbageCollectorFriendship;
 
class VTKCOMMONCORE_EXPORT vtkGarbageCollector : public vtkObject
{
public:
  vtkTypeMacro(vtkGarbageCollector,vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent);
  static vtkGarbageCollector* New();
 
  static void Collect();
 
  static void Collect(vtkObjectBase* root);
 
 
  static void DeferredCollectionPush();
  static void DeferredCollectionPop();
 
 
  static void SetGlobalDebugFlag(bool flag);
  static bool GetGlobalDebugFlag();
 
protected:
  vtkGarbageCollector();
  ~vtkGarbageCollector();
 
private:
 
  static int GiveReference(vtkObjectBase* obj);
 
  static int TakeReference(vtkObjectBase* obj);
 
  // Singleton management functions.
  static void ClassInitialize();
  static void ClassFinalize();
 
  //BTX
  friend class vtkGarbageCollectorManager;
  friend class vtkObjectBaseToGarbageCollectorFriendship;
  //ETX
 
  // Internal report callback and friend function that calls it.
  virtual void Report(vtkObjectBase* obj, void* ptr, const char* desc);
  friend void VTKCOMMONCORE_EXPORT
  vtkGarbageCollectorReportInternal(vtkGarbageCollector*,
                                    vtkObjectBase*, void*,
                                    const char*);
 
private:
  vtkGarbageCollector(const vtkGarbageCollector&);  // Not implemented.
  void operator=(const vtkGarbageCollector&);  // Not implemented.
};
 
//BTX
class vtkSmartPointerBase;
 
 
void VTKCOMMONCORE_EXPORT
vtkGarbageCollectorReport(vtkGarbageCollector* collector,
                          vtkSmartPointerBase& ptr,
                          const char* desc);
 
 
template <class T>
void vtkGarbageCollectorReport(vtkGarbageCollector* collector, T*& ptr,
                               const char* desc)
{
  vtkGarbageCollectorReportInternal(collector, ptr, &ptr, desc);
}
//ETX
 
#endif
// VTK-HeaderTest-Exclude: vtkGarbageCollector.h