VTK  9.1.0
vtkXMLUtilities.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkXMLUtilities.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=========================================================================*/
24#ifndef vtkXMLUtilities_h
25#define vtkXMLUtilities_h
26
27#include "vtkIOXMLParserModule.h" // For export macro
28#include "vtkObject.h"
29
31
32class VTKIOXMLPARSER_EXPORT vtkXMLUtilities : public vtkObject
33{
34public:
36 vtkTypeMacro(vtkXMLUtilities, vtkObject);
37 void PrintSelf(ostream& os, vtkIndent indent) override;
38
45 static void EncodeString(const char* input, int input_encoding, ostream& output,
46 int output_encoding, int special_entities = 0);
47
55 static void CollateAttributes(vtkXMLDataElement*, ostream&, const char* sep = nullptr);
56
67 static void FlattenElement(
68 vtkXMLDataElement*, ostream&, vtkIndent* indent = nullptr, int indent_attributes = 1);
69
76 vtkXMLDataElement*, VTK_FILEPATH const char* filename, vtkIndent* indent = nullptr);
77
79
92 const char* str, int encoding = VTK_ENCODING_NONE);
94 VTK_FILEPATH const char* filename, int encoding = VTK_ENCODING_NONE);
96
106 vtkXMLDataElement* element, const char** atts, int encoding);
107
117 vtkXMLDataElement* elem, vtkXMLDataElement* tree, vtkXMLDataElement*** results);
118
120
128
129protected:
130 vtkXMLUtilities() = default;
131 ~vtkXMLUtilities() override = default;
132
136
137private:
138 vtkXMLUtilities(const vtkXMLUtilities&) = delete;
139 void operator=(const vtkXMLUtilities&) = delete;
140};
141
142#endif
a simple class to control print indentation
Definition: vtkIndent.h:113
abstract base class for most VTK objects
Definition: vtkObject.h:82
Represents an XML element and those nested inside.
XML utilities.
static int UnFactorElementsInternal(vtkXMLDataElement *tree, vtkXMLDataElement *pool)
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
static void ReadElementFromAttributeArray(vtkXMLDataElement *element, const char **atts, int encoding)
Sets attributes of an element from an array of encoded attributes.
static int FactorElementsInternal(vtkXMLDataElement *tree, vtkXMLDataElement *root, vtkXMLDataElement *pool)
static void FlattenElement(vtkXMLDataElement *, ostream &, vtkIndent *indent=nullptr, int indent_attributes=1)
Flatten a vtkXMLDataElement to a stream, i.e.
static vtkXMLDataElement * ReadElementFromStream(istream &, int encoding=VTK_ENCODING_NONE)
Read a vtkXMLDataElement from a stream, string or file.
static int WriteElementToFile(vtkXMLDataElement *, VTK_FILEPATH const char *filename, vtkIndent *indent=nullptr)
Write a vtkXMLDataElement to a file (in a flattened textual form) Note that the resulting character-e...
static void CollateAttributes(vtkXMLDataElement *, ostream &, const char *sep=nullptr)
Collate a vtkXMLDataElement's attributes to a stream as a series of name="value" pairs (the separator...
static void FactorElements(vtkXMLDataElement *tree)
Factor and unfactor a tree.
static vtkXMLUtilities * New()
~vtkXMLUtilities() override=default
static vtkXMLDataElement * ReadElementFromFile(VTK_FILEPATH const char *filename, int encoding=VTK_ENCODING_NONE)
Read a vtkXMLDataElement from a stream, string or file.
static vtkXMLDataElement * ReadElementFromString(const char *str, int encoding=VTK_ENCODING_NONE)
Read a vtkXMLDataElement from a stream, string or file.
static int FindSimilarElements(vtkXMLDataElement *elem, vtkXMLDataElement *tree, vtkXMLDataElement ***results)
Find all elements in 'tree' that are similar to 'elem' (using the vtkXMLDataElement::IsEqualTo() pred...
vtkXMLUtilities()=default
static void UnFactorElements(vtkXMLDataElement *tree)
Factor and unfactor a tree.
static void EncodeString(const char *input, int input_encoding, ostream &output, int output_encoding, int special_entities=0)
Encode a string from one format to another (see VTK_ENCODING_... constants).
#define VTK_ENCODING_NONE
#define VTK_FILEPATH