vtkDebugLeaks.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkDebugLeaks_h
#define vtkDebugLeaks_h

#include "vtkCommonCoreModule.h" // For export macro
#include "vtkObject.h"

#include "vtkDebug.h"             // Needed for VTK_DEBUG_LEAKS macro setting.
#include "vtkDebugLeaksManager.h" // Needed for proper singleton initialization

#include <functional> // for finalizers
#include <mutex>      // for std::mutex
#include <vector>     // for finalizers

VTK_ABI_NAMESPACE_BEGIN
class vtkDebugLeaksHashTable;
class vtkDebugLeaksTraceManager;
class vtkDebugLeaksObserver;

class VTKCOMMONCORE_EXPORT vtkDebugLeaks : public vtkObject
{
public:
  static vtkDebugLeaks* New();
  vtkTypeMacro(vtkDebugLeaks, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static void ConstructClass(vtkObjectBase* object);

  static void ConstructClass(const char* className);

  static void DestructClass(vtkObjectBase* object);

  static void DestructClass(const char* className);

  static int PrintCurrentLeaks();


  static int GetExitError();
  static void SetExitError(int);

  static void SetDebugLeaksObserver(vtkDebugLeaksObserver* observer);
  static vtkDebugLeaksObserver* GetDebugLeaksObserver();

  static void AddFinalizer(std::function<void()> finalizer);

protected:
  vtkDebugLeaks() = default;
  ~vtkDebugLeaks() override = default;

  static int DisplayMessageBox(const char*);

  static void ClassInitialize();
  static void ClassFinalize();

  static void ConstructingObject(vtkObjectBase* object);
  static void DestructingObject(vtkObjectBase* object);

  static std::vector<std::function<void()>>* Finalizers;

  friend class vtkDebugLeaksManager;
  friend class vtkObjectBase;

private:
  static vtkDebugLeaksHashTable* MemoryTable;
  static vtkDebugLeaksTraceManager* TraceManager;
  static std::mutex* CriticalSection;
  static vtkDebugLeaksObserver* Observer;
  static int ExitError;

  vtkDebugLeaks(const vtkDebugLeaks&) = delete;
  void operator=(const vtkDebugLeaks&) = delete;
};

// This class defines callbacks for debugging tools. The callbacks are not for general use.
// The objects passed as arguments to the callbacks are in partially constructed or destructed
// state and accessing them may cause undefined behavior.
class VTKCOMMONCORE_EXPORT vtkDebugLeaksObserver
{
public:
  virtual ~vtkDebugLeaksObserver() = default;
  virtual void ConstructingObject(vtkObjectBase*) = 0;
  virtual void DestructingObject(vtkObjectBase*) = 0;
};

VTK_ABI_NAMESPACE_END
#endif // vtkDebugLeaks_h