]> Creatis software - gdcm.git/blobdiff - gdcmPython/gdcm.i
Fix mistypings
[gdcm.git] / gdcmPython / gdcm.i
index 71b026def4a7056ae9a1a963fc3a89a3bf4fe704..5e1e762d95f7f85bc44f15cbb3e7aa8fa8dd9ca2 100644 (file)
 %module gdcm
+#pragma SWIG nowarn=504,510
 %{
+#include <iostream>
+
 #include "gdcmCommon.h"
-#include "gdcmDictEntry.h"
+#include "gdcmBase.h"
+#include "gdcmRefCounter.h"
+#include "gdcmCommand.h"
+#include "gdcmCommandPy.h"
+#include "gdcmDebug.h"
+#include "gdcmCommandManager.h"
+#include "gdcmTagKey.h"
+#include "gdcmVRKey.h"
 #include "gdcmDict.h"
+#include "gdcmDictEntry.h"
 #include "gdcmDictSet.h"
-#include "gdcmParser.h"
-#include "gdcmHeaderEntry.h"
-#include "gdcmHeader.h"
-#include "gdcmHeaderHelper.h"
-#include "gdcmFile.h"
-#include "gdcmUtil.h"
-#include "gdcmObject.h"
 #include "gdcmDicomDir.h"
 #include "gdcmDicomDirElement.h"
-#include "gdcmMeta.h"
-#include "gdcmPatient.h"
-#include "gdcmStudy.h"
-#include "gdcmSerie.h"
-#include "gdcmImage.h"
-
-using namespace std;
-
-// Utility functions on strings for removing leading and trailing spaces
-void EatLeadingAndTrailingSpaces(string & s) {
-       while ( s.length() && (s[0] == ' ') )
-               s.erase(0,1);
-       while ( s.length() && (s[s.length()-1] == ' ') )
-               s.erase(s.length()-1, 1);
-}
-
-void vtkPythonVoidFunc(void *arg)
-{
-  PyObject *arglist, *result;
-  PyObject *func = (PyObject *)arg;
-
-  arglist = Py_BuildValue("()");
-
-  result = PyEval_CallObject(func, arglist);
-  Py_DECREF(arglist);
-
-  if (result)
-    {
-    Py_XDECREF(result);
-    }
-  else
-    {
-    if (PyErr_ExceptionMatches(PyExc_KeyboardInterrupt))
-      {
-      cerr << "Caught a Ctrl-C within python, exiting program.\n";
-      Py_Exit(1);
-      }
-    PyErr_Print();
-    }
-}
-
-void vtkPythonVoidFuncArgDelete(void *arg)
-{
-  PyObject *func = (PyObject *)arg;
-  if (func)
-    {
-    Py_DECREF(func);
-    }
-}
-
+#include "gdcmDicomDirImage.h"
+#include "gdcmDicomDirMeta.h"
+#include "gdcmDicomDirObject.h"
+#include "gdcmDicomDirPatient.h"
+#include "gdcmDicomDirStudy.h"
+#include "gdcmDicomDirSerie.h"
+#include "gdcmDicomDirVisit.h"
+#include "gdcmDicomDirPrivate.h"
+#include "gdcmDirList.h"
+#include "gdcmDocEntrySet.h"
+#include "gdcmDocument.h"
+#include "gdcmElementSet.h"
+#include "gdcmFileHelper.h"
+#include "gdcmGlobal.h"
+#include "gdcmFile.h"
+#include "gdcmSerieHelper.h"
+#include "gdcmRLEFramesInfo.h"
+#include "gdcmJPEGFragmentsInfo.h"
+#include "gdcmSQItem.h"
+#include "gdcmUtil.h"
+#include "gdcmDocEntry.h"
+#include "gdcmDataEntry.h"
+#include "gdcmSeqEntry.h"
+#include "gdcmVR.h"
+#include "gdcmTS.h"
+#include "gdcmDictGroupName.h"
+
+/// This is required in order to avoid %including all the gdcm include files.
+using namespace GDCM_NAME_SPACE;
 %}
-typedef  unsigned short guint16;
-typedef  unsigned int guint32;
 
-////////////////////////////////////////////////////////////////////////////
-// Global variables get exported to cvar in Python
-%immutable;
-extern gdcmGlobal gdcmGlob;
-%mutable;
 
-////////////////////////////////////////////////////////////////////////////
-%typemap(out) std::list<std::string> * {
-       PyObject* NewItem = (PyObject*)0;
-       PyObject* NewList = PyList_New(0); // The result of this typemap
-       for (list<string>::iterator NewString = ($1)->begin();
-            NewString != ($1)->end(); ++NewString) {
-               NewItem = PyString_FromString(NewString->c_str());
-               PyList_Append( NewList, NewItem);
-       }
-       $result = NewList;
-}
+///////////////////////  typemap section  ////////////////////////////////////
 
-////////////////////////////////////////////////////////////////////////////
-// Convert a c++ hash table in a python native dictionary
-%typemap(out) std::map<std::string, std::list<std::string> > * {
-       PyObject* NewDict = PyDict_New(); // The result of this typemap
-       PyObject* NewKey = (PyObject*)0;
-       PyObject* NewVal = (PyObject*)0;
-
-       for (map<string, list<string> >::iterator tag = ($1)->begin();
-            tag != ($1)->end(); ++tag) {
-      string first = tag->first;
-      // Do not publish entries whose keys is made of spaces
-      if (first.length() == 0)
-         continue;
-               NewKey = PyString_FromString(first.c_str());
-               PyObject* NewList = PyList_New(0);
-               for (list<string>::iterator Item = tag->second.begin();
-                    Item != tag->second.end(); ++Item) {
-                       NewVal = PyString_FromString(Item->c_str());
-                       PyList_Append( NewList, NewVal);
-               }
-               PyDict_SetItem( NewDict, NewKey, NewList);
-       }
-       $result = NewDict;
-}
+////////////////////////////////////////////////
+// Redefine all types used
+typedef char               int8_t;
+typedef unsigned char      uint8_t;
+typedef short              int16_t;
+typedef unsigned short     uint16_t;
+typedef int                int32_t;
+typedef unsigned int       uint32_t;
+typedef long long          int64_t;
+typedef unsigned long long uint64_t;
 
-////////////////////////////////////////////////////////////////////////////
-// Convert a c++ hash table in a python native dictionary
-%typemap(out) TagHeaderEntryHT & {
-       PyObject* NewDict = PyDict_New(); // The result of this typemap
-       string RawName;                   // Element name as gotten from gdcm
-       PyObject* NewKey = (PyObject*)0;  // Associated name as python object
-       string RawValue;                  // Element value as gotten from gdcm
-       PyObject* NewVal = (PyObject*)0;  // Associated value as python object
-
-       for (TagHeaderEntryHT::iterator tag = $1->begin(); tag != $1->end(); ++tag) {
-
-               // The element name shall be the key:
-               RawName = tag->second->GetName();
-               // gdcm unrecognized (including not loaded because their size exceeds
-               // the user specified treshold) elements are exported with their
-               // TagKey as key.
-               if (RawName == "Unknown")
-                       RawName = tag->second->GetKey();
-               NewKey = PyString_FromString(RawName.c_str());
-
-               // Element values are striped from leading/trailing spaces
-               RawValue = tag->second->GetValue();
-               EatLeadingAndTrailingSpaces(RawValue);
-               NewVal = PyString_FromString(RawValue.c_str());
-
-               PyDict_SetItem( NewDict, NewKey, NewVal);
-    }
-       $result = NewDict;
+////////////////////////////////////////////////
+// Convert a DocEntry * to the real derived class
+%typemap(out) GDCM_NAME_SPACE::DocEntry *
+{
+   PyObject *newEntry;
+
+   if($1)
+   {
+      if(dynamic_cast<SeqEntry *>($1)) // SeqEntry *
+         newEntry = SWIG_NewPointerObj($1,SWIGTYPE_p_GDCM_NAME_SPACE__SeqEntry,0);
+      else if(dynamic_cast<DataEntry *>($1)) // DataEntry *
+         newEntry = SWIG_NewPointerObj($1,SWIGTYPE_p_GDCM_NAME_SPACE__DataEntry,0);
+      else
+         newEntry = NULL;
+   }
+   else
+   {
+      newEntry = Py_BuildValue("");
+   }
+   $result = newEntry;
 }
 
-%typemap(out) TagHeaderEntryHT {
-       PyObject* NewDict = PyDict_New(); // The result of this typemap
-       string RawName;                   // Element name as gotten from gdcm
-       PyObject* NewKey = (PyObject*)0;  // Associated name as python object
-       string RawValue;                  // Element value as gotten from gdcm
-       PyObject* NewVal = (PyObject*)0;  // Associated value as python object
-
-       for (TagHeaderEntryHT::iterator tag = $1.begin(); tag != $1.end(); ++tag) {
-
-               // The element name shall be the key:
-               RawName = tag->second->GetName();
-               // gdcm unrecognized (including not loaded because their size exceeds
-               // the user specified treshold) elements are exported with their
-               // TagKey as key.
-               if (RawName == "Unknown")
-                       RawName = tag->second->GetKey();
-               NewKey = PyString_FromString(RawName.c_str());
-
-               // Element values are striped from leading/trailing spaces
-               RawValue = tag->second->GetValue();
-               EatLeadingAndTrailingSpaces(RawValue);
-               NewVal = PyString_FromString(RawValue.c_str());
-
-               PyDict_SetItem( NewDict, NewKey, NewVal);
-    }
-       $result = NewDict;
+////////////////////  STL string versus Python str  ////////////////////////
+// Convertion returning a C++ string.
+%typemap(out) std::string
+{
+    $result = PyString_FromString(($1).c_str());
 }
 
-////////////////////////////////////////////////////////////////////////////
-%typemap(out) ListPatient & {
-       PyObject* NewItem = (PyObject*)0;
-       $result = PyList_New(0); // The result of this typemap
-
-       for (list<gdcmPatient *>::iterator New = ($1)->begin();
-           New != ($1)->end(); ++New) {
-               NewItem = SWIG_NewPointerObj(*New,SWIGTYPE_p_gdcmPatient,1);
-               PyList_Append($result, NewItem);
-       }
+%typemap(out) string
+{
+    $result = PyString_FromString(($1).c_str());
 }
 
-%typemap(out) ListStudy & {
-       PyObject* NewItem = (PyObject*)0;
-       $result = PyList_New(0); // The result of this typemap
-
-       for (list<gdcmStudy *>::iterator New = ($1)->begin();
-           New != ($1)->end(); ++New) {
-               NewItem = SWIG_NewPointerObj(*New,SWIGTYPE_p_gdcmStudy,1);
-               PyList_Append($result, NewItem);
-       }
+%typemap(out) std::string const &
+{
+    $result = PyString_FromString(($1)->c_str());
 }
 
-%typemap(out) ListSerie & {
-       PyObject* NewItem = (PyObject*)0;
-       $result = PyList_New(0); // The result of this typemap
-
-       for (list<gdcmSerie *>::iterator New = ($1)->begin();
-           New != ($1)->end(); ++New) {
-               NewItem = SWIG_NewPointerObj(*New,SWIGTYPE_p_gdcmSerie,1);
-               PyList_Append($result, NewItem);
-       }
+// Convertion of incoming Python str to STL string
+%typemap(python, in) const std::string, std::string
+{
+  $1 = PyString_AsString($input);
 }
 
-%typemap(out) ListImage & {
-       PyObject* NewItem = (PyObject*)0;
-       $result = PyList_New(0); // The result of this typemap
-
-       for (list<gdcmImage *>::iterator New = ($1)->begin();
-           New != ($1)->end(); ++New) {
-               NewItem = SWIG_NewPointerObj(*New,SWIGTYPE_p_gdcmImage,1);
-               PyList_Append($result, NewItem);
-       }
+// Same convertion as above but references (since swig converts C++
+// references to pointers)
+%typemap(python, in) std::string const &
+{
+   $1 = new std::string( PyString_AsString( $input ) );
 }
 
-////////////////////////////////////////////////////////////////////////////
-// Deals with function returning a C++ string.
-%typemap(python, in) (gdcmMethod *method,void *arg) {
-    Py_INCREF($input);
-    $1=vtkPythonVoidFunc;
-       $2=$input;
+////////////////////  gdcm.TagName versus Python str  //////////////////////
+%typemap(out) GDCM_NAME_SPACE::TagName, const GDCM_NAME_SPACE::TagName &
+{
+    $result = PyString_FromString(($1)->c_str());
 }
 
-
-////////////////////////////////////////////////////////////////////////////
-// Deals with function returning a C++ string.
-%typemap(out) string, std::string  {
-    $result = PyString_FromString(($1).c_str());
+// Convertion of incoming Python str to STL string
+%typemap(python, in) const GDCM_NAME_SPACE::TagName, GDCM_NAME_SPACE::TagName
+{
+  $1 = PyString_AsString($input);
 }
 
-%typemap(python, in) const std::string, std::string
+// Same convertion as above but references (since swig converts C++
+// refererences to pointers)
+%typemap(python, in) GDCM_NAME_SPACE::TagName const &
 {
-  $1 = PyString_AsString($input);
+   $1 = new std::string( PyString_AsString( $input ) );
 }
 
 ////////////////////////////////////////////////////////////////////////////
+// Because overloading and %rename don't work together (see below Note 1)
+// we need to ignore some methods (e.g. the overloaded default constructor).
+// The GDCM_NAME_SPACE::File class doesn't have any SetFilename method anyhow, and
+// this constructor is only used internaly (not from the API) so this is
+// not a big loss.
+%ignore GDCM_NAME_SPACE::binary_write(std::ostream &,uint32_t const &);
+%ignore GDCM_NAME_SPACE::binary_write(std::ostream &,uint16_t const &);
+
+%ignore GDCM_NAME_SPACE::VRKey::operator=(const VRKey &_val);
+%ignore GDCM_NAME_SPACE::VRKey::operator=(const std::string &_val);
+%ignore GDCM_NAME_SPACE::VRKey::operator=(const char *_val);
+%ignore GDCM_NAME_SPACE::VRKey::operator[](const unsigned int &_id) const;
+%ignore GDCM_NAME_SPACE::VRKey::operator[](const unsigned int &_id);
+
+%ignore GDCM_NAME_SPACE::TagKey::operator=(const TagKey &_val);
+%ignore GDCM_NAME_SPACE::TagKey::operator[](const unsigned int &_id) const;
+%ignore GDCM_NAME_SPACE::TagKey::operator[](const unsigned int &_id);
+
+// Ignore all placed in gdcmCommon.h
+%ignore GDCM_UNKNOWN;
+%ignore GDCM_UNFOUND;
+%ignore GDCM_BINLOADED;
+%ignore GDCM_NOTLOADED;
+%ignore GDCM_UNREAD;
+%ignore GDCM_NOTASCII;
+%ignore GDCM_PIXELDATA;
+%ignore GDCM_LEGACY;
+%ignore GDCM_VRUNKNOWN;
+%ignore GDCM_FILESEPARATOR;
+
+%constant const char *UNKNOWN        = "GDCM::Unknown";
+%constant const char *UNFOUND        = "GDCM::Unfound";
+%constant const char *BINLOADED      = "GDCM::Binary data";
+%constant const char *NOTLOADED      = "GDCM::NotLoaded";
+%constant const char *UNREAD         = "GDCM::UnRead";
+%constant const char *GDCM_NOTASCII  = "GDCM::NotAscii";
+%constant const char *GDCM_PIXELDATA = "GDCM::Pixel Data to be loaded";
+%constant const char *VRUNKNOWN      = "  ";
+%constant const char GDCM_FILESEPARATOR = '\\';
+////////////////////////////////////////////////////////////////////////////
+// Warning: Order matters !
 %include "gdcmCommon.h"
+%include "gdcmBase.h"
+%include "gdcmRefCounter.h"
+%include "gdcmCommand.h"
+%include "gdcmCommandPy.h"
+%include "gdcmDebug.h"
+%include "gdcmCommandManager.h"
+%include "gdcmTagKey.h"
+%include "gdcmVRKey.h"
 %include "gdcmDictEntry.h"
 %include "gdcmDict.h"
 %include "gdcmDictSet.h"
-%include "gdcmParser.h"
-%include "gdcmHeaderEntry.h"
-%include "gdcmHeader.h"
-%include "gdcmHeaderHelper.h"
+%include "gdcmDocEntrySet.h"
+%include "gdcmElementSet.h"
+%include "gdcmSQItem.h"
+%include "gdcmDicomDirElement.h"
+%include "gdcmDicomDirObject.h"
+%include "gdcmDicomDirImage.h"
+%include "gdcmDicomDirPrivate.h"
+%include "gdcmDicomDirSerie.h"
+%include "gdcmDicomDirVisit.h"
+%include "gdcmDicomDirStudy.h"
+%include "gdcmDicomDirPatient.h"
+%include "gdcmDicomDirMeta.h"
+%include "gdcmDocument.h"
 %include "gdcmFile.h"
+%include "gdcmSerieHelper.h"
+%include "gdcmFileHelper.h"
 %include "gdcmUtil.h"
-%include "gdcmObject.h"
+%include "gdcmGlobal.h"
 %include "gdcmDicomDir.h"
-%include "gdcmDicomDirElement.h"
-%include "gdcmMeta.h"
-%include "gdcmPatient.h"
-%include "gdcmStudy.h"
-%include "gdcmSerie.h"
-%include "gdcmImage.h"
+%include "gdcmDocEntry.h"
+%include "gdcmDataEntry.h"
+%include "gdcmSeqEntry.h"
+%include "gdcmVR.h"
+%include "gdcmTS.h"
+%include "gdcmDictGroupName.h"