lasso/bindings/php5/wrapper_source.py

469 lines
18 KiB
Python

# Lasso - A free implementation of the Liberty Alliance specifications.
#
# Copyright (C) 2004-2007 Entr'ouvert
# http://lasso.entrouvert.org
#
# Authors: See AUTHORS file in top-level directory.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
import sys
import os
import utils
class WrapperSource:
def __init__(self, binding_data, fd):
self.binding_data = binding_data
self.fd = fd
self.functions_list = []
self.src_dir = os.path.dirname(__file__)
def is_object(self, t):
return t not in ['char*', 'const char*', 'gchar*', 'const gchar*', 'GList*', 'GHashTable*',
'xmlNode*', 'int', 'gint', 'gboolean', 'const gboolean'] + self.binding_data.enums
def generate(self):
self.generate_header()
self.generate_constants()
self.generate_middle()
for m in self.binding_data.functions:
self.generate_function(m)
for c in self.binding_data.structs:
self.generate_members(c)
for m in c.methods:
self.generate_function(m)
self.generate_functions_list()
self.generate_footer()
def generate_header(self):
self.functions_list.append('lasso_get_object_typename')
self.functions_list.append('lasso_init')
self.functions_list.append('lasso_shutdown')
print >> self.fd, '''\
/* this file has been generated automatically; do not edit */
'''
print >> self.fd, open(os.path.join(self.src_dir,'wrapper_source_top.c')).read()
for h in self.binding_data.headers:
print >> self.fd, '#include <%s>' % h
print >> self.fd, ''
print >> self.fd, '''\
PHP_MINIT_FUNCTION(lasso)
{
le_lasso_server = zend_register_list_destructors_ex(php_gobject_generic_destructor, NULL, PHP_LASSO_SERVER_RES_NAME, module_number);
lasso_init();
'''
def generate_constants(self):
print >> self.fd, ' /* Constants (both enums and defines) */'
for c in self.binding_data.constants:
if c[0] == 'i':
print >> self.fd, ' REGISTER_LONG_CONSTANT("%s", %s, CONST_CS|CONST_PERSISTENT);' % (c[1], c[1])
elif c[0] == 's':
print >> self.fd, ' REGISTER_STRING_CONSTANT("%s", %s, CONST_CS|CONST_PERSISTENT);' % (c[1], c[1])
elif c[0] == 'b':
print >> self.fd, '''\
#ifdef %s
REGISTER_LONG_CONSTANT("%s", 1, CONST_CS|CONST_PERSISTENT);
#else
REGISTER_LONG_CONSTANT("%s", 0, CONST_CS|CONST_PERSISTENT);
#endif''' % (c[1], c[1], c[1])
else:
print >> sys.stderr, 'E: unknown constant type: %r' % c[0]
print >> self.fd, ''
def generate_middle(self):
print >> self.fd, '''\
return SUCCESS;
}
PHP_MSHUTDOWN_FUNCTION(lasso)
{
lasso_shutdown();
return SUCCESS;
}
'''
def return_value(self, vtype, options, free = False):
if vtype is None:
return
elif vtype == 'gboolean':
print >> self.fd, ' RETVAL_BOOL(return_c_value);'
elif vtype in ['int', 'gint'] + self.binding_data.enums:
print >> self.fd, ' RETVAL_LONG(return_c_value);'
elif vtype in ('char*', 'gchar*'):
print >> self.fd, '''\
if (return_c_value) {
RETVAL_STRING(return_c_value, 1);
} else {
RETVAL_NULL();
}'''
if free:
print >> self.fd, ' free(return_c_value);'
elif vtype in ('const char*', 'const gchar*'):
print >> self.fd, '''\
if (return_c_value) {
RETVAL_STRING((char*)return_c_value, 1);
} else {
RETVAL_NULL();
}'''
elif vtype == 'xmlNode*':
print >> self.fd, '''\
{
char* xmlString = get_string_from_xml_node(return_c_value);
if (xmlString) {
RETVAL_STRING(xmlString, 0);
} else {
RETVAL_NULL();
}
}
'''
elif vtype == 'GList*':
if options.get('elem_type') == 'char*':
print >> self.fd, '''\
set_array_from_list_of_strings(return_c_value, &return_value);
'''
if free:
print >> self.fd, ' free_glist(&return_c_value, (GFunc)free);'
elif options.get('elem_type') == 'xmlNode*':
print >> self.fd, '''\
set_array_from_list_of_xmlnodes(return_c_value, &return_value);
'''
if free:
print >> self.fd, ' free_glist(&return_c_value, (GFunc)efree);'
else:
print >> self.fd, '''\
set_array_from_list_of_objects(return_c_value, &return_value);
'''
if free:
print >> self.fd, ' free_glist(&return_c_value, NULL);'
elif vtype == 'GHashTable*':
if options.get('elem_type') not in ('char*', 'xmlNode*'):
print >> self.fd, '''\
set_array_from_hashtable_of_objects(return_c_value, &return_value);
'''
else:
print >> self.fd, '''\
if (return_c_value) {
self = PhpGObjectPtr_New(G_OBJECT(return_c_value));
ZEND_REGISTER_RESOURCE(return_value, self, le_lasso_server);
} else {
RETVAL_NULL();
}'''
if free:
print >> self.fd, ' if (return_c_value) {'
print >> self.fd, ' g_object_unref(return_c_value); // If constructor ref is off by one'
print >> self.fd, ' }'
def generate_function(self, m):
if m.name in ('lasso_init','lasso_shutdown'):
return
if m.rename:
name = m.rename
else:
name = m.name
self.functions_list.append(name)
print >> self.fd, '''PHP_FUNCTION(%s)
{''' % name
parse_tuple_format = []
parse_tuple_args = []
for arg in m.args:
arg_type, arg_name, arg_options = arg
if arg_type in ('char*', 'const char*', 'gchar*', 'const gchar*'):
arg_type = arg_type.replace('const ', '')
parse_tuple_format.append('s!')
parse_tuple_args.append('&%s_str, &%s_len' % (arg_name, arg_name))
print >> self.fd, ' %s %s = NULL;' % ('char*', arg_name)
print >> self.fd, ' %s %s_str = NULL;' % ('char*', arg_name)
print >> self.fd, ' %s %s_len = 0;' % ('int', arg_name)
elif arg_type in ['int', 'gint', 'gboolean', 'const gboolean'] + self.binding_data.enums:
parse_tuple_format.append('l')
parse_tuple_args.append('&%s' % arg_name)
print >> self.fd, ' %s %s;' % ('long', arg_name)
elif arg_type == 'GList*':
parse_tuple_format.append('a!')
parse_tuple_args.append('&zval_%s' % arg_name)
print >> self.fd, ' %s zval_%s = NULL;' % ('zval*', arg_name)
print >> self.fd, ' %s %s = NULL;' % ('GList*', arg_name)
else:
parse_tuple_format.append('r')
parse_tuple_args.append('&zval_%s' % arg_name)
print >> self.fd, ' %s %s = NULL;' % (arg_type, arg_name)
print >> self.fd, ' %s zval_%s = NULL;' % ('zval*', arg_name)
print >> self.fd, ' %s cvt_%s = NULL;' % ('PhpGObjectPtr*', arg_name)
if m.return_type:
print >> self.fd, ' %s return_c_value;' % m.return_type
if m.return_type is not None and self.is_object(m.return_type):
print >> self.fd, ' PhpGObjectPtr *self;'
print >> self.fd, ''
parse_tuple_args = ', '.join(parse_tuple_args)
if parse_tuple_args:
parse_tuple_args = ', ' + parse_tuple_args
print >> self.fd, '''\
if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "%s"%s) == FAILURE) {
RETURN_FALSE;
}
''' % (''.join(parse_tuple_format), parse_tuple_args)
for f, arg in zip(parse_tuple_format, m.args):
if f.startswith('s'):
print >> self.fd, '''\
%(name)s = %(name)s_str;''' % {'name': arg[1]}
elif f.startswith('r'):
print >> self.fd, ' ZEND_FETCH_RESOURCE(cvt_%s, PhpGObjectPtr *, &zval_%s, -1, PHP_LASSO_SERVER_RES_NAME, le_lasso_server);' % (arg[1], arg[1])
print >> self.fd, ' %s = (%s)cvt_%s->obj;' % (arg[1], arg[0], arg[1])
elif f.startswith('a'):
elem_type = arg[2].get('elem_type')
if elem_type == 'char*':
print >> self.fd, ' %(name)s = get_list_from_array_of_strings(zval_%(name)s);' % {'name': arg[1]}
else:
print >> sys.stderr, 'E: In %(function)s arg %(name)s is of type GList<%(elem)s>' % { 'function': m.name, 'name': arg[1], 'elem': elem_type }
elif f == 'l':
pass
else:
raise Exception('%s format inconnu' % f)
if m.return_type is not None:
print >> self.fd, ' return_c_value = ',
if 'new' in m.name:
print >> self.fd, '(%s)' % m.return_type,
else:
print >> self.fd, ' ',
print >> self.fd, '%s(%s);' % (m.name, ', '.join([x[1] for x in m.args]))
# Free the converted arguments
for f, arg in zip(parse_tuple_format, m.args):
if f.startswith('a'):
elem_type = arg[2].get('elem_type')
if elem_type == 'char*':
print >> self.fd, ' if (%(name)s) {' % { 'name': arg[1] }
print >> self.fd, ' free_glist(&%(name)s,(GFunc)free);' % { 'name': arg[1] }
print >> self.fd, ' }'
self.return_value(m.return_type, {}, m.return_owner)
print >> self.fd, '}'
print >> self.fd, ''
def generate_members(self, c):
for m_type, m_name, m_options in c.members:
self.generate_getter(c.name, m_type, m_name, m_options)
self.generate_setter(c.name, m_type, m_name, m_options)
def generate_getter(self, klassname, m_type, m_name, m_options):
if m_type == 'GList*' and m_options.get('elem_type') not in ('char*', 'xmlNode*') \
and not self.is_object(m_options.get('elem_type')):
print >> sys.stderr, 'E: GList argument : %s of %s, with type : %s' % (m_name, klassname, m_options.get('elem_type'))
return
function_name = '%s_%s_get' % (klassname, utils.format_as_camelcase(m_name))
print >> self.fd, '''PHP_FUNCTION(%s)
{''' % function_name
self.functions_list.append(function_name)
if self.is_object(m_type):
print >> self.fd, ' %s return_c_value = NULL;' % m_type
else:
print >> self.fd, ' %s return_c_value;' % m_type
print >> self.fd, ' %s* this;' % klassname
print >> self.fd, ' zval* zval_this;'
print >> self.fd, ' PhpGObjectPtr *cvt_this;'
if self.is_object(m_type):
print >> self.fd, ' PhpGObjectPtr *self;'
print >> self.fd, ''
print >> self.fd, '''\
if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "r", &zval_this) == FAILURE) {
RETURN_FALSE;
}
ZEND_FETCH_RESOURCE(cvt_this, PhpGObjectPtr *, &zval_this, -1, PHP_LASSO_SERVER_RES_NAME, le_lasso_server);
this = (%s*)cvt_this->obj;
''' % (klassname)
if self.is_object(m_type):
print >> self.fd, ' if (this->%s != NULL) {' % m_name
print >> self.fd, ' return_c_value = this->%s;' % m_name
print >> self.fd, ' }'
else:
print >> self.fd, ' return_c_value = this->%s;' % m_name
self.return_value(m_type, m_options)
print >> self.fd, '}'
print >> self.fd, ''
def generate_setter(self, klassname, m_type, m_name, m_options):
if m_type == 'GList*' and m_options.get('elem_type') not in ('char*', 'xmlNode*') \
and not self.is_object(m_options.get('elem_type')):
print >> sys.stderr, 'E: GList argument : %s of %s, with type : %s' % (m_name, klassname, m_options.get('elem_type'))
return
function_name = '%s_%s_set' % (klassname, utils.format_as_camelcase(m_name))
print >> self.fd, '''PHP_FUNCTION(%s)
{''' % function_name
self.functions_list.append(function_name)
print >> self.fd, ' %s* this;' % klassname
print >> self.fd, ' zval* zval_this;'
print >> self.fd, ' PhpGObjectPtr *cvt_this;'
# FIXME: This bloc should be factorised
parse_tuple_format = ''
parse_tuple_args = []
arg_type = m_type
arg_name = m_name
arg_options = m_options
if arg_type in ('char*', 'const char*', 'gchar*', 'const gchar*', 'xmlNode*'):
arg_type = arg_type.replace('const ', '')
parse_tuple_format += 's'
parse_tuple_args.append('&%s_str, &%s_len' % (arg_name, arg_name))
print >> self.fd, ' %s %s_str = NULL;' % ('char*', arg_name)
print >> self.fd, ' %s %s_len = 0;' % ('int', arg_name)
elif arg_type in ['int', 'gint', 'gboolean', 'const gboolean'] + self.binding_data.enums:
parse_tuple_format += 'l'
parse_tuple_args.append('&%s' % arg_name)
print >> self.fd, ' %s %s;' % ('long', arg_name)
# Must also handle lists of Objects
elif arg_type in ('GList*', 'GHashTable*'):
parse_tuple_format += 'a'
parse_tuple_args.append('&zval_%s' % arg_name)
print >> self.fd, ' %s zval_%s;' % ('zval*', arg_name)
else:
parse_tuple_format += 'r'
parse_tuple_args.append('&zval_%s' % arg_name)
print >> self.fd, ' %s zval_%s = NULL;' % ('zval*', arg_name)
print >> self.fd, ' %s cvt_%s = NULL;' % ('PhpGObjectPtr*', arg_name)
if parse_tuple_args:
parse_tuple_arg = parse_tuple_args[0]
else:
print >> self.fd, '}'
print >> self.fd, ''
return
print >> self.fd, ''
print >> self.fd, '''\
if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "r%s", &zval_this, %s) == FAILURE) {
return;
}
''' % (parse_tuple_format, parse_tuple_arg)
# Get 'this' object
print >> self.fd, '''\
ZEND_FETCH_RESOURCE(cvt_this, PhpGObjectPtr *, &zval_this, -1, PHP_LASSO_SERVER_RES_NAME, le_lasso_server);
this = (%s*)cvt_this->obj;
''' % klassname
# Set new value
if parse_tuple_format == 'l':
print >> self.fd, ' this->%s = %s;' % (m_name, m_name)
elif parse_tuple_format == 's':
print >> self.fd, ' if (this->%s) {' % m_name
print >> self.fd, ' g_free(this->%s);' % m_name
print >> self.fd, ' }'
print >> self.fd, ' if (%s_str && strcmp(%s_str, "") != 0) {' % (m_name, m_name)
if arg_type == 'xmlNode*':
print >> self.fd, ' this->%s = get_xml_node_from_string(%s_str);' % (m_name, m_name)
else:
print >> self.fd, ' this->%s = g_strndup(%s_str, %s_len);' % (m_name, m_name, m_name)
print >> self.fd, ' } else {'
print >> self.fd, ' this->%s = NULL;' % m_name
print >> self.fd, ' }'
elif arg_type == 'GList*':
if m_options.get('elem_type') == 'char*':
print >> self.fd, '''
if (this->%(name)s) {
/* free existing list */
g_list_foreach(this->%(name)s, (GFunc)g_free, NULL);
g_list_free(this->%(name)s);
}
this->%(name)s = get_list_from_array_of_strings(zval_%(name)s);
''' % { 'name': m_name }
elif m_options.get('elem_type') == 'xmlNode*':
print >> self.fd, '''
if (this->%(name)s) {
/* free existing list */
g_list_foreach(this->%(name)s, (GFunc)xmlFreeNode, NULL);
g_list_free(this->%(name)s);
}
this->%(name)s = get_list_from_array_of_xmlnodes(zval_%(name)s);
''' % { 'name': m_name }
else:
print >> self.fd, '''
free_glist(&this->%(name)s, (GFunc)g_object_unref);
this->%(name)s = get_list_from_array_of_objects(zval_%(name)s);
''' % { 'name': m_name }
elif arg_type == 'GHashTable*' and arg_options.get('elem_type') != 'char*':
print >> self.fd, '''\
{
GHashTable *oldhash = this->%(name)s;
this->%(name)s = get_hashtable_from_array_of_objects(zval_%(name)s);
g_hash_table_destroy(oldhash);
}
''' % { 'name': m_name }
elif parse_tuple_format == 'r':
print >> self.fd, ' ZEND_FETCH_RESOURCE(cvt_%s, PhpGObjectPtr*, &zval_%s, -1, PHP_LASSO_SERVER_RES_NAME, le_lasso_server);' % (m_name, m_name)
print >> self.fd, '''
g_object_ref(cvt_%(name)s->obj);
if (this->%(name)s)
g_object_unref(this->%(name)s);
this->%(name)s = (%(type)s)cvt_%(name)s->obj;
''' % { 'name': m_name, 'type': m_type }
print >> self.fd, '}'
print >> self.fd, ''
def generate_functions_list(self):
print >> self.fd, '''\
static function_entry lasso_functions[] = {'''
for m in self.functions_list:
print >> self.fd, ' PHP_FE(%s, NULL)' % m
print >> self.fd, '''\
{NULL, NULL, NULL}
};
'''
def generate_footer(self):
print >> self.fd, '''\
zend_module_entry lasso_module_entry = {
#if ZEND_MODULE_API_NO >= 20010901
STANDARD_MODULE_HEADER,
#endif
PHP_LASSO_EXTNAME,
lasso_functions,
PHP_MINIT(lasso),
PHP_MSHUTDOWN(lasso),
NULL,
NULL,
NULL,
#if ZEND_MODULE_API_NO >= 20010901
PHP_LASSO_VERSION,
#endif
STANDARD_MODULE_PROPERTIES
};
'''