Mercurial > ecos
changeset 1884:6036f158c5ff
* Import of the ezxml XML parsing library
| author | asl |
|---|---|
| date | Mon, 31 Jan 2005 00:09:30 +0000 |
| parents | a16252f31c44 |
| children | 7fd45d2a9dce |
| files | packages/services/ezxml/current/ChangeLog packages/services/ezxml/current/cdl/ezxml.cdl packages/services/ezxml/current/doc/ezxml.html packages/services/ezxml/current/doc/ezxml.txt packages/services/ezxml/current/doc/license.txt packages/services/ezxml/current/include/ezxml.h packages/services/ezxml/current/src/ezxml.c packages/services/ezxml/current/tests/ezxml.c |
| diffstat | 8 files changed, 1275 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
new file mode 100644 --- /dev/null +++ b/packages/services/ezxml/current/ChangeLog @@ -0,0 +1,35 @@ +2005-01-31 Andrew Lunn <andrew.lunn@ascom.ch> + + * Import of the ezxml XML parsing library + +//=========================================================================== +//####ECOSGPLCOPYRIGHTBEGIN#### +// ------------------------------------------- +// This file is part of eCos, the Embedded Configurable Operating System. +// Copyright (C) 2005 Andrew Lunn +// +// eCos is free software; you can redistribute it and/or modify it under +// the terms of the GNU General Public License as published by the Free +// Software Foundation; either version 2 or (at your option) any later version. +// +// eCos is distributed in the hope that it will be useful, but WITHOUT ANY +// WARRANTY; without even the implied warranty of MERCHANTABILITY or +// FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +// for more details. +// +// You should have received a copy of the GNU General Public License along +// with eCos; if not, write to the Free Software Foundation, Inc., +// 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. +// +// As a special exception, if other files instantiate templates or use macros +// or inline functions from this file, or you compile this file and link it +// with other works to produce a work based on this file, this file does not +// by itself cause the resulting work to be covered by the GNU General Public +// License. However the source code for this file must still be made available +// in accordance with section (3) of the GNU General Public License. +// +// This exception does not invalidate any other reasons why a work based on +// this file might be covered by the GNU General Public License. +// ------------------------------------------- +//####ECOSGPLCOPYRIGHTEND#### +//===========================================================================
new file mode 100644 --- /dev/null +++ b/packages/services/ezxml/current/cdl/ezxml.cdl @@ -0,0 +1,80 @@ +# ==================================================================== +# +# ezxml.cdl +# +# XML parser +# +# ==================================================================== +#####ECOSGPLCOPYRIGHTBEGIN#### +## ------------------------------------------- +## This file is part of eCos, the Embedded Configurable Operating System. +## Copyright (C) 2005 eCosCentric Ltd +## +## eCos is free software; you can redistribute it and/or modify it under +## the terms of the GNU General Public License as published by the Free +## Software Foundation; either version 2 or (at your option) any later version. +## +## eCos is distributed in the hope that it will be useful, but WITHOUT ANY +## WARRANTY; without even the implied warranty of MERCHANTABILITY or +## FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +## for more details. +## +## You should have received a copy of the GNU General Public License along +## with eCos; if not, write to the Free Software Foundation, Inc., +## 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. +## +## As a special exception, if other files instantiate templates or use macros +## or inline functions from this file, or you compile this file and link it +## with other works to produce a work based on this file, this file does not +## by itself cause the resulting work to be covered by the GNU General Public +## License. However the source code for this file must still be made available +## in accordance with section (3) of the GNU General Public License. +## +## This exception does not invalidate any other reasons why a work based on +## this file might be covered by the GNU General Public License. +## +## Alternative licenses for eCos may be arranged by contacting Red Hat, Inc. +## at http://sources.redhat.com/ecos/ecos-license/ +## ------------------------------------------- +#####ECOSGPLCOPYRIGHTEND#### +# ==================================================================== +######DESCRIPTIONBEGIN#### +# +# Author(s): Matt Jerdonek +# Original data: Matt Jerdonek +# Contributors: +# Date: 2005-01-31 +# +#####DESCRIPTIONEND#### +# +# ==================================================================== + +cdl_package CYGPKG_EZXML { + display "ezXML XML parser" + description " + ezXML is a C library for parsing XML documents inspired by + simpleXML for PHP. As the name implies, it's easy to + use. It's ideal for parsing xml configuration files or + REST web service responses. It's also fast and lightweight + (11k compiled)." + + compile ezxml.c + + cdl_option CYGPKG_EZXML_CFLAGS_ADD { + display "Additional compiler flags" + flavor data + no_define + default_value { "-D__ECOS__" } + description " + This option modifies the set of compiler flags for + building this package. These flags are used in addition + to the set of global flags." + } + + cdl_option CYGPKG_EZXML_TESTS { + display "ezXML tests" + flavor data + no_define + calculated { "tests/ezxml" } + } +}
new file mode 100644 --- /dev/null +++ b/packages/services/ezxml/current/doc/ezxml.html @@ -0,0 +1,121 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head><title>ezXML</title></head> + <body> + <h1>ezXML - XML Parsing C Library</h1> + <h3>version 0.8</h3> + <p> + ezXML is a C library for parsing XML documents inspired by + <a href="http://www.php.net/SimpleXML">simpleXML</a> for + PHP. As the name implies, it's easy to use. It's ideal for parsing xml + configuration files or REST web service responses. It's also fast and + lightweight (11k compiled). The latest version is available here: + <a href="http://prdownloads.sf.net/ezxml/ezxml-0.8.tar.gz?download" + >ezxml-0.8.tar.gz</a> + </p> + + <b>Example Usage</b> + <p> + Given the following example xml document: + </p> + <code> + <?xml version="1.0"?><br /> + <formula1><br /> + <team name="McLaren"><br /> + <driver><br /> + <name>Kimi + Raikkonen</name><br /> + <points>45</points><br /> + </driver><br /> + <driver><br /> + <name>David + Coultard</name><br /> + <points>24</points><br /> + </driver><br /> + </team><br /> + </formula1> + </code> + <p> + This code snipped prints out a list of drivers, which team they drive for, + and how many championship points they have: + </p> + <code> + ezxml_t f1 = ezxml_parse_file("formula1.xml"), team, driver;<br /> + const char *teamname;<br /> + <br /> + for (team = ezxml_child(f1, "team"); team; team = team->next) {<br /> + teamname = ezxml_attr(team, "name");<br /> + for (driver = ezxml_child(team, "driver"); driver; + driver = driver->next) {<br /> + printf("%s, %s: %s\n", + ezxml_child(driver, "name")->txt, teamname,<br /> + + ezxml_child(driver, "points")->txt);<br /> + }<br /> + }<br /> + ezxml_free(f1); + </code> + <p> + Alternately, the following would print out the name of the second driver + of the first team: + </p> + <code> + ezxml_t f1 = ezxml_parse_file("formula1.xml");<br /> + <br /> + printf("%s\n", ezxml_get(f1, "team", 0, "driver", 1, "name", -1)->txt); + <br />ezxml_free(f1); + </code> + <p> + The -1 indicates the end of the argument list. That's pretty much all + there is to it. Complete API documentation can be found in ezxml.h. + </p> + + <b>Known Limitations</b> + <ul> + <li> + No support for UTF-16, however UTF-8 is handled correctly. UTF-16 + support is required for XML 1.0 conformity and will be implimented for + the 1.0 release. + <br /> + </li> + <li> + Loads the entire xml document into memory at once and does not allow for + documents to be passed in a chunk at a time. Large xml files can still + be handled though through <code>ezxml_parse_file()</code> and + <code>ezxml_parse_fd()</code>, which use mmap to map the file to a + virtual address space and rely on the virtual memory system to page in + data as needed. + <br /> + </li> + <li> + Ignores DTDs. Parsing of the internal DTD subset is required for XML 1.0 + conformity and will be implimented for the 1.0 release. ezXML is not, + and is not likely to become, a validating parser. + <br /> + </li> + <li> + In making the character content of tags easy to access, there is no + way provided to keep track of the location of sub tags relative to the + character data. Example: + <p> + <code><doc>line one<br/><br />line two</doc></code> + </p> + <p> + The character content of the doc tag is reported as + <code>"line one\nline two"</code>, and <code><br/></code> is + reported as a sub tag, but the location of <code><br/></code> + within the character data is not. The function + <code>ezxml_toxml()</code> will convert an ezXML structure back to xml + with sub tag locations intact. + </p> + </li> + </ul> + + <b>Licensing</b> + <p> + ezXML was written by Aaron Voisine and is distributed under the terms of + the <a href="license.txt">MIT license</a>. + </p> + </body> +</html>
new file mode 100644 --- /dev/null +++ b/packages/services/ezxml/current/doc/ezxml.txt @@ -0,0 +1,84 @@ +ezXML - XML Parsing C Library +version 0.8 + +ezXML is a C library for parsing XML documents inspired by simpleXML for PHP. +As the name implies, it's easy to use. It's ideal for parsing xml configuration +files or REST web service responses. It's also fast and lightweight (11k +compiled). The latest version is available here: +http://prdownloads.sf.net/ezxml/ezxml-0.8.tar.gz?download + +Example Usage + +Given the following example xml document: + +<?xml version="1.0"?> +<formula1> + <team name="McLaren"> + <driver> + <name>Kimi Raikkonen</name> + <points>45</points> + </driver> + <driver> + <name>David Coultard</name> + <points>24</points> + </driver> + </team> +</formula1> + +This code snipped prints out a list of drivers, which team they drive for, +and how many championship points they have: + +ezxml_t f1 = ezxml_parse_file("formula1.xml"), team, driver; +const char *teamname; + +for (team = ezxml_child(f1, "team"); team; team = team->next) { + teamname = ezxml_attr(team, "name"); + for (driver = ezxml_child(team, "driver"); driver; driver = driver->next) { + printf("%s, %s: %s\n", ezxml_child(driver, "name")->txt, teamname, + ezxml_child(driver, "points")->txt); + } +} +ezxml_free(f1); + +Alternately, the following would print out the name of the second driver of the +first team: + +ezxml_t f1 = ezxml_parse_file("formula1.xml"); + +printf("%s\n", ezxml_get(f1, "team", 0, "driver", 1, "name", -1)->txt); +ezxml_free(f1); + +The -1 indicates the end of the argument list. That's pretty much all +there is to it. Complete API documentation can be found in ezxml.h. + +Known Limitations + +- No support for UTF-16, however UTF-8 is handled correctly. UTF-16 support is + required for XML 1.0 conformity and will be implimented for the 1.0 release. + +- Loads the entire xml document into memory at once and does not allow for + documents to be passed in a chunk at a time. Large xml files can still be + handled though through ezxml_parse_file() and ezxml_parse_fd(), which use mmap + to map the file to a virtual address space and rely on the virtual memory + system to page in data as needed. + +- Ignores DTDs. Parsing of the internal DTD subset is required for XML 1.0 + conformity and will be implimented for the 1.0 release. ezXML is not, and is + not likely to become, a validating parser. + +- In making the character content of tags easy to access, there is no way + provided to keep track of the location of sub tags relative to the character + data. Example: + + <doc>line one<br/> + line two</doc> + + The character content of the doc tag is reported as "line one\nline two", and + <br/> is reported as a sub tag, but the location of <br/> within the + character data is not. The function ezxml_toxml() will convert an ezXML + structure back to xml with sub tag locations intact. + +Licensing + +ezXML was written by Aaron Voisine <aaron@voisine.org> and is distributed under +the terms of the MIT license, described in license.txt.
new file mode 100644 --- /dev/null +++ b/packages/services/ezxml/current/doc/license.txt @@ -0,0 +1,20 @@ +Copyright 2004 Aaron Voisine <aaron@voisine.org> + +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.
new file mode 100644 --- /dev/null +++ b/packages/services/ezxml/current/include/ezxml.h @@ -0,0 +1,169 @@ +//========================================================================== +// +// ezxml.h +// +// Simple XML parser +// +//========================================================================== +//####ECOSGPLCOPYRIGHTBEGIN#### +// ------------------------------------------- +// This file is part of eCos, the Embedded Configurable Operating System. +// Copyright (C) 2005 eCosCentric Ltd +// +// eCos is free software; you can redistribute it and/or modify it under +// the terms of the GNU General Public License as published by the Free +// Software Foundation; either version 2 or (at your option) any later version. +// +// eCos is distributed in the hope that it will be useful, but WITHOUT ANY +// WARRANTY; without even the implied warranty of MERCHANTABILITY or +// FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +// for more details. +// +// You should have received a copy of the GNU General Public License along +// with eCos; if not, write to the Free Software Foundation, Inc., +// 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. +// +// As a special exception, if other files instantiate templates or use macros +// or inline functions from this file, or you compile this file and link it +// with other works to produce a work based on this file, this file does not +// by itself cause the resulting work to be covered by the GNU General Public +// License. However the source code for this file must still be made available +// in accordance with section (3) of the GNU General Public License. +// +// This exception does not invalidate any other reasons why a work based on +// this file might be covered by the GNU General Public License. +// +// Alternative licenses for eCos may be arranged by contacting Red Hat, Inc. +// at http://sources.redhat.com/ecos/ecos-license/ +// ------------------------------------------- +//####ECOSGPLCOPYRIGHTEND#### +//========================================================================== +//#####DESCRIPTIONBEGIN#### +// +// Author(s): Aaron Voisine +// Contributors: Matt Jerdonek +// Date: 2005-01-31 +// Purpose: +// Description: +// +// This code is part of eCos (tm). +// +//####DESCRIPTIONEND#### +// +//========================================================================== + +/* ezxml.h + * + * Copyright 2004 Aaron Voisine <aaron@voisine.org> + * + * 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 + +// returns the next tag of the same name in the same section and depth or NULL +// if not found +#define ezxml_next(xml) xml->next + +// returns the tag character content or empty string if none +#define ezxml_txt(xml) xml->txt + +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 in 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, only used internally for now +}; + +// 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 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 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 retrive a specific subtag. Takes a variable +// length list of tag names and indexes. Final index must be -1. 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); + +#ifdef __cplusplus +} +#endif + +#endif // _EZXML_H
new file mode 100644 --- /dev/null +++ b/packages/services/ezxml/current/src/ezxml.c @@ -0,0 +1,659 @@ +//========================================================================== +// +// crc32.c +// +// Gary S. Brown's 32 bit CRC +// +//========================================================================== +//####ECOSGPLCOPYRIGHTBEGIN#### +// ------------------------------------------- +// This file is part of eCos, the Embedded Configurable Operating System. +// Copyright (C) 2005 eCosCentric Ltd +// +// eCos is free software; you can redistribute it and/or modify it under +// the terms of the GNU General Public License as published by the Free +// Software Foundation; either version 2 or (at your option) any later version. +// +// eCos is distributed in the hope that it will be useful, but WITHOUT ANY +// WARRANTY; without even the implied warranty of MERCHANTABILITY or +// FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +// for more details. +// +// You should have received a copy of the GNU General Public License along +// with eCos; if not, write to the Free Software Foundation, Inc., +// 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. +// +// As a special exception, if other files instantiate templates or use macros +// or inline functions from this file, or you compile this file and link it +// with other works to produce a work based on this file, this file does not +// by itself cause the resulting work to be covered by the GNU General Public +// License. However the source code for this file must still be made available +// in accordance with section (3) of the GNU General Public License. +// +// This exception does not invalidate any other reasons why a work based on +// this file might be covered by the GNU General Public License. +// +// Alternative licenses for eCos may be arranged by contacting Red Hat, Inc. +// at http://sources.redhat.com/ecos/ecos-license/ +// ------------------------------------------- +//####ECOSGPLCOPYRIGHTEND#### +//========================================================================== +//#####DESCRIPTIONBEGIN#### +// +// Author(s): Aaron Voisine +// Contributors: Matt Jerdonek +// Date: 2005-01-31 +// Purpose: +// Description: +// +// This code is part of eCos (tm). +// +//####DESCRIPTIONEND#### +// +//========================================================================== + + +/* ezxml.c + * + * Copyright 2004 Aaron Voisine <aaron@voisine.org> + * + * 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. + */ + +#include <stdlib.h> +#include <stdio.h> +#include <stdarg.h> +#include <string.h> +#include <ctype.h> +#include <unistd.h> +#include <sys/types.h> +#ifndef __ECOS__ +#include <sys/mman.h> +#endif +#include <sys/stat.h> +#include "ezxml.h" + +#include <pkgconf/system.h> + +#define EZXML_TXTM 0x80 // flag value meaning txt was malloced +#define EZXML_WS "\t\r\n " // whitespace + +// called when parser finds close of tag +#define ezxml_close_tag(root) root->cur = root->cur->parent; + +typedef struct ezxml_root *ezxml_root_t; +struct ezxml_root { // additional data for the root tag + struct ezxml xml; // is a super-struct built on top of ezxml struct + ezxml_t cur; // current xml tree insertion point + void *m; // original xml string + size_t len; // length of allocated memory for mmap, or -1 for malloc + const char *err; // error string + char ***pi; // processing instructions +}; + +// returns the first child tag with the given name or NULL if not found +ezxml_t ezxml_child(ezxml_t xml, const char *name) +{ + if (! xml) return NULL; + xml = xml->child; + while (xml && strcmp(name, xml->name)) xml = xml->sibling; + + return xml; +} + +// returns the Nth tag with the same name in the same subsection or NULL if not +// found +ezxml_t ezxml_idx(ezxml_t xml, int idx) +{ + for (; xml && idx; idx--) xml = xml->next; + return xml; +} + +// returns the value of the requested tag attribute or NULL if not found +const char *ezxml_attr(ezxml_t xml, const char *attr) +{ + int i = 0; + + if (! xml) return NULL; + while (xml->attr[i] && strcmp(attr, xml->attr[i])) i += 2; + return (xml->attr[i]) ? xml->attr[i + 1] : NULL; +} + +// same as ezxml_get but takes an alredy initialized va_list +ezxml_t ezxml_vget(ezxml_t xml, va_list ap) +{ + char *name = va_arg(ap, char *); + int idx = va_arg(ap, int); + + xml = ezxml_child(xml, name); + return (idx < 0) ? xml : ezxml_vget(ezxml_idx(xml, idx), ap); +} + +// Traverses the xml tree to retrive a specific subtag. Takes a variable +// length list of tag names and indexes. Final index must be -1. 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, ...) +{ + va_list ap; + ezxml_t ret; + + va_start(ap, xml); + ret = ezxml_vget(xml, ap); + va_end(ap); + + return ret; +} + +// returns a NULL terminated array of processing instructions for the given +// target +const char **ezxml_pi(ezxml_t xml, const char *target) +{ + static const char *nopi = NULL; + ezxml_root_t root; + int i = 0; + + while (xml->parent) xml = xml->parent; + root = (ezxml_root_t)xml; + + if (! root->pi) return &nopi; + while (root->pi[i] && strcmp(target, root->pi[i][0])) i++; + return (root->pi[i]) ? (const char **)root->pi[i] + 1 : &nopi; +} + +// Converts \r or \r\n to a single \n. If decode is non-zero, decodes ampersand +// sequences in place. Returns s. +char *ezxml_decode(char *s, int decode) +{ + int b; + char *e, *ret = s; + long c, d; + + for (;;) { + while (*s && *s != '\r' && *s != '&') s++; + + if (! *s) return ret; + else if (*s == '\r') { + *(s++) = '\n'; + if (*s == '\n') memmove((void *)s, (void *)(s + 1), strlen(s)); + continue; + } + else if (! decode) { s++; continue; } + else if (! strncmp(s, "<", 4)) *(s++) = '<'; + else if (! strncmp(s, ">", 4)) *(s++) = '>'; + else if (! strncmp(s, """, 6)) *(s++) = '"'; + else if (! strncmp(s, "'", 6)) *(s++) = '\''; + else if (! strncmp(s, "&", 5)) s++; + else if (! strncmp(s, "&#", 2)) { + if (s[2] == 'x') c = strtol(s + 3, &e, 16); + else c = strtol(s + 2, &e, 10); + if (! c || *e != ';') { s++; continue; } + + if (c < 0x80) *(s++) = (char)c; // US-ASCII subset + else { // multi-byte UTF-8 sequence + for (b = 0, d = c; d; d /= 2) b++; // number of bits in c + b = (b - 2) / 5; // number of bytes in payload + *(s++) = (0xFF << (7 - b)) | (c >> (6 * b)); // head + while (b) *(s++) = 0x80 | ((c >> (6 * --b)) & 0x3F); // payload + } + } + else { s++; continue; } + + memmove((void *)s, (void *)(strchr(s, ';') + 1), strlen(strchr(s, ';'))); + } +} + +// called when parser finds start of new tag +void ezxml_open_tag(ezxml_root_t root, char *name, char **attr) +{ + ezxml_t xml = root->cur; + + if (xml->name) { // not root tag + if (xml->child) { // already have sub tags + xml = xml->child; + while (xml->ordered) xml = xml->ordered; + xml->ordered = (ezxml_t)malloc(sizeof(struct ezxml)); + xml->ordered->parent = root->cur; + root->cur = xml->ordered; + xml = xml->parent->child; + + while (strcmp(xml->name, name) && xml->sibling) xml = xml->sibling; + if (! strcmp(xml->name, name)) { // already have this tag type + while (xml->next) xml = xml->next; + xml = xml->next = root->cur; + } + else xml = xml->sibling = root->cur; + } + else { // first sub tag + xml->child = (ezxml_t)malloc(sizeof(struct ezxml)); + xml->child->parent = xml; + root->cur = xml = xml->child; + } + + xml->off = strlen(xml->parent->txt); // offset in parent char content + } + + // initialize new tag + xml->name = name; + xml->attr = attr; + xml->next = xml->child = xml->sibling = xml->ordered = NULL; + xml->txt = ""; + xml->flags = 0; +} + +// called when parser finds character content between open and closing tag +void ezxml_char_content(ezxml_root_t root, char *s, size_t len, short decode) +{ + ezxml_t xml = root->cur; + size_t l; + + if (! xml || ! xml->name || ! len) return; + + s[len] = '\0'; + ezxml_decode(s, decode); + + if (! *(xml->txt)) xml->txt = s; + else { // allocate our own memory and make a copy + l = strlen(xml->txt); + if (! (xml->flags & EZXML_TXTM)) { + xml->txt = strcpy((char *)malloc(l + len + 1), xml->txt); + xml->flags |= EZXML_TXTM; + } + else xml->txt = (char *)realloc((void *)(xml->txt), l + len + 1); + strcpy(xml->txt + l, s); + } +} + +// called when the parser finds an xml processing instruction +void ezxml_proc_inst(ezxml_root_t root, char *s, size_t len) +{ + int i = 0, j = 1; + char *target = s; + + s[len] = '\0'; // null terminate instruction + *(s += strcspn(s, EZXML_WS)) = '\0'; // null terminate target + s += strspn(s + 1, EZXML_WS) + 1; // skip whitespace after target + + if (! root->pi) *(root->pi = (char ***)malloc(sizeof(char**))) = NULL; + + while (root->pi[i] && strcmp(target, root->pi[i][0])) i++; + if (! root->pi[i]) { // new target + root->pi = (char ***)realloc(root->pi, sizeof(char **) * (i + 2)); + root->pi[i] = (char **)malloc(sizeof(char *) * 2); + root->pi[i][0] = target; + root->pi[i + 1] = NULL; // null terminate lists + root->pi[i][1] = (char *)root->pi[i + 1]; + } + + while (root->pi[i][j]) j++; + root->pi[i] = (char **)realloc(root->pi[i], sizeof(char *) * (j + 2)); + root->pi[i][j] = s; + root->pi[i][j + 1] = NULL; +} + +// set an error string and return root +ezxml_t ezxml_seterr(ezxml_root_t root, const char *err) +{ + root->err = err; + return (ezxml_t)root; +} + +// parse the given xml string and return an ezxml structure +ezxml_t ezxml_parse_str(char *s, size_t len) +{ + ezxml_root_t root = (ezxml_root_t)malloc(sizeof(struct ezxml_root)); + char *d, **attr, q, e; + static char *noattr[] = { NULL }; + int l; + + if (! root) return NULL; + + // initialize root tag + memset((void *)root, '\0', sizeof (struct ezxml_root)); + root->xml.attr = noattr; + root->cur = (ezxml_t)root; + root->m = (void *)s; + root->err = root->xml.txt = ""; + + if (! len) return ezxml_seterr(root, "root tag missing"); + e = s[len - 1]; + s[len - 1] = '\0'; + + while (*s && *s != '<') s++; // find first tag + if (! *s) return ezxml_seterr(root, "root tag missing"); + + for (;;) { + attr = noattr; + d = ++s; + + if (isalpha(*s) || *s == '_' || *s == ':') { // new tag + if (! root->cur) return ezxml_seterr(root, "unmatched closing tag"); + + s += strcspn(s, EZXML_WS "/>"); + if (isspace(*s)) *(s++) = '\0'; + + l = 0; + while (*s && *s != '/' && *s != '>') { // new tag attribute + while (isspace(*s)) s++; + + attr = (char **)((! l) ? malloc(3 * sizeof (char *)) : + realloc((void *)attr, (l + 3) * sizeof (char *))); + attr[l] = s; + + s += strcspn(s, EZXML_WS "=/>"); + if (*s == '=' || isspace(*s)) { + *(s++) = '\0'; + q = *(s += strspn(s, EZXML_WS "=")); + if (q == '"' || q == '\'') { // attribute value + attr[l + 1] = ++s; + while (*s && *s != q) s++; + if (*s) *(s++) = '\0'; + else { + free(attr); + return ezxml_seterr(root, (q == '"') ? + "missing \"" : "missing '"); + } + ezxml_decode(attr[l + 1], 1); + } + else attr[l + 1] = ""; + } + else attr[l + 1] = ""; + + attr[(l += 2)] = NULL; + } + + if (*s == '/') { // self closing tag + *(s++) = '\0'; + if ((*s && *s != '>') || (! *s && e != '>')) { + if (l) free(attr); + return ezxml_seterr(root, "missing >"); + } + ezxml_open_tag(root, d, attr); + ezxml_close_tag(root); + } + else if (*s == '>' || (! *s && e == '>')) { // open tag + q = *s; + *s = '\0'; + ezxml_open_tag(root, d, attr); + *s = q; + } + else { + if (l) free(attr); + return ezxml_seterr(root, "missing >"); + } + } + else if (*s == '/') { // close tag + if (! root->cur) return ezxml_seterr(root, "unmatched closing tag"); + ezxml_close_tag(root); + while (*s && *s != '>') s++; + if (! *s && e != '>') return ezxml_seterr(root, "missing >"); + } + else if (! strncmp(s, "!--", 3)) { // comment + do { s = strstr(s, "--"); } while (s && *(s += 2) && *s != '>'); + if (! s || (! *s && e != '>')) + return ezxml_seterr(root, "unclosed <!--"); + } + else if (! strncmp(s, "![CDATA[", 8)) { // cdata + if ((s = strstr(s, "]]>"))) + ezxml_char_content(root, d + 8, (s += 2) - d - 10, 0); + else return ezxml_seterr(root, "unclosed <![CDATA["); + } + else if (! strncmp(s, "!DOCTYPE", 8)) { // skip <!DOCTYPE declarations + for (l = 0; *s && ((! l && *s != '>') || (l && (*s != ']' || + s[strspn(s + 1, EZXML_WS) + 1] != '>'))); + l = (*s == '[') ? 1 : l) s += strcspn(s + 1, "[]>") + 1; + if (! *s && e != '>') + return ezxml_seterr(root, "unclosed <!DOCTYPE"); + } + else if (*s == '?') { // <?...?> processing instructions + do { s = strchr(s, '?'); } while (s && *(++s) && *s != '>'); + if (! s || (! *s && e != '>')) + return ezxml_seterr(root, "unclosed <?"); + else ezxml_proc_inst(root, d + 1, s - d - 2); + } + else return ezxml_seterr(root, "syntax error"); + + if (! s || ! *s) break; + *s = '\0'; + d = ++s; + if (*s && *s != '<') { // tag character content + while (*s && *s != '<') s++; + if (*s) ezxml_char_content(root, d, s - d, 1); + else break; + } + else if (! *s) break; + } + + return (root->cur) ? ezxml_seterr(root, (root->cur->name) ? "unclosed tag" : + "root tag missing") : (ezxml_t)root; +} + +#ifdef CYGPKG_IO_FILEIO +// 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) +{ + ezxml_root_t ret; + size_t l, len = 0, ps = (size_t)sysconf(_SC_PAGESIZE); + void *s; + + if (! (s = (char *)malloc(ps))) return NULL; + do { + len += (l = fread((void *)((int)s + len), 1, ps, fp)); + if (l == ps) s = (char *)realloc((void *)s, len + ps); + } while (s && l == ps); + + if (! s) return NULL; + + ret = (ezxml_root_t)ezxml_parse_str(s, len); + ret->len = -1; // so we know to free s in ezxml_free() + + return (ezxml_t)ret; +} + +// 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) +{ + ezxml_root_t ret; + struct stat stat; + size_t len, ps = (size_t)sysconf(_SC_PAGESIZE); + void *m; + + if (fd < 0) return NULL; + + fstat(fd, &stat); + len = (stat.st_size + ps - 1) & ~(ps - 1); // round up to next page boundry +#ifdef __ECOS__ + if (0) { +#else + if ((m = mmap(NULL, len, PROT_READ | PROT_WRITE, MAP_PRIVATE, fd, 0)) != + MAP_FAILED) { + madvise(m, len, MADV_SEQUENTIAL); // optimize for sequential access + ret = (ezxml_root_t)ezxml_parse_str((char *)m, stat.st_size); + madvise(m, len, MADV_NORMAL); // put it back to normal + ret->len = len; +#endif + } + else { // mmap failed, read file into memory + if (! (m = malloc(stat.st_size))) return NULL; + len = read(fd, m, stat.st_size); + ret = (ezxml_root_t)ezxml_parse_str((char *)m, len); + ret->len = -1; + } + + return (ezxml_t)ret; +} + +// a wrapper for ezxml_parse_fd that accepts a file name +ezxml_t ezxml_parse_file(const char *file) +{ + int fd = open(file, O_RDONLY, 0); + ezxml_t ret = ezxml_parse_fd(fd); + + if (fd >= 0) close(fd); + return ret; +} +#endif +// Encodes ampersand sequences appending the results to dst, reallocating dst +// if it's length excedes max. Returns *dst. +char *ezxml_ampencode(const char *s, size_t len, char **dst, size_t *dlen, + size_t *max) +{ + const char *e; + + for (e = s + len; s != e; s++) { + while (*dlen + 10 > *max) *dst = realloc(*dst, *max += EZXML_BUFSIZE); + + switch (*s) { + case '\0': return *dst; + case '&': *dlen += sprintf(*dst + *dlen, "&"); break; + case '<': *dlen += sprintf(*dst + *dlen, "<"); break; + case '>': *dlen += sprintf(*dst + *dlen, ">"); break; + case '"': *dlen += sprintf(*dst + *dlen, """); break; + default: + if (*s >= ' ' || *s == '\n' || *s == '\t') (*dst)[(*dlen)++] = *s; + else *dlen += sprintf(*dst + *dlen, "&#%02d;", *s); + } + } + + return *dst; +} + +// Recursively converts each tag to xml appending it to s. Reallocates s if it's +// length excedes max. start is the location of the previous tag in the parent +// tag's character content. Returns *s. +char *ezxml_toxml_r(ezxml_t xml, char **s, size_t *len, size_t *max, + size_t start) +{ + int i; + char *txt = (xml->parent) ? xml->parent->txt : ""; + + // parent character content up to this tag + ezxml_ampencode(txt + start, xml->off - start, s, len, max); + + while (*len + strlen(xml->name) + 4 > *max) // reallocate s + *s = realloc(*s, *max += EZXML_BUFSIZE); + + *len += sprintf(*s + *len, "<%s", xml->name); // open tag + for (i = 0; xml->attr[i]; i += 2) { // tag attributes + while (*len + strlen(xml->attr[i]) + 7 > *max) // reallocate s + *s = realloc(*s, *max += EZXML_BUFSIZE); + + *len += sprintf(*s + *len, " %s=\"", xml->attr[i]); + ezxml_ampencode(xml->attr[i + 1], -1, s, len, max); + *len += sprintf(*s + *len, "\""); + } + + if (xml->child || *(xml->txt)) { // tag content + *len += sprintf(*s + *len, ">"); + if (xml->child) ezxml_toxml_r(xml->child, s, len, max, 0); + else ezxml_ampencode(xml->txt, -1, s, len, max); // char content + + while (*len + strlen(xml->name) + 4 > *max) // reallocate s + *s = realloc(*s, *max += EZXML_BUFSIZE); + + *len += sprintf(*s + *len, "</%s>", xml->name); // close tag + } + else *len += sprintf(*s + *len, "/>"); // self closing tag + + if (xml->ordered) return ezxml_toxml_r(xml->ordered, s, len, max, xml->off); + return ezxml_ampencode(txt + xml->off, -1, s, len, max); +} + +// converts an ezxml structure back to xml, returning it as a string that must +// be freed +char *ezxml_toxml(ezxml_t xml) +{ + ezxml_t p = xml->parent; + size_t len = 0, max = EZXML_BUFSIZE; + char *s = strcpy((char *)malloc(max), ""); + + if (! xml || ! xml->name) return realloc(s, len + 1); + + xml->parent = NULL; + ezxml_toxml_r(xml, &s, &len, &max, 0); + xml->parent = p; + + return realloc(s, len + 1); +} + +// free the memory allocated for the ezxml structure +void ezxml_free(ezxml_t xml) +{ + void *m = NULL; // assigned to null to avoid compiler warning + size_t len = 0; + int i; + + if (! xml) return; + + if (! xml->parent) { + m = ((ezxml_root_t)xml)->m; + len = ((ezxml_root_t)xml)->len; + + if (((ezxml_root_t)xml)->pi) { + for (i = 0; ((ezxml_root_t)xml)->pi[i]; i++) + free(((ezxml_root_t)xml)->pi[i]); + free(((ezxml_root_t)xml)->pi); + } + } + + ezxml_free(xml->child); + ezxml_free(xml->ordered); + + if (xml->attr[0]) free((void *)xml->attr); + if ((xml->flags & EZXML_TXTM)) free((void *)xml->txt); + free((void *)xml); + + if (len == -1) free(m); +#ifndef __ECOS__ + else if (len) munmap(m, len); +#endif +} + +// return parser error message or empty string if none +const char *ezxml_error(ezxml_t xml) +{ + while (xml->parent) xml = xml->parent; + return ((ezxml_root_t)xml)->err; +} + +#ifdef EZXMLTEST // test harness + +int main(int argc, char **argv) +{ + ezxml_t xml; + char *s; + + if (argc != 2) return fprintf(stderr, "usage: %s xmlfile\n", argv[0]); + + xml = ezxml_parse_file(argv[1]); + printf("%s", (s = ezxml_toxml(xml))); + fprintf(stderr, "%s", ezxml_error(xml)); + free(s); + ezxml_free(xml); + + return 0; +} + +#endif // EZXMLTEST
new file mode 100644 --- /dev/null +++ b/packages/services/ezxml/current/tests/ezxml.c @@ -0,0 +1,107 @@ +//================================================================= +// +// ezxml.c +// +// ezml test cases +// +//========================================================================== +//####ECOSGPLCOPYRIGHTBEGIN#### +// ------------------------------------------- +// This file is part of eCos, the Embedded Configurable Operating System. +// Copyright (C) 2005 Andrew Lunn +// +// eCos is free software; you can redistribute it and/or modify it under +// the terms of the GNU General Public License as published by the Free +// Software Foundation; either version 2 or (at your option) any later version. +// +// eCos is distributed in the hope that it will be useful, but WITHOUT ANY +// WARRANTY; without even the implied warranty of MERCHANTABILITY or +// FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +// for more details. +// +// You should have received a copy of the GNU General Public License along +// with eCos; if not, write to the Free Software Foundation, Inc., +// 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. +// +// As a special exception, if other files instantiate templates or use macros +// or inline functions from this file, or you compile this file and link it +// with other works to produce a work based on this file, this file does not +// by itself cause the resulting work to be covered by the GNU General Public +// License. However the source code for this file must still be made available +// in accordance with section (3) of the GNU General Public License. +// +// This exception does not invalidate any other reasons why a work based on +// this file might be covered by the GNU General Public License. +// +// ------------------------------------------- +//####ECOSGPLCOPYRIGHTEND#### +//========================================================================== +//#####DESCRIPTIONBEGIN#### +// +// Author(s): asl +// Contributors: asl +// Date: 2005-01-31 +// Description: +//####DESCRIPTIONEND#### + +#include <cyg/infra/testcase.h> +#include <cyg/infra/diag.h> +#include <ezxml.h> + +static char document[] = +"<?xml version=\"1.0\"?>" +"<formula1>" +" <team name=\"McLaren\">" +" <driver>" +" <name>Kimi Raikkonen</name>" +" <points>45</points>" +" </driver>" +" <driver>" +" <name>David Coultard</name>" +" <points>24</points>" +" </driver>" +" </team>" +"</formula1>"; + +struct results_s +{ + char * driver; + char * team; + char * points; +}; + +static struct results_s results[]= + {{ "Kimi Raikkonen", "McLaren", "45"}, + { "David Coultard", "McLaren", "24"}}; + +externC void +cyg_start( void ) +{ + ezxml_t f1, team, driver; + const char * teamname; + int i; + + CYG_TEST_INIT(); + + f1 = ezxml_parse_str(document, sizeof(document)); + + for (team = ezxml_child(f1, "team"); team; team = team->next) { + teamname = ezxml_attr(team, "name"); + for (i=0,driver = ezxml_child(team, "driver"); + driver; + driver = driver->next,i++) { + if (strcmp(results[i].driver, ezxml_child(driver, "name")->txt) || + strcmp(results[i].team, teamname) || + strcmp(results[i].points, ezxml_child(driver, "points")->txt)) + CYG_TEST_FAIL("Parser failed first test"); + } + } + + if (strcmp(ezxml_get(f1, "team", 0, "driver", 1, "name", -1)->txt, + "David Coultard")) + CYG_TEST_FAIL_FINISH("Parser failed second test"); + else + CYG_TEST_PASS_FINISH("Parser passed"); + + ezxml_free(f1); +}