vtkSession.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 vtkSession_h
#define vtkSession_h

#include <stddef.h>
#include <stdint.h>

#include "vtkABINamespace.h"

#include "vtkSerializationManagerModule.h" // for export macro

typedef uint32_t vtkObjectHandle;
typedef int vtkSessionResult;

// Forward declarations
// Opaque type representing the session implementation. See vtkSession.cxx for
// details.
typedef struct vtkSessionImpl* vtkSession;
// Opaque type representing the JSON implementation. This must be
// implemented by callers of this API.
// Look in vtkWebAssemblySessionHelper.h for an example implementation
// that supports JavaScript JSON.
typedef struct vtkSessionJsonImpl* vtkSessionJson;

// Registration function type for object manager extensions.
typedef int (*vtkSessionObjectManagerRegistrarFunc)(
  void* ser, void* deser, void* invoker, const char** error);
// JSON parsing function used to prepare a vtkSessionJson object from a JSON string.
typedef vtkSessionJson (*vtkSessionJsonParseFunc)(const char*);
// JSON stringification function used to convert a vtkSessionJson object to a JSON string.
// The caller is responsible for freeing the returned string using free() or delete[].
typedef char* (*vtkSessionJsonStringifyFunc)(vtkSessionJson);
// Callback function type for session observers.
typedef void (*vtkSessionObserverCallbackFunc)(vtkObjectHandle, const char*);

// Session descriptor structure used to initialize a session.
// It contains function pointers for JSON parsing and stringification, as well as options for event
// loop management.
typedef struct vtkSessionDescriptor
{
  vtkSessionJsonParseFunc ParseJson;
  vtkSessionJsonStringifyFunc StringifyJson;
  int InteractorManagesTheEventLoop;
} vtkSessionDescriptor;

#define vtkSessionResultSuccess 1
#define vtkSessionResultFailure 0

// clang-format off
#define vtkCreateSession VTK_ABI_NAMESPACE_MANGLE(vtkCreateSession)
#define vtkFreeSession VTK_ABI_NAMESPACE_MANGLE(vtkFreeSession)
#define vtkSessionInitializeObjectManager VTK_ABI_NAMESPACE_MANGLE(vtkSessionInitializeObjectManager)
#define vtkSessionInitializeObjectManagerExtensionHandlers VTK_ABI_NAMESPACE_MANGLE(vtkSessionInitializeObjectManagerExtensionHandlers)
#define vtkSessionGetManager VTK_ABI_NAMESPACE_MANGLE(vtkSessionGetManager)
#define vtkSessionCreateObject VTK_ABI_NAMESPACE_MANGLE(vtkSessionCreateObject)
#define vtkSessionDestroyObject VTK_ABI_NAMESPACE_MANGLE(vtkSessionDestroyObject)
#define vtkSessionRegisterState VTK_ABI_NAMESPACE_MANGLE(vtkSessionRegisterState)
#define vtkSessionUnRegisterState VTK_ABI_NAMESPACE_MANGLE(vtkSessionUnRegisterState)
#define vtkSessionGetState VTK_ABI_NAMESPACE_MANGLE(vtkSessionGetState)
#define vtkSessionSkipProperty VTK_ABI_NAMESPACE_MANGLE(vtkSessionSkipProperty)
#define vtkSessionUnSkipProperty VTK_ABI_NAMESPACE_MANGLE(vtkSessionUnSkipProperty)
#define vtkSessionRegisterBlob VTK_ABI_NAMESPACE_MANGLE(vtkSessionRegisterBlob)
#define vtkSessionUnRegisterBlob VTK_ABI_NAMESPACE_MANGLE(vtkSessionUnRegisterBlob)
#define vtkSessionGetBlob VTK_ABI_NAMESPACE_MANGLE(vtkSessionGetBlob)
#define vtkSessionPruneUnusedBlobs VTK_ABI_NAMESPACE_MANGLE(vtkSessionPruneUnusedBlobs)
#define vtkSessionPruneUnusedObjects VTK_ABI_NAMESPACE_MANGLE(vtkSessionPruneUnusedObjects)
#define vtkSessionPruneUnusedStates VTK_ABI_NAMESPACE_MANGLE(vtkSessionPruneUnusedStates)
#define vtkSessionClear VTK_ABI_NAMESPACE_MANGLE(vtkSessionClear)
#define vtkSessionInvoke VTK_ABI_NAMESPACE_MANGLE(vtkSessionInvoke)
#define vtkSessionGetAllDependencies VTK_ABI_NAMESPACE_MANGLE(vtkSessionGetAllDependencies)
#define vtkSessionFreeGetAllDependenciesResult VTK_ABI_NAMESPACE_MANGLE(vtkSessionFreeGetAllDependenciesResult)
#define vtkSessionGetTotalBlobMemoryUsage VTK_ABI_NAMESPACE_MANGLE(vtkSessionGetTotalBlobMemoryUsage)
#define vtkSessionGetTotalVTKDataObjectMemoryUsage VTK_ABI_NAMESPACE_MANGLE(vtkSessionGetTotalVTKDataObjectMemoryUsage)
#define vtkSessionUpdateObjectsFromStates VTK_ABI_NAMESPACE_MANGLE(vtkSessionUpdateObjectsFromStates)
#define vtkSessionUpdateStatesFromObjects VTK_ABI_NAMESPACE_MANGLE(vtkSessionUpdateStatesFromObjects)
#define vtkSessionUpdateObjectFromState VTK_ABI_NAMESPACE_MANGLE(vtkSessionUpdateObjectFromState)
#define vtkSessionUpdateStateFromObject VTK_ABI_NAMESPACE_MANGLE(vtkSessionUpdateStateFromObject)
#define vtkSessionSetSize VTK_ABI_NAMESPACE_MANGLE(vtkSessionSetSize)
#define vtkSessionRender VTK_ABI_NAMESPACE_MANGLE(vtkSessionRender)
#define vtkSessionResetCamera VTK_ABI_NAMESPACE_MANGLE(vtkSessionResetCamera)
#define vtkSessionStartWebXR VTK_ABI_NAMESPACE_MANGLE(vtkSessionStartWebXR)
#define vtkSessionStopWebXR VTK_ABI_NAMESPACE_MANGLE(vtkSessionStopWebXR)
#define vtkSessionStartEventLoop VTK_ABI_NAMESPACE_MANGLE(vtkSessionStartEventLoop)
#define vtkSessionStopEventLoop VTK_ABI_NAMESPACE_MANGLE(vtkSessionStopEventLoop)
#define vtkSessionAddObserver VTK_ABI_NAMESPACE_MANGLE(vtkSessionAddObserver)
#define vtkSessionRemoveObserver VTK_ABI_NAMESPACE_MANGLE(vtkSessionRemoveObserver)
#define vtkSessionRemoveAllObservers VTK_ABI_NAMESPACE_MANGLE(vtkSessionRemoveAllObservers)
#define vtkSessionRemoveAllObserversFromAllObjects VTK_ABI_NAMESPACE_MANGLE(vtkSessionRemoveAllObserversFromAllObjects)
#define vtkSessionImport VTK_ABI_NAMESPACE_MANGLE(vtkSessionImport)
#define vtkSessionExport VTK_ABI_NAMESPACE_MANGLE(vtkSessionExport)
#define vtkSessionPrintObjectToString VTK_ABI_NAMESPACE_MANGLE(vtkSessionPrintObjectToString)
#define vtkSessionPrintSceneManagerInformation VTK_ABI_NAMESPACE_MANGLE(vtkSessionPrintSceneManagerInformation)
#define vtkSessionSetDeserializerLogVerbosity VTK_ABI_NAMESPACE_MANGLE(vtkSessionSetDeserializerLogVerbosity)
#define vtkSessionSetInvokerLogVerbosity VTK_ABI_NAMESPACE_MANGLE(vtkSessionSetInvokerLogVerbosity)
#define vtkSessionSetObjectManagerLogVerbosity VTK_ABI_NAMESPACE_MANGLE(vtkSessionSetObjectManagerLogVerbosity)
#define vtkSessionSetSerializerLogVerbosity VTK_ABI_NAMESPACE_MANGLE(vtkSessionSetSerializerLogVerbosity)
// clang-format on

#ifdef __cplusplus
extern "C"
#endif
{
  VTKSERIALIZATIONMANAGER_EXPORT vtkSession vtkCreateSession(
    const vtkSessionDescriptor* descriptor);

  VTKSERIALIZATIONMANAGER_EXPORT void vtkFreeSession(vtkSession session);

  VTKSERIALIZATIONMANAGER_EXPORT vtkSessionResult vtkSessionInitializeObjectManager(
    vtkSession session);

  VTKSERIALIZATIONMANAGER_EXPORT vtkSessionResult
  vtkSessionInitializeObjectManagerExtensionHandlers(
    vtkSession session, const vtkSessionObjectManagerRegistrarFunc* registrars, size_t count);

  VTKSERIALIZATIONMANAGER_EXPORT void* vtkSessionGetManager(vtkSession session);

  VTKSERIALIZATIONMANAGER_EXPORT vtkObjectHandle vtkSessionCreateObject(
    vtkSession session, const char* className);

  VTKSERIALIZATIONMANAGER_EXPORT vtkSessionResult vtkSessionDestroyObject(
    vtkSession session, vtkObjectHandle object);

  VTKSERIALIZATIONMANAGER_EXPORT vtkSessionResult vtkSessionRegisterState(
    vtkSession session, vtkSessionJson state);

  VTKSERIALIZATIONMANAGER_EXPORT vtkSessionResult vtkSessionUnRegisterState(
    vtkSession session, vtkObjectHandle object);

  VTKSERIALIZATIONMANAGER_EXPORT vtkSessionJson vtkSessionGetState(
    vtkSession session, vtkObjectHandle object);

  VTKSERIALIZATIONMANAGER_EXPORT void vtkSessionSkipProperty(
    vtkSession session, const char* className, const char* propertyName);

  VTKSERIALIZATIONMANAGER_EXPORT void vtkSessionUnSkipProperty(
    vtkSession session, const char* className, const char* propertyName);

  VTKSERIALIZATIONMANAGER_EXPORT vtkSessionResult vtkSessionRegisterBlob(
    vtkSession session, const char* hash, uint8_t* blob, size_t length);

  VTKSERIALIZATIONMANAGER_EXPORT vtkSessionResult vtkSessionUnRegisterBlob(
    vtkSession session, const char* hash);

  VTKSERIALIZATIONMANAGER_EXPORT uint8_t* vtkSessionGetBlob(
    vtkSession session, const char* hash, size_t* length);

  VTKSERIALIZATIONMANAGER_EXPORT vtkSessionJson vtkSessionInvoke(
    vtkSession session, vtkObjectHandle object, const char* methodName, vtkSessionJson args);

  VTKSERIALIZATIONMANAGER_EXPORT vtkObjectHandle* vtkSessionGetAllDependencies(
    vtkSession session, vtkObjectHandle object, size_t* count);

  VTKSERIALIZATIONMANAGER_EXPORT void vtkSessionFreeGetAllDependenciesResult(
    vtkSession session, vtkObjectHandle* ptr);

  VTKSERIALIZATIONMANAGER_EXPORT vtkSessionResult vtkSessionUpdateObjectFromState(
    vtkSession session, vtkSessionJson state);

  VTKSERIALIZATIONMANAGER_EXPORT void vtkSessionUpdateStateFromObject(
    vtkSession session, vtkObjectHandle object);

  VTKSERIALIZATIONMANAGER_EXPORT vtkSessionResult vtkSessionSetSize(
    vtkSession session, vtkObjectHandle object, int width, int height);

  VTKSERIALIZATIONMANAGER_EXPORT vtkSessionResult vtkSessionRender(
    vtkSession session, vtkObjectHandle object);

  VTKSERIALIZATIONMANAGER_EXPORT vtkSessionResult vtkSessionResetCamera(
    vtkSession session, vtkObjectHandle object);

  VTKSERIALIZATIONMANAGER_EXPORT vtkSessionResult vtkSessionStartWebXR(
    uint8_t mode, uint32_t requiredFeatures, uint32_t optionalFeatures);

  VTKSERIALIZATIONMANAGER_EXPORT vtkSessionResult vtkSessionStopWebXR();

  VTKSERIALIZATIONMANAGER_EXPORT vtkSessionResult vtkSessionStartEventLoop(
    vtkSession session, vtkObjectHandle object);

  VTKSERIALIZATIONMANAGER_EXPORT vtkSessionResult vtkSessionStopEventLoop(
    vtkSession session, vtkObjectHandle object);

  VTKSERIALIZATIONMANAGER_EXPORT unsigned long vtkSessionAddObserver(vtkSession session,
    vtkObjectHandle object, const char* eventName, vtkSessionObserverCallbackFunc callback);

  VTKSERIALIZATIONMANAGER_EXPORT vtkSessionResult vtkSessionRemoveObserver(
    vtkSession session, vtkObjectHandle object, unsigned long tag);

  VTKSERIALIZATIONMANAGER_EXPORT vtkSessionResult vtkSessionRemoveAllObservers(
    vtkSession session, vtkObjectHandle object);

  VTKSERIALIZATIONMANAGER_EXPORT void vtkSessionRemoveAllObserversFromAllObjects(
    vtkSession session);

  VTKSERIALIZATIONMANAGER_EXPORT void vtkSessionExport(vtkSession session, const char* fileName);

  VTKSERIALIZATIONMANAGER_EXPORT void vtkSessionImport(
    vtkSession session, const char* stateFileName, const char* blobFileName);

  VTKSERIALIZATIONMANAGER_EXPORT void vtkSessionUpdateObjectsFromStates(vtkSession session);

  VTKSERIALIZATIONMANAGER_EXPORT void vtkSessionUpdateStatesFromObjects(vtkSession session);

  VTKSERIALIZATIONMANAGER_EXPORT void vtkSessionPruneUnusedBlobs(vtkSession session);

  VTKSERIALIZATIONMANAGER_EXPORT void vtkSessionPruneUnusedObjects(vtkSession session);

  VTKSERIALIZATIONMANAGER_EXPORT void vtkSessionPruneUnusedStates(vtkSession session);

  VTKSERIALIZATIONMANAGER_EXPORT void vtkSessionClear(vtkSession session);

  VTKSERIALIZATIONMANAGER_EXPORT size_t vtkSessionGetTotalBlobMemoryUsage(vtkSession session);

  VTKSERIALIZATIONMANAGER_EXPORT size_t vtkSessionGetTotalVTKDataObjectMemoryUsage(
    vtkSession session);

  VTKSERIALIZATIONMANAGER_EXPORT char* vtkSessionPrintObjectToString(
    vtkSession session, vtkObjectHandle object);

  VTKSERIALIZATIONMANAGER_EXPORT void vtkSessionPrintSceneManagerInformation(vtkSession session);

  VTKSERIALIZATIONMANAGER_EXPORT void vtkSessionSetDeserializerLogVerbosity(
    vtkSession session, const char* verbosityStr);

  VTKSERIALIZATIONMANAGER_EXPORT void vtkSessionSetInvokerLogVerbosity(
    vtkSession session, const char* verbosityStr);

  VTKSERIALIZATIONMANAGER_EXPORT void vtkSessionSetObjectManagerLogVerbosity(
    vtkSession session, const char* verbosityStr);

  VTKSERIALIZATIONMANAGER_EXPORT void vtkSessionSetSerializerLogVerbosity(
    vtkSession session, const char* verbosityStr);
#ifdef __cplusplus
} // extern "C"
#endif

#endif
// VTK-HeaderTest-Exclude: vtkSession.h