]> Creatis software - gdcm.git/blobdiff - src/gdcmDocument.cxx
Minor comment fixes
[gdcm.git] / src / gdcmDocument.cxx
index 3803b0a705673a36a062262c0c5d2c00e6fdabbb..d56b0527fe202a244da9553f3d51aab0a17eabb7 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocument.cxx,v $
   Language:  C++
-  Date:      $Date: 2006/02/09 10:48:04 $
-  Version:   $Revision: 1.341 $
+  Date:      $Date: 2006/03/01 10:15:12 $
+  Version:   $Revision: 1.343 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -95,6 +95,20 @@ bool Document::Load(  )
    return DoTheLoadingDocumentJob( );
 }
 
+#ifndef GDCM_LEGACY_REMOVE
+/**
+ * \brief   Loader. (DEPRECATED : not to break the API)   
+ * @param   fileName 'Document' (File or DicomDir) to be open for parsing
+ * @return false if file cannot be open or no swap info was found,
+ *         or no tag was found.
+ */
+bool Document::Load( std::string const &fileName ) 
+{
+   Filename = fileName;
+   return DoTheLoadingDocumentJob( );
+}
+#endif
+
 /**
  * \brief   Performs the Loading Job (internal use only)  
  * @return false if file cannot be open or no swap info was found,
@@ -118,7 +132,7 @@ bool Document::DoTheLoadingDocumentJob(  )
    Group0002Parsed = false;
 
    gdcmDebugMacro( "Starting parsing of file: " << Filename.c_str());
-   
+
    // Computes the total length of the file
    Fp->seekg(0, std::ios::end);  // Once per Document !
    long lgt = Fp->tellg();       // Once per Document !   
@@ -640,7 +654,7 @@ std::ifstream *Document::OpenFile()
 
    // -- Neither ACR/No Preamble Dicom nor DICOMV3 file
    CloseFile();
-   // Don't user Warning nor Error, not to polute the output
+   // Don't user Warning nor Error, not to pollute the output
    // while directory recursive parsing ...
    gdcmDebugMacro( "Neither ACR/No Preamble Dicom nor DICOMV3 file: "
                       << Filename.c_str()); 
@@ -969,7 +983,6 @@ int Document::ComputeGroup0002Length( )
                   // explicit VR AND (OB, OW, SQ, UT) : 4 more bytes
                   groupLength +=  4;
                }
             groupLength += 2 + 2 + 4 + entry->GetLength();   
          }
       }
@@ -1012,6 +1025,7 @@ void Document::CallEndMethod()
 // Private
 /**
  * \brief Loads all the needed Dictionaries
+ * \warning NOT end user intended method !
  */
 void Document::Initialize() 
 {
@@ -1042,8 +1056,18 @@ void Document::ParseDES(DocEntrySet *set, long offset,
                      << " at offset " << std::hex << "0x(" << offset << ")" ); 
    while (true)
    {
-   // if ( !delim_mode && ((long)(Fp->tellg())-offset) >= l_max) // Once per DocEntry
    
+   ///\todo FIXME : On 64 bits processors, tellg gives unexpected results after a while ?
+   ///              Probabely a bug in gdcm code somwhere (some memory erased ?)
+
+// Uncomment to track the bug
+/*   
+   if( Debug::GetDebugFlag() )   
+      std::cout << std::dec <<"(long)(Fp->tellg()) " << (long)(Fp->tellg()) 
+                << std::hex << " 0x(" <<(long)(Fp->tellg()) <<  ")" << std::endl;
+*/
+
+   // if ( !delim_mode && ((long)(Fp->tellg())-offset) >= l_max) // Once per DocEntry   
       if ( !delim_mode ) // 'and then' doesn't exist in C++ :-(
          if ( ((long)(Fp->tellg())-offset) >= l_max) // Once per DocEntry, when no delim mode
          {
@@ -1066,9 +1090,9 @@ void Document::ParseDES(DocEntrySet *set, long offset,
        // but we didn't get it (private Sequence + Implicit VR)
        // we have to backtrack.
       if ( !first && newDocEntry->IsItemStarter() )
-      { 
-        // Debug message within the method !      
-        newDocEntry = Backtrack(newDocEntry); 
+      {
+         // Debug message within the method !
+         newDocEntry = Backtrack(newDocEntry);
       }
       else
       { 
@@ -1344,8 +1368,7 @@ DocEntry *Document::Backtrack(DocEntry *docEntry)
    newEntry->SetOffset(offset);
 
    // Move back to the beginning of the Sequence
-  // Fp->seekg( 0, std::ios::beg);      // JPRx
-  // Fp->seekg(offset, std::ios::cur);  // JPRx
+
    Fp->seekg(offset, std::ios::beg); // Only for Shadow Implicit VR SQ
    return newEntry;
 }
@@ -1369,7 +1392,6 @@ void Document::LoadDocEntry(DocEntry *entry, bool forceLoad)
    //          (fffe e000) tells us an Element is beginning
    //          (fffe e00d) tells us an Element just ended
    //          (fffe e0dd) tells us the current SeQuence just ended
-   //
    //          (fffe 0000) is an 'impossible' tag value, 
    //                                    found in MR-PHILIPS-16-Multi-Seq.dcm
    
@@ -1437,7 +1459,7 @@ void Document::FindDocEntryLength( DocEntry *entry )
          // The following reserved two bytes (see PS 3.5-2003, section
          // "7.1.2 Data element structure with explicit vr", p 27) must be
          // skipped before proceeding on reading the length on 4 bytes.
+
          Fp->seekg( 2L, std::ios::cur); // Once per OW,OB,SQ DocEntry
          uint32_t length32 = ReadInt32();
 
@@ -1500,6 +1522,7 @@ void Document::FindDocEntryLength( DocEntry *entry )
      // Well ... group 0002 is always coded in 'Explicit VR Litle Endian'
      // even if Transfer Syntax is 'Implicit VR ...'
      // --> Except for 'Implicit VR Big Endian Transfer Syntax GE Private' 
+     //     where Group 0x0002 is *also* encoded in Implicit VR !
       
       FixDocEntryFoundLength( entry, ReadInt32() );
       return;
@@ -1508,6 +1531,7 @@ void Document::FindDocEntryLength( DocEntry *entry )
 
 /**
  * \brief  Find the Length till the next sequence delimiter
+ * \warning NOT end user intended method !
  * @return 
  */
 uint32_t Document::FindDocEntryLengthOBOrOW()
@@ -1515,7 +1539,7 @@ uint32_t Document::FindDocEntryLengthOBOrOW()
 {
    // See PS 3.5-2001, section A.4 p. 49 on encapsulation of encoded pixel data.
    long positionOnEntry = Fp->tellg(); // Only for OB,OW DataElements
-   
+
    bool foundSequenceDelimiter = false;
    uint32_t totalLength = 0;
 
@@ -1537,11 +1561,9 @@ uint32_t Document::FindDocEntryLengthOBOrOW()
       totalLength += 4;     
       if ( group != 0xfffe || ( ( elem != 0xe0dd ) && ( elem != 0xe000 ) ) )
       {
-         // long filePosition = Fp->tellg(); JPRx
          gdcmWarningMacro( 
               "Neither an Item tag nor a Sequence delimiter tag on :" 
            << std::hex << group << " , " << elem 
-           //<< ") -before- position x(" << filePosition // JPRx
            << ")" );
   
          Fp->seekg(positionOnEntry, std::ios::beg); // Once per fragment (if any) of OB,OW DataElements
@@ -1665,17 +1687,21 @@ void Document::SkipToNextDocEntry(DocEntry *currentDocEntry)
  *          the parser went Jabberwocky) one can hope improving things by
  *          applying some heuristics.
  * @param   entry entry to check
- * @param   foundLength first assumption about length    
+ * @param   foundLength first assumption about length (before bug fix, or set to zero if =0xffffffff)    
  */
 void Document::FixDocEntryFoundLength(DocEntry *entry,
                                       uint32_t foundLength)
 {
    entry->SetReadLength( foundLength );// will be updated only if a bug is found
+   
    if ( foundLength == 0xffffffff)
    {
-      foundLength = 0;
+      //foundLength = 0;
+      //entry->SetLength(foundLength);
+      entry->SetLength(0);
+      return;  // return ASAP; don't waist time on useless tests
    }
-   
+      
    uint16_t gr   = entry->GetGroup();
    uint16_t elem = entry->GetElement(); 
      
@@ -1705,7 +1731,7 @@ void Document::FixDocEntryFoundLength(DocEntry *entry,
    // Occurence of such images is quite low (unless one leaves close to a
    // 'Leonardo' source. Hence, one might consider commenting out the
    // following fix on efficiency reasons.
-   else if ( gr   == 0x0009 && ( elem == 0x1113 || elem == 0x1114 ) )
+   else if ( gr == 0x0009 && ( elem == 0x1113 || elem == 0x1114 ) )
    {
       foundLength = 4;
       entry->SetReadLength(4); // a bug is to be fixed !
@@ -1724,7 +1750,7 @@ void Document::FixDocEntryFoundLength(DocEntry *entry,
      // According to the norm, fffe|0000 shouldn't exist. BUT the Philips
      // image gdcmData/gdcm-MR-PHILIPS-16-Multi-Seq.dcm happens to
      // causes extra troubles...
-     if ( entry->GetElement() != 0x0000 )
+     if ( elem != 0x0000 )
      {
         foundLength = 0;
      }
@@ -1863,8 +1889,6 @@ bool Document::CheckSwap()
       // Position the file position indicator at first tag 
       // (i.e. after the file preamble and the "DICM" string).
 
-      //Fp->seekg(0, std::ios::beg); // JPRx
-
       Fp->seekg ( 132L, std::ios::beg); // Once per Document
       return true;
    } // ------------------------------- End of DicomV3 ----------------
@@ -2055,7 +2079,7 @@ DocEntry *Document::ReadNextDocEntry()
    }
 
    // In 'true DICOM' files Group 0002 is always little endian
-   if ( HasDCMPreamble ) 
+   if ( HasDCMPreamble )
    {
       if ( !Group0002Parsed && CurrentGroup != 0x0002) // avoid calling a function when useless
          HandleOutOfGroup0002(CurrentGroup, CurrentElem);
@@ -2096,7 +2120,7 @@ DocEntry *Document::ReadNextDocEntry()
          }
       }
    }
-   
+
    DocEntry *newEntry;
    //if ( Global::GetVR()->IsVROfSequence(realVR) )
    if (realVR == "SQ")
@@ -2233,7 +2257,7 @@ void Document::HandleOutOfGroup0002(uint16_t &group, uint16_t &elem)
          group = SwapShort(group);
          elem  = SwapShort(elem);
       }
-      
+
       /// \todo  find a trick to warn user and stop processing
             
       if ( s == TS::DeflatedExplicitVRLittleEndian)