Back to index

radiance  4R0+20100331
ezxml.h
Go to the documentation of this file.
00001 /* RCSid $Id: ezxml.h,v 2.1 2009/06/17 20:41:47 greg Exp $ */
00002 /* ezxml.h
00003  *
00004  * Copyright 2004-2006 Aaron Voisine <aaron@voisine.org>
00005  *
00006  * Permission is hereby granted, free of charge, to any person obtaining
00007  * a copy of this software and associated documentation files (the
00008  * "Software"), to deal in the Software without restriction, including
00009  * without limitation the rights to use, copy, modify, merge, publish,
00010  * distribute, sublicense, and/or sell copies of the Software, and to
00011  * permit persons to whom the Software is furnished to do so, subject to
00012  * the following conditions:
00013  *
00014  * The above copyright notice and this permission notice shall be included
00015  * in all copies or substantial portions of the Software.
00016  *
00017  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
00018  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00019  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00020  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
00021  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
00022  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
00023  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
00024  */
00025 
00026 #ifndef _EZXML_H
00027 #define _EZXML_H
00028 
00029 #include <stdlib.h>
00030 #include <stdio.h>
00031 #include <stdarg.h>
00032 #include <fcntl.h>
00033 
00034 #ifdef __cplusplus
00035 extern "C" {
00036 #endif
00037 
00038 /* disable MMAP on CYGWIN, seems to cause problems... */
00039 #ifdef CYGWIN
00040 #define EZXML_NOMMAP
00041 #endif
00042 
00043 #define EZXML_BUFSIZE 1024 // size of internal memory buffers
00044 #define EZXML_NAMEM   0x80 // name is malloced
00045 #define EZXML_TXTM    0x40 // txt is malloced
00046 #define EZXML_DUP     0x20 // attribute name and value are strduped
00047 
00048 typedef struct ezxml *ezxml_t;
00049 struct ezxml {
00050     char *name;      // tag name
00051     char **attr;     // tag attributes { name, value, name, value, ... NULL }
00052     char *txt;       // tag character content, empty string if none
00053     size_t off;      // tag offset from start of parent tag character content
00054     ezxml_t next;    // next tag with same name in this section at this depth
00055     ezxml_t sibling; // next tag with different name in same section and depth
00056     ezxml_t ordered; // next tag, same section and depth, in original order
00057     ezxml_t child;   // head of sub tag list, NULL if none
00058     ezxml_t parent;  // parent tag, NULL if current tag is root tag
00059     short flags;     // additional information
00060 };
00061 
00062 // Given a string of xml data and its length, parses it and creates an ezxml
00063 // structure. For efficiency, modifies the data by adding null terminators
00064 // and decoding ampersand sequences. If you don't want this, copy the data and
00065 // pass in the copy. Returns NULL on failure.
00066 ezxml_t ezxml_parse_str(char *s, size_t len);
00067 
00068 // A wrapper for ezxml_parse_str() that accepts a file descriptor. First
00069 // attempts to mem map the file. Failing that, reads the file into memory.
00070 // Returns NULL on failure.
00071 ezxml_t ezxml_parse_fd(int fd);
00072 
00073 // a wrapper for ezxml_parse_fd() that accepts a file name
00074 ezxml_t ezxml_parse_file(const char *file);
00075     
00076 // Wrapper for ezxml_parse_str() that accepts a file stream. Reads the entire
00077 // stream into memory and then parses it. For xml files, use ezxml_parse_file()
00078 // or ezxml_parse_fd()
00079 ezxml_t ezxml_parse_fp(FILE *fp);
00080 
00081 // returns the first child tag (one level deeper) with the given name or NULL
00082 // if not found
00083 ezxml_t ezxml_child(ezxml_t xml, const char *name);
00084 
00085 // returns the next tag of the same name in the same section and depth or NULL
00086 // if not found
00087 #define ezxml_next(xml) ((xml) ? xml->next : NULL)
00088 
00089 // Returns the Nth tag with the same name in the same section at the same depth
00090 // or NULL if not found. An index of 0 returns the tag given.
00091 ezxml_t ezxml_idx(ezxml_t xml, int idx);
00092 
00093 // returns the name of the given tag
00094 #define ezxml_name(xml) ((xml) ? xml->name : NULL)
00095 
00096 // returns the given tag's character content or empty string if none
00097 #define ezxml_txt(xml) ((xml) ? xml->txt : "")
00098 
00099 // returns the value of the requested tag attribute, or NULL if not found
00100 const char *ezxml_attr(ezxml_t xml, const char *attr);
00101 
00102 // Traverses the ezxml sturcture to retrieve a specific subtag. Takes a
00103 // variable length list of tag names and indexes. The argument list must be
00104 // terminated by either an index of -1 or an empty string tag name. Example: 
00105 // title = ezxml_get(library, "shelf", 0, "book", 2, "title", -1);
00106 // This retrieves the title of the 3rd book on the 1st shelf of library.
00107 // Returns NULL if not found.
00108 ezxml_t ezxml_get(ezxml_t xml, ...);
00109 
00110 // Converts an ezxml structure back to xml. Returns a string of xml data that
00111 // must be freed.
00112 char *ezxml_toxml(ezxml_t xml);
00113 
00114 // returns a NULL terminated array of processing instructions for the given
00115 // target
00116 const char **ezxml_pi(ezxml_t xml, const char *target);
00117 
00118 // frees the memory allocated for an ezxml structure
00119 void ezxml_free(ezxml_t xml);
00120     
00121 // returns parser error message or empty string if none
00122 const char *ezxml_error(ezxml_t xml);
00123 
00124 // returns a new empty ezxml structure with the given root tag name
00125 ezxml_t ezxml_new(const char *name);
00126 
00127 // wrapper for ezxml_new() that strdup()s name
00128 #define ezxml_new_d(name) ezxml_set_flag(ezxml_new(strdup(name)), EZXML_NAMEM)
00129 
00130 // Adds a child tag. off is the offset of the child tag relative to the start
00131 // of the parent tag's character content. Returns the child tag.
00132 ezxml_t ezxml_add_child(ezxml_t xml, const char *name, size_t off);
00133 
00134 // wrapper for ezxml_add_child() that strdup()s name
00135 #define ezxml_add_child_d(xml, name, off) \
00136     ezxml_set_flag(ezxml_add_child(xml, strdup(name), off), EZXML_NAMEM)
00137 
00138 // sets the character content for the given tag and returns the tag
00139 ezxml_t ezxml_set_txt(ezxml_t xml, const char *txt);
00140 
00141 // wrapper for ezxml_set_txt() that strdup()s txt
00142 #define ezxml_set_txt_d(xml, txt) \
00143     ezxml_set_flag(ezxml_set_txt(xml, strdup(txt)), EZXML_TXTM)
00144 
00145 // Sets the given tag attribute or adds a new attribute if not found. A value
00146 // of NULL will remove the specified attribute. Returns the tag given.
00147 ezxml_t ezxml_set_attr(ezxml_t xml, const char *name, const char *value);
00148 
00149 // Wrapper for ezxml_set_attr() that strdup()s name/value. Value cannot be NULL
00150 #define ezxml_set_attr_d(xml, name, value) \
00151     ezxml_set_attr(ezxml_set_flag(xml, EZXML_DUP), strdup(name), strdup(value))
00152 
00153 // sets a flag for the given tag and returns the tag
00154 ezxml_t ezxml_set_flag(ezxml_t xml, short flag);
00155 
00156 // removes a tag along with its subtags without freeing its memory
00157 ezxml_t ezxml_cut(ezxml_t xml);
00158 
00159 // inserts an existing tag into an ezxml structure
00160 ezxml_t ezxml_insert(ezxml_t xml, ezxml_t dest, size_t off);
00161 
00162 // Moves an existing tag to become a subtag of dest at the given offset from
00163 // the start of dest's character content. Returns the moved tag.
00164 #define ezxml_move(xml, dest, off) ezxml_insert(ezxml_cut(xml), dest, off)
00165 
00166 // removes a tag along with all its subtags
00167 #define ezxml_remove(xml) ezxml_free(ezxml_cut(xml))
00168 
00169 #ifdef __cplusplus
00170 }
00171 #endif
00172 
00173 #endif // _EZXML_H