vtkXMLUtilities.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 vtkXMLUtilities_h
#define vtkXMLUtilities_h
 
#include "vtkIOXMLParserModule.h" // For export macro
#include "vtkObject.h"
 
VTK_ABI_NAMESPACE_BEGIN
class vtkXMLDataElement;
 
class VTKIOXMLPARSER_EXPORT vtkXMLUtilities : public vtkObject
{
public:
  static vtkXMLUtilities* New();
  vtkTypeMacro(vtkXMLUtilities, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  static void EncodeString(const char* input, int input_encoding, ostream& output,
    int output_encoding, int special_entities = 0);
 
  static void CollateAttributes(vtkXMLDataElement*, ostream&, const char* sep = nullptr);
 
  static void FlattenElement(
    vtkXMLDataElement*, ostream&, vtkIndent* indent = nullptr, int indent_attributes = 1);
 
  static int WriteElementToFile(
    vtkXMLDataElement*, VTK_FILEPATH const char* filename, vtkIndent* indent = nullptr);
 
 
  VTK_NEWINSTANCE
  static vtkXMLDataElement* ReadElementFromStream(istream&, int encoding = VTK_ENCODING_NONE);
  VTK_NEWINSTANCE
  static vtkXMLDataElement* ReadElementFromString(
    const char* str, int encoding = VTK_ENCODING_NONE);
  VTK_NEWINSTANCE
  static vtkXMLDataElement* ReadElementFromFile(
    VTK_FILEPATH const char* filename, int encoding = VTK_ENCODING_NONE);
 
  static void ReadElementFromAttributeArray(
    vtkXMLDataElement* element, const char** atts, int encoding);
 
  static int FindSimilarElements(
    vtkXMLDataElement* elem, vtkXMLDataElement* tree, vtkXMLDataElement*** results);
 
 
  static void FactorElements(vtkXMLDataElement* tree);
  static void UnFactorElements(vtkXMLDataElement* tree);
 
protected:
  vtkXMLUtilities() = default;
  ~vtkXMLUtilities() override = default;
 
  static int FactorElementsInternal(
    vtkXMLDataElement* tree, vtkXMLDataElement* root, vtkXMLDataElement* pool);
  static int UnFactorElementsInternal(vtkXMLDataElement* tree, vtkXMLDataElement* pool);
 
private:
  vtkXMLUtilities(const vtkXMLUtilities&) = delete;
  void operator=(const vtkXMLUtilities&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif