comparison libpurple/xmlnode.h @ 32779:d72f2f13b60f

merge of 'c8c73eea7431e6f940916315ace40a41c8da3faa' and 'fec428131bde0ae8247941bd6a3d996c984c9189'

32778:14787acaf9d7

#endif

/**
 * The valid types for an xmlnode
 */
typedef enum _XMLNodeType
{
	XMLNODE_TYPE_TAG,		/**< Just a tag */
	XMLNODE_TYPE_ATTRIB,		/**< Has attributes */
	XMLNODE_TYPE_DATA		/**< Has data */
} XMLNodeType;

 * @param attr  The name of the attribute.
 * @param value The value of the attribute.
 */
void xmlnode_set_attrib(xmlnode *node, const char *attr, const char *value);

#if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_XMLNODE_C_)
/**
 * Sets a prefixed attribute for a node
 *
 * @param node   The node to set an attribute for.
 * @param attr   The name of the attribute to set
 * @param prefix The prefix of the attribute to ste
 * @param value  The value of the attribute
 *
 * @deprecated Use xmlnode_set_attrib_full instead.
 */
void xmlnode_set_attrib_with_prefix(xmlnode *node, const char *attr, const char *prefix, const char *value);

/**
 * Sets a namespaced attribute for a node
 *
 * @param node  The node to set an attribute for.
 * @param attr  The name of the attribute to set
 * @param xmlns The namespace of the attribute to ste
 * @param value The value of the attribute
 *
 * @deprecated Use xmlnode_set_attrib_full instead.
 */
void xmlnode_set_attrib_with_namespace(xmlnode *node, const char *attr, const char *xmlns, const char *value);
#endif /* PURPLE_DISABLE_DEPRECATED */

/**
 * Sets a namespaced attribute for a node
 *
 * @param node   The node to set an attribute for.
 * @param attr   The name of the attribute to set
 * @param xmlns  The namespace of the attribute to ste
 * @param prefix The prefix of the attribute to ste
 * @param value  The value of the attribute
 *
 * @since 2.6.0
 */
void xmlnode_set_attrib_full(xmlnode *node, const char *attr, const char *xmlns,
	const char *prefix, const char *value);

/**

 * Returns the namespace of a node
 *
 * @param node The node to get the namepsace from
 * @return The namespace of this node
 */
const char *xmlnode_get_namespace(xmlnode *node);

/**
 * Sets the prefix of a node
 *
 * @param node   The node to qualify

 * @return The prefix of this node
 */
const char *xmlnode_get_prefix(const xmlnode *node);

/**
 * Gets the parent node.
 *
 * @param child The child node.
 *
 * @return The parent or NULL.
 *
 * @since 2.6.0
 */
xmlnode *xmlnode_get_parent(const xmlnode *child);

/**
 * Returns the node in a string of xml.

 * 			the user if the file cannot be read.
 * @param process  The subsystem that is calling xmlnode_from_file. Used as
 * 			the category for debugging.
 *
 * @return The new node or NULL if an error occurred.
 *
 * @since 2.6.0
 */
xmlnode *xmlnode_from_file(const char *dir, const char *filename,
			   const char *description, const char *process);

#ifdef __cplusplus
}
#endif

#endif /* _PURPLE_XMLNODE_H_ */

32779:d72f2f13b60f

#endif

/**
 * The valid types for an xmlnode
 */
typedef enum
{
	XMLNODE_TYPE_TAG,		/**< Just a tag */
	XMLNODE_TYPE_ATTRIB,		/**< Has attributes */
	XMLNODE_TYPE_DATA		/**< Has data */
} XMLNodeType;

 * @param attr  The name of the attribute.
 * @param value The value of the attribute.
 */
void xmlnode_set_attrib(xmlnode *node, const char *attr, const char *value);

/**
 * Sets a namespaced attribute for a node
 *
 * @param node   The node to set an attribute for.
 * @param attr   The name of the attribute to set
 * @param xmlns  The namespace of the attribute to set
 * @param prefix The prefix of the attribute to set
 * @param value  The value of the attribute
 */
void xmlnode_set_attrib_full(xmlnode *node, const char *attr, const char *xmlns,
	const char *prefix, const char *value);

/**

 * Returns the namespace of a node
 *
 * @param node The node to get the namepsace from
 * @return The namespace of this node
 */
const char *xmlnode_get_namespace(const xmlnode *node);

/**
 * Returns the current default namespace.  The default
 * namespace is the current namespace which applies to child
 * elements which are unprefixed and which do not contain their
 * own namespace.
 *
 * For example, given:
 * \verbatim
 * <iq type='get' xmlns='jabber:client' xmlns:ns1='http://example.org/ns1'>
 *     <ns1:element><child1/></ns1:element>
 * </iq>
 * \endverbatim
 *
 * The default namespace of all nodes (including 'child1') is "jabber:client",
 * though the namespace for 'element' is "http://example.org/ns1".
 *
 * @param node The node for which to return the default namespace
 * @return The default namespace of this node
 */
const char *xmlnode_get_default_namespace(const xmlnode *node);

/**
 * Returns the defined namespace for a prefix.
 *
 * @param node The node from which to start the search.
 * @param prefix The prefix for which to return the associated namespace.
 * @return The namespace for this prefix.
 */
const char *xmlnode_get_prefix_namespace(const xmlnode *node, const char *prefix);

/**
 * Sets the prefix of a node
 *
 * @param node   The node to qualify

 * @return The prefix of this node
 */
const char *xmlnode_get_prefix(const xmlnode *node);

/**
 * Remove all element prefixes from an xmlnode tree.  The prefix's
 * namespace is transformed into the default namespace for an element.
 *
 * Note that this will not necessarily remove all prefixes in use
 * (prefixed attributes may still exist), and that this usage may
 * break some applications (SOAP / XPath apparently often rely on
 * the prefixes having the same name.
 *
 * @param node The node from which to strip prefixes
 */
void xmlnode_strip_prefixes(xmlnode *node);

/**
 * Gets the parent node.
 *
 * @param child The child node.
 *
 * @return The parent or NULL.
 */
xmlnode *xmlnode_get_parent(const xmlnode *child);

/**
 * Returns the node in a string of xml.

 * 			the user if the file cannot be read.
 * @param process  The subsystem that is calling xmlnode_from_file. Used as
 * 			the category for debugging.
 *
 * @return The new node or NULL if an error occurred.
 */
xmlnode *xmlnode_from_file(const char *dir, const char *filename,
			   const char *description, const char *process);

#ifdef __cplusplus
}
#endif

#endif /* _PURPLE_XMLNODE_H_ */