X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=gdcmPython%2Fgdcm.i;h=2d3c5ad64e9d5a13c1c255949d7017b85ee0ab41;hb=d00078b5e19310b379c8339fa8fe38362e8ca392;hp=71b026def4a7056ae9a1a963fc3a89a3bf4fe704;hpb=a919b2ba053a046eb268658ba81ad1bb1ddcd686;p=gdcm.git

diff --git a/gdcmPython/gdcm.i b/gdcmPython/gdcm.i
index 71b026de..2d3c5ad6 100644
--- a/gdcmPython/gdcm.i
+++ b/gdcmPython/gdcm.i
@@ -1,254 +1,379 @@
 %module gdcm
 %{
 #include "gdcmCommon.h"
-#include "gdcmDictEntry.h"
+#include "gdcmBase.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);
-}
+#include "gdcmDicomDirImage.h"
+#include "gdcmDicomDirMeta.h"
+#include "gdcmDicomDirObject.h"
+#include "gdcmDicomDirPatient.h"
+#include "gdcmDicomDirStudy.h"
+#include "gdcmDicomDirSerie.h"
+#include "gdcmDocEntrySet.h"
+#include "gdcmDocument.h"
+#include "gdcmElementSet.h"
+#include "gdcmFileHelper.h"
+#include "gdcmGlobal.h"
+#include "gdcmHeader.h"
+#include "gdcmSerieHeader.h"
+#include "gdcmRLEFramesInfo.h"
+#include "gdcmJPEGFragmentsInfo.h"
+#include "gdcmSQItem.h"
+#include "gdcmUtil.h"
+#include "gdcmDocEntry.h"
+#include "gdcmValEntry.h"
+#include "gdcmBinEntry.h"
+#include "gdcmSeqEntry.h"
 
-void vtkPythonVoidFunc(void *arg)
+////////////////////////////////////////////////////////////////////////////
+/// 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 vtkPythonVoidFuncArgDelete(void *arg)
+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;
+///////////////////////  typemap section  ////////////////////////////////////
+
+////////////////////////////////////////////////
+// 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<BinEntry *>($1)) // BinEntry *
+         newEntry = SWIG_NewPointerObj($1,SWIGTYPE_p_gdcm__BinEntry,0);
+      else // ValEntry *
+         newEntry = SWIG_NewPointerObj($1,SWIGTYPE_p_gdcm__ValEntry,0);
+   }
+   else
+   {
+      newEntry = Py_BuildValue("");
+   }
+   $result = newEntry;
 }
 
-////////////////////////////////////////////////////////////////////////////
-// 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;
+////////////////////////////////////////////////
+// Convert an STL list<> to a python native list
+%typemap(out) std::list<std::string> * 
+{
+   PyObject *newItem = (PyObject *)0;
+   PyObject *newList = PyList_New(0); // The result of this typemap
+
+   for (std::list<std::string>::iterator strIt = ($1)->begin();
+        strIt != ($1)->end();
+        ++strIt)
+   {
+      newItem = PyString_FromString(strIt->c_str());
+      PyList_Append( newList, newItem);
+   }
+   $result = newList;
+}
+
+//////////////////////////////////////////////////////////////////
+// Convert an STL map<> (hash table) to 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 (std::map<std::string,
+        std::list<std::string> >::iterator tag = ($1)->begin();
+        tag != ($1)->end(); ++tag)
+   {
+      std::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;
-}
+      newKey = PyString_FromString(first.c_str());
 
-////////////////////////////////////////////////////////////////////////////
-// 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;
+      PyObject *newList = PyList_New(0);
+      for (std::list<std::string>::iterator itemIt = tag->second.begin();
+           itemIt != tag->second.end();
+           ++itemIt)
+      {
+         newVal = PyString_FromString(itemIt->c_str());
+         PyList_Append( newList, newVal);
+      }
+      PyDict_SetItem( newDict, newKey, newList);
+   }
+   $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;
+/////////////////////////////////////////////////////////
+// Convert a c++ hash table in a python native dictionary
+%typemap(out) gdcm::TagDocEntryHT & 
+{
+   PyObject *newDict = PyDict_New(); // The result of this typemap
+   std::string rawName;              // Element name as gotten from gdcm
+   PyObject *newKey = (PyObject *)0; // Associated name as python object
+   std::string rawValue;             // Element value as gotten from gdcm
+   PyObject *newVal = (PyObject *)0; // Associated value as python object
+
+   for (gdcm::TagDocEntryHT::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
+      gdcm::ValEntry *valEntryPtr = dynamic_cast< gdcm::ValEntry* >(tag->second);
+      if ( valEntryPtr )
+      {
+         rawValue = valEntryPtr->GetValue();
+      }
+      else
+        continue; 
+      newVal = PyString_FromString(rawValue.c_str());
+      PyDict_SetItem( newDict, newKey, newVal);
+   }
+   $result = newDict;
 }
 
-////////////////////////////////////////////////////////////////////////////
-%typemap(out) ListPatient & {
-	PyObject* NewItem = (PyObject*)0;
+/////////////////////////////////////
+%typemap(out) ListDicomDirPatient & 
+{
+	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);
+	for (std::list<gdcm::DicomDirPatient *>::iterator newIt = ($1)->begin();
+	    newIt != ($1)->end(); ++newIt)
+   {
+		newItem = SWIG_NewPointerObj(*newIt,SWIGTYPE_p_DicomDirPatient,0);
+		PyList_Append($result, newItem);
 	}
 }
 
-%typemap(out) ListStudy & {
-	PyObject* NewItem = (PyObject*)0;
+%typemap(out) ListDicomDirStudy & 
+{
+	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);
+	for (std::list<gdcm::DicomDirStudy *>::iterator newIt = ($1)->begin();
+	    newIt != ($1)->end(); ++newIt)
+   {
+		newItem = SWIG_NewPointerObj(*newIt,SWIGTYPE_p_DicomDirStudy,0);
+		PyList_Append($result, newItem);
 	}
 }
 
-%typemap(out) ListSerie & {
-	PyObject* NewItem = (PyObject*)0;
+%typemap(out) ListDicomDirSerie & 
+{
+	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);
+	for (std::list<gdcm::DicomDirSerie *>::iterator newIt = ($1)->begin();
+	    newIt != ($1)->end(); ++newIt)
+   {
+		newItem = SWIG_NewPointerObj(*newIt,SWIGTYPE_p_DicomDirSerie,0);
+		PyList_Append($result, newItem);
 	}
 }
 
-%typemap(out) ListImage & {
-	PyObject* NewItem = (PyObject*)0;
+%typemap(out) ListDicomDirImage & 
+{
+	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);
+	for (std::list<gdcm::DicomDirImage *>::iterator newIt = ($1)->begin();
+	    newIt != ($1)->end(); ++newIt) 
+   {
+		newItem = SWIG_NewPointerObj(*newIt,SWIGTYPE_p_DicomDirImage,0);
+		PyList_Append($result, newItem);
 	}
 }
 
 ////////////////////////////////////////////////////////////////////////////
-// Deals with function returning a C++ string.
-%typemap(python, in) (gdcmMethod *method,void *arg) {
-    Py_INCREF($input);
-    $1=vtkPythonVoidFunc;
-	$2=$input;
+// 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) ( gdcm::DicomDir::Method *, 
+                       void * = NULL, 
+                       gdcm::DicomDir::Method * = NULL )
+{
+	if($input!=Py_None)
+	{
+		Py_INCREF($input);
+		$1=gdcmPythonVoidFunc;
+		$2=$input;
+		$3=gdcmPythonVoidFuncArgDelete;
+	}
+	else
+	{
+		$1=NULL;
+		$2=NULL;
+		$3=NULL;
+	}
 }
 
-
-////////////////////////////////////////////////////////////////////////////
-// Deals with function returning a C++ string.
-%typemap(out) string, std::string  {
+////////////////////  STL string versus Python str  ////////////////////////
+// Convertion 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 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 ) );
+}
+
 ////////////////////////////////////////////////////////////////////////////
+// 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::Header 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::Header::Header();
+%ignore gdcm::DicomDir::DicomDir();
+
+// Ignore all placed in gdcmCommon.h
+%ignore GDCM_UNKNOWN;
+%ignore GDCM_UNFOUND;
+%ignore GDCM_BINLOADED;
+%ignore GDCM_NOTLOADED;
+%ignore GDCM_UNREAD;
+
+////////////////////////////////////////////////////////////////////////////
+// Warning: Order matters !
 %include "gdcmCommon.h"
+%include "gdcmBase.h"
 %include "gdcmDictEntry.h"
 %include "gdcmDict.h"
+%include "gdcmDocEntrySet.h"
+%include "gdcmElementSet.h"
 %include "gdcmDictSet.h"
-%include "gdcmParser.h"
-%include "gdcmHeaderEntry.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 "gdcmHeader.h"
-%include "gdcmHeaderHelper.h"
+%include "gdcmSerieHeader.h"
 %include "gdcmFile.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 "gdcmValEntry.h"
+%include "gdcmBinEntry.h"
+%include "gdcmSeqEntry.h"
+
+////////////////////////////////////////////////////////////////////////////
+// Notes on swig and this file gdcm.i:
+//
+/////////////////////////////////////
+// Note 1: swig collision of method overloading and %typemap
+// Consider the following junk.i file:
+//     %module junk
+//     %{
+//     #include <string>
+//     #include <iostream>
+//     void Junk(std::string const & bozo) { std::cout << bozo << std::endl; }
+//     void Junk() { std::cout << "Renamed Junk()" << std::endl; }
+//     %}
+//   
+//     %typemap(python, in) std::string const &
+//     {
+//     $1 = new std::string( PyString_AsString( $input ) );
+//     }
+//     void Junk();
+//     void Junk(std::string const & bozo);
+//
+// that we compile on linux with:
+//    swig -c++ -python junk.i
+//    g++ -g -I/usr/include/python2.3/ -o junk_wrap.o -c junk_wrap.cxx
+//    g++ junk_wrap.o -shared -g -o _junk.so -L/usr/lib/python2.3/config \
+//        -lpython2.3
+// and invoque with:
+//    python -c 'from junk import *; Junk("aaa") '
+// then we get the following unexpected (for novice) python TypeError:
+//    TypeError: No matching function for overloaded 'Junk'
+//
+// This happens because the swig generated code (at least for python) does
+// the following two stage process:
+//   1/ first do a dynamic dispatch ON THE NUMBER OF ARGUMENTS of the overloaded
+//      Junk function (the same happens with method of course). [Note that the
+//      dispatch is NOT done on the type of the arguments].
+//   2/ second apply the typemap.
+// When the first dynamic dispatch is executed, the swig generated code
+// has no knowledge of the typemap, and thus expects a pointer to a std::string
+// type i.e. an argument to Junk of the form _p_std__int<address>. But this
+// is not what python handles to Junk ! An invocation of the form 'Junk("aaa")'
+// will make Python pass a PyString to swig (and this is precisely why we
+// wrote the typemap). And this will fail....
+/////////////////////////////////////