]> Creatis software - gdcm.git/blobdiff - src/gdcmUtil.cxx
ENH: Adding a deprecation mechanism to gdcm via two MACRO and two config options
[gdcm.git] / src / gdcmUtil.cxx
index 316ab03f8a05e9dad3187a93cf93ab0bde5ad69c..6551051bf31cb213d096f681f0ca95faf5c0b65c 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmUtil.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/02/14 16:20:30 $
-  Version:   $Revision: 1.145 $
+  Date:      $Date: 2005/07/18 10:20:20 $
+  Version:   $Revision: 1.157 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
 #include <stdarg.h>  //only included in implementation file
 #include <stdio.h>   //only included in implementation file
 
-#if defined(_MSC_VER) || defined(__MINGW32__)
-   #include <winsock.h>  // for gethostname and gethostbyname
+#if defined(_MSC_VER) || defined(__BORLANDC__) || defined(__MINGW32__)
+   #include <winsock.h>  // for gethostname and gethostbyname and GetTickCount...
+// I haven't find a way to determine wether we need to under GetCurrentTime or not...
+// I think the best solution would simply to get rid of this problematic function
+// and use a 'less' common name...
+#if !defined(__BORLANDC__) || (__BORLANDC__ >= 0x0560)
    #undef GetCurrentTime
+#endif
 #else
-#ifndef __BORLANDC__
    #include <unistd.h>  // for gethostname
    #include <netdb.h>   // for gethostbyname
 #endif
-#endif
 
 // For GetMACAddress
 #ifdef _WIN32
@@ -92,6 +95,9 @@ namespace gdcm
 //-------------------------------------------------------------------------
 const std::string Util::GDCM_UID = "1.2.826.0.1.3680043.2.1143";
 std::string Util::RootUID        = GDCM_UID;
+const uint16_t Util::FMIV = 0x0001;
+uint8_t *Util::FileMetaInformationVersion = (uint8_t *)&FMIV;
+std::string Util::GDCM_MAC_ADRESS = GetMACAddress();
 
 //-------------------------------------------------------------------------
 // Public
@@ -184,17 +190,17 @@ std::string Util::CreateCleanString(std::string const &s)
 
    for(unsigned int i=0; i<str.size(); i++)
    {
-      if(!isprint((unsigned char)str[i]))
+      if (!isprint((unsigned char)str[i]) )
       {
          str[i] = '.';
       }
    }
 
-   if(str.size() > 0)
+   if (str.size() > 0 )
    {
-      if(!isprint((unsigned char)s[str.size()-1]))
+      if (!isprint((unsigned char)s[str.size()-1]) )
       {
-         if(s[str.size()-1] == 0)
+         if (s[str.size()-1] == 0 )
          {
             str[str.size()-1] = ' ';
          }
@@ -216,7 +222,7 @@ std::string Util::NormalizePath(std::string const &pathname)
    std::string name = pathname;
    int size = name.size();
 
-   if( name[size-1] != SEPARATOR_X && name[size-1] != SEPARATOR_WIN )
+   if ( name[size-1] != SEPARATOR_X && name[size-1] != SEPARATOR_WIN )
    {
       name += SEPARATOR;
    }
@@ -232,7 +238,7 @@ std::string Util::GetPath(std::string const &fullName)
    std::string res = fullName;
    int pos1 = res.rfind("/");
    int pos2 = res.rfind("\\");
-   if( pos1 > pos2)
+   if ( pos1 > pos2 )
    {
       res.resize(pos1);
    }
@@ -255,7 +261,7 @@ std::string Util::GetName(std::string const &fullName)
   std::string::size_type slash_pos = filename.rfind("/");
   std::string::size_type backslash_pos = filename.rfind("\\");
   slash_pos = slash_pos > backslash_pos ? slash_pos : backslash_pos;
-  if(slash_pos != std::string::npos)
+  if (slash_pos != std::string::npos )
     {
     return filename.substr(slash_pos + 1);
     }
@@ -291,7 +297,7 @@ std::string Util::GetCurrentTime()
 
 /**
  * \brief  Get both the date and time at the same time to avoid problem 
- * around midnight where two call could be before and after midnight
+ * around midnight where the two calls could be before and after midnight
  */
 std::string Util::GetCurrentDateTime()
 {
@@ -318,10 +324,11 @@ std::string Util::GetCurrentDateTime()
    strftime (tmp, sizeof (tmp), "%Y%m%d%H%M%S", ptm);
 
    // Add milliseconds
-   std::string r = tmp;
-   r += Format("%03ld", milliseconds);
+   // Don't use Util::Format to accelerate execution of code
+   char tmpAll[80];
+   sprintf(tmpAll,"%s%03ld",tmp,milliseconds);
 
-   return r;
+   return tmpAll;
 }
 
 unsigned int Util::GetCurrentThreadID()
@@ -329,18 +336,20 @@ unsigned int Util::GetCurrentThreadID()
 // FIXME the implementation is far from complete
 #if defined(_MSC_VER) || defined(__BORLANDC__) || defined(__MINGW32__)
   return (unsigned int)GetCurrentThreadId();
-#endif
+#else
 #ifdef __linux__
    return 0;
    // Doesn't work on fedora, but is in the man page...
    //return (unsigned int)gettid();
-#endif
+#else
 #ifdef __sun
    return (unsigned int)thr_self();
 #else
    //default implementation
    return 0;
-#endif
+#endif // __sun
+#endif // __linux__
+#endif // Win32
 }
 
 unsigned int Util::GetCurrentProcessID()
@@ -355,7 +364,7 @@ unsigned int Util::GetCurrentProcessID()
 }
 
 /**
- * \brief   tells us if the processor we are working with is BigEndian or not
+ * \brief   tells us whether the processor we are working with is BigEndian or not
  */
 bool Util::IsCurrentProcessorBigEndian()
 {
@@ -370,7 +379,7 @@ bool Util::IsCurrentProcessorBigEndian()
  * \brief Create a /DICOM/ string:
  * It should a of even length (no odd length ever)
  * It can contain as many (if you are reading this from your
- * editor the following character is is backslash followed by zero
+ * editor the following character is backslash followed by zero
  * that needed to be escaped with an extra backslash for doxygen) \\0
  * as you want.
  */
@@ -385,7 +394,7 @@ std::string Util::DicomString(const char *s, size_t l)
  * \brief Create a /DICOM/ string:
  * It should a of even length (no odd length ever)
  * It can contain as many (if you are reading this from your
- * editor the following character is is backslash followed by zero
+ * editor the following character is backslash followed by zero
  * that needed to be escaped with an extra backslash for doxygen) \\0
  * as you want.
  * This function is similar to DicomString(const char*), 
@@ -395,7 +404,7 @@ std::string Util::DicomString(const char *s, size_t l)
 std::string Util::DicomString(const char *s)
 {
    size_t l = strlen(s);
-   if( l%2 )
+   if ( l%2 )
    {
       l++;
    }
@@ -405,23 +414,58 @@ std::string Util::DicomString(const char *s)
 }
 
 /**
- * \brief Safely compare two Dicom String:
- *        - Both string should be of even length
+ * \brief Safely check the equality of two Dicom String:
+ *        - Both strings should be of even length
  *        - We allow padding of even length string by either a null 
  *          character of a space
  */
 bool Util::DicomStringEqual(const std::string &s1, const char *s2)
 {
-  // s2 is the string from the DICOM reference: 'MONOCHROME1'
+  // s2 is the string from the DICOM reference e.g. : 'MONOCHROME1'
   std::string s1_even = s1; //Never change input parameter
   std::string s2_even = DicomString( s2 );
-  if( s1_even[s1_even.size()-1] == ' ')
+  if ( s1_even[s1_even.size()-1] == ' ' )
   {
     s1_even[s1_even.size()-1] = '\0'; //replace space character by null
   }
   return s1_even == s2_even;
 }
 
+/**
+ * \brief Safely compare two Dicom String:
+ *        - Both strings should be of even length
+ *        - We allow padding of even length string by either a null 
+ *          character of a space
+ */
+bool Util::CompareDicomString(const std::string &s1, const char *s2, int op)
+{
+  // s2 is the string from the DICOM reference e.g. : 'MONOCHROME1'
+  std::string s1_even = s1; //Never change input parameter
+  std::string s2_even = DicomString( s2 );
+  if ( s1_even[s1_even.size()-1] == ' ' )
+  {
+    s1_even[s1_even.size()-1] = '\0'; //replace space character by null
+  }
+  switch (op)
+  {
+     case GDCM_EQUAL :
+        return s1_even == s2_even;
+     case GDCM_DIFFERENT :  
+        return s1_even != s2_even;
+     case GDCM_GREATER :  
+        return s1_even >  s2_even;  
+     case GDCM_GREATEROREQUAL :  
+        return s1_even >= s2_even;
+     case GDCM_LESS :
+        return s1_even <  s2_even;
+     case GDCM_LESSOREQUAL :
+        return s1_even <= s2_even;
+     default :
+        gdcmDebugMacro(" Wrong operator : " << op);
+        return false;
+  }
+}
+
 #ifdef _WIN32
    typedef BOOL(WINAPI * pSnmpExtensionInit) (
            IN DWORD dwTimeZeroReference,
@@ -446,13 +490,15 @@ bool Util::DicomStringEqual(const std::string &s1, const char *s2)
 #endif //_WIN32
 
 /// \brief gets current M.A.C adress (for internal use only)
+int GetMacAddrSys ( unsigned char *addr );
 int GetMacAddrSys ( unsigned char *addr )
 {
 #ifdef _WIN32
    WSADATA WinsockData;
-   if (WSAStartup(MAKEWORD(2, 0), &WinsockData) != 0
+   if ( (WSAStartup(MAKEWORD(2, 0), &WinsockData)) != 0 
    {
-      std::cerr << "This program requires Winsock 2.x!" << std::endl;
+      std::cerr << "in Get MAC Adress (internal) : This program requires Winsock 2.x!" 
+             << std::endl;
       return -1;
    }
 
@@ -546,7 +592,8 @@ int GetMacAddrSys ( unsigned char *addr )
                  && (varBind[1].value.asnValue.address.stream[4] == 0x00) )
                {
                    // Ignore all dial-up networking adapters
-                   std::cerr << "Interface #" << j << " is a DUN adapter\n";
+                   std::cerr << "in Get MAC Adress (internal) : Interface #" 
+                             << j << " is a DUN adapter\n";
                    continue;
                }
                if ( (varBind[1].value.asnValue.address.stream[0] == 0x00)
@@ -558,7 +605,8 @@ int GetMacAddrSys ( unsigned char *addr )
                {
                   // Ignore NULL addresses returned by other network
                   // interfaces
-                  std::cerr << "Interface #" << j << " is a NULL address\n";
+                  std::cerr << "in Get MAC Adress (internal) :  Interface #" 
+                            << j << " is a NULL address\n";
                   continue;
                }
                memcpy( addr, varBind[1].value.asnValue.address.stream, 6);
@@ -575,7 +623,7 @@ int GetMacAddrSys ( unsigned char *addr )
 
 
 // implementation for POSIX system
-#ifdef __sun
+#if defined(CMAKE_HAVE_NET_IF_ARP_H) && defined(__sun)
    //The POSIX version is broken anyway on Solaris, plus would require full
    //root power
    struct  arpreq          parpreq;
@@ -585,18 +633,18 @@ int GetMacAddrSys ( unsigned char *addr )
    char                    **paddrs;
    int                     sock, status=0;
 
-   if(gethostname(hostname,  MAXHOSTNAMELEN) != 0)
+   if (gethostname(hostname,  MAXHOSTNAMELEN) != 0 )
    {
-      perror("gethostname");
+      perror("in Get MAC Adress (internal) : gethostname");
       return -1;
    }
    phost = gethostbyname(hostname);
    paddrs = phost->h_addr_list;
 
    sock = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP);
-   if(sock == -1)
+   if (sock == -1 )
    {
-      perror("sock");
+      perror("in Get MAC Adress (internal) : sock");
       return -1;
    }
    memset(&parpreq, 0, sizeof(struct arpreq));
@@ -607,9 +655,9 @@ int GetMacAddrSys ( unsigned char *addr )
    memcpy(&psa->sin_addr, *paddrs, sizeof(struct in_addr));
 
    status = ioctl(sock, SIOCGARP, &parpreq);
-   if(status == -1)
+   if (status == -1 )
    {
-      perror("SIOCGARP");
+      perror("in Get MAC Adress (internal) : SIOCGARP");
       return -1;
    }
    memcpy(addr, parpreq.arp_ha.sa_data, 6);
@@ -632,7 +680,7 @@ int GetMacAddrSys ( unsigned char *addr )
 // max(sizeof(ifreq), sizeof(ifreq.ifr_name)+ifreq.ifr_addr.sa_len
 // However, under earlier systems, sa_len isn't present, so the size is 
 // just sizeof(struct ifreq)
-// We should investiage the use of SIZEOF_ADDR_IFREQ
+// We should investigate the use of SIZEOF_ADDR_IFREQ
 //
 #ifdef HAVE_SA_LEN
    #ifndef max
@@ -644,7 +692,7 @@ int GetMacAddrSys ( unsigned char *addr )
    #define ifreq_size(i) sizeof(struct ifreq)
 #endif // HAVE_SA_LEN
 
-   if( (sd = socket(AF_INET, SOCK_DGRAM, IPPROTO_IP)) < 0 )
+   if ( (sd = socket(AF_INET, SOCK_DGRAM, IPPROTO_IP)) < 0 )
    {
       return -1;
    }
@@ -682,7 +730,7 @@ int GetMacAddrSys ( unsigned char *addr )
          continue;
       a = (unsigned char *) &sdlp->sdl_data[sdlp->sdl_nlen];
 #else
-      perror("No way to access hardware");
+      perror("in Get MAC Adress (internal) : No way to access hardware");
       close(sd);
       return -1;
 #endif // AF_LINK
@@ -700,7 +748,7 @@ int GetMacAddrSys ( unsigned char *addr )
    close(sd);
 #endif
    // Not implemented platforms
-   perror("There was a configuration problem on your plateform");
+   perror("in Get MAC Adress (internal) : There was a configuration problem on your plateform");
    memset(addr,0,6);
    return -1;
 #endif //__sun
@@ -772,7 +820,7 @@ std::string Util::CreateUniqueUID(const std::string &root)
 {
    std::string prefix;
    std::string append;
-   if( root.empty() )
+   if ( root.empty() )
    {
       // gdcm UID prefix, as supplied by http://www.medicalconnections.co.uk
       prefix = RootUID; 
@@ -784,16 +832,20 @@ std::string Util::CreateUniqueUID(const std::string &root)
 
    // A root was specified use it to forge our new UID:
    append += ".";
-   append += Util::GetMACAddress();
+   //append += Util::GetMACAddress(); // to save CPU time
+   append += Util::GDCM_MAC_ADRESS;
    append += ".";
    append += Util::GetCurrentDateTime();
 
    //Also add a mini random number just in case:
+   char tmp[10];
    int r = (int) (100.0*rand()/RAND_MAX);
-   append += Format("%02d", r);
+   // Don't use Util::Format to accelerate the execution
+   sprintf(tmp,"%02d", r);
+   append += tmp;
 
    // If append is too long we need to rehash it
-   if( (prefix + append).size() > 64 )
+   if ( (prefix + append).size() > 64 )
    {
       gdcmErrorMacro( "Size of UID is too long." );
       // we need a hash function to truncate this number
@@ -806,7 +858,7 @@ std::string Util::CreateUniqueUID(const std::string &root)
 
 void Util::SetRootUID(const std::string &root)
 {
-   if( root.empty() )
+   if ( root.empty() )
       RootUID = GDCM_UID;
    else
       RootUID = root;
@@ -977,7 +1029,7 @@ std::string Util::GetIPAddress()
    char szHostName[HOST_NAME_MAX+1];
    int r = gethostname(szHostName, HOST_NAME_MAX);
  
-   if( r == 0 )
+   if ( r == 0 )
    {
       // Get host adresses
       struct hostent *pHost = gethostbyname(szHostName);
@@ -986,7 +1038,7 @@ std::string Util::GetIPAddress()
       {
          for( int j = 0; j<pHost->h_length; j++ )
          {
-            if( j > 0 ) str += ".";
+            if ( j > 0 ) str += ".";
  
             str += Util::Format("%u", 
                 (unsigned int)((unsigned char*)pHost->h_addr_list[i])[j]);