---

xmlt.h

Go to the documentation of this file.

/*
 *  xmlt.h - XML data structure.
 *           This file is part of the FreeLCD package.
 *
 *  $Id: xmlt_8h-source.html,v 1.1 2003/02/16 22:50:41 unicorn Exp $
 *
 *  This program 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 of the License, or (at your
 *  option) any later version.
 * 
 *  This program 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 this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *  Copyright (c) 2002, 2003, Jeroen van den Berg <[email protected]>
 */


#ifndef _XMLT_H
#define _XMLT_H

#include "slist.h"
#include "dictionary.h"

#define XML_UNKNOWN_TAG -1

#define XML_UNKNOWN_ATTRIBUTE -1

typedef struct
{
  int attribute; 
  char *value; 
  char *unknown_attrib; 
}
xml_attribute;

typedef enum
{
  NODE, CDATA
}
xml_node_t;

/* This struct represents a tag or character data in the XML document.
 * The exact behavior depends on the \a type field. If this is a NODE,
 * it represents a tag. A tag that can be translated with a dictionary
 * is stored by its respective integer value. If the tag was not found,
 * \a type is \ref XML_UNKNOWN_TAG, and the literal tag is stored in
 * \a cdata. If \a type is CDATA, all fields except for \a cdata and
 * \a parent lose their meaning.
 */
typedef struct _xml_node
{
  xml_node_t type; 
  int tag; 
  struct _xml_node *parent;
  slist attributes; 
  slist children; 
  char *cdata; 
}
xml_node;

void *
xmlt_create_context (void (*callback) (void *, xml_node *),
                     void *cb_data,
                     dictionary *tags, dictionary *attribs);

int 
xmlt_parse (void *context, const char *data, size_t len);

void 
xmlt_free_context (void *context);

void 
xmlt_free_document (xml_node *doc);

void
xmlt_rescan_document (xml_node *doc, dictionary *tags, dictionary *attribs);

xml_node *
xmlt_get_next (xml_node *iter, xml_node *doc);

xml_node *
xmlt_get_next_shallow (xml_node *iter);

/* Find the first occurrence of a certain tag, starting right after the
 * given iterator, or at the first child of the document node if this
 * iterator is NULL. Searching is not done in depth.
 */
xml_node *
xmlt_find (xml_node *doc, xml_node *iter, int tag);

/*  Same as xmlt_find, but with a customizable compare function */
xml_node *
xmlt_find_if (xml_node *doc, xml_node *iter, int(*compare)(xml_node*));

/*  Get the contents of a node's attribute. Returns 0 if the attribute
 *  does not exist.
 */
const char *
xmlt_get_attrib (xml_node *node, int attribute);

/* Get the first character data beneath a given node */
const char *
xmlt_get_first_cdata (xml_node *node);

/*  Call the given function with a given pointer and every node in the 
 *  document 
 */
void
xmlt_for_each (xml_node *doc, void *user_data,
               void (*func) (void *, xml_node *));

#endif /* Multiple include guard */

---