1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
/**
* @class vtkXMLUtilities
* @brief XML utilities.
*
* vtkXMLUtilities provides XML-related convenience functions.
* @sa
* vtkXMLDataElement
*/
#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;
/**
* Encode a string from one format to another
* (see VTK_ENCODING_... constants).
* If special_entites is true, convert some characters to their corresponding
* character entities.
*/
static void EncodeString(const char* input, int input_encoding, ostream& output,
int output_encoding, int special_entities = 0);
/**
* Collate a vtkXMLDataElement's attributes to a stream as a series of
* name="value" pairs (the separator between each pair can be specified,
* if not, it defaults to a space).
* Note that the resulting character-encoding will be UTF-8 (we assume
* that this function is used to create XML files/streams).
*/
static void CollateAttributes(vtkXMLDataElement*, ostream&, const char* sep = nullptr);
/**
* Flatten a vtkXMLDataElement to a stream, i.e. output a textual stream
* corresponding to that XML element, its attributes and its
* nested elements.
* If 'indent' is not nullptr, it is used to indent the whole tree.
* If 'indent' is not nullptr and 'indent_attributes' is true, attributes will
* be indented as well.
* Note that the resulting character-encoding will be UTF-8 (we assume
* that this function is used to create XML files/streams).
*/
static void FlattenElement(
vtkXMLDataElement*, ostream&, vtkIndent* indent = nullptr, int indent_attributes = 1);
/**
* Write a vtkXMLDataElement to a file (in a flattened textual form)
* Note that the resulting character-encoding will be UTF-8.
* Return 1 on success, 0 otherwise.
*/
static int WriteElementToFile(
vtkXMLDataElement*, VTK_FILEPATH const char* filename, vtkIndent* indent = nullptr);
///@{
/**
* Read a vtkXMLDataElement from a stream, string or file.
* The 'encoding' parameter will be used to set the internal encoding of the
* attributes of the data elements created by those functions (conversion
* from the XML stream encoding to that new encoding will be performed
* automatically). If set to VTK_ENCODING_NONE, the encoding won't be
* changed and will default to the default vtkXMLDataElement encoding.
* Return the root element on success, nullptr otherwise.
* Note that you have to call Delete() on the element returned by that
* function to ensure it is freed properly.
*/
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);
///@}
/**
* Sets attributes of an element from an array of encoded attributes.
* The 'encoding' parameter will be used to set the internal encoding of the
* attributes of the data elements created by those functions (conversion
* from the XML stream encoding to that new encoding will be performed
* automatically). If set to VTK_ENCODING_NONE, the encoding won't be
* changed and will default to the default vtkXMLDataElement encoding.
*/
static void ReadElementFromAttributeArray(
vtkXMLDataElement* element, const char** atts, int encoding);
/**
* Find all elements in 'tree' that are similar to 'elem' (using the
* vtkXMLDataElement::IsEqualTo() predicate).
* Return the number of elements found and store those elements in
* 'results' (automatically allocated).
* Warning: the results do not include 'elem' if it was found in the tree ;
* do not forget to deallocate 'results' if something was found.
*/
static int FindSimilarElements(
vtkXMLDataElement* elem, vtkXMLDataElement* tree, vtkXMLDataElement*** results);
///@{
/**
* Factor and unfactor a tree. This operation looks for duplicate elements
* in the tree, and replace them with references to a pool of elements.
* Unfactoring a non-factored element is harmless.
*/
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
|
