GDAL
cpl_minixml.h
Go to the documentation of this file.
1/**********************************************************************
2 * $Id$
3 *
4 * Project: CPL - Common Portability Library
5 * Purpose: Declarations for MiniXML Handler.
6 * Author: Frank Warmerdam, warmerdam@pobox.com
7 *
8 **********************************************************************
9 * Copyright (c) 2001, Frank Warmerdam
10 *
11 * Permission is hereby granted, free of charge, to any person obtaining a
12 * copy of this software and associated documentation files (the "Software"),
13 * to deal in the Software without restriction, including without limitation
14 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
15 * and/or sell copies of the Software, and to permit persons to whom the
16 * Software is furnished to do so, subject to the following conditions:
17 *
18 * The above copyright notice and this permission notice shall be included
19 * in all copies or substantial portions of the Software.
20 *
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
24 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
26 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27 * DEALINGS IN THE SOFTWARE.
28 ****************************************************************************/
29
30#ifndef CPL_MINIXML_H_INCLUDED
31#define CPL_MINIXML_H_INCLUDED
32
33#include "cpl_port.h"
34
42
44typedef enum
52
54typedef struct CPLXMLNode CPLXMLNode;
70{
78
100 char *pszValue;
101
110
122};
123
124CPLXMLNode CPL_DLL *CPLParseXMLString( const char * );
125void CPL_DLL CPLDestroyXMLNode( CPLXMLNode * );
126CPLXMLNode CPL_DLL *CPLGetXMLNode( CPLXMLNode *poRoot,
127 const char *pszPath );
128#if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
130extern "C++"
131{
132inline const CPLXMLNode *CPLGetXMLNode( const CPLXMLNode *poRoot,
133 const char *pszPath ) {
134 return const_cast<const CPLXMLNode*>(CPLGetXMLNode(
135 const_cast<CPLXMLNode*>(poRoot), pszPath));
136}
137}
139#endif
140CPLXMLNode CPL_DLL *CPLSearchXMLNode( CPLXMLNode *poRoot,
141 const char *pszTarget );
142#if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
144extern "C++"
145{
146inline const CPLXMLNode *CPLSearchXMLNode( const CPLXMLNode *poRoot,
147 const char *pszTarget ) {
148 return const_cast<const CPLXMLNode*>(CPLSearchXMLNode(
149 const_cast<CPLXMLNode*>(poRoot), pszTarget));
150}
151}
153#endif
154const char CPL_DLL *CPLGetXMLValue( const CPLXMLNode *poRoot,
155 const char *pszPath,
156 const char *pszDefault );
157CPLXMLNode CPL_DLL *CPLCreateXMLNode( CPLXMLNode *poParent,
159 const char *pszText );
160char CPL_DLL *CPLSerializeXMLTree( const CPLXMLNode *psNode );
161void CPL_DLL CPLAddXMLChild( CPLXMLNode *psParent,
163int CPL_DLL CPLRemoveXMLChild( CPLXMLNode *psParent,
165void CPL_DLL CPLAddXMLSibling( CPLXMLNode *psOlderSibling,
166 CPLXMLNode *psNewSibling );
168 const char *pszName,
169 const char *pszValue );
170void CPL_DLL CPLAddXMLAttributeAndValue( CPLXMLNode *psParent,
171 const char *pszName,
172 const char *pszValue );
173CPLXMLNode CPL_DLL *CPLCloneXMLTree( const CPLXMLNode *psTree );
174int CPL_DLL CPLSetXMLValue( CPLXMLNode *psRoot, const char *pszPath,
175 const char *pszValue );
176void CPL_DLL CPLStripXMLNamespace( CPLXMLNode *psRoot,
177 const char *pszNameSpace,
178 int bRecurse );
179void CPL_DLL CPLCleanXMLElementName( char * );
180
181CPLXMLNode CPL_DLL *CPLParseXMLFile( const char *pszFilename );
182int CPL_DLL CPLSerializeXMLTreeToFile( const CPLXMLNode *psTree,
183 const char *pszFilename );
184
186
187#if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
188
189extern "C++"
190{
191#ifndef DOXYGEN_SKIP
192#include <memory>
193#endif
194
196struct CPL_DLL CPLXMLTreeCloserDeleter
197{
198 void operator()(CPLXMLNode* psNode) const { CPLDestroyXMLNode(psNode); }
199};
205class CPL_DLL CPLXMLTreeCloser: public std::unique_ptr<CPLXMLNode, CPLXMLTreeCloserDeleter>
206{
207 public:
210 std::unique_ptr<CPLXMLNode, CPLXMLTreeCloserDeleter>(data) {}
211
214 CPLXMLNode* getDocumentElement();
215};
216
217} // extern "C++"
218
219#endif /* __cplusplus */
220
221#endif /* CPL_MINIXML_H_INCLUDED */
Manage a tree of XML nodes so that all nodes are freed when the instance goes out of scope.
Definition: cpl_minixml.h:206
CPLXMLTreeCloser(CPLXMLNode *data)
Constructor.
Definition: cpl_minixml.h:209
CPLXMLNode * CPLSearchXMLNode(CPLXMLNode *poRoot, const char *pszTarget)
Search for a node in document.
Definition: cpl_minixml.cpp:1470
void CPLAddXMLAttributeAndValue(CPLXMLNode *psParent, const char *pszName, const char *pszValue)
Create an attribute and text value.
Definition: cpl_minixml.cpp:1902
CPLXMLNode * CPLParseXMLString(const char *)
Parse an XML string into tree form.
Definition: cpl_minixml.cpp:615
CPLXMLNode * CPLCreateXMLElementAndValue(CPLXMLNode *psParent, const char *pszName, const char *pszValue)
Create an element and text value.
Definition: cpl_minixml.cpp:1863
CPLXMLNode * CPLGetXMLNode(CPLXMLNode *poRoot, const char *pszPath)
Find node by path.
Definition: cpl_minixml.cpp:1559
void CPLStripXMLNamespace(CPLXMLNode *psRoot, const char *pszNameSpace, int bRecurse)
Strip indicated namespaces.
Definition: cpl_minixml.cpp:2073
void CPLCleanXMLElementName(char *)
Make string into safe XML token.
Definition: cpl_minixml.cpp:2252
int CPLSetXMLValue(CPLXMLNode *psRoot, const char *pszPath, const char *pszValue)
Set element value by path.
Definition: cpl_minixml.cpp:1981
CPLXMLNode * CPLCreateXMLNode(CPLXMLNode *poParent, CPLXMLNodeType eType, const char *pszText)
Create an document tree item.
Definition: cpl_minixml.cpp:1306
void CPLDestroyXMLNode(CPLXMLNode *)
Destroy a tree.
Definition: cpl_minixml.cpp:1414
const char * CPLGetXMLValue(const CPLXMLNode *poRoot, const char *pszPath, const char *pszDefault)
Fetch element/attribute value.
Definition: cpl_minixml.cpp:1656
int CPLRemoveXMLChild(CPLXMLNode *psParent, CPLXMLNode *psChild)
Remove child node from parent.
Definition: cpl_minixml.cpp:1774
void CPLAddXMLSibling(CPLXMLNode *psOlderSibling, CPLXMLNode *psNewSibling)
Add new sibling.
Definition: cpl_minixml.cpp:1820
CPLXMLNode * CPLParseXMLFile(const char *pszFilename)
Parse XML file into tree.
Definition: cpl_minixml.cpp:2143
CPLXMLNode * CPLCloneXMLTree(const CPLXMLNode *psTree)
Copy tree.
Definition: cpl_minixml.cpp:1926
void CPLAddXMLChild(CPLXMLNode *psParent, CPLXMLNode *psChild)
Add child node to parent.
Definition: cpl_minixml.cpp:1718
CPLXMLNodeType
XML node type.
Definition: cpl_minixml.h:45
@ CXT_Literal
Definition: cpl_minixml.h:50
@ CXT_Element
Definition: cpl_minixml.h:46
@ CXT_Comment
Definition: cpl_minixml.h:49
@ CXT_Text
Definition: cpl_minixml.h:47
@ CXT_Attribute
Definition: cpl_minixml.h:48
int CPLSerializeXMLTreeToFile(const CPLXMLNode *psTree, const char *pszFilename)
Write document tree to a file.
Definition: cpl_minixml.cpp:2181
char * CPLSerializeXMLTree(const CPLXMLNode *psNode)
Convert tree into string document.
Definition: cpl_minixml.cpp:1261
Core portability definitions for CPL.
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:306
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:304
Document node structure.
Definition: cpl_minixml.h:70
struct CPLXMLNode * psChild
Child node.
Definition: cpl_minixml.h:121
CPLXMLNodeType eType
Node type.
Definition: cpl_minixml.h:77
struct CPLXMLNode * psNext
Next sibling.
Definition: cpl_minixml.h:109
char * pszValue
Node value.
Definition: cpl_minixml.h:100