]> Creatis software - gdcm.git/blobdiff - src/gdcmCommon.h
ENH: Adding a deprecation mechanism to gdcm via two MACRO and two config options
[gdcm.git] / src / gdcmCommon.h
index c0db974c4436c34c3f748414735c6e6df9df8609..c78b0013aad88a360df4d47cfe2201a04120911c 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmCommon.h,v $
   Language:  C++
-  Date:      $Date: 2004/09/27 08:39:05 $
-  Version:   $Revision: 1.33 $
+  Date:      $Date: 2005/07/19 14:43:48 $
+  Version:   $Revision: 1.82 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -27,6 +27,8 @@
 // 'identifier' : class 'type' needs to have dll-interface to be used by
 // clients of class 'type2'
 #pragma warning ( disable : 4251 )
+// non dll-interface class 'type' used as base for dll-interface class 'type2'
+#pragma warning ( disable : 4275 )
 // 'identifier' : identifier was truncated to 'number' characters in the
 // debug information
 #pragma warning ( disable : 4786 )
 #endif //_MSC_VER
 
 //-----------------------------------------------------------------------------
-#ifdef __GNUC__
-#ifndef HAVE_NO_STDINT_H
-#include <stdint.h>   // For uint8_t uint16_t and uint32_t
+#ifdef CMAKE_HAVE_STDINT_H
+   #include <stdint.h>
 #else
-typedef  unsigned char  uint8_t;
-typedef  unsigned short uint16_t;
-typedef  unsigned int   uint32_t;
-#define UINT32_MAX    (4294967295U)
-#endif //HAVE_NO_STDINT_H
-#endif
+#ifdef CMAKE_HAVE_INTTYPES_H
+   // Old system only have this
+   #include <inttypes.h>   // For uint8_t uint16_t and uint32_t
+#else
+// Broken plateform do not respect C99 and do not provide those typedef
+// Special case for recent borland compiler, comes with stdint.h
+#if defined(_MSC_VER) || defined(__BORLANDC__) && (__BORLANDC__ < 0x0560)  || defined(__MINGW32__)
+typedef  signed char         int8_t;
+typedef  signed short        int16_t;
+typedef  signed int          int32_t;
+typedef  unsigned char       uint8_t;
+typedef  unsigned short      uint16_t;
+typedef  unsigned int        uint32_t;
+#else
+#error "Sorry your plateform is not supported"
+#endif // defined(_MSC_VER) || defined(__BORLANDC__) && (__BORLANDC__ < 0x0560)  || defined(__MINGW32__)
+#endif // CMAKE_HAVE_INTTYPES_H
+#endif // CMAKE_HAVE_STDINT_H
 
-#ifdef _MSC_VER 
-typedef  unsigned char  uint8_t;
-typedef  unsigned short uint16_t;
-typedef  unsigned int   uint32_t;
+// Basically for VS6 and bcc 5.5.1:
+#ifndef UINT32_MAX
 #define UINT32_MAX    (4294967295U)
 #endif
 
-#ifdef _MSC_VER
-#define GDCM_EXPORT __declspec( dllexport )
-#define getcwd _getcwd
+#if defined(_WIN32) && defined(BUILD_SHARED_LIBS)
+  #ifdef gdcm_EXPORTS
+    #define GDCM_EXPORT __declspec( dllexport )
+  #else
+    #define GDCM_EXPORT __declspec( dllimport )
+  #endif
 #else
-#define GDCM_EXPORT
+  #define GDCM_EXPORT
 #endif
 
-// ifdef for old gcc / broken compiler
-#ifdef GDCM_NO_ANSI_STRING_STREAM
-#  include <strstream>
-#  define  ostringstream ostrstream
-# else
-#  include <sstream>
+#include <string>
+#define FASTTAGKEY 0
+
+// FIXME: Should rewrite this:
+#if FASTTAGKEY
+#include <iostream>
+#include <iomanip>
 #endif
+#if defined(_MSC_VER) && (_MSC_VER == 1200)
+/* ostream operator for std::string since VS6 does not provide it*/
+#include <iostream>
+#endif
+
 
+//-----------------------------------------------------------------------------
+/// \brief namespace for Grass root DiCoM
+namespace gdcm
+{
 
 // Centralize information about the gdcm dictionary in only one file:
 #ifndef PUB_DICT_PATH
 #  define PUB_DICT_PATH   "../Dicts/"
 #endif
 #define PUB_DICT_NAME     "DicomV3Dict"
-#define PUB_DICT_FILENAME "dicomV3.dic"
+#define PUB_DICT_FILENAME "gdcm.dic"
 #define DICT_ELEM         "DicomDir.dic"
 #define DICT_TS           "dicomTS.dic"
 #define DICT_VR           "dicomVR.dic"
+#define DICT_GROUP_NAME   "DictGroupName.dic"
 
-#include <string>
+GDCM_EXPORT extern const std::string GDCM_UNKNOWN;
+GDCM_EXPORT extern const std::string GDCM_UNFOUND;
+GDCM_EXPORT extern const std::string GDCM_BINLOADED;
+GDCM_EXPORT extern const std::string GDCM_NOTLOADED;
+GDCM_EXPORT extern const std::string GDCM_UNREAD;
+
+/// \brief TagKey is made to hold the standard Dicom Tag (Group number, Element
+/// number)
+/// Instead of using the two '16 bits integers' as the Hask Table key, we
+/// converted into a string (e.g. 0x0018,0x0050 converted into "0018|0050")
+/// It appears to be a huge waste of time.
+/// We'll fix the mess up -without any change in the API- as soon as the bench
+/// marks are fully performed.
 
-const std::string GDCM_UNFOUND   = "gdcm::Unfound";   /// MEMORY LEAK
-const std::string GDCM_BINLOADED = "gdcm::Binary data loaded";
-const std::string GDCM_NOTLOADED = "gdcm::NotLoaded";
-const std::string GDCM_UNREAD    = "gdcm::UnRead";
-
-/// \brief gdcmTagKey is made to old an "universal" (as in URL, Universal
-///        Ressource Locator)  key to a gdcmDocEntry i.e. a dicom tag.
-///        A dicom tag allways has a group and an element, but a set of tags
-///        embeded in various (optionally nested) sequences and sharing
-///        the same group and element all share the same (group, element)
-///        "identifier". Hence the (group, element) cannot be used as an
-///        identifier (in gdcm we shall refer to a "TagKey") of a tag.
-///        In order to construct a proper tag identifier (i.e. a key) we
-///        consider the following definition of a TagKey:
-///        - let Group, Element be the string representation of the
-///          group and element dicom tag members,
-///        - let ItemNumber be the string representation of the integer
-///          index of the considered item number of a sequence,
-///        Let the key of a tag embeded in a sequence, noted SeqTag, be
-///        the form:
-///           /ItemNumber#Group|Element
-///        where "/", "#" and "|" are characters acting as separators.
-///        Then the general form of a gdcmTagKey is given by:
-///           Group|Element[SeqTag]
-///        where [SeqTag] means NO or many instances of SeqTag.
-///        Hence the gdcmTagKey of a tag not "leaving" in a sequence is the
-///        string e.g. 
-///            0028|1201
-///        but the gdcmTagKey of a tag "embeded" is the first item of
-///        a sequence, itself nested in the third item of a sequence is the
-///        string e.g.
-///            0004|1220/2#0008|0082/0#0008|0090
-typedef std::string gdcmTagKey;
+#if FASTTAGKEY
+typedef union   {
+      uint16_t  tab[2];
+      uint32_t  tagkey;
+    } TagKey;
+/* ostream operator for TagKey */
+inline std::ostream& operator<<(std::ostream& _O, TagKey _val)
+{
+  _O.setf( std::ios::right);
+  return (_O << std::hex << std::setw( 4 ) << std::setfill( '0' )
+     << _val.tab[0] << '|' << std::setw( 4 ) << std::setfill( '0' )
+     << _val.tab[1] << std::setfill( ' ' ) << std::dec);
+};
+inline bool operator==(TagKey _self, TagKey _val)
+{
+  return _self.tagkey == _val.tagkey;
+};
+inline bool operator<(TagKey _self, TagKey _val)
+{
+  // This expression is a tad faster but PrintFile output
+  // is more difficult to read
+  //return _self.tagkey < _val.tagkey;
+
+  // More usal order of dicom tags:
+  if( _self.tab[0] == _val.tab[0] )
+    return _self.tab[1] < _val.tab[1];
+  return _self.tab[0] < _val.tab[0];
+};
+#else
+typedef std::string TagKey;
+#endif
+#if defined(_MSC_VER) && (_MSC_VER == 1200)
+// Doing everything within gdcm namespace to avoid polluting 3d party software
+inline std::ostream& operator<<(std::ostream& _O, std::string _val)
+{
+  return _O << _val.c_str();
+};
+#endif
 typedef std::string TagName;
 
 enum FileType {
-      gdcmUnknown = 0,
-      gdcmExplicitVR, // gdcmDicomDir is in this case
-      gdcmImplicitVR,
-      gdcmACR,
-      gdcmACR_LIBIDO
+   Unknown = 0,
+   ExplicitVR, // DicomDir is in this case. Except when it's ImplicitVR !...
+   ImplicitVR,
+   ACR,
+   ACR_LIBIDO
+};
+
+/// \brief type of the elements composing a DICOMDIR (for internal use only)
+enum DicomDirType {
+   DD_UNKNOWN = 0,
+   DD_META,
+   DD_PATIENT,
+   DD_STUDY,
+   DD_SERIE,
+   DD_IMAGE,
+   DD_VISIT
+};
+
+/// \brief comparaison operators 
+enum CompOperators {
+   GDCM_EQUAL = 0,
+   GDCM_DIFFERENT,
+   GDCM_GREATER,
+   GDCM_GREATEROREQUAL,
+   GDCM_LESS,
+   GDCM_LESSOREQUAL
+};
+/**
+ * \brief structure, for internal use only
+ */  
+struct Element
+{
+   /// DicomGroup number
+   unsigned short int Group;
+   /// DicomElement number
+   unsigned short int Elem;
+   /// value (coded as a std::string) of the Element
+   std::string Value;
 };
 
+} //namespace gdcm
 //-----------------------------------------------------------------------------
 #endif