]> Creatis software - gdcm.git/blob - src/gdcmDocument.cxx
ENH: Remove stupid debug code...
[gdcm.git] / src / gdcmDocument.cxx
1 /*=========================================================================
2                                                                                 
3   Program:   gdcm
4   Module:    $RCSfile: gdcmDocument.cxx,v $
5   Language:  C++
6   Date:      $Date: 2005/07/11 20:47:00 $
7   Version:   $Revision: 1.264 $
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 #include "gdcmDocument.h"
20 #include "gdcmValEntry.h"
21 #include "gdcmBinEntry.h"
22 #include "gdcmSeqEntry.h"
23 #include "gdcmGlobal.h"
24 #include "gdcmUtil.h"
25 #include "gdcmDebug.h"
26 #include "gdcmTS.h"
27 #include "gdcmDictSet.h"
28 #include "gdcmDocEntrySet.h"
29 #include "gdcmSQItem.h"
30
31 #include <vector>
32 #include <iomanip>
33 #include <fstream>
34 #include <ctype.h>  // for isdigit
35 #include <stdlib.h> // for atoi
36
37 namespace gdcm 
38 {
39 //-----------------------------------------------------------------------------
40
41 // Refer to Document::SetMaxSizeLoadEntry()
42 const unsigned int Document::MAX_SIZE_LOAD_ELEMENT_VALUE = 0xfff; // 4096
43
44 //-----------------------------------------------------------------------------
45 // Constructor / Destructor
46 // Constructors and destructors are protected to avoid user to invoke directly
47
48 /**
49  * \brief This default constructor neither loads nor parses the file. 
50  *        You should then invoke \ref Document::Load.
51  *         
52  */
53 Document::Document() 
54          :ElementSet(-1)
55 {
56    Fp = 0;
57
58    SetMaxSizeLoadEntry(MAX_SIZE_LOAD_ELEMENT_VALUE);
59    Initialize();
60    SwapCode = 1234;
61    Filetype = ExplicitVR;
62    // Load will set it to true if sucessfull
63    Group0002Parsed = false;
64    IsDocumentAlreadyLoaded = false;
65    IsDocumentModified = true;
66    LoadMode = 0x00000000; // default : load everything, later
67    SetFileName("");
68 }
69
70 /**
71  * \brief   Constructor (DEPRECATED : not to break the API) 
72  * @param   fileName 'Document' (File or DicomDir) to be open for parsing
73  */
74 Document::Document( std::string const &fileName )
75          :ElementSet(-1) 
76 {
77    Fp = 0;
78
79    SetMaxSizeLoadEntry(MAX_SIZE_LOAD_ELEMENT_VALUE);
80    Initialize();
81    SwapCode = 1234;
82    Filetype = ExplicitVR;
83    Group0002Parsed = false;
84    LoadMode = 0x00000000; // Load everything, later
85
86    // Load will set it to true if sucessfull
87    IsDocumentAlreadyLoaded = false;
88    IsDocumentModified = true;
89
90    SetFileName(fileName);
91    Load( );
92 }
93 /**
94  * \brief   Canonical destructor.
95  */
96 Document::~Document ()
97 {
98    RefPubDict = NULL;
99    RefShaDict = NULL;
100 }
101
102 //-----------------------------------------------------------------------------
103 // Public
104
105 /**
106  * \brief   Loader. use SetLoadMode(), SetFileName() before ! 
107  * @return false if file cannot be open or no swap info was found,
108  *         or no tag was found.
109  */
110 bool Document::Load(  ) 
111 {
112    if ( GetFileName() == "" )
113    {
114       gdcmWarningMacro( "Use SetFileName, before !" );
115       return false;
116    }
117    return DoTheLoadingDocumentJob( );
118
119 /**
120  * \brief   Loader. (DEPRECATED : not to break the API)   
121  * @param   fileName 'Document' (File or DicomDir) to be open for parsing
122  * @return false if file cannot be open or no swap info was found,
123  *         or no tag was found.
124  */
125 bool Document::Load( std::string const &fileName ) 
126 {
127    Filename = fileName;
128    return DoTheLoadingDocumentJob( );
129 }
130
131 /**
132  * \brief   Performs the Loading Job (internal use only)  
133  * @return false if file cannot be open or no swap info was found,
134  *         or no tag was found.
135  */
136 bool Document::DoTheLoadingDocumentJob(  ) 
137 {
138    if ( ! IsDocumentModified ) // Nothing to do !
139       return true;
140
141  //     if ( Filename == fileName )
142  //     {
143  //        gdcmWarningMacro( "The file was already parsed inside this "
144  //                       << "gdcm::Document (its name is: "
145  //                       << Filename.c_str() );
146  //        return true;
147  //     }
148   
149    //gdcmWarningMacro( "A file was already parsed inside this "
150    //                  << "gdcm::Document (previous name was: "
151    //                  << Filename.c_str() << ". New name is :"
152    //                  << fileName );
153      // clean out the Entries, if already parsed
154      // (probabely a mistake from the user)
155  
156    ClearEntry();
157
158    Fp = 0;
159    if ( !OpenFile() )
160    {
161       // warning already performed in OpenFile()
162       //gdcmWarningMacro( "Unable to open as an ACR/DICOM file: "
163       //                 << Filename.c_str() );
164       Filetype = Unknown;
165       return false;
166    }
167
168    Group0002Parsed = false;
169
170    gdcmWarningMacro( "Starting parsing of file: " << Filename.c_str());
171
172    Fp->seekg(0, std::ios::end);
173    long lgt = Fp->tellg();       // total length of the file
174
175    Fp->seekg(0, std::ios::beg);
176
177    // CheckSwap returns a boolean 
178    // (false if no swap info of any kind was found)
179    if (! CheckSwap() )
180    {
181       gdcmWarningMacro( "Neither a DICOM V3 nor an ACR-NEMA file: " 
182                    << Filename.c_str());
183       CloseFile(); 
184       return false;      
185     }
186
187    long beg = Fp->tellg();      // just after DICOM preamble (if any)
188
189    lgt -= beg;                  // remaining length to parse    
190
191    // Recursive call.
192    // Loading is done during parsing
193    ParseDES( this, beg, lgt, false); // delim_mode is first defaulted to false
194
195    if ( IsEmpty() )
196    { 
197       gdcmWarningMacro( "No tag in internal hash table for: "
198                         << Filename.c_str());
199       CloseFile(); 
200       return false;
201    }
202    IsDocumentAlreadyLoaded = true;
203
204    Fp->seekg( 0, std::ios::beg);
205    
206    // Load 'non string' values
207       
208    std::string PhotometricInterpretation = GetEntryValue(0x0028,0x0004);   
209    if ( PhotometricInterpretation == "PALETTE COLOR " )
210    {
211    // FIXME
212    // Probabely this line should be outside the 'if'
213    // Try to find an image sample holding a 'gray LUT'
214       LoadEntryBinArea(0x0028,0x1200);  // gray LUT
215    
216       /// FIXME
217       /// The tags refered by the three following lines used to be CORRECTLY
218       /// defined as having an US Value Representation in the public
219       /// dictionary. BUT the semantics implied by the three following
220       /// lines state that the corresponding tag contents are in fact
221       /// the ones of a BinEntry.
222       /// In order to fix things "Quick and Dirty" the dictionary was
223       /// altered on PURPOSE but now contains a WRONG value.
224       /// In order to fix things and restore the dictionary to its
225       /// correct value, one needs to decided of the semantics by deciding
226       /// whether the following tags are either :
227       /// - multivaluated US, and hence loaded as ValEntry, but afterwards
228       ///   also used as BinEntry, which requires the proper conversion,
229       /// - OW, and hence loaded as BinEntry, but afterwards also used
230       ///   as ValEntry, which requires the proper conversion.
231       LoadEntryBinArea(0x0028,0x1201);  // R    LUT
232       LoadEntryBinArea(0x0028,0x1202);  // G    LUT
233       LoadEntryBinArea(0x0028,0x1203);  // B    LUT
234       
235       // Segmented Red   Palette Color LUT Data
236       LoadEntryBinArea(0x0028,0x1221);
237       // Segmented Green Palette Color LUT Data
238       LoadEntryBinArea(0x0028,0x1222);
239       // Segmented Blue  Palette Color LUT Data
240       LoadEntryBinArea(0x0028,0x1223);
241    }
242  
243    //FIXME later : how to use it?
244    SeqEntry *modLutSeq = GetSeqEntry(0x0028,0x3000);
245    if ( modLutSeq !=0 )
246    {
247       SQItem *sqi= modLutSeq->GetFirstSQItem();
248       if ( sqi != 0 )
249       {
250          BinEntry *b = sqi->GetBinEntry(0x0028,0x3006);
251          if ( b != 0 )
252          {
253             if ( b->GetLength() != 0 )
254             {
255                LoadEntryBinArea(b);    //LUT Data (CTX dependent)
256             }   
257         }
258      }      
259    }
260
261    CloseFile(); 
262   
263    // ----------------------------
264    // Specific code to allow gdcm to read ACR-LibIDO formated images
265    // Note: ACR-LibIDO is an extension of the ACR standard that was
266    //       used at CREATIS. For the time being (say a couple of years)
267    //       we keep this kludge to allow CREATIS users 
268    //       reading their old images.
269    //
270    // if recognition code tells us we deal with a LibIDO image
271    // we switch lineNumber and columnNumber
272    //
273    std::string RecCode;
274    RecCode = GetEntryValue(0x0008, 0x0010); // recognition code (RET)
275    if (RecCode == "ACRNEMA_LIBIDO_1.1" ||
276        RecCode == "CANRME_AILIBOD1_1." )  // for brain-damaged softwares
277                                           // with "little-endian strings"
278    {
279          Filetype = ACR_LIBIDO; 
280          std::string rows    = GetEntryValue(0x0028, 0x0010);
281          std::string columns = GetEntryValue(0x0028, 0x0011);
282          SetValEntry(columns, 0x0028, 0x0010);
283          SetValEntry(rows   , 0x0028, 0x0011);
284    }
285    // --- End of ACR-LibIDO kludge --- 
286
287    return true;
288 }
289
290 /**
291  * \brief   Get the public dictionary used
292  */
293 Dict *Document::GetPubDict()
294 {
295    return RefPubDict;
296 }
297
298 /**
299  * \brief   Get the shadow dictionary used
300  */
301 Dict *Document::GetShaDict()
302 {
303    return RefShaDict;
304 }
305
306 /**
307  * \brief   Set the shadow dictionary used
308  * @param   dict dictionary to use in shadow
309  */
310 bool Document::SetShaDict(Dict *dict)
311 {
312    RefShaDict = dict;
313    return !RefShaDict;
314 }
315
316 /**
317  * \brief   Set the shadow dictionary used
318  * @param   dictName name of the dictionary to use in shadow
319  */
320 bool Document::SetShaDict(DictKey const &dictName)
321 {
322    RefShaDict = Global::GetDicts()->GetDict(dictName);
323    return !RefShaDict;
324 }
325
326 /**
327  * \brief  This predicate tells us whether or not the current Document 
328  *         was properly parsed and contains at least *one* Dicom Element
329  *         (and nothing more, sorry).
330  * @return false when we're 150 % sure it's NOT a Dicom/Acr file,
331  *         true otherwise. 
332  */
333 bool Document::IsReadable()
334 {
335    if ( Filetype == Unknown )
336    {
337       gdcmWarningMacro( "Wrong filetype");
338       return false;
339    }
340
341    if ( IsEmpty() )
342    { 
343       gdcmWarningMacro( "No tag in internal hash table.");
344       return false;
345    }
346
347    return true;
348 }
349
350 /**
351  * \brief   Predicate for dicom version 3 file.
352  * @return  True when the file is a dicom version 3.
353  */
354 bool Document::IsDicomV3()
355 {
356    // Checking if Transfer Syntax exists is enough
357    // Anyway, it's too late check if the 'Preamble' was found ...
358    // And ... would it be a rich idea to check ?
359    // (some 'no Preamble' DICOM images exist !)
360    return GetDocEntry(0x0002, 0x0010) != NULL;
361 }
362
363 /**
364  * \brief   Predicate for Papyrus file
365  *          Dedicated to whomsoever it may concern
366  * @return  True when the file is a Papyrus file.
367  */
368 bool Document::IsPapyrus()
369 {
370    // check for Papyrus private Sequence
371    DocEntry *e = GetDocEntry(0x0041, 0x1050);
372    if ( !e )
373       return false;
374    // check if it's actually a Sequence
375    if ( !dynamic_cast<SeqEntry*>(e) )
376       return  false;
377    return true;
378 }
379
380 /**
381  * \brief  returns the File Type 
382  *         (ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown)
383  * @return the FileType code
384  */
385 FileType Document::GetFileType()
386 {
387    return Filetype;
388 }
389
390 /**
391  * \brief   Accessor to the Transfer Syntax (when present) of the
392  *          current document (it internally handles reading the
393  *          value from disk when only parsing occured).
394  * @return  The encountered Transfer Syntax of the current document.
395  */
396 std::string Document::GetTransferSyntax()
397 {
398    DocEntry *entry = GetDocEntry(0x0002, 0x0010);
399    if ( !entry )
400    {
401       return GDCM_UNKNOWN;
402    }
403
404    // The entry might be present but not loaded (parsing and loading
405    // happen at different stages): try loading and proceed with check...
406    LoadDocEntrySafe(entry);
407    if (ValEntry *valEntry = dynamic_cast< ValEntry* >(entry) )
408    {
409       std::string transfer = valEntry->GetValue();
410       // The actual transfer (as read from disk) might be padded. We
411       // first need to remove the potential padding. We can make the
412       // weak assumption that padding was not executed with digits...
413       if  ( transfer.length() == 0 )
414       {
415          // for brain damaged headers
416          return GDCM_UNKNOWN;
417       }
418       while ( !isdigit((unsigned char)transfer[transfer.length()-1]) )
419       {
420          transfer.erase(transfer.length()-1, 1);
421       }
422       return transfer;
423    }
424    return GDCM_UNKNOWN;
425 }
426
427 /**
428  * \brief Accesses the info from 0002,0010 : Transfer Syntax and TS
429  * @return The full Transfer Syntax Name (as opposed to Transfer Syntax UID)
430  */
431 std::string Document::GetTransferSyntaxName()
432 {
433    // use the TS (TS : Transfer Syntax)
434    std::string transferSyntax = GetEntryValue(0x0002,0x0010);
435
436    if ( (transferSyntax.find(GDCM_NOTLOADED) < transferSyntax.length()) )
437    {
438       gdcmErrorMacro( "Transfer Syntax not loaded. " << std::endl
439                << "Better you increase MAX_SIZE_LOAD_ELEMENT_VALUE" );
440       return "Uncompressed ACR-NEMA";
441    }
442    if ( transferSyntax == GDCM_UNFOUND )
443    {
444       gdcmWarningMacro( "Unfound Transfer Syntax (0002,0010)");
445       return "Uncompressed ACR-NEMA";
446    }
447
448    // we do it only when we need it
449    const TSKey &tsName = Global::GetTS()->GetValue( transferSyntax );
450
451    // Global::GetTS() is a global static you shall never try to delete it!
452    return tsName;
453 }
454 //
455 // --------------- Swap Code ------------------
456 /**
457  * \brief   Swaps the bytes so they agree with the processor order
458  * @return  The properly swaped 16 bits integer.
459  */
460 uint16_t Document::SwapShort(uint16_t a)
461 {
462    if ( SwapCode == 4321 || SwapCode == 2143 )
463    {
464       //a = ((( a << 8 ) & 0xff00 ) | (( a >> 8 ) & 0x00ff ) );
465       // Save CPU time
466       a = ( a << 8 ) | ( a >> 8 );
467    }
468    return a;
469 }
470
471 /**
472  * \brief   Swaps back the bytes of 4-byte long integer accordingly to
473  *          processor order.
474  * @return  The properly swaped 32 bits integer.
475  */
476 uint32_t Document::SwapLong(uint32_t a)
477 {
478    switch (SwapCode)
479    {
480       case 1234 :
481          break;
482       case 4321 :
483 //         a=( ((a<<24) & 0xff000000) | ((a<<8)  & 0x00ff0000) | 
484 //             ((a>>8)  & 0x0000ff00) | ((a>>24) & 0x000000ff) );
485 // save CPU time
486          a=( ( a<<24)               | ((a<<8)  & 0x00ff0000) | 
487              ((a>>8)  & 0x0000ff00) |  (a>>24)                );
488          break;   
489       case 3412 :
490 //       a=( ((a<<16) & 0xffff0000) | ((a>>16) & 0x0000ffff) );
491          a=( (a<<16)                | (a>>16)  );
492          break;  
493       case 2143 :
494          a=( ((a<< 8) & 0xff00ff00) | ((a>>8) & 0x00ff00ff)  );
495       break;
496       default :
497          gdcmErrorMacro( "Unset swap code:" << SwapCode );
498          a = 0;
499    }
500    return a;
501
502
503 //
504 // -----------------File I/O ---------------
505 /**
506  * \brief  Tries to open the file \ref Document::Filename and
507  *         checks the preamble when existing.
508  * @return The FILE pointer on success. 
509  */
510 std::ifstream *Document::OpenFile()
511 {
512    HasDCMPreamble = false;
513    if (Filename.length() == 0) 
514    {
515       return 0;
516    }
517
518    if ( Fp )
519    {
520       gdcmWarningMacro( "File already open: " << Filename.c_str());
521       CloseFile();
522    }
523
524    Fp = new std::ifstream(Filename.c_str(), std::ios::in | std::ios::binary);
525    if ( ! *Fp )
526    {
527    // Don't user gdcmErrorMacro :
528    // a spurious message will appear when you use, for instance 
529    // gdcm::FileHelper *fh = new gdcm::FileHelper( outputFileName );
530    // to create outputFileName.
531       gdcmWarningMacro( "Cannot open file: " << Filename.c_str());
532       delete Fp;
533       Fp = 0;
534       return 0;
535       //exit(1); // No function is allowed to leave the application instead
536                  // of warning the caller
537    }
538  
539    uint16_t zero = 0;
540    Fp->read((char*)&zero, (size_t)2);
541    if ( Fp->eof() )
542    {
543       CloseFile();
544       return 0;
545    }
546  
547    //-- ACR or DICOM with no Preamble; may start with a Shadow Group --
548    if ( 
549        zero == 0x0001 || zero == 0x0100 || zero == 0x0002 || zero == 0x0200 ||
550        zero == 0x0003 || zero == 0x0300 || zero == 0x0004 || zero == 0x0400 ||
551        zero == 0x0005 || zero == 0x0500 || zero == 0x0006 || zero == 0x0600 ||
552        zero == 0x0007 || zero == 0x0700 || zero == 0x0008 || zero == 0x0800 )
553    {
554       std::string msg = Util::Format(
555         "ACR/DICOM starting at the begining of the file:(%04x)\n", zero);
556       gdcmWarningMacro( msg.c_str() );
557       return Fp;
558    }
559  
560    //-- DICOM --
561    Fp->seekg(126L, std::ios::cur);
562    char dicm[4] = {' ',' ',' ',' '};
563    Fp->read(dicm,  (size_t)4);
564    if ( Fp->eof() )
565    {
566       CloseFile();
567       return 0;
568    }
569    if ( memcmp(dicm, "DICM", 4) == 0 )
570    {
571       HasDCMPreamble = true;
572       return Fp;
573    }
574
575    // -- Neither ACR/No Preamble Dicom nor DICOMV3 file
576    CloseFile();
577    gdcmWarningMacro( "Neither ACR/No Preamble Dicom nor DICOMV3 file: "
578                       << Filename.c_str()); 
579    return 0;
580 }
581
582 /**
583  * \brief closes the file  
584  * @return  TRUE if the close was successfull 
585  */
586 bool Document::CloseFile()
587 {
588    if ( Fp )
589    {
590       Fp->close();
591       delete Fp;
592       Fp = 0;
593    }
594    return true;
595 }
596
597 /**
598  * \brief Writes in a file all the Header Entries (Dicom Elements) 
599  * @param fp file pointer on an already open file (actually: Output File Stream)
600  * @param filetype Type of the File to be written 
601  *          (ACR-NEMA, ExplicitVR, ImplicitVR)
602  * @return Always true.
603  */
604 void Document::WriteContent(std::ofstream *fp, FileType filetype)
605 {
606    // \TODO move the following lines (and a lot of others, to be written)
607    // to a future function CheckAndCorrectHeader  
608
609    // (necessary if user wants to write a DICOM V3 file
610    // starting from an ACR-NEMA (V2) Header
611
612    if ( filetype == ImplicitVR || filetype == ExplicitVR )
613    {
614       // writing Dicom File Preamble
615       char filePreamble[128];
616       memset(filePreamble, 0, 128);
617       fp->write(filePreamble, 128);
618       fp->write("DICM", 4);
619    }
620
621    /*
622     * \todo rewrite later, if really usefull
623     *       - 'Group Length' element is optional in DICOM
624     *       - but un-updated odd groups lengthes can causes pb
625     *         (xmedcon breaker)
626     *
627     * if ( (filetype == ImplicitVR) || (filetype == ExplicitVR) )
628     *    UpdateGroupLength(false,filetype);
629     * if ( filetype == ACR)
630     *    UpdateGroupLength(true,ACR);
631     */
632
633    ElementSet::WriteContent(fp, filetype); // This one is recursive
634 }
635
636 // -----------------------------------------
637 // Content entries 
638 /**
639  * \brief Loads (from disk) the element content 
640  *        when a string is not suitable
641  * @param group   group number of the Entry 
642  * @param elem  element number of the Entry
643  */
644 void Document::LoadEntryBinArea(uint16_t group, uint16_t elem)
645 {
646    // Search the corresponding DocEntry
647    DocEntry *docElement = GetDocEntry(group, elem);
648    if ( !docElement )
649       return;
650
651    BinEntry *binElement = dynamic_cast<BinEntry *>(docElement);
652    if ( !binElement )
653       return;
654
655    LoadEntryBinArea(binElement);
656 }
657
658 /**
659  * \brief Loads (from disk) the element content 
660  *        when a string is not suitable
661  * @param elem  Entry whose binArea is going to be loaded
662  */
663 void Document::LoadEntryBinArea(BinEntry *elem) 
664 {
665    if (elem->GetBinArea() )
666       return;
667
668    bool openFile = !Fp;
669    if ( openFile )
670       OpenFile();
671
672    size_t o =(size_t)elem->GetOffset();
673    Fp->seekg(o, std::ios::beg);
674
675    size_t l = elem->GetLength();
676    uint8_t *a = new uint8_t[l];
677    if ( !a )
678    {
679       gdcmWarningMacro( "Cannot allocate BinEntry content");
680       return;
681    }
682
683    Fp->read((char*)a, l);
684    if ( Fp->fail() || Fp->eof() )
685    {
686       delete[] a;
687       return;
688    }
689
690    elem->SetBinArea(a);
691
692    if ( openFile )
693       CloseFile();
694 }
695
696 /**
697  * \brief  Loads the element while preserving the current
698  *         underlying file position indicator as opposed to
699  *        LoadDocEntry that modifies it.
700  * @param entry   DocEntry whose value will be loaded. 
701  */
702 void Document::LoadDocEntrySafe(DocEntry *entry)
703 {
704    if ( Fp )
705    {
706       long PositionOnEntry = Fp->tellg();
707       LoadDocEntry(entry);
708       Fp->seekg(PositionOnEntry, std::ios::beg);
709    }
710 }
711
712 /**
713  * \brief   Compares two documents, according to \ref DicomDir rules
714  * \warning Does NOT work with ACR-NEMA files
715  * \todo    Find a trick to solve the pb (use RET fields ?)
716  * @param   document to compare with current one
717  * @return  true if 'smaller'
718  */
719 bool Document::operator<(Document &document)
720 {
721    // Patient Name
722    std::string s1 = GetEntryValue(0x0010,0x0010);
723    std::string s2 = document.GetEntryValue(0x0010,0x0010);
724    if (s1 < s2)
725    {
726       return true;
727    }
728    else if ( s1 > s2 )
729    {
730       return false;
731    }
732    else
733    {
734       // Patient ID
735       s1 = GetEntryValue(0x0010,0x0020);
736       s2 = document.GetEntryValue(0x0010,0x0020);
737       if ( s1 < s2 )
738       {
739          return true;
740       }
741       else if ( s1 > s2 )
742       {
743          return false;
744       }
745       else
746       {
747          // Study Instance UID
748          s1 = GetEntryValue(0x0020,0x000d);
749          s2 = document.GetEntryValue(0x0020,0x000d);
750          if ( s1 < s2 )
751          {
752             return true;
753          }
754          else if ( s1 > s2 )
755          {
756             return false;
757          }
758          else
759          {
760             // Serie Instance UID
761             s1 = GetEntryValue(0x0020,0x000e);
762             s2 = document.GetEntryValue(0x0020,0x000e);    
763             if ( s1 < s2 )
764             {
765                return true;
766             }
767             else if ( s1 > s2 )
768             {
769                return false;
770             }
771          }
772       }
773    }
774    return false;
775 }
776
777 //-----------------------------------------------------------------------------
778 // Protected
779 /**
780  * \brief Reads a supposed to be 16 Bits integer
781  *       (swaps it depending on processor endianness) 
782  * @return read value
783  */
784 uint16_t Document::ReadInt16()
785    throw( FormatError )
786 {
787    uint16_t g;
788    Fp->read ((char*)&g, (size_t)2);
789    if ( Fp->fail() )
790    {
791       throw FormatError( "Document::ReadInt16()", " file error." );
792    }
793    if ( Fp->eof() )
794    {
795       throw FormatError( "Document::ReadInt16()", "EOF." );
796    }
797    g = SwapShort(g); 
798    return g;
799 }
800
801 /**
802  * \brief  Reads a supposed to be 32 Bits integer
803  *        (swaps it depending on processor endianness)  
804  * @return read value
805  */
806 uint32_t Document::ReadInt32()
807    throw( FormatError )
808 {
809    uint32_t g;
810    Fp->read ((char*)&g, (size_t)4);
811    if ( Fp->fail() )
812    {
813       throw FormatError( "Document::ReadInt32()", " file error." );
814    }
815    if ( Fp->eof() )
816    {
817       throw FormatError( "Document::ReadInt32()", "EOF." );
818    }
819    g = SwapLong(g);
820    return g;
821 }
822
823 /**
824  * \brief skips bytes inside the source file 
825  * \warning NOT end user intended method !
826  * @return 
827  */
828 void Document::SkipBytes(uint32_t nBytes)
829 {
830    //FIXME don't dump the returned value
831    Fp->seekg((long)nBytes, std::ios::cur);
832 }
833
834 /**
835  * \brief   Re-computes the length of a ACR-NEMA/Dicom group from a DcmHeader
836  * @param filetype Type of the File to be written 
837  */
838 int Document::ComputeGroup0002Length( FileType filetype ) 
839 {
840    uint16_t gr;
841    std::string vr;
842    
843    int groupLength = 0;
844    bool found0002 = false;   
845   
846    // for each zero-level Tag in the DCM Header
847    DocEntry *entry = GetFirstEntry();
848    while( entry )
849    {
850       gr = entry->GetGroup();
851
852       if ( gr == 0x0002 )
853       {
854          found0002 = true;
855
856          if ( entry->GetElement() != 0x0000 )
857          {
858             vr = entry->GetVR();
859  
860             if ( filetype == ExplicitVR )
861             {
862                if ( (vr == "OB") || (vr == "OW") || (vr == "SQ") || (vr == "UT") ) 
863                {
864                   // explicit VR AND OB, OW, SQ, UT : 4 more bytes
865                   groupLength +=  4;
866                }
867             }
868             groupLength += 2 + 2 + 4 + entry->GetLength();   
869          }
870       }
871       else if (found0002 )
872          break;
873
874       entry = GetNextEntry();
875    }
876    return groupLength; 
877 }
878
879 //-----------------------------------------------------------------------------
880 // Private
881 /**
882  * \brief Loads all the needed Dictionaries
883  * \warning NOT end user intended method !   
884  */
885 void Document::Initialize() 
886 {
887    RefPubDict = Global::GetDicts()->GetDefaultPubDict();
888    RefShaDict = NULL;
889    Filetype   = Unknown;
890 }
891
892 /**
893  * \brief   Parses a DocEntrySet (Zero-level DocEntries or SQ Item DocEntries)
894  * @param set DocEntrySet we are going to parse ('zero level' or a SQItem)
895  * @param offset start of parsing
896  * @param l_max  length to parse (meaningless when we are in 'delimitor mode')
897  * @param delim_mode : whether we are in 'delimitor mode' (l=0xffffff) or not
898  */ 
899 void Document::ParseDES(DocEntrySet *set, long offset, 
900                         long l_max, bool delim_mode)
901 {
902    DocEntry *newDocEntry;
903    ValEntry *newValEntry;
904    BinEntry *newBinEntry;
905    SeqEntry *newSeqEntry;
906    VRKey vr;
907    bool used;
908    bool delim_mode_intern = delim_mode;
909
910    while (true)
911    {
912       if ( !delim_mode && ((long)(Fp->tellg())-offset) >= l_max)
913       {
914          break;
915       }
916
917       newDocEntry = ReadNextDocEntry( );
918
919       if ( !newDocEntry )
920       {
921          break;
922       }
923
924       used = true;
925       newValEntry = dynamic_cast<ValEntry*>(newDocEntry);
926       newBinEntry = dynamic_cast<BinEntry*>(newDocEntry);
927
928       if ( newValEntry || newBinEntry )  
929       {
930        //////////////////////////// ContentEntry
931          if ( newBinEntry )
932          {
933             vr = newDocEntry->GetVR();
934             if ( Filetype == ExplicitVR && 
935                  !Global::GetVR()->IsVROfBinaryRepresentable(vr) )
936             { 
937                 ////// Neither ValEntry NOR BinEntry: should mean UNKOWN VR
938                 gdcmWarningMacro( std::hex << newDocEntry->GetGroup() 
939                                   << "|" << newDocEntry->GetElement()
940                                   << " : Neither Valentry, nor BinEntry." 
941                                   "Probably unknown VR.");
942             }
943
944          //////////////////// BinEntry or UNKOWN VR:
945
946             // When "this" is a Document the Key is simply of the
947             // form ( group, elem )...
948             if ( dynamic_cast< Document* > ( set ) )
949             {
950                newBinEntry->SetKey( newBinEntry->GetKey() );
951             }
952             // but when "this" is a SQItem, we are inserting this new
953             // valEntry in a sequence item, and the key has the
954             // generalized form (refer to \ref BaseTagKey):
955
956             // time waste hunting
957             //if (SQItem *parentSQItem = dynamic_cast< SQItem* > ( set ) )
958             //{
959             //   newBinEntry->SetKey(  parentSQItem->GetBaseTagKey()
960             //                       + newBinEntry->GetKey() );
961             //}
962            
963             if ( !set->AddEntry( newBinEntry ) )
964             {
965                gdcmWarningMacro( "in ParseDES : cannot add a BinEntry "
966                                    << newBinEntry->GetKey() );
967                used=false;
968             }
969             else
970             {
971                // Load only if we can add (not a duplicate key)
972                LoadDocEntry( newBinEntry );
973             }
974          }  // end BinEntry
975          else
976          {
977          /////////////////////// ValEntry
978
979             // When "set" is a Document, then we are at the top of the
980             // hierarchy and the Key is simply of the form ( group, elem )...
981             if ( dynamic_cast< Document* > ( set ) )
982             {
983                newValEntry->SetKey( newValEntry->GetKey() );
984             }
985             // ...but when "set" is a SQItem, we are inserting this new
986             // valEntry in a sequence item. Hence the key has the
987             // generalized form (refer to \ref BaseTagKey):
988
989             // time waste hunting
990             //if (SQItem *parentSQItem = dynamic_cast< SQItem* > ( set ) )
991             //{
992             //   newValEntry->SetKey(  parentSQItem->GetBaseTagKey()
993             //                      + newValEntry->GetKey() );
994             //}
995
996             if ( LoadMode & NO_SHADOW ) // User asked to skip, if possible, 
997                                         // shadow groups ( if possible :
998                                         // whether element 0x0000 exits)
999             {
1000                if ( newValEntry->GetGroup()%2 != 0 )
1001                {
1002                   if ( newValEntry->GetElement() == 0x0000 )
1003                   {
1004                      std::string strLgrGroup = newValEntry->GetValue();
1005                      int lgrGroup;
1006                      if ( strLgrGroup != GDCM_UNFOUND)
1007                      {
1008                         lgrGroup = atoi(strLgrGroup.c_str());
1009                         Fp->seekg(lgrGroup, std::ios::cur);
1010                         used = false;
1011                         continue;
1012                      }
1013                   }
1014                }
1015              }
1016
1017             if ( !set->AddEntry( newValEntry ) )
1018             {
1019               gdcmWarningMacro( "in ParseDES : cannot add a ValEntry "
1020                                   << newValEntry->GetKey() );  
1021               used=false;
1022             }
1023             else
1024             {
1025                // Load only if we can add (not a duplicate key)
1026                LoadDocEntry( newValEntry );
1027             }
1028
1029             bool delimitor=newValEntry->IsItemDelimitor();
1030
1031             if ( delimitor || 
1032                 (!delim_mode && ((long)(Fp->tellg())-offset) >= l_max) )
1033             {
1034                if ( !used )
1035                   delete newDocEntry;
1036                break;
1037             }
1038          }
1039
1040          // Just to make sure we are at the beginning of next entry.
1041          SkipToNextDocEntry(newDocEntry);
1042       }
1043       else
1044       {
1045          /////////////////////// SeqEntry :  VR = "SQ"
1046
1047          unsigned long l = newDocEntry->GetReadLength();          
1048          if ( l != 0 ) // don't mess the delim_mode for 'zero-length sequence'
1049          {
1050             if ( l == 0xffffffff )
1051             {
1052               delim_mode_intern = true;
1053             }
1054             else
1055             {
1056               delim_mode_intern = false;
1057             }
1058          }
1059
1060          if ( (LoadMode & NO_SHADOWSEQ) && ! delim_mode_intern )
1061          { 
1062            // User asked to skip SeQuences *only* if they belong to Shadow Group
1063             if ( newDocEntry->GetGroup()%2 != 0 )
1064             {
1065                 Fp->seekg( l, std::ios::cur);
1066                 used = false;
1067                 continue;  
1068             } 
1069          } 
1070          if ( (LoadMode & NO_SEQ) && ! delim_mode_intern ) 
1071          {
1072            // User asked to skip *any* SeQuence
1073             Fp->seekg( l, std::ios::cur);
1074             used = false;
1075             continue;
1076          }
1077          // delay the dynamic cast as late as possible
1078          newSeqEntry = dynamic_cast<SeqEntry*>(newDocEntry);
1079          
1080          // no other way to create the Delimitor ...
1081          newSeqEntry->SetDelimitorMode( delim_mode_intern );
1082
1083          // At the top of the hierarchy, stands a Document. When "set"
1084          // is a Document, then we are building the first depth level.
1085          // Hence the SeqEntry we are building simply has a depth
1086          // level of one:
1087          if ( dynamic_cast< Document* > ( set ) )
1088          {
1089             newSeqEntry->SetDepthLevel( 1 );
1090             newSeqEntry->SetKey( newSeqEntry->GetKey() );
1091          }
1092          // But when "set" is already a SQItem, we are building a nested
1093          // sequence, and hence the depth level of the new SeqEntry
1094          // we are building, is one level deeper:
1095
1096          // time waste hunting
1097          if (SQItem *parentSQItem = dynamic_cast< SQItem* > ( set ) )
1098          {
1099             newSeqEntry->SetDepthLevel( parentSQItem->GetDepthLevel() + 1 );
1100
1101           //  newSeqEntry->SetKey(  parentSQItem->GetBaseTagKey()
1102           //                      + newSeqEntry->GetKey() );
1103          }
1104
1105          if ( l != 0 )
1106          {  // Don't try to parse zero-length sequences
1107             ParseSQ( newSeqEntry, 
1108                      newDocEntry->GetOffset(),
1109                      l, delim_mode_intern);
1110          }
1111          if ( !set->AddEntry( newSeqEntry ) )
1112          {
1113             gdcmWarningMacro( "in ParseDES : cannot add a SeqEntry "
1114                                 << newSeqEntry->GetKey() );
1115             used = false;
1116          }
1117  
1118          if ( !delim_mode && ((long)(Fp->tellg())-offset) >= l_max)
1119          {
1120             if ( !used )
1121                delete newDocEntry;
1122             break;
1123          }
1124       }  // end SeqEntry : VR = "SQ"
1125
1126       if ( !used )
1127          delete newDocEntry;
1128    }                               // end While
1129 }
1130
1131 /**
1132  * \brief   Parses a Sequence ( SeqEntry after SeqEntry)
1133  * @return  parsed length for this level
1134  */ 
1135 void Document::ParseSQ( SeqEntry *seqEntry,
1136                         long offset, long l_max, bool delim_mode)
1137 {
1138    int SQItemNumber = 0;
1139    bool dlm_mod;
1140    long offsetStartCurrentSQItem = offset;
1141
1142    while (true)
1143    {
1144       // the first time, we read the fff0,e000 of the first SQItem
1145       DocEntry *newDocEntry = ReadNextDocEntry();
1146
1147       if ( !newDocEntry )
1148       {
1149          // FIXME Should warn user
1150          gdcmWarningMacro("in ParseSQ : should never get here!");
1151          break;
1152       }
1153       if ( delim_mode )
1154       {
1155          if ( newDocEntry->IsSequenceDelimitor() )
1156          {
1157             seqEntry->SetDelimitationItem( newDocEntry ); 
1158             break;
1159          }
1160       }
1161       if ( !delim_mode && ((long)(Fp->tellg())-offset) >= l_max)
1162       {
1163          delete newDocEntry;
1164          break;
1165       }
1166       // create the current SQItem
1167       SQItem *itemSQ = new SQItem( seqEntry->GetDepthLevel() );
1168 /*
1169       std::ostringstream newBase;
1170       newBase << seqEntry->GetKey()
1171               << "/"
1172               << SQItemNumber
1173               << "#";
1174       itemSQ->SetBaseTagKey( newBase.str() );
1175 */
1176       unsigned int l = newDocEntry->GetReadLength();
1177       
1178       if ( l == 0xffffffff )
1179       {
1180          dlm_mod = true;
1181       }
1182       else
1183       {
1184          dlm_mod = false;
1185       }
1186
1187       // Let's try :------------
1188       // remove fff0,e000, created out of the SQItem
1189       delete newDocEntry;
1190       Fp->seekg(offsetStartCurrentSQItem, std::ios::beg);
1191       // fill up the current SQItem, starting at the beginning of fff0,e000
1192
1193       ParseDES(itemSQ, offsetStartCurrentSQItem, l+8, dlm_mod);
1194
1195       offsetStartCurrentSQItem = Fp->tellg();
1196       // end try -----------------
1197  
1198       seqEntry->AddSQItem( itemSQ, SQItemNumber ); 
1199       SQItemNumber++;
1200       if ( !delim_mode && ((long)(Fp->tellg())-offset ) >= l_max )
1201       {
1202          break;
1203       }
1204    }
1205 }
1206
1207 /**
1208  * \brief   Loads the element content if its length doesn't exceed
1209  *          the value specified with Document::SetMaxSizeLoadEntry()
1210  * @param   entry Header Entry (Dicom Element) to be dealt with
1211  */
1212 void Document::LoadDocEntry(DocEntry *entry)
1213 {
1214    uint16_t group  = entry->GetGroup();
1215    std::string  vr = entry->GetVR();
1216    uint32_t length = entry->GetLength();
1217
1218    Fp->seekg((long)entry->GetOffset(), std::ios::beg);
1219
1220    // A SeQuence "contains" a set of Elements.  
1221    //          (fffe e000) tells us an Element is beginning
1222    //          (fffe e00d) tells us an Element just ended
1223    //          (fffe e0dd) tells us the current SeQuence just ended
1224    if ( group == 0xfffe )
1225    {
1226       // NO more value field for SQ !
1227       return;
1228    }
1229
1230    // When the length is zero things are easy:
1231    if ( length == 0 )
1232    {
1233       ((ValEntry *)entry)->SetValue("");
1234       return;
1235    }
1236
1237    // The elements whose length is bigger than the specified upper bound
1238    // are not loaded. Instead we leave a short notice on the offset of
1239    // the element content and it's length.
1240
1241    std::ostringstream s;
1242    if (length > MaxSizeLoadEntry)
1243    {
1244       if (BinEntry *binEntryPtr = dynamic_cast< BinEntry* >(entry) )
1245       {  
1246          s << GDCM_NOTLOADED;
1247          s << " Ad.:" << (long)entry->GetOffset();
1248          s << " x(" << std::hex << entry->GetOffset() << ")";
1249          s << std::dec;
1250          s << " Lgt:"  << entry->GetLength();
1251          s << " x(" << std::hex << entry->GetLength() << ")";
1252          binEntryPtr->SetValue(s.str());
1253       }
1254       else if (ValEntry *valEntryPtr = dynamic_cast< ValEntry* >(entry) )
1255       {
1256          s << GDCM_NOTLOADED;  
1257          s << " Address:" << (long)entry->GetOffset();
1258          s << " Length:"  << entry->GetLength();
1259          s << " x(" << std::hex << entry->GetLength() << ")";
1260          valEntryPtr->SetValue(s.str());
1261       }
1262       else
1263       {
1264          // fusible
1265          gdcmErrorMacro( "MaxSizeLoadEntry exceeded, neither a BinEntry "
1266                       << "nor a ValEntry ?! Should never print that !" );
1267       }
1268
1269       // to be sure we are at the end of the value ...
1270       Fp->seekg((long)entry->GetOffset()+(long)entry->GetLength(),
1271                 std::ios::beg);
1272       return;
1273    }
1274
1275    // When we find a BinEntry not very much can be done :
1276    if (BinEntry *binEntryPtr = dynamic_cast< BinEntry* >(entry) )
1277    {
1278       s << GDCM_BINLOADED;
1279       binEntryPtr->SetValue(s.str());
1280       LoadEntryBinArea(binEntryPtr); // last one, not to erase length !
1281       return;
1282    }
1283
1284    if ( IsDocEntryAnInteger(entry) )
1285    {   
1286       uint32_t NewInt;
1287       int nbInt;
1288       // When short integer(s) are expected, read and convert the following 
1289       // (n * 2) characters properly i.e. consider them as short integers as
1290       // opposed to strings.
1291       // Elements with Value Multiplicity > 1
1292       // contain a set of integers (not a single one)       
1293       if (vr == "US" || vr == "SS")
1294       {
1295          nbInt = length / 2;
1296          NewInt = ReadInt16();
1297          s << NewInt;
1298          if (nbInt > 1)
1299          {
1300             for (int i=1; i < nbInt; i++)
1301             {
1302                s << '\\';
1303                NewInt = ReadInt16();
1304                s << NewInt;
1305             }
1306          }
1307       }
1308       // See above comment on multiple integers (mutatis mutandis).
1309       else if (vr == "UL" || vr == "SL")
1310       {
1311          nbInt = length / 4;
1312          NewInt = ReadInt32();
1313          s << NewInt;
1314          if (nbInt > 1)
1315          {
1316             for (int i=1; i < nbInt; i++)
1317             {
1318                s << '\\';
1319                NewInt = ReadInt32();
1320                s << NewInt;
1321             }
1322          }
1323       }
1324 #ifdef GDCM_NO_ANSI_STRING_STREAM
1325       s << std::ends; // to avoid oddities on Solaris
1326 #endif //GDCM_NO_ANSI_STRING_STREAM
1327
1328       ((ValEntry *)entry)->SetValue(s.str());
1329       return;
1330    }
1331    
1332   // FIXME: We need an additional byte for storing \0 that is not on disk
1333    char *str = new char[length+1];
1334    Fp->read(str, (size_t)length);
1335    str[length] = '\0'; //this is only useful when length is odd
1336    // Special DicomString call to properly handle \0 and even length
1337    std::string newValue;
1338    if ( length % 2 )
1339    {
1340       newValue = Util::DicomString(str, length+1);
1341       gdcmWarningMacro("Warning: bad length: " << length <<
1342                        " For string :" <<  newValue.c_str()); 
1343       // Since we change the length of string update it length
1344       //entry->SetReadLength(length+1);
1345    }
1346    else
1347    {
1348       newValue = Util::DicomString(str, length);
1349    }
1350    delete[] str;
1351
1352    if ( ValEntry *valEntry = dynamic_cast<ValEntry* >(entry) )
1353    {
1354       if ( Fp->fail() || Fp->eof())
1355       {
1356          if ( Fp->fail() )
1357             gdcmWarningMacro("--> fail");
1358
1359          gdcmWarningMacro("Unread element value " << valEntry->GetKey() 
1360                           << " lgt : " << valEntry->GetReadLength() 
1361                           << " at " << std::hex << valEntry->GetOffset());
1362          valEntry->SetValue(GDCM_UNREAD);
1363          return;
1364       }
1365
1366       if ( vr == "UI" )
1367       {
1368          // Because of correspondance with the VR dic
1369          valEntry->SetValue(newValue);
1370       }
1371       else
1372       {
1373          valEntry->SetValue(newValue);
1374       }
1375    }
1376    else
1377    {
1378       gdcmWarningMacro("Should have a ValEntry, here ! " << valEntry->GetKey() 
1379                           << " lgt : " << valEntry->GetReadLength() 
1380                           << " at " << std::hex << valEntry->GetOffset());
1381    }
1382 }
1383
1384 /**
1385  * \brief  Find the value Length of the passed Header Entry
1386  * @param  entry Header Entry whose length of the value shall be loaded. 
1387  */
1388 void Document::FindDocEntryLength( DocEntry *entry )
1389    throw ( FormatError )
1390 {
1391    std::string  vr  = entry->GetVR();
1392    uint16_t length16;       
1393    
1394    if ( Filetype == ExplicitVR && !entry->IsImplicitVR() ) 
1395    {
1396       if ( vr == "OB" || vr == "OW" || vr == "SQ" || vr == "UT" || vr == "UN" ) 
1397       {
1398          // The following reserved two bytes (see PS 3.5-2003, section
1399          // "7.1.2 Data element structure with explicit vr", p 27) must be
1400          // skipped before proceeding on reading the length on 4 bytes.
1401          Fp->seekg( 2L, std::ios::cur);
1402          uint32_t length32 = ReadInt32();
1403
1404          if ( (vr == "OB" || vr == "OW") && length32 == 0xffffffff ) 
1405          {
1406             uint32_t lengthOB;
1407             try 
1408             {
1409                lengthOB = FindDocEntryLengthOBOrOW();
1410             }
1411             catch ( FormatUnexpected )
1412             {
1413                // Computing the length failed (this happens with broken
1414                // files like gdcm-JPEG-LossLess3a.dcm). We still have a
1415                // chance to get the pixels by deciding the element goes
1416                // until the end of the file. Hence we artificially fix the
1417                // the length and proceed.
1418                long currentPosition = Fp->tellg();
1419                Fp->seekg(0L,std::ios::end);
1420
1421                long lengthUntilEOF = (long)(Fp->tellg())-currentPosition;
1422                Fp->seekg(currentPosition, std::ios::beg);
1423
1424                entry->SetReadLength(lengthUntilEOF);
1425                entry->SetLength(lengthUntilEOF);
1426                return;
1427             }
1428             entry->SetReadLength(lengthOB);
1429             entry->SetLength(lengthOB);
1430             return;
1431          }
1432          FixDocEntryFoundLength(entry, length32); 
1433          return;
1434       }
1435
1436       // Length is encoded on 2 bytes.
1437       length16 = ReadInt16();
1438   
1439       // 0xffff means that we deal with 'No Length' Sequence 
1440       //        or 'No Length' SQItem
1441       if ( length16 == 0xffff) 
1442       {           
1443          length16 = 0;
1444       }
1445       FixDocEntryFoundLength( entry, (uint32_t)length16 );
1446       return;
1447    }
1448    else
1449    {
1450       // Either implicit VR or a non DICOM conformal (see note below) explicit
1451       // VR that ommited the VR of (at least) this element. Farts happen.
1452       // [Note: according to the part 5, PS 3.5-2001, section 7.1 p25
1453       // on Data elements "Implicit and Explicit VR Data Elements shall
1454       // not coexist in a Data Set and Data Sets nested within it".]
1455       // Length is on 4 bytes.
1456
1457      // Well ... group 0002 is always coded in 'Explicit VR Litle Endian'
1458      // even if Transfer Syntax is 'Implicit VR ...' 
1459       
1460       FixDocEntryFoundLength( entry, ReadInt32() );
1461       return;
1462    }
1463 }
1464
1465 /**
1466  * \brief  Find the Length till the next sequence delimiter
1467  * \warning NOT end user intended method !
1468  * @return 
1469  */
1470 uint32_t Document::FindDocEntryLengthOBOrOW()
1471    throw( FormatUnexpected )
1472 {
1473    // See PS 3.5-2001, section A.4 p. 49 on encapsulation of encoded pixel data.
1474    long positionOnEntry = Fp->tellg();
1475    bool foundSequenceDelimiter = false;
1476    uint32_t totalLength = 0;
1477
1478    while ( !foundSequenceDelimiter )
1479    {
1480       uint16_t group;
1481       uint16_t elem;
1482       try
1483       {
1484          group = ReadInt16();
1485          elem  = ReadInt16();   
1486       }
1487       catch ( FormatError )
1488       {
1489          throw FormatError("Unexpected end of file encountered during ",
1490                            "Document::FindDocEntryLengthOBOrOW()");
1491       }
1492       // We have to decount the group and element we just read
1493       totalLength += 4;     
1494       if ( group != 0xfffe || ( ( elem != 0xe0dd ) && ( elem != 0xe000 ) ) )
1495       {
1496          long filePosition = Fp->tellg();
1497          gdcmWarningMacro( 
1498               "Neither an Item tag nor a Sequence delimiter tag on :" 
1499            << std::hex << group << " , " << elem 
1500            << ") -before- position x(" << filePosition << ")" );
1501   
1502          Fp->seekg(positionOnEntry, std::ios::beg);
1503          throw FormatUnexpected( 
1504                "Neither an Item tag nor a Sequence delimiter tag.");
1505       }
1506       if ( elem == 0xe0dd )
1507       {
1508          foundSequenceDelimiter = true;
1509       }
1510       uint32_t itemLength = ReadInt32();
1511       // We add 4 bytes since we just read the ItemLength with ReadInt32
1512       totalLength += itemLength + 4;
1513       SkipBytes(itemLength);
1514       
1515       if ( foundSequenceDelimiter )
1516       {
1517          break;
1518       }
1519    }
1520    Fp->seekg( positionOnEntry, std::ios::beg);
1521    return totalLength;
1522 }
1523
1524 /**
1525  * \brief     Find the Value Representation of the current Dicom Element.
1526  * @return    Value Representation of the current Entry
1527  */
1528 std::string Document::FindDocEntryVR()
1529 {
1530    if ( Filetype != ExplicitVR )
1531       return GDCM_UNKNOWN;
1532
1533    long positionOnEntry = Fp->tellg();
1534    // Warning: we believe this is explicit VR (Value Representation) because
1535    // we used a heuristic that found "UL" in the first tag. Alas this
1536    // doesn't guarantee that all the tags will be in explicit VR. In some
1537    // cases (see e-film filtered files) one finds implicit VR tags mixed
1538    // within an explicit VR file. Hence we make sure the present tag
1539    // is in explicit VR and try to fix things if it happens not to be
1540    // the case.
1541
1542    char vr[3];
1543    Fp->read (vr, (size_t)2);
1544    vr[2] = 0;
1545
1546    if ( !CheckDocEntryVR(vr) )
1547    {
1548       Fp->seekg(positionOnEntry, std::ios::beg);
1549       return GDCM_UNKNOWN;
1550    }
1551    return vr;
1552 }
1553
1554 /**
1555  * \brief     Check the correspondance between the VR of the header entry
1556  *            and the taken VR. If they are different, the header entry is 
1557  *            updated with the new VR.
1558  * @param     vr    Dicom Value Representation
1559  * @return    false if the VR is incorrect of if the VR isn't referenced
1560  *            otherwise, it returns true
1561 */
1562 bool Document::CheckDocEntryVR(VRKey vr)
1563 {
1564    if ( !Global::GetVR()->IsValidVR(vr) )
1565       return false;
1566
1567    return true; 
1568 }
1569
1570 /**
1571  * \brief   Get the transformed value of the header entry. The VR value 
1572  *          is used to define the transformation to operate on the value
1573  * \warning NOT end user intended method !
1574  * @param   entry entry to tranform
1575  * @return  Transformed entry value
1576  */
1577 std::string Document::GetDocEntryValue(DocEntry *entry)
1578 {
1579    if ( IsDocEntryAnInteger(entry) && entry->IsImplicitVR() )
1580    {
1581       std::string val = ((ValEntry *)entry)->GetValue();
1582       std::string vr  = entry->GetVR();
1583       uint32_t length = entry->GetLength();
1584       std::ostringstream s;
1585       int nbInt;
1586
1587       // When short integer(s) are expected, read and convert the following 
1588       // n * 2 bytes properly i.e. as a multivaluated strings
1589       // (each single value is separated fromthe next one by '\'
1590       // as usual for standard multivaluated filels
1591       // Elements with Value Multiplicity > 1
1592       // contain a set of short integers (not a single one) 
1593    
1594       if ( vr == "US" || vr == "SS" )
1595       {
1596          uint16_t newInt16;
1597
1598          nbInt = length / 2;
1599          for (int i=0; i < nbInt; i++) 
1600          {
1601             if ( i != 0 )
1602             {
1603                s << '\\';
1604             }
1605             newInt16 = ( val[2*i+0] & 0xFF ) + ( ( val[2*i+1] & 0xFF ) << 8);
1606             newInt16 = SwapShort( newInt16 );
1607             s << newInt16;
1608          }
1609       }
1610
1611       // When integer(s) are expected, read and convert the following 
1612       // n * 4 bytes properly i.e. as a multivaluated strings
1613       // (each single value is separated fromthe next one by '\'
1614       // as usual for standard multivaluated filels
1615       // Elements with Value Multiplicity > 1
1616       // contain a set of integers (not a single one) 
1617       else if ( vr == "UL" || vr == "SL" )
1618       {
1619          uint32_t newInt32;
1620
1621          nbInt = length / 4;
1622          for (int i=0; i < nbInt; i++) 
1623          {
1624             if ( i != 0)
1625             {
1626                s << '\\';
1627             }
1628             newInt32 = ( val[4*i+0] & 0xFF )
1629                     + (( val[4*i+1] & 0xFF ) <<  8 )
1630                     + (( val[4*i+2] & 0xFF ) << 16 )
1631                     + (( val[4*i+3] & 0xFF ) << 24 );
1632             newInt32 = SwapLong( newInt32 );
1633             s << newInt32;
1634          }
1635       }
1636 #ifdef GDCM_NO_ANSI_STRING_STREAM
1637       s << std::ends; // to avoid oddities on Solaris
1638 #endif //GDCM_NO_ANSI_STRING_STREAM
1639       return s.str();
1640    }
1641    return ((ValEntry *)entry)->GetValue();
1642 }
1643
1644 /**
1645  * \brief   Get the reverse transformed value of the header entry. The VR 
1646  *          value is used to define the reverse transformation to operate on
1647  *          the value
1648  * \warning NOT end user intended method !
1649  * @param   entry Entry to reverse transform
1650  * @return  Reverse transformed entry value
1651  */
1652 std::string Document::GetDocEntryUnvalue(DocEntry *entry)
1653 {
1654    if ( IsDocEntryAnInteger(entry) && entry->IsImplicitVR() )
1655    {
1656       std::string vr = entry->GetVR();
1657       std::vector<std::string> tokens;
1658       std::ostringstream s;
1659
1660       if ( vr == "US" || vr == "SS" ) 
1661       {
1662          uint16_t newInt16;
1663
1664          tokens.erase( tokens.begin(), tokens.end()); // clean any previous value
1665          Util::Tokenize (((ValEntry *)entry)->GetValue(), tokens, "\\");
1666          for (unsigned int i=0; i<tokens.size(); i++) 
1667          {
1668             newInt16 = atoi(tokens[i].c_str());
1669             s << (  newInt16        & 0xFF ) 
1670               << (( newInt16 >> 8 ) & 0xFF );
1671          }
1672          tokens.clear();
1673       }
1674       if ( vr == "UL" || vr == "SL")
1675       {
1676          uint32_t newInt32;
1677
1678          tokens.erase(tokens.begin(),tokens.end()); // clean any previous value
1679          Util::Tokenize (((ValEntry *)entry)->GetValue(), tokens, "\\");
1680          for (unsigned int i=0; i<tokens.size();i++) 
1681          {
1682             newInt32 = atoi(tokens[i].c_str());
1683             s << (char)(  newInt32         & 0xFF ) 
1684               << (char)(( newInt32 >>  8 ) & 0xFF )
1685               << (char)(( newInt32 >> 16 ) & 0xFF )
1686               << (char)(( newInt32 >> 24 ) & 0xFF );
1687          }
1688          tokens.clear();
1689       }
1690
1691 #ifdef GDCM_NO_ANSI_STRING_STREAM
1692       s << std::ends; // to avoid oddities on Solaris
1693 #endif //GDCM_NO_ANSI_STRING_STREAM
1694       return s.str();
1695    }
1696
1697    return ((ValEntry *)entry)->GetValue();
1698 }
1699
1700 /**
1701  * \brief   Skip a given Header Entry 
1702  * \warning NOT end user intended method !
1703  * @param   entry entry to skip
1704  */
1705 void Document::SkipDocEntry(DocEntry *entry) 
1706 {
1707    SkipBytes(entry->GetLength());
1708 }
1709
1710 /**
1711  * \brief   Skips to the beginning of the next Header Entry 
1712  * \warning NOT end user intended method !
1713  * @param   currentDocEntry entry to skip
1714  */
1715 void Document::SkipToNextDocEntry(DocEntry *currentDocEntry) 
1716 {
1717    Fp->seekg((long)(currentDocEntry->GetOffset()),     std::ios::beg);
1718    if (currentDocEntry->GetGroup() != 0xfffe)  // for fffe pb
1719       Fp->seekg( (long)(currentDocEntry->GetReadLength()),std::ios::cur);
1720 }
1721
1722 /**
1723  * \brief   When the length of an element value is obviously wrong (because
1724  *          the parser went Jabberwocky) one can hope improving things by
1725  *          applying some heuristics.
1726  * @param   entry entry to check
1727  * @param   foundLength first assumption about length    
1728  */
1729 void Document::FixDocEntryFoundLength(DocEntry *entry,
1730                                       uint32_t foundLength)
1731 {
1732    entry->SetReadLength( foundLength ); // will be updated only if a bug is found        
1733    if ( foundLength == 0xffffffff)
1734    {
1735       foundLength = 0;
1736    }
1737    
1738    uint16_t gr   = entry->GetGroup();
1739    uint16_t elem = entry->GetElement(); 
1740      
1741    if ( foundLength % 2)
1742    {
1743       gdcmWarningMacro( "Warning : Tag with uneven length " << foundLength 
1744         <<  " in x(" << std::hex << gr << "," << elem <<")");
1745    }
1746       
1747    //////// Fix for some naughty General Electric images.
1748    // Allthough not recent many such GE corrupted images are still present
1749    // on Creatis hard disks. Hence this fix shall remain when such images
1750    // are no longer in use (we are talking a few years, here)...
1751    // Note: XMedCon probably uses such a trick since it is able to read
1752    //       those pesky GE images ...
1753    if ( foundLength == 13)
1754    {
1755       // Only happens for this length !
1756       if ( gr != 0x0008 || ( elem != 0x0070 && elem != 0x0080 ) )
1757       {
1758          foundLength = 10;
1759          entry->SetReadLength(10); // a bug is to be fixed !?
1760       }
1761    }
1762
1763    //////// Fix for some brain-dead 'Leonardo' Siemens images.
1764    // Occurence of such images is quite low (unless one leaves close to a
1765    // 'Leonardo' source. Hence, one might consider commenting out the
1766    // following fix on efficiency reasons.
1767    else if ( gr   == 0x0009 && ( elem == 0x1113 || elem == 0x1114 ) )
1768    {
1769       foundLength = 4;
1770       entry->SetReadLength(4); // a bug is to be fixed !?
1771    } 
1772  
1773    else if ( entry->GetVR() == "SQ" )
1774    {
1775       foundLength = 0;      // ReadLength is unchanged 
1776    } 
1777     
1778    //////// We encountered a 'delimiter' element i.e. a tag of the form 
1779    // "fffe|xxxx" which is just a marker. Delimiters length should not be
1780    // taken into account.
1781    else if ( gr == 0xfffe )
1782    {    
1783      // According to the norm, fffe|0000 shouldn't exist. BUT the Philips
1784      // image gdcmData/gdcm-MR-PHILIPS-16-Multi-Seq.dcm happens to
1785      // causes extra troubles...
1786      if ( entry->GetElement() != 0x0000 )
1787      {
1788         foundLength = 0;
1789      }
1790    }            
1791    entry->SetLength(foundLength);
1792 }
1793
1794 /**
1795  * \brief   Apply some heuristics to predict whether the considered 
1796  *          element value contains/represents an integer or not.
1797  * @param   entry The element value on which to apply the predicate.
1798  * @return  The result of the heuristical predicate.
1799  */
1800 bool Document::IsDocEntryAnInteger(DocEntry *entry)
1801 {
1802    uint16_t elem         = entry->GetElement();
1803    uint16_t group        = entry->GetGroup();
1804    const std::string &vr = entry->GetVR();
1805    uint32_t length       = entry->GetLength();
1806
1807    // When we have some semantics on the element we just read, and if we
1808    // a priori know we are dealing with an integer, then we shall be
1809    // able to swap it's element value properly.
1810    if ( elem == 0 )  // This is the group length of the group
1811    {  
1812       if ( length == 4 )
1813       {
1814          return true;
1815       }
1816       else 
1817       {
1818          // Allthough this should never happen, still some images have a
1819          // corrupted group length [e.g. have a glance at offset x(8336) of
1820          // gdcmData/gdcm-MR-PHILIPS-16-Multi-Seq.dcm].
1821          // Since for dicom compliant and well behaved headers, the present
1822          // test is useless (and might even look a bit paranoid), when we
1823          // encounter such an ill-formed image, we simply display a warning
1824          // message and proceed on parsing (while crossing fingers).
1825          long filePosition = Fp->tellg();
1826          gdcmWarningMacro( "Erroneous Group Length element length  on : (" 
1827            << std::hex << group << " , " << elem
1828            << ") -before- position x(" << filePosition << ")"
1829            << "lgt : " << length );
1830       }
1831    }
1832
1833    if ( vr == "UL" || vr == "US" || vr == "SL" || vr == "SS" )
1834    {
1835       return true;
1836    }   
1837    return false;
1838 }
1839
1840 /**
1841  * \brief   Discover what the swap code is (among little endian, big endian,
1842  *          bad little endian, bad big endian).
1843  *          sw is set
1844  * @return false when we are absolutely sure 
1845  *               it's neither ACR-NEMA nor DICOM
1846  *         true  when we hope ours assuptions are OK
1847  */
1848 bool Document::CheckSwap()
1849 {   
1850    uint32_t  s32;
1851    uint16_t  s16;
1852        
1853    char deb[256];
1854     
1855    // First, compare HostByteOrder and NetworkByteOrder in order to
1856    // determine if we shall need to swap bytes (i.e. the Endian type).
1857    bool net2host = Util::IsCurrentProcessorBigEndian();
1858          
1859    // The easiest case is the one of a 'true' DICOM header, we just have
1860    // to look for the string "DICM" inside the file preamble.
1861    Fp->read(deb, 256);
1862    
1863    char *entCur = deb + 128;
1864    if ( memcmp(entCur, "DICM", (size_t)4) == 0 )
1865    {
1866       gdcmWarningMacro( "Looks like DICOM Version3 (preamble + DCM)" );
1867       
1868       // Group 0002 should always be VR, and the first element 0000
1869       // Let's be carefull (so many wrong headers ...)
1870       // and determine the value representation (VR) : 
1871       // Let's skip to the first element (0002,0000) and check there if we find
1872       // "UL"  - or "OB" if the 1st one is (0002,0001) -,
1873       // in which case we (almost) know it is explicit VR.
1874       // WARNING: if it happens to be implicit VR then what we will read
1875       // is the length of the group. If this ascii representation of this
1876       // length happens to be "UL" then we shall believe it is explicit VR.
1877       // We need to skip :
1878       // * the 128 bytes of File Preamble (often padded with zeroes),
1879       // * the 4 bytes of "DICM" string,
1880       // * the 4 bytes of the first tag (0002, 0000),or (0002, 0001)
1881       // i.e. a total of  136 bytes.
1882       entCur = deb + 136;
1883      
1884       // group 0x0002 *is always* Explicit VR Sometimes ,
1885       // even if elem 0002,0010 (Transfer Syntax) tells us the file is
1886       // *Implicit* VR  (see former 'gdcmData/icone.dcm')
1887       
1888       if ( memcmp(entCur, "UL", (size_t)2) == 0 ||
1889            memcmp(entCur, "OB", (size_t)2) == 0 ||
1890            memcmp(entCur, "UI", (size_t)2) == 0 ||
1891            memcmp(entCur, "CS", (size_t)2) == 0 )  // CS, to remove later
1892                                                    // when Write DCM *adds*
1893       // FIXME
1894       // Use Document::dicom_vr to test all the possibilities
1895       // instead of just checking for UL, OB and UI !? group 0000 
1896       {
1897          Filetype = ExplicitVR;
1898          gdcmWarningMacro( "Group 0002 : Explicit Value Representation");
1899       } 
1900       else 
1901       {
1902          Filetype = ImplicitVR;
1903          gdcmWarningMacro( "Group 0002 :Not an explicit Value Representation;"
1904                         << "Looks like a bugged Header!");
1905       }
1906       
1907       if ( net2host )
1908       {
1909          SwapCode = 4321;
1910          gdcmWarningMacro( "HostByteOrder != NetworkByteOrder");
1911       }
1912       else 
1913       {
1914          SwapCode = 1234;
1915          gdcmWarningMacro( "HostByteOrder = NetworkByteOrder");
1916       }
1917       
1918       // Position the file position indicator at first tag 
1919       // (i.e. after the file preamble and the "DICM" string).
1920
1921       Fp->seekg(0, std::ios::beg); // FIXME : Is it usefull?
1922
1923       Fp->seekg ( 132L, std::ios::beg);
1924       return true;
1925    } // ------------------------------- End of DicomV3 ----------------
1926
1927    // Alas, this is not a DicomV3 file and whatever happens there is no file
1928    // preamble. We can reset the file position indicator to where the data
1929    // is (i.e. the beginning of the file).
1930
1931    gdcmWarningMacro( "Not a Kosher DICOM Version3 file (no preamble)");
1932
1933    Fp->seekg(0, std::ios::beg);
1934
1935    // Let's check 'No Preamble Dicom File' :
1936    // Should start with group 0x0002
1937    // and be Explicit Value Representation
1938
1939    s16 = *((uint16_t *)(deb));
1940    SwapCode = 0;     
1941    switch ( s16 )
1942    {
1943       case 0x0002 :
1944          SwapCode = 1234;
1945          entCur = deb + 4;
1946          break;
1947       case 0x0200 :
1948          SwapCode = 4321;
1949          entCur = deb + 6;
1950     } 
1951
1952    if ( SwapCode != 0 )
1953    {
1954       if ( memcmp(entCur, "UL", (size_t)2) == 0 ||
1955            memcmp(entCur, "OB", (size_t)2) == 0 ||
1956            memcmp(entCur, "UI", (size_t)2) == 0 ||
1957            memcmp(entCur, "SH", (size_t)2) == 0 ||
1958            memcmp(entCur, "AE", (size_t)2) == 0 ||
1959            memcmp(entCur, "OB", (size_t)2) == 0 )
1960          {
1961             Filetype = ExplicitVR;
1962             gdcmWarningMacro( "Group 0002 : Explicit Value Representation");
1963             return true;
1964           }
1965     }
1966 // ------------------------------- End of 'No Preamble' DicomV3 -------------
1967
1968    // Our next best chance would be to be considering a 'clean' ACR/NEMA file.
1969    // By clean we mean that the length of the first group is written down.
1970    // If this is the case and since the length of the first group HAS to be
1971    // four (bytes), then determining the proper swap code is straightforward.
1972
1973    entCur = deb + 4;
1974    // We assume the array of char we are considering contains the binary
1975    // representation of a 32 bits integer. Hence the following dirty
1976    // trick :
1977    s32 = *((uint32_t *)(entCur));
1978    switch( s32 )
1979    {
1980       case 0x00040000 :
1981          SwapCode = 3412;
1982          Filetype = ACR;
1983          return true;
1984       case 0x04000000 :
1985          SwapCode = 4321;
1986          Filetype = ACR;
1987          return true;
1988       case 0x00000400 :
1989          SwapCode = 2143;
1990          Filetype = ACR;
1991          return true;
1992       case 0x00000004 :
1993          SwapCode = 1234;
1994          Filetype = ACR;
1995          return true;
1996       default :
1997          // We are out of luck. It is not a DicomV3 nor a 'clean' ACR/NEMA file.
1998          // It is time for despaired wild guesses. 
1999          // So, let's check if this file wouldn't happen to be 'dirty' ACR/NEMA,
2000          //  i.e. the 'group length' element is not present :     
2001          
2002          //  check the supposed-to-be 'group number'
2003          //  in ( 0x0001 .. 0x0008 )
2004          //  to determine ' SwapCode' value .
2005          //  Only 0 or 4321 will be possible 
2006          //  (no oportunity to check for the formerly well known
2007          //  ACR-NEMA 'Bad Big Endian' or 'Bad Little Endian' 
2008          //  if unsuccessfull (i.e. neither 0x0002 nor 0x0200 etc -3, 4, ..., 8-) 
2009          //  the file IS NOT ACR-NEMA nor DICOM V3
2010          //  Find a trick to tell it the caller...
2011       
2012          s16 = *((uint16_t *)(deb));
2013       
2014          switch ( s16 )
2015          {
2016             case 0x0001 :
2017             case 0x0002 :
2018             case 0x0003 :
2019             case 0x0004 :
2020             case 0x0005 :
2021             case 0x0006 :
2022             case 0x0007 :
2023             case 0x0008 :
2024                SwapCode = 1234;
2025                Filetype = ACR;
2026                return true;
2027             case 0x0100 :
2028             case 0x0200 :
2029             case 0x0300 :
2030             case 0x0400 :
2031             case 0x0500 :
2032             case 0x0600 :
2033             case 0x0700 :
2034             case 0x0800 :
2035                SwapCode = 4321;
2036                Filetype = ACR;
2037                return true;
2038             default :
2039                gdcmWarningMacro( "ACR/NEMA unfound swap info (Really hopeless !)");
2040                Filetype = Unknown;
2041                return false;
2042          }
2043    }
2044 }
2045
2046 /**
2047  * \brief Change the Byte Swap code. 
2048  */
2049 void Document::SwitchByteSwapCode() 
2050 {
2051    gdcmWarningMacro( "Switching Byte Swap code from "<< SwapCode
2052                      << " at :" <<std::hex << Fp->tellg() );
2053    if ( SwapCode == 1234 ) 
2054    {
2055       SwapCode = 4321;
2056    }
2057    else if ( SwapCode == 4321 ) 
2058    {
2059       SwapCode = 1234;
2060    }
2061    else if ( SwapCode == 3412 ) 
2062    {
2063       SwapCode = 2143;
2064    }
2065    else if ( SwapCode == 2143 )
2066    {
2067       SwapCode = 3412;
2068    }
2069 }
2070
2071 /**
2072  * \brief  during parsing, Header Elements too long are not loaded in memory 
2073  * @param newSize new size
2074  */
2075 void Document::SetMaxSizeLoadEntry(long newSize) 
2076 {
2077    if ( newSize < 0 )
2078    {
2079       return;
2080    }
2081    if ((uint32_t)newSize >= (uint32_t)0xffffffff )
2082    {
2083       MaxSizeLoadEntry = 0xffffffff;
2084       return;
2085    }
2086    MaxSizeLoadEntry = newSize;
2087 }
2088
2089 /**
2090  * \brief   Read the next tag WITHOUT loading it's value
2091  *          (read the 'Group Number', the 'Element Number',
2092  *          gets the Dict Entry
2093  *          gets the VR, gets the length, gets the offset value)
2094  * @return  On succes : the newly created DocEntry, NULL on failure.      
2095  */
2096 DocEntry *Document::ReadNextDocEntry()
2097 {
2098    uint16_t group;
2099    uint16_t elem;
2100
2101    try
2102    {
2103       group = ReadInt16();
2104       elem  = ReadInt16();
2105    }
2106    catch ( FormatError e )
2107    {
2108       // We reached the EOF (or an error occured) therefore 
2109       // header parsing has to be considered as finished.
2110       return 0;
2111    }
2112
2113    // Sometimes file contains groups of tags with reversed endianess.
2114    HandleBrokenEndian(group, elem);
2115
2116    // In 'true DICOM' files Group 0002 is always little endian
2117    if ( HasDCMPreamble )
2118       HandleOutOfGroup0002(group, elem);
2119  
2120    std::string vr = FindDocEntryVR();
2121    std::string realVR = vr;
2122
2123    if ( vr == GDCM_UNKNOWN )
2124    {
2125       if ( elem == 0x0000 ) // Group Length
2126          realVR = "UL";     // must be UL
2127       else
2128       {
2129          DictEntry *dictEntry = GetDictEntry(group,elem);
2130          if ( dictEntry )
2131             realVR = dictEntry->GetVR();
2132       }
2133    }
2134
2135    DocEntry *newEntry;
2136    if ( Global::GetVR()->IsVROfSequence(realVR) )
2137       newEntry = NewSeqEntry(group, elem);
2138    else if ( Global::GetVR()->IsVROfStringRepresentable(realVR) )
2139       newEntry = NewValEntry(group, elem,vr);
2140    else
2141       newEntry = NewBinEntry(group, elem,vr);
2142
2143    if ( vr == GDCM_UNKNOWN )
2144    {
2145       if ( Filetype == ExplicitVR )
2146       {
2147          // We thought this was explicit VR, but we end up with an
2148          // implicit VR tag. Let's backtrack.
2149          if ( newEntry->GetGroup() != 0xfffe )
2150          { 
2151             std::string msg;
2152             int offset = Fp->tellg();
2153             msg = Util::Format("Entry (%04x,%04x) at 0x(%x) should be Explicit VR\n", 
2154                           newEntry->GetGroup(), newEntry->GetElement(), offset );
2155             gdcmWarningMacro( msg.c_str() );
2156           }
2157       }
2158       newEntry->SetImplicitVR();
2159    }
2160
2161    try
2162    {
2163       FindDocEntryLength(newEntry);
2164    }
2165    catch ( FormatError e )
2166    {
2167       // Call it quits
2168       delete newEntry;
2169       return 0;
2170    }
2171
2172    newEntry->SetOffset(Fp->tellg());  
2173
2174    return newEntry;
2175 }
2176
2177 /**
2178  * \brief   Handle broken private tag from Philips NTSCAN
2179  *          where the endianess is being switched to BigEndian 
2180  *          for no apparent reason
2181  * @return  no return
2182  */
2183 void Document::HandleBrokenEndian(uint16_t &group, uint16_t &elem)
2184 {
2185    // Endian reversion. Some files contain groups of tags with reversed endianess.
2186    static int reversedEndian = 0;
2187    // try to fix endian switching in the middle of headers
2188    if ((group == 0xfeff) && (elem == 0x00e0))
2189    {
2190      // start endian swap mark for group found
2191      reversedEndian++;
2192      SwitchByteSwapCode();
2193      // fix the tag
2194      group = 0xfffe;
2195      elem  = 0xe000;
2196    } 
2197    else if (group == 0xfffe && elem == 0xe00d && reversedEndian) 
2198    {
2199      // end of reversed endian group
2200      reversedEndian--;
2201      SwitchByteSwapCode();
2202    }
2203 }
2204
2205 /**
2206  * \brief   Group 0002 is always coded Little Endian
2207  *          whatever Transfer Syntax is
2208  * @return  no return
2209  */
2210 void Document::HandleOutOfGroup0002(uint16_t &group, uint16_t &elem)
2211 {
2212    // Endian reversion. Some files contain groups of tags with reversed endianess.
2213    if ( !Group0002Parsed && group != 0x0002)
2214    {
2215       Group0002Parsed = true;
2216       // we just came out of group 0002
2217       // if Transfer syntax is Big Endian we have to change CheckSwap
2218
2219       std::string ts = GetTransferSyntax();
2220       if ( !Global::GetTS()->IsTransferSyntax(ts) )
2221       {
2222          gdcmWarningMacro("True DICOM File, with NO Tansfer Syntax: " << ts );
2223          return;
2224       }
2225
2226       // Group 0002 is always 'Explicit ...' enven when Transfer Syntax says 'Implicit ..." 
2227
2228       if ( Global::GetTS()->GetSpecialTransferSyntax(ts) == TS::ImplicitVRLittleEndian )
2229          {
2230             Filetype = ImplicitVR;
2231          }
2232        
2233       // FIXME Strangely, this works with 
2234       //'Implicit VR Transfer Syntax (GE Private)
2235       if ( Global::GetTS()->GetSpecialTransferSyntax(ts) == TS::ExplicitVRBigEndian )
2236       {
2237          gdcmWarningMacro("Transfer Syntax Name = [" 
2238                         << GetTransferSyntaxName() << "]" );
2239          SwitchByteSwapCode();
2240          group = SwapShort(group);
2241          elem  = SwapShort(elem);
2242       }
2243    }
2244 }
2245
2246 //-----------------------------------------------------------------------------
2247 // Print
2248
2249 //-----------------------------------------------------------------------------
2250 } // end namespace gdcm