src/gdcmCommon.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmCommon.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/07/19 14:43:48 $
   7   Version:   $Revision: 1.82 $
   8
   9   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
  10   l'Image). All rights reserved. See Doc/License.txt or
  11   http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
  12
  13      This software is distributed WITHOUT ANY WARRANTY; without even
  14      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15      PURPOSE.  See the above copyright notices for more information.
  16
  17 =========================================================================*/
  18
  19 #ifndef GDCMCOMMON_H
  20 #define GDCMCOMMON_H
  21
  22 #include "gdcmConfigure.h"
  23
  24 //-----------------------------------------------------------------------------
  25 //This is needed when compiling in debug mode
  26 #ifdef _MSC_VER
  27 // 'identifier' : class 'type' needs to have dll-interface to be used by
  28 // clients of class 'type2'
  29 #pragma warning ( disable : 4251 )
  30 // non dll-interface class 'type' used as base for dll-interface class 'type2'
  31 #pragma warning ( disable : 4275 )
  32 // 'identifier' : identifier was truncated to 'number' characters in the
  33 // debug information
  34 #pragma warning ( disable : 4786 )
  35 //'identifier' : decorated name length exceeded, name was truncated
  36 #pragma warning ( disable : 4503 )
  37 // C++ exception specification ignored except to indicate a
  38 // function is not __declspec(nothrow)
  39 #pragma warning ( disable : 4290 )
  40 // signed/unsigned mismatch
  41 #pragma warning ( disable : 4018 )
  42 // return type for 'identifier' is '' (ie; not a UDT or reference to UDT. Will
  43 // produce errors if applied using infix notation
  44 #pragma warning ( disable : 4284 )
  45 // 'type' : forcing value to bool 'true' or 'false' (performance warning)
  46 // //#pragma warning ( disable : 4800 )
  47 #endif //_MSC_VER
  48
  49 //-----------------------------------------------------------------------------
  50 #ifdef CMAKE_HAVE_STDINT_H
  51    #include <stdint.h>
  52 #else
  53 #ifdef CMAKE_HAVE_INTTYPES_H
  54    // Old system only have this
  55    #include <inttypes.h>   // For uint8_t uint16_t and uint32_t
  56 #else
  57 // Broken plateform do not respect C99 and do not provide those typedef
  58 // Special case for recent borland compiler, comes with stdint.h
  59 #if defined(_MSC_VER) || defined(__BORLANDC__) && (__BORLANDC__ < 0x0560)  || defined(__MINGW32__)
  60 typedef  signed char         int8_t;
  61 typedef  signed short        int16_t;
  62 typedef  signed int          int32_t;
  63 typedef  unsigned char       uint8_t;
  64 typedef  unsigned short      uint16_t;
  65 typedef  unsigned int        uint32_t;
  66 #else
  67 #error "Sorry your plateform is not supported"
  68 #endif // defined(_MSC_VER) || defined(__BORLANDC__) && (__BORLANDC__ < 0x0560)  || defined(__MINGW32__)
  69 #endif // CMAKE_HAVE_INTTYPES_H
  70 #endif // CMAKE_HAVE_STDINT_H
  71
  72 // Basically for VS6 and bcc 5.5.1:
  73 #ifndef UINT32_MAX
  74 #define UINT32_MAX    (4294967295U)
  75 #endif
  76
  77 #if defined(_WIN32) && defined(BUILD_SHARED_LIBS)
  78   #ifdef gdcm_EXPORTS
  79     #define GDCM_EXPORT __declspec( dllexport )
  80   #else
  81     #define GDCM_EXPORT __declspec( dllimport )
  82   #endif
  83 #else
  84   #define GDCM_EXPORT
  85 #endif
  86
  87 #include <string>
  88 #define FASTTAGKEY 0
  89
  90 // FIXME: Should rewrite this:
  91 #if FASTTAGKEY
  92 #include <iostream>
  93 #include <iomanip>
  94 #endif
  95 #if defined(_MSC_VER) && (_MSC_VER == 1200)
  96 /* ostream operator for std::string since VS6 does not provide it*/
  97 #include <iostream>
  98 #endif
  99
 100
 101 //-----------------------------------------------------------------------------
 102 /// \brief namespace for Grass root DiCoM
 103 namespace gdcm
 104 {
 105
 106 // Centralize information about the gdcm dictionary in only one file:
 107 #ifndef PUB_DICT_PATH
 108 #  define PUB_DICT_PATH   "../Dicts/"
 109 #endif
 110 #define PUB_DICT_NAME     "DicomV3Dict"
 111 #define PUB_DICT_FILENAME "gdcm.dic"
 112 #define DICT_ELEM         "DicomDir.dic"
 113 #define DICT_TS           "dicomTS.dic"
 114 #define DICT_VR           "dicomVR.dic"
 115 #define DICT_GROUP_NAME   "DictGroupName.dic"
 116
 117 GDCM_EXPORT extern const std::string GDCM_UNKNOWN;
 118 GDCM_EXPORT extern const std::string GDCM_UNFOUND;
 119 GDCM_EXPORT extern const std::string GDCM_BINLOADED;
 120 GDCM_EXPORT extern const std::string GDCM_NOTLOADED;
 121 GDCM_EXPORT extern const std::string GDCM_UNREAD;
 122
 123 /// \brief TagKey is made to hold the standard Dicom Tag (Group number, Element
 124 /// number)
 125 /// Instead of using the two '16 bits integers' as the Hask Table key, we
 126 /// converted into a string (e.g. 0x0018,0x0050 converted into "0018|0050")
 127 /// It appears to be a huge waste of time.
 128 /// We'll fix the mess up -without any change in the API- as soon as the bench
 129 /// marks are fully performed.
 130
 131 #if FASTTAGKEY
 132 typedef union   {
 133       uint16_t  tab[2];
 134       uint32_t  tagkey;
 135     } TagKey;
 136 /* ostream operator for TagKey */
 137 inline std::ostream& operator<<(std::ostream& _O, TagKey _val)
 138 {
 139   _O.setf( std::ios::right);
 140   return (_O << std::hex << std::setw( 4 ) << std::setfill( '0' )
 141      << _val.tab[0] << '|' << std::setw( 4 ) << std::setfill( '0' )
 142      << _val.tab[1] << std::setfill( ' ' ) << std::dec);
 143 };
 144 inline bool operator==(TagKey _self, TagKey _val)
 145 {
 146   return _self.tagkey == _val.tagkey;
 147 };
 148 inline bool operator<(TagKey _self, TagKey _val)
 149 {
 150   // This expression is a tad faster but PrintFile output
 151   // is more difficult to read
 152   //return _self.tagkey < _val.tagkey;
 153
 154   // More usal order of dicom tags:
 155   if( _self.tab[0] == _val.tab[0] )
 156     return _self.tab[1] < _val.tab[1];
 157   return _self.tab[0] < _val.tab[0];
 158 };
 159 #else
 160 typedef std::string TagKey;
 161 #endif
 162 #if defined(_MSC_VER) && (_MSC_VER == 1200)
 163 // Doing everything within gdcm namespace to avoid polluting 3d party software
 164 inline std::ostream& operator<<(std::ostream& _O, std::string _val)
 165 {
 166   return _O << _val.c_str();
 167 };
 168 #endif
 169 typedef std::string TagName;
 170
 171 enum FileType {
 172    Unknown = 0,
 173    ExplicitVR, // DicomDir is in this case. Except when it's ImplicitVR !...
 174    ImplicitVR,
 175    ACR,
 176    ACR_LIBIDO
 177 };
 178
 179 /// \brief type of the elements composing a DICOMDIR (for internal use only)
 180 enum DicomDirType {
 181    DD_UNKNOWN = 0,
 182    DD_META,
 183    DD_PATIENT,
 184    DD_STUDY,
 185    DD_SERIE,
 186    DD_IMAGE,
 187    DD_VISIT
 188 };
 189
 190 /// \brief comparaison operators
 191 enum CompOperators {
 192    GDCM_EQUAL = 0,
 193    GDCM_DIFFERENT,
 194    GDCM_GREATER,
 195    GDCM_GREATEROREQUAL,
 196    GDCM_LESS,
 197    GDCM_LESSOREQUAL
 198 };
 199 /**
 200  * \brief structure, for internal use only
 201  */
 202 struct Element
 203 {
 204    /// DicomGroup number
 205    unsigned short int Group;
 206    /// DicomElement number
 207    unsigned short int Elem;
 208    /// value (coded as a std::string) of the Element
 209    std::string Value;
 210 };
 211
 212 } //namespace gdcm
 213 //-----------------------------------------------------------------------------
 214 #endif