VTK
vtkXMLDataParser.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkXMLDataParser.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
29 #ifndef vtkXMLDataParser_h
30 #define vtkXMLDataParser_h
31 
32 #include "vtkIOXMLParserModule.h" // For export macro
33 #include "vtkXMLParser.h"
34 #include "vtkXMLDataElement.h"//For inline definition.
35 
36 class vtkInputStream;
37 class vtkDataCompressor;
38 
39 class VTKIOXMLPARSER_EXPORT vtkXMLDataParser : public vtkXMLParser
40 {
41 public:
43  void PrintSelf(ostream& os, vtkIndent indent);
44  static vtkXMLDataParser* New();
45 
50 
54  enum { BigEndian, LittleEndian };
55 
60  size_t ReadInlineData(vtkXMLDataElement* element, int isAscii,
61  void* buffer, vtkTypeUInt64 startWord,
62  size_t numWords, int wordType);
63  size_t ReadInlineData(vtkXMLDataElement* element, int isAscii,
64  char* buffer, vtkTypeUInt64 startWord,
65  size_t numWords)
66  { return this->ReadInlineData(element, isAscii, buffer, startWord,
67  numWords, VTK_CHAR); }
68 
73  size_t ReadAppendedData(vtkTypeInt64 offset, void* buffer,
74  vtkTypeUInt64 startWord,
75  size_t numWords, int wordType);
76  size_t ReadAppendedData(vtkTypeInt64 offset, char* buffer,
77  vtkTypeUInt64 startWord,
78  size_t numWords)
79  { return this->ReadAppendedData(offset, buffer, startWord, numWords,
80  VTK_CHAR); }
81 
86  size_t ReadAsciiData(void* buffer, vtkTypeUInt64 startWord,
87  size_t numWords, int wordType);
88 
93  size_t ReadBinaryData(void* buffer, vtkTypeUInt64 startWord,
94  size_t maxWords, int wordType);
95 
97 
102  vtkGetObjectMacro(Compressor, vtkDataCompressor);
104 
108  size_t GetWordTypeSize(int wordType);
109 
114  virtual int Parse();
115 
117 
121  vtkGetMacro(Abort, int);
122  vtkSetMacro(Abort, int);
124 
126 
130  vtkGetMacro(Progress, float);
131  vtkSetMacro(Progress, float);
133 
135 
143  vtkSetClampMacro(AttributesEncoding,int,VTK_ENCODING_NONE,VTK_ENCODING_UNKNOWN);
144  vtkGetMacro(AttributesEncoding, int);
146 
153  virtual void CharacterDataHandler(const char* data, int length);
154 
159  vtkTypeInt64 GetAppendedDataPosition()
160  {
161  return this->AppendedDataPosition;
162  }
163 
164 protected:
167 
168  // This parser does not support parsing from a string.
169  virtual int Parse(const char*);
170  virtual int Parse(const char*, unsigned int);
171 
172  // Implement parsing methods.
173  virtual void StartElement(const char* name, const char** atts);
174  virtual void EndElement(const char*);
175 
179  int ParseBuffer(const char* buffer, unsigned int count);
180 
185  void PerformByteSwap(void* data, size_t numWords, size_t wordSize);
186 
187  // Data reading methods.
189  size_t FindBlockSize(vtkTypeUInt64 block);
190  int ReadBlock(vtkTypeUInt64 block, unsigned char* buffer);
191  unsigned char* ReadBlock(vtkTypeUInt64 block);
192  size_t ReadUncompressedData(unsigned char* data,
193  vtkTypeUInt64 startWord,
194  size_t numWords,
195  size_t wordSize);
196  size_t ReadCompressedData(unsigned char* data,
197  vtkTypeUInt64 startWord,
198  size_t numWords,
199  size_t wordSize);
200 
201  // Go to the start of the inline data
203 
204  // Ascii data reading methods.
205  int ParseAsciiData(int wordType);
207 
208  // Progress update methods.
210 
211  // The root XML element.
213 
214  // The stack of elements currently being parsed.
216  unsigned int NumberOfOpenElements;
217  unsigned int OpenElementsSize;
218 
219  // The position of the appended data section, if found.
220  vtkTypeInt64 AppendedDataPosition;
221 
222  // How much of the string "<AppendedData" has been matched in input.
224 
225  // The byte order of the binary input.
227 
228  // The word type of binary input headers.
230 
231  // The input stream used to read data. Set by ReadAppendedData and
232  // ReadInlineData methods.
234 
235  // The input stream used to read inline data. May transparently
236  // decode the data.
238 
239  // The stream to use for appended data.
241 
242  // Decompression data.
248  vtkTypeInt64* BlockStartOffsets;
249 
250  // Ascii data parsing.
251  unsigned char* AsciiDataBuffer;
254  vtkTypeInt64 AsciiDataPosition;
255 
256  // Progress during reading of data.
257  float Progress;
258 
259  // Abort flag checked during reading of data.
260  int Abort;
261 
263 
264 private:
265  vtkXMLDataParser(const vtkXMLDataParser&) VTK_DELETE_FUNCTION;
266  void operator=(const vtkXMLDataParser&) VTK_DELETE_FUNCTION;
267 };
268 
269 //----------------------------------------------------------------------------
270 inline
272 {
273  const unsigned int eid=this->NumberOfOpenElements-1;
275 }
276 
277 
278 #endif
vtkXMLDataParser::Parse
virtual int Parse()
Parse the XML input and check that the file is safe to read.
vtkXMLDataParser::PushOpenElement
void PushOpenElement(vtkXMLDataElement *element)
vtkXMLDataParser::CheckPrimaryAttributes
int CheckPrimaryAttributes()
vtkXMLParser
Parse XML to handle element tags and attributes.
Definition: vtkXMLParser.h:43
vtkXMLDataParser::ReadCompressedData
size_t ReadCompressedData(unsigned char *data, vtkTypeUInt64 startWord, size_t numWords, size_t wordSize)
vtkXMLDataParser::AppendedDataPosition
vtkTypeInt64 AppendedDataPosition
Definition: vtkXMLDataParser.h:220
vtkXMLDataParser::Parse
virtual int Parse(const char *, unsigned int)
vtkX3D::data
@ data
Definition: vtkX3D.h:315
vtkXMLDataParser::DataStream
vtkInputStream * DataStream
Definition: vtkXMLDataParser.h:233
VTK_ENCODING_NONE
#define VTK_ENCODING_NONE
Definition: vtkSystemIncludes.h:141
vtkXMLDataParser::PartialLastBlockUncompressedSize
size_t PartialLastBlockUncompressedSize
Definition: vtkXMLDataParser.h:246
vtkXMLDataParser::FindAppendedDataPosition
void FindAppendedDataPosition()
vtkXMLDataParser::ReadUncompressedData
size_t ReadUncompressedData(unsigned char *data, vtkTypeUInt64 startWord, size_t numWords, size_t wordSize)
vtkXMLDataParser::BlockUncompressedSize
size_t BlockUncompressedSize
Definition: vtkXMLDataParser.h:245
vtkXMLDataParser::HeaderType
int HeaderType
Definition: vtkXMLDataParser.h:229
vtkXMLDataParser::BlockStartOffsets
vtkTypeInt64 * BlockStartOffsets
Definition: vtkXMLDataParser.h:248
vtkXMLDataParser::AsciiDataBufferLength
size_t AsciiDataBufferLength
Definition: vtkXMLDataParser.h:252
vtkXMLDataParser::ReadBlock
unsigned char * ReadBlock(vtkTypeUInt64 block)
vtkXMLDataParser::AsciiDataPosition
vtkTypeInt64 AsciiDataPosition
Definition: vtkXMLDataParser.h:254
vtkXMLDataParser::GetRootElement
vtkXMLDataElement * GetRootElement()
Get the root element from the XML document.
vtkXMLDataParser::EndElement
virtual void EndElement(const char *)
vtkXMLDataParser::GetAppendedDataPosition
vtkTypeInt64 GetAppendedDataPosition()
Returns the byte index of where appended data starts (if the file is using appended data).
Definition: vtkXMLDataParser.h:159
vtkXMLDataParser::ReadBlock
int ReadBlock(vtkTypeUInt64 block, unsigned char *buffer)
vtkXMLDataParser::OpenElements
vtkXMLDataElement ** OpenElements
Definition: vtkXMLDataParser.h:215
vtkXMLDataParser::NumberOfBlocks
size_t NumberOfBlocks
Definition: vtkXMLDataParser.h:244
vtkXMLParser.h
vtkX3D::length
@ length
Definition: vtkX3D.h:393
vtkXMLDataParser::GetWordTypeSize
size_t GetWordTypeSize(int wordType)
Get the size of a word of the given type.
vtkXMLDataParser::OpenElementsSize
unsigned int OpenElementsSize
Definition: vtkXMLDataParser.h:217
vtkXMLDataParser::InlineDataStream
vtkInputStream * InlineDataStream
Definition: vtkXMLDataParser.h:237
vtkXMLDataParser::ParseAsciiData
int ParseAsciiData(int wordType)
vtkXMLDataParser::ReadAppendedData
size_t ReadAppendedData(vtkTypeInt64 offset, char *buffer, vtkTypeUInt64 startWord, size_t numWords)
Definition: vtkXMLDataParser.h:76
vtkXMLDataParser::ReadCompressionHeader
int ReadCompressionHeader()
vtkXMLDataParser::ParsingComplete
int ParsingComplete()
vtkXMLDataParser::PopOpenElement
vtkXMLDataElement * PopOpenElement()
vtkXMLDataParser::FreeAsciiBuffer
void FreeAsciiBuffer()
vtkXMLDataParser::PerformByteSwap
void PerformByteSwap(void *data, size_t numWords, size_t wordSize)
vtkXMLDataElement::AddCharacterData
void AddCharacterData(const char *c, size_t length)
Definition: vtkXMLDataElement.h:350
vtkXMLDataParser::RootElement
vtkXMLDataElement * RootElement
Definition: vtkXMLDataParser.h:212
vtkXMLDataParser::ReadBinaryData
size_t ReadBinaryData(void *buffer, vtkTypeUInt64 startWord, size_t maxWords, int wordType)
Read from a data section starting at the current position in the stream.
vtkXMLDataElement.h
vtkXMLDataParser::AddElement
void AddElement(vtkXMLDataElement *element)
vtkXMLDataParser::ReadInlineData
size_t ReadInlineData(vtkXMLDataElement *element, int isAscii, void *buffer, vtkTypeUInt64 startWord, size_t numWords, int wordType)
Read inline data from inside the given element.
vtkXMLDataParser::AppendedDataMatched
int AppendedDataMatched
Definition: vtkXMLDataParser.h:223
vtkX3D::offset
@ offset
Definition: vtkX3D.h:438
vtkXMLDataParser::SetCompressor
virtual void SetCompressor(vtkDataCompressor *)
Get/Set the compressor used to decompress binary and appended data after reading from the file.
vtkXMLDataParser::ByteOrder
int ByteOrder
Definition: vtkXMLDataParser.h:226
vtkXMLDataParser::Progress
float Progress
Definition: vtkXMLDataParser.h:257
VTK_CHAR
#define VTK_CHAR
Definition: vtkType.h:49
vtkXMLDataParser::SeekInlineDataPosition
void SeekInlineDataPosition(vtkXMLDataElement *element)
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkXMLDataParser::AppendedDataStream
vtkInputStream * AppendedDataStream
Definition: vtkXMLDataParser.h:240
vtkXMLDataParser::ParseBuffer
int ParseBuffer(const char *buffer, unsigned int count)
vtkDataCompressor
Abstract interface for data compression classes.
Definition: vtkDataCompressor.h:34
vtkXMLDataParser::vtkXMLDataParser
vtkXMLDataParser()
vtkXMLDataElement
Represents an XML element and those nested inside.
Definition: vtkXMLDataElement.h:37
vtkXMLDataParser::AsciiDataWordType
int AsciiDataWordType
Definition: vtkXMLDataParser.h:253
vtkXMLDataParser::ReadAsciiData
size_t ReadAsciiData(void *buffer, vtkTypeUInt64 startWord, size_t numWords, int wordType)
Read from an ascii data section starting at the current position in the stream.
vtkX3D::name
@ name
Definition: vtkX3D.h:219
vtkXMLDataParser::AsciiDataBuffer
unsigned char * AsciiDataBuffer
Definition: vtkXMLDataParser.h:251
vtkXMLDataParser::BlockCompressedSizes
size_t * BlockCompressedSizes
Definition: vtkXMLDataParser.h:247
vtkXMLDataParser::StartElement
virtual void StartElement(const char *name, const char **atts)
vtkSetMacro
vtkSetMacro(IgnoreDriverBugs, bool)
Updates the extensions string.
vtkXMLDataParser::~vtkXMLDataParser
~vtkXMLDataParser()
vtkXMLDataParser::CharacterDataHandler
virtual void CharacterDataHandler(const char *data, int length)
If you need the text inside XMLElements, turn IgnoreCharacterData off.
Definition: vtkXMLDataParser.h:271
vtkXMLDataParser::Compressor
vtkDataCompressor * Compressor
Definition: vtkXMLDataParser.h:243
vtkXMLDataParser::FreeAllElements
void FreeAllElements()
VTK_ENCODING_UNKNOWN
#define VTK_ENCODING_UNKNOWN
Definition: vtkSystemIncludes.h:161
vtkXMLDataParser::ReadInlineData
size_t ReadInlineData(vtkXMLDataElement *element, int isAscii, char *buffer, vtkTypeUInt64 startWord, size_t numWords)
Definition: vtkXMLDataParser.h:63
vtkXMLDataParser::New
static vtkXMLDataParser * New()
vtkX3D::progress
@ progress
Definition: vtkX3D.h:452
vtkXMLDataParser::NumberOfOpenElements
unsigned int NumberOfOpenElements
Definition: vtkXMLDataParser.h:216
vtkXMLDataParser::Parse
virtual int Parse(const char *)
Parse the XML message.
vtkXMLDataParser::Abort
int Abort
Definition: vtkXMLDataParser.h:260
vtkInputStream
Wraps a binary input stream with a VTK interface.
Definition: vtkInputStream.h:34
vtkXMLDataParser::AttributesEncoding
int AttributesEncoding
Definition: vtkXMLDataParser.h:262
vtkXMLParser::CharacterDataHandler
virtual void CharacterDataHandler(const char *data, int length)
vtkXMLDataParser::FindBlockSize
size_t FindBlockSize(vtkTypeUInt64 block)
vtkXMLDataParser::UpdateProgress
void UpdateProgress(float progress)
vtkXMLDataParser::ReadAppendedData
size_t ReadAppendedData(vtkTypeInt64 offset, void *buffer, vtkTypeUInt64 startWord, size_t numWords, int wordType)
Read from an appended data section starting at the given appended data offset.
vtkXMLDataParser
Used by vtkXMLReader to parse VTK XML files.
Definition: vtkXMLDataParser.h:40
vtkXMLDataParser::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.