%module gdcm
+#pragma SWIG nowarn=504
%{
+#include <iostream>
+
#include "gdcmCommon.h"
-#include "gdcmDictEntry.h"
+#include "gdcmBase.h"
#include "gdcmDict.h"
+#include "gdcmDictEntry.h"
#include "gdcmDictSet.h"
-#include "gdcmDocEntrySet.h"
-#include "gdcmSQItem.h"
-#include "gdcmDocument.h"
-#include "gdcmElementSet.h"
-#include "gdcmHeader.h"
-#include "gdcmHeaderHelper.h"
-#include "gdcmFile.h"
-#include "gdcmUtil.h"
-#include "gdcmGlobal.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"
+#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 "gdcmContentEntry.h"
#include "gdcmValEntry.h"
+#include "gdcmBinEntry.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(std::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;
-
- arglist = Py_BuildValue("()");
-
- result = PyEval_CallObject(func, arglist);
- Py_DECREF(arglist);
-
- if (result)
- {
- Py_XDECREF(result);
- }
- else
- {
- if (PyErr_ExceptionMatches(PyExc_KeyboardInterrupt))
- {
- std::cerr << "Caught a Ctrl-C within python, exiting program.\n";
- Py_Exit(1);
- }
- PyErr_Print();
- }
-}
-
-void gdcmPythonVoidFuncArgDelete(void *arg)
-{
- PyObject *func = (PyObject *)arg;
- if (func)
- {
- Py_DECREF(func);
- }
-}
+ PyObject *arglist, *result;
+ PyObject *func = (PyObject *)arg;
-%}
-typedef unsigned short guint16;
-typedef unsigned int guint32;
+ arglist = Py_BuildValue("()");
-////////////////////////////////////////////////////////////////////////////
-%typemap(out) std::list<std::string> * {
- PyObject* NewItem = (PyObject*)0;
- PyObject* NewList = PyList_New(0); // The result of this typemap
+ result = PyEval_CallObject(func, arglist);
+ Py_DECREF(arglist);
- for (std::list<std::string>::iterator NewString = ($1)->begin();
- NewString != ($1)->end();
- ++NewString)
+ if (result)
{
- NewItem = PyString_FromString(NewString->c_str());
- PyList_Append( NewList, NewItem);
+ Py_XDECREF(result);
}
- $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 (std::map<std::string,
- std::list<std::string> >::iterator tag = ($1)->begin();
- tag != ($1)->end(); ++tag)
+ else
{
- 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 (std::list<std::string>::iterator Item = tag->second.begin();
- Item != tag->second.end();
- ++Item)
+ if (PyErr_ExceptionMatches(PyExc_KeyboardInterrupt))
{
- NewVal = PyString_FromString(Item->c_str());
- PyList_Append( NewList, NewVal);
+ std::cerr << "Caught a Ctrl-C within python, exiting program.\n";
+ Py_Exit(1);
}
- PyDict_SetItem( NewDict, NewKey, NewList);
+ PyErr_Print();
}
- $result = NewDict;
}
-////////////////////////////////////////////////////////////////////////////
-// Convert a c++ hash table in a python native dictionary
-%typemap(out) 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 (TagDocEntryHT::iterator tag = $1->begin(); tag != $1->end(); ++tag)
+void gdcmPythonVoidFuncArgDelete(void *arg)
+{
+ PyObject *func = (PyObject *)arg;
+ if (func)
{
- // 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
- if (gdcmValEntry* ValEntryPtr =
- dynamic_cast< gdcmValEntry* >(tag->second) )
- {
- RawValue = ValEntryPtr->GetValue();
- }
- else
- continue;
- EatLeadingAndTrailingSpaces(RawValue);
- NewVal = PyString_FromString(RawValue.c_str());
- PyDict_SetItem( NewDict, NewKey, NewVal);
+ Py_DECREF(func);
}
- $result = NewDict;
-}
-
-////////////////////////////////////////////////////////////////////////////
-%typemap(out) ListDicomDirPatient & {
- PyObject* NewItem = (PyObject*)0;
- $result = PyList_New(0); // The result of this typemap
-
- for (std::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
+/// This is required in order to avoid %including all the gdcm include files.
+using namespace gdcm;
+%}
- for (std::list<gdcmDicomDirStudy *>::iterator New = ($1)->begin();
- New != ($1)->end(); ++New) {
- NewItem = SWIG_NewPointerObj(*New,SWIGTYPE_p_gdcmDicomDirStudy,1);
- PyList_Append($result, NewItem);
- }
-}
-%typemap(out) ListDicomDirSerie & {
- PyObject* NewItem = (PyObject*)0;
- $result = PyList_New(0); // The result of this typemap
+/////////////////////// typemap section ////////////////////////////////////
- for (std::list<gdcmDicomDirSerie *>::iterator New = ($1)->begin();
- New != ($1)->end(); ++New) {
- NewItem = SWIG_NewPointerObj(*New,SWIGTYPE_p_gdcmDicomDirSerie,1);
- PyList_Append($result, NewItem);
- }
-}
+////////////////////////////////////////////////
+// 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;
-%typemap(out) ListDicomDirImage & {
- PyObject* NewItem = (PyObject*)0;
- $result = PyList_New(0); // The result of this typemap
+////////////////////////////////////////////////
+// Convert a DocEntry * to the real derived class
+%typemap(out) gdcm::DocEntry *
+{
+ PyObject *newEntry;
- for (std::list<gdcmDicomDirImage *>::iterator New = ($1)->begin();
- New != ($1)->end(); ++New) {
- NewItem = SWIG_NewPointerObj(*New,SWIGTYPE_p_gdcmDicomDirImage,1);
- PyList_Append($result, NewItem);
- }
+ 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;
}
////////////////////////////////////////////////////////////////////////////
-// 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);
}
}
+//////////////////// 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::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;
+
+%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";
+
////////////////////////////////////////////////////////////////////////////
// Warning: Order matters !
%include "gdcmCommon.h"
+%include "gdcmBase.h"
%include "gdcmDictEntry.h"
%include "gdcmDict.h"
%include "gdcmDictSet.h"
%include "gdcmDocEntrySet.h"
%include "gdcmElementSet.h"
-%include "gdcmDocument.h"
%include "gdcmSQItem.h"
-%include "gdcmHeader.h"
-%include "gdcmHeaderHelper.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 "gdcmGlobal.h"
-%include "gdcmObject.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 "gdcmContentEntry.h"
+%include "gdcmValEntry.h"
+%include "gdcmBinEntry.h"
+%include "gdcmSeqEntry.h"
+%include "gdcmVR.h"
+%include "gdcmTS.h"
+%include "gdcmDictGroupName.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....
+/////////////////////////////////////
git://git.creatis.insa-lyon.fr / gdcm.git / blobdiff