[Sugar-devel] [PATCH sugar-toolkit-gtk3] sugar-activity: import and make independent of sugar-toolkit GTK versions

Daniel Drake dsd at laptop.org
Tue Dec 13 14:47:33 EST 2011


As we move to adding support for a second UI toolkit (GTK+ 3.x),
the sugar-activity binary used by all activities must become
backend-toolkit-independent. It would be wasteful to have two backend
toolkits loaded in memory, and in the GTK2/GTK3 case, it is impossible
(importing both results in an instant crash).

To achieve this, we split the existing sugar-toolkit activity/main.py:main()
functionality into two parts, moving it into the sugar-activity binary and
the Activity class as follows:
 1. All toolkit-specific stuff is moved into the Activity class (i.e.
   everything that interacts with GTK)
 2. Everything that can be reasonably/easily moved into the Activity class
   is also moved.
 3. What remains is the stuff that is inherently involved with the
   construction of the Activity object, not related to UI toolkits. This
   is moved into the sugar-activity binary.

main.py is then removed from sugar-toolkit, and sugar-activity is moved
from sugar to sugar-toolkit-gtk3 in order to keep toolkit-related code
with the toolkit itself.

With this work done, the one remaining question is how to invoke the main
loop. An optional run_main_loop() method is added to the activity class,
for GTK2 this will run the GTK2 main loop, for GTK3 the GTK3 main loop will
be run, etc.

Signed-off-by: Daniel Drake <dsd at laptop.org>
---
 Makefile.am                     |    2 +-
 bin/Makefile.am                 |    1 +
 bin/sugar-activity              |  147 +++++++++++++++++++++++++++++++++++
 configure.ac                    |    1 +
 src/sugar3/activity/Makefile.am |    1 -
 src/sugar3/activity/activity.py |   21 +++++
 src/sugar3/activity/main.py     |  160 ---------------------------------------
 7 files changed, 171 insertions(+), 162 deletions(-)
 create mode 100644 bin/Makefile.am
 create mode 100644 bin/sugar-activity
 delete mode 100644 src/sugar3/activity/main.py

Replaces the earlier sugar patch:
 [PATCH] sugar-activity: make independent of sugar-toolkit GTK versions

sugar-activity is now moved into sugar-toolkit-gtk3
A followup sugar patch will remove sugar-activity from there, and
a followup sugar-toolkit patch will adapt the GTK2 toolkit for the
new behaviour.

diff --git a/Makefile.am b/Makefile.am
index 6359a2b..86a095c 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -11,4 +11,4 @@ EXTRA_DIST =                    \
 	intltool-update.in      \
 	intltool-extract.in
 
-SUBDIRS = src po
+SUBDIRS = bin src po
diff --git a/bin/Makefile.am b/bin/Makefile.am
new file mode 100644
index 0000000..0d78267
--- /dev/null
+++ b/bin/Makefile.am
@@ -0,0 +1 @@
+dist_bin_SCRIPTS = sugar-activity
diff --git a/bin/sugar-activity b/bin/sugar-activity
new file mode 100644
index 0000000..2b1b9b3
--- /dev/null
+++ b/bin/sugar-activity
@@ -0,0 +1,147 @@
+#!/usr/bin/env python
+
+# Copyright (C) 2006-2008, Red Hat, Inc.
+#
+# 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., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+import os
+import sys
+import gettext
+from optparse import OptionParser
+
+import dbus
+import dbus.service
+import dbus.glib
+
+import sugar
+from sugar.activity import activityhandle
+from sugar.bundle.activitybundle import ActivityBundle
+from sugar import logger
+
+
+def create_activity_instance(constructor, handle):
+    activity = constructor(handle)
+    activity.show()
+    return activity
+
+
+def get_single_process_name(bundle_id):
+    return bundle_id
+
+
+def get_single_process_path(bundle_id):
+    return '/' + bundle_id.replace('.', '/')
+
+
+class SingleProcess(dbus.service.Object):
+
+    def __init__(self, name_service, constructor):
+        self.constructor = constructor
+
+        bus = dbus.SessionBus()
+        bus_name = dbus.service.BusName(name_service, bus=bus)
+        object_path = get_single_process_path(name_service)
+        dbus.service.Object.__init__(self, bus_name, object_path)
+
+    @dbus.service.method('org.laptop.SingleProcess', in_signature='a{sv}')
+    def create(self, handle_dict):
+        handle = activityhandle.create_from_dict(handle_dict)
+        create_activity_instance(self.constructor, handle)
+
+def main():
+    parser = OptionParser()
+    parser.add_option('-b', '--bundle-id', dest='bundle_id',
+                      help='identifier of the activity bundle')
+    parser.add_option('-a', '--activity-id', dest='activity_id',
+                      help='identifier of the activity instance')
+    parser.add_option('-o', '--object-id', dest='object_id',
+                      help='identifier of the associated datastore object')
+    parser.add_option('-u', '--uri', dest='uri',
+                      help='URI to load')
+    parser.add_option('-s', '--single-process', dest='single_process',
+                      action='store_true',
+                      help='start all the instances in the same process')
+    parser.add_option('-i', '--invited', dest='invited',
+                      action='store_true', default=False,
+                      help='the activity is being launched for handling an '
+                           'invite from the network')
+    (options, args) = parser.parse_args()
+
+    logger.start()
+
+    if 'SUGAR_BUNDLE_PATH' not in os.environ:
+        print 'SUGAR_BUNDLE_PATH is not defined in the environment.'
+        sys.exit(1)
+
+    if len(args) == 0:
+        print 'A python class must be specified as first argument.'
+        sys.exit(1)
+
+    bundle_path = os.environ['SUGAR_BUNDLE_PATH']
+    sys.path.append(bundle_path)
+
+    bundle = ActivityBundle(bundle_path)
+
+    os.environ['SUGAR_BUNDLE_ID'] = bundle.get_bundle_id()
+    os.environ['SUGAR_BUNDLE_NAME'] = bundle.get_name()
+    os.environ['SUGAR_BUNDLE_VERSION'] = str(bundle.get_activity_version())
+
+    splitted_module = args[0].rsplit('.', 1)
+    module_name = splitted_module[0]
+    class_name = splitted_module[1]
+
+    module = __import__(module_name)
+    for comp in module_name.split('.')[1:]:
+        module = getattr(module, comp)
+
+    activity_constructor = getattr(module, class_name)
+    activity_handle = activityhandle.ActivityHandle(
+            activity_id=options.activity_id,
+            object_id=options.object_id, uri=options.uri,
+            invited=options.invited)
+
+    if options.single_process is True:
+        sessionbus = dbus.SessionBus()
+
+        service_name = get_single_process_name(options.bundle_id)
+        service_path = get_single_process_path(options.bundle_id)
+
+        bus_object = sessionbus.get_object(
+                'org.freedesktop.DBus', '/org/freedesktop/DBus')
+        try:
+            name = bus_object.GetNameOwner(
+                    service_name, dbus_interface='org.freedesktop.DBus')
+        except  dbus.DBusException:
+            name = None
+
+        if not name:
+            SingleProcess(service_name, activity_constructor)
+        else:
+            single_process = sessionbus.get_object(service_name, service_path)
+            single_process.create(activity_handle.get_dict(),
+                                  dbus_interface='org.laptop.SingleProcess')
+
+            print 'Created %s in a single process.' % service_name
+            sys.exit(0)
+
+    if hasattr(module, 'start'):
+        module.start()
+
+    instance = create_activity_instance(activity_constructor, activity_handle)
+
+    if hasattr(instance, 'run_main_loop'):
+        instance.run_main_loop()
+
+main()
diff --git a/configure.ac b/configure.ac
index 91db19a..fa38c66 100644
--- a/configure.ac
+++ b/configure.ac
@@ -39,6 +39,7 @@ GOBJECT_INTROSPECTION_CHECK([1.30.0])
 
 AC_OUTPUT([
 Makefile
+bin/Makefile
 src/Makefile
 src/sugar3/Makefile
 src/sugar3/activity/Makefile
diff --git a/src/sugar3/activity/Makefile.am b/src/sugar3/activity/Makefile.am
index 50e12a5..40701d1 100644
--- a/src/sugar3/activity/Makefile.am
+++ b/src/sugar3/activity/Makefile.am
@@ -7,6 +7,5 @@ sugar_PYTHON =              \
 	activityservice.py      \
 	bundlebuilder.py        \
 	i18n.py			\
-	main.py                 \
 	namingalert.py          \
 	widgets.py
diff --git a/src/sugar3/activity/activity.py b/src/sugar3/activity/activity.py
index f92f261..d6b9590 100644
--- a/src/sugar3/activity/activity.py
+++ b/src/sugar3/activity/activity.py
@@ -71,8 +71,10 @@ from telepathy.interfaces import CHANNEL, \
 from telepathy.constants import CONNECTION_HANDLE_TYPE_CONTACT
 from telepathy.constants import CONNECTION_HANDLE_TYPE_ROOM
 
+import sugar3
 from sugar3 import util
 from sugar3.presence import presenceservice
+from sugar3.activity import i18n
 from sugar3.activity.activityservice import ActivityService
 from sugar3.activity.namingalert import NamingAlert
 from sugar3.graphics import style
@@ -259,6 +261,22 @@ class Activity(Window, Gtk.Container):
             the base class __init()__ before doing Activity specific things.
 
         """
+        # Stuff that needs to be done early
+
+        locale_path = i18n.get_locale_path(self.get_bundle_id())
+        gettext.bindtextdomain(self.get_bundle_id(), locale_path)
+        gettext.bindtextdomain('sugar-toolkit', sugar3.locale_path)
+        gettext.textdomain(self.get_bundle_id())
+
+        icons_path = os.path.join(get_bundle_path(), 'icons')
+        Gtk.IconTheme.get_default().append_search_path(icons_path)
+
+        # This code can be removed when we grow an xsettings daemon (the GTK+
+        # init routines will then automatically figure out the font settings)
+        settings = Gtk.Settings.get_default()
+        settings.set_property('gtk-font-name',
+                              '%s %f' % (style.FONT_FACE, style.FONT_SIZE))
+
         Window.__init__(self)
 
         if 'SUGAR_ACTIVITY_ROOT' in os.environ:
@@ -349,6 +367,9 @@ class Activity(Window, Gtk.Container):
                                            self.__jobject_updated_cb)
         self.set_title(self._jobject.metadata['title'])
 
+    def run_main_loop(self):
+        Gtk.main()
+
     def _initialize_journal_object(self):
         title = _('%s Activity') % get_bundle_name()
         client = GConf.Client.get_default()
diff --git a/src/sugar3/activity/main.py b/src/sugar3/activity/main.py
deleted file mode 100644
index fa84f02..0000000
--- a/src/sugar3/activity/main.py
+++ /dev/null
@@ -1,160 +0,0 @@
-# Copyright (C) 2008 Red Hat, Inc.
-#
-# This library is free software; you can redistribute it and/or
-# modify it under the terms of the GNU Lesser General Public
-# License as published by the Free Software Foundation; either
-# version 2 of the License, or (at your option) any later version.
-#
-# This library 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
-# Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public
-# License along with this library; if not, write to the
-# Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-# Boston, MA 02111-1307, USA.
-
-import os
-import sys
-import gettext
-from optparse import OptionParser
-
-import gtk
-import dbus
-import dbus.service
-import dbus.glib
-
-import sugar
-from sugar3.activity import activityhandle
-from sugar3.activity import i18n
-from sugar3.bundle.activitybundle import ActivityBundle
-from sugar3.graphics import style
-from sugar import logger
-
-
-def create_activity_instance(constructor, handle):
-    activity = constructor(handle)
-    activity.show()
-
-
-def get_single_process_name(bundle_id):
-    return bundle_id
-
-
-def get_single_process_path(bundle_id):
-    return '/' + bundle_id.replace('.', '/')
-
-
-class SingleProcess(dbus.service.Object):
-
-    def __init__(self, name_service, constructor):
-        self.constructor = constructor
-
-        bus = dbus.SessionBus()
-        bus_name = dbus.service.BusName(name_service, bus=bus)
-        object_path = get_single_process_path(name_service)
-        dbus.service.Object.__init__(self, bus_name, object_path)
-
-    @dbus.service.method('org.laptop.SingleProcess', in_signature='a{sv}')
-    def create(self, handle_dict):
-        handle = activityhandle.create_from_dict(handle_dict)
-        create_activity_instance(self.constructor, handle)
-
-
-def main():
-    parser = OptionParser()
-    parser.add_option('-b', '--bundle-id', dest='bundle_id',
-                      help='identifier of the activity bundle')
-    parser.add_option('-a', '--activity-id', dest='activity_id',
-                      help='identifier of the activity instance')
-    parser.add_option('-o', '--object-id', dest='object_id',
-                      help='identifier of the associated datastore object')
-    parser.add_option('-u', '--uri', dest='uri',
-                      help='URI to load')
-    parser.add_option('-s', '--single-process', dest='single_process',
-                      action='store_true',
-                      help='start all the instances in the same process')
-    parser.add_option('-i', '--invited', dest='invited',
-                      action='store_true', default=False,
-                      help='the activity is being launched for handling an '
-                           'invite from the network')
-    (options, args) = parser.parse_args()
-
-    logger.start()
-
-    if 'SUGAR_BUNDLE_PATH' not in os.environ:
-        print 'SUGAR_BUNDLE_PATH is not defined in the environment.'
-        sys.exit(1)
-
-    if len(args) == 0:
-        print 'A python class must be specified as first argument.'
-        sys.exit(1)
-
-    bundle_path = os.environ['SUGAR_BUNDLE_PATH']
-    sys.path.append(bundle_path)
-
-    bundle = ActivityBundle(bundle_path)
-
-    os.environ['SUGAR_BUNDLE_ID'] = bundle.get_bundle_id()
-    os.environ['SUGAR_BUNDLE_NAME'] = bundle.get_name()
-    os.environ['SUGAR_BUNDLE_VERSION'] = str(bundle.get_activity_version())
-
-    gtk.icon_theme_get_default().append_search_path(bundle.get_icons_path())
-
-    # This code can be removed when we grow an xsettings daemon (the GTK+
-    # init routines will then automatically figure out the font settings)
-    settings = gtk.settings_get_default()
-    settings.set_property('gtk-font-name',
-                          '%s %f' % (style.FONT_FACE, style.FONT_SIZE))
-
-    locale_path = i18n.get_locale_path(bundle.get_bundle_id())
-
-    gettext.bindtextdomain(bundle.get_bundle_id(), locale_path)
-    gettext.bindtextdomain('sugar-toolkit', sugar3.locale_path)
-    gettext.textdomain(bundle.get_bundle_id())
-
-    splitted_module = args[0].rsplit('.', 1)
-    module_name = splitted_module[0]
-    class_name = splitted_module[1]
-
-    module = __import__(module_name)
-    for comp in module_name.split('.')[1:]:
-        module = getattr(module, comp)
-
-    activity_constructor = getattr(module, class_name)
-    activity_handle = activityhandle.ActivityHandle(
-            activity_id=options.activity_id,
-            object_id=options.object_id, uri=options.uri,
-            invited=options.invited)
-
-    if options.single_process is True:
-        sessionbus = dbus.SessionBus()
-
-        service_name = get_single_process_name(options.bundle_id)
-        service_path = get_single_process_path(options.bundle_id)
-
-        bus_object = sessionbus.get_object(
-                'org.freedesktop.DBus', '/org/freedesktop/DBus')
-        try:
-            name = bus_object.GetNameOwner(
-                    service_name, dbus_interface='org.freedesktop.DBus')
-        except  dbus.DBusException:
-            name = None
-
-        if not name:
-            SingleProcess(service_name, activity_constructor)
-        else:
-            single_process = sessionbus.get_object(service_name, service_path)
-            single_process.create(activity_handle.get_dict(),
-                                  dbus_interface='org.laptop.SingleProcess')
-
-            print 'Created %s in a single process.' % service_name
-            sys.exit(0)
-
-    if hasattr(module, 'start'):
-        module.start()
-
-    create_activity_instance(activity_constructor, activity_handle)
-
-    gtk.main()
-- 
1.7.7.4



More information about the Sugar-devel mailing list