]> Creatis software - gdcm.git/blobdiff - src/gdcmCommon.h
* src/gdcmDictGroupName.[h|cxx] : add a correlation between a group (number)
[gdcm.git] / src / gdcmCommon.h
index 0af21208d3643698614776e408519bed1d07d5fb..26ded6d39b3c440f619d9c68ca50a5cd4748bcf2 100644 (file)
@@ -1,5 +1,21 @@
-//gdcmCommon.h
-//-----------------------------------------------------------------------------
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmCommon.h,v $
+  Language:  C++
+  Date:      $Date: 2005/04/05 10:56:25 $
+  Version:   $Revision: 1.63 $
+                                                                                
+  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.html for details.
+                                                                                
+     This software is distributed WITHOUT ANY WARRANTY; without even
+     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+     PURPOSE.  See the above copyright notices for more information.
+                                                                                
+=========================================================================*/
+
 #ifndef GDCMCOMMON_H
 #define GDCMCOMMON_H
 
@@ -11,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
-//#if defined __STDC_LIMIT_MACROS
-//#endif
-#include <stdint.h>
-//#ifdef UINT32_MAX
-//#error hehrehhehehehe2
-//#endif
-#define guint16 uint16_t
-#define guint32 uint32_t
-#define gint16  int16_t
-#define gint32  int32_t
+#ifdef CMAKE_HAVE_STDINT_H
+   #include <stdint.h>
 #else
-typedef  unsigned short guint16;
-typedef  unsigned int   guint32;
-typedef  short          gint16;
-typedef  int                   gint32;
-#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
 #endif
 
-#ifdef _MSC_VER 
-typedef  unsigned short guint16;
-typedef  unsigned int   guint32;
-typedef  short                 gint16;
-typedef  int            gint32;
+// Broken plateform do not respect C99 and do not provide those typedef
+#if defined(_MSC_VER) || defined(__BORLANDC__)
+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 _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>
-#endif
+#include <string>
 
+/// \brief namespace for Grass root DiCoM
+namespace gdcm
+{
 
 // Centralize information about the gdcm dictionary in only one file:
 #ifndef PUB_DICT_PATH
@@ -83,21 +92,75 @@ typedef  int            gint32;
 #define DICT_ELEM         "DicomDir.dic"
 #define DICT_TS           "dicomTS.dic"
 #define DICT_VR           "dicomVR.dic"
+#define DICT_GROUP_NAME   "DictGroupName.dic"
 
-#include <string>
-
-const std::string GDCM_UNFOUND = "gdcm::Unfound";
+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 elem, but a set of tags
+///        embeded in various (optionally nested) sequences and sharing
+///        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 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
+///        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 {
-      Unknown = 0,
-      ExplicitVR, // gdcmDicomDir 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
 };
 
+/// \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
+};
+
+/**
+ * \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