sbus_codegen revision c2cc119de8eac712c040b3993f41c967ff2278de
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# Stef Walter <stefw@redhat.com>
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# Copyright (C) 2014 Red Hat
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# This program is free software; you can redistribute it and/or modify
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# it under the terms of the GNU General Public License as published by
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# the Free Software Foundation; either version 3 of the License, or
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# (at your option) any later version.
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# This program is distributed in the hope that it will be useful,
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# but WITHOUT ANY WARRANTY; without even the implied warranty of
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# GNU General Public License for more details.
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# You should have received a copy of the GNU General Public License
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# along with this program. If not, see <http://www.gnu.org/licenses/>.
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# Some parser code from GLib
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# Copyright (C) 2008-2011 Red Hat, Inc.
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# This library is free software; you can redistribute it and/or
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# modify it under the terms of the GNU Lesser General Public
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# License as published by the Free Software Foundation; either
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# version 2 of the License, or (at your option) any later version.
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# This library is distributed in the hope that it will be useful,
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# but WITHOUT ANY WARRANTY; without even the implied warranty of
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# Lesser General Public License for more details.
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# You should have received a copy of the GNU Lesser General
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# Public License along with this library; if not, write to the
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# Free Software Foundation, Inc., 59 Temple Place, Suite 330,
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# Boston, MA 02111-1307, USA.
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# Portions by: David Zeuthen <davidz@redhat.com>
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# DBus interfaces are defined here:
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# http://dbus.freedesktop.org/doc/dbus-specification.html#introspection-format
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# The introspection data format has become the standard way to represent a
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# DBus interface. For many examples see /usr/share/dbus-1/interfaces/ on a
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# typical linux machine.
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# A word about annotations. These are extra flags or values that can be
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# assigned to anything. So far, the codegen supports this annotation:
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# - An annotation specified in the specification that tells us what C symbol
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# to generate for a given interface or method. By default the codegen will
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# build up a symbol name from the DBus name.
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# -----------------------------------------------------------------------------
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter # Lets us print problems like a compiler would
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter return "%s:%d: %s" % (self.file, self.line, message)
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter return self.annotations.get("org.freedesktop.DBus.GLib.CSymbol", self.name)
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter return "%s_%s" % (self.iface.c_name(), self.c_name())
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter return "%s_%s" % (self.iface.c_name(), self.c_name())
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter def __init__(self, iface, name, signature, access):
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter raise DBusXmlException('Invalid access type %s'%self.access)
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter return "%s_%s" % (self.iface.c_name(), self.c_name())
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter return self.annotations.get("org.freedesktop.DBus.GLib.CSymbol",
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# -----------------------------------------------------------------------------
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# Code Generation
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter out("/* arguments for %s.%s */", parent.iface.name, parent.name)
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter out("const struct sbus_arg_meta %s%s[] = {", parent.fq_c_name(), suffix)
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter out(" { \"%s\", \"%s\" },", arg.name, arg.signature)
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter out("const struct sbus_method_meta %s__methods[] = {", iface.c_name())
fcd8093c58638dc7c4f9cddfc97f273b94ce2eadStef Walter out(" offsetof(struct %s, %s),", iface.c_name(), meth.c_name())
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter out("const struct sbus_signal_meta %s__signals[] = {", iface.c_name())
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter out("const struct sbus_property_meta %s__properties[] = {", iface.c_name())
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter out(" SBUS_PROPERTY_READABLE | SBUS_PROPERTY_WRITABLE,")
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter out("extern const struct sbus_interface_meta %s_meta;", iface.c_name())
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter out("const struct sbus_interface_meta %s_meta = {", iface.c_name())
fcd8093c58638dc7c4f9cddfc97f273b94ce2eadStef Walterdef generate_source(ifaces, filename, include_header=None):
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter out("/* The following definitions are auto-generated from %s */", basename)
fcd8093c58638dc7c4f9cddfc97f273b94ce2eadStef Walter out("#include \"%s\"", os.path.basename(include_header))
fcd8093c58638dc7c4f9cddfc97f273b94ce2eadStef Walter out(" struct sbus_vtable vtable; /* derive from sbus_vtable */")
fcd8093c58638dc7c4f9cddfc97f273b94ce2eadStef Walter # TODO: Property getters and setters will go here
c2cc119de8eac712c040b3993f41c967ff2278deStef Walter out("#define %s \"%s\"", iface.c_name().upper(), iface.name)
c2cc119de8eac712c040b3993f41c967ff2278deStef Walter out("#define %s \"%s\"", meth.fq_c_name().upper(), meth.name)
c2cc119de8eac712c040b3993f41c967ff2278deStef Walter out("#define %s \"%s\"", sig.fq_c_name().upper(), sig.name)
c2cc119de8eac712c040b3993f41c967ff2278deStef Walter out("#define %s \"%s\"", prop.fq_c_name().upper(), prop.name)
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter guard = "__%s__" % re.sub(r'([^_A-Z0-9])', "_", basename.upper())
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter out("/* The following declarations are auto-generated from %s */", basename)
c2cc119de8eac712c040b3993f41c967ff2278deStef Walter out("/* ------------------------------------------------------------------------")
c2cc119de8eac712c040b3993f41c967ff2278deStef Walter out(" * Various constants of interface and method names mostly for use by clients")
fcd8093c58638dc7c4f9cddfc97f273b94ce2eadStef Walter out("/* ------------------------------------------------------------------------")
fcd8093c58638dc7c4f9cddfc97f273b94ce2eadStef Walter out(" * These structures are filled in by implementors of the different")
fcd8093c58638dc7c4f9cddfc97f273b94ce2eadStef Walter out(" * dbus interfaces to handle method calls.")
fcd8093c58638dc7c4f9cddfc97f273b94ce2eadStef Walter out(" * Handler functions of type sbus_msg_handler_fn accept raw messages,")
fcd8093c58638dc7c4f9cddfc97f273b94ce2eadStef Walter out(" * other handlers will be typed appropriately. If a handler that is")
fcd8093c58638dc7c4f9cddfc97f273b94ce2eadStef Walter out(" * set to NULL is invoked it will result in a")
fcd8093c58638dc7c4f9cddfc97f273b94ce2eadStef Walter out(" * org.freedesktop.DBus.Error.NotSupported error for the caller.")
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter out("/* ------------------------------------------------------------------------")
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter out(" * These structure definitions are filled in with the information about")
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter out(" * the interfaces, methods, properties and so on.")
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter out(" * The actual definitions are found in the accompanying C file next")
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# -----------------------------------------------------------------------------
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter# XML Interface Parsing
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter raise DBusXmlException("Missing attribute '%s'" % name)
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter raise DBusXmlException("Empty attribute '%s'" % name)
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter parser.CharacterDataHandler = self.handle_char_data
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter parser.StartElementHandler = self.handle_start_element
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter parser.EndElementHandler = self.handle_end_element
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter elif self.cur_object and name == STATE_ANNOTATION:
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter self.cur_object.annotations[expect_attr(attrs, 'name')] = val
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter method = Method(self.cur_object, expect_attr(attrs, 'name'))
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter signal = Signal(self.cur_object, expect_attr(attrs, 'name'))
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter raise DBusXmlException('Invalid direction "%s"' % direction)
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter assert False, 'Unhandled state "%s" while entering element with name "%s"' % (self.state, name)
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter parser = optparse.OptionParser("usage: %prog [options] introspect.xml ...")
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter parser.set_description("sbus_codegen generates sbus interface structures \
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter print >> sys.stderr, "sbus_codegen: no input file specified"
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter print >> sys.stderr, "sbus_codegen: specify --mode=header or --mode=source"
b699c4d7f85a5404be1d1ee9450331aea869b886Stef Walter generate_header(parser.parsed_interfaces, filename)