the c14n modules provides a "Canonical XML" implementation Table of Contentsint xmlC14NDocDumpMemory (xmlDocPtr doc, xmlNodeSetPtr nodes, int exclusive, xmlChar ** inclusive_ns_prefixes, int with_comments, xmlChar ** doc_txt_ptr)
int xmlC14NDocSave (xmlDocPtr doc, xmlNodeSetPtr nodes, int exclusive, xmlChar ** inclusive_ns_prefixes, int with_comments, const char * filename, int compression)
int xmlC14NDocSaveTo (xmlDocPtr doc, xmlNodeSetPtr nodes, int exclusive, xmlChar ** inclusive_ns_prefixes, int with_comments, xmlOutputBufferPtr buf)
int xmlC14NExecute (xmlDocPtr doc, xmlC14NIsVisibleCallback is_visible_callback, void * user_data, int exclusive, xmlChar ** inclusive_ns_prefixes, int with_comments, xmlOutputBufferPtr buf)
@@ -19,13 +19,13 @@ int xmlC14NIsVisibleCallback (void * use
Description
Function: xmlC14NDocDumpMemoryint xmlC14NDocDumpMemory (xmlDocPtr doc, xmlNodeSetPtr nodes, int exclusive, xmlChar ** inclusive_ns_prefixes, int with_comments, xmlChar ** doc_txt_ptr)
- Dumps the canonized image of given XML document into memory. For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or "Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)
+Dumps the canonized image of given XML document into memory. For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or "Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)
doc: | the XML document for canonization | nodes: | the nodes set to be included in the canonized image or NULL if all document nodes should be included | exclusive: | the exclusive flag (0 - non-exclusive canonicalization; otherwise - exclusive canonicalization) | inclusive_ns_prefixes: | the list of inclusive namespace prefixes ended with a NULL or NULL if there is no inclusive namespaces (only for exclusive canonicalization, ignored otherwise) | with_comments: | include comments in the result (!=0) or not (==0) | doc_txt_ptr: | the memory pointer for allocated canonical XML text; the caller of this functions is responsible for calling xmlFree() to free allocated memory | Returns: | the number of bytes written on success or a negative value on fail |
Function: xmlC14NDocSaveint xmlC14NDocSave (xmlDocPtr doc, xmlNodeSetPtr nodes, int exclusive, xmlChar ** inclusive_ns_prefixes, int with_comments, const char * filename, int compression)
- Dumps the canonized image of given XML document into the file. For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or "Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)
+Dumps the canonized image of given XML document into the file. For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or "Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)
doc: | the XML document for canonization | nodes: | the nodes set to be included in the canonized image or NULL if all document nodes should be included | exclusive: | the exclusive flag (0 - non-exclusive canonicalization; otherwise - exclusive canonicalization) | inclusive_ns_prefixes: | the list of inclusive namespace prefixes ended with a NULL or NULL if there is no inclusive namespaces (only for exclusive canonicalization, ignored otherwise) | with_comments: | include comments in the result (!=0) or not (==0) | filename: | the filename to store canonical XML image | compression: | the compression level (zlib requred): -1 - libxml default, 0 - uncompressed, >0 - compression level | Returns: | the number of bytes written success or a negative value on fail |
Function: xmlC14NDocSaveToint xmlC14NDocSaveTo (xmlDocPtr doc, xmlNodeSetPtr nodes, int exclusive, xmlChar ** inclusive_ns_prefixes, int with_comments, xmlOutputBufferPtr buf)
- Dumps the canonized image of given XML document into the provided buffer. For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or "Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)
+Dumps the canonized image of given XML document into the provided buffer. For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or "Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)
doc: | the XML document for canonization | nodes: | the nodes set to be included in the canonized image or NULL if all document nodes should be included | exclusive: | the exclusive flag (0 - non-exclusive canonicalization; otherwise - exclusive canonicalization) | inclusive_ns_prefixes: | the list of inclusive namespace prefixes ended with a NULL or NULL if there is no inclusive namespaces (only for exclusive canonicalization, ignored otherwise) | with_comments: | include comments in the result (!=0) or not (==0) | buf: | the output buffer to store canonical XML; this buffer MUST have encoder==NULL because C14N requires UTF-8 output | Returns: | non-negative value on success or a negative value on fail |
Function: xmlC14NExecuteint xmlC14NExecute (xmlDocPtr doc, xmlC14NIsVisibleCallback is_visible_callback, void * user_data, int exclusive, xmlChar ** inclusive_ns_prefixes, int with_comments, xmlOutputBufferPtr buf)
- Dumps the canonized image of given XML document into the provided buffer. For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or "Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)
+Dumps the canonized image of given XML document into the provided buffer. For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or "Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)
doc: | the XML document for canonization | is_visible_callback: | the function to use to determine is node visible or not | user_data: | the first parameter for @is_visible_callback function (in most cases, it is nodes set) | exclusive: | the exclusive flag (0 - non-exclusive canonicalization; otherwise - exclusive canonicalization) | inclusive_ns_prefixes: | the list of inclusive namespace prefixes ended with a NULL or NULL if there is no inclusive namespaces (only for exclusive canonicalization, ignored otherwise) | with_comments: | include comments in the result (!=0) or not (==0) | buf: | the output buffer to store canonical XML; this buffer MUST have encoder==NULL because C14N requires UTF-8 output | Returns: | non-negative value on success or a negative value on fail |
Function type: xmlC14NIsVisibleCallbackFunction type: xmlC14NIsVisibleCallback
int xmlC14NIsVisibleCallback (void * user_data, xmlNodePtr node, xmlNodePtr parent)
user_data: | | node: | | parent: | | Returns: | |
diff --git a/doc/html/libxml-debugXML.html b/doc/html/libxml-debugXML.html
index 0aeab114..def6a361 100644
--- a/doc/html/libxml-debugXML.html
+++ b/doc/html/libxml-debugXML.html
@@ -56,7 +56,7 @@ char * xmlShellReadlineFunc (char * prompt)
xmlShellReadlineFunc input
}Function: xmlBoolToTextconst char * xmlBoolToText (int boolval)
Convenient way to turn bool into text
-boolval: | a bool to turn into text | Returns: | a pointer to either "True" or "False" |
Function: xmlDebugDumpAttrvoid xmlDebugDumpAttr (FILE * output, xmlAttrPtr attr, int depth)
+boolval: | a bool to turn into text | Returns: | a pointer to either "True" or "False" |
Function: xmlDebugDumpAttrvoid xmlDebugDumpAttr (FILE * output, xmlAttrPtr attr, int depth)
Dumps debug information for the attribute
output: | the FILE * for the output | attr: | the attribute | depth: | the indentation level. |
Function: xmlDebugDumpAttrListvoid xmlDebugDumpAttrList (FILE * output, xmlAttrPtr attr, int depth)
Dumps debug information for the attribute list
@@ -83,20 +83,20 @@ char * xmlShellReadlineFunc (char * prompt)
output: | the FILE * for the output | node: | the node to dump |
Function: xmlShellvoid xmlShell (xmlDocPtr doc, char * filename, xmlShellReadlineFunc input, FILE * output)
Implements the XML shell This allow to load, validate, view, modify and save a document using a environment similar to a UNIX commandline.
doc: | the initial document | filename: | the output buffer | input: | the line reading function | output: | the output FILE*, defaults to stdout if NULL |
Function: xmlShellBaseint xmlShellBase (xmlShellCtxtPtr ctxt, char * arg, xmlNodePtr node, xmlNodePtr node2)
- Implements the XML shell function "base" dumps the current XML base of the node
+ Implements the XML shell function "base" dumps the current XML base of the node
ctxt: | the shell context | arg: | unused | node: | a node | node2: | unused | Returns: | 0 |
Function: xmlShellCatint xmlShellCat (xmlShellCtxtPtr ctxt, char * arg, xmlNodePtr node, xmlNodePtr node2)
- Implements the XML shell function "cat" dumps the serialization node content (XML or HTML).
+Implements the XML shell function "cat" dumps the serialization node content (XML or HTML).
ctxt: | the shell context | arg: | unused | node: | a node | node2: | unused | Returns: | 0 |
Function type: xmlShellCmdFunction type: xmlShellCmd
int xmlShellCmd (xmlShellCtxtPtr ctxt, char * arg, xmlNodePtr node, xmlNodePtr node2)
This is a generic signature for the XML shell functions. ctxt: | a shell context | arg: | a string argument | node: | a first node | node2: | a second node | Returns: | an int, negative returns indicating errors. |
Function: xmlShellDirint xmlShellDir (xmlShellCtxtPtr ctxt, char * arg, xmlNodePtr node, xmlNodePtr node2)
- Implements the XML shell function "dir" dumps informations about the node (namespace, attributes, content).
+Implements the XML shell function "dir" dumps informations about the node (namespace, attributes, content).
ctxt: | the shell context | arg: | unused | node: | a node | node2: | unused | Returns: | 0 |
Function: xmlShellDuint xmlShellDu (xmlShellCtxtPtr ctxt, char * arg, xmlNodePtr tree, xmlNodePtr node2)
- Implements the XML shell function "du" show the structure of the subtree under node @tree If @tree is null, the command works on the current node.
+Implements the XML shell function "du" show the structure of the subtree under node @tree If @tree is null, the command works on the current node.
ctxt: | the shell context | arg: | unused | tree: | a node defining a subtree | node2: | unused | Returns: | 0 or -1 in case of error |
Function: xmlShellListint xmlShellList (xmlShellCtxtPtr ctxt, char * arg, xmlNodePtr node, xmlNodePtr node2)
- Implements the XML shell function "ls" Does an Unix like listing of the given node (like a directory)
+Implements the XML shell function "ls" Does an Unix like listing of the given node (like a directory)
ctxt: | the shell context | arg: | unused | node: | a node | node2: | unused | Returns: | 0 |
Function: xmlShellLoadint xmlShellLoad (xmlShellCtxtPtr ctxt, char * filename, xmlNodePtr node, xmlNodePtr node2)
- Implements the XML shell function "load" loads a new document specified by the filename
+Implements the XML shell function "load" loads a new document specified by the filename
ctxt: | the shell context | filename: | the file name | node: | unused | node2: | unused | Returns: | 0 or -1 if loading failed |
Function: xmlShellPrintNodevoid xmlShellPrintNode (xmlNodePtr node)
Print node to the output FILE
node: | a non-null node to print to the output FILE |
Function: xmlShellPrintXPathErrorvoid xmlShellPrintXPathError (int errorType, const char * arg)
@@ -104,14 +104,14 @@ int xmlShellCmd (xmlShellCtxtPt
errorType: | valid xpath error id | arg: | the argument that cause xpath to fail |
Function: xmlShellPrintXPathResultvoid xmlShellPrintXPathResult (xmlXPathObjectPtr list)
Prints result to the output FILE
list: | a valid result generated by an xpath evaluation |
Function: xmlShellPwdint xmlShellPwd (xmlShellCtxtPtr ctxt, char * buffer, xmlNodePtr node, xmlNodePtr node2)
- Implements the XML shell function "pwd" Show the full path from the root to the node, if needed building thumblers when similar elements exists at a given ancestor level. The output is compatible with XPath commands.
+ Implements the XML shell function "pwd" Show the full path from the root to the node, if needed building thumblers when similar elements exists at a given ancestor level. The output is compatible with XPath commands.
ctxt: | the shell context | buffer: | the output buffer | node: | a node | node2: | unused | Returns: | 0 or -1 in case of error |
Function type: xmlShellReadlineFuncFunction type: xmlShellReadlineFunc
char * xmlShellReadlineFunc (char * prompt)
This is a generic signature for the XML shell input function. prompt: | a string prompt | Returns: | a string which will be freed by the Shell. |
Function: xmlShellSaveint xmlShellSave (xmlShellCtxtPtr ctxt, char * filename, xmlNodePtr node, xmlNodePtr node2)
- Implements the XML shell function "save" Write the current document to the filename, or it's original name
+Implements the XML shell function "save" Write the current document to the filename, or it's original name
ctxt: | the shell context | filename: | the file name (optional) | node: | unused | node2: | unused | Returns: | 0 or -1 in case of error |
Function: xmlShellValidateint xmlShellValidate (xmlShellCtxtPtr ctxt, char * dtd, xmlNodePtr node, xmlNodePtr node2)
- Implements the XML shell function "validate" Validate the document, if a DTD path is provided, then the validation is done against the given DTD.
+Implements the XML shell function "validate" Validate the document, if a DTD path is provided, then the validation is done against the given DTD.
ctxt: | the shell context | dtd: | the DTD URI (optional) | node: | unused | node2: | unused | Returns: | 0 or -1 in case of error |
Function: xmlShellWriteint xmlShellWrite (xmlShellCtxtPtr ctxt, char * filename, xmlNodePtr node, xmlNodePtr node2)
- Implements the XML shell function "write" Write the current node to the filename, it saves the serialization of the subtree under the @node specified
+Implements the XML shell function "write" Write the current node to the filename, it saves the serialization of the subtree under the @node specified
ctxt: | the shell context | filename: | the file name | node: | a node in the tree | node2: | unused | Returns: | 0 or -1 in case of error |
Daniel Veillard |