]> Creatis software - gdcm.git/blobdiff - src/gdcmCommon.h
Doxygenation
[gdcm.git] / src / gdcmCommon.h
index 40e651014c4df5bfa2a98f2085e2871c0cd314f5..056fdbc53cc4dfead7c1d8be7fdc028048aa1738 100644 (file)
@@ -1,13 +1,34 @@
-//gdcmCommon.h
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmCommon.h,v $
+  Language:  C++
+  Date:      $Date: 2005/07/11 08:19:37 $
+  Version:   $Revision: 1.70 $
+                                                                                
+  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
 
+#include "gdcmConfigure.h"
+
+//-----------------------------------------------------------------------------
 //This is needed when compiling in debug mode
 #ifdef _MSC_VER
 // '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 )
 // return type for 'identifier' is '' (ie; not a UDT or reference to UDT. Will
 // produce errors if applied using infix notation
 #pragma warning ( disable : 4284 )
+// 'type' : forcing value to bool 'true' or 'false' (performance warning)
+// //#pragma warning ( disable : 4800 )
 #endif //_MSC_VER
 
-#ifdef __GNUC__
-#ifndef HAVE_NO_STDINT_H
-#include <stdint.h>
-#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
-#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 short guint16;
-typedef  unsigned int   guint32;
-typedef  short                 gint16;
-typedef  int                   gint32;
+// Basically for VS6 and bcc 5.5.1:
+#ifndef UINT32_MAX
 #define UINT32_MAX    (4294967295U)
 #endif
 
-#ifdef _MSC_VER
-#define GDCM_EXPORT __declspec( dllexport )
+#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
 
 #include <string>
 
-const std::string GDCM_UNFOUND = "gdcm::Unfound";
+/// \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 "gdcm.dic"
+#define DICT_ELEM         "DicomDir.dic"
+#define DICT_TS           "dicomTS.dic"
+#define DICT_VR           "dicomVR.dic"
+#define DICT_GROUP_NAME   "DictGroupName.dic"
+
+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.
 
 typedef std::string TagKey;
 typedef std::string TagName;
 
 enum FileType {
-      Unknown = 0,
-      ExplicitVR,
-      ImplicitVR,
-      ACR,
-      ACR_LIBIDO
+   Unknown = 0,
+   ExplicitVR, // DicomDir is in this case. Except when it's ImplicitVR !...
+   ImplicitVR,
+   ACR,
+   ACR_LIBIDO
 };
 
-//For now gdcm is not willing cmake, try to be more quiet
-//#cmakedefine GDCM_NO_ANSI_STRING_STREAM
+/// \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
+ */  
+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