vtkXMLParser.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkXMLParser_h
#define vtkXMLParser_h
 
#include "vtkIOXMLParserModule.h" // For export macro
#include "vtkObject.h"
 
VTK_ABI_NAMESPACE_BEGIN
void vtkXMLParserStartElement(void*, const char*, const char**);
void vtkXMLParserEndElement(void*, const char*);
void vtkXMLParserCharacterDataHandler(void*, const char*, int);
 
class VTKIOXMLPARSER_EXPORT vtkXMLParser : public vtkObject
{
public:
  vtkTypeMacro(vtkXMLParser, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  static vtkXMLParser* New();
 
 
  vtkSetMacro(Stream, istream*);
  vtkGetMacro(Stream, istream*);
 
 
  vtkTypeInt64 TellG();
  void SeekG(vtkTypeInt64 position);
 
  virtual int Parse();
 
 
  virtual int Parse(const char* inputString);
  virtual int Parse(const char* inputString, unsigned int length);
 
 
  virtual int InitializeParser();
  virtual int ParseChunk(const char* inputString, unsigned int length);
  virtual int CleanupParser();
 
 
  vtkSetFilePathMacro(FileName);
  vtkGetFilePathMacro(FileName);
 
 
  vtkSetMacro(IgnoreCharacterData, vtkTypeBool);
  vtkGetMacro(IgnoreCharacterData, vtkTypeBool);
 
 
  vtkSetStringMacro(Encoding);
  vtkGetStringMacro(Encoding);
 
  static bool hasLargeOffsets();
 
protected:
  vtkXMLParser();
  ~vtkXMLParser() override;
 
  // Input stream.  Set by user.
  istream* Stream;
 
  // File name to parse
  char* FileName;
 
  // Encoding
  char* Encoding;
 
  // This variable is true if there was a parse error while parsing in
  // chunks.
  int ParseError;
 
  // Character message to parse
  const char* InputString;
  int InputStringLength;
 
  // Expat parser structure.  Exists only during call to Parse().
  void* Parser;
 
  // Create/Allocate the internal parser (can be overridden by subclasses).
  virtual int CreateParser();
 
  // Called by Parse() to read the stream and call ParseBuffer.  Can
  // be replaced by subclasses to change how input is read.
  virtual int ParseXML();
 
  // Called before each block of input is read from the stream to
  // check if parsing is complete.  Can be replaced by subclasses to
  // change the terminating condition for parsing.  Parsing always
  // stops when the end of file is reached in the stream.
  virtual int ParsingComplete();
 
  // Called when a new element is opened in the XML source.  Should be
  // replaced by subclasses to handle each element.
  //  name = Name of new element.
  //  atts = Null-terminated array of attribute name/value pairs.
  //         Even indices are attribute names, and odd indices are values.
  virtual void StartElement(const char* name, const char** atts);
 
  // Called at the end of an element in the XML source opened when
  // StartElement was called.
  virtual void EndElement(const char* name);
 
  // Called when there is character data to handle.
  virtual void CharacterDataHandler(const char* data, int length);
 
  // Called by begin handlers to report any stray attribute values.
  virtual void ReportStrayAttribute(const char* element, const char* attr, const char* value);
 
  // Called by begin handlers to report any missing attribute values.
  virtual void ReportMissingAttribute(const char* element, const char* attr);
 
  // Called by begin handlers to report bad attribute values.
  virtual void ReportBadAttribute(const char* element, const char* attr, const char* value);
 
  // Called by StartElement to report unknown element type.
  virtual void ReportUnknownElement(const char* element);
 
  // Called by Parse to report an XML syntax error.
  virtual void ReportXmlParseError();
 
  // Get the current byte index from the beginning of the XML stream.
  vtkTypeInt64 GetXMLByteIndex();
 
  // Send the given buffer to the XML parser.
  virtual int ParseBuffer(const char* buffer, unsigned int count);
 
  // Send the given c-style string to the XML parser.
  int ParseBuffer(const char* buffer);
 
  // Utility for convenience of subclasses.  Wraps isspace C library
  // routine.
  static int IsSpace(char c);
 
  friend void vtkXMLParserStartElement(void*, const char*, const char**);
  friend void vtkXMLParserEndElement(void*, const char*);
  friend void vtkXMLParserCharacterDataHandler(void*, const char*, int);
 
  vtkTypeBool IgnoreCharacterData;
 
private:
  vtkXMLParser(const vtkXMLParser&) = delete;
  void operator=(const vtkXMLParser&) = delete;
};
 
//----------------------------------------------------------------------------
inline void vtkXMLParserCharacterDataHandler(void* parser, const char* data, int length)
{
  // Character data handler that is registered with the XML_Parser.
  // This just casts the user data to a vtkXMLParser and calls
  // CharacterDataHandler.
  static_cast<vtkXMLParser*>(parser)->CharacterDataHandler(data, length);
}
 
VTK_ABI_NAMESPACE_END
#endif