lilxml.h

Go to the documentation of this file.

#if 0
liblilxml
Copyright (C) 2003 Elwood C. Downey
2022 Ludovic Pollet
 
This library is free software;
you can redistribute it and / or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation;
either
version 2.1 of the License, or (at your option) any later version.
 
This library 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
Lesser General Public License for more details.
 
You should have received a copy of the GNU Lesser General Public
License along with this library;
if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110 - 1301  USA
 
#endif
 
#pragma once
 
#include <stdio.h>
 
/* size every caller must allocate for the errmsg[]/ynot[] buffer passed to
 * parseXMLChunk(), readXMLEle(), readXMLFile() and parseXML(). Error text
 * is always truncated to fit this size, no matter how long the offending
 * XML token is. */
#define XML_ERROR_SIZE 1024
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* opaque handle types */
typedef struct xml_att_ XMLAtt;
typedef struct xml_ele_ XMLEle;
typedef struct LilXML_ LilXML;
 
 
/* creation and destruction functions */
 
extern LilXML *newLilXML();
 
extern void delLilXML(LilXML *lp);
 
extern void delXMLEle(XMLEle *e);
 
extern XMLEle **parseXMLChunk(LilXML *lp, char *buf, int size, char errmsg[]);
 
extern XMLEle *readXMLEle(LilXML *lp, int c, char errmsg[]);
 
/* search functions */
extern XMLAtt *findXMLAtt(XMLEle *e, const char *name);
 
extern XMLEle *findXMLEle(XMLEle *e, const char *tag);
 
/* iteration functions */
extern XMLEle *nextXMLEle(XMLEle *ep, int first);
 
extern XMLAtt *nextXMLAtt(XMLEle *ep, int first);
 
/* tree functions */
extern XMLEle *parentXMLEle(XMLEle *ep);
 
extern XMLEle *parentXMLAtt(XMLAtt *ap);
 
/* access functions */
extern char *tagXMLEle(XMLEle *ep);
 
extern char *pcdataXMLEle(XMLEle *ep);
 
extern char *nameXMLAtt(XMLAtt *ap);
 
extern char *valuXMLAtt(XMLAtt *ap);
 
extern int pcdatalenXMLEle(XMLEle *ep);
 
extern int nXMLEle(XMLEle *ep);
 
extern int nXMLAtt(XMLEle *ep);
 
/* editing functions */
extern XMLEle *addXMLEle(XMLEle *parent, const char *tag);
 
 
extern XMLEle *setXMLEleTag(XMLEle *ep, const char * tag);
 
extern void editXMLEle(XMLEle *ep, const char *pcdata);
 
extern XMLAtt *addXMLAtt(XMLEle *ep, const char *name, const char *value);
 
extern void rmXMLAtt(XMLEle *ep, const char *name);
 
extern void editXMLAtt(XMLAtt *ap, const char *str);
 
extern char *entityXML(char *str);
 
/* convenience functions */
extern const char *findXMLAttValu(XMLEle *ep, const char *name);
 
extern XMLEle *shallowCloneXMLEle(XMLEle * ele);
 
extern XMLEle * cloneXMLEle(XMLEle * ep, int (*replace)(void * self, XMLEle * source, XMLEle * * replace), void * self);
 
extern XMLEle *readXMLFile(FILE *fp, LilXML *lp, char errmsg[]);
 
extern void prXMLEle(FILE *fp, XMLEle *e, int level);
 
extern size_t sprXMLEle(char *s, XMLEle *ep, int level);
 
extern size_t sprlXMLEle(XMLEle *ep, int level);
 
extern size_t sprXMLCDataOffset(XMLEle * root, XMLEle * child, int level);
 
/* install alternatives to malloc/realloc/free */
extern void indi_xmlMalloc(void *(*newmalloc)(size_t size), void *(*newrealloc)(void *ptr, size_t size),
                           void (*newfree)(void *ptr));
 
#ifdef __cplusplus
}
#endif
 
/* examples.
 
        initialize a lil xml context and read an XML file in a root element
 
        LilXML *lp = newLilXML();
        char errmsg[1024];
        XMLEle *root, *ep;
        int c;
 
        while ((c = fgetc(stdin)) != EOF) {
            root = readXMLEle (lp, c, errmsg);
            if (root)
                break;
            if (errmsg[0])
                error ("Error: %s\n", errmsg);
        }
 
        print the tag and pcdata content of each child element within the root
 
        for (ep = nextXMLEle (root, 1); ep != NULL; ep = nextXMLEle (root, 0))
            printf ("%s: %s\n", tagXMLEle(ep), pcdataXMLEle(ep));
 
 
        finished with root element and with lil xml context
 
        delXMLEle (root);
        delLilXML (lp);
 */
 
/* For RCS Only -- Do Not Edit
 * @(#) $RCSfile$ $Date: 2007-09-17 16:34:48 +0300 (Mon, 17 Sep 2007) $ $Revision: 713418 $ $Name:  $
 */