]> Creatis software - gdcm.git/blobdiff - src/gdcmCommon.h
ENH: gdcm now compiles on borland
[gdcm.git] / src / gdcmCommon.h
index 89e76f67d5c7f9b869784e966bc9326bf1accbda..62a71b7238ca4ad32c78d97557eb7a55a79c102f 100644 (file)
@@ -3,12 +3,12 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmCommon.h,v $
   Language:  C++
-  Date:      $Date: 2004/07/19 11:51:26 $
-  Version:   $Revision: 1.29 $
+  Date:      $Date: 2004/11/09 21:55:55 $
+  Version:   $Revision: 1.39 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
-  http://www.creatis.insa-lyon.fr/Public/Gdcm/License.htm for details.
+  http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
                                                                                 
      This software is distributed WITHOUT ANY WARRANTY; without even
      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
@@ -49,6 +49,7 @@
 #ifndef HAVE_NO_STDINT_H
 #include <stdint.h>   // For uint8_t uint16_t and uint32_t
 #else
+typedef    signed char   int8_t;
 typedef  unsigned char  uint8_t;
 typedef  unsigned short uint16_t;
 typedef  unsigned int   uint32_t;
@@ -56,20 +57,24 @@ typedef  unsigned int   uint32_t;
 #endif //HAVE_NO_STDINT_H
 #endif
 
-#ifdef _MSC_VER 
+#if defined( _MSC_VER) || defined(__BORLANDC__)
+typedef    signed char   int8_t;
 typedef  unsigned char  uint8_t;
 typedef  unsigned short uint16_t;
 typedef  unsigned int   uint32_t;
 #define UINT32_MAX    (4294967295U)
 #endif
 
-#ifdef _MSC_VER
+#if defined(_MSC_VER) || defined(__BORLANDC__)
 #define GDCM_EXPORT __declspec( dllexport )
-#define getcwd _getcwd
 #else
 #define GDCM_EXPORT
 #endif
 
+#ifdef _MSC_VER
+#define getcwd _getcwd
+#endif
+
 // ifdef for old gcc / broken compiler
 #ifdef GDCM_NO_ANSI_STRING_STREAM
 #  include <strstream>
@@ -78,6 +83,11 @@ typedef  unsigned int   uint32_t;
 #  include <sstream>
 #endif
 
+#include <string>
+#include <cassert>
+
+namespace gdcm
+{
 
 // Centralize information about the gdcm dictionary in only one file:
 #ifndef PUB_DICT_PATH
@@ -89,20 +99,48 @@ typedef  unsigned int   uint32_t;
 #define DICT_TS           "dicomTS.dic"
 #define DICT_VR           "dicomVR.dic"
 
-#include <string>
+const std::string GDCM_UNFOUND   = "gdcm::Unfound";
+const std::string GDCM_BINLOADED = "gdcm::Binary data loaded";
+const std::string GDCM_NOTLOADED = "gdcm::NotLoaded";
+const std::string GDCM_UNREAD    = "gdcm::UnRead";
 
-const std::string GDCM_UNFOUND = "gdcm::Unfound";   /// MEMORY LEAK
-
-typedef std::string gdcmTagKey;
+/// \brief TagKey is made to hold an "universal" (as in URL, Universal
+///        Ressource Locator)  key to a DocEntry i.e. a dicom tag.
+///        A dicom tag always 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 TagKey is given by:
+///           Group|Element[SeqTag]
+///        where [SeqTag] means NO or many instances of SeqTag.
+///        Hence the TagKey of a tag not "leaving" in a sequence is the
+///        string e.g. 
+///            0028|1201
+///        but the TagKey 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 TagKey;
 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
+      ImplicitVR,
+      ACR,
+      ACR_LIBIDO
 };
-
+} //namespace gdcm
 //-----------------------------------------------------------------------------
 #endif