libxml2/python/libxml2-python-api.xml

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <api name='libxml2-python'>
   3   <symbols>
   4     <function name='xmlRegisterXPathFunction' file='python'>
   5       <info>Register a Python written function to the XPath interpreter</info>
   6       <return type='int' info="1 in case of success, 0 or -1 in case of error"/>
   7       <arg name='ctx' type='xmlXPathContextPtr' info='the xpathContext'/>
   8       <arg name='name' type='xmlChar *' info='the function name'/>
   9       <arg name='ns_uri' type='xmlChar *' info='the namespace or NULL'/>
  10       <arg name='f' type='pythonObject' info='the python function'/>
  11     </function>
  12     <function name='xmlNewNode' file='python'>
  13       <info>Create a new Node</info>
  14       <return type='xmlNodePtr' info="A new element node"/>
  15       <arg name='name' type='xmlChar *' info='the node name'/>
  16     </function>
  17     <function name='xmlCreatePushParser' file='python'>
  18       <info>Create a progressive XML parser context to build either an event flow if the SAX object is not None, or a DOM tree otherwise.</info>
  19       <return type='xmlParserCtxtPtr' info="the parser context or None in case of error"/>
  20       <arg name='SAX' type='pythonObject' info='the SAX callback object or None'/>
  21       <arg name='chunk' type='xmlChar *' info='the initial data'/>
  22       <arg name='size' type='int' info='the size of the initial data'/>
  23       <arg name='URI' type='xmlChar *' info='The URI used for base computations'/>
  24     </function>
  25     <function name='htmlCreatePushParser' file='python'>
  26       <info>Create a progressive HTML parser context to build either an event flow if the SAX object is not None, or a DOM tree otherwise.</info>
  27       <return type='xmlParserCtxtPtr' info="the parser context or None in case of error"/>
  28       <arg name='SAX' type='pythonObject' info='the SAX callback object or None'/>
  29       <arg name='chunk' type='xmlChar *' info='the initial data'/>
  30       <arg name='size' type='int' info='the size of the initial data'/>
  31       <arg name='URI' type='xmlChar *' info='The URI used for base computations'/>
  32     </function>
  33     <function name='xmlSAXParseFile' file='python'>
  34       <info>Interface to parse an XML file or resource pointed by an URI to build an event flow to the SAX object</info>
  35       <return type='void'/>
  36       <arg name='SAX' type='pythonObject' info='the SAX callback object or None'/>
  37       <arg name='URI' type='xmlChar *' info='The URI of the resource'/>
  38       <arg name='recover' type='int' info='allow recovery in case of error'/>
  39     </function>
  40     <function name='htmlSAXParseFile' file='python'>
  41       <info>Interface to parse an HTML file or resource pointed by an URI to build an event flow to the SAX object</info>
  42       <return type='void'/>
  43       <arg name='SAX' type='pythonObject' info='the SAX callback object or None'/>
  44       <arg name='URI' type='xmlChar *' info='The URI of the resource'/>
  45       <arg name='encoding' type='const char *' info='encoding or None'/>
  46     </function>
  47     <function name='xmlCreateOutputBuffer' file='python'>
  48       <info>Create a libxml2 output buffer from a Python file</info>
  49       <return type='xmlOutputBufferPtr' info="the output buffer"/>
  50       <arg name='file' type='pythonObject' info='the Python file'/>
  51       <arg name='encoding' type='xmlChar *' info='an optionnal encoding'/>
  52     </function>
  53     <function name='xmlCreateInputBuffer' file='python'>
  54       <info>Create a libxml2 input buffer from a Python file</info>
  55       <return type='xmlParserInputBufferPtr' info="the input buffer"/>
  56       <arg name='file' type='pythonObject' info='the Python file'/>
  57       <arg name='encoding' type='xmlChar *' info='an optionnal encoding'/>
  58     </function>
  59     <function name='xmlSetEntityLoader' file='python'>
  60       <info>Set the entity resolver as a python function</info>
  61       <return type='int' info="0 in case of success, -1 for error"/>
  62       <arg name='resolver' type='pythonObject' info='the Python function'/>
  63     </function>
  64     <!-- xmlParserCtxtPtr accessors -->
  65     <function name='xmlParserGetDoc' file='python_accessor'>
  66       <info>Get the document tree from a parser context.</info>
  67       <return type='xmlDocPtr' info="the document tree" field="myDoc"/>
  68       <arg name='ctxt' type='xmlParserCtxtPtr' info='the parser context'/>
  69     </function>
  70     <function name='xmlParserGetWellFormed' file='python_accessor'>
  71       <info>Get the well formed information from a parser context.</info>
  72       <return type='int' info="the wellFormed field" field="wellFormed"/>
  73       <arg name='ctxt' type='xmlParserCtxtPtr' info='the parser context'/>
  74     </function>
  75     <function name='xmlParserGetIsValid' file='python_accessor'>
  76       <info>Get the validity information from a parser context.</info>
  77       <return type='int' info="the valid field" field="valid"/>
  78       <arg name='ctxt' type='xmlParserCtxtPtr' info='the parser context'/>
  79     </function>
  80     <function name='xmlParserSetValidate' file='python_accessor'>
  81       <info>Switch the parser to validation mode.</info>
  82       <return type='void'/>
  83       <arg name='ctxt' type='xmlParserCtxtPtr' info='the parser context'/>
  84       <arg name='validate' type='int' info='1 to activate validation'/>
  85     </function>
  86     <function name='xmlParserSetReplaceEntities' file='python_accessor'>
  87       <info>Switch the parser to replace entities.</info>
  88       <return type='void'/>
  89       <arg name='ctxt' type='xmlParserCtxtPtr' info='the parser context'/>
  90       <arg name='replaceEntities' type='int' info='1 to replace entities'/>
  91     </function>
  92     <function name='xmlParserSetPedantic' file='python_accessor'>
  93       <info>Switch the parser to be pedantic.</info>
  94       <return type='void'/>
  95       <arg name='ctxt' type='xmlParserCtxtPtr' info='the parser context'/>
  96       <arg name='pedantic' type='int' info='1 to run in pedantic mode'/>
  97     </function>
  98     <function name='xmlParserSetLoadSubset' file='python_accessor'>
  99       <info>Switch the parser to load the DTD without validating.</info>
 100       <return type='void'/>
 101       <arg name='ctxt' type='xmlParserCtxtPtr' info='the parser context'/>
 102       <arg name='loadsubset' type='int' info='1 to load the DTD'/>
 103     </function>
 104     <function name='xmlParserSetLineNumbers' file='python_accessor'>
 105       <info>Switch on the generation of line number for elements nodes.</info>
 106       <return type='void'/>
 107       <arg name='ctxt' type='xmlParserCtxtPtr' info='the parser context'/>
 108       <arg name='linenumbers' type='int' info='1 to save line numbers'/>
 109     </function>
 110     <function name='xmlDebugMemory' file='python'>
 111       <info>Switch on the generation of line number for elements nodes. Also returns the number of bytes allocated and not freed by libxml2 since memory debugging was switched on.</info>
 112       <return type='int' info="returns the number of bytes allocated and not freed"/>
 113       <arg name='activate' type='int' info='1 switch on memory debugging 0 switch it off'/>
 114     </function>
 115     <function name='xmlDumpMemory' file='python'>
 116       <info>dump the memory allocated in the file .memdump</info>
 117       <return type='void'/>
 118     </function>
 119     <!-- xmlNsPtr accessors -->
 120     <function name='xmlNodeGetNs' file='python_accessor'>
 121       <info>Get the namespace of a node</info>
 122       <return type='xmlNsPtr' info="The namespace or None"/>
 123       <arg name='node' type='xmlNodePtr' info='the node'/>
 124     </function>
 125     <function name='xmlNodeGetNsDefs' file='python_accessor'>
 126       <info>Get the namespace of a node</info>
 127       <return type='xmlNsPtr' info="The namespace or None"/>
 128       <arg name='node' type='xmlNodePtr' info='the node'/>
 129     </function>
 130     <!-- xmlXPathContextPtr accessors -->
 131     <function name='xmlXPathParserGetContext' file='python_accessor'>
 132       <info>Get the xpathContext from an xpathParserContext</info>
 133       <return type='xmlXPathContextPtr' info="The XPath context" field="context"/>
 134       <arg name='ctxt' type='xmlXPathParserContextPtr' info='the XPath parser context'/>
 135     </function>
 136     <function name='xmlXPathGetContextDoc' file='python_accessor'>
 137       <info>Get the doc from an xpathContext</info>
 138       <return type='xmlDocPtr' info="The doc context" field="doc"/>
 139       <arg name='ctxt' type='xmlXPathContextPtr' info='the XPath context'/>
 140     </function>
 141     <function name='xmlXPathGetContextNode' file='python_accessor'>
 142       <info>Get the current node from an xpathContext</info>
 143       <return type='xmlNodePtr' info="The node context" field="node"/>
 144       <arg name='ctxt' type='xmlXPathContextPtr' info='the XPath context'/>
 145     </function>
 146     <function name='xmlXPathSetContextDoc' file='python_accessor'>
 147       <info>Set the doc of an xpathContext</info>
 148       <return type='void'/>
 149       <arg name='ctxt' type='xmlXPathContextPtr' info='the XPath context'/>
 150       <arg name="doc" type='xmlDocPtr' info="The doc context"/>
 151     </function>
 152     <function name='xmlXPathSetContextNode' file='python_accessor'>
 153       <info>Set the current node of an xpathContext</info>
 154       <return type='void'/>
 155       <arg name='ctxt' type='xmlXPathContextPtr' info='the XPath context'/>
 156       <arg name="node" type='xmlNodePtr' info="The node context"/>
 157     </function>
 158     <function name='xmlXPathGetContextPosition' file='python_accessor'>
 159       <info>Get the current node from an xpathContext</info>
 160       <return type='int' info="The node context" field="proximityPosition"/>
 161       <arg name='ctxt' type='xmlXPathContextPtr' info='the XPath context'/>
 162     </function>
 163     <function name='xmlXPathGetContextSize' file='python_accessor'>
 164       <info>Get the current node from an xpathContext</info>
 165       <return type='int' info="The node context" field="contextSize"/>
 166       <arg name='ctxt' type='xmlXPathContextPtr' info='the XPath context'/>
 167     </function>
 168     <function name='xmlXPathGetFunction' file='python_accessor'>
 169       <info>Get the current function name xpathContext</info>
 170       <return type='const xmlChar *' info="The function name" field="function"/>
 171       <arg name='ctxt' type='xmlXPathContextPtr' info='the XPath context'/>
 172     </function>
 173     <function name='xmlXPathGetFunctionURI' file='python_accessor'>
 174       <info>Get the current function name URI xpathContext</info>
 175       <return type='const xmlChar *' info="The function name URI" field="functionURI"/>
 176       <arg name='ctxt' type='xmlXPathContextPtr' info='the XPath context'/>
 177     </function>
 178     <!-- xmlURIPtr accessors -->
 179     <function name='xmlURIGetScheme' file='python_accessor'>
 180       <info>Get the scheme part from an URI</info>
 181       <return type='const char *' info="The URI scheme" field="scheme"/>
 182       <arg name='URI' type='xmlURIPtr' info='the URI'/>
 183     </function>
 184     <function name='xmlURISetScheme' file='python_accessor'>
 185       <info>Set the scheme part of an URI.</info>
 186       <return type='void'/>
 187       <arg name='URI' type='xmlURIPtr' info='the URI'/>
 188       <arg name='scheme' type='char *' info='The URI scheme part'/>
 189     </function>
 190     <function name='xmlURIGetOpaque' file='python_accessor'>
 191       <info>Get the opaque part from an URI</info>
 192       <return type='const char *' info="The URI opaque" field="opaque"/>
 193       <arg name='URI' type='xmlURIPtr' info='the URI'/>
 194     </function>
 195     <function name='xmlURISetOpaque' file='python_accessor'>
 196       <info>Set the opaque part of an URI.</info>
 197       <return type='void'/>
 198       <arg name='URI' type='xmlURIPtr' info='the URI'/>
 199       <arg name='opaque' type='char *' info='The URI opaque part'/>
 200     </function>
 201     <function name='xmlURIGetAuthority' file='python_accessor'>
 202       <info>Get the authority part from an URI</info>
 203       <return type='const char *' info="The URI authority" field="authority"/>
 204       <arg name='URI' type='xmlURIPtr' info='the URI'/>
 205     </function>
 206     <function name='xmlURISetAuthority' file='python_accessor'>
 207       <info>Set the authority part of an URI.</info>
 208       <return type='void'/>
 209       <arg name='URI' type='xmlURIPtr' info='the URI'/>
 210       <arg name='authority' type='char *' info='The URI authority part'/>
 211     </function>
 212     <function name='xmlURIGetServer' file='python_accessor'>
 213       <info>Get the server part from an URI</info>
 214       <return type='const char *' info="The URI server" field="server"/>
 215       <arg name='URI' type='xmlURIPtr' info='the URI'/>
 216     </function>
 217     <function name='xmlURISetServer' file='python_accessor'>
 218       <info>Set the server part of an URI.</info>
 219       <return type='void'/>
 220       <arg name='URI' type='xmlURIPtr' info='the URI'/>
 221       <arg name='server' type='char *' info='The URI server part'/>
 222     </function>
 223     <function name='xmlURIGetUser' file='python_accessor'>
 224       <info>Get the user part from an URI</info>
 225       <return type='const char *' info="The URI user" field="user"/>
 226       <arg name='URI' type='xmlURIPtr' info='the URI'/>
 227     </function>
 228     <function name='xmlURISetUser' file='python_accessor'>
 229       <info>Set the user part of an URI.</info>
 230       <return type='void'/>
 231       <arg name='URI' type='xmlURIPtr' info='the URI'/>
 232       <arg name='user' type='char *' info='The URI user part'/>
 233     </function>
 234     <function name='xmlURIGetPath' file='python_accessor'>
 235       <info>Get the path part from an URI</info>
 236       <return type='const char *' info="The URI path" field="path"/>
 237       <arg name='URI' type='xmlURIPtr' info='the URI'/>
 238     </function>
 239     <function name='xmlURISetPath' file='python_accessor'>
 240       <info>Set the path part of an URI.</info>
 241       <return type='void'/>
 242       <arg name='URI' type='xmlURIPtr' info='the URI'/>
 243       <arg name='path' type='char *' info='The URI path part'/>
 244     </function>
 245     <function name='xmlURIGetQuery' file='python_accessor'>
 246       <info>Get the query part from an URI</info>
 247       <return type='const char *' info="The URI query" field="query"/>
 248       <arg name='URI' type='xmlURIPtr' info='the URI'/>
 249     </function>
 250     <function name='xmlURISetQuery' file='python_accessor'>
 251       <info>Set the query part of an URI.</info>
 252       <return type='void'/>
 253       <arg name='URI' type='xmlURIPtr' info='the URI'/>
 254       <arg name='query' type='char *' info='The URI query part'/>
 255     </function>
 256     <function name='xmlURIGetFragment' file='python_accessor'>
 257       <info>Get the fragment part from an URI</info>
 258       <return type='const char *' info="The URI fragment" field="fragment"/>
 259       <arg name='URI' type='xmlURIPtr' info='the URI'/>
 260     </function>
 261     <function name='xmlURISetFragment' file='python_accessor'>
 262       <info>Set the fragment part of an URI.</info>
 263       <return type='void'/>
 264       <arg name='URI' type='xmlURIPtr' info='the URI'/>
 265       <arg name='fragment' type='char *' info='The URI fragment part'/>
 266     </function>
 267     <function name='xmlURIGetPort' file='python_accessor'>
 268       <info>Get the port part from an URI</info>
 269       <return type='int' info="The URI port" field="port"/>
 270       <arg name='URI' type='xmlURIPtr' info='the URI'/>
 271     </function>
 272     <function name='xmlURISetPort' file='python_accessor'>
 273       <info>Set the port part of an URI.</info>
 274       <return type='void'/>
 275       <arg name='URI' type='xmlURIPtr' info='the URI'/>
 276       <arg name='port' type='int' info='The URI port part'/>
 277     </function>
 278   </symbols>
 279 </api>