]> Creatis software - gdcm.git/blobdiff - src/gdcmParser.cxx
2004-04-28 Jean-Pierre Roux
[gdcm.git] / src / gdcmParser.cxx
index e413ee1edd704ea5cd92a3067000686f2c036351..acd248eb3f5230b4cc34ae0c9db1d227d19d87d3 100644 (file)
@@ -1,5 +1,13 @@
 // gdcmParser.cxx
 //-----------------------------------------------------------------------------
+//#define UINT32_MAX    (4294967295U)
+
+
+#include "gdcmParser.h"
+#include "gdcmGlobal.h"
+#include "gdcmUtil.h"
+#include "gdcmDebug.h"
+
 #include <errno.h>
 #include <vector>
 
    #include <netinet/in.h>
 #endif
 
-#ifdef GDCM_NO_ANSI_STRING_STREAM
-#  include <strstream>
-#  define  ostringstream ostrstream
-# else
-#  include <sstream>
-#endif
 #  include <iomanip>
 
-#include "gdcmParser.h"
-#include "gdcmGlobal.h"
-#include "gdcmUtil.h"
-#include "gdcmDebug.h"
-
 #define UI1_2_840_10008_1_2      "1.2.840.10008.1.2"
 #define UI1_2_840_10008_1_2_1    "1.2.840.10008.1.2.1"
 #define UI1_2_840_10008_1_2_2    "1.2.840.10008.1.2.2"
 #define UI1_2_840_10008_1_2_1_99 "1.2.840.10008.1.2.1.99"
 
+typedef struct {
+   guint32 totalSQlength;
+   guint32 alreadyParsedlength;
+} pileElem;
+
 //-----------------------------------------------------------------------------
 // Refer to gdcmParser::CheckSwap()
 const unsigned int gdcmParser::HEADER_LENGTH_TO_READ = 256;
@@ -44,11 +46,12 @@ const unsigned int gdcmParser::MAX_SIZE_PRINT_ELEMENT_VALUE = 64;
 
 /**
  * \brief   constructor  
- * @param   inFilename
+ * @param   inFilename file to be opened for parsing
  * @param   exception_on_error whether we throw an exception or not
  * @param   enable_sequences = true to allow the header 
- *          to be parsed *inside* the SeQuences, 
+ *          to be parsed *inside* the SeQuences,
  *          when they have an actual length 
+ * \warning enable_sequences *has to be* true for reading PAPYRUS 3.0 files 
  * @param   ignore_shadow to allow skipping the shadow elements, 
  *          to save memory space.
  * \warning The TRUE value for this param has to be used 
@@ -68,9 +71,8 @@ gdcmParser::gdcmParser(const char *inFilename,
 
    if ( !OpenFile(exception_on_error))
       return;
-   if (ParseHeader()) {
-     LoadHeaderEntries();
-   }
+
+   LoadHeaderEntries();   
    CloseFile();
 
    wasUpdated = 0;  // will be set to 1 if user adds an entry
@@ -83,6 +85,7 @@ gdcmParser::gdcmParser(const char *inFilename,
  * @param   exception_on_error
  */
 gdcmParser::gdcmParser(bool exception_on_error) {
+       (void)exception_on_error;
    enableSequences=0;
 
    SetMaxSizeLoadEntry(MAX_SIZE_LOAD_ELEMENT_VALUE);
@@ -106,11 +109,10 @@ gdcmParser::~gdcmParser (void) {
 /**
   * \ingroup gdcmParser
   * \brief   Prints the Header Entries (Dicom Elements)
-  *          both from the H Table and the chained list
+  *          from the chained list
   * @return
   */ 
 void gdcmParser::PrintEntry(std::ostream & os) {
-   std::ostringstream s;   
 
    for (ListTag::iterator i = listEntries.begin();  
         i != listEntries.end();
@@ -119,11 +121,11 @@ void gdcmParser::PrintEntry(std::ostream & os) {
       (*i)->SetPrintLevel(printLevel);
       (*i)->Print(os);   
    } 
-   os<<s.str();
 }
 
+
 /**
-  * \brief   Prints The Dict Entries of THE public Dicom Dictionnry
+  * \brief   Prints The Dict Entries of THE public Dicom Dictionary
   * @return
   */  
 void gdcmParser::PrintPubDict(std::ostream & os) {
@@ -131,7 +133,7 @@ void gdcmParser::PrintPubDict(std::ostream & os) {
 }
 
 /**
-  * \brief   Prints The Dict Entries of THE shadow Dicom Dictionnary
+  * \brief   Prints The Dict Entries of THE shadow Dicom Dictionary
   * @return
   */
 void gdcmParser::PrintShaDict(std::ostream & os) {
@@ -687,8 +689,8 @@ void *gdcmParser::LoadEntryVoidArea(guint16 Group, guint16 Elem)
       return NULL;
    size_t o =(size_t)Element->GetOffset();
    fseek(fp, o, SEEK_SET);
-   int l=Element->GetLength();
-   void * a = malloc(l);
+   size_t l=Element->GetLength();
+   char* a = new char[l];
    if(!a) 
       return NULL;
 
@@ -697,7 +699,7 @@ void *gdcmParser::LoadEntryVoidArea(guint16 Group, guint16 Elem)
    size_t l2 = fread(a, 1, l ,fp);
    if(l != l2) 
    {
-      free(a);
+      delete[] a;
       return NULL;
    }
 
@@ -878,7 +880,7 @@ void gdcmParser::UpdateGroupLength(bool SkipSequence, FileType type) {
       // since it's at the end of the Hash Table
       // (fffe,e0dd) 
        
-      // pas SEQUENCE en ACR-NEMA
+      // there is SEQUENCE in ACR-NEMA
       // WARNING : 
       // --> la descente a l'interieur' des SQ 
       // devrait etre faite avec une liste chainee, pas avec une HTable...
@@ -915,7 +917,7 @@ void gdcmParser::UpdateGroupLength(bool SkipSequence, FileType type) {
    { 
       // FIXME: g++ -Wall -Wstrict-prototypes reports on following line:
       //        warning: unsigned int format, different type arg
-      sscanf(g->first.c_str(),"%x",&gr_bid);
+      sscanf(g->first.c_str(),"%x",&gr_bid); //FIXME
       tk = g->first + "|0000";   // generate the element full tag
                      
       if ( tagHT.count(tk) == 0) // if element 0x0000 not found
@@ -1006,6 +1008,7 @@ void gdcmParser::WriteEntryTagVRLength(gdcmHeaderEntry *tag,
  */
 void gdcmParser::WriteEntryValue(gdcmHeaderEntry *tag, FILE *_fp,FileType type)
 {
+   (void)type;
    guint16 group  = tag->GetGroup();
    std::string vr = tag->GetVR();
    guint32 lgr    = tag->GetReadLength();
@@ -1016,7 +1019,6 @@ void gdcmParser::WriteEntryValue(gdcmHeaderEntry *tag, FILE *_fp,FileType type)
    if (group == 0xfffe)
       // Delimiters have no associated value:
       return;
-
       
    void *voidArea;
    voidArea = tag->GetVoidArea();
@@ -1028,6 +1030,9 @@ void gdcmParser::WriteEntryValue(gdcmHeaderEntry *tag, FILE *_fp,FileType type)
       
    if (vr == "US" || vr == "SS") 
    {
+      // some 'Short integer' fields may be mulivaluated
+      // each single value is separated from the next one by '\'
+      // we split the string and write each value as a short int
       std::vector<std::string> tokens;
       tokens.erase(tokens.begin(),tokens.end()); // clean any previous value
       Tokenize (tag->GetValue(), tokens, "\\");
@@ -1040,7 +1045,9 @@ void gdcmParser::WriteEntryValue(gdcmHeaderEntry *tag, FILE *_fp,FileType type)
       tokens.clear();
       return;
    }
-
+      // some 'Integer' fields may be mulivaluated
+      // each single value is separated from the next one by '\'
+      // we split the string and write each value as an int
    if (vr == "UL" || vr == "SL") 
    {
       std::vector<std::string> tokens;
@@ -1054,8 +1061,7 @@ void gdcmParser::WriteEntryValue(gdcmHeaderEntry *tag, FILE *_fp,FileType type)
       }
       tokens.clear();
       return;
-   } 
-          
+   }           
    fwrite (tag->GetValue().c_str(), (size_t)lgr ,(size_t)1, _fp); // Elem value
 }
 
@@ -1102,7 +1108,7 @@ bool gdcmParser::WriteEntry(gdcmHeaderEntry *tag, FILE *_fp,FileType type)
 
 bool gdcmParser::WriteEntries(FILE *_fp,FileType type)
 {   
-   // TODO (?) tester les echecs en ecriture (apres chaque fwrite)
+   // TODO (?) check write failures (after *each* fwrite)
      
    for (ListTag::iterator tag2=listEntries.begin();
                           tag2 != listEntries.end();
@@ -1115,13 +1121,10 @@ bool gdcmParser::WriteEntries(FILE *_fp,FileType type)
          if ((*tag2)->GetElement() %2)
             // Ignore the "shadow" groups
             continue;
-         if ((*tag2)->GetVR() == "SQ" )
-            // For the time being sequences are simply ignored
-            // TODO : find a trick not to *skip* the SeQuences !
-            continue;
-         if ((*tag2)->GetGroup() == 0xfffe )
-            // Ignore the documented delimiter
+         if ((*tag2)->GetVR() == "SQ" ) // ignore Sequences
             continue;
+         if ((*tag2)->GetSQDepthLevel() != 0) // Not only ignore the SQ element
+            continue;      
       } 
       if (! WriteEntry(*tag2,_fp,type) )
          return false;
@@ -1154,13 +1157,10 @@ void gdcmParser::WriteEntriesDeprecated(FILE *_fp,FileType type) {
         tag2 != tagHT.end();
         ++tag2){
       if ( type == ACR ){ 
-         if ((*tag2->second).GetGroup() < 0x0008)   continue; // ignore pure DICOM V3 groups
-         if ((*tag2->second).GetElement() %2)       continue; // ignore shadow groups
-         if ((*tag2->second).GetVR() == "SQ" )      continue; // ignore Sequences
-         // TODO : find a trick to *skip* the SeQuences !
-         // Not only ignore the SQ element
-        // --> will be done with the next organization
-         if ((*tag2->second).GetGroup() == 0xfffe ) continue; // ignore delimiters     
+         if ((*tag2->second).GetGroup() < 0x0008)    continue; // ignore pure DICOM V3 groups
+         if ((*tag2->second).GetElement() %2)        continue; // ignore shadow groups
+         if ((*tag2->second).GetVR() == "SQ" )       continue; // ignore Sequences
+         if ((*tag2->second).GetSQDepthLevel() != 0) continue; // Not only ignore the SQ element          
       }
       if ( ! WriteEntry(tag2->second,_fp,type))
          break;
@@ -1230,11 +1230,11 @@ guint16 gdcmParser::UnswapShort(guint16 a) {
 // Private
 /**
  * \ingroup gdcmParser
- * \brief   Parses the header of the file but WITHOUT loading element values.
+ * \brief   Parses the header of the file and load element values.
  * @return  false if file is not ACR-NEMA / DICOM
  */
-bool gdcmParser::ParseHeader(bool exception_on_error) throw(gdcmFormatError) {
-   
+bool gdcmParser::LoadHeaderEntries(bool exception_on_error) throw(gdcmFormatError) {
+   (void)exception_on_error;
    rewind(fp);
    if (!CheckSwap())
       return false;
@@ -1244,28 +1244,13 @@ bool gdcmParser::ParseHeader(bool exception_on_error) throw(gdcmFormatError) {
      SkipHeaderEntry(newHeaderEntry);
      if ( (ignoreShadow==0) || (newHeaderEntry->GetGroup()%2) == 0) { 
         AddHeaderEntry(newHeaderEntry); 
+       LoadHeaderEntry(newHeaderEntry); 
      }     
    }
-   return true;
-}
-
-/**
- * \ingroup gdcmParser
- * \brief   Loads the element values of all the Header Entries pointed in the
- *          public Chained List.
- */
-void gdcmParser::LoadHeaderEntries(void) {
-   rewind(fp);
-   for (ListTag::iterator i = GetListEntry().begin();
-      i != GetListEntry().end();
-      ++i)
-   {
-      LoadHeaderEntry(*i);
-   }
-            
    rewind(fp);
 
-   // Load 'non string' values   
+   // Load 'non string' values
+      
    std::string PhotometricInterpretation = GetEntryByNumber(0x0028,0x0004);   
    if( PhotometricInterpretation == "PALETTE COLOR " ) {
       LoadEntryVoidArea(0x0028,0x1200);  // gray LUT   
@@ -1277,7 +1262,7 @@ void gdcmParser::LoadHeaderEntries(void) {
       LoadEntryVoidArea(0x0028,0x1222);  // Segmented Green Palette Color LUT Data
       LoadEntryVoidArea(0x0028,0x1223);  // Segmented Blue  Palette Color LUT Data
    } 
-   //FIXME : how to use it?
+   //FIXME later : how to use it?
    LoadEntryVoidArea(0x0028,0x3006);  //LUT Data (CTX dependent)     
    
    // --------------------------------------------------------------
@@ -1297,7 +1282,8 @@ void gdcmParser::LoadHeaderEntries(void) {
          SetEntryByNumber(columns, 0x0028, 0x0010);
          SetEntryByNumber(rows   , 0x0028, 0x0011);
    }
-   // ----------------- End of Special Patch ----------------
+   // ----------------- End of Special Patch ----------------   
+   return true;
 }
 
 /**
@@ -1311,25 +1297,14 @@ void gdcmParser::LoadHeaderEntry(gdcmHeaderEntry *Entry)  {
    guint16 group  = Entry->GetGroup();
    std::string  vr= Entry->GetVR();
    guint32 length = Entry->GetLength();
-   bool SkipLoad  = false;
 
    fseek(fp, (long)Entry->GetOffset(), SEEK_SET);
-   
-   // the test was commented out to 'go inside' the SeQuences
-   // we don't any longer skip them !
-    
-   // if( vr == "SQ" )  //  (DO NOT remove this comment)
-   //    SkipLoad = true;
 
    // A SeQuence "contains" a set of Elements.  
    //          (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
-   if( group == 0xfffe )
-      SkipLoad = true;
-
-   if ( SkipLoad ) {
-      Entry->SetLength(0);
+   if( group == 0xfffe ) {
       Entry->SetValue("gdcm::Skipped");
       return;
    }
@@ -1352,18 +1327,16 @@ void gdcmParser::LoadHeaderEntry(gdcmHeaderEntry *Entry)  {
       Entry->SetValue(s.str());
       return;
    }
-   
-   // When integer(s) are expected, read and convert the following 
-   // n *(two or four bytes)
-   // properly i.e. as integers as opposed to strings.
-   // Elements with Value Multiplicity > 1
-   // contain a set of integers (not a single one) 
     
    // Any compacter code suggested (?)
    if ( IsHeaderEntryAnInteger(Entry) ) {   
       guint32 NewInt;
       std::ostringstream s;
       int nbInt;
+   // When short integer(s) are expected, read and convert the following 
+   // n *two characters properly i.e. as short integers as opposed to strings.
+   // Elements with Value Multiplicity > 1
+   // contain a set of integers (not a single one)       
       if (vr == "US" || vr == "SS") {
          nbInt = length / 2;
          NewInt = ReadInt16();
@@ -1376,6 +1349,10 @@ void gdcmParser::LoadHeaderEntry(gdcmHeaderEntry *Entry)  {
             }
          }
       }
+   // When integer(s) are expected, read and convert the following 
+   // n * four characters properly i.e. as integers as opposed to strings.
+   // Elements with Value Multiplicity > 1
+   // contain a set of integers (not a single one)           
       else if (vr == "UL" || vr == "SL") {
          nbInt = length / 4;
          NewInt = ReadInt32();
@@ -1434,9 +1411,10 @@ void gdcmParser::AddHeaderEntry(gdcmHeaderEntry *newHeaderEntry) {
  */
  void gdcmParser::FindHeaderEntryLength (gdcmHeaderEntry *Entry) {
    guint16 element = Entry->GetElement();
-   guint16 group   = Entry->GetGroup();
+   //guint16 group   = Entry->GetGroup(); //FIXME
    std::string  vr = Entry->GetVR();
    guint16 length16;
+       
    
    if ( (filetype == ExplicitVR) && (! Entry->IsImplicitVR()) ) 
    {
@@ -1666,6 +1644,13 @@ std::string gdcmParser::GetHeaderEntryValue(gdcmHeaderEntry *Entry)
       std::ostringstream s;
       int nbInt;
 
+   // When short integer(s) are expected, read and convert the following 
+   // n * 2 bytes properly i.e. as a multivaluated strings
+   // (each single value is separated fromthe next one by '\'
+   // as usual for standard multivaluated filels
+   // Elements with Value Multiplicity > 1
+   // contain a set of short integers (not a single one) 
+   
       if (vr == "US" || vr == "SS")
       {
          guint16 NewInt16;
@@ -1681,6 +1666,12 @@ std::string gdcmParser::GetHeaderEntryValue(gdcmHeaderEntry *Entry)
          }
       }
 
+   // When integer(s) are expected, read and convert the following 
+   // n * 4 bytes properly i.e. as a multivaluated strings
+   // (each single value is separated fromthe next one by '\'
+   // as usual for standard multivaluated filels
+   // Elements with Value Multiplicity > 1
+   // contain a set of integers (not a single one) 
       else if (vr == "UL" || vr == "SL")
       {
          guint32 NewInt32;
@@ -1778,8 +1769,7 @@ void gdcmParser::SkipHeaderEntry(gdcmHeaderEntry *entry)
  */
 void gdcmParser::FixHeaderEntryFoundLength(gdcmHeaderEntry *Entry, guint32 FoundLength) 
 {
-   Entry->SetReadLength(FoundLength); // will be updated only if a bug is found
-     
+   Entry->SetReadLength(FoundLength); // will be updated only if a bug is found        
    if ( FoundLength == 0xffffffff) {
       FoundLength = 0;
    }
@@ -1795,7 +1785,7 @@ void gdcmParser::FixHeaderEntryFoundLength(gdcmHeaderEntry *Entry, guint32 Found
    }
       
    // Sorry for the patch!  
-   // XMedCom did the trick to read some nasty GE images ...
+   // XMedCom did the trick to read some naughty GE images ...
    if (FoundLength == 13) {
       // The following 'if' will be removed when there is no more
       // images on Creatis HDs with a 13 length for Manufacturer...
@@ -1823,15 +1813,16 @@ void gdcmParser::FixHeaderEntryFoundLength(gdcmHeaderEntry *Entry, guint32 Found
          FoundLength =0;      // ReadLength is unchanged 
    } 
     
-   // a SeQuence Element is beginning                                          
-   // fffe|e000 is just a marker, its length *should be* zero                                               
+   // we found a 'delimiter' element                                         
+   // fffe|xxxx is just a marker, we don't take its length into account                                                   
    else if(Entry->GetGroup() == 0xfffe)
-   { 
+   {    
                                          // *normally, fffe|0000 doesn't exist ! 
      if( Entry->GetElement() != 0x0000 ) // gdcm-MR-PHILIPS-16-Multi-Seq.dcm
-                                         // causes extra troubles :-(                                                        
-         FoundLength =0;
-   }         
+                                         // causes extra troubles :-(                                                                  
+        FoundLength =0;
+   } 
+           
    Entry->SetUsableLength(FoundLength);
 }