blob: 5026ee14245d79fefe8c237a2da48382f37c08ca [file] [log] [blame]
Daniel Veillard9589d452002-02-02 10:28:17 +00001<?xml version="1.0" encoding="ISO-8859-1"?>
2<api name='libxml2-python'>
Daniel Veillard9589d452002-02-02 10:28:17 +00003 <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>
Daniel Veillarda94ec6f2002-03-01 13:00:53 +000012 <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>
Daniel Veillard5d819032002-02-02 21:49:17 +000017 <function name='xmlRegisterErrorHandler' file='python'>
18 <info>Register a Python written function to for error reporting. The function is called back as f(ctx, error).</info>
19 <return type='int' info="1 in case of success, 0 or -1 in case of error"/>
20 <arg name='f' type='pythonObject' info='the python function'/>
21 <arg name='ctx' type='pythonObject' info='a context for the callback'/>
22 </function>
Daniel Veillard3ce52572002-02-03 15:08:05 +000023 <function name='xmlCreatePushParser' file='python'>
Daniel Veillard4e1b26c2002-02-03 20:13:06 +000024 <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>
25 <return type='xmlParserCtxtPtr' info="the parser context or None in case of error"/>
26 <arg name='SAX' type='pythonObject' info='the SAX callback object or None'/>
27 <arg name='chunk' type='xmlChar *' info='the initial data'/>
28 <arg name='size' type='int' info='the size of the initial data'/>
29 <arg name='URI' type='xmlChar *' info='The URI used for base computations'/>
30 </function>
31 <function name='htmlCreatePushParser' file='python'>
32 <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>
Daniel Veillard3ce52572002-02-03 15:08:05 +000033 <return type='xmlParserCtxtPtr' info="the parser context or None in case of error"/>
34 <arg name='SAX' type='pythonObject' info='the SAX callback object or None'/>
35 <arg name='chunk' type='xmlChar *' info='the initial data'/>
36 <arg name='size' type='int' info='the size of the initial data'/>
37 <arg name='URI' type='xmlChar *' info='The URI used for base computations'/>
38 </function>
Daniel Veillardc575b992002-02-08 13:28:40 +000039 <!-- xmlParserCtxtPtr accessors -->
Daniel Veillard3ce52572002-02-03 15:08:05 +000040 <function name='xmlParserGetDoc' file='python_accessor'>
41 <info>Get the document tree from a parser context.</info>
42 <return type='xmlDocPtr' info="the document tree" field="myDoc"/>
Daniel Veillard26f1dcc2002-02-03 16:53:19 +000043 <arg name='ctxt' type='xmlParserCtxtPtr' info='the parser context'/>
44 </function>
45 <function name='xmlParserGetWellFormed' file='python_accessor'>
46 <info>Get the well formed information from a parser context.</info>
47 <return type='int' info="the wellFormed field" field="wellFormed"/>
48 <arg name='ctxt' type='xmlParserCtxtPtr' info='the parser context'/>
49 </function>
50 <function name='xmlParserGetIsValid' file='python_accessor'>
51 <info>Get the validity information from a parser context.</info>
52 <return type='int' info="the valid field" field="valid"/>
53 <arg name='ctxt' type='xmlParserCtxtPtr' info='the parser context'/>
54 </function>
55 <function name='xmlParserSetValidate' file='python_accessor'>
56 <info>Switch the parser to validation mode.</info>
57 <return type='void'/>
58 <arg name='ctxt' type='xmlParserCtxtPtr' info='the parser context'/>
59 <arg name='validate' type='int' info='1 to activate validation'/>
60 </function>
61 <function name='xmlParserSetReplaceEntities' file='python_accessor'>
62 <info>Switch the parser to replace entities.</info>
63 <return type='void'/>
64 <arg name='ctxt' type='xmlParserCtxtPtr' info='the parser context'/>
65 <arg name='replaceEntities' type='int' info='1 to replace entities'/>
66 </function>
67 <function name='xmlParserSetPedantic' file='python_accessor'>
68 <info>Switch the parser to be pedantic.</info>
69 <return type='void'/>
70 <arg name='ctxt' type='xmlParserCtxtPtr' info='the parser context'/>
71 <arg name='pedantic' type='int' info='1 to run in pedantic mode'/>
72 </function>
73 <function name='xmlParserSetLoadSubset' file='python_accessor'>
74 <info>Switch the parser to load the DTD without validating.</info>
75 <return type='void'/>
76 <arg name='ctxt' type='xmlParserCtxtPtr' info='the parser context'/>
77 <arg name='loadsubset' type='int' info='1 to load the DTD'/>
78 </function>
79 <function name='xmlParserSetLineNumbers' file='python_accessor'>
80 <info>Switch on the generation of line number for elements nodes.</info>
81 <return type='void'/>
82 <arg name='ctxt' type='xmlParserCtxtPtr' info='the parser context'/>
83 <arg name='linenumbers' type='int' info='1 to save line numbers'/>
Daniel Veillard3ce52572002-02-03 15:08:05 +000084 </function>
Daniel Veillard4e1b26c2002-02-03 20:13:06 +000085 <function name='xmlDebugMemory' file='python'>
86 <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>
87 <return type='int' info="returns the number of bytes allocated and not freed"/>
88 <arg name='activate' type='int' info='1 switch on memory debugging 0 switch it off'/>
89 </function>
90 <function name='xmlDumpMemory' file='python'>
91 <info>dump the memory allocated in the file .memdump</info>
92 <return type='void'/>
93 </function>
Daniel Veillardc575b992002-02-08 13:28:40 +000094 <!-- xmlNsPtr accessors -->
Daniel Veillard36eea2d2002-02-04 00:17:01 +000095 <function name='xmlNodeGetNs' file='python_accessor'>
96 <info>Get the namespace of a node</info>
97 <return type='xmlNsPtr' info="The namespace or None"/>
98 <arg name='node' type='xmlNodePtr' info='the node'/>
99 </function>
100 <function name='xmlNodeGetNsDefs' file='python_accessor'>
101 <info>Get the namespace of a node</info>
102 <return type='xmlNsPtr' info="The namespace or None"/>
103 <arg name='node' type='xmlNodePtr' info='the node'/>
104 </function>
Daniel Veillardc575b992002-02-08 13:28:40 +0000105 <!-- xmlXPathParserContextPtr accessors -->
106 <function name='xmlXPathParserGetContext' file='python_accessor'>
107 <info>Get the xpathContext from an xpathParserContext</info>
108 <return type='xmlXPathContextPtr' info="The XPath context" field="context"/>
109 <arg name='ctxt' type='xmlXPathParserContextPtr' info='the XPath parser context'/>
110 </function>
111 <function name='xmlXPathGetContextDoc' file='python_accessor'>
112 <info>Get the doc from an xpathContext</info>
113 <return type='xmlDocPtr' info="The doc context" field="doc"/>
114 <arg name='ctxt' type='xmlXPathContextPtr' info='the XPath context'/>
115 </function>
116 <function name='xmlXPathGetContextNode' file='python_accessor'>
117 <info>Get the current node from an xpathContext</info>
118 <return type='xmlNodePtr' info="The node context" field="node"/>
119 <arg name='ctxt' type='xmlXPathContextPtr' info='the XPath context'/>
120 </function>
121 <function name='xmlXPathGetContextPosition' file='python_accessor'>
122 <info>Get the current node from an xpathContext</info>
123 <return type='int' info="The node context" field="proximityPosition"/>
124 <arg name='ctxt' type='xmlXPathContextPtr' info='the XPath context'/>
125 </function>
126 <function name='xmlXPathGetContextSize' file='python_accessor'>
127 <info>Get the current node from an xpathContext</info>
128 <return type='int' info="The node context" field="contextSize"/>
129 <arg name='ctxt' type='xmlXPathContextPtr' info='the XPath context'/>
130 </function>
131 <function name='xmlXPathGetFunction' file='python_accessor'>
132 <info>Get the current function name xpathContext</info>
133 <return type='const xmlChar *' info="The function name" field="function"/>
134 <arg name='ctxt' type='xmlXPathContextPtr' info='the XPath context'/>
135 </function>
136 <function name='xmlXPathGetFunctionURI' file='python_accessor'>
137 <info>Get the current function name URI xpathContext</info>
138 <return type='const xmlChar *' info="The function name URI" field="functionURI"/>
139 <arg name='ctxt' type='xmlXPathContextPtr' info='the XPath context'/>
140 </function>
Daniel Veillard6361da02002-02-23 10:10:33 +0000141 <!-- xmlURIPtr accessors -->
142 <function name='xmlURIGetScheme' file='python_accessor'>
143 <info>Get the scheme part from an URI</info>
144 <return type='const char *' info="The URI scheme" field="scheme"/>
145 <arg name='URI' type='xmlURIPtr' info='the URI'/>
146 </function>
147 <function name='xmlURISetScheme' file='python_accessor'>
148 <info>Set the scheme part of an URI.</info>
149 <return type='void'/>
150 <arg name='URI' type='xmlURIPtr' info='the URI'/>
151 <arg name='scheme' type='char *' info='The URI scheme part'/>
152 </function>
153 <function name='xmlURIGetOpaque' file='python_accessor'>
154 <info>Get the opaque part from an URI</info>
155 <return type='const char *' info="The URI opaque" field="opaque"/>
156 <arg name='URI' type='xmlURIPtr' info='the URI'/>
157 </function>
158 <function name='xmlURISetOpaque' file='python_accessor'>
159 <info>Set the opaque part of an URI.</info>
160 <return type='void'/>
161 <arg name='URI' type='xmlURIPtr' info='the URI'/>
162 <arg name='opaque' type='char *' info='The URI opaque part'/>
163 </function>
164 <function name='xmlURIGetAuthority' file='python_accessor'>
165 <info>Get the authority part from an URI</info>
166 <return type='const char *' info="The URI authority" field="authority"/>
167 <arg name='URI' type='xmlURIPtr' info='the URI'/>
168 </function>
169 <function name='xmlURISetAuthority' file='python_accessor'>
170 <info>Set the authority part of an URI.</info>
171 <return type='void'/>
172 <arg name='URI' type='xmlURIPtr' info='the URI'/>
173 <arg name='authority' type='char *' info='The URI authority part'/>
174 </function>
175 <function name='xmlURIGetServer' file='python_accessor'>
176 <info>Get the server part from an URI</info>
177 <return type='const char *' info="The URI server" field="server"/>
178 <arg name='URI' type='xmlURIPtr' info='the URI'/>
179 </function>
180 <function name='xmlURISetServer' file='python_accessor'>
181 <info>Set the server part of an URI.</info>
182 <return type='void'/>
183 <arg name='URI' type='xmlURIPtr' info='the URI'/>
184 <arg name='server' type='char *' info='The URI server part'/>
185 </function>
186 <function name='xmlURIGetUser' file='python_accessor'>
187 <info>Get the user part from an URI</info>
188 <return type='const char *' info="The URI user" field="user"/>
189 <arg name='URI' type='xmlURIPtr' info='the URI'/>
190 </function>
191 <function name='xmlURISetUser' file='python_accessor'>
192 <info>Set the user part of an URI.</info>
193 <return type='void'/>
194 <arg name='URI' type='xmlURIPtr' info='the URI'/>
195 <arg name='user' type='char *' info='The URI user part'/>
196 </function>
197 <function name='xmlURIGetPath' file='python_accessor'>
198 <info>Get the path part from an URI</info>
199 <return type='const char *' info="The URI path" field="path"/>
200 <arg name='URI' type='xmlURIPtr' info='the URI'/>
201 </function>
202 <function name='xmlURISetPath' file='python_accessor'>
203 <info>Set the path part of an URI.</info>
204 <return type='void'/>
205 <arg name='URI' type='xmlURIPtr' info='the URI'/>
206 <arg name='path' type='char *' info='The URI path part'/>
207 </function>
208 <function name='xmlURIGetQuery' file='python_accessor'>
209 <info>Get the query part from an URI</info>
210 <return type='const char *' info="The URI query" field="query"/>
211 <arg name='URI' type='xmlURIPtr' info='the URI'/>
212 </function>
213 <function name='xmlURISetQuery' file='python_accessor'>
214 <info>Set the query part of an URI.</info>
215 <return type='void'/>
216 <arg name='URI' type='xmlURIPtr' info='the URI'/>
217 <arg name='query' type='char *' info='The URI query part'/>
218 </function>
219 <function name='xmlURIGetFragment' file='python_accessor'>
220 <info>Get the fragment part from an URI</info>
221 <return type='const char *' info="The URI fragment" field="fragment"/>
222 <arg name='URI' type='xmlURIPtr' info='the URI'/>
223 </function>
224 <function name='xmlURISetFragment' file='python_accessor'>
225 <info>Set the fragment part of an URI.</info>
226 <return type='void'/>
227 <arg name='URI' type='xmlURIPtr' info='the URI'/>
228 <arg name='fragment' type='char *' info='The URI fragment part'/>
229 </function>
230 <function name='xmlURIGetPort' file='python_accessor'>
231 <info>Get the port part from an URI</info>
232 <return type='int' info="The URI port" field="port"/>
233 <arg name='URI' type='xmlURIPtr' info='the URI'/>
234 </function>
235 <function name='xmlURISetPort' file='python_accessor'>
236 <info>Set the port part of an URI.</info>
237 <return type='void'/>
238 <arg name='URI' type='xmlURIPtr' info='the URI'/>
239 <arg name='port' type='int' info='The URI port part'/>
240 </function>
Daniel Veillard9589d452002-02-02 10:28:17 +0000241 </symbols>
242</api>