src/gen/ezxml.h

/* RCSid $Id$ */
/* ezxml.h
 *
 * Copyright 2004-2006 Aaron Voisine <[email protected]>
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#ifndef _EZXML_H
#define _EZXML_H

#include <stdlib.h>
#include <stdio.h>
#include <stdarg.h>
#include <fcntl.h>

#ifdef __cplusplus
extern "C" {
#endif

#define EZXML_BUFSIZE 1024 // size of internal memory buffers
#define EZXML_NAMEM   0x80 // name is malloced
#define EZXML_TXTM    0x40 // txt is malloced
#define EZXML_DUP     0x20 // attribute name and value are strduped

typedef struct ezxml *ezxml_t;
struct ezxml {
    char *name;      // tag name
    char **attr;     // tag attributes { name, value, name, value, ... NULL }
    char *txt;       // tag character content, empty string if none
    size_t off;      // tag offset from start of parent tag character content
    ezxml_t next;    // next tag with same name in this section at this depth
    ezxml_t sibling; // next tag with different name in same section and depth
    ezxml_t ordered; // next tag, same section and depth, in original order
    ezxml_t child;   // head of sub tag list, NULL if none
    ezxml_t parent;  // parent tag, NULL if current tag is root tag
    short flags;     // additional information
};

// Given a string of xml data and its length, parses it and creates an ezxml
// structure. For efficiency, modifies the data by adding null terminators
// and decoding ampersand sequences. If you don't want this, copy the data and
// pass in the copy. Returns NULL on failure.
ezxml_t ezxml_parse_str(char *s, size_t len);

// A wrapper for ezxml_parse_str() that accepts a file descriptor. First
// attempts to mem map the file. Failing that, reads the file into memory.
// Returns NULL on failure.
ezxml_t ezxml_parse_fd(int fd);

// a wrapper for ezxml_parse_fd() that accepts a file name
ezxml_t ezxml_parse_file(const char *file);
    
// Wrapper for ezxml_parse_str() that accepts a file stream. Reads the entire
// stream into memory and then parses it. For xml files, use ezxml_parse_file()
// or ezxml_parse_fd()
ezxml_t ezxml_parse_fp(FILE *fp);

// returns the first child tag (one level deeper) with the given name or NULL
// if not found
ezxml_t ezxml_child(ezxml_t xml, const char *name);

// returns the next tag of the same name in the same section and depth or NULL
// if not found
#define ezxml_next(xml) ((xml) ? xml->next : NULL)

// Returns the Nth tag with the same name in the same section at the same depth
// or NULL if not found. An index of 0 returns the tag given.
ezxml_t ezxml_idx(ezxml_t xml, int idx);

// returns the name of the given tag
#define ezxml_name(xml) ((xml) ? xml->name : NULL)

// returns the given tag's character content or empty string if none
#define ezxml_txt(xml) ((xml) ? xml->txt : "")

// returns the value of the requested tag attribute, or NULL if not found
const char *ezxml_attr(ezxml_t xml, const char *attr);

// Traverses the ezxml sturcture to retrieve a specific subtag. Takes a
// variable length list of tag names and indexes. The argument list must be
// terminated by either an index of -1 or an empty string tag name. Example: 
// title = ezxml_get(library, "shelf", 0, "book", 2, "title", -1);
// This retrieves the title of the 3rd book on the 1st shelf of library.
// Returns NULL if not found.
ezxml_t ezxml_get(ezxml_t xml, ...);

// Converts an ezxml structure back to xml. Returns a string of xml data that
// must be freed.
char *ezxml_toxml(ezxml_t xml);

// returns a NULL terminated array of processing instructions for the given
// target
const char **ezxml_pi(ezxml_t xml, const char *target);

// frees the memory allocated for an ezxml structure
void ezxml_free(ezxml_t xml);
    
// returns parser error message or empty string if none
const char *ezxml_error(ezxml_t xml);

// returns a new empty ezxml structure with the given root tag name
ezxml_t ezxml_new(const char *name);

// wrapper for ezxml_new() that strdup()s name
#define ezxml_new_d(name) ezxml_set_flag(ezxml_new(strdup(name)), EZXML_NAMEM)

// Adds a child tag. off is the offset of the child tag relative to the start
// of the parent tag's character content. Returns the child tag.
ezxml_t ezxml_add_child(ezxml_t xml, const char *name, size_t off);

// wrapper for ezxml_add_child() that strdup()s name
#define ezxml_add_child_d(xml, name, off) \
    ezxml_set_flag(ezxml_add_child(xml, strdup(name), off), EZXML_NAMEM)

// sets the character content for the given tag and returns the tag
ezxml_t ezxml_set_txt(ezxml_t xml, const char *txt);

// wrapper for ezxml_set_txt() that strdup()s txt
#define ezxml_set_txt_d(xml, txt) \
    ezxml_set_flag(ezxml_set_txt(xml, strdup(txt)), EZXML_TXTM)

// Sets the given tag attribute or adds a new attribute if not found. A value
// of NULL will remove the specified attribute. Returns the tag given.
ezxml_t ezxml_set_attr(ezxml_t xml, const char *name, const char *value);

// Wrapper for ezxml_set_attr() that strdup()s name/value. Value cannot be NULL
#define ezxml_set_attr_d(xml, name, value) \
    ezxml_set_attr(ezxml_set_flag(xml, EZXML_DUP), strdup(name), strdup(value))

// sets a flag for the given tag and returns the tag
ezxml_t ezxml_set_flag(ezxml_t xml, short flag);

// removes a tag along with its subtags without freeing its memory
ezxml_t ezxml_cut(ezxml_t xml);

// inserts an existing tag into an ezxml structure
ezxml_t ezxml_insert(ezxml_t xml, ezxml_t dest, size_t off);

// Moves an existing tag to become a subtag of dest at the given offset from
// the start of dest's character content. Returns the moved tag.
#define ezxml_move(xml, dest, off) ezxml_insert(ezxml_cut(xml), dest, off)

// removes a tag along with all its subtags
#define ezxml_remove(xml) ezxml_free(ezxml_cut(xml))

#ifdef __cplusplus
}
#endif

#endif // _EZXML_H
Revision:	2.1
Committed:	Fri Sep 21 05:53:21 2007 UTC (18 years, 1 month ago) by greg
Content type:	text/plain
Branch:	MAIN
CVS Tags:	rad3R9
Log Message:	Partial implementation of BSDF incorporation
#	Content
1	/* RCSid $Id$ */
2	/* ezxml.h
3	*
4	* Copyright 2004-2006 Aaron Voisine <[email protected]>
5	*
6	* Permission is hereby granted, free of charge, to any person obtaining
7	* a copy of this software and associated documentation files (the
8	* "Software"), to deal in the Software without restriction, including
9	* without limitation the rights to use, copy, modify, merge, publish,
10	* distribute, sublicense, and/or sell copies of the Software, and to
11	* permit persons to whom the Software is furnished to do so, subject to
12	* the following conditions:
13	*
14	* The above copyright notice and this permission notice shall be included
15	* in all copies or substantial portions of the Software.
16	*
17	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
18	* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19	* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
20	* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
21	* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
22	* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
23	* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24	*/
25
26	#ifndef _EZXML_H
27	#define _EZXML_H
28
29	#include <stdlib.h>
30	#include <stdio.h>
31	#include <stdarg.h>
32	#include <fcntl.h>
33
34	#ifdef __cplusplus
35	extern "C" {
36	#endif
37
38	#define EZXML_BUFSIZE 1024 // size of internal memory buffers
39	#define EZXML_NAMEM 0x80 // name is malloced
40	#define EZXML_TXTM 0x40 // txt is malloced
41	#define EZXML_DUP 0x20 // attribute name and value are strduped
42
43	typedef struct ezxml *ezxml_t;
44	struct ezxml {
45	char *name; // tag name
46	char **attr; // tag attributes { name, value, name, value, ... NULL }
47	char *txt; // tag character content, empty string if none
48	size_t off; // tag offset from start of parent tag character content
49	ezxml_t next; // next tag with same name in this section at this depth
50	ezxml_t sibling; // next tag with different name in same section and depth
51	ezxml_t ordered; // next tag, same section and depth, in original order
52	ezxml_t child; // head of sub tag list, NULL if none
53	ezxml_t parent; // parent tag, NULL if current tag is root tag
54	short flags; // additional information
55	};
56
57	// Given a string of xml data and its length, parses it and creates an ezxml
58	// structure. For efficiency, modifies the data by adding null terminators
59	// and decoding ampersand sequences. If you don't want this, copy the data and
60	// pass in the copy. Returns NULL on failure.
61	ezxml_t ezxml_parse_str(char *s, size_t len);
62
63	// A wrapper for ezxml_parse_str() that accepts a file descriptor. First
64	// attempts to mem map the file. Failing that, reads the file into memory.
65	// Returns NULL on failure.
66	ezxml_t ezxml_parse_fd(int fd);
67
68	// a wrapper for ezxml_parse_fd() that accepts a file name
69	ezxml_t ezxml_parse_file(const char *file);
70
71	// Wrapper for ezxml_parse_str() that accepts a file stream. Reads the entire
72	// stream into memory and then parses it. For xml files, use ezxml_parse_file()
73	// or ezxml_parse_fd()
74	ezxml_t ezxml_parse_fp(FILE *fp);
75
76	// returns the first child tag (one level deeper) with the given name or NULL
77	// if not found
78	ezxml_t ezxml_child(ezxml_t xml, const char *name);
79
80	// returns the next tag of the same name in the same section and depth or NULL
81	// if not found
82	#define ezxml_next(xml) ((xml) ? xml->next : NULL)
83
84	// Returns the Nth tag with the same name in the same section at the same depth
85	// or NULL if not found. An index of 0 returns the tag given.
86	ezxml_t ezxml_idx(ezxml_t xml, int idx);
87
88	// returns the name of the given tag
89	#define ezxml_name(xml) ((xml) ? xml->name : NULL)
90
91	// returns the given tag's character content or empty string if none
92	#define ezxml_txt(xml) ((xml) ? xml->txt : "")
93
94	// returns the value of the requested tag attribute, or NULL if not found
95	const char ezxml_attr(ezxml_t xml, const char attr);
96
97	// Traverses the ezxml sturcture to retrieve a specific subtag. Takes a
98	// variable length list of tag names and indexes. The argument list must be
99	// terminated by either an index of -1 or an empty string tag name. Example:
100	// title = ezxml_get(library, "shelf", 0, "book", 2, "title", -1);
101	// This retrieves the title of the 3rd book on the 1st shelf of library.
102	// Returns NULL if not found.
103	ezxml_t ezxml_get(ezxml_t xml, ...);
104
105	// Converts an ezxml structure back to xml. Returns a string of xml data that
106	// must be freed.
107	char *ezxml_toxml(ezxml_t xml);
108
109	// returns a NULL terminated array of processing instructions for the given
110	// target
111	const char *ezxml_pi(ezxml_t xml, const char target);
112
113	// frees the memory allocated for an ezxml structure
114	void ezxml_free(ezxml_t xml);
115
116	// returns parser error message or empty string if none
117	const char *ezxml_error(ezxml_t xml);
118
119	// returns a new empty ezxml structure with the given root tag name
120	ezxml_t ezxml_new(const char *name);
121
122	// wrapper for ezxml_new() that strdup()s name
123	#define ezxml_new_d(name) ezxml_set_flag(ezxml_new(strdup(name)), EZXML_NAMEM)
124
125	// Adds a child tag. off is the offset of the child tag relative to the start
126	// of the parent tag's character content. Returns the child tag.
127	ezxml_t ezxml_add_child(ezxml_t xml, const char *name, size_t off);
128
129	// wrapper for ezxml_add_child() that strdup()s name
130	#define ezxml_add_child_d(xml, name, off) \
131	ezxml_set_flag(ezxml_add_child(xml, strdup(name), off), EZXML_NAMEM)
132
133	// sets the character content for the given tag and returns the tag
134	ezxml_t ezxml_set_txt(ezxml_t xml, const char *txt);
135
136	// wrapper for ezxml_set_txt() that strdup()s txt
137	#define ezxml_set_txt_d(xml, txt) \
138	ezxml_set_flag(ezxml_set_txt(xml, strdup(txt)), EZXML_TXTM)
139
140	// Sets the given tag attribute or adds a new attribute if not found. A value
141	// of NULL will remove the specified attribute. Returns the tag given.
142	ezxml_t ezxml_set_attr(ezxml_t xml, const char name, const char value);
143
144	// Wrapper for ezxml_set_attr() that strdup()s name/value. Value cannot be NULL
145	#define ezxml_set_attr_d(xml, name, value) \
146	ezxml_set_attr(ezxml_set_flag(xml, EZXML_DUP), strdup(name), strdup(value))
147
148	// sets a flag for the given tag and returns the tag
149	ezxml_t ezxml_set_flag(ezxml_t xml, short flag);
150
151	// removes a tag along with its subtags without freeing its memory
152	ezxml_t ezxml_cut(ezxml_t xml);
153
154	// inserts an existing tag into an ezxml structure
155	ezxml_t ezxml_insert(ezxml_t xml, ezxml_t dest, size_t off);
156
157	// Moves an existing tag to become a subtag of dest at the given offset from
158	// the start of dest's character content. Returns the moved tag.
159	#define ezxml_move(xml, dest, off) ezxml_insert(ezxml_cut(xml), dest, off)
160
161	// removes a tag along with all its subtags
162	#define ezxml_remove(xml) ezxml_free(ezxml_cut(xml))
163
164	#ifdef __cplusplus
165	}
166	#endif
167
168	#endif // _EZXML_H