Update comments for DicomDir stuff

[gdcm.git] / src / gdcmCommon.h

diff --git a/src/gdcmCommon.h b/src/gdcmCommon.h
index 62a71b7238ca4ad32c78d97557eb7a55a79c102f..b4eb0d9614f7edc5ed2c84b68c66511e75be2aab 100644 (file)
--- a/src/gdcmCommon.h
+++ b/src/gdcmCommon.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmCommon.h,v $
   Language:  C++
-  Date:      $Date: 2004/11/09 21:55:55 $
-  Version:   $Revision: 1.39 $
+  Date:      $Date: 2005/02/06 14:31:09 $
+  Version:   $Revision: 1.60 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -45,46 +45,37 @@
 #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    signed char   int8_t;
-typedef  unsigned char  uint8_t;
-typedef  unsigned short uint16_t;
-typedef  unsigned int   uint32_t;
-#define UINT32_MAX    (4294967295U)
-#endif //HAVE_NO_STDINT_H
+#ifdef CMAKE_HAVE_INTTYPES_H
+   // Old system only have this
+   #include <inttypes.h>   // For uint8_t uint16_t and uint32_t
 #endif
-
-#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
 
+// Broken plateform do not respect C99 and do not provide those typedef
 #if defined(_MSC_VER) || defined(__BORLANDC__)
-#define GDCM_EXPORT __declspec( dllexport )
-#else
-#define GDCM_EXPORT
-#endif
-
-#ifdef _MSC_VER
-#define getcwd _getcwd
+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;
+#define UINT32_MAX    (4294967295U)
 #endif
 
-// ifdef for old gcc / broken compiler
-#ifdef GDCM_NO_ANSI_STRING_STREAM
-#  include <strstream>
-#  define  ostringstream ostrstream
-# else
-#  include <sstream>
+#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
 #endif
 
 #include <string>
-#include <cassert>
 
 namespace gdcm
 {
@@ -99,22 +90,23 @@ namespace gdcm
 #define DICT_TS           "dicomTS.dic"
 #define DICT_VR           "dicomVR.dic"
 
-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";
+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 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
+///        Ressource Locator) key to a DocEntry i.e. a dicom tag.
+///        A dicom tag always has a group and an elem, 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
+///        the same group and elem all share the same (group, elem)
+///        "identifier". Hence the (group, elem) 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,
+///          group and elem 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
@@ -135,12 +127,35 @@ typedef std::string TagKey;
 typedef std::string TagName;
 
 enum FileType {
-      Unknown = 0,
-      ExplicitVR, // DicomDir is in this case
-      ImplicitVR,
-      ACR,
-      ACR_LIBIDO
+   Unknown = 0,
+   ExplicitVR, // DicomDir is in this case. Except when it's ImplicitVR !...
+   ImplicitVR,
+   ACR,
+   ACR_LIBIDO
+};
+
+enum DicomDirType {
+   DD_UNKNOWN = 0,
+   DD_META,
+   DD_PATIENT,
+   DD_STUDY,
+   DD_SERIE,
+   DD_IMAGE
 };
+
+/**
+ * \brief structure, for internal use only
+ */  
+GDCM_EXPORT typedef struct
+{
+   /// DicomGroup number
+   unsigned short int Group;
+   /// DicomElement number
+   unsigned short int Elem;
+   /// value (coded as a std::string) of the Element
+   std::string Value;
+} Element;
+
 } //namespace gdcm
 //-----------------------------------------------------------------------------
 #endif