mirror of
https://github.com/michaelrsweet/mxml.git
synced 2024-11-14 07:45:31 +00:00
bcfa6ef518
Add mxmlNewOpaquef and mxmlSetOpaquef functions. Fix discussion writing code to look for opaque strings. Fix dependencies for documentation generation.
336 lines
12 KiB
C
336 lines
12 KiB
C
/*
|
|
* Header file for Mini-XML, a small XML file parsing library.
|
|
*
|
|
* Copyright 2003-2017 by Michael R Sweet.
|
|
*
|
|
* These coded instructions, statements, and computer programs are the
|
|
* property of Michael R Sweet and are protected by Federal copyright
|
|
* law. Distribution and use rights are outlined in the file "COPYING"
|
|
* which should have been included with this file. If this file is
|
|
* missing or damaged, see the license at:
|
|
*
|
|
* https://michaelrsweet.github.io/mxml
|
|
*/
|
|
|
|
/*
|
|
* Prevent multiple inclusion...
|
|
*/
|
|
|
|
#ifndef _mxml_h_
|
|
# define _mxml_h_
|
|
|
|
/*
|
|
* Include necessary headers...
|
|
*/
|
|
|
|
# include <stdio.h>
|
|
# include <stdlib.h>
|
|
# include <string.h>
|
|
# include <ctype.h>
|
|
# include <errno.h>
|
|
|
|
|
|
/*
|
|
* Constants...
|
|
*/
|
|
|
|
# define MXML_MAJOR_VERSION 2 /* Major version number */
|
|
# define MXML_MINOR_VERSION 11 /* Minor version number */
|
|
|
|
# define MXML_TAB 8 /* Tabs every N columns */
|
|
|
|
# define MXML_NO_CALLBACK 0 /* Don't use a type callback */
|
|
# define MXML_INTEGER_CALLBACK mxml_integer_cb
|
|
/* Treat all data as integers */
|
|
# define MXML_OPAQUE_CALLBACK mxml_opaque_cb
|
|
/* Treat all data as opaque */
|
|
# define MXML_REAL_CALLBACK mxml_real_cb
|
|
/* Treat all data as real numbers */
|
|
# define MXML_TEXT_CALLBACK 0 /* Treat all data as text */
|
|
# define MXML_IGNORE_CALLBACK mxml_ignore_cb
|
|
/* Ignore all non-element content */
|
|
|
|
# define MXML_NO_PARENT 0 /* No parent for the node */
|
|
|
|
# define MXML_DESCEND 1 /* Descend when finding/walking */
|
|
# define MXML_NO_DESCEND 0 /* Don't descend when finding/walking */
|
|
# define MXML_DESCEND_FIRST -1 /* Descend for first find */
|
|
|
|
# define MXML_WS_BEFORE_OPEN 0 /* Callback for before open tag */
|
|
# define MXML_WS_AFTER_OPEN 1 /* Callback for after open tag */
|
|
# define MXML_WS_BEFORE_CLOSE 2 /* Callback for before close tag */
|
|
# define MXML_WS_AFTER_CLOSE 3 /* Callback for after close tag */
|
|
|
|
# define MXML_ADD_BEFORE 0 /* Add node before specified node */
|
|
# define MXML_ADD_AFTER 1 /* Add node after specified node */
|
|
# define MXML_ADD_TO_PARENT NULL /* Add node relative to parent */
|
|
|
|
|
|
/*
|
|
* Data types...
|
|
*/
|
|
|
|
typedef enum mxml_sax_event_e /**** SAX event type. ****/
|
|
{
|
|
MXML_SAX_CDATA, /* CDATA node */
|
|
MXML_SAX_COMMENT, /* Comment node */
|
|
MXML_SAX_DATA, /* Data node */
|
|
MXML_SAX_DIRECTIVE, /* Processing directive node */
|
|
MXML_SAX_ELEMENT_CLOSE, /* Element closed */
|
|
MXML_SAX_ELEMENT_OPEN /* Element opened */
|
|
} mxml_sax_event_t;
|
|
|
|
typedef enum mxml_type_e /**** The XML node type. ****/
|
|
{
|
|
MXML_IGNORE = -1, /* Ignore/throw away node @since Mini-XML 2.3@ */
|
|
MXML_ELEMENT, /* XML element with attributes */
|
|
MXML_INTEGER, /* Integer value */
|
|
MXML_OPAQUE, /* Opaque string */
|
|
MXML_REAL, /* Real value */
|
|
MXML_TEXT, /* Text fragment */
|
|
MXML_CUSTOM /* Custom data @since Mini-XML 2.1@ */
|
|
} mxml_type_t;
|
|
|
|
typedef void (*mxml_custom_destroy_cb_t)(void *);
|
|
/**** Custom data destructor ****/
|
|
|
|
typedef void (*mxml_error_cb_t)(const char *);
|
|
/**** Error callback function ****/
|
|
|
|
typedef struct mxml_attr_s /**** An XML element attribute value. @private@ ****/
|
|
{
|
|
char *name; /* Attribute name */
|
|
char *value; /* Attribute value */
|
|
} mxml_attr_t;
|
|
|
|
typedef struct mxml_element_s /**** An XML element value. @private@ ****/
|
|
{
|
|
char *name; /* Name of element */
|
|
int num_attrs; /* Number of attributes */
|
|
mxml_attr_t *attrs; /* Attributes */
|
|
} mxml_element_t;
|
|
|
|
typedef struct mxml_text_s /**** An XML text value. @private@ ****/
|
|
{
|
|
int whitespace; /* Leading whitespace? */
|
|
char *string; /* Fragment string */
|
|
} mxml_text_t;
|
|
|
|
typedef struct mxml_custom_s /**** An XML custom value. @private@ ****/
|
|
{
|
|
void *data; /* Pointer to (allocated) custom data */
|
|
mxml_custom_destroy_cb_t destroy; /* Pointer to destructor function */
|
|
} mxml_custom_t;
|
|
|
|
typedef union mxml_value_u /**** An XML node value. @private@ ****/
|
|
{
|
|
mxml_element_t element; /* Element */
|
|
int integer; /* Integer number */
|
|
char *opaque; /* Opaque string */
|
|
double real; /* Real number */
|
|
mxml_text_t text; /* Text fragment */
|
|
mxml_custom_t custom; /* Custom data @since Mini-XML 2.1@ */
|
|
} mxml_value_t;
|
|
|
|
struct mxml_node_s /**** An XML node. @private@ ****/
|
|
{
|
|
mxml_type_t type; /* Node type */
|
|
struct mxml_node_s *next; /* Next node under same parent */
|
|
struct mxml_node_s *prev; /* Previous node under same parent */
|
|
struct mxml_node_s *parent; /* Parent node */
|
|
struct mxml_node_s *child; /* First child node */
|
|
struct mxml_node_s *last_child; /* Last child node */
|
|
mxml_value_t value; /* Node value */
|
|
int ref_count; /* Use count */
|
|
void *user_data; /* User data */
|
|
};
|
|
|
|
typedef struct mxml_node_s mxml_node_t; /**** An XML node. ****/
|
|
|
|
struct mxml_index_s /**** An XML node index. @private@ ****/
|
|
{
|
|
char *attr; /* Attribute used for indexing or NULL */
|
|
int num_nodes; /* Number of nodes in index */
|
|
int alloc_nodes; /* Allocated nodes in index */
|
|
int cur_node; /* Current node */
|
|
mxml_node_t **nodes; /* Node array */
|
|
};
|
|
|
|
typedef struct mxml_index_s mxml_index_t;
|
|
/**** An XML node index. ****/
|
|
|
|
typedef int (*mxml_custom_load_cb_t)(mxml_node_t *, const char *);
|
|
/**** Custom data load callback function ****/
|
|
|
|
typedef char *(*mxml_custom_save_cb_t)(mxml_node_t *);
|
|
/**** Custom data save callback function ****/
|
|
|
|
typedef int (*mxml_entity_cb_t)(const char *);
|
|
/**** Entity callback function */
|
|
|
|
typedef mxml_type_t (*mxml_load_cb_t)(mxml_node_t *);
|
|
/**** Load callback function ****/
|
|
|
|
typedef const char *(*mxml_save_cb_t)(mxml_node_t *, int);
|
|
/**** Save callback function ****/
|
|
|
|
typedef void (*mxml_sax_cb_t)(mxml_node_t *, mxml_sax_event_t, void *);
|
|
/**** SAX callback function ****/
|
|
|
|
|
|
/*
|
|
* C++ support...
|
|
*/
|
|
|
|
# ifdef __cplusplus
|
|
extern "C" {
|
|
# endif /* __cplusplus */
|
|
|
|
/*
|
|
* Prototypes...
|
|
*/
|
|
|
|
extern void mxmlAdd(mxml_node_t *parent, int where,
|
|
mxml_node_t *child, mxml_node_t *node);
|
|
extern void mxmlDelete(mxml_node_t *node);
|
|
extern void mxmlElementDeleteAttr(mxml_node_t *node,
|
|
const char *name);
|
|
extern const char *mxmlElementGetAttr(mxml_node_t *node, const char *name);
|
|
extern const char *mxmlElementGetAttrByIndex(mxml_node_t *node, int idx, const char **name);
|
|
extern int mxmlElementGetAttrCount(mxml_node_t *node);
|
|
extern void mxmlElementSetAttr(mxml_node_t *node, const char *name,
|
|
const char *value);
|
|
extern void mxmlElementSetAttrf(mxml_node_t *node, const char *name,
|
|
const char *format, ...)
|
|
# ifdef __GNUC__
|
|
__attribute__ ((__format__ (__printf__, 3, 4)))
|
|
# endif /* __GNUC__ */
|
|
;
|
|
extern int mxmlEntityAddCallback(mxml_entity_cb_t cb);
|
|
extern const char *mxmlEntityGetName(int val);
|
|
extern int mxmlEntityGetValue(const char *name);
|
|
extern void mxmlEntityRemoveCallback(mxml_entity_cb_t cb);
|
|
extern mxml_node_t *mxmlFindElement(mxml_node_t *node, mxml_node_t *top,
|
|
const char *element, const char *attr,
|
|
const char *value, int descend);
|
|
extern mxml_node_t *mxmlFindPath(mxml_node_t *node, const char *path);
|
|
extern const char *mxmlGetCDATA(mxml_node_t *node);
|
|
extern const void *mxmlGetCustom(mxml_node_t *node);
|
|
extern const char *mxmlGetElement(mxml_node_t *node);
|
|
extern mxml_node_t *mxmlGetFirstChild(mxml_node_t *node);
|
|
extern int mxmlGetInteger(mxml_node_t *node);
|
|
extern mxml_node_t *mxmlGetLastChild(mxml_node_t *node);
|
|
extern mxml_node_t *mxmlGetNextSibling(mxml_node_t *node);
|
|
extern const char *mxmlGetOpaque(mxml_node_t *node);
|
|
extern mxml_node_t *mxmlGetParent(mxml_node_t *node);
|
|
extern mxml_node_t *mxmlGetPrevSibling(mxml_node_t *node);
|
|
extern double mxmlGetReal(mxml_node_t *node);
|
|
extern int mxmlGetRefCount(mxml_node_t *node);
|
|
extern const char *mxmlGetText(mxml_node_t *node, int *whitespace);
|
|
extern mxml_type_t mxmlGetType(mxml_node_t *node);
|
|
extern void *mxmlGetUserData(mxml_node_t *node);
|
|
extern void mxmlIndexDelete(mxml_index_t *ind);
|
|
extern mxml_node_t *mxmlIndexEnum(mxml_index_t *ind);
|
|
extern mxml_node_t *mxmlIndexFind(mxml_index_t *ind,
|
|
const char *element,
|
|
const char *value);
|
|
extern int mxmlIndexGetCount(mxml_index_t *ind);
|
|
extern mxml_index_t *mxmlIndexNew(mxml_node_t *node, const char *element,
|
|
const char *attr);
|
|
extern mxml_node_t *mxmlIndexReset(mxml_index_t *ind);
|
|
extern mxml_node_t *mxmlLoadFd(mxml_node_t *top, int fd,
|
|
mxml_type_t (*cb)(mxml_node_t *));
|
|
extern mxml_node_t *mxmlLoadFile(mxml_node_t *top, FILE *fp,
|
|
mxml_type_t (*cb)(mxml_node_t *));
|
|
extern mxml_node_t *mxmlLoadString(mxml_node_t *top, const char *s,
|
|
mxml_type_t (*cb)(mxml_node_t *));
|
|
extern mxml_node_t *mxmlNewCDATA(mxml_node_t *parent, const char *string);
|
|
extern mxml_node_t *mxmlNewCustom(mxml_node_t *parent, void *data,
|
|
mxml_custom_destroy_cb_t destroy);
|
|
extern mxml_node_t *mxmlNewElement(mxml_node_t *parent, const char *name);
|
|
extern mxml_node_t *mxmlNewInteger(mxml_node_t *parent, int integer);
|
|
extern mxml_node_t *mxmlNewOpaque(mxml_node_t *parent, const char *opaque);
|
|
extern mxml_node_t *mxmlNewOpaquef(mxml_node_t *parent, const char *format, ...)
|
|
# ifdef __GNUC__
|
|
__attribute__ ((__format__ (__printf__, 2, 3)))
|
|
# endif /* __GNUC__ */
|
|
;
|
|
extern mxml_node_t *mxmlNewReal(mxml_node_t *parent, double real);
|
|
extern mxml_node_t *mxmlNewText(mxml_node_t *parent, int whitespace, const char *string);
|
|
extern mxml_node_t *mxmlNewTextf(mxml_node_t *parent, int whitespace, const char *format, ...)
|
|
# ifdef __GNUC__
|
|
__attribute__ ((__format__ (__printf__, 3, 4)))
|
|
# endif /* __GNUC__ */
|
|
;
|
|
extern mxml_node_t *mxmlNewXML(const char *version);
|
|
extern int mxmlRelease(mxml_node_t *node);
|
|
extern void mxmlRemove(mxml_node_t *node);
|
|
extern int mxmlRetain(mxml_node_t *node);
|
|
extern char *mxmlSaveAllocString(mxml_node_t *node,
|
|
mxml_save_cb_t cb);
|
|
extern int mxmlSaveFd(mxml_node_t *node, int fd,
|
|
mxml_save_cb_t cb);
|
|
extern int mxmlSaveFile(mxml_node_t *node, FILE *fp,
|
|
mxml_save_cb_t cb);
|
|
extern int mxmlSaveString(mxml_node_t *node, char *buffer,
|
|
int bufsize, mxml_save_cb_t cb);
|
|
extern mxml_node_t *mxmlSAXLoadFd(mxml_node_t *top, int fd,
|
|
mxml_type_t (*cb)(mxml_node_t *),
|
|
mxml_sax_cb_t sax, void *sax_data);
|
|
extern mxml_node_t *mxmlSAXLoadFile(mxml_node_t *top, FILE *fp,
|
|
mxml_type_t (*cb)(mxml_node_t *),
|
|
mxml_sax_cb_t sax, void *sax_data);
|
|
extern mxml_node_t *mxmlSAXLoadString(mxml_node_t *top, const char *s,
|
|
mxml_type_t (*cb)(mxml_node_t *),
|
|
mxml_sax_cb_t sax, void *sax_data);
|
|
extern int mxmlSetCDATA(mxml_node_t *node, const char *data);
|
|
extern int mxmlSetCustom(mxml_node_t *node, void *data,
|
|
mxml_custom_destroy_cb_t destroy);
|
|
extern void mxmlSetCustomHandlers(mxml_custom_load_cb_t load,
|
|
mxml_custom_save_cb_t save);
|
|
extern int mxmlSetElement(mxml_node_t *node, const char *name);
|
|
extern void mxmlSetErrorCallback(mxml_error_cb_t cb);
|
|
extern int mxmlSetInteger(mxml_node_t *node, int integer);
|
|
extern int mxmlSetOpaque(mxml_node_t *node, const char *opaque);
|
|
extern int mxmlSetOpaquef(mxml_node_t *node, const char *format, ...)
|
|
# ifdef __GNUC__
|
|
__attribute__ ((__format__ (__printf__, 2, 3)))
|
|
# endif /* __GNUC__ */
|
|
;
|
|
extern int mxmlSetReal(mxml_node_t *node, double real);
|
|
extern int mxmlSetText(mxml_node_t *node, int whitespace,
|
|
const char *string);
|
|
extern int mxmlSetTextf(mxml_node_t *node, int whitespace,
|
|
const char *format, ...)
|
|
# ifdef __GNUC__
|
|
__attribute__ ((__format__ (__printf__, 3, 4)))
|
|
# endif /* __GNUC__ */
|
|
;
|
|
extern int mxmlSetUserData(mxml_node_t *node, void *data);
|
|
extern void mxmlSetWrapMargin(int column);
|
|
extern mxml_node_t *mxmlWalkNext(mxml_node_t *node, mxml_node_t *top,
|
|
int descend);
|
|
extern mxml_node_t *mxmlWalkPrev(mxml_node_t *node, mxml_node_t *top,
|
|
int descend);
|
|
|
|
|
|
/*
|
|
* Semi-private functions...
|
|
*/
|
|
|
|
extern void mxml_error(const char *format, ...);
|
|
extern mxml_type_t mxml_ignore_cb(mxml_node_t *node);
|
|
extern mxml_type_t mxml_integer_cb(mxml_node_t *node);
|
|
extern mxml_type_t mxml_opaque_cb(mxml_node_t *node);
|
|
extern mxml_type_t mxml_real_cb(mxml_node_t *node);
|
|
|
|
|
|
/*
|
|
* C++ support...
|
|
*/
|
|
|
|
# ifdef __cplusplus
|
|
}
|
|
# endif /* __cplusplus */
|
|
#endif /* !_mxml_h_ */
|