1 /*=========================================================================
4 Module: $RCSfile: gdcmUtil.cxx,v $
6 Date: $Date: 2004/11/16 02:04:00 $
7 Version: $Revision: 1.63 $
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
35 * \brief Provide a better 'c++' approach for sprintf
36 * For example c code is:
37 * sprintf(trash, "%04x|%04x", group , element);
40 * std::ostringstream buf;
41 * buf << std::right << std::setw(4) << std::setfill('0') << std::hex
42 * << group << "|" << std::right << std::setw(4) << std::setfill('0')
43 * << std::hex << element;
47 std::string Util::Format(const char* format, ...)
51 va_start(args, format);
52 vsprintf(buffer, format, args); //might be a security flaw
53 va_end(args); // Each invocation of va_start should be matched
54 // by a corresponding invocation of va_end
55 // args is then 'undefined'
62 * \brief Because not available in C++ (?)
64 void Util::Tokenize (const std::string& str,
65 std::vector<std::string>& tokens,
66 const std::string& delimiters)
68 std::string::size_type lastPos = str.find_first_not_of(delimiters,0);
69 std::string::size_type pos = str.find_first_of (delimiters,lastPos);
70 while (std::string::npos != pos || std::string::npos != lastPos)
72 tokens.push_back(str.substr(lastPos, pos - lastPos));
73 lastPos = str.find_first_not_of(delimiters, pos);
74 pos = str.find_first_of (delimiters, lastPos);
80 * \brief Because not available in C++ (?)
81 * Counts the number of occurences of a substring within a string
84 int Util::CountSubstring (const std::string& str,
85 const std::string& subStr)
87 int count = 0; // counts how many times it appears
88 unsigned int x = 0; // The index position in the string
92 x = str.find(subStr,x); // Find the substring
93 if (x != std::string::npos) // If present
95 count++; // increase the count
96 x += subStr.length(); // Skip this word
99 while (x != std::string::npos); // Carry on until not present
106 * \brief Weed out a string from the non-printable characters (in order
107 * to avoid corrupting the terminal of invocation when printing)
108 * @param s string to remove non printable characters from
110 std::string Util::CreateCleanString(std::string const & s)
114 for(unsigned int i=0;i<str.size();i++)
124 if(!isprint(s[str.size()-1]))
126 if(s[str.size()-1]==0)
128 str[str.size()-1]=' ';
138 * \brief Add a SEPARATOR to the end of the name is necessary
139 * @param name file/directory name to normalize
141 std::string Util::NormalizePath(std::string const & pathname)
143 const char SEPARATOR_X = '/';
144 const char SEPARATOR_WIN = '\\';
145 const std::string SEPARATOR = "/";
146 std::string name = pathname;
147 int size = name.size();
149 if( name[size-1] != SEPARATOR_X && name[size-1] != SEPARATOR_WIN )
158 * \brief Get the (directory) path from a full path file name
159 * @param fullName file/directory name to extract Path from
161 std::string Util::GetPath(std::string const & fullName)
163 std::string res = fullName;
164 int pos1 = res.rfind("/");
165 int pos2 = res.rfind("\\");
180 * \brief Get the (last) name of a full path file name
181 * @param fullName file/directory name to extract end name from
183 std::string Util::GetName(std::string const & fullName)
185 std::string filename = fullName;
187 std::string::size_type slash_pos = filename.rfind("/");
188 std::string::size_type backslash_pos = filename.rfind("\\");
189 slash_pos = slash_pos > backslash_pos ? slash_pos : backslash_pos;
190 if(slash_pos != std::string::npos)
192 return filename.substr(slash_pos + 1);
202 * \brief Get the current date of the system in a dicom string
204 std::string Util::GetCurrentDate()
209 strftime(tmp,512,"%Y%m%d", localtime(&tloc) );
215 * \brief Get the current time of the system in a dicom string
217 std::string Util::GetCurrentTime()
222 strftime(tmp,512,"%H%M%S", localtime(&tloc) );
228 * \brief Create a /DICOM/ string:
229 * It should a of even length (no odd length ever)
230 * It can contains as many \0 as you want.
232 std::string Util::DicomString(const char* s, size_t l)
234 std::string r(s, s+l);
235 assert( !(r.size() % 2) ); // == basically 'l' is even
241 * \brief Create a /DICOM/ string:
242 * It should a of even lenght (no odd length ever)
243 * It can contains as many \0 as you want.
244 * This function is similar to DicomString(const char*),
245 * except it doesn't take a lenght.
246 * It only pad with a null character if length is odd
248 std::string Util::DicomString(const char* s)
250 size_t l = strlen(s);
255 std::string r(s, s+l);
256 assert( !(r.size() % 2) );
262 * \brief Safely compare two Dicom String:
263 * - Both string should be of even lenght
264 * - We allow padding of even lenght string by either a null
265 * character of a space
267 bool Util::DicomStringEqual(const std::string& s1, const char *s2)
269 // s2 is the string from the DICOM reference: 'MONOCHROME1'
270 std::string s1_even = s1; //Never directly change input parameter
271 std::string s2_even = DicomString( s2 );
272 if( s1_even[s1_even.size()-1] == ' ')
274 s1_even[s1_even.size()-1] = '\0'; //replace space character by null
276 return s1_even == s2_even;
280 std::ostream& binary_write(std::ostream& os, const T& val)
282 return os.write(reinterpret_cast<const char*>(&val), sizeof val);
285 std::ostream& binary_write(std::ostream& os, const uint16_t& val)
287 #ifdef GDCM_WORDS_BIGENDIAN
289 swap = ((( val << 8 ) & 0x0ff00 ) | (( val >> 8 ) & 0x00ff ) );
290 return os.write(reinterpret_cast<const char*>(&swap), 2);
292 return os.write(reinterpret_cast<const char*>(&val), 2);
293 #endif //GDCM_WORDS_BIGENDIAN
296 std::ostream& binary_write(std::ostream& os, const uint32_t& val)
298 #ifdef GDCM_WORDS_BIGENDIAN
300 swap = ( ((val<<24) & 0xff000000) | ((val<<8) & 0x00ff0000) |
301 ((val>>8) & 0x0000ff00) | ((val>>24) & 0x000000ff) );
302 return os.write(reinterpret_cast<const char*>(&swap), 4);
304 return os.write(reinterpret_cast<const char*>(&val), 4);
305 #endif //GDCM_WORDS_BIGENDIAN
308 std::ostream& binary_write(std::ostream& os, const char* val)
310 return os.write(val, strlen(val));
313 std::ostream& binary_write(std::ostream& os, std::string const & val)
315 return os.write(val.c_str(), val.size());
318 } // end namespace gdcm