vtkPythonUtil.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkPythonUtil.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 vtkPythonUtil_h
#define vtkPythonUtil_h

#include "vtkPython.h"
#include "vtkPythonCompatibility.h"
#include "PyVTKMutableObject.h"
#include "PyVTKNamespace.h"
#include "PyVTKObject.h"
#include "PyVTKSpecialObject.h"

class vtkPythonClassMap;
class vtkPythonCommand;
class vtkPythonCommandList;
class vtkPythonGhostMap;
class vtkPythonObjectMap;
class vtkPythonSpecialTypeMap;
class vtkPythonNamespaceMap;
class vtkPythonEnumMap;
class vtkStdString;
class vtkUnicodeString;
class vtkVariant;

extern "C" void vtkPythonUtilDelete();

class VTKWRAPPINGPYTHONCORE_EXPORT vtkPythonUtil
{
public:

  static const char *PythonicClassName(const char *classname);

  static const char *StripModule(const char *tpname);


  static PyVTKClass *AddClassToMap(
    PyTypeObject *pytype, PyMethodDef *methods,
    const char *classname, vtknewfunc constructor);

  static PyVTKClass *FindClass(const char *classname);

  static PyVTKClass *FindNearestBaseClass(vtkObjectBase *ptr);


  static vtkObjectBase *GetPointerFromObject(PyObject *obj,
                                             const char *classname);

  static PyObject *GetObjectFromPointer(vtkObjectBase *ptr);

  static void *SIPGetPointerFromObject(PyObject *obj, const char *classname);


  static PyObject *SIPGetObjectFromPointer(
    const void *ptr, const char* classname, bool is_new);

  static PyObject *GetObjectFromObject(PyObject *arg, const char *type);

  static void AddObjectToMap(PyObject *obj, vtkObjectBase *anInstance);

  static void RemoveObjectFromMap(PyObject *obj);


  static PyVTKSpecialType *AddSpecialTypeToMap(
    PyTypeObject *pytype, PyMethodDef *methods, PyMethodDef *constructors,
    vtkcopyfunc copyfunc);

  static PyVTKSpecialType *FindSpecialType(const char *classname);


  static void *GetPointerFromSpecialObject(
    PyObject *obj, const char *result_type, PyObject **newobj);

  static void AddNamespaceToMap(PyObject *o);

  static void RemoveNamespaceFromMap(PyObject *o);

  static PyObject *FindNamespace(const char *name);

  static void AddEnumToMap(PyTypeObject *o);

  static PyTypeObject *FindEnum(const char *name);

  static PyObject *BuildDocString(const char *docstring[]);

  static char *ManglePointer(const void *ptr, const char *type);

  static void *UnmanglePointer(char *ptrText, int *len, const char *type);

  static Py_hash_t VariantHash(const vtkVariant *variant);


  static void RegisterPythonCommand(vtkPythonCommand*);
  static void UnRegisterPythonCommand(vtkPythonCommand*);

private:
  vtkPythonUtil();
  ~vtkPythonUtil();
  vtkPythonUtil(const vtkPythonUtil&);  // Not implemented.
  void operator=(const vtkPythonUtil&);  // Not implemented.

  vtkPythonObjectMap *ObjectMap;
  vtkPythonGhostMap *GhostMap;
  vtkPythonClassMap *ClassMap;
  vtkPythonSpecialTypeMap *SpecialTypeMap;
  vtkPythonNamespaceMap *NamespaceMap;
  vtkPythonEnumMap *EnumMap;
  vtkPythonCommandList *PythonCommandList;

  friend void vtkPythonUtilDelete();
  friend void vtkPythonUtilCreateIfNeeded();
};

// For use by SetXXMethod() , SetXXMethodArgDelete()
extern VTKWRAPPINGPYTHONCORE_EXPORT void vtkPythonVoidFunc(void *);
extern VTKWRAPPINGPYTHONCORE_EXPORT void vtkPythonVoidFuncArgDelete(void *);

#endif