13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
17
"""File annotate based on weave storage"""
19
19
# TODO: Choice of more or less verbose formats:
21
21
# interposed: show more details between blocks of modified lines
23
23
# TODO: Show which revision caused a line to merge into the parent
25
25
# TODO: perhaps abbreviate timescales depending on how recent they are
26
# e.g. "3:12 Tue", "13 Oct", "Oct 2005", etc.
26
# e.g. "3:12 Tue", "13 Oct", "Oct 2005", etc.
57
59
to_file = sys.stdout
59
61
# Handle the show_ids case
62
annotations = _annotations(branch.repository, file_id, rev_id)
62
annotations = _annotations(branch.repository, file_id, rev_id)
63
max_origin_len = max(len(origin) for origin, text in annotations)
64
for origin, text in annotations:
65
if full or last_rev_id != origin:
69
to_file.write('%*s | %s' % (max_origin_len, this, text))
64
return _show_id_annotations(annotations, to_file, full)
73
66
# Calculate the lengths of the various columns
74
annotation = list(_annotate_file(branch, rev_id, file_id))
67
annotation = list(_expand_annotations(annotations, branch))
68
_print_annotations(annotation, verbose, to_file, full)
71
def annotate_file_tree(tree, file_id, to_file, verbose=False, full=False,
73
"""Annotate file_id in a tree.
75
The tree should already be read_locked() when annotate_file_tree is called.
77
:param tree: The tree to look for revision numbers and history from.
78
:param file_id: The file_id to annotate.
79
:param to_file: The file to output the annotation to.
80
:param verbose: Show all details rather than truncating to ensure
81
reasonable text width.
82
:param full: XXXX Not sure what this does.
83
:param show_ids: Show revision ids in the annotation output.
85
rev_id = tree.last_revision()
88
# Handle the show_ids case
89
annotations = list(tree.annotate_iter(file_id))
91
return _show_id_annotations(annotations, to_file, full)
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,
104
_print_annotations(annotation, verbose, to_file, full)
107
def _print_annotations(annotation, verbose, to_file, full):
108
"""Print annotations to to_file.
110
:param to_file: The file to output the annotation to.
111
:param verbose: Show all details rather than truncating to ensure
112
reasonable text width.
113
:param full: XXXX Not sure what this does.
75
115
if len(annotation) == 0:
76
116
max_origin_len = max_revno_len = max_revid_len = 0
153
def _show_id_annotations(annotations, to_file, full):
157
max_origin_len = max(len(origin) for origin, text in annotations)
158
for origin, text in annotations:
159
if full or last_rev_id != origin:
163
to_file.write('%*s | %s' % (max_origin_len, this, text))
113
168
def _annotations(repo, file_id, rev_id):
114
169
"""Return the list of (origin_revision_id, line_text) for a revision of a file in a repository."""
115
170
annotations = repo.texts.annotate((file_id, rev_id))
117
172
return [(key[-1], line) for (key, line) in annotations]
120
def _annotate_file(branch, rev_id, file_id):
121
"""Yield the origins for each line of a file.
123
This includes detailed information, such as the author name, and
124
date string for the commit, rather than just the revision id.
175
def _expand_annotations(annotations, branch, current_rev=None):
176
"""Expand a file's annotations into command line UI ready tuples.
178
Each tuple includes detailed information, such as the author name, and date
179
string for the commit, rather than just the revision id.
181
:param annotations: The annotations to expand.
182
:param revision_id_to_revno: A map from id to revision numbers.
183
:param branch: A locked branch to query for revision details.
126
revision_id_to_revno = branch.get_revision_id_to_revno_map()
127
annotations = _annotations(branch.repository, file_id, rev_id)
185
repository = branch.repository
186
if current_rev is not None:
187
# This can probably become a function on MutableTree, get_revno_map there,
189
last_revision = current_rev.revision_id
190
# XXX: Partially Cloned from branch, uses the old_get_graph, eep.
191
# XXX: The main difficulty is that we need to inject a single new node
192
# (current_rev) into the graph before it gets numbered, etc.
193
# Once KnownGraph gets an 'add_node()' function, we can use
194
# VF.get_known_graph_ancestry().
195
graph = repository.get_graph()
196
revision_graph = dict(((key, value) for key, value in
197
graph.iter_ancestry(current_rev.parent_ids) if value is not None))
198
revision_graph = _strip_NULL_ghosts(revision_graph)
199
revision_graph[last_revision] = current_rev.parent_ids
200
merge_sorted_revisions = tsort.merge_sort(
205
revision_id_to_revno = dict((rev_id, revno)
206
for seq_num, rev_id, depth, revno, end_of_merge in
207
merge_sorted_revisions)
209
revision_id_to_revno = branch.get_revision_id_to_revno_map()
128
210
last_origin = None
129
211
revision_ids = set(o for o, t in annotations)
130
revision_ids = [o for o in revision_ids if
131
branch.repository.has_revision(o)]
132
revisions = dict((r.revision_id, r) for r in
133
branch.repository.get_revisions(revision_ids))
213
if CURRENT_REVISION in revision_ids:
214
revision_id_to_revno[CURRENT_REVISION] = (
215
"%d?" % (branch.revno() + 1),)
216
revisions[CURRENT_REVISION] = current_rev
217
revision_ids = [o for o in revision_ids if
218
repository.has_revision(o)]
219
revisions.update((r.revision_id, r) for r in
220
repository.get_revisions(revision_ids))
134
221
for origin, text in annotations:
135
222
text = text.rstrip('\r\n')
136
223
if origin == last_origin:
230
317
return matcher.get_matching_blocks()
320
_break_annotation_tie = None
322
def _old_break_annotation_tie(annotated_lines):
323
"""Chose an attribution between several possible ones.
325
:param annotated_lines: A list of tuples ((file_id, rev_id), line) where
326
the lines are identical but the revids different while no parent
327
relation exist between them
329
:return : The "winning" line. This must be one with a revid that
330
guarantees that further criss-cross merges will converge. Failing to
331
do so have performance implications.
333
# sort lexicographically so that we always get a stable result.
335
# TODO: while 'sort' is the easiest (and nearly the only possible solution)
336
# with the current implementation, chosing the oldest revision is known to
337
# provide better results (as in matching user expectations). The most
338
# common use case being manual cherry-pick from an already existing
340
return sorted(annotated_lines)[0]
233
343
def _find_matching_unannotated_lines(output_lines, plain_child_lines,
234
344
child_lines, start_child, end_child,
235
345
right_lines, start_right, end_right,
285
396
if len(heads) == 1:
286
397
output_append((iter(heads).next(), left[1]))
288
# Both claim different origins, sort lexicographically
289
# so that we always get a stable result.
290
output_append(sorted([left, right])[0])
399
# Both claim different origins, get a stable result.
400
# If the result is not stable, there is a risk a
401
# performance degradation as criss-cross merges will
402
# flip-flop the attribution.
403
if _break_annotation_tie is None:
405
_old_break_annotation_tie([left, right]))
407
output_append(_break_annotation_tie([left, right]))
291
408
last_child_idx = child_idx + match_len
317
434
matching_left_and_right = _get_matching_blocks(right_parent_lines,
319
436
for right_idx, left_idx, match_len in matching_left_and_right:
320
# annotated lines from last_left_idx to left_idx did not match the lines from
322
# to right_idx, the raw lines should be compared to determine what annotations
437
# annotated lines from last_left_idx to left_idx did not match the
438
# lines from last_right_idx to right_idx, the raw lines should be
439
# compared to determine what annotations need to be updated
324
440
if last_right_idx == right_idx or last_left_idx == left_idx:
325
441
# One of the sides is empty, so this is a pure insertion
326
442
lines_extend(annotated_lines[last_left_idx:left_idx])
added
removed
bzrlib/annotate.py
