]> Creatis software - gdcm.git/blob - src/gdcmDocument.h
Avoid warnings
[gdcm.git] / src / gdcmDocument.h
1 /*=========================================================================
2  
3   Program:   gdcm
4   Module:    $RCSfile: gdcmDocument.h,v $
5   Language:  C++
6   Date:      $Date: 2005/11/29 17:21:34 $
7   Version:   $Revision: 1.137 $
8  
9   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
10   l'Image). All rights reserved. See Doc/License.txt or
11   http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
12  
13      This software is distributed WITHOUT ANY WARRANTY; without even
14      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15      PURPOSE.  See the above copyright notices for more information.
16  
17 =========================================================================*/
18
19 #ifndef GDCMDOCUMENT_H
20 #define GDCMDOCUMENT_H
21
22 #include "gdcmVR.h"
23 #include "gdcmDict.h"
24 #include "gdcmElementSet.h"
25 #include "gdcmException.h"
26 #include "gdcmDebug.h"  // for LEGACY
27 #include "gdcmCommandManager.h"
28
29 #include <map>
30 #include <list>
31 #include <fstream>
32
33 namespace gdcm 
34 {
35 class SeqEntry;
36 class Dict;
37
38 //-----------------------------------------------------------------------------
39 /**
40  * \brief Derived by both gdcm::File and gdcm::DicomDir
41  */
42 class GDCM_EXPORT Document : public ElementSet
43 {
44    gdcmTypeMacro(Document);
45
46 public:
47    typedef std::list<DicomElement> ListElements;
48
49 // Loading
50    //Deprecated : use SetFileName() + Load()
51    //GDCM_LEGACY(  virtual bool Load( std::string const &filename )  ); 
52    //virtual bool Load( std::string const &filename );
53    virtual bool Load( ); 
54
55 // Dictionaries
56    Dict *GetPubDict();
57    Dict *GetShaDict();
58    bool SetShaDict(Dict *dict);
59    bool SetShaDict(DictKey const &dictName);
60
61 // Informations contained in the gdcm::Document
62    bool IsParsable();
63    virtual bool IsReadable();
64    bool IsDicomV3();
65    bool IsPapyrus();
66    FileType GetFileType();
67    std::string GetTransferSyntax();
68    /// Return the Transfer Syntax as a string
69    std::string GetTransferSyntaxName();
70
71 // Swap code
72    /// 'Swap code' accessor (see \ref SwapCode )
73    int GetSwapCode() { return SwapCode; }
74    
75 // File I/O
76    /// Accessor to \ref Filename
77    const std::string &GetFileName() const { return Filename; }
78    /// Accessor to \ref Filename
79    virtual void SetFileName(std::string const &fileName) 
80                    { if (Filename != fileName)
81                         Filename = fileName, IsDocumentModified = true; }
82
83    std::ifstream *OpenFile();
84    bool CloseFile();
85    void WriteContent( std::ofstream *fp, FileType type );
86
87 // Content entries
88    virtual void LoadEntryBinArea(uint16_t group, uint16_t elem);
89    virtual void LoadEntryBinArea(DataEntry *entry);
90
91    void LoadDocEntrySafe(DocEntry *entry);
92    void AddForceLoadElement(uint16_t group, uint16_t elem);
93  
94 // Ordering of Documents
95    bool operator<(Document &document);
96
97 /**
98  * \brief Sets the LoadMode as a boolean string. 
99  *        LD_NOSEQ, LD_NOSHADOW, LD_NOSHADOWSEQ
100  ... (nothing more, right now)
101  *        WARNING : before using NO_SHADOW, be sure *all* your files
102  *        contain accurate values in the 0x0000 element (if any) 
103  *        of *each* Shadow Group. The parser will fail if the size is wrong !
104  * @param   mode Load mode to be used    
105  */
106    void SetLoadMode (int mode) { if (LoadMode != mode) 
107                                      LoadMode=mode, IsDocumentModified = true; }
108
109 protected:
110 // Methods
111    // Constructor and destructor are protected to forbid end user 
112    // to instanciate from this class Document (only gdcm::File and
113    // gdcm::DicomDir are meaningfull).
114    Document();
115    virtual ~Document();
116
117    virtual void CallStartMethod();
118    virtual void CallProgressMethod();
119    virtual void CallEndMethod();
120       
121    uint16_t ReadInt16() throw ( FormatError );
122    uint32_t ReadInt32() throw ( FormatError );
123    void     SkipBytes(uint32_t);
124    int ComputeGroup0002Length( );
125
126 // Variables
127    /// Refering underlying filename.
128    std::string Filename;
129
130    /// \brief Swap code gives an information on the byte order of a 
131    ///  supposed to be an int32, as it's read on disc 
132    /// (depending on the image Transfer Syntax *and* on the processor endianess)
133    /// as opposed as it should in memory to be dealt as an int32.
134    /// For instance :
135    /// - a 'Little Endian' image, read with a little endian processor
136    /// will have a SwapCode= 1234 (the order is OK; nothing to do)
137    /// - a 'Little Endian' image, read with a big endian procesor
138    /// will have a SwapCode= 4321 (the order is wrong; int32 an int16 must be
139    /// swapped)
140    /// note : values 2143, 4321, 3412 remain for the ACR-NEMA time, and
141    /// the well known 'Bad Big Endian' and 'Bad Little Endian' codes
142    int SwapCode;
143
144    ///\brief whether we already parsed group 0002 (Meta Elements)
145    bool Group0002Parsed;
146
147    ///\brief whether file has a DCM Preamble
148    bool HasDCMPreamble;
149
150    /// File Pointer, opened during Document parsing.
151    std::ifstream *Fp;
152
153    /// ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown
154    FileType Filetype;  
155
156    /// After opening the file, we read HEADER_LENGTH_TO_READ bytes.
157    static const unsigned int HEADER_LENGTH_TO_READ; 
158    /// \brief Elements whose value is longer than MAX_SIZE_LOAD_ELEMENT_VALUE
159    /// are NOT loaded.
160    static const unsigned int MAX_SIZE_LOAD_ELEMENT_VALUE;
161
162    /// User supplied list of elements to Anonymize
163    ListElements UserAnonymizeList;
164
165    /// User supplied list of elements to force Load
166    ListElements UserForceLoadList;
167
168    /// \brief Bit string integer (each one considered as a boolean)
169    ///        Bit 0 : Skip Sequences,    if possible
170    ///        Bit 1 : Skip Shadow Groups if possible
171    ///        Probabely, some more to add
172    int LoadMode;
173    
174    /// \brief Whether the gdcm::Document is already parsed/loaded :
175    /// False from the creation of the gdcm::Document untill 
176    ///   gdcm::Document:Load()
177    bool IsDocumentAlreadyLoaded; // FIXME : probabely useless now
178
179    /// Whether the gdcm::Document was modified since the last Load()
180    bool IsDocumentModified;
181
182 private:
183 // Methods
184    void Initialize();
185    bool DoTheLoadingDocumentJob(); 
186      
187       // System access (meaning endian related !?)
188    uint16_t SwapShort(uint16_t);
189    uint32_t SwapLong(uint32_t);
190    double SwapDouble(double);
191    /// \brief  Unswaps back the bytes of 2-bytes long integer 
192    ///         so they agree with the processor order.
193    uint16_t UnswapShort(uint16_t a) { return SwapShort(a);}
194    /// \brief  Unswaps back the bytes of 4-byte long integer 
195    ///         so they agree with the processor order.
196    uint32_t UnswapLong(uint32_t a) { return SwapLong(a);}
197    
198    // Read
199    void ParseDES(DocEntrySet *set, long offset, long l_max, bool delim_mode);
200    void ParseSQ (SeqEntry *seq,    long offset, long l_max, bool delim_mode);
201
202    void LoadDocEntry         (DocEntry *e, bool forceLoad = false);
203    void FindDocEntryLength   (DocEntry *e) throw ( FormatError );
204    uint32_t FindDocEntryLengthOBOrOW() throw( FormatUnexpected );
205    VRKey FindDocEntryVR();
206    bool CheckDocEntryVR      (const VRKey &k);
207
208    void SkipDocEntry          (DocEntry *entry);
209    void SkipToNextDocEntry    (DocEntry *entry);
210
211    void FixDocEntryFoundLength(DocEntry *entry, uint32_t l);
212    bool IsDocEntryAnInteger   (DocEntry *entry);
213
214    bool CheckSwap();
215    void SwitchByteSwapCode();
216    void SetMaxSizeLoadEntry(long);
217
218    // DocEntry related utilities
219    DocEntry *ReadNextDocEntry();
220
221    void HandleBrokenEndian  (uint16_t &group, uint16_t &elem);
222    void HandleOutOfGroup0002(uint16_t &group, uint16_t &elem);
223    DocEntry *Backtrack(DocEntry *docEntry);
224
225 // Variables
226 protected:
227    /// value of the ??? for any progress bar
228    float Progress;
229    mutable bool Abort;
230    
231    /// Public dictionary used to parse this header
232    Dict *RefPubDict;
233    /// \brief Optional "shadow dictionary" (private elements) used to parse
234    /// this header
235    Dict *RefShaDict;
236
237    /// \brief Size threshold above which an element value will NOT be loaded
238    /// in memory (to avoid loading the image/volume itself). By default,
239    /// this upper bound is fixed to 1024 bytes (which might look reasonable
240    /// when one considers the definition of the various VR contents).
241    uint32_t MaxSizeLoadEntry;
242
243    /// \brief to allow any inner method to know current tag Group number 
244    uint16_t CurrentGroup;
245    /// \brief to allow any inner method to know current tag Element number 
246    uint16_t CurrentElem; 
247      
248 //  uint32_t GenerateFreeTagKeyInGroup(uint16_t group);
249 //  void BuildFlatHashTableRecurse( TagDocEntryHT &builtHT,
250 //                                  DocEntrySet *set );
251
252 };
253
254 } // end namespace gdcm
255
256 //-----------------------------------------------------------------------------
257 #endif