vtkXMLUtilities.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkXMLUtilities.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef vtkXMLUtilities_h
#define vtkXMLUtilities_h

#include "vtkIOXMLParserModule.h" // For export macro
#include "vtkObject.h"

class vtkXMLDataElement;

class VTKIOXMLPARSER_EXPORT vtkXMLUtilities : public vtkObject
{
public:
  static vtkXMLUtilities* New();
  vtkTypeMacro(vtkXMLUtilities, vtkObject);

  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*,
                                const char *filename,
                                vtkIndent *indent = nullptr);


  static vtkXMLDataElement* ReadElementFromStream(
    istream&, int encoding = VTK_ENCODING_NONE);
  static vtkXMLDataElement* ReadElementFromString(
    const char *str, int encoding = VTK_ENCODING_NONE);
  static vtkXMLDataElement* ReadElementFromFile(
    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() {}
  ~vtkXMLUtilities() override {}

  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;
};

#endif


// VTK-HeaderTest-Exclude: vtkXMLUtilities.h