Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
path: root/tutorius/creator.py
blob: 68c5fa63c90a5375c9cefe1cefb59372fd9e881c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
"""
This package contains UI classes related to tutorial authoring.
This includes visual display of tools to edit and create tutorials from within
the activity itself.
"""
# Copyright (C) 2009, Tutorius.org
# Copyright (C) 2009, Simon Poirier <simpoir@gmail.com>
#
#
# 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 1 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 gtk.gdk
import gtk.glade
import gobject
from gettext import gettext as T

import uuid
import os
from sugar.graphics import icon, style

from . import overlayer, gtkutils, actions, vault, properties, addon
from . import filters
from .services import ObjectStore
from .core import State
from .tutorial import Tutorial
from . import viewer
from .propwidgets import TextInputDialog, StringPropWidget

class Creator(object):
    """
    Class acting as a bridge between the creator, serialization and core
    classes. This contains most of the UI part of the editor.
    """
    def __init__(self, activity, tutorial=None):
        """
        Instanciate a tutorial creator for the activity.

        @param activity to bind the creator to
        @param tutorial an existing tutorial to edit, or None to create one
        """
        self._activity = activity
        if not tutorial:
            self._tutorial = Tutorial('Untitled')
            self._state = self._tutorial.add_state()
            self._tutorial.update_transition(
                transition_name=self._tutorial.INITIAL_TRANSITION_NAME,
                new_state=self._state)
        else:
            self._tutorial = tutorial
            # TODO load existing tutorial; unused yet

        self._action_panel = None
        self._current_filter = None
        self._intro_mask = None
        self._intro_handle = None
        allocation = self._activity.get_allocation()
        self._width = allocation.width
        self._height = allocation.height
        self._selected_widget = None
        self._eventmenu = None
        self.tuto = None
        self._guid = None

        self._hlmask = overlayer.Rectangle(None, (1.0, 0.0, 0.0, 0.5))
        self._activity._overlayer.put(self._hlmask, 0, 0)

        dlg_width = 300
        dlg_height = 70
        sw = gtk.gdk.screen_width()
        sh = gtk.gdk.screen_height()

        self._propedit = ToolBox(self._activity)
        self._propedit.tree.signal_autoconnect({
            'on_quit_clicked': self._cleanup_cb,
            'on_save_clicked': self.save,
            'on_action_activate': self._add_action_cb,
            'on_event_activate': self._add_event_cb,
        })
        self._propedit.window.move(
            gtk.gdk.screen_width()-self._propedit.window.get_allocation().width,
            100)


        self._overview = viewer.Viewer(self._tutorial, self)
        self._overview.win.set_transient_for(self._activity)

        self._overview.win.move(0, gtk.gdk.screen_height()- \
                                self._overview.win.get_allocation().height)

        self._transitions = dict()

    def _update_next_state(self, state, event, next_state):
        self._transitions[event] = next_state

        evts = state.get_event_filter_list()
        state.clear_event_filters()
        for evt, next_state in evts:
            state.add_event_filter(evt, self._transitions[evt])

    def delete_action(self, action):
        """
        Removes the first instance of specified action from the tutorial.

        @param action: the action name
        @returns: True if successful, otherwise False.
        """
        action_obj = self._tutorial.get_action_dict(self._state)\
                .get(action, None)
        if not action_obj:
            return False
        action_obj.exit_editmode()
        self._tutorial.delete_action(action)
        self._overview.win.queue_draw()
        return True

    def delete_state(self):
        """
        Remove current state.
        Limitation: The last state cannot be removed, as it doesn't have
                    any transitions to remove anyway.

        @returns: True if successful, otherwise False.
        """
        if self._state in (self._tutorial.INIT, self._tutorial.END):
            # last state cannot be removed
            return False

        remove_state = self._state
        next_state = self._tutorial\
                .get_following_states_dict(remove_state).keys()[0]
        self.set_insertion_point(next_state)
        return bool(self._tutorial.delete_state(remove_state))

    def get_insertion_point(self):
        return self._state

    def set_insertion_point(self, state_name):
        for action in self._tutorial.get_action_dict(self._state).values():
            action.exit_editmode()

        self._state = state_name
        state_actions = self._tutorial.get_action_dict(self._state).values()
        for action in state_actions:
            action.enter_editmode()
            action._drag._eventbox.connect_after(
                "button-release-event", self._action_refresh_cb, action)

        if state_actions:
            self._propedit.action = state_actions[0]
        else:
            self._propedit.action = None

        self._overview.win.queue_draw()


    def _evfilt_cb(self, menuitem, event):
        """
        This will get called once the user has selected a menu item from the
        event filter popup menu. This should add the correct event filter
        to the FSM and increment states.
        """
        # undo actions so they don't persist through step editing
        for action in self._state.get_action_list():
            action.exit_editmode()
        self._hlmask.covered = None
        self._propedit.action = None
        self._activity.queue_draw()

    def _intro_cb(self, widget, evt):
        """
        Callback for capture of widget events, when in introspect mode.
        """
        if evt.type == gtk.gdk.BUTTON_PRESS:
            # widget has focus, let's hilight it
            win = gtk.gdk.display_get_default().get_window_at_pointer()
            click_wdg = win[0].get_user_data()
            if not click_wdg.is_ancestor(self._activity._overlayer):
                # as popups are not (yet) supported, it would break
                # badly if we were to play with a widget not in the
                # hierarchy.
                return
            for hole in self._intro_mask.pass_thru:
                self._intro_mask.mask(hole)
            self._intro_mask.unmask(click_wdg)
            self._selected_widget = gtkutils.raddr_lookup(click_wdg)

            if self._eventmenu:
                self._eventmenu.destroy()
            self._eventmenu = gtk.Menu()
            menuitem = gtk.MenuItem(label=type(click_wdg).__name__)
            menuitem.set_sensitive(False)
            self._eventmenu.append(menuitem)
            self._eventmenu.append(gtk.MenuItem())

            for item in gobject.signal_list_names(click_wdg):
                menuitem = gtk.MenuItem(label=item)
                menuitem.connect("activate", self._evfilt_cb, item)
                self._eventmenu.append(menuitem)
            self._eventmenu.show_all()
            self._eventmenu.popup(None, None, None, evt.button, evt.time)
            self._activity.queue_draw()

    def _add_action_cb(self, widget, path):
        """Callback for the action creation toolbar tool"""
        action_type = self._propedit.actions_list[path][ToolBox.ICON_NAME]
        action = addon.create(action_type)
        action.enter_editmode()
        self._tutorial.add_action(self._state, action)
        # FIXME: replace following with event catching
        action._drag._eventbox.connect_after(
            "button-release-event", self._action_refresh_cb, action)
        self._overview.win.queue_draw()

    def _add_event_cb(self, widget, path):
        """Callback for the event creation toolbar tool"""
        event_type = self._propedit.events_list[path][ToolBox.ICON_NAME]
        event = addon.create(event_type)
        addonname = type(event).__name__
        meta = addon.get_addon_meta(addonname)
        for propname in meta['mandatory_props']:
            prop = getattr(type(event), propname)
            prop.widget_class.run_dialog(self._activity, event, propname)

        event_filters = self._tutorial.get_transition_dict(self._state)

        # if not at the end of tutorial
        if event_filters:
            old_transition = event_filters.keys()[0]
            new_state = self._tutorial.add_state(event_filters[old_transition])
            self._tutorial.update_transition(transition_name=old_transition,
                                             new_state=new_state)

        else:
            # append empty state only if edit inserting at end of linearized
            # tutorial.
            new_state = self._tutorial.add_state()
            self._tutorial.add_transition(self._state, (event, new_state))

        self._overview.win.queue_draw()

        self.set_insertion_point(new_state)

    def _action_refresh_cb(self, widget, evt, action):
        """
        Callback for refreshing properties values and notifying the 
        property dialog of the new values.
        """
        action.exit_editmode()
        action.enter_editmode()
        self._activity.queue_draw()
        # TODO: replace following with event catching
        action._drag._eventbox.connect_after(
            "button-release-event", self._action_refresh_cb, action)
        self._propedit.action = action

        self._overview.win.queue_draw()

    def _cleanup_cb(self, *args, **kwargs):
        """
        Quit editing and cleanup interface artifacts.

        @param force: force quitting without saving.
        """
        # undo actions so they don't persist through step editing
        for action in self._tutorial.get_action_dict(self._state).values():
            action.exit_editmode()

        if kwargs.get('force', False):
            dialog = gtk.MessageDialog(
                parent=self._activity,
                flags=gtk.DIALOG_MODAL,
                type=gtk.MESSAGE_QUESTION,
                buttons=gtk.BUTTONS_YES_NO,
                message_format=T('Do you want to save before stopping edition?'))
            do_save = dialog.run()
            dialog.destroy()
            if do_save == gtk.RESPONSE_YES:
                self.save()

        # remove UI remains
        self._hlmask.covered = None
        self._activity._overlayer.remove(self._hlmask)
        self._hlmask.destroy()
        self._hlmask = None
        self._propedit.destroy()
        self._overview.destroy()
        self._activity.queue_draw()
        del self._activity._creator

    def save(self, widget=None):
        if not self._guid:
            self._guid = str(uuid.uuid1())
            dlg = TextInputDialog(parent=self._overview.win,
                                  text=T("Enter a tutorial title."),
                                  field=T("Title"))
            tutorialName = ""
            while not tutorialName: tutorialName = dlg.pop()
            dlg.destroy()
            self._metadata = {
                vault.INI_GUID_PROPERTY: self._guid,
                vault.INI_NAME_PROPERTY: tutorialName,
                vault.INI_VERSION_PROPERTY: '1',
                'activities':{os.environ['SUGAR_BUNDLE_NAME']:
                              os.environ['SUGAR_BUNDLE_VERSION']
                             },
            }

        vault.Vault.saveTutorial(self._tutorial, self._metadata)


    def launch(*args, **kwargs):
        """
        Launch and attach a creator to the currently running activity.
        """
        activity = ObjectStore().activity
        if not hasattr(activity, "_creator"):
            activity._creator = Creator(activity)
    launch = staticmethod(launch)

class ToolBox(object):
    ICON_LABEL = 0
    ICON_IMAGE = 1
    ICON_NAME  = 2
    ICON_TIP   = 3
    def __init__(self, parent):
        super(ToolBox, self).__init__()
        self.__parent = parent
        sugar_prefix = os.getenv("SUGAR_PREFIX",default="/usr")
        glade_file = os.path.join(sugar_prefix, 'share', 'tutorius',
                                  'ui', 'creator.glade')
        self.tree = gtk.glade.XML(glade_file)
        self.window = self.tree.get_widget('mainwindow')
        self._propbox = self.tree.get_widget('propbox')
        self._propedits = []

        self.window.set_transient_for(parent)

        self._action = None
        self.actions_list = gtk.ListStore(str, gtk.gdk.Pixbuf, str, str)
        self.actions_list.set_sort_column_id(self.ICON_LABEL, gtk.SORT_ASCENDING)
        self.events_list = gtk.ListStore(str, gtk.gdk.Pixbuf, str, str)
        self.events_list.set_sort_column_id(self.ICON_LABEL, gtk.SORT_ASCENDING)

        for toolname in addon.list_addons():
            meta = addon.get_addon_meta(toolname)
            iconfile = gtk.Image()
            iconfile.set_from_file(icon.get_icon_file_name(meta['icon']))
            img = iconfile.get_pixbuf()
            label = format_multiline(meta['display_name'])

            if meta['type'] == addon.TYPE_ACTION:
                self.actions_list.append((label, img, toolname, meta['display_name']))
            else:
                self.events_list.append((label, img, toolname, meta['display_name']))

        iconview_action = self.tree.get_widget('iconview1')
        iconview_action.set_model(self.actions_list)
        iconview_action.set_text_column(self.ICON_LABEL)
        iconview_action.set_pixbuf_column(self.ICON_IMAGE)
        iconview_action.set_tooltip_column(self.ICON_TIP)
        iconview_event = self.tree.get_widget('iconview2')
        iconview_event.set_model(self.events_list)
        iconview_event.set_text_column(self.ICON_LABEL)
        iconview_event.set_pixbuf_column(self.ICON_IMAGE)
        iconview_event.set_tooltip_column(self.ICON_TIP)

        self.window.show()

    def destroy(self):
        """ clean and free the toolbox """
        self.window.destroy()

    def refresh_properties(self):
        """Refresh property values from the selected action."""
        if self._action is None:
            return

        #Refresh the property editors
        for prop in self._propedits:
            prop.refresh_widget()

    def set_action(self, action):
        """Setter for the action property."""
        if self._action is action:
            self.refresh_properties()
            return

        #Clear the prop box
        for old_prop in self._propbox.get_children():
            self._propbox.remove(old_prop)

        self._propedits = []

        self._action = action
        if action is None:
            return
        for propname in action._props.keys():
            row = gtk.HBox()
            #Label
            row.pack_start(gtk.Label(T(propname)), False, False, 10)

            #Value field
            prop = getattr(type(action), propname)
            propedit = prop.widget_class(self.__parent, action, propname, self._refresh_action_cb)
            self._propedits.append(propedit)
            row.pack_end(propedit.widget)

            #Add row
            self._propbox.pack_start(row, expand=False)
        self._propbox.show_all()
        self.refresh_properties()

    def get_action(self):
        """Getter for the action property"""
        return self._action
    action = property(fset=set_action, fget=get_action, doc=\
        "Action to be edited through introspection.")

    def _refresh_action_cb(self):
        if self._action is not None:
            self.__parent._creator._action_refresh_cb(None, None, self._action)


# The purpose of this function is to reformat text, as current IconView
# implentation does not insert carriage returns on long lines.
# To preserve layout, this call reformat text to fit in small space under an
# icon.
def format_multiline(text, length=10, lines=3, line_separator='\n'):
    """
    Reformat a text to fit in a small space.

    @param length: maximum char per line
    @param lines: maximum number of lines
    """
    words = text.split(' ')
    line = list()
    return_val = []
    linelen = 0

    for word in words:
        t_len = linelen+len(word)
        if t_len < length:
            line.append(word)
            linelen = t_len+1 # count space
        else:
            if len(return_val)+1 < lines:
                return_val.append(' '.join(line))
                line = list()
                linelen = 0
                line.append(word)
            else:
                return_val.append(' '.join(line+['...']))
                return line_separator.join(return_val)

    return_val.append(' '.join(line))
    return line_separator.join(return_val)


# vim:set ts=4 sts=4 sw=4 et: