ENH: Try to sync gdcm CVS and gdcm 1.2. ~2000 lines of changes, please be gentle...

[gdcm.git] / src / gdcmDocument.h

diff --git a/src/gdcmDocument.h b/src/gdcmDocument.h
index 764160abd78ea4107850652c5ae9cfa84089a28d..841bd685b15d8968bd0a1e9423d30054afcf551d 100644 (file)
--- a/src/gdcmDocument.h
+++ b/src/gdcmDocument.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocument.h,v $
   Language:  C++
-  Date:      $Date: 2005/10/18 12:58:28 $
-  Version:   $Revision: 1.125 $
+  Date:      $Date: 2006/02/16 20:06:14 $
+  Version:   $Revision: 1.140 $
  
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -23,6 +23,8 @@
 #include "gdcmDict.h"
 #include "gdcmElementSet.h"
 #include "gdcmException.h"
+#include "gdcmDebug.h"  // for LEGACY
+#include "gdcmCommandManager.h"
 
 #include <map>
 #include <list>
@@ -39,13 +41,16 @@ class Dict;
  */
 class GDCM_EXPORT Document : public ElementSet
 {
-public:
+   gdcmTypeMacro(Document);
 
-typedef std::list<Element> ListElements;
+public:
+   typedef std::list<DicomElement> ListElements;
 
 // Loading
    //Deprecated : use SetFileName() + Load()
+#ifndef GDCM_LEGACY_REMOVE 
    virtual bool Load( std::string const &filename ); 
+#endif
    virtual bool Load( ); 
 
 // Dictionaries
@@ -55,6 +60,7 @@ typedef std::list<Element> ListElements;
    bool SetShaDict(DictKey const &dictName);
 
 // Informations contained in the gdcm::Document
+   bool IsParsable();
    virtual bool IsReadable();
    bool IsDicomV3();
    bool IsPapyrus();
@@ -66,15 +72,6 @@ typedef std::list<Element> ListElements;
 // Swap code
    /// 'Swap code' accessor (see \ref SwapCode )
    int GetSwapCode() { return SwapCode; }
-   // System access (meaning endian related !?)
-   uint16_t SwapShort(uint16_t);
-   uint32_t SwapLong(uint32_t);
-   /// \brief  Unswaps back the bytes of 2-bytes long integer 
-   ///         so they agree with the processor order.
-   uint16_t UnswapShort(uint16_t a) { return SwapShort(a);}
-   /// \brief  Unswaps back the bytes of 4-byte long integer 
-   ///         so they agree with the processor order.
-   uint32_t UnswapLong(uint32_t a) { return SwapLong(a);}
    
 // File I/O
    /// Accessor to \ref Filename
@@ -88,11 +85,11 @@ typedef std::list<Element> ListElements;
    bool CloseFile();
    void WriteContent( std::ofstream *fp, FileType type );
 
-// Content entries
+// Data entries
    virtual void LoadEntryBinArea(uint16_t group, uint16_t elem);
    virtual void LoadEntryBinArea(DataEntry *entry);
 
-   void LoadDocEntrySafe(DocEntry *entry);
+   void SetMaxSizeLoadEntry(long);
    void AddForceLoadElement(uint16_t group, uint16_t elem);
  
 // Ordering of Documents
@@ -117,10 +114,16 @@ protected:
    // gdcm::DicomDir are meaningfull).
    Document();
    virtual ~Document();
-   
+
+   virtual void CallStartMethod();
+   virtual void CallProgressMethod();
+   virtual void CallEndMethod();
+      
    uint16_t ReadInt16() throw ( FormatError );
    uint32_t ReadInt32() throw ( FormatError );
-   void     SkipBytes(uint32_t);
+   
+   /// \brief skips bytes inside the source file
+   void     SkipBytes(uint32_t nBytes) { Fp->seekg((long)nBytes, std::ios::cur);} 
    int ComputeGroup0002Length( );
 
 // Variables
@@ -183,6 +186,18 @@ private:
 // Methods
    void Initialize();
    bool DoTheLoadingDocumentJob();
+     
+      // System access (meaning endian related !?)
+   uint16_t SwapShort(uint16_t);
+   uint32_t SwapLong(uint32_t);
+   double SwapDouble(double);
+   /// \brief  Unswaps back the bytes of 2-bytes long integer 
+   ///         so they agree with the processor order.
+   uint16_t UnswapShort(uint16_t a) { return SwapShort(a);}
+   /// \brief  Unswaps back the bytes of 4-byte long integer 
+   ///         so they agree with the processor order.
+   uint32_t UnswapLong(uint32_t a) { return SwapLong(a);}
+   
    // Read
    void ParseDES(DocEntrySet *set, long offset, long l_max, bool delim_mode);
    void ParseSQ (SeqEntry *seq,    long offset, long l_max, bool delim_mode);
@@ -201,7 +216,6 @@ private:
 
    bool CheckSwap();
    void SwitchByteSwapCode();
-   void SetMaxSizeLoadEntry(long);
 
    // DocEntry related utilities
    DocEntry *ReadNextDocEntry();
@@ -211,6 +225,11 @@ private:
    DocEntry *Backtrack(DocEntry *docEntry);
 
 // Variables
+protected:
+   /// value of the ??? for any progress bar
+   float Progress;
+   mutable bool Abort;
+   
    /// Public dictionary used to parse this header
    Dict *RefPubDict;
    /// \brief Optional "shadow dictionary" (private elements) used to parse
@@ -222,7 +241,12 @@ private:
    /// this upper bound is fixed to 1024 bytes (which might look reasonable
    /// when one considers the definition of the various VR contents).
    uint32_t MaxSizeLoadEntry;
-   
+
+   /// \brief to allow any inner method to know current tag Group number 
+   uint16_t CurrentGroup;
+   /// \brief to allow any inner method to know current tag Element number 
+   uint16_t CurrentElem; 
+     
 //  uint32_t GenerateFreeTagKeyInGroup(uint16_t group);
 //  void BuildFlatHashTableRecurse( TagDocEntryHT &builtHT,
 //                                  DocEntrySet *set );