Program: gdcm
Module: $RCSfile: gdcmUtil.cxx,v $
Language: C++
- Date: $Date: 2004/06/20 18:08:48 $
- Version: $Revision: 1.44 $
+ Date: $Date: 2004/11/16 02:54:35 $
+ Version: $Revision: 1.64 $
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.htm for details.
+ 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
#include "gdcmUtil.h"
#include "gdcmDebug.h"
-#include <stdio.h>
-#include <ctype.h> // For isspace
-#include <string.h> // CLEANME: could this be only string ? Related to Win32 ?
-#include <iostream>
+
+// For GetCurrentDate, GetCurrentTime
+#include <time.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+
+#include <stdarg.h> //only included in implementation file
+#include <stdio.h> //only included in implementation file
+
+#include <unistd.h> // for gethostname
+#include <netdb.h> // for gethostbyname
+
+namespace gdcm
+{
/**
* \ingroup Globals
- * \brief Because is not yet available in g++2.96
+ * \brief Provide a better 'c++' approach for sprintf
+ * For example c code is:
+ * sprintf(trash, "%04x|%04x", group , element);
+ *
+ * c++ is
+ * std::ostringstream buf;
+ * buf << std::right << std::setw(4) << std::setfill('0') << std::hex
+ * << group << "|" << std::right << std::setw(4) << std::setfill('0')
+ * << std::hex << element;
+ * buf.str();
*/
-std::istream& eatwhite(std::istream& is) {
- char c;
- while (is.get(c)) {
- if (!isspace(c)) {
- is.putback(c);
- break;
- }
- }
- return is;
+
+std::string Util::Format(const char* format, ...)
+{
+ char buffer[2048];
+ va_list args;
+ va_start(args, format);
+ vsprintf(buffer, format, args); //might be a security flaw
+ va_end(args); // Each invocation of va_start should be matched
+ // by a corresponding invocation of va_end
+ // args is then 'undefined'
+ return buffer;
}
+
/**
* \ingroup Globals
* \brief Because not available in C++ (?)
*/
-void Tokenize (const std::string& str,
- std::vector<std::string>& tokens,
- const std::string& delimiters) {
+void Util::Tokenize (const std::string& str,
+ std::vector<std::string>& tokens,
+ const std::string& delimiters)
+{
std::string::size_type lastPos = str.find_first_not_of(delimiters,0);
std::string::size_type pos = str.find_first_of (delimiters,lastPos);
- while (std::string::npos != pos || std::string::npos != lastPos) {
+ while (std::string::npos != pos || std::string::npos != lastPos)
+ {
tokens.push_back(str.substr(lastPos, pos - lastPos));
lastPos = str.find_first_not_of(delimiters, pos);
pos = str.find_first_of (delimiters, lastPos);
}
}
+/**
+ * \ingroup Globals
+ * \brief Because not available in C++ (?)
+ * Counts the number of occurences of a substring within a string
+ */
+
+int Util::CountSubstring (const std::string& str,
+ const std::string& subStr)
+{
+ int count = 0; // counts how many times it appears
+ unsigned int x = 0; // The index position in the string
+
+ do
+ {
+ x = str.find(subStr,x); // Find the substring
+ if (x != std::string::npos) // If present
+ {
+ count++; // increase the count
+ x += subStr.length(); // Skip this word
+ }
+ }
+ while (x != std::string::npos); // Carry on until not present
+
+ return count;
+}
+
/**
* \ingroup Globals
* \brief Weed out a string from the non-printable characters (in order
* to avoid corrupting the terminal of invocation when printing)
* @param s string to remove non printable characters from
*/
-std::string CreateCleanString(std::string s) {
- std::string str=s;
+std::string Util::CreateCleanString(std::string const & s)
+{
+ std::string str = s;
for(unsigned int i=0;i<str.size();i++)
{
if(!isprint(str[i]))
+ {
str[i]='.';
+ }
}
if(str.size()>0)
+ {
if(!isprint(s[str.size()-1]))
+ {
if(s[str.size()-1]==0)
+ {
str[str.size()-1]=' ';
+ }
+ }
+ }
- return(str);
+ return str;
}
/**
* \brief Add a SEPARATOR to the end of the name is necessary
* @param name file/directory name to normalize
*/
-void NormalizePath(std::string &name)
+std::string Util::NormalizePath(std::string const & pathname)
{
const char SEPARATOR_X = '/';
const char SEPARATOR_WIN = '\\';
const std::string SEPARATOR = "/";
- int size=name.size();
+ 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;
+ name += SEPARATOR;
}
+ return name;
}
/**
* \brief Get the (directory) path from a full path file name
* @param fullName file/directory name to extract Path from
*/
-std::string GetPath(std::string &fullName)
+std::string Util::GetPath(std::string const & fullName)
{
- int pos1=fullName.rfind("/");
- int pos2=fullName.rfind("\\");
- if(pos1>pos2)
- fullName.resize(pos1);
+ std::string res = fullName;
+ int pos1 = res.rfind("/");
+ int pos2 = res.rfind("\\");
+ if( pos1 > pos2)
+ {
+ res.resize(pos1);
+ }
else
- fullName.resize(pos2);
- return(fullName);
+ {
+ res.resize(pos2);
+ }
+
+ return res;
}
/**
- * \ingroup Globals
+ * \ingroup Util
* \brief Get the (last) name of a full path file name
* @param fullName file/directory name to extract end name from
*/
-std::string GetName(std::string &fullName)
+std::string Util::GetName(std::string const & fullName)
{
- int fin=fullName.length()-1;
- char a =fullName.c_str()[fin];
- if (a == '/' || a == '\\') {
- fin--;
- }
- int deb;
- for (int i=fin;i!=0;i--) {
- if (fullName.c_str()[i] == '/' || fullName.c_str()[i] == '\\')
- break;
- deb = i;
- }
-
- std::string lastName;
- for (int j=deb;j<fin+1;j++)
- lastName=lastName+fullName.c_str()[j];
-
- return(lastName);
+ std::string filename = 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)
+ {
+ return filename.substr(slash_pos + 1);
+ }
+ else
+ {
+ return filename;
+ }
}
+
+/**
+ * \ingroup Util
+ * \brief Get the current date of the system in a dicom string
+ */
+std::string Util::GetCurrentDate()
+{
+ char tmp[512];
+ time_t tloc;
+ time (&tloc);
+ strftime(tmp,512,"%Y%m%d", localtime(&tloc) );
+ return tmp;
+}
+
+/**
+ * \ingroup Util
+ * \brief Get the current time of the system in a dicom string
+ */
+std::string Util::GetCurrentTime()
+{
+ char tmp[512];
+ time_t tloc;
+ time (&tloc);
+ strftime(tmp,512,"%H%M%S", localtime(&tloc) );
+ return tmp;
+}
+
+/**
+ * \ingroup Util
+ * \brief Create a /DICOM/ string:
+ * It should a of even length (no odd length ever)
+ * It can contains as many \0 as you want.
+ */
+std::string Util::DicomString(const char* s, size_t l)
+{
+ std::string r(s, s+l);
+ assert( !(r.size() % 2) ); // == basically 'l' is even
+ return r;
+}
+
+/**
+ * \ingroup Util
+ * \brief Create a /DICOM/ string:
+ * It should a of even lenght (no odd length ever)
+ * It can contains as many \0 as you want.
+ * This function is similar to DicomString(const char*),
+ * except it doesn't take a lenght.
+ * It only pad with a null character if length is odd
+ */
+std::string Util::DicomString(const char* s)
+{
+ size_t l = strlen(s);
+ if( l%2 )
+ {
+ l++;
+ }
+ std::string r(s, s+l);
+ assert( !(r.size() % 2) );
+ return r;
+}
+
+/**
+ * \ingroup Util
+ * \brief Safely compare two Dicom String:
+ * - Both string should be of even lenght
+ * - We allow padding of even lenght 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'
+ 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
+ }
+ return s1_even == s2_even;
+}
+
+/**
+ * \ingroup Util
+ * \brief Return the IP adress of the machine writting the DICOM image
+ */
+std::string Util::GetIPAddress()
+{
+ // This is a rip from http://www.codeguru.com/Cpp/I-N/internet/network/article.php/c3445/
+#ifndef HOST_NAME_MAX
+ // SUSv2 guarantees that `Host names are limited to 255 bytes'.
+ // POSIX 1003.1-2001 guarantees that `Host names (not including the
+ // terminating NUL) are limited to HOST_NAME_MAX bytes'.
+# define HOST_NAME_MAX 255
+ // In this case we should maybe check the string was not truncated.
+ // But I don't known how to check that...
+#endif //HOST_NAME_MAX
+
+ std::string str;
+ char szHostName[HOST_NAME_MAX+1];
+ int r = gethostname(szHostName, HOST_NAME_MAX);
+
+ if( r == 0 )
+ {
+ // Get host adresses
+ struct hostent * pHost = gethostbyname(szHostName);
+
+ for( int i = 0; pHost!= NULL && pHost->h_addr_list[i]!= NULL; i++ )
+ {
+ for( int j = 0; j<pHost->h_length; j++ )
+ {
+ if( j > 0 ) str += ".";
+
+ str += Util::Format("%u",
+ (unsigned int)((unsigned char*)pHost->h_addr_list[i])[j]);
+ }
+ // str now contains one local IP address
+ }
+ }
+ // If an error occur r == -1
+ // Most of the time it will return 127.0.0.1...
+ return str;
+}
+
+/**
+ * \ingroup Util
+ * \brief Creates a new UID. As stipulate in the DICOM ref
+ * each time a DICOM image is create it should have
+ * a unique identifier (URI)
+ */
+std::string Util::CreateUniqueUID(const std::string& root)
+{
+ // The code works as follow:
+ // echo "gdcm" | od -b
+ // 0000000 147 144 143 155 012
+ // Therefore we return
+ // radical + 147.144.143.155 + IP + time()
+ std::string radical = root;
+ if( !root.size() ) //anything better ?
+ {
+ radical = "0.0."; // Is this really usefull ?
+ }
+ // else
+ // A root was specified use it to forge our new UID:
+ radical += "147.144.143.155"; // gdcm
+ radical += ".";
+ radical += Util::GetIPAddress();
+ radical += ".";
+ radical += Util::GetCurrentDate();
+ radical += ".";
+ radical += Util::GetCurrentTime();
+
+ return radical;
+}
+
+template <class T>
+std::ostream& binary_write(std::ostream& os, const T& val)
+{
+ return os.write(reinterpret_cast<const char*>(&val), sizeof val);
+}
+
+std::ostream& binary_write(std::ostream& os, const uint16_t& val)
+{
+#ifdef GDCM_WORDS_BIGENDIAN
+ uint16_t swap;
+ swap = ((( val << 8 ) & 0x0ff00 ) | (( val >> 8 ) & 0x00ff ) );
+ return os.write(reinterpret_cast<const char*>(&swap), 2);
+#else
+ return os.write(reinterpret_cast<const char*>(&val), 2);
+#endif //GDCM_WORDS_BIGENDIAN
+}
+
+std::ostream& binary_write(std::ostream& os, const uint32_t& val)
+{
+#ifdef GDCM_WORDS_BIGENDIAN
+ uint32_t swap;
+ swap = ( ((val<<24) & 0xff000000) | ((val<<8) & 0x00ff0000) |
+ ((val>>8) & 0x0000ff00) | ((val>>24) & 0x000000ff) );
+ return os.write(reinterpret_cast<const char*>(&swap), 4);
+#else
+ return os.write(reinterpret_cast<const char*>(&val), 4);
+#endif //GDCM_WORDS_BIGENDIAN
+}
+
+std::ostream& binary_write(std::ostream& os, const char* val)
+{
+ return os.write(val, strlen(val));
+}
+
+std::ostream& binary_write(std::ostream& os, std::string const & val)
+{
+ return os.write(val.c_str(), val.size());
+}
+
+} // end namespace gdcm
+