5 #include "gdcmHeader.h"
8 #include "gdcmDataImages.h"
12 typedef string EntryValueType; // same type as gdcmValEntry::value
13 typedef map< gdcmTagKey, EntryValueType > MapEntryValues;
14 typedef MapEntryValues* MapEntryValuesPtr;
15 typedef string FileNameType;
16 typedef map< FileNameType, MapEntryValuesPtr > MapFileValuesType;
18 struct ParserException
23 static string GetIndent() { return ParserException::Indent; }
24 ParserException( string ErrorMessage )
29 void Print() { cerr << Indent << error << endl; }
32 string ParserException::Indent = " ";
34 class ReferenceFileParser
36 bool AddKeyValuePairToMap( string& key, string& value );
38 istream& eatwhite(istream& is);
39 void eatwhite(string& toClean);
40 string ExtractFirstString(string& toSplit);
41 void CleanUpLine( string& line );
43 string ExtractValue(string& toSplit) throw ( ParserException );
44 void ParseRegularLine( string& line ) throw ( ParserException );
45 void FirstPassReferenceFile() throw ( ParserException );
46 bool SecondPassReferenceFile() throw ( ParserException );
47 void HandleFileName( string& line ) throw ( ParserException );
48 void HandleKey( string& line ) throw ( ParserException );
49 bool HandleValue( string& line ) throw ( ParserException );
50 static uint16_t axtoi( char* );
52 ReferenceFileParser();
53 bool Open( string& referenceFileName );
55 void SetDataPath(string&);
58 /// The directory containing the images to check:
61 /// The product of the parser:
62 MapFileValuesType ProducedMap;
64 /// The ifstream attached to the file we parse:
67 /// String prefixing every output
70 /// The current line position within the stream:
73 /// The currently parsed filename:
74 string CurrentFileName;
76 /// The currently parsed key:
79 /// The currently parsed value:
82 /// The current MapEntryValues pointer:
83 MapEntryValues* CurrentMapEntryValuesPtr;
87 /// http://community.borland.com/article/0,1410,17203,0.html
88 uint16_t ReferenceFileParser::axtoi(char *hexStg) {
89 int n = 0; // position in string
90 int m = 0; // position in digit[] to shift
91 int count; // loop index
92 int intValue = 0; // integer value of hex string
93 int digit[5]; // hold values to convert
97 if (hexStg[n] > 0x29 && hexStg[n] < 0x40 ) //if 0 to 9
98 digit[n] = hexStg[n] & 0x0f; //convert to int
99 else if (hexStg[n] >='a' && hexStg[n] <= 'f') //if a to f
100 digit[n] = (hexStg[n] & 0x0f) + 9; //convert to int
101 else if (hexStg[n] >='A' && hexStg[n] <= 'F') //if A to F
102 digit[n] = (hexStg[n] & 0x0f) + 9; //convert to int
110 // digit[n] is value of hex digit at position n
111 // (m << 2) is the number of positions to shift
112 // OR the bits into return value
113 intValue = intValue | (digit[n] << (m << 2));
114 m--; // adjust the position to set
115 n++; // next digit to process
120 void ReferenceFileParser::SetDataPath( string& inDataPath )
122 DataPath = inDataPath;
125 bool ReferenceFileParser::AddKeyValuePairToMap( string& key, string& value )
127 if ( !CurrentMapEntryValuesPtr )
129 if ( CurrentMapEntryValuesPtr->count(key) != 0 )
131 (*CurrentMapEntryValuesPtr)[key] = value;
136 void ReferenceFileParser::Print()
138 for (MapFileValuesType::iterator i = ProducedMap.begin();
139 i != ProducedMap.end();
142 cout << Indent << "FileName: " << i->first << endl;
143 MapEntryValuesPtr KeyValues = i->second;
144 for (MapEntryValues::iterator j = KeyValues->begin();
145 j != KeyValues->end();
149 << " Key: " << j->first
150 << " Value: " << j->second
153 cout << Indent << endl;
155 cout << Indent << endl;
158 bool ReferenceFileParser::Check()
160 for (MapFileValuesType::iterator i = ProducedMap.begin();
161 i != ProducedMap.end();
164 string fileName = DataPath + i->first;
165 cout << Indent << "FileName: " << fileName << endl;
166 gdcmHeader* tested = new gdcmHeader( fileName.c_str() );
167 if( !tested->IsReadable() )
169 cerr << Indent << "Image not gdcm compatible:"
175 MapEntryValuesPtr KeyValues = i->second;
176 for (MapEntryValues::iterator j = KeyValues->begin();
177 j != KeyValues->end();
180 string key = j->first;
182 string groupString = key.substr( 0, 4 );
184 groupCharPtr = new char(groupString.length() + 1);
185 strcpy( groupCharPtr, groupString.c_str() );
187 string groupElement = key.substr( key.find_first_of( "|" ) + 1, 4 );
188 char* groupElementPtr;
189 groupElementPtr = new char(groupElement.length() + 1);
190 strcpy( groupElementPtr, groupElement.c_str() );
192 uint16_t group = axtoi( groupCharPtr );
193 uint16_t element = axtoi( groupElementPtr );
195 string testedValue = tested->GetEntryByNumber(group, element);
196 if ( testedValue != j->second )
198 cout << Indent << "Uncorrect value for key " << key << endl
199 << Indent << " read value [" << testedValue << "]" << endl
200 << Indent << " reference value [" << j->second << "]"
206 cout << Indent << " OK" << endl;
208 cout << Indent << endl;
212 istream& ReferenceFileParser::eatwhite( istream& is )
224 void ReferenceFileParser::eatwhite( string& toClean )
226 while( toClean.find_first_of( " " ) == 0 )
227 toClean.erase( 0, toClean.find_first_of( " " ) + 1 );
230 string ReferenceFileParser::ExtractFirstString( string& toSplit )
232 std::string firstString;
234 if ( toSplit.find( " " ) == string::npos ) {
235 firstString = toSplit;
239 firstString = toSplit.substr( 0, toSplit.find(" ") );
240 toSplit.erase( 0, toSplit.find(" ") + 1);
245 string ReferenceFileParser::ExtractValue( string& toSplit )
246 throw ( ParserException )
249 string::size_type beginPos = toSplit.find_first_of( '"' );
250 string::size_type endPos = toSplit.find_last_of( '"' );
252 // Make sure we have at most two " in toSplit:
253 string noQuotes = toSplit.substr( beginPos + 1, endPos - beginPos - 1);
254 if ( noQuotes.find_first_of( '"' ) != string::npos )
255 throw ParserException( "more than two quote character" );
257 // No leading quote means this is not a value:
258 if ( beginPos == string::npos )
263 if ( ( endPos == string::npos ) || ( beginPos == endPos ) )
264 throw ParserException( "unmatched \" (quote character)" );
269 error << "leading character ["
270 << toSplit.substr(beginPos -1, 1)
271 << "] before opening \" ";
272 throw ParserException( error.str() );
275 // When they are some extra characters at end of value, it must
277 if ( ( endPos != toSplit.length() - 1 )
278 && ( toSplit.substr(endPos + 1, 1) != " " ) )
281 error << "trailing character ["
282 << toSplit.substr(endPos + 1, 1)
283 << "] after value closing \" ";
284 throw ParserException( error.str() );
287 string value = toSplit.substr( beginPos + 1, endPos - beginPos - 1 );
288 toSplit.erase( beginPos, endPos - beginPos + 1);
293 /// \brief Checks the block syntax of the incoming ifstream. Checks that
294 /// - no nested blocks are present
295 /// - we encounter a matching succesion of "[" and "]"
296 /// - when ifstream terminates the last block is closed.
297 /// - a block is not opened and close on the same line
298 /// @param from The incoming ifstream to be checked.
299 /// @return True when incoming ifstream has a correct syntax, false otherwise.
300 /// \warning The underlying file pointer is not preseved.
301 void ReferenceFileParser::FirstPassReferenceFile() throw ( ParserException )
305 bool inBlock = false;
306 from.seekg( 0, ios::beg );
308 while ( ! from.eof() )
310 getline( from, line );
312 /// This is how we usually end the parsing because we hit EOF:
318 throw ParserException( "Syntax error: EOF reached when in block.");
321 // Don't try to parse comments (weed out anything after first "#"):
322 if ( line.find_first_of( "#" ) != string::npos )
324 line.erase( line.find_first_of( "#" ) );
327 // Two occurences of opening blocks on a single line implies nested
328 // blocks which is illegal:
329 if ( line.find_first_of( "[" ) != line.find_last_of( "[" ) )
332 error << "Syntax error: nested block (open) in reference file"
334 << ParserException::GetIndent()
335 << " at line " << lineNumber << endl;
336 throw ParserException( error.str() );
339 // Two occurences of closing blocks on a single line implies nested
340 // blocks which is illegal:
341 if ( line.find_first_of( "]" ) != line.find_last_of( "]" ) )
344 error << "Syntax error: nested block (close) in reference file"
346 << ParserException::GetIndent()
347 << " at line " << lineNumber << endl;
348 throw ParserException( error.str() );
351 bool beginBlock ( line.find_first_of("[") != string::npos );
352 bool endBlock ( line.find_last_of("]") != string::npos );
354 // Opening and closing of block on same line:
355 if ( beginBlock && endBlock )
358 error << "Syntax error: opening and closing on block on same line "
359 << lineNumber++ << endl;
360 throw ParserException( error.str() );
363 // Illegal closing block when block not open:
364 if ( !inBlock && endBlock )
367 error << "Syntax error: unexpected end of block at line "
368 << lineNumber++ << endl;
369 throw ParserException( error.str() );
372 // Uncommented line outside of block is not clean:
373 if ( !inBlock && !beginBlock )
378 if ( inBlock && beginBlock )
381 error << " Syntax error: illegal opening of nested block at line "
382 << lineNumber++ << endl;
383 throw ParserException( error.str() );
386 // Normal situation of opening block:
394 // Normal situation of closing block:
401 // This line had no block delimiter
405 // We need rewinding:
407 from.seekg( 0, ios::beg );
410 ReferenceFileParser::ReferenceFileParser()
416 bool ReferenceFileParser::Open( string& referenceFileName )
418 from.open( referenceFileName.c_str(), ios::in );
419 if ( !from.is_open() )
421 cerr << Indent << "Can't open reference file." << endl;
426 FirstPassReferenceFile();
427 SecondPassReferenceFile();
429 catch ( ParserException except )
439 void ReferenceFileParser::CleanUpLine( string& line )
441 // Cleanup from comments:
442 if ( line.find_first_of( "#" ) != string::npos )
443 line.erase( line.find_first_of( "#" ) );
445 // Cleanup everything after end block delimiter:
446 if ( line.find_last_of( "]" ) != string::npos )
447 line.erase( line.find_last_of( "]" ) + 1 );
449 // Cleanup leading whites and skip empty lines:
453 void ReferenceFileParser::HandleFileName( string& line )
454 throw ( ParserException )
456 if ( line.length() == 0 )
457 throw ParserException( "empty line on call of HandleFileName" );
459 if ( CurrentFileName.length() != 0 )
462 CurrentFileName = ExtractFirstString(line);
465 void ReferenceFileParser::HandleKey( string& line )
466 throw ( ParserException )
468 if ( CurrentKey.length() != 0 )
471 CurrentKey = ExtractFirstString(line);
472 if ( CurrentKey.find_first_of( "|" ) == string::npos )
475 error << "uncorrect key:" << CurrentKey;
476 throw ParserException( error.str() );
480 bool ReferenceFileParser::HandleValue( string& line )
481 throw ( ParserException )
483 if ( line.length() == 0 )
484 throw ParserException( "empty line in HandleValue" );
486 if ( CurrentKey.length() == 0 )
488 cout << Indent << "No key present:" << CurrentKey << endl;
492 string newCurrentValue = ExtractValue(line);
493 if ( newCurrentValue.length() == 0 )
495 cout << Indent << "Warning: empty value for key:"
496 << CurrentKey << endl;
499 CurrentValue += newCurrentValue;
503 void ReferenceFileParser::ParseRegularLine(string& line)
504 throw ( ParserException )
506 if ( line.length() == 0 )
509 // First thing is to get a filename:
510 HandleFileName( line );
512 if ( line.length() == 0 )
515 // Second thing is to get a key:
518 if ( line.length() == 0 )
521 // Third thing is to get a value:
522 if ( ! HandleValue( line ) )
525 if ( CurrentKey.length() && CurrentValue.length() )
527 if ( ! AddKeyValuePairToMap( CurrentKey, CurrentValue ) )
528 throw ParserException( "adding to map of (key, value) failed" );
530 CurrentValue.erase();
534 bool ReferenceFileParser::SecondPassReferenceFile()
535 throw ( ParserException )
538 EntryValueType value;
540 bool inBlock = false;
543 while ( !from.eof() )
545 getline( from, line );
550 // Empty lines don't require any treatement:
551 if ( line.length() == 0 )
554 bool beginBlock ( line.find_first_of("[") != string::npos );
555 bool endBlock ( line.find_last_of("]") != string::npos );
557 // Waiting for a block to be opened. Meanwhile, drop everything:
558 if ( !inBlock && !beginBlock )
564 line.erase( 0, line.find_first_of( "[" ) + 1 );
566 CurrentMapEntryValuesPtr = new MapEntryValues();
570 line.erase( line.find_last_of( "]" ) );
572 ParseRegularLine( line );
573 ProducedMap[CurrentFileName] = CurrentMapEntryValuesPtr;
575 CurrentFileName.erase();
578 // Outside block lines are dropped:
582 ParseRegularLine( line );
587 int TestAllEntryVerify(int argc, char* argv[])
591 cerr << " Usage: " << argv[0]
592 << " (no arguments needed)." << endl;
596 string referenceDir = GDCM_DATA_ROOT;
598 string referenceFilename = referenceDir + "TestAllEntryVerifyReference.txt";
600 cout << " Description (Test::TestAllEntryVerify): "
602 cout << " For all images (not blacklisted in gdcm/Test/CMakeLists.txt)"
604 cout << " encountered in directory: " << GDCM_DATA_ROOT << endl;
605 cout << " apply the following tests : "<< endl;
606 cout << " step 1: parse the image and call IsReadable(). " << endl;
607 cout << " step 2: look for the entry corresponding to the image" << endl;
608 cout << " in the reference file: " << referenceFilename << endl;
609 cout << " step 3: check that each reference tag value listed for this"
611 cout << " entry matches the tag encountered at parsing step 1."
614 ReferenceFileParser Parser;
615 if ( !Parser.Open(referenceFilename) )
617 cout << " Corrupted reference file name: "
618 << referenceFilename << endl;
621 Parser.SetDataPath(referenceDir);
623 if ( Parser.Check() )