/b-gtk/fix-viz

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/b-gtk/fix-viz

« back to all changes in this revision

Viewing changes to logview.py

  • Committer: Jelmer Vernooij
  • Date: 2007-07-15 15:22:29 UTC
  • Revision ID: jelmer@samba.org-20070715152229-clmlen0vpd8d2pzx
Add docstrings, remove unused code.

Show diffs side-by-side

added added

removed removed

Lines of Context:
logview.py
19
19
pygtk.require("2.0")
20
20
import gtk
21
21
import pango
22
 
import gobject
23
22
 
24
23
from bzrlib.osutils import format_date
25
 
from bzrlib.util.bencode import bdecode
26
 
 
27
 
class RevisionView(gtk.Notebook):
 
24
 
 
25
 
 
26
class LogView(gtk.ScrolledWindow):
28
27
    """ Custom widget for commit log details.
29
28
 
30
29
    A variety of bzr tools may need to implement such a thing. This is a
31
30
    start.
32
31
    """
33
32
 
34
 
    __gproperties__ = {
35
 
        'branch': (
36
 
            gobject.TYPE_PYOBJECT,
37
 
            'Branch',
38
 
            'The branch holding the revision being displayed',
39
 
            gobject.PARAM_CONSTRUCT_ONLY | gobject.PARAM_WRITABLE
40
 
        ),
41
 
 
42
 
        'revision': (
43
 
            gobject.TYPE_PYOBJECT,
44
 
            'Revision',
45
 
            'The revision being displayed',
46
 
            gobject.PARAM_READWRITE
47
 
        ),
48
 
 
49
 
        'children': (
50
 
            gobject.TYPE_PYOBJECT,
51
 
            'Children',
52
 
            'Child revisions',
53
 
            gobject.PARAM_READWRITE
54
 
        ),
55
 
 
56
 
        'file-id': (
57
 
            gobject.TYPE_PYOBJECT,
58
 
            'File Id',
59
 
            'The file id',
60
 
            gobject.PARAM_READWRITE
61
 
        )
62
 
    }
63
 
 
64
 
 
65
 
    def __init__(self, branch=None):
66
 
        gtk.Notebook.__init__(self)
67
 
 
68
 
        self._create_general()
69
 
        self._create_relations()
70
 
        self._create_file_info_view()
71
 
 
72
 
        self.set_current_page(0)
73
 
        
 
33
    def __init__(self, revision=None, scroll=True):
 
34
        super(LogView, self).__init__()
 
35
        if scroll:
 
36
            self.set_policy(gtk.POLICY_NEVER, gtk.POLICY_AUTOMATIC)
 
37
        else:
 
38
            self.set_policy(gtk.POLICY_NEVER, gtk.POLICY_NEVER)
 
39
        self.set_shadow_type(gtk.SHADOW_NONE)
 
40
        self._create()
74
41
        self._show_callback = None
 
42
        self._go_callback = None
75
43
        self._clicked_callback = None
76
44
 
77
 
        self._revision = None
78
 
        self._branch = branch
79
 
 
80
 
        self.update_tags()
81
 
 
82
 
        self.set_file_id(None)
83
 
 
84
 
    def do_get_property(self, property):
85
 
        if property.name == 'branch':
86
 
            return self._branch
87
 
        elif property.name == 'revision':
88
 
            return self._revision
89
 
        elif property.name == 'children':
90
 
            return self._children
91
 
        elif property.name == 'file-id':
92
 
            return self._file_id
93
 
        else:
94
 
            raise AttributeError, 'unknown property %s' % property.name
95
 
 
96
 
    def do_set_property(self, property, value):
97
 
        if property.name == 'branch':
98
 
            self._branch = value
99
 
        elif property.name == 'revision':
100
 
            self._set_revision(value)
101
 
        elif property.name == 'children':
102
 
            self.set_children(value)
103
 
        elif property.name == 'file-id':
104
 
            self._file_id = value
105
 
        else:
106
 
            raise AttributeError, 'unknown property %s' % property.name
 
45
        if revision is not None:
 
46
            self.set_revision(revision)
107
47
 
108
48
    def set_show_callback(self, callback):
109
49
        self._show_callback = callback
110
50
 
111
 
    def set_file_id(self, file_id):
112
 
        """Set a specific file id that we want to track.
113
 
 
114
 
        This just effects the display of a per-file commit message.
115
 
        If it is set to None, then all commit messages will be shown.
116
 
        """
117
 
        self.set_property('file-id', file_id)
 
51
    def set_go_callback(self, callback):
 
52
        self._go_callback = callback
118
53
 
119
54
    def set_revision(self, revision):
120
 
        if revision != self._revision:
121
 
            self.set_property('revision', revision)
122
 
 
123
 
    def get_revision(self):
124
 
        return self.get_property('revision')
125
 
 
126
 
    def _set_revision(self, revision):
127
 
        if revision is None: return
128
 
 
129
55
        self._revision = revision
 
56
        self.revision_id.set_text(revision.revision_id)
130
57
        if revision.committer is not None:
131
58
            self.committer.set_text(revision.committer)
132
59
        else:
133
60
            self.committer.set_text("")
134
 
        author = revision.properties.get('author', '')
135
 
        if author != '':
136
 
            self.author.set_text(author)
137
 
            self.author.show()
138
 
            self.author_label.show()
139
 
        else:
140
 
            self.author.hide()
141
 
            self.author_label.hide()
142
 
 
143
61
        if revision.timestamp is not None:
144
62
            self.timestamp.set_text(format_date(revision.timestamp,
145
63
                                                revision.timezone))
 
64
        self.message_buffer.set_text(revision.message)
146
65
        try:
147
66
            self.branchnick_label.set_text(revision.properties['branch-nick'])
148
67
        except KeyError:
149
68
            self.branchnick_label.set_text("")
150
69
 
151
 
        self._add_parents_or_children(revision.parent_ids,
152
 
                                      self.parents_widgets,
153
 
                                      self.parents_table)
154
 
        
155
 
        file_info = revision.properties.get('file-info', None)
156
 
        if file_info is not None:
157
 
            file_info = bdecode(file_info.encode('UTF-8'))
158
 
 
159
 
        if file_info:
160
 
            if self._file_id is None:
161
 
                text = []
162
 
                for fi in file_info:
163
 
                    text.append('%(path)s\n%(message)s' % fi)
164
 
                self.file_info_buffer.set_text('\n'.join(text))
165
 
                self.file_info_box.show()
166
 
            else:
167
 
                text = []
168
 
                for fi in file_info:
169
 
                    if fi['file_id'] == self._file_id:
170
 
                        text.append(fi['message'])
171
 
                if text:
172
 
                    self.file_info_buffer.set_text('\n'.join(text))
173
 
                    self.file_info_box.show()
174
 
                else:
175
 
                    self.file_info_box.hide()
176
 
        else:
177
 
            self.file_info_box.hide()
178
 
 
179
 
    def update_tags(self):
180
 
        if self._branch is not None and self._branch.supports_tags():
181
 
            self._tagdict = self._branch.tags.get_reverse_tag_dict()
182
 
        else:
183
 
            self._tagdict = {}
184
 
 
185
 
        self._add_tags()
186
 
 
187
 
    def set_children(self, children):
188
 
        self._add_parents_or_children(children,
189
 
                                      self.children_widgets,
190
 
                                      self.children_table)
 
70
        self._add_parents(revision.parent_ids)
191
71
 
192
72
    def _show_clicked_cb(self, widget, revid, parentid):
193
73
        """Callback for when the show button for a parent is clicked."""
195
75
 
196
76
    def _go_clicked_cb(self, widget, revid):
197
77
        """Callback for when the go button for a parent is clicked."""
198
 
 
199
 
    def _add_tags(self, *args):
200
 
        if self._revision is None: return
201
 
 
202
 
        if self._tagdict.has_key(self._revision.revision_id):
203
 
            tags = self._tagdict[self._revision.revision_id]
204
 
        else:
205
 
            tags = []
 
78
        self._go_callback(revid)
 
79
 
 
80
    def _add_parents(self, parent_ids):
 
81
        for widget in self.parents_widgets:
 
82
            self.parents_table.remove(widget)
206
83
            
207
 
        if tags == []:
208
 
            self.tags_list.hide()
209
 
            self.tags_label.hide()
210
 
            return
211
 
 
212
 
        self.tags_list.set_text(", ".join(tags))
213
 
 
214
 
        self.tags_list.show_all()
215
 
        self.tags_label.show_all()
216
 
        
217
 
    def _add_parents_or_children(self, revids, widgets, table):
218
 
        while len(widgets) > 0:
219
 
            widget = widgets.pop()
220
 
            table.remove(widget)
221
 
        
222
 
        table.resize(max(len(revids), 1), 2)
223
 
 
224
 
        for idx, revid in enumerate(revids):
 
84
        self.parents_widgets = []
 
85
        self.parents_table.resize(max(len(parent_ids), 1), 2)
 
86
 
 
87
        for idx, parent_id in enumerate(parent_ids):
225
88
            align = gtk.Alignment(0.0, 0.0)
226
 
            widgets.append(align)
227
 
            table.attach(align, 1, 2, idx, idx + 1,
 
89
            self.parents_widgets.append(align)
 
90
            self.parents_table.attach(align, 1, 2, idx, idx + 1,
228
91
                                      gtk.EXPAND | gtk.FILL, gtk.FILL)
229
92
            align.show()
230
93
 
241
104
                button = gtk.Button()
242
105
                button.add(image)
243
106
                button.connect("clicked", self._show_clicked_cb,
244
 
                               self._revision.revision_id, revid)
 
107
                               self._revision.revision_id, parent_id)
245
108
                hbox.pack_start(button, expand=False, fill=True)
246
109
                button.show()
247
110
 
248
 
            button = gtk.Button(revid)
249
 
            button.connect("clicked",
250
 
                    lambda w, r: self.set_revision(self._branch.repository.get_revision(r)), revid)
 
111
            if self._go_callback is not None:
 
112
                button = gtk.Button(parent_id)
 
113
                button.connect("clicked", self._go_clicked_cb, parent_id)
 
114
            else:
 
115
                button = gtk.Label(parent_id)
251
116
            button.set_use_underline(False)
252
117
            hbox.pack_start(button, expand=False, fill=True)
253
118
            button.show()
254
119
 
255
 
    def _create_general(self):
 
120
    def _create(self):
256
121
        vbox = gtk.VBox(False, 6)
257
122
        vbox.set_border_width(6)
258
123
        vbox.pack_start(self._create_headers(), expand=False, fill=True)
 
124
        vbox.pack_start(self._create_parents_table(), expand=False, fill=True)
259
125
        vbox.pack_start(self._create_message_view())
260
 
        self.append_page(vbox, tab_label=gtk.Label("General"))
261
 
        vbox.show()
262
 
 
263
 
    def _create_relations(self):
264
 
        vbox = gtk.VBox(False, 6)
265
 
        vbox.set_border_width(6)
266
 
        vbox.pack_start(self._create_parents(), expand=False, fill=True)
267
 
        vbox.pack_start(self._create_children(), expand=False, fill=True)
268
 
        self.append_page(vbox, tab_label=gtk.Label("Relations"))
 
126
        self.add_with_viewport(vbox)
269
127
        vbox.show()
270
128
 
271
129
    def _create_headers(self):
272
 
        self.table = gtk.Table(rows=5, columns=2)
 
130
        self.table = gtk.Table(rows=4, columns=2)
273
131
        self.table.set_row_spacings(6)
274
132
        self.table.set_col_spacings(6)
275
133
        self.table.show()
283
141
        label.show()
284
142
 
285
143
        align = gtk.Alignment(0.0, 0.5)
286
 
        revision_id = gtk.Label()
287
 
        revision_id.set_selectable(True)
288
 
        self.connect('notify::revision', 
289
 
                lambda w, p: revision_id.set_text(self._revision.revision_id))
290
 
        align.add(revision_id)
 
144
        self.revision_id = gtk.Label()
 
145
        self.revision_id.set_selectable(True)
 
146
        align.add(self.revision_id)
291
147
        self.table.attach(align, 1, 2, 0, 1, gtk.EXPAND | gtk.FILL, gtk.FILL)
292
148
        align.show()
293
 
        revision_id.show()
 
149
        self.revision_id.show()
294
150
 
295
151
        align = gtk.Alignment(1.0, 0.5)
296
 
        self.author_label = gtk.Label()
297
 
        self.author_label.set_markup("<b>Author:</b>")
298
 
        align.add(self.author_label)
 
152
        label = gtk.Label()
 
153
        label.set_markup("<b>Committer:</b>")
 
154
        align.add(label)
299
155
        self.table.attach(align, 0, 1, 1, 2, gtk.FILL, gtk.FILL)
300
156
        align.show()
301
 
        self.author_label.show()
302
 
 
303
 
        align = gtk.Alignment(0.0, 0.5)
304
 
        self.author = gtk.Label()
305
 
        self.author.set_selectable(True)
306
 
        align.add(self.author)
307
 
        self.table.attach(align, 1, 2, 1, 2, gtk.EXPAND | gtk.FILL, gtk.FILL)
308
 
        align.show()
309
 
        self.author.show()
310
 
        self.author.hide()
311
 
 
312
 
        align = gtk.Alignment(1.0, 0.5)
313
 
        label = gtk.Label()
314
 
        label.set_markup("<b>Committer:</b>")
315
 
        align.add(label)
316
 
        self.table.attach(align, 0, 1, 2, 3, gtk.FILL, gtk.FILL)
317
 
        align.show()
318
157
        label.show()
319
158
 
320
159
        align = gtk.Alignment(0.0, 0.5)
321
160
        self.committer = gtk.Label()
322
161
        self.committer.set_selectable(True)
323
162
        align.add(self.committer)
324
 
        self.table.attach(align, 1, 2, 2, 3, gtk.EXPAND | gtk.FILL, gtk.FILL)
 
163
        self.table.attach(align, 1, 2, 1, 2, gtk.EXPAND | gtk.FILL, gtk.FILL)
325
164
        align.show()
326
165
        self.committer.show()
327
166
 
329
168
        label = gtk.Label()
330
169
        label.set_markup("<b>Branch nick:</b>")
331
170
        align.add(label)
332
 
        self.table.attach(align, 0, 1, 3, 4, gtk.FILL, gtk.FILL)
 
171
        self.table.attach(align, 0, 1, 2, 3, gtk.FILL, gtk.FILL)
333
172
        label.show()
334
173
        align.show()
335
174
 
337
176
        self.branchnick_label = gtk.Label()
338
177
        self.branchnick_label.set_selectable(True)
339
178
        align.add(self.branchnick_label)
340
 
        self.table.attach(align, 1, 2, 3, 4, gtk.EXPAND | gtk.FILL, gtk.FILL)
 
179
        self.table.attach(align, 1, 2, 2, 3, gtk.EXPAND | gtk.FILL, gtk.FILL)
341
180
        self.branchnick_label.show()
342
181
        align.show()
343
182
 
345
184
        label = gtk.Label()
346
185
        label.set_markup("<b>Timestamp:</b>")
347
186
        align.add(label)
348
 
        self.table.attach(align, 0, 1, 4, 5, gtk.FILL, gtk.FILL)
 
187
        self.table.attach(align, 0, 1, 3, 4, gtk.FILL, gtk.FILL)
349
188
        align.show()
350
189
        label.show()
351
190
 
353
192
        self.timestamp = gtk.Label()
354
193
        self.timestamp.set_selectable(True)
355
194
        align.add(self.timestamp)
356
 
        self.table.attach(align, 1, 2, 4, 5, gtk.EXPAND | gtk.FILL, gtk.FILL)
 
195
        self.table.attach(align, 1, 2, 3, 4, gtk.EXPAND | gtk.FILL, gtk.FILL)
357
196
        align.show()
358
197
        self.timestamp.show()
359
198
 
360
 
        align = gtk.Alignment(1.0, 0.5)
361
 
        self.tags_label = gtk.Label()
362
 
        self.tags_label.set_markup("<b>Tags:</b>")
363
 
        align.add(self.tags_label)
364
 
        align.show()
365
 
        self.table.attach(align, 0, 1, 5, 6, gtk.FILL, gtk.FILL)
366
 
        self.tags_label.show()
367
 
 
368
 
        align = gtk.Alignment(0.0, 0.5)
369
 
        self.tags_list = gtk.Label()
370
 
        align.add(self.tags_list)
371
 
        self.table.attach(align, 1, 2, 5, 6, gtk.EXPAND | gtk.FILL, gtk.FILL)
372
 
        align.show()
373
 
        self.tags_list.show()
374
 
 
375
 
        self.connect('notify::revision', self._add_tags)
376
 
 
377
199
        return self.table
378
200
 
379
 
    
380
 
    def _create_parents(self):
381
 
        hbox = gtk.HBox(True, 3)
382
 
        
383
 
        self.parents_table = self._create_parents_or_children_table(
384
 
            "<b>Parents:</b>")
 
201
    def _create_parents_table(self):
 
202
        self.parents_table = gtk.Table(rows=1, columns=2)
 
203
        self.parents_table.set_row_spacings(3)
 
204
        self.parents_table.set_col_spacings(6)
 
205
        self.parents_table.show()
385
206
        self.parents_widgets = []
386
 
        hbox.pack_start(self.parents_table)
387
 
 
388
 
        hbox.show()
389
 
        return hbox
390
 
 
391
 
    def _create_children(self):
392
 
        hbox = gtk.HBox(True, 3)
393
 
        self.children_table = self._create_parents_or_children_table(
394
 
            "<b>Children:</b>")
395
 
        self.children_widgets = []
396
 
        hbox.pack_start(self.children_table)
397
 
        hbox.show()
398
 
        return hbox
399
 
        
400
 
    def _create_parents_or_children_table(self, text):
401
 
        table = gtk.Table(rows=1, columns=2)
402
 
        table.set_row_spacings(3)
403
 
        table.set_col_spacings(6)
404
 
        table.show()
405
207
 
406
208
        label = gtk.Label()
407
 
        label.set_markup(text)
 
209
        label.set_markup("<b>Parents:</b>")
408
210
        align = gtk.Alignment(0.0, 0.5)
409
211
        align.add(label)
410
 
        table.attach(align, 0, 1, 0, 1, gtk.FILL, gtk.FILL)
 
212
        self.parents_table.attach(align, 0, 1, 0, 1, gtk.FILL, gtk.FILL)
411
213
        label.show()
412
214
        align.show()
413
215
 
414
 
        return table
 
216
        return self.parents_table
415
217
 
416
218
    def _create_message_view(self):
417
 
        msg_buffer = gtk.TextBuffer()
418
 
        self.connect('notify::revision',
419
 
                lambda w, p: msg_buffer.set_text(self._revision.message))
420
 
        window = gtk.ScrolledWindow()
421
 
        window.set_policy(gtk.POLICY_NEVER, gtk.POLICY_AUTOMATIC)
422
 
        window.set_shadow_type(gtk.SHADOW_IN)
423
 
        tv = gtk.TextView(msg_buffer)
424
 
        tv.set_editable(False)
425
 
        tv.set_wrap_mode(gtk.WRAP_WORD)
426
 
        tv.modify_font(pango.FontDescription("Monospace"))
427
 
        tv.show()
428
 
        window.add(tv)
429
 
        window.show()
430
 
        return window
431
 
 
432
 
    def _create_file_info_view(self):
433
 
        self.file_info_box = gtk.VBox(False, 6)
434
 
        self.file_info_box.set_border_width(6)
435
 
        self.file_info_buffer = gtk.TextBuffer()
436
 
        window = gtk.ScrolledWindow()
437
 
        window.set_policy(gtk.POLICY_NEVER, gtk.POLICY_AUTOMATIC)
438
 
        window.set_shadow_type(gtk.SHADOW_IN)
439
 
        tv = gtk.TextView(self.file_info_buffer)
440
 
        tv.set_editable(False)
441
 
        tv.set_wrap_mode(gtk.WRAP_WORD)
442
 
        tv.modify_font(pango.FontDescription("Monospace"))
443
 
        tv.show()
444
 
        window.add(tv)
445
 
        window.show()
446
 
        self.file_info_box.pack_start(window)
447
 
        self.file_info_box.hide() # Only shown when there are per-file messages
448
 
        self.append_page(self.file_info_box, tab_label=gtk.Label('Per-file'))
 
219
        self.message_buffer = gtk.TextBuffer()
 
220
        tv = gtk.TextView(self.message_buffer)
 
221
        tv.set_editable(False)
 
222
        tv.set_wrap_mode(gtk.WRAP_WORD)
 
223
        tv.modify_font(pango.FontDescription("Monospace"))
 
224
        tv.show()
 
225
        return tv
449
226