]> Creatis software - gdcm.git/blobdiff - src/gdcmDocument.cxx
Improve 'Print' methods
[gdcm.git] / src / gdcmDocument.cxx
index 11d558e3344917dd92f07a156cd11d79244467ff..7001f202d8ed5b90d7b0d0b49a26843e7476e1ba 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocument.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/07/05 18:44:21 $
-  Version:   $Revision: 1.255 $
+  Date:      $Date: 2005/08/23 12:57:49 $
+  Version:   $Revision: 1.265 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -62,11 +62,13 @@ Document::Document()
    // Load will set it to true if sucessfull
    Group0002Parsed = false;
    IsDocumentAlreadyLoaded = false;
+   IsDocumentModified = true;
    LoadMode = 0x00000000; // default : load everything, later
+   SetFileName("");
 }
 
 /**
- * \brief   Constructor (not to break the API) 
+ * \brief   Constructor (DEPRECATED : not to break the API) 
  * @param   fileName 'Document' (File or DicomDir) to be open for parsing
  */
 Document::Document( std::string const &fileName )
@@ -83,8 +85,10 @@ Document::Document( std::string const &fileName )
 
    // Load will set it to true if sucessfull
    IsDocumentAlreadyLoaded = false;
+   IsDocumentModified = true;
 
-   Load(fileName);
+   SetFileName(fileName);
+   Load( );
 }
 /**
  * \brief   Canonical destructor.
@@ -99,26 +103,57 @@ Document::~Document ()
 // Public
 
 /**
- * \brief   Loader  
- * @param   fileName 'Document' (File or DicomDir) to be open for parsing
+ * \brief   Loader. use SetLoadMode(), SetFileName() before ! 
  * @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 ) 
+bool Document::Load(  ) 
 {
-   // We should clean out anything that already exists.
-   // Check IsDocumentAlreadyLoaded to be sure.
-   if ( IsDocumentAlreadyLoaded )
+   if ( GetFileName() == "" )
    {
-      gdcmWarningMacro( "A file was already parsed inside this "
-                        << "gdcm::Document (previous name was: "
-                        << Filename.c_str() << ". New name is :"
-                        << fileName );
-     // todo : clean out the 'Document'
-     // Should we call ClearEntry() on the parent object ?!?
+      gdcmWarningMacro( "Use SetFileName, before !" );
+      return false;
    }
-
+   return DoTheLoadingDocumentJob( );
+} 
+/**
+ * \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( );
+}
+
+/**
+ * \brief   Performs the Loading Job (internal use only)  
+ * @return false if file cannot be open or no swap info was found,
+ *         or no tag was found.
+ */
+bool Document::DoTheLoadingDocumentJob(  ) 
+{
+   if ( ! IsDocumentModified ) // Nothing to do !
+      return true;
+
+ //     if ( Filename == fileName )
+ //     {
+ //        gdcmWarningMacro( "The file was already parsed inside this "
+ //                       << "gdcm::Document (its name is: "
+ //                       << Filename.c_str() );
+ //        return true;
+ //     }
+  
+   //gdcmWarningMacro( "A file was already parsed inside this "
+   //                  << "gdcm::Document (previous name was: "
+   //                  << Filename.c_str() << ". New name is :"
+   //                  << fileName );
+     // clean out the Entries, if already parsed
+     // (probabely a mistake from the user)
+   ClearEntry();
 
    Fp = 0;
    if ( !OpenFile() )
@@ -858,7 +893,7 @@ void Document::Initialize()
  * \brief   Parses a DocEntrySet (Zero-level DocEntries or SQ Item DocEntries)
  * @param set DocEntrySet we are going to parse ('zero level' or a SQItem)
  * @param offset start of parsing
- * @param l_max  length to parse
+ * @param l_max  length to parse (meaningless when we are in 'delimitor mode')
  * @param delim_mode : whether we are in 'delimitor mode' (l=0xffffff) or not
  */ 
 void Document::ParseDES(DocEntrySet *set, long offset, 
@@ -870,7 +905,7 @@ void Document::ParseDES(DocEntrySet *set, long offset,
    SeqEntry *newSeqEntry;
    VRKey vr;
    bool used;
-   bool delim_mode_intern;
+   bool delim_mode_intern = delim_mode;
 
    while (true)
    {
@@ -879,7 +914,6 @@ void Document::ParseDES(DocEntrySet *set, long offset,
          break;
       }
 
-      used = true;
       newDocEntry = ReadNextDocEntry( );
 
       if ( !newDocEntry )
@@ -887,15 +921,22 @@ void Document::ParseDES(DocEntrySet *set, long offset,
          break;
       }
 
-      vr = newDocEntry->GetVR();
+      // Uncoment this printf line to be able to 'follow' the DocEntries
+      // when something *very* strange happens
+
+      //printf( "%04x|%04x %s\n",newDocEntry->GetGroup(), 
+      //                     newDocEntry->GetElement(),
+      //                     newDocEntry->GetVR().c_str() );
+      used = true;
       newValEntry = dynamic_cast<ValEntry*>(newDocEntry);
       newBinEntry = dynamic_cast<BinEntry*>(newDocEntry);
-      newSeqEntry = dynamic_cast<SeqEntry*>(newDocEntry);
 
-      if ( newValEntry || newBinEntry )
+      if ( newValEntry || newBinEntry )  
       {
+       //////////////////////////// ContentEntry
          if ( newBinEntry )
          {
+            vr = newDocEntry->GetVR();
             if ( Filetype == ExplicitVR && 
                  !Global::GetVR()->IsVROfBinaryRepresentable(vr) )
             { 
@@ -907,6 +948,7 @@ void Document::ParseDES(DocEntrySet *set, long offset,
             }
 
          //////////////////// BinEntry or UNKOWN VR:
+
             // When "this" is a Document the Key is simply of the
             // form ( group, elem )...
             if ( dynamic_cast< Document* > ( set ) )
@@ -916,21 +958,28 @@ void Document::ParseDES(DocEntrySet *set, long offset,
             // but when "this" is a SQItem, we are inserting this new
             // valEntry in a sequence item, and the key has the
             // generalized form (refer to \ref BaseTagKey):
-            if (SQItem *parentSQItem = dynamic_cast< SQItem* > ( set ) )
-            {
-               newBinEntry->SetKey(  parentSQItem->GetBaseTagKey()
-                                   + newBinEntry->GetKey() );
-            }
 
-            LoadDocEntry( newBinEntry );
+            // time waste hunting
+            //if (SQItem *parentSQItem = dynamic_cast< SQItem* > ( set ) )
+            //{
+            //   newBinEntry->SetKey(  parentSQItem->GetBaseTagKey()
+            //                       + newBinEntry->GetKey() );
+            //}
+           
             if ( !set->AddEntry( newBinEntry ) )
             {
-              //Expect big troubles if here
-              //delete newBinEntry;
-              gdcmWarningMacro("in ParseDES : shouldn't get here !");
-              used=false;
+               gdcmWarningMacro( "in ParseDES : cannot add a BinEntry "
+                                   << newBinEntry->GetKey()  
+                                   << " (at offset : " 
+                                   << newBinEntry->GetOffset() << " )" );
+               used=false;
             }
-         }
+            else
+            {
+               // Load only if we can add (not a duplicate key)
+               LoadDocEntry( newBinEntry );
+            }
+         }  // end BinEntry
          else
          {
          /////////////////////// ValEntry
@@ -944,22 +993,33 @@ void Document::ParseDES(DocEntrySet *set, long offset,
             // ...but when "set" is a SQItem, we are inserting this new
             // valEntry in a sequence item. Hence the key has the
             // generalized form (refer to \ref BaseTagKey):
-            if (SQItem *parentSQItem = dynamic_cast< SQItem* > ( set ) )
+
+            // time waste hunting
+            //if (SQItem *parentSQItem = dynamic_cast< SQItem* > ( set ) )
+            //{
+            //   newValEntry->SetKey(  parentSQItem->GetBaseTagKey()
+            //                      + newValEntry->GetKey() );
+            //}
+
+            if ( !set->AddEntry( newValEntry ) )
             {
-               newValEntry->SetKey(  parentSQItem->GetBaseTagKey()
-                                   + newValEntry->GetKey() );
+              gdcmWarningMacro( "in ParseDES : cannot add a ValEntry "
+                                  << newValEntry->GetKey()
+                                  << " (at offset : " 
+                                  << newValEntry->GetOffset() << " )" );   
+              used=false;
+            }
+            else
+            {
+               // Load only if we can add (not a duplicate key)
+               LoadDocEntry( newValEntry );
             }
-             
-            LoadDocEntry( newValEntry );
-            bool delimitor=newValEntry->IsItemDelimitor();
 
-            if ( LoadMode & NO_SHADOW ) // User asked to skip, if possible, 
-                                        // shadow groups ( if possible :
-                                        // whether element 0x0000 exits)
+            if ( newValEntry->GetElement() == 0x0000 ) // if on group length
             {
-               if ( newValEntry->GetGroup()%2 != 0 )
+               if ( newValEntry->GetGroup()%2 != 0 )   // if Shadow Group
                {
-                  if ( newValEntry->GetElement() == 0x0000 )
+                  if ( LoadMode & NO_SHADOW ) // if user asked to skip shad.gr
                   {
                      std::string strLgrGroup = newValEntry->GetValue();
                      int lgrGroup;
@@ -968,27 +1028,34 @@ void Document::ParseDES(DocEntrySet *set, long offset,
                         lgrGroup = atoi(strLgrGroup.c_str());
                         Fp->seekg(lgrGroup, std::ios::cur);
                         used = false;
+                        RemoveEntry( newDocEntry );
+                        newDocEntry = 0;
                         continue;
                      }
                   }
                }
              }
 
-            if ( !set->AddEntry( newValEntry ) )
-            {
-              // If here expect big troubles
-              // delete newValEntry; //otherwise mem leak
-              used=false;
-            }
+            bool delimitor=newValEntry->IsItemDelimitor();
 
-            if (delimitor)
-            {
-               if ( !used )
-                  delete newDocEntry;
-               break;
-            }
-            if ( !delim_mode && ((long)(Fp->tellg())-offset) >= l_max )
+            // FIXME : Brutal patch, waiting till we find a clever way to guess
+            //         if a doc entry is a Sequence, 
+            //          - when it's odd number
+            //          - and the file is Implicit VR Transfert Syntax
+            //
+            // '&& offset!=132' is a very fierce way to guess
+            //          if we are at zero level (Probabely not enough ...).
+            //          We want to go on parsing.
+            if ( (delimitor && offset!=132) || 
+                (!delim_mode && ((long)(Fp->tellg())-offset) >= l_max) )
             {
+               if (offset!=132)
+               {
+                  gdcmWarningMacro( "in ParseDES : Item found out of a Sequence "
+                                  << newValEntry->GetKey()
+                                  << " (at offset : " 
+                                  << newValEntry->GetOffset() << " )" );
+               }
                if ( !used )
                   delete newDocEntry;
                break;
@@ -1032,8 +1099,10 @@ void Document::ParseDES(DocEntrySet *set, long offset,
             used = false;
             continue;
          }
+         // delay the dynamic cast as late as possible
+         newSeqEntry = dynamic_cast<SeqEntry*>(newDocEntry);
          
-         // no other way to create it ...
+         // no other way to create the Delimitor ...
          newSeqEntry->SetDelimitorMode( delim_mode_intern );
 
          // At the top of the hierarchy, stands a Document. When "set"
@@ -1048,11 +1117,14 @@ void Document::ParseDES(DocEntrySet *set, long offset,
          // But when "set" is already a SQItem, we are building a nested
          // sequence, and hence the depth level of the new SeqEntry
          // we are building, is one level deeper:
+
+         // time waste hunting
          if (SQItem *parentSQItem = dynamic_cast< SQItem* > ( set ) )
          {
             newSeqEntry->SetDepthLevel( parentSQItem->GetDepthLevel() + 1 );
-            newSeqEntry->SetKey(  parentSQItem->GetBaseTagKey()
-                                + newSeqEntry->GetKey() );
+
+          //  newSeqEntry->SetKey(  parentSQItem->GetBaseTagKey()
+          //                      + newSeqEntry->GetKey() );
          }
 
          if ( l != 0 )
@@ -1063,20 +1135,26 @@ void Document::ParseDES(DocEntrySet *set, long offset,
          }
          if ( !set->AddEntry( newSeqEntry ) )
          {
+            gdcmWarningMacro( "in ParseDES : cannot add a SeqEntry "
+                                << newSeqEntry->GetKey()
+                                << " (at offset : " 
+                                << newSeqEntry->GetOffset() << " )" ); 
             used = false;
          }
  
          if ( !delim_mode && ((long)(Fp->tellg())-offset) >= l_max)
          {
             if ( !used )
-               delete newDocEntry;
-            break;
+               delete newDocEntry;  
+               break;
          }
-      }
+      }  // end SeqEntry : VR = "SQ"
 
       if ( !used )
+      {
          delete newDocEntry;
-   }
+      }
+   }                               // end While
 }
 
 /**
@@ -1116,12 +1194,14 @@ void Document::ParseSQ( SeqEntry *seqEntry,
       }
       // create the current SQItem
       SQItem *itemSQ = new SQItem( seqEntry->GetDepthLevel() );
+/*
       std::ostringstream newBase;
       newBase << seqEntry->GetKey()
               << "/"
               << SQItemNumber
               << "#";
       itemSQ->SetBaseTagKey( newBase.str() );
+*/
       unsigned int l = newDocEntry->GetReadLength();
       
       if ( l == 0xffffffff )
@@ -1663,9 +1743,15 @@ void Document::SkipDocEntry(DocEntry *entry)
  */
 void Document::SkipToNextDocEntry(DocEntry *currentDocEntry) 
 {
-   Fp->seekg((long)(currentDocEntry->GetOffset()),     std::ios::beg);
+   int l = currentDocEntry->GetReadLength();
+   if ( l == -1 ) // length = 0xffff shouldn't appear here ...
+                  // ... but PMS imagers happen !
+      return;
+   Fp->seekg((long)(currentDocEntry->GetOffset()), std::ios::beg);
    if (currentDocEntry->GetGroup() != 0xfffe)  // for fffe pb
+   {
       Fp->seekg( (long)(currentDocEntry->GetReadLength()),std::ios::cur);
+   }
 }
 
 /**
@@ -2077,7 +2163,9 @@ DocEntry *Document::ReadNextDocEntry()
       {
          DictEntry *dictEntry = GetDictEntry(group,elem);
          if ( dictEntry )
+         {
             realVR = dictEntry->GetVR();
+         }
       }
    }