vtkXMLDataElement.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 vtkXMLDataElement_h
#define vtkXMLDataElement_h
 
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkObject.h"
 
VTK_ABI_NAMESPACE_BEGIN
class vtkXMLDataParser;
 
class VTKCOMMONDATAMODEL_EXPORT vtkXMLDataElement : public vtkObject
{
public:
  vtkTypeMacro(vtkXMLDataElement, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
  static vtkXMLDataElement* New();
 
 
  vtkGetStringMacro(Name);
  virtual void SetName(const char* _arg);
 
 
  vtkGetStringMacro(Id);
  vtkSetStringMacro(Id);
 
  const char* GetAttribute(const char* name);
 
  void SetAttribute(const char* name, const char* value);
 
 
  void SetCharacterData(const char* data, int length);
  void AddCharacterData(const char* c, size_t length);
  vtkGetStringMacro(CharacterData);
 
 
  int GetScalarAttribute(const char* name, int& value);
  int GetScalarAttribute(const char* name, float& value);
  int GetScalarAttribute(const char* name, double& value);
  int GetScalarAttribute(const char* name, long& value);
  int GetScalarAttribute(const char* name, unsigned long& value);
 
 
  void SetIntAttribute(const char* name, int value);
  void SetFloatAttribute(const char* name, float value);
  void SetDoubleAttribute(const char* name, double value);
  void SetUnsignedLongAttribute(const char* name, unsigned long value);
 
 
  int GetVectorAttribute(const char* name, int length, int* value);
  int GetVectorAttribute(const char* name, int length, float* value);
  int GetVectorAttribute(const char* name, int length, double* value);
  int GetVectorAttribute(const char* name, int length, long* value);
  int GetVectorAttribute(const char* name, int length, unsigned long* value);
 
 
  void SetVectorAttribute(const char* name, int length, const int* value);
  void SetVectorAttribute(const char* name, int length, const float* value);
  void SetVectorAttribute(const char* name, int length, const double* value);
  void SetVectorAttribute(const char* name, int length, const unsigned long* value);
 
  int GetScalarAttribute(const char* name, long long& value);
  int GetVectorAttribute(const char* name, int length, long long* value);
  void SetVectorAttribute(const char* name, int length, long long const* value);
  int GetScalarAttribute(const char* name, unsigned long long& value);
  int GetVectorAttribute(const char* name, int length, unsigned long long* value);
  void SetVectorAttribute(const char* name, int length, unsigned long long const* value);
 
  int GetWordTypeAttribute(const char* name, int& value);
 
 
  vtkGetMacro(NumberOfAttributes, int);
 
  const char* GetAttributeName(int idx);
 
  const char* GetAttributeValue(int idx);
 
 
  virtual void RemoveAttribute(const char* name);
  virtual void RemoveAllAttributes();
 
 
  vtkXMLDataElement* GetParent();
  void SetParent(vtkXMLDataElement* parent);
 
  virtual vtkXMLDataElement* GetRoot();
 
  int GetNumberOfNestedElements();
 
  vtkXMLDataElement* GetNestedElement(int index);
 
  void AddNestedElement(vtkXMLDataElement* element);
 
  virtual void RemoveNestedElement(vtkXMLDataElement*);
 
  virtual void RemoveAllNestedElements();
 
 
  vtkXMLDataElement* FindNestedElement(const char* id);
  vtkXMLDataElement* FindNestedElementWithName(const char* name);
  vtkXMLDataElement* FindNestedElementWithNameAndId(const char* name, const char* id);
  vtkXMLDataElement* FindNestedElementWithNameAndAttribute(
    const char* name, const char* att_name, const char* att_value);
 
  vtkXMLDataElement* LookupElementWithName(const char* name);
 
  vtkXMLDataElement* LookupElement(const char* id);
 
 
  vtkGetMacro(XMLByteIndex, vtkTypeInt64);
  vtkSetMacro(XMLByteIndex, vtkTypeInt64);
 
  virtual int IsEqualTo(vtkXMLDataElement* elem);
 
  virtual void DeepCopy(vtkXMLDataElement* elem);
 
 
  vtkSetClampMacro(AttributeEncoding, int, VTK_ENCODING_NONE, VTK_ENCODING_UNKNOWN);
  vtkGetMacro(AttributeEncoding, int);
 
 
  void PrintXML(ostream& os, vtkIndent indent);
  void PrintXML(VTK_FILEPATH const char* fname);
 
 
  vtkGetMacro(CharacterDataWidth, int);
  vtkSetMacro(CharacterDataWidth, int);
 
protected:
  vtkXMLDataElement();
  ~vtkXMLDataElement() override;
 
  // The name of the element from the XML file.
  char* Name;
  // The value of the "id" attribute, if any was given.
  char* Id;
 
  int CharacterDataWidth;
 
  // Data inside of the tag's open and close. ie <X> character data </X>
  char* CharacterData;            // Null terminated buffer.
  size_t CharacterDataBlockSize;  // Allocation size if buffer needs expand
  size_t CharacterDataBufferSize; // Allocated size.
  size_t EndOfCharacterData;      // Number of bytes used.
 
  // Tags that have specialized character data handlers
  // can set this flag to improve performance. The default is unset.
  vtkTypeBool IgnoreCharacterData;
 
  // Get/Set the stream position of the elements inline data.
  vtkGetMacro(InlineDataPosition, vtkTypeInt64);
  vtkSetMacro(InlineDataPosition, vtkTypeInt64);
  // The offset into the XML stream where the inline data begins.
  vtkTypeInt64 InlineDataPosition;
  // The offset into the XML stream where the element begins.
  vtkTypeInt64 XMLByteIndex;
 
  // The raw property name/value pairs read from the XML attributes.
  char** AttributeNames;
  char** AttributeValues;
  int NumberOfAttributes;
  int AttributesSize;
  int AttributeEncoding;
 
  // The set of nested elements.
  int NumberOfNestedElements;
  int NestedElementsSize;
  vtkXMLDataElement** NestedElements;
  // The parent of this element.
  vtkXMLDataElement* Parent;
 
  // Internal utility methods.
  vtkXMLDataElement* LookupElementInScope(const char* id);
  vtkXMLDataElement* LookupElementUpScope(const char* id);
  static int IsSpace(char c);
  void PrintCharacterData(ostream& os, vtkIndent indent);
  static void PrintWithEscapedData(ostream& os, const char* data);
 
  friend class vtkXMLDataParser;
  friend class vtkXMLMaterialParser;
 
private:
  vtkXMLDataElement(const vtkXMLDataElement&) = delete;
  void operator=(const vtkXMLDataElement&) = delete;
};
 
//----------------------------------------------------------------------------
inline void vtkXMLDataElement::AddCharacterData(const char* data, size_t length)
{
  if (this->IgnoreCharacterData)
  {
    return;
  }
  // This is the index where we start to put the new data at.
  size_t eod = this->EndOfCharacterData - 1;
  // Check if the new data will write off the end. If it does
  // resize the character data buffer.
  this->EndOfCharacterData += length;
  if (this->EndOfCharacterData >= this->CharacterDataBufferSize)
  {
    while (this->EndOfCharacterData >= this->CharacterDataBufferSize)
    {
      this->CharacterDataBufferSize += this->CharacterDataBlockSize;
    }
    this->CharacterData =
      static_cast<char*>(realloc(this->CharacterData, this->CharacterDataBufferSize));
  }
  // put the new data at the end of the buffer, and null terminate.
  char* pCD = this->CharacterData + eod;
  memmove(pCD, data, length);
  pCD[length] = '\0';
}
 
VTK_ABI_NAMESPACE_END
#endif