1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
|
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
/**
* @class vtkFilteringInformationKeyManager
* @brief Manages key types in vtkFiltering.
*
* vtkFilteringInformationKeyManager is included in the header of any
* subclass of vtkInformationKey defined in the vtkFiltering library.
* It makes sure that the table of keys is created before and
* destroyed after it is used.
*/
#ifndef vtkFilteringInformationKeyManager_h
#define vtkFilteringInformationKeyManager_h
#include "vtkCommonExecutionModelModule.h" // For export macro
#include "vtkSystemIncludes.h"
#include "vtkDebugLeaksManager.h" // DebugLeaks exists longer than info keys.
#include <token/Singletons.h> // to increment its Schwarz counter
#include <functional> // for finalizers
#include <vector> // for finalizers
VTK_ABI_NAMESPACE_BEGIN
class vtkInformationKey;
class VTKCOMMONEXECUTIONMODEL_EXPORT vtkFilteringInformationKeyManager
{
public:
vtkFilteringInformationKeyManager();
~vtkFilteringInformationKeyManager();
/**
* Called by constructors of vtkInformationKey subclasses defined in
* vtkFiltering to register themselves with the manager. The
* instances will be deleted when vtkFiltering is unloaded on
* program exit.
*/
static void Register(vtkInformationKey* key);
/// Ensure that \a finalizer is invoked before ClassFinalizer() runs.
///
/// If your application holds VTK objects (i.e., instances of classes that inherit
/// vtkObjectBase) for its duration, then adding \a finalizer function that frees
/// them will prevent this class's static ClassFinalizer() method from freeing
/// keys that may be in use.
static void AddFinalizer(std::function<void()> finalizer);
private:
// Unimplemented
vtkFilteringInformationKeyManager(const vtkFilteringInformationKeyManager&) = delete;
vtkFilteringInformationKeyManager& operator=(const vtkFilteringInformationKeyManager&) = delete;
static void ClassInitialize();
static void ClassFinalize();
static std::vector<std::function<void()>>* Finalizers;
};
// This instance will show up in any translation unit that uses key
// types defined in vtkFiltering or that has a singleton. It will
// make sure vtkFilteringInformationKeyManager's vector of keys is
// initialized before and destroyed after it is used.
static vtkFilteringInformationKeyManager vtkFilteringInformationKeyManagerInstance;
VTK_ABI_NAMESPACE_END
#endif
// VTK-HeaderTest-Exclude: vtkFilteringInformationKeyManager.h
|