src/gdcmUtil.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmUtil.h,v $
   5   Language:  C++
   6   Date:      $Date: 2007/08/22 16:14:05 $
   7   Version:   $Revision: 1.69 $
   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 _GDCMUTIL_H_
  20 #define _GDCMUTIL_H_
  21
  22 #include "gdcmCommon.h"
  23 #include <vector>
  24 #include <string>
  25
  26 namespace GDCM_NAME_SPACE
  27 {
  28 /**
  29  * \brief    Here are some utility functions, belonging to the gdcm::Util class,
  30  *           dealing with strings, file names... that can be called
  31  *           from anywhere by whomsoever they can help.
  32  */
  33
  34 //-----------------------------------------------------------------------------
  35
  36 class GDCM_EXPORT Util
  37 {
  38 public:
  39    static std::string Format(const char *format, ...);
  40    static void        Tokenize (const std::string &str,
  41                                 std::vector<std::string> &tokens,
  42                                 const std::string &delimiters = " ");
  43    static int         CountSubstring (const std::string &str,
  44                                       const std::string &subStr);
  45
  46    static std::string CreateCleanString(std::string const &s);
  47    static std::string CreateCleanString(uint8_t *s, int l);
  48    static bool IsCleanString(std::string const &s);
  49    static bool IsCleanArea(uint8_t *s, int l);
  50    static std::string NormalizePath(std::string const &name);
  51    static std::string GetPath(std::string const &fullName);
  52    static std::string GetName(std::string const &fullName);
  53    static std::string GetCurrentDate();
  54    static std::string GetCurrentTime();
  55    static std::string GetCurrentDateTime();
  56    /// Provides a simple static GetVersion() function
  57    static std::string GetVersion()
  58                       { return GDCM_VERSION;}
  59    static unsigned int GetCurrentThreadID();
  60    static unsigned int GetCurrentProcessID();
  61    static bool         IsCurrentProcessorBigEndian();
  62
  63    static std::string DicomString(const char *s, size_t l);
  64    static std::string DicomString(const char *s);
  65    static bool        DicomStringEqual(const std::string &s1, const char *s2);
  66    static bool        CompareDicomString(const std::string &s1,
  67                                          const char *s2, int op);
  68    static std::string GetMACAddress();
  69
  70    static std::string CreateUniqueUID(const std::string &root = "");
  71    static void SetRootUID(const std::string &root = "");
  72    static const std::string &GetRootUID();
  73
  74    static const uint8_t *GetFileMetaInformationVersion()
  75                      { return FileMetaInformationVersion;}
  76    static void SetFileMetaInformationVersion( uint16_t fmiv )
  77                      { FileMetaInformationVersion = (uint8_t *)&fmiv; }
  78
  79 // ----------------- to be removed later --------------------------
  80 //To perform a full check of inline functions on all the platforms,
  81 // we put here the two 'static' functions
  82 // hifpswap and  hNoifpswap in a .h
  83 // They will be remove ASAP
  84
  85    inline void hifpswap(double *a, double *b)
  86    {
  87       double tmp;
  88       tmp = *a;
  89       *a = *b;
  90       *b = tmp;
  91    }
  92    void hNoifpswap(double *a, double *b)
  93    {
  94       double tmp;
  95       tmp = *a;
  96       *a = *b;
  97       *b = tmp;
  98    }
  99    void hfpswap(double *a, double *b);
 100    static inline void sthifpswap(double *a, double *b)
 101    {
 102       double tmp;
 103       tmp = *a;
 104       *a = *b;
 105       *b = tmp;
 106    }
 107    static void sthNoifpswap(double *a, double *b)
 108    {
 109       double tmp;
 110       tmp = *a;
 111       *a = *b;
 112       *b = tmp;
 113    }
 114 // ------------ end of functions to remove --------------------
 115
 116 // For MD5
 117 static std::string ConvertToMD5 (std::string &stringToCrypt);
 118
 119 private:
 120    static std::string GetIPAddress(); //Do not expose this method
 121
 122    static std::string RootUID;
 123    static const std::string GDCM_UID;
 124    static uint8_t *FileMetaInformationVersion;
 125    static const uint16_t FMIV;
 126    static std::string GDCM_MAC_ADRESS;
 127
 128 // For MD5
 129
 130 /*
 131   Copyright (C) 1999, 2002 Aladdin Enterprises.  All rights reserved.
 132   This software is provided 'as-is', without any express or implied
 133   warranty.  In no event will the authors be held liable for any damages
 134   arising from the use of this software.
 135
 136   Permission is granted to anyone to use this software for any purpose,
 137   including commercial applications, and to alter it and redistribute it
 138   freely, subject to the following restrictions:
 139
 140   1. The origin of this software must not be misrepresented; you must not
 141      claim that you wrote the original software. If you use this software
 142      in a product, an acknowledgment in the product documentation would be
 143      appreciated but is not required.
 144   2. Altered source versions must be plainly marked as such, and must not be
 145      misrepresented as being the original software.
 146   3. This notice may not be removed or altered from any source distribution.
 147
 148   L. Peter Deutsch
 149   ghost@aladdin.com
 150 */
 151
 152 /* $Id: gdcmUtil.h,v 1.69 2007/08/22 16:14:05 jpr Exp $ */
 153 /*
 154   Independent implementation of MD5 (RFC 1321).
 155   This code implements the MD5 Algorithm defined in RFC 1321, whose
 156   text is available at
 157  http://www.ietf.org/rfc/rfc1321.txt
 158   The code is derived from the text of the RFC, including the test suite
 159   (section A.5) but excluding the rest of Appendix A.  It does not include
 160   any code or documentation that is identified in the RFC as being
 161   copyrighted.
 162   The original and principal author of md5.h is L. Peter Deutsch
 163   <ghost@aladdin.com>.  Other authors are noted in the change history
 164   that follows (in reverse chronological order):
 165   2002-04-13 lpd Removed support for non-ANSI compilers; removed
 166        references to Ghostscript; clarified derivation from RFC 1321;
 167        now handles byte order either statically or dynamically.
 168   1999-11-04 lpd Edited comments slightly for automatic TOC extraction.
 169   1999-10-18 lpd Fixed typo in header comment (ansi2knr rather than md5);
 170        added conditionalization for C++ compilation from
 171        Martin Purschke <purschke@bnl.gov>.
 172   1999-05-03 lpd Original version.
 173  */
 174
 175 /*
 176  * This package supports both compile-time and run-time determination of CPU
 177  * byte order.  If ARCH_IS_BIG_ENDIAN is defined as 0, the code will be
 178  * compiled to run only on little-endian CPUs; if ARCH_IS_BIG_ENDIAN is
 179  * defined as non-zero, the code will be compiled to run only on big-endian
 180  * CPUs; if ARCH_IS_BIG_ENDIAN is not defined, the code will be compiled to
 181  * run on either big- or little-endian CPUs, but will run slightly less
 182  * efficiently on either one than if ARCH_IS_BIG_ENDIAN is defined.
 183  */
 184
 185 /* Define the state of the MD5 Algorithm. */
 186 typedef struct md5_state_s {
 187     uint32_t count[2];   /* message length in bits, lsw first */
 188     uint32_t abcd[4];    /* digest buffer    */
 189     uint8_t buf[64];     /* accumulate block */
 190 } md5_state_t;
 191
 192    static void md5_process(md5_state_t *pms, const uint8_t *data /*[64]*/);
 193    /* Initialize the algorithm. */
 194    static void md5_init(md5_state_t *pms);
 195    /* Append a string to the message. */
 196    static void md5_append(md5_state_t *pms, const uint8_t *data, int nbytes);
 197    /* Finish the message and return the digest. */
 198    static void md5_finish(md5_state_t *pms, uint8_t digest[16]);
 199
 200 };
 201
 202 GDCM_EXPORT std::ostream &binary_write(std::ostream &os, const uint16_t &val);
 203 GDCM_EXPORT std::ostream &binary_write(std::ostream &os, const uint32_t &val);
 204 GDCM_EXPORT std::ostream &binary_write(std::ostream &os, const double &val);
 205 GDCM_EXPORT std::ostream &binary_write(std::ostream &os, const char *val);
 206 GDCM_EXPORT std::ostream &binary_write(std::ostream &os, std::string const &val);
 207 GDCM_EXPORT std::ostream &binary_write(std::ostream &os, const uint8_t *val, size_t len);
 208 GDCM_EXPORT std::ostream &binary_write(std::ostream &os, const uint16_t *val, size_t len);
 209
 210 } // end namespace gdcm
 211 //-----------------------------------------------------------------------------
 212 #endif