blob: 6aad6b0edb7631837bc21ad4c2311b450da364be [file] [log] [blame]
Daniel Veillardd2897fd2002-01-30 16:37:32 +00001#!/usr/bin/python -u
2#
3# generate python wrappers from the XML API description
4#
5
6functions = {}
7
Daniel Veillard0fea6f42002-02-22 22:51:13 +00008import sys
Daniel Veillard36ed5292002-01-30 23:49:06 +00009import string
Daniel Veillard1971ee22002-01-31 20:29:19 +000010
11#######################################################################
12#
13# That part if purely the API acquisition phase from the
14# XML API description
15#
16#######################################################################
17import os
Daniel Veillardd2897fd2002-01-30 16:37:32 +000018import xmllib
19try:
20 import sgmlop
21except ImportError:
22 sgmlop = None # accelerator not available
23
24debug = 0
25
26if sgmlop:
27 class FastParser:
Daniel Veillard01a6d412002-02-11 18:42:20 +000028 """sgmlop based XML parser. this is typically 15x faster
29 than SlowParser..."""
Daniel Veillardd2897fd2002-01-30 16:37:32 +000030
Daniel Veillard01a6d412002-02-11 18:42:20 +000031 def __init__(self, target):
Daniel Veillardd2897fd2002-01-30 16:37:32 +000032
Daniel Veillard01a6d412002-02-11 18:42:20 +000033 # setup callbacks
34 self.finish_starttag = target.start
35 self.finish_endtag = target.end
36 self.handle_data = target.data
Daniel Veillardd2897fd2002-01-30 16:37:32 +000037
Daniel Veillard01a6d412002-02-11 18:42:20 +000038 # activate parser
39 self.parser = sgmlop.XMLParser()
40 self.parser.register(self)
41 self.feed = self.parser.feed
42 self.entity = {
43 "amp": "&", "gt": ">", "lt": "<",
44 "apos": "'", "quot": '"'
45 }
Daniel Veillardd2897fd2002-01-30 16:37:32 +000046
Daniel Veillard01a6d412002-02-11 18:42:20 +000047 def close(self):
48 try:
49 self.parser.close()
50 finally:
51 self.parser = self.feed = None # nuke circular reference
Daniel Veillardd2897fd2002-01-30 16:37:32 +000052
Daniel Veillard01a6d412002-02-11 18:42:20 +000053 def handle_entityref(self, entity):
54 # <string> entity
55 try:
56 self.handle_data(self.entity[entity])
57 except KeyError:
58 self.handle_data("&%s;" % entity)
Daniel Veillardd2897fd2002-01-30 16:37:32 +000059
60else:
61 FastParser = None
62
63
64class SlowParser(xmllib.XMLParser):
65 """slow but safe standard parser, based on the XML parser in
66 Python's standard library."""
67
68 def __init__(self, target):
Daniel Veillard01a6d412002-02-11 18:42:20 +000069 self.unknown_starttag = target.start
70 self.handle_data = target.data
71 self.unknown_endtag = target.end
72 xmllib.XMLParser.__init__(self)
Daniel Veillardd2897fd2002-01-30 16:37:32 +000073
74def getparser(target = None):
75 # get the fastest available parser, and attach it to an
76 # unmarshalling object. return both objects.
77 if target == None:
Daniel Veillard01a6d412002-02-11 18:42:20 +000078 target = docParser()
Daniel Veillardd2897fd2002-01-30 16:37:32 +000079 if FastParser:
Daniel Veillard01a6d412002-02-11 18:42:20 +000080 return FastParser(target), target
Daniel Veillardd2897fd2002-01-30 16:37:32 +000081 return SlowParser(target), target
82
83class docParser:
84 def __init__(self):
85 self._methodname = None
Daniel Veillard01a6d412002-02-11 18:42:20 +000086 self._data = []
87 self.in_function = 0
Daniel Veillardd2897fd2002-01-30 16:37:32 +000088
89 def close(self):
90 if debug:
Daniel Veillard01a6d412002-02-11 18:42:20 +000091 print "close"
Daniel Veillardd2897fd2002-01-30 16:37:32 +000092
93 def getmethodname(self):
94 return self._methodname
95
96 def data(self, text):
97 if debug:
Daniel Veillard01a6d412002-02-11 18:42:20 +000098 print "data %s" % text
Daniel Veillardd2897fd2002-01-30 16:37:32 +000099 self._data.append(text)
100
101 def start(self, tag, attrs):
102 if debug:
Daniel Veillard01a6d412002-02-11 18:42:20 +0000103 print "start %s, %s" % (tag, attrs)
104 if tag == 'function':
105 self._data = []
106 self.in_function = 1
107 self.function = None
108 self.function_args = []
109 self.function_descr = None
110 self.function_return = None
111 self.function_file = None
112 if attrs.has_key('name'):
113 self.function = attrs['name']
114 if attrs.has_key('file'):
115 self.function_file = attrs['file']
116 elif tag == 'info':
117 self._data = []
118 elif tag == 'arg':
119 if self.in_function == 1:
120 self.function_arg_name = None
121 self.function_arg_type = None
122 self.function_arg_info = None
123 if attrs.has_key('name'):
124 self.function_arg_name = attrs['name']
125 if attrs.has_key('type'):
126 self.function_arg_type = attrs['type']
127 if attrs.has_key('info'):
128 self.function_arg_info = attrs['info']
129 elif tag == 'return':
130 if self.in_function == 1:
131 self.function_return_type = None
132 self.function_return_info = None
133 self.function_return_field = None
134 if attrs.has_key('type'):
135 self.function_return_type = attrs['type']
136 if attrs.has_key('info'):
137 self.function_return_info = attrs['info']
138 if attrs.has_key('field'):
139 self.function_return_field = attrs['field']
Daniel Veillardd2897fd2002-01-30 16:37:32 +0000140
141
142 def end(self, tag):
143 if debug:
Daniel Veillard01a6d412002-02-11 18:42:20 +0000144 print "end %s" % tag
145 if tag == 'function':
146 if self.function != None:
147 function(self.function, self.function_descr,
148 self.function_return, self.function_args,
149 self.function_file)
150 self.in_function = 0
151 elif tag == 'arg':
152 if self.in_function == 1:
153 self.function_args.append([self.function_arg_name,
154 self.function_arg_type,
155 self.function_arg_info])
156 elif tag == 'return':
157 if self.in_function == 1:
158 self.function_return = [self.function_return_type,
159 self.function_return_info,
160 self.function_return_field]
161 elif tag == 'info':
162 str = ''
163 for c in self._data:
164 str = str + c
165 if self.in_function == 1:
166 self.function_descr = str
167
168
Daniel Veillardd2897fd2002-01-30 16:37:32 +0000169def function(name, desc, ret, args, file):
170 global functions
171
172 functions[name] = (desc, ret, args, file)
173
Daniel Veillard1971ee22002-01-31 20:29:19 +0000174#######################################################################
175#
176# Some filtering rukes to drop functions/types which should not
177# be exposed as-is on the Python interface
178#
179#######################################################################
Daniel Veillard36ed5292002-01-30 23:49:06 +0000180
Daniel Veillardd2897fd2002-01-30 16:37:32 +0000181skipped_modules = {
182 'xmlmemory': None,
Daniel Veillard96fe0952002-01-30 20:52:23 +0000183 'DOCBparser': None,
184 'SAX': None,
185 'hash': None,
186 'list': None,
187 'threads': None,
Daniel Veillard1971ee22002-01-31 20:29:19 +0000188 'xpointer': None,
Daniel Veillard96fe0952002-01-30 20:52:23 +0000189}
190skipped_types = {
191 'int *': "usually a return type",
192 'xmlSAXHandlerPtr': "not the proper interface for SAX",
193 'htmlSAXHandlerPtr': "not the proper interface for SAX",
Daniel Veillard96fe0952002-01-30 20:52:23 +0000194 'xmlRMutexPtr': "thread specific, skipped",
195 'xmlMutexPtr': "thread specific, skipped",
196 'xmlGlobalStatePtr': "thread specific, skipped",
197 'xmlListPtr': "internal representation not suitable for python",
198 'xmlBufferPtr': "internal representation not suitable for python",
199 'FILE *': None,
Daniel Veillardd2897fd2002-01-30 16:37:32 +0000200}
Daniel Veillard1971ee22002-01-31 20:29:19 +0000201
202#######################################################################
203#
204# Table of remapping to/from the python type or class to the C
205# counterpart.
206#
207#######################################################################
208
Daniel Veillardd2897fd2002-01-30 16:37:32 +0000209py_types = {
Daniel Veillard96fe0952002-01-30 20:52:23 +0000210 'void': (None, None, None, None),
211 'int': ('i', None, "int", "int"),
212 'long': ('i', None, "int", "int"),
213 'double': ('d', None, "double", "double"),
214 'unsigned int': ('i', None, "int", "int"),
215 'xmlChar': ('c', None, "int", "int"),
Daniel Veillard253aa2c2002-02-02 09:17:16 +0000216 'unsigned char *': ('z', None, "charPtr", "char *"),
217 'char *': ('z', None, "charPtr", "char *"),
Daniel Veillardc575b992002-02-08 13:28:40 +0000218 'const char *': ('z', None, "charPtrConst", "const char *"),
Daniel Veillard253aa2c2002-02-02 09:17:16 +0000219 'xmlChar *': ('z', None, "xmlCharPtr", "xmlChar *"),
Daniel Veillardc575b992002-02-08 13:28:40 +0000220 'const xmlChar *': ('z', None, "xmlCharPtrConst", "const xmlChar *"),
Daniel Veillard96fe0952002-01-30 20:52:23 +0000221 'xmlNodePtr': ('O', "xmlNode", "xmlNodePtr", "xmlNodePtr"),
222 'const xmlNodePtr': ('O', "xmlNode", "xmlNodePtr", "xmlNodePtr"),
223 'xmlNode *': ('O', "xmlNode", "xmlNodePtr", "xmlNodePtr"),
224 'const xmlNode *': ('O', "xmlNode", "xmlNodePtr", "xmlNodePtr"),
225 'xmlDtdPtr': ('O', "xmlNode", "xmlNodePtr", "xmlNodePtr"),
226 'const xmlDtdPtr': ('O', "xmlNode", "xmlNodePtr", "xmlNodePtr"),
227 'xmlDtd *': ('O', "xmlNode", "xmlNodePtr", "xmlNodePtr"),
228 'const xmlDtd *': ('O', "xmlNode", "xmlNodePtr", "xmlNodePtr"),
229 'xmlAttrPtr': ('O', "xmlNode", "xmlNodePtr", "xmlNodePtr"),
230 'const xmlAttrPtr': ('O', "xmlNode", "xmlNodePtr", "xmlNodePtr"),
231 'xmlAttr *': ('O', "xmlNode", "xmlNodePtr", "xmlNodePtr"),
232 'const xmlAttr *': ('O', "xmlNode", "xmlNodePtr", "xmlNodePtr"),
233 'xmlEntityPtr': ('O', "xmlNode", "xmlNodePtr", "xmlNodePtr"),
234 'const xmlEntityPtr': ('O', "xmlNode", "xmlNodePtr", "xmlNodePtr"),
235 'xmlEntity *': ('O', "xmlNode", "xmlNodePtr", "xmlNodePtr"),
236 'const xmlEntity *': ('O', "xmlNode", "xmlNodePtr", "xmlNodePtr"),
Daniel Veillard1971ee22002-01-31 20:29:19 +0000237 'xmlElementPtr': ('O', "xmlElement", "xmlElementPtr", "xmlElementPtr"),
238 'const xmlElementPtr': ('O', "xmlElement", "xmlElementPtr", "xmlElementPtr"),
239 'xmlElement *': ('O', "xmlElement", "xmlElementPtr", "xmlElementPtr"),
240 'const xmlElement *': ('O', "xmlElement", "xmlElementPtr", "xmlElementPtr"),
241 'xmlAttributePtr': ('O', "xmlAttribute", "xmlAttributePtr", "xmlAttributePtr"),
242 'const xmlAttributePtr': ('O', "xmlAttribute", "xmlAttributePtr", "xmlAttributePtr"),
243 'xmlAttribute *': ('O', "xmlAttribute", "xmlAttributePtr", "xmlAttributePtr"),
244 'const xmlAttribute *': ('O', "xmlAttribute", "xmlAttributePtr", "xmlAttributePtr"),
245 'xmlNsPtr': ('O', "xmlNode", "xmlNsPtr", "xmlNsPtr"),
246 'const xmlNsPtr': ('O', "xmlNode", "xmlNsPtr", "xmlNsPtr"),
247 'xmlNs *': ('O', "xmlNode", "xmlNsPtr", "xmlNsPtr"),
248 'const xmlNs *': ('O', "xmlNode", "xmlNsPtr", "xmlNsPtr"),
Daniel Veillard96fe0952002-01-30 20:52:23 +0000249 'xmlDocPtr': ('O', "xmlNode", "xmlDocPtr", "xmlDocPtr"),
250 'const xmlDocPtr': ('O', "xmlNode", "xmlDocPtr", "xmlDocPtr"),
251 'xmlDoc *': ('O', "xmlNode", "xmlDocPtr", "xmlDocPtr"),
252 'const xmlDoc *': ('O', "xmlNode", "xmlDocPtr", "xmlDocPtr"),
253 'htmlDocPtr': ('O', "xmlNode", "xmlDocPtr", "xmlDocPtr"),
254 'const htmlDocPtr': ('O', "xmlNode", "xmlDocPtr", "xmlDocPtr"),
255 'htmlDoc *': ('O', "xmlNode", "xmlDocPtr", "xmlDocPtr"),
256 'const htmlDoc *': ('O', "xmlNode", "xmlDocPtr", "xmlDocPtr"),
257 'htmlNodePtr': ('O', "xmlNode", "xmlNodePtr", "xmlNodePtr"),
258 'const htmlNodePtr': ('O', "xmlNode", "xmlNodePtr", "xmlNodePtr"),
259 'htmlNode *': ('O', "xmlNode", "xmlNodePtr", "xmlNodePtr"),
260 'const htmlNode *': ('O', "xmlNode", "xmlNodePtr", "xmlNodePtr"),
Daniel Veillard1971ee22002-01-31 20:29:19 +0000261 'xmlXPathContextPtr': ('O', "xmlXPathContext", "xmlXPathContextPtr", "xmlXPathContextPtr"),
262 'xmlXPathContext *': ('O', "xpathContext", "xmlXPathContextPtr", "xmlXPathContextPtr"),
Daniel Veillard7db38712002-02-07 16:39:11 +0000263 'xmlXPathParserContextPtr': ('O', "xmlXPathParserContext", "xmlXPathParserContextPtr", "xmlXPathParserContextPtr"),
Daniel Veillard3ce52572002-02-03 15:08:05 +0000264 'xmlParserCtxtPtr': ('O', "parserCtxt", "xmlParserCtxtPtr", "xmlParserCtxtPtr"),
265 'xmlParserCtxt *': ('O', "parserCtxt", "xmlParserCtxtPtr", "xmlParserCtxtPtr"),
266 'htmlParserCtxtPtr': ('O', "parserCtxt", "xmlParserCtxtPtr", "xmlParserCtxtPtr"),
267 'htmlParserCtxt *': ('O', "parserCtxt", "xmlParserCtxtPtr", "xmlParserCtxtPtr"),
Daniel Veillard7db38712002-02-07 16:39:11 +0000268 'xmlCatalogPtr': ('O', "catalog", "xmlCatalogPtr", "xmlCatalogPtr"),
269 'FILE *': ('O', "File", "FILEPtr", "FILE *"),
Daniel Veillard6361da02002-02-23 10:10:33 +0000270 'xmlURIPtr': ('O', "URI", "xmlURIPtr", "xmlURIPtr"),
Daniel Veillard1971ee22002-01-31 20:29:19 +0000271}
272
273py_return_types = {
274 'xmlXPathObjectPtr': ('O', "foo", "xmlXPathObjectPtr", "xmlXPathObjectPtr"),
Daniel Veillardd2897fd2002-01-30 16:37:32 +0000275}
276
277unknown_types = {}
278
Daniel Veillard1971ee22002-01-31 20:29:19 +0000279#######################################################################
280#
281# This part writes the C <-> Python stubs libxml2-py.[ch] and
282# the table libxml2-export.c to add when registrering the Python module
283#
284#######################################################################
285
286def skip_function(name):
287 if name[0:12] == "xmlXPathWrap":
288 return 1
289# if name[0:11] == "xmlXPathNew":
290# return 1
291 return 0
292
Daniel Veillard96fe0952002-01-30 20:52:23 +0000293def print_function_wrapper(name, output, export, include):
Daniel Veillardd2897fd2002-01-30 16:37:32 +0000294 global py_types
295 global unknown_types
296 global functions
297 global skipped_modules
298
299 try:
Daniel Veillard01a6d412002-02-11 18:42:20 +0000300 (desc, ret, args, file) = functions[name]
Daniel Veillardd2897fd2002-01-30 16:37:32 +0000301 except:
302 print "failed to get function %s infos"
303 return
304
305 if skipped_modules.has_key(file):
306 return 0
Daniel Veillard1971ee22002-01-31 20:29:19 +0000307 if skip_function(name) == 1:
308 return 0
Daniel Veillardd2897fd2002-01-30 16:37:32 +0000309
310 c_call = "";
311 format=""
312 format_args=""
313 c_args=""
314 c_return=""
Daniel Veillard96fe0952002-01-30 20:52:23 +0000315 c_convert=""
Daniel Veillardd2897fd2002-01-30 16:37:32 +0000316 for arg in args:
Daniel Veillard01a6d412002-02-11 18:42:20 +0000317 # This should be correct
318 if arg[1][0:6] == "const ":
319 arg[1] = arg[1][6:]
Daniel Veillardd2897fd2002-01-30 16:37:32 +0000320 c_args = c_args + " %s %s;\n" % (arg[1], arg[0])
Daniel Veillard01a6d412002-02-11 18:42:20 +0000321 if py_types.has_key(arg[1]):
322 (f, t, n, c) = py_types[arg[1]]
323 if f != None:
324 format = format + f
325 if t != None:
326 format_args = format_args + ", &pyobj_%s" % (arg[0])
327 c_args = c_args + " PyObject *pyobj_%s;\n" % (arg[0])
328 c_convert = c_convert + \
329 " %s = (%s) Py%s_Get(pyobj_%s);\n" % (arg[0],
330 arg[1], t, arg[0]);
331 else:
332 format_args = format_args + ", &%s" % (arg[0])
333 if c_call != "":
334 c_call = c_call + ", ";
335 c_call = c_call + "%s" % (arg[0])
336 else:
337 if skipped_types.has_key(arg[1]):
338 return 0
339 if unknown_types.has_key(arg[1]):
340 lst = unknown_types[arg[1]]
341 lst.append(name)
342 else:
343 unknown_types[arg[1]] = [name]
344 return -1
Daniel Veillardd2897fd2002-01-30 16:37:32 +0000345 if format != "":
346 format = format + ":%s" % (name)
347
348 if ret[0] == 'void':
Daniel Veillard01a6d412002-02-11 18:42:20 +0000349 if file == "python_accessor":
Daniel Veillard6361da02002-02-23 10:10:33 +0000350 if args[1][1] == "char *" or args[1][1] == "xmlChar *":
351 c_call = "\n if (%s->%s != NULL) xmlFree(%s->%s);\n" % (
352 args[0][0], args[1][0], args[0][0], args[1][0])
353 c_call = c_call + " %s->%s = xmlStrdup(%s);\n" % (args[0][0],
354 args[1][0], args[1][0])
355 else:
356 c_call = "\n %s->%s = %s;\n" % (args[0][0], args[1][0],
357 args[1][0])
Daniel Veillard01a6d412002-02-11 18:42:20 +0000358 else:
359 c_call = "\n %s(%s);\n" % (name, c_call);
360 ret_convert = " Py_INCREF(Py_None);\n return(Py_None);\n"
Daniel Veillardd2897fd2002-01-30 16:37:32 +0000361 elif py_types.has_key(ret[0]):
Daniel Veillard01a6d412002-02-11 18:42:20 +0000362 (f, t, n, c) = py_types[ret[0]]
363 c_return = " %s c_retval;\n" % (ret[0])
364 if file == "python_accessor" and ret[2] != None:
365 c_call = "\n c_retval = %s->%s;\n" % (args[0][0], ret[2])
366 else:
367 c_call = "\n c_retval = %s(%s);\n" % (name, c_call);
368 ret_convert = " py_retval = libxml_%sWrap((%s) c_retval);\n" % (n,c)
369 ret_convert = ret_convert + " return(py_retval);\n"
Daniel Veillard1971ee22002-01-31 20:29:19 +0000370 elif py_return_types.has_key(ret[0]):
Daniel Veillard01a6d412002-02-11 18:42:20 +0000371 (f, t, n, c) = py_return_types[ret[0]]
372 c_return = " %s c_retval;\n" % (ret[0])
Daniel Veillard1971ee22002-01-31 20:29:19 +0000373 c_call = "\n c_retval = %s(%s);\n" % (name, c_call);
Daniel Veillard01a6d412002-02-11 18:42:20 +0000374 ret_convert = " py_retval = libxml_%sWrap((%s) c_retval);\n" % (n,c)
375 ret_convert = ret_convert + " return(py_retval);\n"
Daniel Veillardd2897fd2002-01-30 16:37:32 +0000376 else:
Daniel Veillard01a6d412002-02-11 18:42:20 +0000377 if skipped_types.has_key(ret[0]):
378 return 0
379 if unknown_types.has_key(ret[0]):
380 lst = unknown_types[ret[0]]
381 lst.append(name)
382 else:
383 unknown_types[ret[0]] = [name]
384 return -1
Daniel Veillardd2897fd2002-01-30 16:37:32 +0000385
Daniel Veillard96fe0952002-01-30 20:52:23 +0000386 include.write("PyObject * ")
387 include.write("libxml_%s(PyObject *self, PyObject *args);\n" % (name))
Daniel Veillard9589d452002-02-02 10:28:17 +0000388
Daniel Veillard5e5c2d02002-02-09 18:03:01 +0000389 export.write(" { \"%s\", libxml_%s, METH_VARARGS, NULL },\n" %
390 (name, name))
Daniel Veillard9589d452002-02-02 10:28:17 +0000391
392 if file == "python":
393 # Those have been manually generated
Daniel Veillard01a6d412002-02-11 18:42:20 +0000394 return 1
Daniel Veillard36eea2d2002-02-04 00:17:01 +0000395 if file == "python_accessor" and ret[0] != "void" and ret[2] == None:
396 # Those have been manually generated
Daniel Veillard01a6d412002-02-11 18:42:20 +0000397 return 1
Daniel Veillard9589d452002-02-02 10:28:17 +0000398
Daniel Veillardd2897fd2002-01-30 16:37:32 +0000399 output.write("PyObject *\n")
400 output.write("libxml_%s(PyObject *self, PyObject *args) {\n" % (name))
401 if ret[0] != 'void':
Daniel Veillard01a6d412002-02-11 18:42:20 +0000402 output.write(" PyObject *py_retval;\n")
Daniel Veillardd2897fd2002-01-30 16:37:32 +0000403 if c_return != "":
Daniel Veillard01a6d412002-02-11 18:42:20 +0000404 output.write(c_return)
Daniel Veillardd2897fd2002-01-30 16:37:32 +0000405 if c_args != "":
Daniel Veillard01a6d412002-02-11 18:42:20 +0000406 output.write(c_args)
Daniel Veillardd2897fd2002-01-30 16:37:32 +0000407 if format != "":
Daniel Veillard01a6d412002-02-11 18:42:20 +0000408 output.write("\n if (!PyArg_ParseTuple(args, \"%s\"%s))\n" %
409 (format, format_args))
410 output.write(" return(NULL);\n")
Daniel Veillard96fe0952002-01-30 20:52:23 +0000411 if c_convert != "":
Daniel Veillard01a6d412002-02-11 18:42:20 +0000412 output.write(c_convert)
Daniel Veillardd2897fd2002-01-30 16:37:32 +0000413
414 output.write(c_call)
415 output.write(ret_convert)
416 output.write("}\n\n")
417 return 1
418
Daniel Veillard0fea6f42002-02-22 22:51:13 +0000419def buildStubs():
420 global py_types
421 global py_return_types
422 global unknown_types
Daniel Veillardd2897fd2002-01-30 16:37:32 +0000423
Daniel Veillard0fea6f42002-02-22 22:51:13 +0000424 try:
425 f = open("libxml2-api.xml")
426 data = f.read()
427 (parser, target) = getparser()
428 parser.feed(data)
429 parser.close()
430 except IOError, msg:
431 try:
432 f = open("../doc/libxml2-api.xml")
433 data = f.read()
434 (parser, target) = getparser()
435 parser.feed(data)
436 parser.close()
437 except IOError, msg:
438 print file, ":", msg
439 sys.exit(1)
Daniel Veillard9589d452002-02-02 10:28:17 +0000440
Daniel Veillard0fea6f42002-02-22 22:51:13 +0000441 n = len(functions.keys())
442 print "Found %d functions in libxml2-api.xml" % (n)
443
444 py_types['pythonObject'] = ('O', "pythonObject", "pythonObject", "pythonObject")
445 try:
446 f = open("libxml2-python-api.xml")
447 data = f.read()
448 (parser, target) = getparser()
449 parser.feed(data)
450 parser.close()
451 except IOError, msg:
452 print file, ":", msg
Daniel Veillard9589d452002-02-02 10:28:17 +0000453
454
Daniel Veillard0fea6f42002-02-22 22:51:13 +0000455 print "Found %d functions in libxml2-python-api.xml" % (
456 len(functions.keys()) - n)
457 nb_wrap = 0
458 failed = 0
459 skipped = 0
Daniel Veillardd2897fd2002-01-30 16:37:32 +0000460
Daniel Veillard0fea6f42002-02-22 22:51:13 +0000461 include = open("libxml2-py.h", "w")
462 include.write("/* Generated */\n\n")
463 export = open("libxml2-export.c", "w")
464 export.write("/* Generated */\n\n")
465 wrapper = open("libxml2-py.c", "w")
466 wrapper.write("/* Generated */\n\n")
467 wrapper.write("#include <Python.h>\n")
468 wrapper.write("#include <libxml/tree.h>\n")
469 wrapper.write("#include \"libxml_wrap.h\"\n")
470 wrapper.write("#include \"libxml2-py.h\"\n\n")
471 for function in functions.keys():
472 ret = print_function_wrapper(function, wrapper, export, include)
473 if ret < 0:
474 failed = failed + 1
475 del functions[function]
476 if ret == 0:
477 skipped = skipped + 1
478 del functions[function]
479 if ret == 1:
480 nb_wrap = nb_wrap + 1
481 include.close()
482 export.close()
483 wrapper.close()
Daniel Veillardd2897fd2002-01-30 16:37:32 +0000484
Daniel Veillard0fea6f42002-02-22 22:51:13 +0000485 print "Generated %d wrapper functions, %d failed, %d skipped\n" % (nb_wrap,
486 failed, skipped);
487 print "Missing type converters: "
488 for type in unknown_types.keys():
489 print "%s:%d " % (type, len(unknown_types[type])),
490 print
Daniel Veillard36ed5292002-01-30 23:49:06 +0000491
Daniel Veillard1971ee22002-01-31 20:29:19 +0000492#######################################################################
493#
494# This part writes part of the Python front-end classes based on
495# mapping rules between types and classes and also based on function
496# renaming to get consistent function names at the Python level
497#
498#######################################################################
499
500#
501# The type automatically remapped to generated classes
502#
503classes_type = {
504 "xmlNodePtr": ("._o", "xmlNode(_obj=%s)", "xmlNode"),
505 "xmlNode *": ("._o", "xmlNode(_obj=%s)", "xmlNode"),
506 "xmlDocPtr": ("._o", "xmlDoc(_obj=%s)", "xmlDoc"),
507 "xmlDocPtr *": ("._o", "xmlDoc(_obj=%s)", "xmlDoc"),
508 "htmlDocPtr": ("._o", "xmlDoc(_obj=%s)", "xmlDoc"),
509 "htmlxmlDocPtr *": ("._o", "xmlDoc(_obj=%s)", "xmlDoc"),
510 "xmlAttrPtr": ("._o", "xmlAttr(_obj=%s)", "xmlAttr"),
511 "xmlAttr *": ("._o", "xmlAttr(_obj=%s)", "xmlAttr"),
512 "xmlNsPtr": ("._o", "xmlNs(_obj=%s)", "xmlNs"),
513 "xmlNs *": ("._o", "xmlNs(_obj=%s)", "xmlNs"),
514 "xmlDtdPtr": ("._o", "xmlDtd(_obj=%s)", "xmlDtd"),
515 "xmlDtd *": ("._o", "xmlDtd(_obj=%s)", "xmlDtd"),
516 "xmlEntityPtr": ("._o", "xmlEntity(_obj=%s)", "xmlEntity"),
517 "xmlEntity *": ("._o", "xmlEntity(_obj=%s)", "xmlEntity"),
518 "xmlElementPtr": ("._o", "xmlElement(_obj=%s)", "xmlElement"),
519 "xmlElement *": ("._o", "xmlElement(_obj=%s)", "xmlElement"),
520 "xmlAttributePtr": ("._o", "xmlAttribute(_obj=%s)", "xmlAttribute"),
521 "xmlAttribute *": ("._o", "xmlAttribute(_obj=%s)", "xmlAttribute"),
522 "xmlXPathContextPtr": ("._o", "xpathContext(_obj=%s)", "xpathContext"),
Daniel Veillard7db38712002-02-07 16:39:11 +0000523 "xmlXPathContext *": ("._o", "xpathContext(_obj=%s)", "xpathContext"),
524 "xmlXPathParserContext *": ("._o", "xpathParserContext(_obj=%s)", "xpathParserContext"),
525 "xmlXPathParserContextPtr": ("._o", "xpathParserContext(_obj=%s)", "xpathParserContext"),
Daniel Veillard3ce52572002-02-03 15:08:05 +0000526 "xmlParserCtxtPtr": ("._o", "parserCtxt(_obj=%s)", "parserCtxt"),
527 "xmlParserCtxt *": ("._o", "parserCtxt(_obj=%s)", "parserCtxt"),
Daniel Veillard7db38712002-02-07 16:39:11 +0000528 "xmlCatalogPtr": ("._o", "catalog(_obj=%s)", "catalog"),
Daniel Veillard6361da02002-02-23 10:10:33 +0000529 "xmlURIPtr": ("._o", "URI(_obj=%s)", "URI"),
Daniel Veillard1971ee22002-01-31 20:29:19 +0000530}
531
532converter_type = {
533 "xmlXPathObjectPtr": "xpathObjectRet(%s)",
534}
535
536primary_classes = ["xmlNode", "xmlDoc"]
537
538classes_ancestor = {
539 "xmlNode" : "xmlCore",
Daniel Veillard253aa2c2002-02-02 09:17:16 +0000540 "xmlDtd" : "xmlNode",
541 "xmlDoc" : "xmlNode",
542 "xmlAttr" : "xmlNode",
543 "xmlNs" : "xmlNode",
544 "xmlEntity" : "xmlNode",
545 "xmlElement" : "xmlNode",
546 "xmlAttribute" : "xmlNode",
Daniel Veillard1971ee22002-01-31 20:29:19 +0000547}
548classes_destructors = {
Daniel Veillard3ce52572002-02-03 15:08:05 +0000549 "parserCtxt": "xmlFreeParserCtxt",
Daniel Veillard7db38712002-02-07 16:39:11 +0000550 "catalog": "xmlFreeCatalog",
Daniel Veillard6361da02002-02-23 10:10:33 +0000551 "URI": "xmlFreeURI",
Daniel Veillard1971ee22002-01-31 20:29:19 +0000552}
553
Daniel Veillard36ed5292002-01-30 23:49:06 +0000554function_classes = {}
Daniel Veillard1971ee22002-01-31 20:29:19 +0000555
556function_classes["None"] = []
Daniel Veillard1971ee22002-01-31 20:29:19 +0000557
Daniel Veillard0fea6f42002-02-22 22:51:13 +0000558def nameFixup(name, classe, type, file):
Daniel Veillard1971ee22002-01-31 20:29:19 +0000559 listname = classe + "List"
560 ll = len(listname)
561 l = len(classe)
562 if name[0:l] == listname:
Daniel Veillard01a6d412002-02-11 18:42:20 +0000563 func = name[l:]
564 func = string.lower(func[0:1]) + func[1:]
Daniel Veillard3ce52572002-02-03 15:08:05 +0000565 elif name[0:12] == "xmlParserGet" and file == "python_accessor":
566 func = name[12:]
567 func = string.lower(func[0:1]) + func[1:]
Daniel Veillard26f1dcc2002-02-03 16:53:19 +0000568 elif name[0:12] == "xmlParserSet" and file == "python_accessor":
569 func = name[12:]
570 func = string.lower(func[0:1]) + func[1:]
Daniel Veillard36eea2d2002-02-04 00:17:01 +0000571 elif name[0:10] == "xmlNodeGet" and file == "python_accessor":
572 func = name[10:]
573 func = string.lower(func[0:1]) + func[1:]
Daniel Veillard6361da02002-02-23 10:10:33 +0000574 elif name[0:9] == "xmlURIGet" and file == "python_accessor":
575 func = name[9:]
576 func = string.lower(func[0:1]) + func[1:]
577 elif name[0:9] == "xmlURISet" and file == "python_accessor":
578 func = name[6:]
579 func = string.lower(func[0:1]) + func[1:]
Daniel Veillardc575b992002-02-08 13:28:40 +0000580 elif name[0:17] == "xmlXPathParserGet" and file == "python_accessor":
581 func = name[17:]
582 func = string.lower(func[0:1]) + func[1:]
583 elif name[0:11] == "xmlXPathGet" and file == "python_accessor":
584 func = name[11:]
585 func = string.lower(func[0:1]) + func[1:]
Daniel Veillard7db38712002-02-07 16:39:11 +0000586 elif name[0:11] == "xmlACatalog":
587 func = name[11:]
588 func = string.lower(func[0:1]) + func[1:]
Daniel Veillard1971ee22002-01-31 20:29:19 +0000589 elif name[0:l] == classe:
Daniel Veillard01a6d412002-02-11 18:42:20 +0000590 func = name[l:]
591 func = string.lower(func[0:1]) + func[1:]
Daniel Veillard9589d452002-02-02 10:28:17 +0000592 elif name[0:7] == "libxml_":
Daniel Veillard01a6d412002-02-11 18:42:20 +0000593 func = name[7:]
594 func = string.lower(func[0:1]) + func[1:]
Daniel Veillard1971ee22002-01-31 20:29:19 +0000595 elif name[0:6] == "xmlGet":
Daniel Veillard01a6d412002-02-11 18:42:20 +0000596 func = name[6:]
597 func = string.lower(func[0:1]) + func[1:]
Daniel Veillard1971ee22002-01-31 20:29:19 +0000598 elif name[0:3] == "xml":
Daniel Veillard01a6d412002-02-11 18:42:20 +0000599 func = name[3:]
600 func = string.lower(func[0:1]) + func[1:]
Daniel Veillard36ed5292002-01-30 23:49:06 +0000601 else:
Daniel Veillard1971ee22002-01-31 20:29:19 +0000602 func = name
603 if func[0:5] == "xPath":
604 func = "xpath" + func[5:]
605 elif func[0:4] == "xPtr":
606 func = "xpointer" + func[4:]
607 elif func[0:8] == "xInclude":
608 func = "xinclude" + func[8:]
609 elif func[0:2] == "iD":
610 func = "ID" + func[2:]
611 elif func[0:3] == "uRI":
612 func = "URI" + func[3:]
613 elif func[0:4] == "uTF8":
614 func = "UTF8" + func[4:]
615 return func
Daniel Veillard36ed5292002-01-30 23:49:06 +0000616
Daniel Veillard36ed5292002-01-30 23:49:06 +0000617
Daniel Veillard1971ee22002-01-31 20:29:19 +0000618def functionCompare(info1, info2):
619 (index1, func1, name1, ret1, args1, file1) = info1
620 (index2, func2, name2, ret2, args2, file2) = info2
Daniel Veillard26f1dcc2002-02-03 16:53:19 +0000621 if file1 == file2:
Daniel Veillard01a6d412002-02-11 18:42:20 +0000622 if func1 < func2:
623 return -1
624 if func1 > func2:
625 return 1
Daniel Veillard3ce52572002-02-03 15:08:05 +0000626 if file1 == "python_accessor":
627 return -1
628 if file2 == "python_accessor":
629 return 1
Daniel Veillard1971ee22002-01-31 20:29:19 +0000630 if file1 < file2:
631 return -1
632 if file1 > file2:
633 return 1
Daniel Veillard1971ee22002-01-31 20:29:19 +0000634 return 0
635
636def writeDoc(name, args, indent, output):
637 if functions[name][0] == None or functions[name][0] == "":
638 return
639 val = functions[name][0]
640 val = string.replace(val, "NULL", "None");
641 output.write(indent)
642 output.write('"""')
643 while len(val) > 60:
644 str = val[0:60]
Daniel Veillard01a6d412002-02-11 18:42:20 +0000645 i = string.rfind(str, " ");
646 if i < 0:
647 i = 60
Daniel Veillard1971ee22002-01-31 20:29:19 +0000648 str = val[0:i]
Daniel Veillard01a6d412002-02-11 18:42:20 +0000649 val = val[i:]
650 output.write(str)
651 output.write('\n ');
652 output.write(indent)
Daniel Veillard1971ee22002-01-31 20:29:19 +0000653 output.write(val);
654 output.write('"""\n')
655
Daniel Veillard0fea6f42002-02-22 22:51:13 +0000656def buildWrappers():
657 global ctypes
658 global py_types
659 global py_return_types
660 global unknown_types
661 global functions
662 global function_classes
663 global classes_type
664 global classes_list
665 global converter_type
666 global primary_classes
667 global converter_type
668 global classes_ancestor
669 global converter_type
670 global primary_classes
671 global classes_ancestor
672 global classes_destructors
Daniel Veillard36eea2d2002-02-04 00:17:01 +0000673
Daniel Veillard0fea6f42002-02-22 22:51:13 +0000674 for type in classes_type.keys():
675 function_classes[classes_type[type][2]] = []
Daniel Veillard36ed5292002-01-30 23:49:06 +0000676
Daniel Veillard0fea6f42002-02-22 22:51:13 +0000677 #
678 # Build the list of C types to look for ordered to start
679 # with primary classes
680 #
681 ctypes = []
682 classes_list = []
683 ctypes_processed = {}
684 classes_processed = {}
685 for classe in primary_classes:
686 classes_list.append(classe)
687 classes_processed[classe] = ()
688 for type in classes_type.keys():
689 tinfo = classes_type[type]
690 if tinfo[2] == classe:
691 ctypes.append(type)
692 ctypes_processed[type] = ()
693 for type in classes_type.keys():
694 if ctypes_processed.has_key(type):
695 continue
696 tinfo = classes_type[type]
697 if not classes_processed.has_key(tinfo[2]):
698 classes_list.append(tinfo[2])
699 classes_processed[tinfo[2]] = ()
700
701 ctypes.append(type)
702 ctypes_processed[type] = ()
Daniel Veillard36ed5292002-01-30 23:49:06 +0000703
Daniel Veillard0fea6f42002-02-22 22:51:13 +0000704 for name in functions.keys():
705 found = 0;
706 (desc, ret, args, file) = functions[name]
707 for type in ctypes:
708 classe = classes_type[type][2]
709
710 if name[0:3] == "xml" and len(args) >= 1 and args[0][1] == type:
711 found = 1
712 func = nameFixup(name, classe, type, file)
713 info = (0, func, name, ret, args, file)
714 function_classes[classe].append(info)
715 elif name[0:3] == "xml" and len(args) >= 2 and args[1][1] == type:
716 found = 1
717 func = nameFixup(name, classe, type, file)
718 info = (1, func, name, ret, args, file)
719 function_classes[classe].append(info)
720 elif name[0:4] == "html" and len(args) >= 1 and args[0][1] == type:
721 found = 1
722 func = nameFixup(name, classe, type, file)
723 info = (0, func, name, ret, args, file)
724 function_classes[classe].append(info)
725 elif name[0:4] == "html" and len(args) >= 2 and args[1][1] == type:
726 found = 1
727 func = nameFixup(name, classe, type, file)
728 info = (1, func, name, ret, args, file)
729 function_classes[classe].append(info)
730 if found == 1:
731 break
732 if found == 1:
733 continue
734 if name[0:8] == "xmlXPath":
735 continue
736 if name[0:6] == "xmlStr":
737 continue
738 if name[0:10] == "xmlCharStr":
739 continue
740 func = nameFixup(name, "None", file, file)
741 info = (0, func, name, ret, args, file)
742 function_classes['None'].append(info)
743
744 classes = open("libxml2class.py", "w")
745 txt = open("libxml2class.txt", "w")
746 txt.write(" Generated Classes for libxml2-python\n\n")
747
748 txt.write("#\n# Global functions of the module\n#\n\n")
749 if function_classes.has_key("None"):
750 flist = function_classes["None"]
751 flist.sort(functionCompare)
752 oldfile = ""
753 for info in flist:
754 (index, func, name, ret, args, file) = info
755 if file != oldfile:
756 classes.write("#\n# Functions from module %s\n#\n\n" % file)
757 txt.write("\n# functions from module %s\n" % file)
758 oldfile = file
759 classes.write("def %s(" % func)
760 txt.write("%s()\n" % func);
761 n = 0
762 for arg in args:
763 if n != 0:
764 classes.write(", ")
765 classes.write("%s" % arg[0])
766 n = n + 1
767 classes.write("):\n")
768 writeDoc(name, args, ' ', classes);
769
770 for arg in args:
771 if classes_type.has_key(arg[1]):
772 classes.write(" if %s == None: %s__o = None\n" %
773 (arg[0], arg[0]))
774 classes.write(" else: %s__o = %s%s\n" %
775 (arg[0], arg[0], classes_type[arg[1]][0]))
776 if ret[0] != "void":
777 classes.write(" ret = ");
778 else:
779 classes.write(" ");
780 classes.write("libxml2mod.%s(" % name)
781 n = 0
782 for arg in args:
783 if n != 0:
784 classes.write(", ");
785 classes.write("%s" % arg[0])
786 if classes_type.has_key(arg[1]):
787 classes.write("__o");
788 n = n + 1
789 classes.write(")\n");
790 if ret[0] != "void":
791 if classes_type.has_key(ret[0]):
792 classes.write(" if ret == None: return None\n");
793 classes.write(" return ");
794 classes.write(classes_type[ret[0]][1] % ("ret"));
795 classes.write("\n");
796 else:
797 classes.write(" return ret\n");
798 classes.write("\n");
799
800 txt.write("\n\n#\n# Set of classes of the module\n#\n\n")
801 for classname in classes_list:
802 if classname == "None":
803 pass
804 else:
805 if classes_ancestor.has_key(classname):
806 txt.write("\n\nClass %s(%s)\n" % (classname,
807 classes_ancestor[classname]))
808 classes.write("class %s(%s):\n" % (classname,
809 classes_ancestor[classname]))
810 classes.write(" def __init__(self, _obj=None):\n")
811 classes.write(" self._o = None\n")
812 classes.write(" %s.__init__(self, _obj=_obj)\n\n" % (
813 classes_ancestor[classname]))
814 if classes_ancestor[classname] == "xmlCore" or \
815 classes_ancestor[classname] == "xmlNode":
816 classes.write(" def __repr__(self):\n")
817 format = "%s:%%s" % (classname)
818 classes.write(" return \"%s\" %% (self.name)\n\n" % (
819 format))
820 else:
821 txt.write("Class %s()\n" % (classname))
822 classes.write("class %s:\n" % (classname))
823 classes.write(" def __init__(self, _obj=None):\n")
824 classes.write(" if _obj != None:self._o = _obj;return\n")
825 classes.write(" self._o = None\n\n");
826 if classes_destructors.has_key(classname):
827 classes.write(" def __del__(self):\n")
828 classes.write(" if self._o != None:\n")
829 classes.write(" libxml2mod.%s(self._o)\n" %
830 classes_destructors[classname]);
831 classes.write(" self._o = None\n\n");
832 flist = function_classes[classname]
833 flist.sort(functionCompare)
834 oldfile = ""
835 for info in flist:
836 (index, func, name, ret, args, file) = info
837 if file != oldfile:
838 if file == "python_accessor":
839 classes.write(" # accessors for %s\n" % (classname))
840 txt.write(" # accessors\n")
841 else:
842 classes.write(" #\n")
843 classes.write(" # %s functions from module %s\n" % (
844 classname, file))
845 txt.write("\n # functions from module %s\n" % file)
846 classes.write(" #\n\n")
847 oldfile = file
848 classes.write(" def %s(self" % func)
849 txt.write(" %s()\n" % func);
850 n = 0
851 for arg in args:
852 if n != index:
853 classes.write(", %s" % arg[0])
854 n = n + 1
855 classes.write("):\n")
856 writeDoc(name, args, ' ', classes);
857 n = 0
858 for arg in args:
859 if classes_type.has_key(arg[1]):
860 if n != index:
861 classes.write(" if %s == None: %s__o = None\n" %
862 (arg[0], arg[0]))
863 classes.write(" else: %s__o = %s%s\n" %
864 (arg[0], arg[0], classes_type[arg[1]][0]))
865 n = n + 1
866 if ret[0] != "void":
867 classes.write(" ret = ");
868 else:
869 classes.write(" ");
870 classes.write("libxml2mod.%s(" % name)
871 n = 0
872 for arg in args:
873 if n != 0:
874 classes.write(", ");
875 if n != index:
876 classes.write("%s" % arg[0])
877 if classes_type.has_key(arg[1]):
878 classes.write("__o");
879 else:
880 classes.write("self");
881 if classes_type.has_key(arg[1]):
882 classes.write(classes_type[arg[1]][0])
883 n = n + 1
884 classes.write(")\n");
885 if ret[0] != "void":
886 if classes_type.has_key(ret[0]):
887 classes.write(" if ret == None: return None\n");
888 classes.write(" return ");
889 classes.write(classes_type[ret[0]][1] % ("ret"));
890 classes.write("\n");
891 elif converter_type.has_key(ret[0]):
892 classes.write(" if ret == None: return None\n");
893 classes.write(" return ");
894 classes.write(converter_type[ret[0]] % ("ret"));
895 classes.write("\n");
896 else:
897 classes.write(" return ret\n");
898 classes.write("\n");
899
900 txt.close()
901 classes.close()
902
903
904buildStubs()
905buildWrappers()