00001 /********************************************************************** 00002 * $Id: cpl_minixml.h,v 1.9 2003/11/05 20:14:21 warmerda Exp $ 00003 * 00004 * Project: CPL - Common Portability Library 00005 * Purpose: Declarations for MiniXML Handler. 00006 * Author: Frank Warmerdam, warmerdam@pobox.com 00007 * 00008 ********************************************************************** 00009 * Copyright (c) 2001, Frank Warmerdam 00010 * 00011 * Permission is hereby granted, free of charge, to any person obtaining a 00012 * copy of this software and associated documentation files (the "Software"), 00013 * to deal in the Software without restriction, including without limitation 00014 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 00015 * and/or sell copies of the Software, and to permit persons to whom the 00016 * Software is furnished to do so, subject to the following conditions: 00017 * 00018 * The above copyright notice and this permission notice shall be included 00019 * in all copies or substantial portions of the Software. 00020 * 00021 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 00022 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 00023 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 00024 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 00025 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 00026 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 00027 * DEALINGS IN THE SOFTWARE. 00028 ********************************************************************** 00029 * 00030 * $Log: cpl_minixml.h,v $ 00031 * Revision 1.9 2003/11/05 20:14:21 warmerda 00032 * added lots of documentation 00033 * 00034 * Revision 1.8 2003/03/27 18:12:41 warmerda 00035 * Added NULL pszNameSpace support in namespace stripper (all namespaces). 00036 * Added XML file read/write functions. 00037 * 00038 * Revision 1.7 2003/03/24 16:46:48 warmerda 00039 * added CPLStripXMLNamespace 00040 * 00041 * Revision 1.6 2002/11/16 20:38:34 warmerda 00042 * added support for literals like DOCTYPE 00043 * 00044 * Revision 1.5 2002/05/24 04:09:10 warmerda 00045 * added clone and SetXMLValue functions 00046 * 00047 * Revision 1.4 2002/03/05 14:26:57 warmerda 00048 * expanded tabs 00049 * 00050 * Revision 1.3 2002/01/23 20:45:06 warmerda 00051 * handle <?...?> and comment elements 00052 * 00053 * Revision 1.2 2001/12/06 18:13:49 warmerda 00054 * added CPLAddXMLChild and CPLCreateElmentAndValue 00055 * 00056 * Revision 1.1 2001/11/16 15:39:48 warmerda 00057 * New 00058 * 00059 **********************************************************************/ 00060 00061 #ifndef _CPL_MINIXML_H_INCLUDED 00062 #define _CPL_MINIXML_H_INCLUDED 00063 00064 #include "cpl_port.h" 00065 00072 CPL_C_START 00073 00074 typedef enum 00075 { CXT_Element = 0, CXT_Text = 1, CXT_Attribute = 2, CXT_Comment = 3, CXT_Literal = 4 00081 } CPLXMLNodeType; 00082 00096 typedef struct _CPLXMLNode 00097 { 00104 CPLXMLNodeType eType; 00105 00127 char *pszValue; 00128 00136 struct _CPLXMLNode *psNext; 00137 00148 struct _CPLXMLNode *psChild; 00149 } CPLXMLNode; 00150 00151 00152 CPLXMLNode CPL_DLL *CPLParseXMLString( const char * ); 00153 void CPL_DLL CPLDestroyXMLNode( CPLXMLNode * ); 00154 CPLXMLNode CPL_DLL *CPLGetXMLNode( CPLXMLNode *poRoot, 00155 const char *pszPath ); 00156 const char CPL_DLL *CPLGetXMLValue( CPLXMLNode *poRoot, 00157 const char *pszPath, 00158 const char *pszDefault ); 00159 CPLXMLNode CPL_DLL *CPLCreateXMLNode( CPLXMLNode *poParent, 00160 CPLXMLNodeType eType, 00161 const char *pszText ); 00162 char CPL_DLL *CPLSerializeXMLTree( CPLXMLNode *psNode ); 00163 void CPL_DLL CPLAddXMLChild( CPLXMLNode *psParent, 00164 CPLXMLNode *psChild ); 00165 CPLXMLNode CPL_DLL *CPLCreateXMLElementAndValue( CPLXMLNode *psParent, 00166 const char *pszName, 00167 const char *pszValue ); 00168 CPLXMLNode CPL_DLL *CPLCloneXMLTree( CPLXMLNode *psTree ); 00169 int CPL_DLL CPLSetXMLValue( CPLXMLNode *psRoot, const char *pszPath, 00170 const char *pszValue ); 00171 void CPL_DLL CPLStripXMLNamespace( CPLXMLNode *psRoot, 00172 const char *pszNameSpace, 00173 int bRecurse ); 00174 00175 CPLXMLNode CPL_DLL *CPLParseXMLFile( const char *pszFilename ); 00176 int CPL_DLL CPLSerializeXMLTreeToFile( CPLXMLNode *psTree, 00177 const char *pszFilename ); 00178 00179 CPL_C_END 00180 00181 #endif /* _CPL_MINIXML_H_INCLUDED */