/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 annotate/gannotate.py

  • Committer: Daniel Schierbeck
  • Date: 2008-01-13 14:15:20 UTC
  • mto: (423.1.2 trunk)
  • mto: This revision was merged to the branch mainline in revision 429.
  • Revision ID: daniel.schierbeck@gmail.com-20080113141520-ol1on2ju8h833rh0
Moved the branch window class to the viz package.

Show diffs side-by-side

added added

removed removed

Lines of Context:
21
21
import gobject
22
22
import gtk
23
23
import pango
 
24
import re
24
25
 
 
26
from bzrlib import patiencediff, tsort
25
27
from bzrlib.errors import NoSuchRevision
26
 
from bzrlib.revision import NULL_REVISION
 
28
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
27
29
 
28
30
from colormap import AnnotateColorMap, AnnotateColorSaturation
29
 
from logview import LogView
30
 
from spanselector import SpanSelector
 
31
from bzrlib.plugins.gtk.revisionview import RevisionView
 
32
from bzrlib.plugins.gtk.window import Window
31
33
 
32
34
 
33
35
(
40
42
) = range(6)
41
43
 
42
44
 
43
 
class GAnnotateWindow(gtk.Window):
 
45
class GAnnotateWindow(Window):
44
46
    """Annotate window."""
45
47
 
46
 
    def __init__(self, all=False, plain=False):
 
48
    def __init__(self, all=False, plain=False, parent=None):
47
49
        self.all = all
48
50
        self.plain = plain
49
51
        
50
 
        gtk.Window.__init__(self, gtk.WINDOW_TOPLEVEL)
 
52
        Window.__init__(self, parent)
51
53
        
52
54
        self.set_icon(self.render_icon(gtk.STOCK_FIND, gtk.ICON_SIZE_BUTTON))
53
55
        self.annotate_colormap = AnnotateColorSaturation()
54
56
 
55
57
        self._create()
56
 
 
57
 
        if self.plain:
58
 
            self.span_selector.hide()
59
 
 
60
 
    def annotate(self, branch, file_id):
61
58
        self.revisions = {}
 
59
        self.history = []
 
60
        self._no_back = set()
 
61
 
 
62
    def annotate(self, tree, branch, file_id):
62
63
        self.annotations = []
63
64
        self.branch = branch
 
65
        self.tree = tree
64
66
        self.file_id = file_id
 
67
        self.revisionview.set_file_id(file_id)
 
68
        self.revision_id = getattr(tree, 'get_revision_id', 
 
69
                                   lambda: CURRENT_REVISION)()
65
70
        
66
 
        # [revision id, line number, committer, revno, highlight color, line]
 
71
        # [revision id, line number, author, revno, highlight color, line]
67
72
        self.annomodel = gtk.ListStore(gobject.TYPE_STRING,
68
73
                                       gobject.TYPE_STRING,
69
74
                                       gobject.TYPE_STRING,
76
81
            branch.lock_read()
77
82
            branch.repository.lock_read()
78
83
            for line_no, (revision, revno, line)\
79
 
                    in enumerate(self._annotate(branch, file_id)):
 
84
                    in enumerate(self._annotate(tree, file_id)):
80
85
                if revision.revision_id == last_seen and not self.all:
81
 
                    revno = committer = ""
 
86
                    revno = author = ""
82
87
                else:
83
88
                    last_seen = revision.revision_id
84
 
                    committer = revision.committer
 
89
                    author = revision.get_apparent_author()
85
90
 
86
91
                if revision.revision_id not in self.revisions:
87
92
                    self.revisions[revision.revision_id] = revision
88
93
 
89
94
                self.annomodel.append([revision.revision_id,
90
95
                                       line_no + 1,
91
 
                                       committer,
 
96
                                       author,
92
97
                                       revno,
93
98
                                       None,
94
99
                                       line.rstrip("\r\n")
96
101
                self.annotations.append(revision)
97
102
 
98
103
            if not self.plain:
99
 
                self._set_oldest_newest()
100
 
                # Recall that calling activate_default will emit "span-changed",
101
 
                # so self._span_changed_cb will take care of initial highlighting
102
 
                self.span_selector.activate_default()
 
104
                now = time.time()
 
105
                self.annomodel.foreach(self._highlight_annotation, now)
103
106
        finally:
104
107
            branch.repository.unlock()
105
108
            branch.unlock()
121
124
        self.annoview.set_cursor(row)
122
125
        self.annoview.scroll_to_cell(row, use_align=True)
123
126
 
124
 
    def _annotate(self, branch, file_id):
125
 
        rev_hist = branch.revision_history()
126
 
        repository = branch.repository
127
 
        rev_tree = repository.revision_tree(branch.last_revision())
128
 
        rev_id = rev_tree.inventory[file_id].revision
129
 
        weave = repository.weave_store.get_weave(file_id,
130
 
                                                 branch.get_transaction())
 
127
    def _dotted_revnos(self, repository, revision_id):
 
128
        """Return a dict of revision_id -> dotted revno
131
129
        
132
 
        revision_cache = RevisionCache(repository)
133
 
        for origin, text in weave.annotate_iter(rev_id):
 
130
        :param repository: The repository to get the graph from
 
131
        :param revision_id: The last revision for which this info is needed
 
132
        """
 
133
        graph = repository.get_revision_graph(revision_id)
 
134
        dotted = {}
 
135
        for n, revision_id, d, revno, e in tsort.merge_sort(graph, 
 
136
            revision_id, generate_revno=True):
 
137
            dotted[revision_id] = '.'.join(str(num) for num in revno)
 
138
        return dotted
 
139
 
 
140
    def _annotate(self, tree, file_id):
 
141
        current_revision = FakeRevision(CURRENT_REVISION)
 
142
        current_revision.committer = self.branch.get_config().username()
 
143
        current_revision.timestamp = time.time()
 
144
        current_revision.message = '[Not yet committed]'
 
145
        current_revision.parent_ids = tree.get_parent_ids()
 
146
        current_revision.properties['branch-nick'] = self.branch.nick
 
147
        current_revno = '%d?' % (self.branch.revno() + 1)
 
148
        repository = self.branch.repository
 
149
        if self.revision_id == CURRENT_REVISION:
 
150
            revision_id = self.branch.last_revision()
 
151
        else:
 
152
            revision_id = self.revision_id
 
153
        dotted = self._dotted_revnos(repository, revision_id)
 
154
        revision_cache = RevisionCache(repository, self.revisions)
 
155
        for origin, text in tree.annotate_iter(file_id):
134
156
            rev_id = origin
135
 
            try:
136
 
                revision = revision_cache.get_revision(rev_id)
137
 
                if rev_id in rev_hist:
138
 
                    revno = branch.revision_id_to_revno(rev_id)
139
 
                else:
140
 
                    revno = "merge"
141
 
            except NoSuchRevision:
142
 
                revision = NoneRevision(rev_id)
143
 
                revno = "?"
 
157
            if rev_id == CURRENT_REVISION:
 
158
                revision = current_revision
 
159
                revno = current_revno
 
160
            else:
 
161
                try:
 
162
                    revision = revision_cache.get_revision(rev_id)
 
163
                    revno = dotted.get(rev_id, 'merge')
 
164
                    if len(revno) > 15:
 
165
                        revno = 'merge'
 
166
                except NoSuchRevision:
 
167
                    revision = FakeRevision(rev_id)
 
168
                    revno = "?"
144
169
 
145
170
            yield revision, revno, text
146
171
 
147
 
    def _set_oldest_newest(self):
148
 
        rev_dates = map(lambda i: self.revisions[i].timestamp, self.revisions)
149
 
        if len(rev_dates) == 0:
150
 
            return
151
 
        oldest = min(rev_dates)
152
 
        newest = max(rev_dates)
153
 
 
154
 
        span = self._span_from_seconds(time.time() - oldest)
155
 
        self.span_selector.set_to_oldest_span(span)
156
 
        
157
 
        span = self._span_from_seconds(newest - oldest)
158
 
        self.span_selector.set_newest_to_oldest_span(span)
159
 
 
160
 
    def _span_from_seconds(self, seconds):
161
 
        return (seconds / (24 * 60 * 60))
162
 
    
163
 
    def _span_changed_cb(self, w, span):
164
 
        self.annotate_colormap.set_span(span)
165
 
        now = time.time()
166
 
        self.annomodel.foreach(self._highlight_annotation, now)
167
 
 
168
172
    def _highlight_annotation(self, model, path, iter, now):
169
173
        revision_id, = model.get(iter, REVISION_ID_COL)
170
174
        revision = self.revisions[revision_id]
171
175
        model.set(iter, HIGHLIGHT_COLOR_COL,
172
176
                  self.annotate_colormap.get_color(revision, now))
173
177
 
174
 
    def _show_log(self, w):
 
178
    def _selected_revision(self):
175
179
        (path, col) = self.annoview.get_cursor()
176
180
        if path is None:
 
181
            return None
 
182
        return self.annomodel[path][REVISION_ID_COL]
 
183
 
 
184
    def _activate_selected_revision(self, w):
 
185
        rev_id = self._selected_revision()
 
186
        if rev_id is None:
177
187
            return
178
 
        rev_id = self.annomodel[path][REVISION_ID_COL]
179
 
        self.logview.set_revision(self.revisions[rev_id])
 
188
        selected = self.revisions[rev_id]
 
189
        self.revisionview.set_revision(selected)
 
190
        if (len(selected.parent_ids) != 0 and selected.parent_ids[0] not in
 
191
            self._no_back):
 
192
            enable_back = True
 
193
        else:
 
194
            enable_back = False
 
195
        self.back_button.set_sensitive(enable_back)
180
196
 
181
197
    def _create(self):
182
 
        self.logview = self._create_log_view()
 
198
        self.revisionview = self._create_log_view()
183
199
        self.annoview = self._create_annotate_view()
184
 
        self.span_selector = self._create_span_selector()
185
200
 
186
 
        vbox = gtk.VBox(False, 12)
187
 
        vbox.set_border_width(12)
 
201
        vbox = gtk.VBox(False)
188
202
        vbox.show()
189
203
 
190
204
        sw = gtk.ScrolledWindow()
193
207
        sw.add(self.annoview)
194
208
        self.annoview.gwindow = self
195
209
        sw.show()
 
210
 
 
211
        swbox = gtk.VBox()
 
212
        swbox.pack_start(sw)
 
213
        swbox.show()
 
214
 
 
215
        hbox = gtk.HBox(False, 6)
 
216
        self.back_button = self._create_back_button()
 
217
        hbox.pack_start(self.back_button, expand=False, fill=True)
 
218
        self.forward_button = self._create_forward_button()
 
219
        hbox.pack_start(self.forward_button, expand=False, fill=True)
 
220
        hbox.show()
 
221
        vbox.pack_start(hbox, expand=False, fill=True)
196
222
        
197
223
        self.pane = pane = gtk.VPaned()
198
 
        pane.add1(sw)
199
 
        pane.add2(self.logview)
 
224
        pane.add1(swbox)
 
225
        pane.add2(self.revisionview)
200
226
        pane.show()
201
227
        vbox.pack_start(pane, expand=True, fill=True)
202
 
        
203
 
        hbox = gtk.HBox(True, 6)
204
 
        hbox.pack_start(self.span_selector, expand=False, fill=True)
205
 
        hbox.pack_start(self._create_button_box(), expand=False, fill=True)
206
 
        hbox.show()
207
 
        vbox.pack_start(hbox, expand=False, fill=True)
 
228
 
 
229
        self._search = SearchBox()
 
230
        swbox.pack_start(self._search, expand=False, fill=True)
 
231
        accels = gtk.AccelGroup()
 
232
        accels.connect_group(gtk.keysyms.f, gtk.gdk.CONTROL_MASK,
 
233
                             gtk.ACCEL_LOCKED,
 
234
                             self._search_by_text)
 
235
        accels.connect_group(gtk.keysyms.g, gtk.gdk.CONTROL_MASK,
 
236
                             gtk.ACCEL_LOCKED,
 
237
                             self._search_by_line)
 
238
        self.add_accel_group(accels)
208
239
 
209
240
        self.add(vbox)
210
241
 
 
242
    def _search_by_text(self, accel_group, window, key, modifiers):
 
243
        self._search.show_for('text')
 
244
        self._search.set_target(self.annoview, TEXT_LINE_COL)
 
245
 
 
246
    def _search_by_line(self, accel_group, window, key, modifiers):
 
247
        self._search.show_for('line')
 
248
        self._search.set_target(self.annoview, LINE_NUM_COL)
 
249
 
211
250
    def row_diff(self, tv, path, tvc):
212
251
        row = path[0]
213
252
        revision = self.annotations[row]
214
253
        repository = self.branch.repository
215
 
        tree1 = repository.revision_tree(revision.revision_id)
216
 
        if len(revision.parent_ids) > 0:
217
 
            tree2 = repository.revision_tree(revision.parent_ids[0])
 
254
        if revision.revision_id == CURRENT_REVISION:
 
255
            tree1 = self.tree
 
256
            tree2 = self.tree.basis_tree()
218
257
        else:
219
 
            tree2 = repository.revision_tree(NULL_REVISION)
220
 
        from bzrlib.plugins.gtk.viz.diffwin import DiffWindow
 
258
            tree1 = repository.revision_tree(revision.revision_id)
 
259
            if len(revision.parent_ids) > 0:
 
260
                tree2 = repository.revision_tree(revision.parent_ids[0])
 
261
            else:
 
262
                tree2 = repository.revision_tree(NULL_REVISION)
 
263
        from bzrlib.plugins.gtk.diff import DiffWindow
221
264
        window = DiffWindow()
222
265
        window.set_diff("Diff for row %d" % (row+1), tree1, tree2)
223
266
        window.set_file(tree1.id2path(self.file_id))
227
270
    def _create_annotate_view(self):
228
271
        tv = gtk.TreeView()
229
272
        tv.set_rules_hint(False)
230
 
        tv.connect("cursor-changed", self._show_log)
 
273
        tv.connect("cursor-changed", self._activate_selected_revision)
231
274
        tv.show()
232
275
        tv.connect("row-activated", self.row_diff)
233
276
 
276
319
        col.add_attribute(cell, "text", TEXT_LINE_COL)
277
320
        tv.append_column(col)
278
321
 
 
322
        # FIXME: Now that C-f is now used for search by text we
 
323
        # may as well disable the auto search.
279
324
        tv.set_search_column(LINE_NUM_COL)
280
 
        
 
325
 
281
326
        return tv
282
327
 
283
 
    def _create_span_selector(self):
284
 
        ss = SpanSelector()
285
 
        ss.connect("span-changed", self._span_changed_cb)
286
 
        ss.show()
287
 
 
288
 
        return ss
289
 
 
290
328
    def _create_log_view(self):
291
 
        lv = LogView()
 
329
        lv = RevisionView()
292
330
        lv.show()
293
 
 
294
331
        return lv
295
332
 
296
 
    def _create_button_box(self):
297
 
        box = gtk.HButtonBox()
298
 
        box.set_layout(gtk.BUTTONBOX_END)
299
 
        box.show()
300
 
        
301
 
        button = gtk.Button()
302
 
        button.set_use_stock(True)
303
 
        button.set_label("gtk-close")
304
 
        button.connect("clicked", lambda w: self.destroy())
305
 
        button.show()
306
 
        
307
 
        box.pack_start(button, expand=False, fill=False)
308
 
 
309
 
        return box
310
 
 
311
 
 
312
 
class NoneRevision:
 
333
    def _create_back_button(self):
 
334
        button = gtk.Button()
 
335
        button.set_use_stock(True)
 
336
        button.set_label("gtk-go-back")
 
337
        button.connect("clicked", lambda w: self.go_back())
 
338
        button.set_relief(gtk.RELIEF_NONE)
 
339
        button.show()
 
340
        return button
 
341
 
 
342
    def _create_forward_button(self):
 
343
        button = gtk.Button()
 
344
        button.set_use_stock(True)
 
345
        button.set_label("gtk-go-forward")
 
346
        button.connect("clicked", lambda w: self.go_forward())
 
347
        button.set_relief(gtk.RELIEF_NONE)
 
348
        button.show()
 
349
        button.set_sensitive(False)
 
350
        return button
 
351
 
 
352
    def go_back(self):
 
353
        last_tree = self.tree
 
354
        rev_id = self._selected_revision()
 
355
        parent_id = self.revisions[rev_id].parent_ids[0]
 
356
        target_tree = self.branch.repository.revision_tree(parent_id)
 
357
        if self._go(target_tree):
 
358
            self.history.append(last_tree)
 
359
            self.forward_button.set_sensitive(True)
 
360
        else:
 
361
            self._no_back.add(parent_id)
 
362
            self.back_button.set_sensitive(False)
 
363
 
 
364
    def go_forward(self):
 
365
        if len(self.history) == 0:
 
366
            return
 
367
        target_tree = self.history.pop()
 
368
        if len(self.history) == 0:
 
369
            self.forward_button.set_sensitive(False)
 
370
        self._go(target_tree)
 
371
 
 
372
    def _go(self, target_tree):
 
373
        rev_id = self._selected_revision()
 
374
        if self.file_id in target_tree:
 
375
            offset = self.get_scroll_offset(target_tree)
 
376
            (row,), col = self.annoview.get_cursor()
 
377
            self.annotate(target_tree, self.branch, self.file_id)
 
378
            new_row = row+offset
 
379
            if new_row < 0:
 
380
                new_row = 0
 
381
            self.annoview.set_cursor(new_row)
 
382
            return True
 
383
        else:
 
384
            return False
 
385
 
 
386
    def get_scroll_offset(self, tree):
 
387
        old = self.tree.get_file(self.file_id)
 
388
        new = tree.get_file(self.file_id)
 
389
        (row,), col = self.annoview.get_cursor()
 
390
        matcher = patiencediff.PatienceSequenceMatcher(None, old.readlines(),
 
391
                                                       new.readlines())
 
392
        for i, j, n in matcher.get_matching_blocks():
 
393
            if i + n >= row:
 
394
                return j - i
 
395
 
 
396
 
 
397
class FakeRevision:
313
398
    """ A fake revision.
314
399
 
315
400
    For when a revision is referenced but not present.
316
401
    """
317
402
 
318
 
    def __init__(self, revision_id):
 
403
    def __init__(self, revision_id, committer='?', nick=None):
319
404
        self.revision_id = revision_id
320
405
        self.parent_ids = []
321
 
        self.committer = "?"
 
406
        self.committer = committer
322
407
        self.message = "?"
323
408
        self.timestamp = 0.0
324
409
        self.timezone = 0
 
410
        self.properties = {}
 
411
 
 
412
    def get_apparent_author(self):
 
413
        return self.committer
325
414
 
326
415
 
327
416
class RevisionCache(object):
328
417
    """A caching revision source"""
329
 
    def __init__(self, real_source):
 
418
    def __init__(self, real_source, seed_cache=None):
330
419
        self.__real_source = real_source
331
 
        self.__cache = {}
 
420
        if seed_cache is None:
 
421
            self.__cache = {}
 
422
        else:
 
423
            self.__cache = dict(seed_cache)
332
424
 
333
425
    def get_revision(self, revision_id):
334
426
        if revision_id not in self.__cache:
335
427
            revision = self.__real_source.get_revision(revision_id)
336
428
            self.__cache[revision_id] = revision
337
429
        return self.__cache[revision_id]
 
430
 
 
431
class SearchBox(gtk.HBox):
 
432
    """A button box for searching in text or lines of annotations"""
 
433
    def __init__(self):
 
434
        gtk.HBox.__init__(self, False, 6)
 
435
 
 
436
        # Close button
 
437
        button = gtk.Button()
 
438
        image = gtk.Image()
 
439
        image.set_from_stock('gtk-stop', gtk.ICON_SIZE_BUTTON)
 
440
        button.set_image(image)
 
441
        button.set_relief(gtk.RELIEF_NONE)
 
442
        button.connect("clicked", lambda w: self.hide_all())
 
443
        self.pack_start(button, expand=False, fill=False)
 
444
 
 
445
        # Search entry
 
446
        label = gtk.Label()
 
447
        self._label = label
 
448
        self.pack_start(label, expand=False, fill=False)
 
449
 
 
450
        entry = gtk.Entry()
 
451
        self._entry = entry
 
452
        entry.connect("activate", lambda w, d: self._do_search(d),
 
453
                      'forward')
 
454
        self.pack_start(entry, expand=False, fill=False)
 
455
 
 
456
        # Next/previous buttons
 
457
        button = gtk.Button('_Next')
 
458
        image = gtk.Image()
 
459
        image.set_from_stock('gtk-go-forward', gtk.ICON_SIZE_BUTTON)
 
460
        button.set_image(image)
 
461
        button.connect("clicked", lambda w, d: self._do_search(d),
 
462
                       'forward')
 
463
        self.pack_start(button, expand=False, fill=False)
 
464
 
 
465
        button = gtk.Button('_Previous')
 
466
        image = gtk.Image()
 
467
        image.set_from_stock('gtk-go-back', gtk.ICON_SIZE_BUTTON)
 
468
        button.set_image(image)
 
469
        button.connect("clicked", lambda w, d: self._do_search(d),
 
470
                       'backward')
 
471
        self.pack_start(button, expand=False, fill=False)
 
472
 
 
473
        # Search options
 
474
        check = gtk.CheckButton('Match case')
 
475
        self._match_case = check
 
476
        self.pack_start(check, expand=False, fill=False)
 
477
 
 
478
        check = gtk.CheckButton('Regexp')
 
479
        check.connect("toggled", lambda w: self._set_label())
 
480
        self._regexp = check
 
481
        self.pack_start(check, expand=False, fill=False)
 
482
 
 
483
        self._view = None
 
484
        self._column = None
 
485
        # Note that we stay hidden (we do not call self.show_all())
 
486
 
 
487
 
 
488
    def show_for(self, kind):
 
489
        self._kind = kind
 
490
        self.show_all()
 
491
        self._set_label()
 
492
        # Hide unrelated buttons
 
493
        if kind == 'line':
 
494
            self._match_case.hide()
 
495
            self._regexp.hide()
 
496
        # Be ready
 
497
        self._entry.grab_focus()
 
498
 
 
499
    def _set_label(self):
 
500
        if self._kind == 'line':
 
501
            self._label.set_text('Find Line: ')
 
502
        else:
 
503
            if self._regexp.get_active():
 
504
                self._label.set_text('Find Regexp: ')
 
505
            else:
 
506
                self._label.set_text('Find Text: ')
 
507
 
 
508
    def set_target(self, view,column):
 
509
        self._view = view
 
510
        self._column = column
 
511
 
 
512
    def _match(self, model, iterator, column):
 
513
        matching_case = self._match_case.get_active()
 
514
        string, = model.get(iterator, column)
 
515
        key = self._entry.get_text()
 
516
        if self._regexp.get_active():
 
517
            if matching_case:
 
518
                match = re.compile(key).search(string, 1)
 
519
            else:
 
520
                match = re.compile(key, re.I).search(string, 1)
 
521
        else:
 
522
            if not matching_case:
 
523
                string = string.lower()
 
524
                key = key.lower()
 
525
            match = string.find(key) != -1
 
526
 
 
527
        return match
 
528
 
 
529
    def _iterate_rows_forward(self, model, start):
 
530
        model_size = len(model)
 
531
        current = start + 1
 
532
        while model_size != 0:
 
533
            if current >= model_size: current =  0
 
534
            yield model.get_iter_from_string('%d' % current)
 
535
            if current == start: raise StopIteration
 
536
            current += 1
 
537
 
 
538
    def _iterate_rows_backward(self, model, start):
 
539
        model_size = len(model)
 
540
        current = start - 1
 
541
        while model_size != 0:
 
542
            if current < 0: current = model_size - 1
 
543
            yield model.get_iter_from_string('%d' % current)
 
544
            if current == start: raise StopIteration
 
545
            current -= 1
 
546
 
 
547
    def _do_search(self, direction):
 
548
        if direction == 'forward':
 
549
            iterate = self._iterate_rows_forward
 
550
        else:
 
551
            iterate = self._iterate_rows_backward
 
552
 
 
553
        model, sel = self._view.get_selection().get_selected()
 
554
        if sel is None:
 
555
            start = 0
 
556
        else:
 
557
            path = model.get_string_from_iter(sel)
 
558
            start = int(path)
 
559
 
 
560
        for row in iterate(model, start):
 
561
            if self._match(model, row, self._column):
 
562
                path = model.get_path(row)
 
563
                self._view.set_cursor(path)
 
564
                self._view.scroll_to_cell(path, use_align=True)
 
565
                break