1 /*=========================================================================
4 Module: $RCSfile: gdcmUtil.cxx,v $
6 Date: $Date: 2004/12/13 15:12:33 $
7 Version: $Revision: 1.70 $
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.
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.
17 =========================================================================*/
20 #include "gdcmDebug.h"
22 // For GetCurrentDate, GetCurrentTime
24 #include <sys/types.h>
27 #include <stdarg.h> //only included in implementation file
28 #include <stdio.h> //only included in implementation file
31 #include <winsock.h> // for gethostname & gethostbyname
35 #include <unistd.h> // for gethostname
36 #include <netdb.h> // for gethostbyname
44 * \brief Provide a better 'c++' approach for sprintf
45 * For example c code is:
46 * sprintf(trash, "%04x|%04x", group , element);
49 * std::ostringstream buf;
50 * buf << std::right << std::setw(4) << std::setfill('0') << std::hex
51 * << group << "|" << std::right << std::setw(4) << std::setfill('0')
52 * << std::hex << element;
56 std::string Util::Format(const char* format, ...)
60 va_start(args, format);
61 vsprintf(buffer, format, args); //might be a security flaw
62 va_end(args); // Each invocation of va_start should be matched
63 // by a corresponding invocation of va_end
64 // args is then 'undefined'
71 * \brief Because not available in C++ (?)
73 void Util::Tokenize (const std::string& str,
74 std::vector<std::string>& tokens,
75 const std::string& delimiters)
77 std::string::size_type lastPos = str.find_first_not_of(delimiters,0);
78 std::string::size_type pos = str.find_first_of (delimiters,lastPos);
79 while (std::string::npos != pos || std::string::npos != lastPos)
81 tokens.push_back(str.substr(lastPos, pos - lastPos));
82 lastPos = str.find_first_not_of(delimiters, pos);
83 pos = str.find_first_of (delimiters, lastPos);
89 * \brief Because not available in C++ (?)
90 * Counts the number of occurences of a substring within a string
93 int Util::CountSubstring (const std::string& str,
94 const std::string& subStr)
96 int count = 0; // counts how many times it appears
97 std::string::size_type x = 0; // The index position in the string
101 x = str.find(subStr,x); // Find the substring
102 if (x != std::string::npos) // If present
104 count++; // increase the count
105 x += subStr.length(); // Skip this word
108 while (x != std::string::npos); // Carry on until not present
115 * \brief Weed out a string from the non-printable characters (in order
116 * to avoid corrupting the terminal of invocation when printing)
117 * @param s string to remove non printable characters from
119 std::string Util::CreateCleanString(std::string const & s)
123 for(unsigned int i=0; i<str.size(); i++)
125 if(!isprint((unsigned char)str[i]))
133 if(!isprint((unsigned char)s[str.size()-1]))
135 if(s[str.size()-1] == 0)
137 str[str.size()-1] = ' ';
147 * \brief Add a SEPARATOR to the end of the name is necessary
148 * @param pathname file/directory name to normalize
150 std::string Util::NormalizePath(std::string const & pathname)
152 const char SEPARATOR_X = '/';
153 const char SEPARATOR_WIN = '\\';
154 const std::string SEPARATOR = "/";
155 std::string name = pathname;
156 int size = name.size();
158 if( name[size-1] != SEPARATOR_X && name[size-1] != SEPARATOR_WIN )
167 * \brief Get the (directory) path from a full path file name
168 * @param fullName file/directory name to extract Path from
170 std::string Util::GetPath(std::string const & fullName)
172 std::string res = fullName;
173 int pos1 = res.rfind("/");
174 int pos2 = res.rfind("\\");
189 * \brief Get the (last) name of a full path file name
190 * @param fullName file/directory name to extract end name from
192 std::string Util::GetName(std::string const & fullName)
194 std::string filename = fullName;
196 std::string::size_type slash_pos = filename.rfind("/");
197 std::string::size_type backslash_pos = filename.rfind("\\");
198 slash_pos = slash_pos > backslash_pos ? slash_pos : backslash_pos;
199 if(slash_pos != std::string::npos)
201 return filename.substr(slash_pos + 1);
211 * \brief Get the current date of the system in a dicom string
213 std::string Util::GetCurrentDate()
218 strftime(tmp,512,"%Y%m%d", localtime(&tloc) );
224 * \brief Get the current time of the system in a dicom string
226 std::string Util::GetCurrentTime()
231 strftime(tmp,512,"%H%M%S", localtime(&tloc) );
236 * \brief Create a /DICOM/ string:
237 * It should a of even length (no odd length ever)
238 * It can contain as many (if you are reading this from your
239 * editor the following character is is backslash followed by zero
240 * that needed to be escaped with an extra backslash for doxygen) \\0
243 std::string Util::DicomString(const char* s, size_t l)
245 std::string r(s, s+l);
246 assert( !(r.size() % 2) ); // == basically 'l' is even
252 * \brief Create a /DICOM/ string:
253 * It should a of even lenght (no odd length ever)
254 * It can contain as many (if you are reading this from your
255 * editor the following character is is backslash followed by zero
256 * that needed to be escaped with an extra backslash for doxygen) \\0
258 * This function is similar to DicomString(const char*),
259 * except it doesn't take a lenght.
260 * It only pad with a null character if length is odd
262 std::string Util::DicomString(const char* s)
264 size_t l = strlen(s);
269 std::string r(s, s+l);
270 assert( !(r.size() % 2) );
276 * \brief Safely compare two Dicom String:
277 * - Both string should be of even lenght
278 * - We allow padding of even lenght string by either a null
279 * character of a space
281 bool Util::DicomStringEqual(const std::string& s1, const char *s2)
283 // s2 is the string from the DICOM reference: 'MONOCHROME1'
284 std::string s1_even = s1; //Never change input parameter
285 std::string s2_even = DicomString( s2 );
286 if( s1_even[s1_even.size()-1] == ' ')
288 s1_even[s1_even.size()-1] = '\0'; //replace space character by null
290 return s1_even == s2_even;
295 * \brief Return the IP adress of the machine writting the DICOM image
297 std::string Util::GetIPAddress()
299 // This is a rip from http://www.codeguru.com/Cpp/I-N/internet/network/article.php/c3445/
300 #ifndef HOST_NAME_MAX
301 // SUSv2 guarantees that `Host names are limited to 255 bytes'.
302 // POSIX 1003.1-2001 guarantees that `Host names (not including the
303 // terminating NUL) are limited to HOST_NAME_MAX bytes'.
304 # define HOST_NAME_MAX 255
305 // In this case we should maybe check the string was not truncated.
306 // But I don't known how to check that...
307 #if defined(_MSC_VER) || defined(__BORLANDC__)
308 // with WinSock DLL we need to initialise the WinSock before using gethostname
309 WORD wVersionRequested = MAKEWORD(1,0);
311 int err = WSAStartup(wVersionRequested,&WSAData);
313 /* Tell the user that we could not find a usable */
320 #endif //HOST_NAME_MAX
323 char szHostName[HOST_NAME_MAX+1];
324 int r = gethostname(szHostName, HOST_NAME_MAX);
329 struct hostent * pHost = gethostbyname(szHostName);
331 for( int i = 0; pHost!= NULL && pHost->h_addr_list[i]!= NULL; i++ )
333 for( int j = 0; j<pHost->h_length; j++ )
335 if( j > 0 ) str += ".";
337 str += Util::Format("%u",
338 (unsigned int)((unsigned char*)pHost->h_addr_list[i])[j]);
340 // str now contains one local IP address
342 #if defined(_MSC_VER) || defined(__BORLANDC__)
348 // If an error occur r == -1
349 // Most of the time it will return 127.0.0.1...
355 * \brief Creates a new UID. As stipulate in the DICOM ref
356 * each time a DICOM image is create it should have
357 * a unique identifier (URI)
359 std::string Util::CreateUniqueUID(const std::string& root)
361 // The code works as follow:
362 // echo "gdcm" | od -b
363 // 0000000 147 144 143 155 012
364 // Therefore we return
365 // radical + 147.144.143.155 + IP + time()
366 std::string radical = root;
367 if( !root.size() ) //anything better ?
369 radical = "0.0."; // Is this really usefull ?
372 // A root was specified use it to forge our new UID:
373 radical += "147.144.143.155"; // gdcm
375 radical += Util::GetIPAddress();
377 radical += Util::GetCurrentDate();
379 radical += Util::GetCurrentTime();
385 std::ostream& binary_write(std::ostream& os, const T& val)
387 return os.write(reinterpret_cast<const char*>(&val), sizeof val);
390 std::ostream& binary_write(std::ostream& os, const uint16_t& val)
392 #ifdef GDCM_WORDS_BIGENDIAN
394 swap = ((( val << 8 ) & 0x0ff00 ) | (( val >> 8 ) & 0x00ff ) );
395 return os.write(reinterpret_cast<const char*>(&swap), 2);
397 return os.write(reinterpret_cast<const char*>(&val), 2);
398 #endif //GDCM_WORDS_BIGENDIAN
401 std::ostream& binary_write(std::ostream& os, const uint32_t& val)
403 #ifdef GDCM_WORDS_BIGENDIAN
405 swap = ( ((val<<24) & 0xff000000) | ((val<<8) & 0x00ff0000) |
406 ((val>>8) & 0x0000ff00) | ((val>>24) & 0x000000ff) );
407 return os.write(reinterpret_cast<const char*>(&swap), 4);
409 return os.write(reinterpret_cast<const char*>(&val), 4);
410 #endif //GDCM_WORDS_BIGENDIAN
413 std::ostream& binary_write(std::ostream& os, const char* val)
415 return os.write(val, strlen(val));
418 std::ostream& binary_write(std::ostream& os, std::string const & val)
420 return os.write(val.c_str(), val.size());
423 } // end namespace gdcm