]> Creatis software - gdcm.git/blobdiff - src/gdcmDocument.cxx
ENH: Improve string manipulation. I now inforce the notion of 'DicomString'
[gdcm.git] / src / gdcmDocument.cxx
index 2f0f843a333b40a1007b8c9fc55a6e2184d2a187..bdf5a01c5f34398caf8704dc5d1d328b7844394e 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocument.cxx,v $
   Language:  C++
-  Date:      $Date: 2004/10/22 04:13:25 $
-  Version:   $Revision: 1.109 $
+  Date:      $Date: 2004/11/05 20:23:14 $
+  Version:   $Revision: 1.117 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -84,8 +84,7 @@ const unsigned int Document::MAX_SIZE_PRINT_ELEMENT_VALUE = 0x7fffffff;
  * \brief   constructor  
  * @param   filename file to be opened for parsing
  */
-Document::Document( std::string const & filename ) 
-              : ElementSet(-1)
+Document::Document( std::string const & filename ) : ElementSet(-1)
 {
    SetMaxSizeLoadEntry(MAX_SIZE_LOAD_ELEMENT_VALUE); 
    Filename = filename;
@@ -180,8 +179,7 @@ Document::Document( std::string const & filename )
  * \brief This default constructor doesn't parse the file. You should
  *        then invoke \ref Document::SetFileName and then the parsing.
  */
-Document::Document() 
-             :ElementSet(-1)
+Document::Document() : ElementSet(-1)
 {
    SetMaxSizeLoadEntry(MAX_SIZE_LOAD_ELEMENT_VALUE);
    Initialise();
@@ -478,7 +476,8 @@ void Document::Write(std::ofstream* fp, FileType filetype)
 
    if (filetype == ImplicitVR) 
    {
-      std::string ts = TransferSyntaxStrings[ImplicitVRLittleEndian];
+      std::string ts = 
+         Util::DicomString( TransferSyntaxStrings[ImplicitVRLittleEndian] );
       ReplaceOrCreateByNumber(ts, 0x0002, 0x0010);
       
       /// \todo Refer to standards on page 21, chapter 6.2
@@ -491,7 +490,8 @@ void Document::Write(std::ofstream* fp, FileType filetype)
 
    if (filetype == ExplicitVR)
    {
-      std::string ts = TransferSyntaxStrings[ExplicitVRLittleEndian];
+      std::string ts = 
+         Util::DicomString( TransferSyntaxStrings[ExplicitVRLittleEndian] );
       ReplaceOrCreateByNumber(ts, 0x0002, 0x0010);
       
       /// \todo Refer to standards on page 21, chapter 6.2
@@ -532,7 +532,7 @@ ValEntry* Document::ReplaceOrCreateByNumber(
                                          std::string const & value, 
                                          uint16_t group, 
                                          uint16_t elem,
-                                         std::string const & VR )
+                                         TagName const & vr )
 {
    ValEntry* valEntry = 0;
    DocEntry* currentEntry = GetDocEntryByNumber( group, elem);
@@ -548,7 +548,7 @@ ValEntry* Document::ReplaceOrCreateByNumber(
       DictEntry* dictEntry = pubDict->GetDictEntryByNumber(group, elem);
       if (!dictEntry)
       {
-         currentEntry = NewDocEntryByNumber(group, elem,VR);
+         currentEntry = NewDocEntryByNumber(group, elem, vr);
       }
       else
       {
@@ -611,7 +611,7 @@ BinEntry* Document::ReplaceOrCreateByNumber(
                                          int lgth, 
                                          uint16_t group, 
                                          uint16_t elem,
-                                         std::string const& VR )
+                                         TagName const & vr )
 {
    BinEntry* binEntry = 0;
    DocEntry* currentEntry = GetDocEntryByNumber( group, elem);
@@ -628,7 +628,7 @@ BinEntry* Document::ReplaceOrCreateByNumber(
 
       if (!dictEntry)
       {
-         currentEntry = NewDocEntryByNumber(group, elem, VR);
+         currentEntry = NewDocEntryByNumber(group, elem, vr);
       }
       else
       {
@@ -685,9 +685,7 @@ BinEntry* Document::ReplaceOrCreateByNumber(
  * \return  pointer to the modified/created SeqEntry (NULL when creation
  *          failed).
  */
-SeqEntry* Document::ReplaceOrCreateByNumber(
-                                         uint16_t group, 
-                                         uint16_t elem)
+SeqEntry* Document::ReplaceOrCreateByNumber( uint16_t group, uint16_t elem)
 {
    SeqEntry* b = 0;
    DocEntry* a = GetDocEntryByNumber( group, elem);
@@ -714,7 +712,7 @@ SeqEntry* Document::ReplaceOrCreateByNumber(
  * \return  boolean 
  */
 bool Document::ReplaceIfExistByNumber(std::string const & value, 
-                                          uint16_t group, uint16_t elem ) 
+                                      uint16_t group, uint16_t elem ) 
 {
    SetEntryByNumber(value, group, elem);
 
@@ -733,7 +731,7 @@ bool Document::ReplaceIfExistByNumber(std::string const & value,
 bool Document::CheckIfEntryExistByNumber(uint16_t group, uint16_t element )
 {
    const std::string &key = DictEntry::TranslateToKey(group, element );
-   return TagHT.count(key);
+   return TagHT.count(key) != 0;
 }
 
 /**
@@ -745,7 +743,7 @@ bool Document::CheckIfEntryExistByNumber(uint16_t group, uint16_t element )
  * @return  Corresponding element value when it exists,
  *          and the string GDCM_UNFOUND ("gdcm::Unfound") otherwise.
  */
-std::string Document::GetEntryByName(TagName const& tagName)
+std::string Document::GetEntryByName(TagName const & tagName)
 {
    DictEntry* dictEntry = RefPubDict->GetDictEntryByName(tagName); 
    if( !dictEntry )
@@ -778,7 +776,7 @@ std::string Document::GetEntryVRByName(TagName const& tagName)
    }
 
    DocEntry* elem = GetDocEntryByNumber(dictEntry->GetGroup(),
-                                            dictEntry->GetElement());
+                                        dictEntry->GetElement());
    return elem->GetVR();
 }
 
@@ -850,7 +848,8 @@ int Document::GetEntryLengthByNumber(uint16_t group, uint16_t element)
  * @param   tagName name of the searched Dicom Element.
  * @return  true when found
  */
-bool Document::SetEntryByName(std::string const & content,std::string const & tagName)
+bool Document::SetEntryByName(std::string const & content,
+                              TagName const & tagName)
 {
    DictEntry *dictEntry = RefPubDict->GetDictEntryByName(tagName); 
    if( !dictEntry )
@@ -871,8 +870,7 @@ bool Document::SetEntryByName(std::string const & content,std::string const & ta
  * @param   element element number of the Dicom Element to modify
  */
 bool Document::SetEntryByNumber(std::string const& content, 
-                                    uint16_t group,
-                                    uint16_t element) 
+                                uint16_t group, uint16_t element) 
 {
    int c;
    int l;
@@ -885,13 +883,10 @@ bool Document::SetEntryByNumber(std::string const& content,
       return false;
    }
    // Non even content must be padded with a space (020H)...
-   std::string finalContent = content;
-   if( finalContent.length() % 2 )
-   {
-      finalContent += '\0';  // ... therefore we padd with (000H) .!?!
-   }      
+   std::string finalContent = Util::DicomString( content.c_str() );
+   assert( !(finalContent.size() % 2) );
    valEntry->SetValue(finalContent);
-   
+
    // Integers have a special treatement for their length:
 
    l = finalContent.length();
@@ -924,10 +919,8 @@ bool Document::SetEntryByNumber(std::string const& content,
  * @param   group     group number of the Dicom Element to modify
  * @param   element element number of the Dicom Element to modify
  */
-bool Document::SetEntryByNumber(uint8_t*content,
-                                int lgth, 
-                                uint16_t group,
-                                uint16_t element) 
+bool Document::SetEntryByNumber(uint8_t*content, int lgth, 
+                                uint16_t group, uint16_t element) 
 {
    (void)lgth;  //not used
    TagKey key = DictEntry::TranslateToKey(group, element);
@@ -963,8 +956,7 @@ bool Document::SetEntryByNumber(uint8_t*content,
  * @return  true on success, false otherwise.
  */
 bool Document::SetEntryLengthByNumber(uint32_t l, 
-                                      uint16_t group, 
-                                      uint16_t element) 
+                                      uint16_t group, uint16_t element) 
 {
    /// \todo use map methods, instead of multimap JPR
    TagKey key = DictEntry::TranslateToKey(group, element);
@@ -1093,8 +1085,7 @@ void* Document::LoadEntryBinArea(BinEntry* element)
  * @return  
  */
 bool Document::SetEntryBinAreaByNumber(uint8_t* area,
-                                            uint16_t group, 
-                                            uint16_t element) 
+                                       uint16_t group, uint16_t element) 
 {
    DocEntry* currentEntry = GetDocEntryByNumber(group, element);
    if ( !currentEntry )
@@ -1164,7 +1155,7 @@ void Document::UpdateShaEntries()
  * @return  Corresponding Dicom Element when it exists, and NULL
  *          otherwise.
  */
-DocEntry* Document::GetDocEntryByName(std::string const & tagName)
+DocEntry* Document::GetDocEntryByName(TagName const & tagName)
 {
    DictEntry *dictEntry = RefPubDict->GetDictEntryByName(tagName); 
    if( !dictEntry )
@@ -1185,8 +1176,7 @@ DocEntry* Document::GetDocEntryByName(std::string const & tagName)
  * @param   element Element number of the searched Dicom Element 
  * @return  
  */
-DocEntry* Document::GetDocEntryByNumber(uint16_t group,
-                                                uint16_t element) 
+DocEntry* Document::GetDocEntryByNumber(uint16_t group, uint16_t element) 
 {
    TagKey key = DictEntry::TranslateToKey(group, element);
    if ( !TagHT.count(key))
@@ -1202,8 +1192,7 @@ DocEntry* Document::GetDocEntryByNumber(uint16_t group,
  *         ValEntry.
  * @return When present, the corresponding ValEntry. 
  */
-ValEntry* Document::GetValEntryByNumber(uint16_t group,
-                                                uint16_t element)
+ValEntry* Document::GetValEntryByNumber(uint16_t group, uint16_t element)
 {
    DocEntry* currentEntry = GetDocEntryByNumber(group, element);
    if ( !currentEntry )
@@ -1303,10 +1292,8 @@ uint16_t Document::UnswapShort(uint16_t a)
  * \brief   Parses a DocEntrySet (Zero-level DocEntries or SQ Item DocEntries)
  * @return  length of the parsed set. 
  */ 
-void Document::ParseDES(DocEntrySet *set,
-                        long offset,
-                        long l_max,
-                        bool delim_mode)
+void Document::ParseDES(DocEntrySet *set, long offset, 
+                        long l_max, bool delim_mode)
 {
    DocEntry *newDocEntry = 0;
    
@@ -1479,7 +1466,7 @@ void Document::ParseDES(DocEntrySet *set,
  * @return  parsed length for this level
  */ 
 void Document::ParseSQ( SeqEntry* seqEntry,
-                            long offset, long l_max, bool delim_mode)
+                        long offset, long l_max, bool delim_mode)
 {
    int SQItemNumber = 0;
    bool dlm_mod;
@@ -1598,7 +1585,8 @@ void Document::LoadDocEntry(DocEntry* entry)
       }
 
       // to be sure we are at the end of the value ...
-      Fp->seekg((long)entry->GetOffset()+(long)entry->GetLength(),std::ios_base::beg);
+      Fp->seekg((long)entry->GetOffset()+(long)entry->GetLength(),
+                std::ios_base::beg);
       return;
    }
 
@@ -1660,15 +1648,28 @@ void Document::LoadDocEntry(DocEntry* entry)
       return;
    }
    
-   // We need an additional byte for storing \0 that is not on disk
+  // FIXME: We need an additional byte for storing \0 that is not on disk
    char *str = new char[length+1];
    Fp->read(str, (size_t)length);
-   str[length] = '\0';
-   std::string newValue = str;
+   str[length] = '\0'; //this is only useful when length is odd
+   // Special DicomString call to properly handle \0 and even length
+   std::string newValue;
+   if( length % 2 )
+   {
+      newValue = Util::DicomString(str, length+1);
+      //dbg.Verbose(0, "Warning: bad length: ", length );
+      dbg.Verbose(0, "For string :",  newValue.c_str()); 
+      // Since we change the length of string update it length
+      entry->SetReadLength(length+1);
+   }
+   else
+   {
+      newValue = Util::DicomString(str, length);
+   }
    delete[] str;
 
    if ( ValEntry* valEntry = dynamic_cast<ValEntry* >(entry) )
-   {  
+   {
       if ( Fp->fail() || Fp->eof())//Fp->gcount() == 1
       {
          dbg.Verbose(1, "Document::LoadDocEntry",
@@ -2110,7 +2111,7 @@ void Document::SkipToNextDocEntry(DocEntry *entry)
  * @param   foundLength fist assumption about length    
  */
 void Document::FixDocEntryFoundLength(DocEntry *entry,
-                                          uint32_t foundLength)
+                                      uint32_t foundLength)
 {
    entry->SetReadLength( foundLength ); // will be updated only if a bug is found        
    if ( foundLength == 0xffffffff)
@@ -2192,7 +2193,7 @@ bool Document::IsDocEntryAnInteger(DocEntry *entry)
 {
    uint16_t element = entry->GetElement();
    uint16_t group   = entry->GetGroup();
-   std::string  vr  = entry->GetVR();
+   const std::string & vr  = entry->GetVR();
    uint32_t length  = entry->GetLength();
 
    // When we have some semantics on the element we just read, and if we
@@ -2304,7 +2305,7 @@ uint16_t Document::ReadInt16()
    Fp->read ((char*)&g, (size_t)2);
    if ( Fp->fail() )
    {
-          throw FormatError( "Document::ReadInt16()", " file error." );
+      throw FormatError( "Document::ReadInt16()", " file error." );
    }
    if( Fp->eof() )
    {
@@ -2697,8 +2698,18 @@ bool Document::ReadTag(uint16_t testGroup, uint16_t testElement)
 
    //// Read the Item Tag group and element, and make
    // sure they are what we expected:
-   uint16_t itemTagGroup   = ReadInt16();
-   uint16_t itemTagElement = ReadInt16();
+   uint16_t itemTagGroup;
+   uint16_t itemTagElement;
+   try
+   {
+      itemTagGroup   = ReadInt16();
+      itemTagElement = ReadInt16();
+   }
+   catch ( FormatError e )
+   {
+      //std::cerr << e << std::endl;
+      return false;
+   }
    if ( itemTagGroup != testGroup || itemTagElement != testElement )
    {
       std::ostringstream s;
@@ -2838,6 +2849,11 @@ void Document::ComputeRLEInfo()
       long frameOffset = Fp->tellg();
 
       uint32_t nbRleSegments = ReadInt32();
+      if ( nbRleSegments > 16 )
+      {
+         // There should be at most 15 segments (refer to RLEFrame class)
+         dbg.Verbose(0, "Document::ComputeRLEInfo: too many segments.");
+      }
  
       uint32_t rleSegmentOffsetTable[15];
       for( int k = 1; k <= 15; k++ )
@@ -2935,19 +2951,19 @@ void Document::ComputeJPEGFragmentInfo()
  * @param set The structure to be traversed (recursively).
  */
 void Document::BuildFlatHashTableRecurse( TagDocEntryHT& builtHT,
-                                              DocEntrySet* set )
+                                          DocEntrySet* set )
 { 
    if (ElementSet* elementSet = dynamic_cast< ElementSet* > ( set ) )
    {
-      TagDocEntryHT* currentHT = elementSet->GetTagHT();
-      for( TagDocEntryHT::const_iterator i  = currentHT->begin();
-                                         i != currentHT->end();
+      TagDocEntryHT const & currentHT = elementSet->GetTagHT();
+      for( TagDocEntryHT::const_iterator i  = currentHT.begin();
+                                         i != currentHT.end();
                                        ++i)
       {
          DocEntry* entry = i->second;
          if ( SeqEntry* seqEntry = dynamic_cast<SeqEntry*>(entry) )
          {
-            ListSQItem& items = seqEntry->GetSQItems();
+            const ListSQItem& items = seqEntry->GetSQItems();
             for( ListSQItem::const_iterator item  = items.begin();
                                             item != items.end();
                                           ++item)
@@ -2963,15 +2979,15 @@ void Document::BuildFlatHashTableRecurse( TagDocEntryHT& builtHT,
 
    if (SQItem* SQItemSet = dynamic_cast< SQItem* > ( set ) )
    {
-      ListDocEntry& currentList = SQItemSet->GetDocEntries();
-      for (ListDocEntry::iterator i  = currentList.begin();
-                                  i != currentList.end();
-                                ++i)
+      const ListDocEntry& currentList = SQItemSet->GetDocEntries();
+      for (ListDocEntry::const_iterator i  = currentList.begin();
+                                        i != currentList.end();
+                                      ++i)
       {
          DocEntry* entry = *i;
          if ( SeqEntry* seqEntry = dynamic_cast<SeqEntry*>(entry) )
          {
-            ListSQItem& items = seqEntry->GetSQItems();
+            const ListSQItem& items = seqEntry->GetSQItems();
             for( ListSQItem::const_iterator item  = items.begin();
                                             item != items.end();
                                           ++item)