axl main logo
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Modules Pages
Macros | Functions
Axl Doc: XML Documents related functions, loading XML documents and using them.

Macros

#define axl_doc_find_called(doc, name)   (axl_node_find_called(axl_doc_get_root(doc),name))
 Convenience macro that allows to call axl_node_find_called, providing a document, making the parent reference to use the root document node. More...
 

Functions

void axl_doc_add_pi_target (axlDoc *doc, char *target, char *content)
 Allows to configure a PI target, with its content, on the given axlDoc. More...
 
axl_bool axl_doc_are_equal (axlDoc *doc, axlDoc *doc2)
 Allows to check if the provided two references represents equivalent xml documents. More...
 
axl_bool axl_doc_are_equal_full (axlDoc *doc, axlDoc *doc2, axl_bool trimmed, axlError **error)
 Allows to check if the provided two references represents equivalent xml documents. More...
 
axl_bool axl_doc_are_equal_trimmed (axlDoc *doc, axlDoc *doc2)
 Allows to perform a document equal check against order, relaxing the checking done to contet found inside nodes. More...
 
axlDocaxl_doc_create (const char *version, const char *encoding, axl_bool standalone)
 Creates a new empty xml document, especifying options to be used in the header. More...
 
axl_bool axl_doc_dump (axlDoc *doc, char **content, int *size)
 Allows to get the xml representation for the provided axlDoc reference. More...
 
axl_bool axl_doc_dump_pretty (axlDoc *doc, char **content, int *size, int tabular)
 Allows to perform a dump operation like axl_doc_dump, but making the output to be pretty printed. More...
 
axl_bool axl_doc_dump_pretty_to_file (axlDoc *doc, const char *file_path, int tabular)
 Allows to dump a xml document directly to the file located at the file path, doing pretty printing operations. More...
 
axl_bool axl_doc_dump_to_file (axlDoc *doc, const char *file_path)
 Allows to dump a xml document directly to the file located at the file path. More...
 
void axl_doc_free (axlDoc *doc)
 Releases memory allocated by the axlDoc object. More...
 
axlNodeaxl_doc_get (axlDoc *doc, const char *path_to)
 Allows to return only one node for the selected path. More...
 
const char * axl_doc_get_content_at (axlDoc *doc, const char *path_to, int *content_size)
 Allows to get the node content for the final node provided by the path. More...
 
const char * axl_doc_get_encoding (axlDoc *doc)
 Gets current axl Document encoding. More...
 
int axl_doc_get_flat_size (axlDoc *doc)
 Allows to get how much will take the axlDoc instance represented as an XML document in an storage device (like memory). More...
 
int axl_doc_get_flat_size_pretty (axlDoc *doc, int tabular)
 Allows to get how much will take the axlDoc instance represented as an XML document in an storage device (like memory) using pretty print format. More...
 
axlListaxl_doc_get_list (axlDoc *doc, const char *path_to)
 Allows to get a particular node (or list of nodes) that are located at a selected path. More...
 
char * axl_doc_get_pi_target_content (axlDoc *doc, char *pi_target)
 Allows to get current processing instruction content. More...
 
axlListaxl_doc_get_pi_target_list (axlDoc *doc)
 Allows to get a list which contains axlPI nodes, representing all process instruction that the document has. More...
 
axlNodeaxl_doc_get_root (axlDoc *doc)
 Allows to get current root node for the given xml document, represented by the axlDoc instance. More...
 
axl_bool axl_doc_get_standalone (axlDoc *doc)
 Allows to get current standalone configuration for the given axlDoc document. More...
 
axl_bool axl_doc_has_pi_target (axlDoc *doc, char *pi_target)
 Allows to check if the provided Processing instruction target is defined on the given xml document (axlDoc). More...
 
axl_bool axl_doc_iterate (axlDoc *doc, AxlIterationMode mode, axlIterationFunc func, axlPointer ptr)
 Allows to perform an iteration over the documented provided, visiting all nodes inside it. More...
 
axl_bool axl_doc_iterate_full (axlDoc *doc, AxlIterationMode mode, axlIterationFunc2 func, axlPointer ptr, axlPointer ptr2)
 Allows to perform an iteration over the documented provided, visiting all nodes inside it (with two user defined pointers support). More...
 
axl_bool axl_doc_iterate_full_from (axlDoc *doc, axlNode *starting_from, AxlIterationMode mode, axlIterationFunc2 func, axlPointer ptr, axlPointer ptr2)
 Allows to perform a iteration operation but configuring where to start, discarding the rest content. More...
 
axlDocaxl_doc_parse (const char *entity, int entity_size, axlError **error)
 Parse an XML entity that is hold inside the memory pointed by entity and limited by entity_size. More...
 
axlDocaxl_doc_parse_from_file (const char *file_path, axlError **error)
 Allows to parse an xml document from the given file path location. More...
 
axlDocaxl_doc_parse_strings (axlError **error,...)
 Allows to parse an xml document that is provided as a set of strings ended by a NULL reference. More...
 
axlDocConfigureCodification axl_doc_set_configure_codification_func (axlDocConfigureCodification func, axlPointer user_data)
 Allows to configure the handler used to finally configure codification to be used for a particular axlStream. More...
 
axlDocDetectCodification axl_doc_set_detect_codification_func (axlDocDetectCodification func, axlPointer user_data)
 Allows to configure a handler that implements document detection and in such cases reconfigure axlStream to act an a proper manner. More...
 
void axl_doc_set_root (axlDoc *doc, axlNode *root)
 Allows to configure the document root for the given axlDoc instance. More...
 
axl_bool axl_pi_are_equal (axlPI *pi, axlPI *pi2)
 Allows to check if both provided process instructions are equal. More...
 
axlPIaxl_pi_copy (axlPI *pi)
 Returns a newly allocated copy representing the same value as the provided axlPI reference. More...
 
axlPIaxl_pi_create (char *name, char *content)
 Allows to create a new axlPI element. More...
 
void axl_pi_free (axlPI *pi)
 Deallocates memory used by the axlPI target. More...
 
char * axl_pi_get_content (axlPI *pi)
 Allows to get current optinal PI content. More...
 
char * axl_pi_get_name (axlPI *pi)
 Allows to get current pi name from the given axlPI reference. More...
 

Detailed Description