X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=gdcmPython%2Fgdcm.i;h=a3bdeda9376ce002ba132a39683e3b5118cf8ef9;hb=409d1e0eb9cdfb64db19a110808f27cf054d68a6;hp=d267799810185f76017bf22bf8271ce6e1bca3d1;hpb=c8d390d6a732aa48eeb9d831ea83f4bebc8e19f8;p=gdcm.git

diff --git a/gdcmPython/gdcm.i b/gdcmPython/gdcm.i
index d2677998..a3bdeda9 100644
--- a/gdcmPython/gdcm.i
+++ b/gdcmPython/gdcm.i
@@ -1,222 +1,137 @@
 %module gdcm
+#pragma SWIG nowarn=504
 %{
+#include <iostream>
+
 #include "gdcmCommon.h"
-#include "gdcmDictEntry.h"
+#include "gdcmBase.h"
+#include "gdcmRefCounter.h"
+#include "gdcmTagKey.h"
+#include "gdcmVRKey.h"
 #include "gdcmDict.h"
+#include "gdcmDicomEntry.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 "gdcmDicomDirImage.h"
 #include "gdcmDicomDirMeta.h"
+#include "gdcmDicomDirObject.h"
 #include "gdcmDicomDirPatient.h"
 #include "gdcmDicomDirStudy.h"
 #include "gdcmDicomDirSerie.h"
-#include "gdcmDicomDirImage.h"
-
-using namespace std;
+#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"
 
 ////////////////////////////////////////////////////////////////////////////
-// 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);
-}
-
+/// Refer (below) to the definition of multi-argument typemap
+///   %typemap(python, in)
+///      ( gdcm::DicomDir::Method*, void*, gdcm::DicomDir::Method*)
+/// for detail on gdcmPythonVoidFunc() and gdcmPythonVoidFuncArgDelete().
 void gdcmPythonVoidFunc(void *arg)
 {
-  PyObject *arglist, *result;
-  PyObject *func = (PyObject *)arg;
+   PyObject *arglist, *result;
+   PyObject *func = (PyObject *)arg;
 
-  arglist = Py_BuildValue("()");
+   arglist = Py_BuildValue("()");
 
-  result = PyEval_CallObject(func, arglist);
-  Py_DECREF(arglist);
+   result = PyEval_CallObject(func, arglist);
+   Py_DECREF(arglist);
 
-  if (result)
-    {
-    Py_XDECREF(result);
-    }
-  else
-    {
-    if (PyErr_ExceptionMatches(PyExc_KeyboardInterrupt))
+   if (result)
+   {
+      Py_XDECREF(result);
+   }
+   else
+   {
+      if (PyErr_ExceptionMatches(PyExc_KeyboardInterrupt))
       {
-      cerr << "Caught a Ctrl-C within python, exiting program.\n";
-      Py_Exit(1);
+         std::cerr << "Caught a Ctrl-C within python, exiting program.\n";
+         Py_Exit(1);
       }
-    PyErr_Print();
-    }
+      PyErr_Print();
+   }
 }
 
 void gdcmPythonVoidFuncArgDelete(void *arg)
 {
-  PyObject *func = (PyObject *)arg;
-  if (func)
-    {
-    Py_DECREF(func);
-    }
+   PyObject *func = (PyObject *)arg;
+   if (func)
+   {
+      Py_DECREF(func);
+   }
 }
 
+/// This is required in order to avoid %including all the gdcm include files.
+using namespace gdcm;
 %}
-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;
-}
-
-////////////////////////////////////////////////////////////////////////////
-// 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;
-}
 
-////////////////////////////////////////////////////////////////////////////
-// 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;
-}
-
-%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;
-}
-
-////////////////////////////////////////////////////////////////////////////
-%typemap(out) ListDicomDirPatient & {
-	PyObject* NewItem = (PyObject*)0;
-	$result = PyList_New(0); // The result of this typemap
-
-	for (list<gdcmDicomDirPatient *>::iterator New = ($1)->begin();
-	    New != ($1)->end(); ++New) {
-		NewItem = SWIG_NewPointerObj(*New,SWIGTYPE_p_gdcmDicomDirPatient,1);
-		PyList_Append($result, NewItem);
-	}
-}
-
-%typemap(out) ListDicomDirStudy & {
-	PyObject* NewItem = (PyObject*)0;
-	$result = PyList_New(0); // The result of this typemap
-
-	for (list<gdcmDicomDirStudy *>::iterator New = ($1)->begin();
-	    New != ($1)->end(); ++New) {
-		NewItem = SWIG_NewPointerObj(*New,SWIGTYPE_p_gdcmDicomDirStudy,1);
-		PyList_Append($result, NewItem);
-	}
-}
+///////////////////////  typemap section  ////////////////////////////////////
 
-%typemap(out) ListDicomDirSerie & {
-	PyObject* NewItem = (PyObject*)0;
-	$result = PyList_New(0); // The result of this typemap
+////////////////////////////////////////////////
+// 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;
 
-	for (list<gdcmDicomDirSerie *>::iterator New = ($1)->begin();
-	    New != ($1)->end(); ++New) {
-		NewItem = SWIG_NewPointerObj(*New,SWIGTYPE_p_gdcmDicomDirSerie,1);
-		PyList_Append($result, NewItem);
-	}
-}
-
-%typemap(out) ListDicomDirImage & {
-	PyObject* NewItem = (PyObject*)0;
-	$result = PyList_New(0); // The result of this typemap
-
-	for (list<gdcmDicomDirImage *>::iterator New = ($1)->begin();
-	    New != ($1)->end(); ++New) {
-		NewItem = SWIG_NewPointerObj(*New,SWIGTYPE_p_gdcmDicomDirImage,1);
-		PyList_Append($result, NewItem);
-	}
+////////////////////////////////////////////////
+// Convert a DocEntry * to the real derived class
+%typemap(out) gdcm::DocEntry * 
+{
+   PyObject *newEntry;
+
+   if($1)
+   {
+      if(dynamic_cast<SeqEntry *>($1)) // SeqEntry *
+         newEntry = SWIG_NewPointerObj($1,SWIGTYPE_p_gdcm__SeqEntry,0);
+      else if(dynamic_cast<DataEntry *>($1)) // DataEntry *
+         newEntry = SWIG_NewPointerObj($1,SWIGTYPE_p_gdcm__DataEntry,0);
+      else
+         newEntry = NULL;
+   }
+   else
+   {
+      newEntry = Py_BuildValue("");
+   }
+   $result = newEntry;
 }
 
 ////////////////////////////////////////////////////////////////////////////
-// Deals with function returning a C++ string.
-%typemap(python, in) (gdcmMethod *,void * =NULL,gdcmMethod * =NULL) {
+// Multi-argument typemap designed for wrapping the progress related methods
+// in order to control from an external application the computation of
+// a DicomDir object (see DicomDir::SetStartMethod*,
+// DicomDir::SetProgressMethod* and DicomDir::SetEndMethod*).
+// Motivation: since DicomDir parsing can be quite long, a GUI application
+//             needs to display the avancement and potentially offer a
+//             cancel method to the user (when this one feels things are
+//             longer than expected).
+// Example of usage: refer to demo/DicomDirProgressMethod.py
+// Note: Uses gdcmPythonVoidFunc and gdcmPythonVoidFuncArgDelete defined
+//       in the Swig verbatim section of this gdcm.i i.e. in the above section
+//       enclosed within the %{ ... %} scope operator ).
+%typemap(python, in) (void(*method)(void *),void *arg,void(*argDelete)(void *))
+{
 	if($input!=Py_None)
 	{
 		Py_INCREF($input);
@@ -232,34 +147,129 @@ extern gdcmGlobal gdcmGlob;
 	}
 }
 
+////////////////////  STL string versus Python str  ////////////////////////
+// Convertion returning a C++ string.
+%typemap(out) std::string
+{
+    $result = PyString_FromString(($1).c_str());
+}
 
-////////////////////////////////////////////////////////////////////////////
-// Deals with function returning a C++ string.
-%typemap(out) string, std::string  {
+%typemap(out) string
+{
     $result = PyString_FromString(($1).c_str());
 }
 
+%typemap(out) std::string const &
+{
+    $result = PyString_FromString(($1)->c_str());
+}
+
+// Convertion of incoming Python str to STL string
 %typemap(python, in) const std::string, std::string
 {
   $1 = PyString_AsString($input);
 }
 
+// Same convertion as above but references (since swig converts C++
+// refererences to pointers)
+%typemap(python, in) std::string const &
+{
+   $1 = new std::string( PyString_AsString( $input ) );
+}
+
+////////////////////  gdcm.TagName versus Python str  //////////////////////
+%typemap(out) gdcm::TagName, const gdcm::TagName &
+{
+    $result = PyString_FromString(($1)->c_str());
+}
+
+// Convertion of incoming Python str to STL string
+%typemap(python, in) const gdcm::TagName, gdcm::TagName
+{
+  $1 = PyString_AsString($input);
+}
+
+// Same convertion as above but references (since swig converts C++
+// refererences to pointers)
+%typemap(python, in) gdcm::TagName const &
+{
+   $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::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::binary_write(std::ostream &,uint32_t const &);
+%ignore gdcm::binary_write(std::ostream &,uint16_t const &);
+
+%ignore gdcm::VRKey::operator=(const VRKey &_val);
+%ignore gdcm::VRKey::operator=(const std::string &_val);
+%ignore gdcm::VRKey::operator=(const char *_val);
+%ignore gdcm::VRKey::operator[](const unsigned int &_id) const;
+%ignore gdcm::VRKey::operator[](const unsigned int &_id);
+
+%ignore gdcm::TagKey::operator=(const TagKey &_val);
+%ignore gdcm::TagKey::operator[](const unsigned int &_id) const;
+%ignore gdcm::TagKey::operator[](const unsigned int &_id);
+
+%ignore gdcm::DicomDir::SetStartMethod(DicomDir::Method *method,void *arg = NULL);
+%ignore gdcm::DicomDir::SetProgressMethod(DicomDir::Method *method,void *arg = NULL);
+%ignore gdcm::DicomDir::SetEndMethod(DicomDir::Method *method,void *arg = NULL);
+
+// 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;
+
+%constant const char *UNKNOWN        = "gdcm::Unknown";
+%constant const char *UNFOUND        = "gdcm::Unfound";
+%constant const char *BINLOADED      = "gdcm::Binary data loaded";
+%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      = "  ";
+
 ////////////////////////////////////////////////////////////////////////////
+// Warning: Order matters !
 %include "gdcmCommon.h"
+%include "gdcmBase.h"
+%include "gdcmRefCounter.h"
+%include "gdcmTagKey.h"
+%include "gdcmVRKey.h"
+%include "gdcmDicomEntry.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 "gdcmDicomDirSerie.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 "gdcmDicomDirMeta.h"
-%include "gdcmDicomDirPatient.h"
-%include "gdcmDicomDirStudy.h"
-%include "gdcmDicomDirSerie.h"
-%include "gdcmDicomDirImage.h"
+%include "gdcmDocEntry.h"
+%include "gdcmDataEntry.h"
+%include "gdcmSeqEntry.h"
+%include "gdcmVR.h"
+%include "gdcmTS.h"
+%include "gdcmDictGroupName.h"