]> Creatis software - gdcm.git/blob - src/gdcmDocument.cxx
4511aab548db6c6a17ba7bf003d49fbf75804b8c
[gdcm.git] / src / gdcmDocument.cxx
1 /*=========================================================================
2                                                                                 
3   Program:   gdcm
4   Module:    $RCSfile: gdcmDocument.cxx,v $
5   Language:  C++
6   Date:      $Date: 2005/08/23 14:41:59 $
7   Version:   $Revision: 1.266 $
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       // Uncoment this printf line to be able to 'follow' the DocEntries
925       // when something *very* strange happens
926
927       //printf( "%04x|%04x %s\n",newDocEntry->GetGroup(), 
928       //                     newDocEntry->GetElement(),
929       //                     newDocEntry->GetVR().c_str() );
930       used = true;
931       newValEntry = dynamic_cast<ValEntry*>(newDocEntry);
932       newBinEntry = dynamic_cast<BinEntry*>(newDocEntry);
933
934       if ( newValEntry || newBinEntry )  
935       {
936        //////////////////////////// ContentEntry
937          if ( newBinEntry )
938          {
939             vr = newDocEntry->GetVR();
940             if ( Filetype == ExplicitVR && 
941                  !Global::GetVR()->IsVROfBinaryRepresentable(vr) )
942             { 
943                 ////// Neither ValEntry NOR BinEntry: should mean UNKOWN VR
944                 gdcmWarningMacro( std::hex << newDocEntry->GetGroup() 
945                                   << "|" << newDocEntry->GetElement()
946                                   << " : Neither Valentry, nor BinEntry." 
947                                   "Probably unknown VR.");
948             }
949
950          //////////////////// BinEntry or UNKOWN VR:
951
952             // When "this" is a Document the Key is simply of the
953             // form ( group, elem )...
954             if ( dynamic_cast< Document* > ( set ) )
955             {
956                newBinEntry->SetKey( newBinEntry->GetKey() );
957             }
958             // but when "this" is a SQItem, we are inserting this new
959             // valEntry in a sequence item, and the key has the
960             // generalized form (refer to \ref BaseTagKey):
961
962             // time waste hunting
963             //if (SQItem *parentSQItem = dynamic_cast< SQItem* > ( set ) )
964             //{
965             //   newBinEntry->SetKey(  parentSQItem->GetBaseTagKey()
966             //                       + newBinEntry->GetKey() );
967             //}
968            
969             if ( !set->AddEntry( newBinEntry ) )
970             {
971                gdcmWarningMacro( "in ParseDES : cannot add a BinEntry "
972                                    << newBinEntry->GetKey()  
973                                    << " (at offset : " 
974                                    << newBinEntry->GetOffset() << " )" );
975                used=false;
976             }
977             else
978             {
979                // Load only if we can add (not a duplicate key)
980                LoadDocEntry( newBinEntry );
981             }
982          }  // end BinEntry
983          else
984          {
985          /////////////////////// ValEntry
986
987             // When "set" is a Document, then we are at the top of the
988             // hierarchy and the Key is simply of the form ( group, elem )...
989             if ( dynamic_cast< Document* > ( set ) )
990             {
991                newValEntry->SetKey( newValEntry->GetKey() );
992             }
993             // ...but when "set" is a SQItem, we are inserting this new
994             // valEntry in a sequence item. Hence the key has the
995             // generalized form (refer to \ref BaseTagKey):
996
997             // time waste hunting
998             //if (SQItem *parentSQItem = dynamic_cast< SQItem* > ( set ) )
999             //{
1000             //   newValEntry->SetKey(  parentSQItem->GetBaseTagKey()
1001             //                      + newValEntry->GetKey() );
1002             //}
1003
1004             if ( !set->AddEntry( newValEntry ) )
1005             {
1006               gdcmWarningMacro( "in ParseDES : cannot add a ValEntry "
1007                                   << newValEntry->GetKey()
1008                                   << " (at offset : " 
1009                                   << newValEntry->GetOffset() << " )" );   
1010               used=false;
1011             }
1012             else
1013             {
1014                // Load only if we can add (not a duplicate key)
1015                LoadDocEntry( newValEntry );
1016             }
1017
1018             if ( newValEntry->GetElement() == 0x0000 ) // if on group length
1019             {
1020                if ( newValEntry->GetGroup()%2 != 0 )   // if Shadow Group
1021                {
1022                   if ( LoadMode & NO_SHADOW ) // if user asked to skip shad.gr
1023                   {
1024                      std::string strLgrGroup = newValEntry->GetValue();
1025                      int lgrGroup;
1026                      if ( strLgrGroup != GDCM_UNFOUND)
1027                      {
1028                         lgrGroup = atoi(strLgrGroup.c_str());
1029                         Fp->seekg(lgrGroup, std::ios::cur);
1030                         used = false;
1031                         RemoveEntry( newDocEntry );
1032                         newDocEntry = 0;
1033                         continue;
1034                      }
1035                   }
1036                }
1037              }
1038
1039             bool delimitor=newValEntry->IsItemDelimitor();
1040
1041             // FIXME : Brutal patch, waiting till we find a clever way to guess
1042             //         if a doc entry is a Sequence, 
1043             //          - when it's odd number
1044             //          - and the file is Implicit VR Transfert Syntax
1045             //
1046             // '&& offset!=132' is a very fierce way to guess
1047             //          if we are at zero level (Probabely not enough ...).
1048             //          We want to go on parsing.
1049             if ( (delimitor && offset!=132) || 
1050                 (!delim_mode && ((long)(Fp->tellg())-offset) >= l_max) )
1051             {
1052                if (delimitor && offset!=132)
1053                {
1054                   gdcmWarningMacro( "in ParseDES : Item found out of a Sequence "
1055                                   << newValEntry->GetKey()
1056                                   << " (at offset : " 
1057                                   << newValEntry->GetOffset() << " )" );
1058                }
1059                if ( !used )
1060                   delete newDocEntry;
1061                break;
1062             }
1063          }
1064
1065          // Just to make sure we are at the beginning of next entry.
1066          SkipToNextDocEntry(newDocEntry);
1067       }
1068       else
1069       {
1070          /////////////////////// SeqEntry :  VR = "SQ"
1071
1072          unsigned long l = newDocEntry->GetReadLength();          
1073          if ( l != 0 ) // don't mess the delim_mode for 'zero-length sequence'
1074          {
1075             if ( l == 0xffffffff )
1076             {
1077               delim_mode_intern = true;
1078             }
1079             else
1080             {
1081               delim_mode_intern = false;
1082             }
1083          }
1084
1085          if ( (LoadMode & NO_SHADOWSEQ) && ! delim_mode_intern )
1086          { 
1087            // User asked to skip SeQuences *only* if they belong to Shadow Group
1088             if ( newDocEntry->GetGroup()%2 != 0 )
1089             {
1090                 Fp->seekg( l, std::ios::cur);
1091                 used = false;
1092                 continue;  
1093             } 
1094          } 
1095          if ( (LoadMode & NO_SEQ) && ! delim_mode_intern ) 
1096          {
1097            // User asked to skip *any* SeQuence
1098             Fp->seekg( l, std::ios::cur);
1099             used = false;
1100             continue;
1101          }
1102          // delay the dynamic cast as late as possible
1103          newSeqEntry = dynamic_cast<SeqEntry*>(newDocEntry);
1104          
1105          // no other way to create the Delimitor ...
1106          newSeqEntry->SetDelimitorMode( delim_mode_intern );
1107
1108          // At the top of the hierarchy, stands a Document. When "set"
1109          // is a Document, then we are building the first depth level.
1110          // Hence the SeqEntry we are building simply has a depth
1111          // level of one:
1112          if ( dynamic_cast< Document* > ( set ) )
1113          {
1114             newSeqEntry->SetDepthLevel( 1 );
1115             newSeqEntry->SetKey( newSeqEntry->GetKey() );
1116          }
1117          // But when "set" is already a SQItem, we are building a nested
1118          // sequence, and hence the depth level of the new SeqEntry
1119          // we are building, is one level deeper:
1120
1121          // time waste hunting
1122          if (SQItem *parentSQItem = dynamic_cast< SQItem* > ( set ) )
1123          {
1124             newSeqEntry->SetDepthLevel( parentSQItem->GetDepthLevel() + 1 );
1125
1126           //  newSeqEntry->SetKey(  parentSQItem->GetBaseTagKey()
1127           //                      + newSeqEntry->GetKey() );
1128          }
1129
1130          if ( l != 0 )
1131          {  // Don't try to parse zero-length sequences
1132             ParseSQ( newSeqEntry, 
1133                      newDocEntry->GetOffset(),
1134                      l, delim_mode_intern);
1135          }
1136          if ( !set->AddEntry( newSeqEntry ) )
1137          {
1138             gdcmWarningMacro( "in ParseDES : cannot add a SeqEntry "
1139                                 << newSeqEntry->GetKey()
1140                                 << " (at offset : " 
1141                                 << newSeqEntry->GetOffset() << " )" ); 
1142             used = false;
1143          }
1144  
1145          if ( !delim_mode && ((long)(Fp->tellg())-offset) >= l_max)
1146          {
1147             if ( !used )
1148                delete newDocEntry;  
1149                break;
1150          }
1151       }  // end SeqEntry : VR = "SQ"
1152
1153       if ( !used )
1154       {
1155          delete newDocEntry;
1156       }
1157    }                               // end While
1158 }
1159
1160 /**
1161  * \brief   Parses a Sequence ( SeqEntry after SeqEntry)
1162  * @return  parsed length for this level
1163  */ 
1164 void Document::ParseSQ( SeqEntry *seqEntry,
1165                         long offset, long l_max, bool delim_mode)
1166 {
1167    int SQItemNumber = 0;
1168    bool dlm_mod;
1169    long offsetStartCurrentSQItem = offset;
1170
1171    while (true)
1172    {
1173       // the first time, we read the fff0,e000 of the first SQItem
1174       DocEntry *newDocEntry = ReadNextDocEntry();
1175
1176       if ( !newDocEntry )
1177       {
1178          // FIXME Should warn user
1179          gdcmWarningMacro("in ParseSQ : should never get here!");
1180          break;
1181       }
1182       if ( delim_mode )
1183       {
1184          if ( newDocEntry->IsSequenceDelimitor() )
1185          {
1186             seqEntry->SetDelimitationItem( newDocEntry ); 
1187             break;
1188          }
1189       }
1190       if ( !delim_mode && ((long)(Fp->tellg())-offset) >= l_max)
1191       {
1192          delete newDocEntry;
1193          break;
1194       }
1195       // create the current SQItem
1196       SQItem *itemSQ = new SQItem( seqEntry->GetDepthLevel() );
1197 /*
1198       std::ostringstream newBase;
1199       newBase << seqEntry->GetKey()
1200               << "/"
1201               << SQItemNumber
1202               << "#";
1203       itemSQ->SetBaseTagKey( newBase.str() );
1204 */
1205       unsigned int l = newDocEntry->GetReadLength();
1206       
1207       if ( l == 0xffffffff )
1208       {
1209          dlm_mod = true;
1210       }
1211       else
1212       {
1213          dlm_mod = false;
1214       }
1215
1216       // Let's try :------------
1217       // remove fff0,e000, created out of the SQItem
1218       delete newDocEntry;
1219       Fp->seekg(offsetStartCurrentSQItem, std::ios::beg);
1220       // fill up the current SQItem, starting at the beginning of fff0,e000
1221
1222       ParseDES(itemSQ, offsetStartCurrentSQItem, l+8, dlm_mod);
1223
1224       offsetStartCurrentSQItem = Fp->tellg();
1225       // end try -----------------
1226  
1227       seqEntry->AddSQItem( itemSQ, SQItemNumber ); 
1228       SQItemNumber++;
1229       if ( !delim_mode && ((long)(Fp->tellg())-offset ) >= l_max )
1230       {
1231          break;
1232       }
1233    }
1234 }
1235
1236 /**
1237  * \brief   Loads the element content if its length doesn't exceed
1238  *          the value specified with Document::SetMaxSizeLoadEntry()
1239  * @param   entry Header Entry (Dicom Element) to be dealt with
1240  */
1241 void Document::LoadDocEntry(DocEntry *entry)
1242 {
1243    uint16_t group  = entry->GetGroup();
1244    std::string  vr = entry->GetVR();
1245    uint32_t length = entry->GetLength();
1246
1247    Fp->seekg((long)entry->GetOffset(), std::ios::beg);
1248
1249    // A SeQuence "contains" a set of Elements.  
1250    //          (fffe e000) tells us an Element is beginning
1251    //          (fffe e00d) tells us an Element just ended
1252    //          (fffe e0dd) tells us the current SeQuence just ended
1253    if ( group == 0xfffe )
1254    {
1255       // NO more value field for SQ !
1256       return;
1257    }
1258
1259    // When the length is zero things are easy:
1260    if ( length == 0 )
1261    {
1262       ((ValEntry *)entry)->SetValue("");
1263       return;
1264    }
1265
1266    // The elements whose length is bigger than the specified upper bound
1267    // are not loaded. Instead we leave a short notice on the offset of
1268    // the element content and it's length.
1269
1270    std::ostringstream s;
1271    if (length > MaxSizeLoadEntry)
1272    {
1273       if (BinEntry *binEntryPtr = dynamic_cast< BinEntry* >(entry) )
1274       {  
1275          s << GDCM_NOTLOADED;
1276          s << " Ad.:" << (long)entry->GetOffset();
1277          s << " x(" << std::hex << entry->GetOffset() << ")";
1278          s << std::dec;
1279          s << " Lgt:"  << entry->GetLength();
1280          s << " x(" << std::hex << entry->GetLength() << ")";
1281          binEntryPtr->SetValue(s.str());
1282       }
1283       else if (ValEntry *valEntryPtr = dynamic_cast< ValEntry* >(entry) )
1284       {
1285          s << GDCM_NOTLOADED;  
1286          s << " Address:" << (long)entry->GetOffset();
1287          s << " Length:"  << entry->GetLength();
1288          s << " x(" << std::hex << entry->GetLength() << ")";
1289          valEntryPtr->SetValue(s.str());
1290       }
1291       else
1292       {
1293          // fusible
1294          gdcmErrorMacro( "MaxSizeLoadEntry exceeded, neither a BinEntry "
1295                       << "nor a ValEntry ?! Should never print that !" );
1296       }
1297
1298       // to be sure we are at the end of the value ...
1299       Fp->seekg((long)entry->GetOffset()+(long)entry->GetLength(),
1300                 std::ios::beg);
1301       return;
1302    }
1303
1304    // When we find a BinEntry not very much can be done :
1305    if (BinEntry *binEntryPtr = dynamic_cast< BinEntry* >(entry) )
1306    {
1307       s << GDCM_BINLOADED;
1308       binEntryPtr->SetValue(s.str());
1309       LoadEntryBinArea(binEntryPtr); // last one, not to erase length !
1310       return;
1311    }
1312
1313    if ( IsDocEntryAnInteger(entry) )
1314    {   
1315       uint32_t NewInt;
1316       int nbInt;
1317       // When short integer(s) are expected, read and convert the following 
1318       // (n * 2) characters properly i.e. consider them as short integers as
1319       // opposed to strings.
1320       // Elements with Value Multiplicity > 1
1321       // contain a set of integers (not a single one)       
1322       if (vr == "US" || vr == "SS")
1323       {
1324          nbInt = length / 2;
1325          NewInt = ReadInt16();
1326          s << NewInt;
1327          if (nbInt > 1)
1328          {
1329             for (int i=1; i < nbInt; i++)
1330             {
1331                s << '\\';
1332                NewInt = ReadInt16();
1333                s << NewInt;
1334             }
1335          }
1336       }
1337       // See above comment on multiple integers (mutatis mutandis).
1338       else if (vr == "UL" || vr == "SL")
1339       {
1340          nbInt = length / 4;
1341          NewInt = ReadInt32();
1342          s << NewInt;
1343          if (nbInt > 1)
1344          {
1345             for (int i=1; i < nbInt; i++)
1346             {
1347                s << '\\';
1348                NewInt = ReadInt32();
1349                s << NewInt;
1350             }
1351          }
1352       }
1353 #ifdef GDCM_NO_ANSI_STRING_STREAM
1354       s << std::ends; // to avoid oddities on Solaris
1355 #endif //GDCM_NO_ANSI_STRING_STREAM
1356
1357       ((ValEntry *)entry)->SetValue(s.str());
1358       return;
1359    }
1360    
1361   // FIXME: We need an additional byte for storing \0 that is not on disk
1362    char *str = new char[length+1];
1363    Fp->read(str, (size_t)length);
1364    str[length] = '\0'; //this is only useful when length is odd
1365    // Special DicomString call to properly handle \0 and even length
1366    std::string newValue;
1367    if ( length % 2 )
1368    {
1369       newValue = Util::DicomString(str, length+1);
1370       gdcmWarningMacro("Warning: bad length: " << length <<
1371                        " For string :" <<  newValue.c_str()); 
1372       // Since we change the length of string update it length
1373       //entry->SetReadLength(length+1);
1374    }
1375    else
1376    {
1377       newValue = Util::DicomString(str, length);
1378    }
1379    delete[] str;
1380
1381    if ( ValEntry *valEntry = dynamic_cast<ValEntry* >(entry) )
1382    {
1383       if ( Fp->fail() || Fp->eof())
1384       {
1385          if ( Fp->fail() )
1386             gdcmWarningMacro("--> fail");
1387
1388          gdcmWarningMacro("Unread element value " << valEntry->GetKey() 
1389                           << " lgt : " << valEntry->GetReadLength() 
1390                           << " at " << std::hex << valEntry->GetOffset());
1391          valEntry->SetValue(GDCM_UNREAD);
1392          return;
1393       }
1394
1395       if ( vr == "UI" )
1396       {
1397          // Because of correspondance with the VR dic
1398          valEntry->SetValue(newValue);
1399       }
1400       else
1401       {
1402          valEntry->SetValue(newValue);
1403       }
1404    }
1405    else
1406    {
1407       gdcmWarningMacro("Should have a ValEntry, here ! " << valEntry->GetKey() 
1408                           << " lgt : " << valEntry->GetReadLength() 
1409                           << " at " << std::hex << valEntry->GetOffset());
1410    }
1411 }
1412
1413 /**
1414  * \brief  Find the value Length of the passed Header Entry
1415  * @param  entry Header Entry whose length of the value shall be loaded. 
1416  */
1417 void Document::FindDocEntryLength( DocEntry *entry )
1418    throw ( FormatError )
1419 {
1420    std::string  vr  = entry->GetVR();
1421    uint16_t length16;       
1422    
1423    if ( Filetype == ExplicitVR && !entry->IsImplicitVR() ) 
1424    {
1425       if ( vr == "OB" || vr == "OW" || vr == "SQ" || vr == "UT" || vr == "UN" ) 
1426       {
1427          // The following reserved two bytes (see PS 3.5-2003, section
1428          // "7.1.2 Data element structure with explicit vr", p 27) must be
1429          // skipped before proceeding on reading the length on 4 bytes.
1430          Fp->seekg( 2L, std::ios::cur);
1431          uint32_t length32 = ReadInt32();
1432
1433          if ( (vr == "OB" || vr == "OW") && length32 == 0xffffffff ) 
1434          {
1435             uint32_t lengthOB;
1436             try 
1437             {
1438                lengthOB = FindDocEntryLengthOBOrOW();
1439             }
1440             catch ( FormatUnexpected )
1441             {
1442                // Computing the length failed (this happens with broken
1443                // files like gdcm-JPEG-LossLess3a.dcm). We still have a
1444                // chance to get the pixels by deciding the element goes
1445                // until the end of the file. Hence we artificially fix the
1446                // the length and proceed.
1447                long currentPosition = Fp->tellg();
1448                Fp->seekg(0L,std::ios::end);
1449
1450                long lengthUntilEOF = (long)(Fp->tellg())-currentPosition;
1451                Fp->seekg(currentPosition, std::ios::beg);
1452
1453                entry->SetReadLength(lengthUntilEOF);
1454                entry->SetLength(lengthUntilEOF);
1455                return;
1456             }
1457             entry->SetReadLength(lengthOB);
1458             entry->SetLength(lengthOB);
1459             return;
1460          }
1461          FixDocEntryFoundLength(entry, length32); 
1462          return;
1463       }
1464
1465       // Length is encoded on 2 bytes.
1466       length16 = ReadInt16();
1467   
1468       // 0xffff means that we deal with 'No Length' Sequence 
1469       //        or 'No Length' SQItem
1470       if ( length16 == 0xffff) 
1471       {           
1472          length16 = 0;
1473       }
1474       FixDocEntryFoundLength( entry, (uint32_t)length16 );
1475       return;
1476    }
1477    else
1478    {
1479       // Either implicit VR or a non DICOM conformal (see note below) explicit
1480       // VR that ommited the VR of (at least) this element. Farts happen.
1481       // [Note: according to the part 5, PS 3.5-2001, section 7.1 p25
1482       // on Data elements "Implicit and Explicit VR Data Elements shall
1483       // not coexist in a Data Set and Data Sets nested within it".]
1484       // Length is on 4 bytes.
1485
1486      // Well ... group 0002 is always coded in 'Explicit VR Litle Endian'
1487      // even if Transfer Syntax is 'Implicit VR ...' 
1488       
1489       FixDocEntryFoundLength( entry, ReadInt32() );
1490       return;
1491    }
1492 }
1493
1494 /**
1495  * \brief  Find the Length till the next sequence delimiter
1496  * \warning NOT end user intended method !
1497  * @return 
1498  */
1499 uint32_t Document::FindDocEntryLengthOBOrOW()
1500    throw( FormatUnexpected )
1501 {
1502    // See PS 3.5-2001, section A.4 p. 49 on encapsulation of encoded pixel data.
1503    long positionOnEntry = Fp->tellg();
1504    bool foundSequenceDelimiter = false;
1505    uint32_t totalLength = 0;
1506
1507    while ( !foundSequenceDelimiter )
1508    {
1509       uint16_t group;
1510       uint16_t elem;
1511       try
1512       {
1513          group = ReadInt16();
1514          elem  = ReadInt16();   
1515       }
1516       catch ( FormatError )
1517       {
1518          throw FormatError("Unexpected end of file encountered during ",
1519                            "Document::FindDocEntryLengthOBOrOW()");
1520       }
1521       // We have to decount the group and element we just read
1522       totalLength += 4;     
1523       if ( group != 0xfffe || ( ( elem != 0xe0dd ) && ( elem != 0xe000 ) ) )
1524       {
1525          long filePosition = Fp->tellg();
1526          gdcmWarningMacro( 
1527               "Neither an Item tag nor a Sequence delimiter tag on :" 
1528            << std::hex << group << " , " << elem 
1529            << ") -before- position x(" << filePosition << ")" );
1530   
1531          Fp->seekg(positionOnEntry, std::ios::beg);
1532          throw FormatUnexpected( 
1533                "Neither an Item tag nor a Sequence delimiter tag.");
1534       }
1535       if ( elem == 0xe0dd )
1536       {
1537          foundSequenceDelimiter = true;
1538       }
1539       uint32_t itemLength = ReadInt32();
1540       // We add 4 bytes since we just read the ItemLength with ReadInt32
1541       totalLength += itemLength + 4;
1542       SkipBytes(itemLength);
1543       
1544       if ( foundSequenceDelimiter )
1545       {
1546          break;
1547       }
1548    }
1549    Fp->seekg( positionOnEntry, std::ios::beg);
1550    return totalLength;
1551 }
1552
1553 /**
1554  * \brief     Find the Value Representation of the current Dicom Element.
1555  * @return    Value Representation of the current Entry
1556  */
1557 std::string Document::FindDocEntryVR()
1558 {
1559    if ( Filetype != ExplicitVR )
1560       return GDCM_UNKNOWN;
1561
1562    long positionOnEntry = Fp->tellg();
1563    // Warning: we believe this is explicit VR (Value Representation) because
1564    // we used a heuristic that found "UL" in the first tag. Alas this
1565    // doesn't guarantee that all the tags will be in explicit VR. In some
1566    // cases (see e-film filtered files) one finds implicit VR tags mixed
1567    // within an explicit VR file. Hence we make sure the present tag
1568    // is in explicit VR and try to fix things if it happens not to be
1569    // the case.
1570
1571    char vr[3];
1572    Fp->read (vr, (size_t)2);
1573    vr[2] = 0;
1574
1575    if ( !CheckDocEntryVR(vr) )
1576    {
1577       Fp->seekg(positionOnEntry, std::ios::beg);
1578       return GDCM_UNKNOWN;
1579    }
1580    return vr;
1581 }
1582
1583 /**
1584  * \brief     Check the correspondance between the VR of the header entry
1585  *            and the taken VR. If they are different, the header entry is 
1586  *            updated with the new VR.
1587  * @param     vr    Dicom Value Representation
1588  * @return    false if the VR is incorrect of if the VR isn't referenced
1589  *            otherwise, it returns true
1590 */
1591 bool Document::CheckDocEntryVR(VRKey vr)
1592 {
1593    if ( !Global::GetVR()->IsValidVR(vr) )
1594       return false;
1595
1596    return true; 
1597 }
1598
1599 /**
1600  * \brief   Get the transformed value of the header entry. The VR value 
1601  *          is used to define the transformation to operate on the value
1602  * \warning NOT end user intended method !
1603  * @param   entry entry to tranform
1604  * @return  Transformed entry value
1605  */
1606 std::string Document::GetDocEntryValue(DocEntry *entry)
1607 {
1608    if ( IsDocEntryAnInteger(entry) && entry->IsImplicitVR() )
1609    {
1610       std::string val = ((ValEntry *)entry)->GetValue();
1611       std::string vr  = entry->GetVR();
1612       uint32_t length = entry->GetLength();
1613       std::ostringstream s;
1614       int nbInt;
1615
1616       // When short integer(s) are expected, read and convert the following 
1617       // n * 2 bytes properly i.e. as a multivaluated strings
1618       // (each single value is separated fromthe next one by '\'
1619       // as usual for standard multivaluated filels
1620       // Elements with Value Multiplicity > 1
1621       // contain a set of short integers (not a single one) 
1622    
1623       if ( vr == "US" || vr == "SS" )
1624       {
1625          uint16_t newInt16;
1626
1627          nbInt = length / 2;
1628          for (int i=0; i < nbInt; i++) 
1629          {
1630             if ( i != 0 )
1631             {
1632                s << '\\';
1633             }
1634             newInt16 = ( val[2*i+0] & 0xFF ) + ( ( val[2*i+1] & 0xFF ) << 8);
1635             newInt16 = SwapShort( newInt16 );
1636             s << newInt16;
1637          }
1638       }
1639
1640       // When integer(s) are expected, read and convert the following 
1641       // n * 4 bytes properly i.e. as a multivaluated strings
1642       // (each single value is separated fromthe next one by '\'
1643       // as usual for standard multivaluated filels
1644       // Elements with Value Multiplicity > 1
1645       // contain a set of integers (not a single one) 
1646       else if ( vr == "UL" || vr == "SL" )
1647       {
1648          uint32_t newInt32;
1649
1650          nbInt = length / 4;
1651          for (int i=0; i < nbInt; i++) 
1652          {
1653             if ( i != 0)
1654             {
1655                s << '\\';
1656             }
1657             newInt32 = ( val[4*i+0] & 0xFF )
1658                     + (( val[4*i+1] & 0xFF ) <<  8 )
1659                     + (( val[4*i+2] & 0xFF ) << 16 )
1660                     + (( val[4*i+3] & 0xFF ) << 24 );
1661             newInt32 = SwapLong( newInt32 );
1662             s << newInt32;
1663          }
1664       }
1665 #ifdef GDCM_NO_ANSI_STRING_STREAM
1666       s << std::ends; // to avoid oddities on Solaris
1667 #endif //GDCM_NO_ANSI_STRING_STREAM
1668       return s.str();
1669    }
1670    return ((ValEntry *)entry)->GetValue();
1671 }
1672
1673 /**
1674  * \brief   Get the reverse transformed value of the header entry. The VR 
1675  *          value is used to define the reverse transformation to operate on
1676  *          the value
1677  * \warning NOT end user intended method !
1678  * @param   entry Entry to reverse transform
1679  * @return  Reverse transformed entry value
1680  */
1681 std::string Document::GetDocEntryUnvalue(DocEntry *entry)
1682 {
1683    if ( IsDocEntryAnInteger(entry) && entry->IsImplicitVR() )
1684    {
1685       std::string vr = entry->GetVR();
1686       std::vector<std::string> tokens;
1687       std::ostringstream s;
1688
1689       if ( vr == "US" || vr == "SS" ) 
1690       {
1691          uint16_t newInt16;
1692
1693          tokens.erase( tokens.begin(), tokens.end()); // clean any previous value
1694          Util::Tokenize (((ValEntry *)entry)->GetValue(), tokens, "\\");
1695          for (unsigned int i=0; i<tokens.size(); i++) 
1696          {
1697             newInt16 = atoi(tokens[i].c_str());
1698             s << (  newInt16        & 0xFF ) 
1699               << (( newInt16 >> 8 ) & 0xFF );
1700          }
1701          tokens.clear();
1702       }
1703       if ( vr == "UL" || vr == "SL")
1704       {
1705          uint32_t newInt32;
1706
1707          tokens.erase(tokens.begin(),tokens.end()); // clean any previous value
1708          Util::Tokenize (((ValEntry *)entry)->GetValue(), tokens, "\\");
1709          for (unsigned int i=0; i<tokens.size();i++) 
1710          {
1711             newInt32 = atoi(tokens[i].c_str());
1712             s << (char)(  newInt32         & 0xFF ) 
1713               << (char)(( newInt32 >>  8 ) & 0xFF )
1714               << (char)(( newInt32 >> 16 ) & 0xFF )
1715               << (char)(( newInt32 >> 24 ) & 0xFF );
1716          }
1717          tokens.clear();
1718       }
1719
1720 #ifdef GDCM_NO_ANSI_STRING_STREAM
1721       s << std::ends; // to avoid oddities on Solaris
1722 #endif //GDCM_NO_ANSI_STRING_STREAM
1723       return s.str();
1724    }
1725
1726    return ((ValEntry *)entry)->GetValue();
1727 }
1728
1729 /**
1730  * \brief   Skip a given Header Entry 
1731  * \warning NOT end user intended method !
1732  * @param   entry entry to skip
1733  */
1734 void Document::SkipDocEntry(DocEntry *entry) 
1735 {
1736    SkipBytes(entry->GetLength());
1737 }
1738
1739 /**
1740  * \brief   Skips to the beginning of the next Header Entry 
1741  * \warning NOT end user intended method !
1742  * @param   currentDocEntry entry to skip
1743  */
1744 void Document::SkipToNextDocEntry(DocEntry *currentDocEntry) 
1745 {
1746    int l = currentDocEntry->GetReadLength();
1747    if ( l == -1 ) // length = 0xffff shouldn't appear here ...
1748                   // ... but PMS imagers happen !
1749       return;
1750    Fp->seekg((long)(currentDocEntry->GetOffset()), std::ios::beg);
1751    if (currentDocEntry->GetGroup() != 0xfffe)  // for fffe pb
1752    {
1753       Fp->seekg( (long)(currentDocEntry->GetReadLength()),std::ios::cur);
1754    }
1755 }
1756
1757 /**
1758  * \brief   When the length of an element value is obviously wrong (because
1759  *          the parser went Jabberwocky) one can hope improving things by
1760  *          applying some heuristics.
1761  * @param   entry entry to check
1762  * @param   foundLength first assumption about length    
1763  */
1764 void Document::FixDocEntryFoundLength(DocEntry *entry,
1765                                       uint32_t foundLength)
1766 {
1767    entry->SetReadLength( foundLength ); // will be updated only if a bug is found        
1768    if ( foundLength == 0xffffffff)
1769    {
1770       foundLength = 0;
1771    }
1772    
1773    uint16_t gr   = entry->GetGroup();
1774    uint16_t elem = entry->GetElement(); 
1775      
1776    if ( foundLength % 2)
1777    {
1778       gdcmWarningMacro( "Warning : Tag with uneven length " << foundLength 
1779         <<  " in x(" << std::hex << gr << "," << elem <<")");
1780    }
1781       
1782    //////// Fix for some naughty General Electric images.
1783    // Allthough not recent many such GE corrupted images are still present
1784    // on Creatis hard disks. Hence this fix shall remain when such images
1785    // are no longer in use (we are talking a few years, here)...
1786    // Note: XMedCon probably uses such a trick since it is able to read
1787    //       those pesky GE images ...
1788    if ( foundLength == 13)
1789    {
1790       // Only happens for this length !
1791       if ( gr != 0x0008 || ( elem != 0x0070 && elem != 0x0080 ) )
1792       {
1793          foundLength = 10;
1794          entry->SetReadLength(10); // a bug is to be fixed !?
1795       }
1796    }
1797
1798    //////// Fix for some brain-dead 'Leonardo' Siemens images.
1799    // Occurence of such images is quite low (unless one leaves close to a
1800    // 'Leonardo' source. Hence, one might consider commenting out the
1801    // following fix on efficiency reasons.
1802    else if ( gr   == 0x0009 && ( elem == 0x1113 || elem == 0x1114 ) )
1803    {
1804       foundLength = 4;
1805       entry->SetReadLength(4); // a bug is to be fixed !?
1806    } 
1807  
1808    else if ( entry->GetVR() == "SQ" )
1809    {
1810       foundLength = 0;      // ReadLength is unchanged 
1811    } 
1812     
1813    //////// We encountered a 'delimiter' element i.e. a tag of the form 
1814    // "fffe|xxxx" which is just a marker. Delimiters length should not be
1815    // taken into account.
1816    else if ( gr == 0xfffe )
1817    {    
1818      // According to the norm, fffe|0000 shouldn't exist. BUT the Philips
1819      // image gdcmData/gdcm-MR-PHILIPS-16-Multi-Seq.dcm happens to
1820      // causes extra troubles...
1821      if ( entry->GetElement() != 0x0000 )
1822      {
1823         foundLength = 0;
1824      }
1825    }            
1826    entry->SetLength(foundLength);
1827 }
1828
1829 /**
1830  * \brief   Apply some heuristics to predict whether the considered 
1831  *          element value contains/represents an integer or not.
1832  * @param   entry The element value on which to apply the predicate.
1833  * @return  The result of the heuristical predicate.
1834  */
1835 bool Document::IsDocEntryAnInteger(DocEntry *entry)
1836 {
1837    uint16_t elem         = entry->GetElement();
1838    uint16_t group        = entry->GetGroup();
1839    const std::string &vr = entry->GetVR();
1840    uint32_t length       = entry->GetLength();
1841
1842    // When we have some semantics on the element we just read, and if we
1843    // a priori know we are dealing with an integer, then we shall be
1844    // able to swap it's element value properly.
1845    if ( elem == 0 )  // This is the group length of the group
1846    {  
1847       if ( length == 4 )
1848       {
1849          return true;
1850       }
1851       else 
1852       {
1853          // Allthough this should never happen, still some images have a
1854          // corrupted group length [e.g. have a glance at offset x(8336) of
1855          // gdcmData/gdcm-MR-PHILIPS-16-Multi-Seq.dcm].
1856          // Since for dicom compliant and well behaved headers, the present
1857          // test is useless (and might even look a bit paranoid), when we
1858          // encounter such an ill-formed image, we simply display a warning
1859          // message and proceed on parsing (while crossing fingers).
1860          long filePosition = Fp->tellg();
1861          gdcmWarningMacro( "Erroneous Group Length element length  on : (" 
1862            << std::hex << group << " , " << elem
1863            << ") -before- position x(" << filePosition << ")"
1864            << "lgt : " << length );
1865       }
1866    }
1867
1868    if ( vr == "UL" || vr == "US" || vr == "SL" || vr == "SS" )
1869    {
1870       return true;
1871    }   
1872    return false;
1873 }
1874
1875 /**
1876  * \brief   Discover what the swap code is (among little endian, big endian,
1877  *          bad little endian, bad big endian).
1878  *          sw is set
1879  * @return false when we are absolutely sure 
1880  *               it's neither ACR-NEMA nor DICOM
1881  *         true  when we hope ours assuptions are OK
1882  */
1883 bool Document::CheckSwap()
1884 {   
1885    uint32_t  s32;
1886    uint16_t  s16;
1887        
1888    char deb[256];
1889     
1890    // First, compare HostByteOrder and NetworkByteOrder in order to
1891    // determine if we shall need to swap bytes (i.e. the Endian type).
1892    bool net2host = Util::IsCurrentProcessorBigEndian();
1893          
1894    // The easiest case is the one of a 'true' DICOM header, we just have
1895    // to look for the string "DICM" inside the file preamble.
1896    Fp->read(deb, 256);
1897    
1898    char *entCur = deb + 128;
1899    if ( memcmp(entCur, "DICM", (size_t)4) == 0 )
1900    {
1901       gdcmWarningMacro( "Looks like DICOM Version3 (preamble + DCM)" );
1902       
1903       // Group 0002 should always be VR, and the first element 0000
1904       // Let's be carefull (so many wrong headers ...)
1905       // and determine the value representation (VR) : 
1906       // Let's skip to the first element (0002,0000) and check there if we find
1907       // "UL"  - or "OB" if the 1st one is (0002,0001) -,
1908       // in which case we (almost) know it is explicit VR.
1909       // WARNING: if it happens to be implicit VR then what we will read
1910       // is the length of the group. If this ascii representation of this
1911       // length happens to be "UL" then we shall believe it is explicit VR.
1912       // We need to skip :
1913       // * the 128 bytes of File Preamble (often padded with zeroes),
1914       // * the 4 bytes of "DICM" string,
1915       // * the 4 bytes of the first tag (0002, 0000),or (0002, 0001)
1916       // i.e. a total of  136 bytes.
1917       entCur = deb + 136;
1918      
1919       // group 0x0002 *is always* Explicit VR Sometimes ,
1920       // even if elem 0002,0010 (Transfer Syntax) tells us the file is
1921       // *Implicit* VR  (see former 'gdcmData/icone.dcm')
1922       
1923       if ( memcmp(entCur, "UL", (size_t)2) == 0 ||
1924            memcmp(entCur, "OB", (size_t)2) == 0 ||
1925            memcmp(entCur, "UI", (size_t)2) == 0 ||
1926            memcmp(entCur, "CS", (size_t)2) == 0 )  // CS, to remove later
1927                                                    // when Write DCM *adds*
1928       // FIXME
1929       // Use Document::dicom_vr to test all the possibilities
1930       // instead of just checking for UL, OB and UI !? group 0000 
1931       {
1932          Filetype = ExplicitVR;
1933          gdcmWarningMacro( "Group 0002 : Explicit Value Representation");
1934       } 
1935       else 
1936       {
1937          Filetype = ImplicitVR;
1938          gdcmWarningMacro( "Group 0002 :Not an explicit Value Representation;"
1939                         << "Looks like a bugged Header!");
1940       }
1941       
1942       if ( net2host )
1943       {
1944          SwapCode = 4321;
1945          gdcmWarningMacro( "HostByteOrder != NetworkByteOrder");
1946       }
1947       else 
1948       {
1949          SwapCode = 1234;
1950          gdcmWarningMacro( "HostByteOrder = NetworkByteOrder");
1951       }
1952       
1953       // Position the file position indicator at first tag 
1954       // (i.e. after the file preamble and the "DICM" string).
1955
1956       Fp->seekg(0, std::ios::beg); // FIXME : Is it usefull?
1957
1958       Fp->seekg ( 132L, std::ios::beg);
1959       return true;
1960    } // ------------------------------- End of DicomV3 ----------------
1961
1962    // Alas, this is not a DicomV3 file and whatever happens there is no file
1963    // preamble. We can reset the file position indicator to where the data
1964    // is (i.e. the beginning of the file).
1965
1966    gdcmWarningMacro( "Not a Kosher DICOM Version3 file (no preamble)");
1967
1968    Fp->seekg(0, std::ios::beg);
1969
1970    // Let's check 'No Preamble Dicom File' :
1971    // Should start with group 0x0002
1972    // and be Explicit Value Representation
1973
1974    s16 = *((uint16_t *)(deb));
1975    SwapCode = 0;     
1976    switch ( s16 )
1977    {
1978       case 0x0002 :
1979          SwapCode = 1234;
1980          entCur = deb + 4;
1981          break;
1982       case 0x0200 :
1983          SwapCode = 4321;
1984          entCur = deb + 6;
1985     } 
1986
1987    if ( SwapCode != 0 )
1988    {
1989       if ( memcmp(entCur, "UL", (size_t)2) == 0 ||
1990            memcmp(entCur, "OB", (size_t)2) == 0 ||
1991            memcmp(entCur, "UI", (size_t)2) == 0 ||
1992            memcmp(entCur, "SH", (size_t)2) == 0 ||
1993            memcmp(entCur, "AE", (size_t)2) == 0 ||
1994            memcmp(entCur, "OB", (size_t)2) == 0 )
1995          {
1996             Filetype = ExplicitVR;
1997             gdcmWarningMacro( "Group 0002 : Explicit Value Representation");
1998             return true;
1999           }
2000     }
2001 // ------------------------------- End of 'No Preamble' DicomV3 -------------
2002
2003    // Our next best chance would be to be considering a 'clean' ACR/NEMA file.
2004    // By clean we mean that the length of the first group is written down.
2005    // If this is the case and since the length of the first group HAS to be
2006    // four (bytes), then determining the proper swap code is straightforward.
2007
2008    entCur = deb + 4;
2009    // We assume the array of char we are considering contains the binary
2010    // representation of a 32 bits integer. Hence the following dirty
2011    // trick :
2012    s32 = *((uint32_t *)(entCur));
2013    switch( s32 )
2014    {
2015       case 0x00040000 :
2016          SwapCode = 3412;
2017          Filetype = ACR;
2018          return true;
2019       case 0x04000000 :
2020          SwapCode = 4321;
2021          Filetype = ACR;
2022          return true;
2023       case 0x00000400 :
2024          SwapCode = 2143;
2025          Filetype = ACR;
2026          return true;
2027       case 0x00000004 :
2028          SwapCode = 1234;
2029          Filetype = ACR;
2030          return true;
2031       default :
2032          // We are out of luck. It is not a DicomV3 nor a 'clean' ACR/NEMA file.
2033          // It is time for despaired wild guesses. 
2034          // So, let's check if this file wouldn't happen to be 'dirty' ACR/NEMA,
2035          //  i.e. the 'group length' element is not present :     
2036          
2037          //  check the supposed-to-be 'group number'
2038          //  in ( 0x0001 .. 0x0008 )
2039          //  to determine ' SwapCode' value .
2040          //  Only 0 or 4321 will be possible 
2041          //  (no oportunity to check for the formerly well known
2042          //  ACR-NEMA 'Bad Big Endian' or 'Bad Little Endian' 
2043          //  if unsuccessfull (i.e. neither 0x0002 nor 0x0200 etc -3, 4, ..., 8-) 
2044          //  the file IS NOT ACR-NEMA nor DICOM V3
2045          //  Find a trick to tell it the caller...
2046       
2047          s16 = *((uint16_t *)(deb));
2048       
2049          switch ( s16 )
2050          {
2051             case 0x0001 :
2052             case 0x0002 :
2053             case 0x0003 :
2054             case 0x0004 :
2055             case 0x0005 :
2056             case 0x0006 :
2057             case 0x0007 :
2058             case 0x0008 :
2059                SwapCode = 1234;
2060                Filetype = ACR;
2061                return true;
2062             case 0x0100 :
2063             case 0x0200 :
2064             case 0x0300 :
2065             case 0x0400 :
2066             case 0x0500 :
2067             case 0x0600 :
2068             case 0x0700 :
2069             case 0x0800 :
2070                SwapCode = 4321;
2071                Filetype = ACR;
2072                return true;
2073             default :
2074                gdcmWarningMacro( "ACR/NEMA unfound swap info (Really hopeless !)");
2075                Filetype = Unknown;
2076                return false;
2077          }
2078    }
2079 }
2080
2081 /**
2082  * \brief Change the Byte Swap code. 
2083  */
2084 void Document::SwitchByteSwapCode() 
2085 {
2086    gdcmWarningMacro( "Switching Byte Swap code from "<< SwapCode
2087                      << " at :" <<std::hex << Fp->tellg() );
2088    if ( SwapCode == 1234 ) 
2089    {
2090       SwapCode = 4321;
2091    }
2092    else if ( SwapCode == 4321 ) 
2093    {
2094       SwapCode = 1234;
2095    }
2096    else if ( SwapCode == 3412 ) 
2097    {
2098       SwapCode = 2143;
2099    }
2100    else if ( SwapCode == 2143 )
2101    {
2102       SwapCode = 3412;
2103    }
2104 }
2105
2106 /**
2107  * \brief  during parsing, Header Elements too long are not loaded in memory 
2108  * @param newSize new size
2109  */
2110 void Document::SetMaxSizeLoadEntry(long newSize) 
2111 {
2112    if ( newSize < 0 )
2113    {
2114       return;
2115    }
2116    if ((uint32_t)newSize >= (uint32_t)0xffffffff )
2117    {
2118       MaxSizeLoadEntry = 0xffffffff;
2119       return;
2120    }
2121    MaxSizeLoadEntry = newSize;
2122 }
2123
2124 /**
2125  * \brief   Read the next tag WITHOUT loading it's value
2126  *          (read the 'Group Number', the 'Element Number',
2127  *          gets the Dict Entry
2128  *          gets the VR, gets the length, gets the offset value)
2129  * @return  On succes : the newly created DocEntry, NULL on failure.      
2130  */
2131 DocEntry *Document::ReadNextDocEntry()
2132 {
2133    uint16_t group;
2134    uint16_t elem;
2135
2136    try
2137    {
2138       group = ReadInt16();
2139       elem  = ReadInt16();
2140    }
2141    catch ( FormatError e )
2142    {
2143       // We reached the EOF (or an error occured) therefore 
2144       // header parsing has to be considered as finished.
2145       return 0;
2146    }
2147
2148    // Sometimes file contains groups of tags with reversed endianess.
2149    HandleBrokenEndian(group, elem);
2150
2151    // In 'true DICOM' files Group 0002 is always little endian
2152    if ( HasDCMPreamble )
2153       HandleOutOfGroup0002(group, elem);
2154  
2155    std::string vr = FindDocEntryVR();
2156    std::string realVR = vr;
2157
2158    if ( vr == GDCM_UNKNOWN )
2159    {
2160       if ( elem == 0x0000 ) // Group Length
2161          realVR = "UL";     // must be UL
2162       else
2163       {
2164          DictEntry *dictEntry = GetDictEntry(group,elem);
2165          if ( dictEntry )
2166          {
2167             realVR = dictEntry->GetVR();
2168          }
2169       }
2170    }
2171
2172    DocEntry *newEntry;
2173    if ( Global::GetVR()->IsVROfSequence(realVR) )
2174       newEntry = NewSeqEntry(group, elem);
2175    else if ( Global::GetVR()->IsVROfStringRepresentable(realVR) )
2176       newEntry = NewValEntry(group, elem,vr);
2177    else
2178       newEntry = NewBinEntry(group, elem,vr);
2179
2180    if ( vr == GDCM_UNKNOWN )
2181    {
2182       if ( Filetype == ExplicitVR )
2183       {
2184          // We thought this was explicit VR, but we end up with an
2185          // implicit VR tag. Let's backtrack.
2186          if ( newEntry->GetGroup() != 0xfffe )
2187          { 
2188             std::string msg;
2189             int offset = Fp->tellg();
2190             msg = Util::Format("Entry (%04x,%04x) at 0x(%x) should be Explicit VR\n", 
2191                           newEntry->GetGroup(), newEntry->GetElement(), offset );
2192             gdcmWarningMacro( msg.c_str() );
2193           }
2194       }
2195       newEntry->SetImplicitVR();
2196    }
2197
2198    try
2199    {
2200       FindDocEntryLength(newEntry);
2201    }
2202    catch ( FormatError e )
2203    {
2204       // Call it quits
2205       delete newEntry;
2206       return 0;
2207    }
2208
2209    newEntry->SetOffset(Fp->tellg());  
2210
2211    return newEntry;
2212 }
2213
2214 /**
2215  * \brief   Handle broken private tag from Philips NTSCAN
2216  *          where the endianess is being switched to BigEndian 
2217  *          for no apparent reason
2218  * @return  no return
2219  */
2220 void Document::HandleBrokenEndian(uint16_t &group, uint16_t &elem)
2221 {
2222    // Endian reversion. Some files contain groups of tags with reversed endianess.
2223    static int reversedEndian = 0;
2224    // try to fix endian switching in the middle of headers
2225    if ((group == 0xfeff) && (elem == 0x00e0))
2226    {
2227      // start endian swap mark for group found
2228      reversedEndian++;
2229      SwitchByteSwapCode();
2230      // fix the tag
2231      group = 0xfffe;
2232      elem  = 0xe000;
2233    } 
2234    else if (group == 0xfffe && elem == 0xe00d && reversedEndian) 
2235    {
2236      // end of reversed endian group
2237      reversedEndian--;
2238      SwitchByteSwapCode();
2239    }
2240 }
2241
2242 /**
2243  * \brief   Group 0002 is always coded Little Endian
2244  *          whatever Transfer Syntax is
2245  * @return  no return
2246  */
2247 void Document::HandleOutOfGroup0002(uint16_t &group, uint16_t &elem)
2248 {
2249    // Endian reversion. Some files contain groups of tags with reversed endianess.
2250    if ( !Group0002Parsed && group != 0x0002)
2251    {
2252       Group0002Parsed = true;
2253       // we just came out of group 0002
2254       // if Transfer syntax is Big Endian we have to change CheckSwap
2255
2256       std::string ts = GetTransferSyntax();
2257       if ( !Global::GetTS()->IsTransferSyntax(ts) )
2258       {
2259          gdcmWarningMacro("True DICOM File, with NO Tansfer Syntax: " << ts );
2260          return;
2261       }
2262
2263       // Group 0002 is always 'Explicit ...' enven when Transfer Syntax says 'Implicit ..." 
2264
2265       if ( Global::GetTS()->GetSpecialTransferSyntax(ts) == TS::ImplicitVRLittleEndian )
2266          {
2267             Filetype = ImplicitVR;
2268          }
2269        
2270       // FIXME Strangely, this works with 
2271       //'Implicit VR Transfer Syntax (GE Private)
2272       if ( Global::GetTS()->GetSpecialTransferSyntax(ts) == TS::ExplicitVRBigEndian )
2273       {
2274          gdcmWarningMacro("Transfer Syntax Name = [" 
2275                         << GetTransferSyntaxName() << "]" );
2276          SwitchByteSwapCode();
2277          group = SwapShort(group);
2278          elem  = SwapShort(elem);
2279       }
2280    }
2281 }
2282
2283 //-----------------------------------------------------------------------------
2284 // Print
2285
2286 //-----------------------------------------------------------------------------
2287 } // end namespace gdcm