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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_L10NTOOLS_INC_XMLPARSE_HXX
#define INCLUDED_L10NTOOLS_INC_XMLPARSE_HXX
#include "sal/config.h"
#include <cstddef>
#include <vector>
#include <signal.h>
#include <libxml/xmlexports.h>
#include <expat.h>
#include <rtl/string.hxx>
#include <rtl/strbuf.hxx>
#include "export.hxx"
#include <unordered_map>
class XMLParentNode;
class XMLElement;
enum class XMLNodeType{
XFILE = 0x001,
ELEMENT = 0x002,
DATA = 0x003,
COMMENT = 0x004,
DEFAULT = 0x005
};
/** Holds data of Attributes
*/
class XMLAttribute
{
private:
OString m_sName;
OString m_sValue;
public:
/// creates an attribute
XMLAttribute(
const OString &rName, // attributes name
const OString &rValue // attributes data
)
: m_sName( rName ), m_sValue( rValue ) {}
const OString& GetName() const { return m_sName; }
const OString& GetValue() const { return m_sValue; }
void setValue( const OString &rValue ){ m_sValue = rValue; }
};
typedef std::vector< XMLAttribute* > XMLAttributeList;
/** Virtual base to handle different kinds of XML nodes
*/
class XMLNode
{
protected:
XMLNode(){}
public:
virtual XMLNodeType GetNodeType() const = 0;
virtual ~XMLNode(){}
};
/** Virtual base to handle different kinds of child nodes
*/
class XMLChildNode : public XMLNode
{
private:
XMLParentNode *m_pParent;
protected:
XMLChildNode( XMLParentNode *pPar );
XMLChildNode( const XMLChildNode& rObj);
XMLChildNode& operator=(const XMLChildNode& rObj);
public:
/// returns the parent of this node
XMLParentNode *GetParent() { return m_pParent; }
virtual ~XMLChildNode() override {};
};
typedef std::vector< XMLChildNode* > XMLChildNodeList;
class XMLData;
/** Virtual base to handle different kinds of parent nodes
*/
class XMLParentNode : public XMLChildNode
{
private:
std::unique_ptr<XMLChildNodeList> m_pChildList;
protected:
XMLParentNode( XMLParentNode *pPar )
: XMLChildNode( pPar ) {}
XMLParentNode( const XMLParentNode& );
XMLParentNode& operator=(const XMLParentNode& rObj);
virtual ~XMLParentNode() override;
public:
/// returns child list of this node
XMLChildNodeList *GetChildList() { return m_pChildList.get(); }
/// adds a new child
void AddChild(
XMLChildNode *pChild /// the new child
);
void RemoveAndDeleteAllChildren();
};
/// Mapping numeric Language code <-> XML Element
typedef std::unordered_map<OString, XMLElement*, OStringHash> LangHashMap;
/// Mapping XML Element string identifier <-> Language Map
typedef std::unordered_map<OString, LangHashMap*, OStringHash> XMLHashMap;
/// Mapping XML tag names <-> have localizable strings
typedef std::unordered_map<OString, sal_Bool, OStringHash> TagMap;
/** Holds information of a XML file, is root node of tree
*/
class XMLFile : public XMLParentNode
{
public:
XMLFile(
const OString &rFileName // the file name, empty if created from memory stream
);
XMLFile( const XMLFile& rObj ) ;
virtual ~XMLFile() override;
void Print( XMLNode *pCur, sal_uInt16 nLevel = 0 );
void SearchL10NElements( XMLChildNode *pCur, int pos = 0 );
void Extract();
XMLHashMap* GetStrings(){ return m_pXMLStrings.get(); }
void Write( OString const &rFilename );
bool Write( std::ofstream &rStream, XMLNode *pCur = nullptr );
bool CheckExportStatus( XMLParentNode *pCur = nullptr );
XMLFile& operator=(const XMLFile& rObj);
virtual XMLNodeType GetNodeType() const override { return XMLNodeType::XFILE; }
/// returns file name
const OString& GetName() const { return m_sFileName; }
void SetName( const OString &rFilename ) { m_sFileName = rFilename; }
const std::vector<OString>& getOrder() const { return m_vOrder; }
protected:
void InsertL10NElement( XMLElement* pElement);
// DATA
OString m_sFileName;
TagMap m_aNodes_localize;
std::unique_ptr<XMLHashMap> m_pXMLStrings;
std::vector <OString> m_vOrder;
};
/// An Utility class for XML
class XMLUtil
{
public:
/// Quot the XML characters
static OString QuotHTML( const OString& rString );
};
/** Hold information of an element node
*/
class XMLElement : public XMLParentNode
{
private:
OString m_sElementName;
std::unique_ptr<XMLAttributeList> m_pAttributes;
OString m_sId;
OString m_sOldRef;
OString m_sLanguageId;
int m_nPos;
protected:
void Print(XMLNode *pCur, OStringBuffer& rBuffer, bool bRootelement) const;
public:
/// create an element node
XMLElement(
const OString &rName, // the element name
XMLParentNode *pParent // parent node of this element
);
virtual ~XMLElement() override;
XMLElement(const XMLElement&);
XMLElement& operator=(const XMLElement& rObj);
virtual XMLNodeType GetNodeType() const override { return XMLNodeType::ELEMENT; }
/// returns element name
const OString& GetName() const { return m_sElementName; }
/// returns list of attributes of this element
XMLAttributeList *GetAttributeList() { return m_pAttributes.get(); }
/// adds a new attribute to this element, typically used by parser
void AddAttribute( const OString &rAttribute, const OString &rValue );
void ChangeLanguageTag( const OString &rValue );
/// Return a Unicode String representation of this object
OString ToOString();
void SetId ( OString const & sTheId ) { m_sId = sTheId; }
void SetLanguageId ( OString const & sLangId ) { m_sLanguageId = sLangId; }
void SetPos ( int nPos ) { m_nPos = nPos; }
void SetOldRef ( OString const & sOldRef ) { m_sOldRef = sOldRef; }
const OString& GetOldref() const { return m_sOldRef; }
};
/** Holds character data
*/
class XMLData : public XMLChildNode
{
private:
OString m_sData;
public:
/// create a data node
XMLData(
const OString &rData, // the initial data
XMLParentNode *pParent // the parent node of this data, typically a element node
)
: XMLChildNode( pParent ), m_sData( rData ) {}
// Default copy constructor and copy operator work well.
virtual XMLNodeType GetNodeType() const override { return XMLNodeType::DATA; }
/// returns the data
const OString& GetData() const { return m_sData; }
/// adds new character data to the existing one
void AddData( const OString &rData ) { m_sData += rData; }
};
/** Holds comments
*/
class XMLComment : public XMLChildNode
{
private:
OString m_sComment;
public:
/// create a comment node
XMLComment(
const OString &rComment, // the comment
XMLParentNode *pParent // the parent node of this comemnt, typically a element node
)
: XMLChildNode( pParent ), m_sComment( rComment ) {}
// Default copy constructor and copy operator work well.
virtual XMLNodeType GetNodeType() const override { return XMLNodeType::COMMENT; }
/// returns the comment
const OString& GetComment() const { return m_sComment; }
};
/** Holds additional file content like those for which no handler exists
*/
class XMLDefault : public XMLChildNode
{
private:
OString m_sDefault;
public:
/// create a comment node
XMLDefault(
const OString &rDefault, // the comment
XMLParentNode *pParent // the parent node of this comemnt, typically a element node
)
: XMLChildNode( pParent ), m_sDefault( rDefault ) {}
// Default copy constructor and copy operator work well.
virtual XMLNodeType GetNodeType() const override { return XMLNodeType::DEFAULT; }
/// returns the comment
const OString& GetDefault() const { return m_sDefault; }
};
/** struct for error information, used by class SimpleXMLParser
*/
struct XMLError {
XML_Error m_eCode; ///< the error code
std::size_t m_nLine; ///< error line number
std::size_t m_nColumn; ///< error column number
OString m_sMessage; ///< readable error message
};
/** validating xml parser, creates a document tree with xml nodes
*/
class SimpleXMLParser
{
private:
XML_Parser m_aParser;
XMLError m_aErrorInformation;
XMLParentNode *m_pCurNode;
XMLData *m_pCurData;
static void StartElementHandler( void *userData, const XML_Char *name, const XML_Char **atts );
static void EndElementHandler( void *userData, const XML_Char *name );
static void CharacterDataHandler( void *userData, const XML_Char *s, int len );
static void CommentHandler( void *userData, const XML_Char *data );
static void DefaultHandler( void *userData, const XML_Char *s, int len );
void StartElement( const XML_Char *name, const XML_Char **atts );
void EndElement( const XML_Char *name );
void CharacterData( const XML_Char *s, int len );
void Comment( const XML_Char *data );
void Default( const XML_Char *s, int len );
public:
/// creates a new parser
SimpleXMLParser();
~SimpleXMLParser();
/// parse a file, returns NULL on criticall errors
XMLFile *Execute(
const OString &rFileName, // the file name
XMLFile *pXMLFileIn // the XMLFile
);
/// returns an error struct
const XMLError &GetError() const { return m_aErrorInformation; }
};
#endif // INCLUDED_L10NTOOLS_INC_XMLPARSE_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|