Contents

• Enumerations
• Functions
• Structures
• Types
• Unions

Enumerations

• mxml_type_e

mxml_type_e

The XML node type.

Values

Functions

• mxmlAdd()
• mxmlDelete()
• mxmlElementGetAttr()
• mxmlElementSetAttr()
• mxmlEntityGetName()
• mxmlEntityGetValue()
• mxmlFindElement()
• mxmlLoadFile()
• mxmlLoadString()
• mxmlNewElement()
• mxmlNewInteger()
• mxmlNewOpaque()
• mxmlNewReal()
• mxmlNewText()
• mxmlNewTextf()
• mxmlRemove()
• mxmlSaveAllocString()
• mxmlSaveFile()
• mxmlSaveString()
• mxmlSetElement()
• mxmlSetErrorCallback()
• mxmlSetInteger()
• mxmlSetOpaque()
• mxmlSetReal()
• mxmlSetText()
• mxmlSetTextf()
• mxmlWalkNext()
• mxmlWalkPrev()

mxmlAdd()

Add a node to a tree. Adds the specified node to the parent. If the child argument is not NULL, puts the new node before or after the specified child depending on the value of the where argument. If the child argument is NULL, puts the new node at the beginning of the child list (MXML_ADD_BEFORE) or at the end of the child list (MXML_ADD_AFTER). The constant MXML_ADD_TO_PARENT can be used to specify a NULL child pointer.

Syntax

void
mxmlAdd(
    mxml_node_t * parent,
    int where,
    mxml_node_t * child,
    mxml_node_t * node);

Arguments

Returns

Nothing.

mxmlDelete()

Delete a node and all of its children. If the specified node has a parent, this function first removes the node from its parent using the mxmlRemove() function.

Syntax

void
mxmlDelete(
    mxml_node_t * node);

Arguments

Returns

Nothing.

mxmlElementGetAttr()

Get an attribute. This function returns NULL if the node is not an element or the named attribute does not exist.

Syntax

const char *
mxmlElementGetAttr(
    mxml_node_t * node,
    const char * name);

Arguments

Returns

Attribute value or NULL

mxmlElementSetAttr()

Set an attribute. If the named attribute already exists, the value of the attribute is replaced by the new string value. The string value is copied into the element node. This function does nothing if the node is not an element.

Syntax

void
mxmlElementSetAttr(
    mxml_node_t * node,
    const char * name,
    const char * value);

Arguments

Returns

Nothing.

mxmlEntityGetName()

Get the name that corresponds to the character value. If val does not need to be represented by a named entity, NULL is returned.

Syntax

const char *
mxmlEntityGetName(
    int val);

Arguments

Returns

Entity name or NULL

mxmlEntityGetValue()

Get the character corresponding to a named entity. The entity name can also be a numeric constant. -1 is returned if the name is not known.

Syntax

int
mxmlEntityGetValue(
    const char * name);

Arguments

Returns

Character value or -1 on error

mxmlFindElement()

Find the named element. The search is constrained by the name, attribute name, and value; any NULL names or values are treated as wildcards, so different kinds of searches can be implemented by looking for all elements of a given name or all elements with a specific attribute. The descend argument determines whether the search descends into child nodes; normally you will use MXML_DESCEND_FIRST for the initial search and MXML_NO_DESCEND to find additional direct descendents of the node. The top node argument constrains the search to a particular node's children.

Syntax

mxml_node_t *
mxmlFindElement(
    mxml_node_t * node,
    mxml_node_t * top,
    const char * name,
    const char * attr,
    const char * value,
    int descend);

Arguments

Returns

Element node or NULL

mxmlLoadFile()

Load a file into an XML node tree. The nodes in the specified file are added to the specified top node. If no top node is provided, the XML file MUST be well-formed with a single parent node like <?xml> for the entire file. The callback function returns the value type that should be used for child nodes. If MXML_NO_CALLBACK is specified then all child nodes will be either MXML_ELEMENT or MXML_TEXT nodes. The constants MXML_INTEGER_CALLBACK, MXML_OPAQUE_CALLBACK, MXML_REAL_CALLBACK, and MXML_TEXT_CALLBACK are defined for loading child nodes of the specified type.

Syntax

mxml_node_t *
mxmlLoadFile(
    mxml_node_t * top,
    FILE * fp,
    mxml_type_t (*cb)(mxml_node_t *node));

Arguments

Returns

First node or NULL if the file could not be read.

mxmlLoadString()

Load a string into an XML node tree. The nodes in the specified string are added to the specified top node. If no top node is provided, the XML string MUST be well-formed with a single parent node like <?xml> for the entire string. The callback function returns the value type that should be used for child nodes. If MXML_NO_CALLBACK is specified then all child nodes will be either MXML_ELEMENT or MXML_TEXT nodes. The constants MXML_INTEGER_CALLBACK, MXML_OPAQUE_CALLBACK, MXML_REAL_CALLBACK, and MXML_TEXT_CALLBACK are defined for loading child nodes of the specified type.

Syntax

mxml_node_t *
mxmlLoadString(
    mxml_node_t * top,
    const char * s,
    mxml_type_t (*cb)(mxml_node_t *node));

Arguments

Returns

First node or NULL if the string has errors.

mxmlNewElement()

Create a new element node. The new element node is added to the end of the specified parent's child list. The constant MXML_NO_PARENT can be used to specify that the new element node has no parent.

Syntax

mxml_node_t *
mxmlNewElement(
    mxml_node_t * parent,
    const char * name);

Arguments

Returns

New node

mxmlNewInteger()

Create a new integer node. The new integer node is added to the end of the specified parent's child list. The constant MXML_NO_PARENT can be used to specify that the new integer node has no parent.

Syntax

mxml_node_t *
mxmlNewInteger(
    mxml_node_t * parent,
    int integer);

Arguments

Returns

New node

mxmlNewOpaque()

Create a new opaque string. The new opaque node is added to the end of the specified parent's child list. The constant MXML_NO_PARENT can be used to specify that the new opaque node has no parent. The opaque string must be nul-terminated and is copied into the new node.

Syntax

mxml_node_t *
mxmlNewOpaque(
    mxml_node_t * parent,
    const char * opaque);

Arguments

Returns

New node

mxmlNewReal()

Create a new real number node. The new real number node is added to the end of the specified parent's child list. The constant MXML_NO_PARENT can be used to specify that the new real number node has no parent.

Syntax

mxml_node_t *
mxmlNewReal(
    mxml_node_t * parent,
    double real);

Arguments

Returns

New node

mxmlNewText()

Create a new text fragment node. The new text node is added to the end of the specified parent's child list. The constant MXML_NO_PARENT can be used to specify that the new text node has no parent. The whitespace parameter is used to specify whether leading whitespace is present before the node. The text string must be nul-terminated and is copied into the new node.

Syntax

mxml_node_t *
mxmlNewText(
    mxml_node_t * parent,
    int whitespace,
    const char * string);

Arguments

Returns

New node

mxmlNewTextf()

Create a new formatted text fragment node. The new text node is added to the end of the specified parent's child list. The constant MXML_NO_PARENT can be used to specify that the new text node has no parent. The whitespace parameter is used to specify whether leading whitespace is present before the node. The format string must be nul-terminated and is formatted into the new node.

Syntax

mxml_node_t *
mxmlNewTextf(
    mxml_node_t * parent,
    int whitespace,
    const char * format,
    ...);

Arguments

Returns

New node

mxmlRemove()

Remove a node from its parent. Does not free memory used by the node - use mxmlDelete() for that. This function does nothing if the node has no parent.

Syntax

void
mxmlRemove(
    mxml_node_t * node);

Arguments

Returns

Nothing.

mxmlSaveAllocString()

Save an XML node tree to an allocated string. This function returns a pointer to a string containing the textual representation of the XML node tree. The string should be freed using the free() function when you are done with it. NULL is returned if the node would produce an empty string or if the string cannot be allocated.

Syntax

char *
mxmlSaveAllocString(
    mxml_node_t * node,
    int (*cb)(mxml_node_t *node, int ws));

Arguments

Returns

Allocated string or NULL

mxmlSaveFile()

Save an XML tree to a file. The callback argument specifies a function that returns a whitespace character or nul (0) before and after each element. If MXML_NO_CALLBACK is specified, whitespace will only be added before MXML_TEXT nodes with leading whitespace and before attribute names inside opening element tags.

Syntax

int
mxmlSaveFile(
    mxml_node_t * node,
    FILE * fp,
    int (*cb)(mxml_node_t *node, int ws));

Arguments

Returns

0 on success, -1 on error.

mxmlSaveString()

Save an XML node tree to a string. This function returns the total number of bytes that would be required for the string but only copies (bufsize - 1) characters into the specified buffer.

Syntax

int
mxmlSaveString(
    mxml_node_t * node,
    char * buffer,
    int bufsize,
    int (*cb)(mxml_node_t *node, int ws));

Arguments

Returns

Size of string

mxmlSetElement()

Set the name of an element node. The node is not changed if it is not an element node.

Syntax

int
mxmlSetElement(
    mxml_node_t * node,
    const char * name);

Arguments

Returns

0 on success, -1 on failure

mxmlSetErrorCallback()

Set the error message callback.

Syntax

void
mxmlSetErrorCallback(
    void (*cb)(const char *));

Arguments

Returns

Nothing.

mxmlSetInteger()

Set the value of an integer node. The node is not changed if it is not an integer node.

Syntax

int
mxmlSetInteger(
    mxml_node_t * node,
    int integer);

Arguments

Returns

0 on success, -1 on failure

mxmlSetOpaque()

Set the value of an opaque node. The node is not changed if it is not an opaque node.

Syntax

int
mxmlSetOpaque(
    mxml_node_t * node,
    const char * opaque);

Arguments

Returns

0 on success, -1 on failure

mxmlSetReal()

Set the value of a real number node. The node is not changed if it is not a real number node.

Syntax

int
mxmlSetReal(
    mxml_node_t * node,
    double real);

Arguments

Returns

0 on success, -1 on failure

mxmlSetText()

Set the value of a text node. The node is not changed if it is not a text node.

Syntax

int
mxmlSetText(
    mxml_node_t * node,
    int whitespace,
    const char * string);

Arguments

Returns

0 on success, -1 on failure

mxmlSetTextf()

Set the value of a text node to a formatted string. The node is not changed if it is not a text node.

Syntax

int
mxmlSetTextf(
    mxml_node_t * node,
    int whitespace,
    const char * format,
    ...);

Arguments

Returns

0 on success, -1 on failure

mxmlWalkNext()

Walk to the next logical node in the tree. The descend argument controls whether the first child is considered to be the next node. The top node argument constrains the walk to the node's children.

Syntax

mxml_node_t *
mxmlWalkNext(
    mxml_node_t * node,
    mxml_node_t * top,
    int descend);

Arguments

Returns

Next node or NULL

mxmlWalkPrev()

Walk to the previous logical node in the tree. The descend argument controls whether the previous node's last child is considered to be the previous node. The top node argument constrains the walk to the node's children.

Syntax

mxml_node_t *
mxmlWalkPrev(
    mxml_node_t * node,
    mxml_node_t * top,
    int descend);

Arguments

Returns

Previous node or NULL

Structures

• mxml_attr_s
• mxml_node_s
• mxml_text_s
• mxml_value_s

mxml_attr_s

An XML element attribute value.

Definition

struct mxml_attr_s
{
  char * name;
  char * value;
};

Members

mxml_node_s

An XML node.

Definition

struct mxml_node_s
{
  struct mxml_node_s * child;
  struct mxml_node_s * last_child;
  struct mxml_node_s * next;
  struct mxml_node_s * parent;
  struct mxml_node_s * prev;
  mxml_type_t type;
  mxml_value_t value;
};

Members

mxml_text_s

An XML text value.

Definition

struct mxml_text_s
{
  char * string;
  int whitespace;
};

Members

mxml_value_s

An XML element value.

Definition

struct mxml_value_s
{
  mxml_attr_t * attrs;
  char * name;
  int num_attrs;
};

Members

Types

• mxml_attr_t
• mxml_element_t
• mxml_node_t
• mxml_text_t
• mxml_type_t
• mxml_value_t

mxml_attr_t

An XML element attribute value.

Definition

typedef struct mxml_attr_s mxml_attr_t;

mxml_element_t

An XML element value.

Definition

typedef struct mxml_value_s mxml_element_t;

mxml_node_t

An XML node.

Definition

typedef struct mxml_node_s mxml_node_t;

mxml_text_t

An XML text value.

Definition

typedef struct mxml_text_s mxml_text_t;

mxml_type_t

The XML node type.

Definition

typedef enum mxml_type_e mxml_type_t;

mxml_value_t

An XML node value.

Definition

typedef union mxml_value_u mxml_value_t;

Unions

• mxml_value_u

mxml_value_u

An XML node value.

Definition

union mxml_value_u
{
  mxml_element_t element;
  int integer;
  char * opaque;
  double real;
  mxml_text_t text;
};

Members