vtkSerializer.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 vtkSerializer_h
#define vtkSerializer_h

#include "vtkObject.h"

#include "vtkCommonCoreModule.h" // for export macro
#include "vtkLogger.h"           // for vtkLogger::Verbosity enum
#include "vtkMarshalContext.h"   // for vtkMarshalContext
#include "vtkSmartPointer.h"     // for vktSmartPointer

// clang-format off
#include "vtk_nlohmannjson.h"        // for json
#include VTK_NLOHMANN_JSON(json.hpp) // for json
// clang-format on

#include <memory>   // for unique_ptr
#include <typeinfo> // for type_info

VTK_ABI_NAMESPACE_BEGIN

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

  using HandlerType = std::function<nlohmann::json(vtkObjectBase*, vtkSerializer*)>;

  nlohmann::json SerializeJSON(vtkObjectBase* objectBase);


  void RegisterHandler(const std::type_info& type, HandlerType handler);
  HandlerType GetHandler(const std::type_info& type) const;
  bool UnRegisterHandler(const std::type_info& type);


  vtkSetSmartPointerMacro(Context, vtkMarshalContext);
  vtkGetSmartPointerMacro(Context, vtkMarshalContext);


  void SetSerializerLogVerbosity(vtkLogger::Verbosity verbosity);
  vtkLogger::Verbosity GetSerializerLogVerbosity();

protected:
  vtkSerializer();
  ~vtkSerializer() override;

  vtkSmartPointer<vtkMarshalContext> Context;
  vtkLogger::Verbosity SerializerLogVerbosity = vtkLogger::VERBOSITY_INVALID;

private:
  vtkSerializer(const vtkSerializer&) = delete;
  void operator=(const vtkSerializer&) = delete;
  class vtkInternals;
  std::unique_ptr<vtkInternals> Internals;
};
VTK_ABI_NAMESPACE_END
#endif