1
# Copyright (C) 2005-2010 Canonical Ltd
1
# Copyright (C) 2004, 2005, 2006, 2007 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
31
from bzrlib.lazy_import import lazy_import
32
lazy_import(globals(), """
33
31
from bzrlib import (
42
37
from bzrlib.config import extract_email_address
43
38
from bzrlib.repository import _strip_NULL_ghosts
44
from bzrlib.revision import (
48
from bzrlib.symbol_versioning import (
54
@deprecated_function(deprecated_in((2, 4, 0)))
39
from bzrlib.revision import CURRENT_REVISION, Revision
55
42
def annotate_file(branch, rev_id, file_id, verbose=False, full=False,
56
43
to_file=None, show_ids=False):
57
44
"""Annotate file_id at revision rev_id in branch.
69
56
:param show_ids: Show revision ids in the annotation output.
71
tree = branch.repository.revision_tree(rev_id)
72
annotate_file_tree(tree, file_id, to_file, verbose=verbose,
73
full=full, show_ids=show_ids, branch=branch)
61
# Handle the show_ids case
62
annotations = _annotations(branch.repository, file_id, rev_id)
64
return _show_id_annotations(annotations, to_file, full)
66
# Calculate the lengths of the various columns
67
annotation = list(_expand_annotations(annotations, branch))
68
_print_annotations(annotation, verbose, to_file, full)
76
71
def annotate_file_tree(tree, file_id, to_file, verbose=False, full=False,
77
show_ids=False, branch=None):
78
73
"""Annotate file_id in a tree.
80
75
The tree should already be read_locked() when annotate_file_tree is called.
86
81
reasonable text width.
87
82
:param full: XXXX Not sure what this does.
88
83
:param show_ids: Show revision ids in the annotation output.
89
:param branch: Branch to use for revision revno lookups
85
rev_id = tree.last_revision()
96
88
# Handle the show_ids case
97
89
annotations = list(tree.annotate_iter(file_id))
99
91
return _show_id_annotations(annotations, to_file, full)
101
if not getattr(tree, "get_revision_id", False):
102
# Create a virtual revision to represent the current tree state.
103
# Should get some more pending commit attributes, like pending tags,
105
current_rev = Revision(CURRENT_REVISION)
106
current_rev.parent_ids = tree.get_parent_ids()
108
current_rev.committer = branch.get_config().username()
109
except errors.NoWhoami:
110
current_rev.committer = 'local user'
111
current_rev.message = "?"
112
current_rev.timestamp = round(time.time(), 3)
113
current_rev.timezone = osutils.local_time_offset()
116
annotation = list(_expand_annotations(annotations, branch,
93
# Create a virtual revision to represent the current tree state.
94
# Should get some more pending commit attributes, like pending tags,
96
current_rev = Revision(CURRENT_REVISION)
97
current_rev.parent_ids = tree.get_parent_ids()
98
current_rev.committer = tree.branch.get_config().username()
99
current_rev.message = "?"
100
current_rev.timestamp = round(time.time(), 3)
101
current_rev.timezone = osutils.local_time_offset()
102
annotation = list(_expand_annotations(annotations, tree.branch,
118
104
_print_annotations(annotation, verbose, to_file, full)
168
def _annotations(repo, file_id, rev_id):
169
"""Return the list of (origin_revision_id, line_text) for a revision of a file in a repository."""
170
annotations = repo.texts.annotate((file_id, rev_id))
172
return [(key[-1], line) for (key, line) in annotations]
182
175
def _expand_annotations(annotations, branch, current_rev=None):
183
176
"""Expand a file's annotations into command line UI ready tuples.
192
185
repository = branch.repository
193
186
if current_rev is not None:
194
# This can probably become a function on MutableTree, get_revno_map
195
# there, or something.
187
# This can probably become a function on MutableTree, get_revno_map there,
196
189
last_revision = current_rev.revision_id
197
190
# XXX: Partially Cloned from branch, uses the old_get_graph, eep.
198
# XXX: The main difficulty is that we need to inject a single new node
199
# (current_rev) into the graph before it gets numbered, etc.
200
# Once KnownGraph gets an 'add_node()' function, we can use
201
# VF.get_known_graph_ancestry().
202
191
graph = repository.get_graph()
203
192
revision_graph = dict(((key, value) for key, value in
204
193
graph.iter_ancestry(current_rev.parent_ids) if value is not None))
321
310
def _get_matching_blocks(old, new):
322
matcher = patiencediff.PatienceSequenceMatcher(None, old, new)
311
matcher = patiencediff.PatienceSequenceMatcher(None,
323
313
return matcher.get_matching_blocks()
326
_break_annotation_tie = None
328
def _old_break_annotation_tie(annotated_lines):
329
"""Chose an attribution between several possible ones.
331
:param annotated_lines: A list of tuples ((file_id, rev_id), line) where
332
the lines are identical but the revids different while no parent
333
relation exist between them
335
:return : The "winning" line. This must be one with a revid that
336
guarantees that further criss-cross merges will converge. Failing to
337
do so have performance implications.
339
# sort lexicographically so that we always get a stable result.
341
# TODO: while 'sort' is the easiest (and nearly the only possible solution)
342
# with the current implementation, chosing the oldest revision is known to
343
# provide better results (as in matching user expectations). The most
344
# common use case being manual cherry-pick from an already existing
346
return sorted(annotated_lines)[0]
349
316
def _find_matching_unannotated_lines(output_lines, plain_child_lines,
350
317
child_lines, start_child, end_child,
351
318
right_lines, start_right, end_right,
356
323
:param plain_child_lines: The unannotated new lines for the child text
357
324
:param child_lines: Lines for the child text which have been annotated
358
325
for the left parent
360
:param start_child: Position in plain_child_lines and child_lines to start
362
:param end_child: Last position in plain_child_lines and child_lines to
326
:param start_child: Position in plain_child_lines and child_lines to start the
328
:param end_child: Last position in plain_child_lines and child_lines to search
364
330
:param right_lines: The annotated lines for the whole text for the right
366
332
:param start_right: Position in right_lines to start the match
402
368
if len(heads) == 1:
403
369
output_append((iter(heads).next(), left[1]))
405
# Both claim different origins, get a stable result.
406
# If the result is not stable, there is a risk a
407
# performance degradation as criss-cross merges will
408
# flip-flop the attribution.
409
if _break_annotation_tie is None:
411
_old_break_annotation_tie([left, right]))
413
output_append(_break_annotation_tie([left, right]))
371
# Both claim different origins, sort lexicographically
372
# so that we always get a stable result.
373
output_append(sorted([left, right])[0])
414
374
last_child_idx = child_idx + match_len
440
400
matching_left_and_right = _get_matching_blocks(right_parent_lines,
442
402
for right_idx, left_idx, match_len in matching_left_and_right:
443
# annotated lines from last_left_idx to left_idx did not match the
444
# lines from last_right_idx to right_idx, the raw lines should be
445
# compared to determine what annotations need to be updated
403
# annotated lines from last_left_idx to left_idx did not match the lines from
405
# to right_idx, the raw lines should be compared to determine what annotations
446
407
if last_right_idx == right_idx or last_left_idx == left_idx:
447
408
# One of the sides is empty, so this is a pure insertion
448
409
lines_extend(annotated_lines[last_left_idx:left_idx])
460
421
# If left and right agree on a range, just push that into the output
461
422
lines_extend(annotated_lines[left_idx:left_idx + match_len])
466
from bzrlib._annotator_pyx import Annotator
467
except ImportError, e:
468
osutils.failed_to_load_extension(e)
469
from bzrlib._annotator_py import Annotator