~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/annotate.py

Initial commit for russian version of documents.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2004, 2005, 2006, 2007 Canonical Ltd
2
2
#
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
12
12
#
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""File annotate based on weave storage"""
18
18
 
19
19
# TODO: Choice of more or less verbose formats:
20
 
#
 
20
21
21
# interposed: show more details between blocks of modified lines
22
22
 
23
23
# TODO: Show which revision caused a line to merge into the parent
24
24
 
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.  
27
27
 
28
28
import sys
29
29
import time
35
35
    tsort,
36
36
    )
37
37
from bzrlib.config import extract_email_address
38
 
from bzrlib.repository import _strip_NULL_ghosts
39
 
from bzrlib.revision import CURRENT_REVISION, Revision
40
38
 
41
39
 
42
40
def annotate_file(branch, rev_id, file_id, verbose=False, full=False,
59
57
        to_file = sys.stdout
60
58
 
61
59
    # Handle the show_ids case
62
 
    annotations = _annotations(branch.repository, file_id, rev_id)
 
60
    last_rev_id = None
63
61
    if show_ids:
64
 
        return _show_id_annotations(annotations, to_file, full)
 
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:
 
66
                this = origin
 
67
            else:
 
68
                this = ''
 
69
            to_file.write('%*s | %s' % (max_origin_len, this, text))
 
70
            last_rev_id = origin
 
71
        return
65
72
 
66
73
    # Calculate the lengths of the various columns
67
 
    annotation = list(_expand_annotations(annotations, branch))
68
 
    _print_annotations(annotation, verbose, to_file, full)
69
 
 
70
 
 
71
 
def annotate_file_tree(tree, file_id, to_file, verbose=False, full=False,
72
 
    show_ids=False):
73
 
    """Annotate file_id in a tree.
74
 
 
75
 
    The tree should already be read_locked() when annotate_file_tree is called.
76
 
 
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.
84
 
    """
85
 
    rev_id = tree.last_revision()
86
 
    branch = tree.branch
87
 
 
88
 
    # Handle the show_ids case
89
 
    annotations = list(tree.annotate_iter(file_id))
90
 
    if show_ids:
91
 
        return _show_id_annotations(annotations, to_file, full)
92
 
 
93
 
    # Create a virtual revision to represent the current tree state.
94
 
    # Should get some more pending commit attributes, like pending tags,
95
 
    # bugfixes etc.
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,
103
 
        current_rev))
104
 
    _print_annotations(annotation, verbose, to_file, full)
105
 
 
106
 
 
107
 
def _print_annotations(annotation, verbose, to_file, full):
108
 
    """Print annotations to to_file.
109
 
 
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.
114
 
    """
 
74
    annotation = list(_annotate_file(branch, rev_id, file_id))
115
75
    if len(annotation) == 0:
116
76
        max_origin_len = max_revno_len = max_revid_len = 0
117
77
    else:
150
110
        prevanno = anno
151
111
 
152
112
 
153
 
def _show_id_annotations(annotations, to_file, full):
154
 
    if not annotations:
155
 
        return
156
 
    last_rev_id = None
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:
160
 
            this = origin
161
 
        else:
162
 
            this = ''
163
 
        to_file.write('%*s | %s' % (max_origin_len, this, text))
164
 
        last_rev_id = origin
165
 
    return
166
 
 
167
 
 
168
113
def _annotations(repo, file_id, rev_id):
169
114
    """Return the list of (origin_revision_id, line_text) for a revision of a file in a repository."""
170
115
    annotations = repo.texts.annotate((file_id, rev_id))
171
 
    #
 
116
    # 
172
117
    return [(key[-1], line) for (key, line) in annotations]
173
118
 
174
119
 
175
 
def _expand_annotations(annotations, branch, current_rev=None):
176
 
    """Expand a file's annotations into command line UI ready tuples.
177
 
 
178
 
    Each tuple includes detailed information, such as the author name, and date
179
 
    string for the commit, rather than just the revision id.
180
 
 
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.
 
120
def _annotate_file(branch, rev_id, file_id):
 
121
    """Yield the origins for each line of a file.
 
122
 
 
123
    This includes detailed information, such as the author name, and
 
124
    date string for the commit, rather than just the revision id.
184
125
    """
185
 
    repository = branch.repository
186
 
    if current_rev is not None:
187
 
        # This can probably become a function on MutableTree, get_revno_map there,
188
 
        # or something.
189
 
        last_revision = current_rev.revision_id
190
 
        # XXX: Partially Cloned from branch, uses the old_get_graph, eep.
191
 
        graph = repository.get_graph()
192
 
        revision_graph = dict(((key, value) for key, value in
193
 
            graph.iter_ancestry(current_rev.parent_ids) if value is not None))
194
 
        revision_graph = _strip_NULL_ghosts(revision_graph)
195
 
        revision_graph[last_revision] = current_rev.parent_ids
196
 
        merge_sorted_revisions = tsort.merge_sort(
197
 
            revision_graph,
198
 
            last_revision,
199
 
            None,
200
 
            generate_revno=True)
201
 
        revision_id_to_revno = dict((rev_id, revno)
202
 
            for seq_num, rev_id, depth, revno, end_of_merge in
203
 
                merge_sorted_revisions)
204
 
    else:
205
 
        revision_id_to_revno = branch.get_revision_id_to_revno_map()
 
126
    revision_id_to_revno = branch.get_revision_id_to_revno_map()
 
127
    annotations = _annotations(branch.repository, file_id, rev_id)
206
128
    last_origin = None
207
129
    revision_ids = set(o for o, t in annotations)
208
 
    revisions = {}
209
 
    if CURRENT_REVISION in revision_ids:
210
 
        revision_id_to_revno[CURRENT_REVISION] = (
211
 
            "%d?" % (branch.revno() + 1),)
212
 
        revisions[CURRENT_REVISION] = current_rev
213
 
    revision_ids = [o for o in revision_ids if
214
 
                    repository.has_revision(o)]
215
 
    revisions.update((r.revision_id, r) for r in
216
 
                     repository.get_revisions(revision_ids))
 
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))
217
134
    for origin, text in annotations:
218
135
        text = text.rstrip('\r\n')
219
136
        if origin == last_origin:
231
148
                                     time.gmtime(rev.timestamp + tz))
232
149
            # a lazy way to get something like the email address
233
150
            # TODO: Get real email address
234
 
            author = rev.get_apparent_authors()[0]
 
151
            author = rev.get_apparent_author()
235
152
            try:
236
153
                author = extract_email_address(author)
237
154
            except errors.NoEmailInUsername:
243
160
               _left_matching_blocks=None,
244
161
               heads_provider=None):
245
162
    """Create a new annotated version from new lines and parent annotations.
246
 
 
 
163
    
247
164
    :param parents_lines: List of annotated lines for all parents
248
165
    :param new_lines: The un-annotated new lines
249
166
    :param new_revision_id: The revision-id to associate with new lines
252
169
        between the text and its left-hand-parent.  The format is
253
170
        the SequenceMatcher.get_matching_blocks format
254
171
        (start_left, start_right, length_of_match).
255
 
    :param heads_provider: An object which provides a .heads() call to resolve
 
172
    :param heads_provider: An object which provids a .heads() call to resolve
256
173
        if any revision ids are children of others.
257
174
        If None, then any ancestry disputes will be resolved with
258
175
        new_revision_id
313
230
    return matcher.get_matching_blocks()
314
231
 
315
232
 
316
 
_break_annotation_tie = None
317
 
 
318
 
def _old_break_annotation_tie(annotated_lines):
319
 
    """Chose an attribution between several possible ones.
320
 
 
321
 
    :param annotated_lines: A list of tuples ((file_id, rev_id), line) where
322
 
        the lines are identical but the revids different while no parent
323
 
        relation exist between them
324
 
 
325
 
     :return : The "winning" line. This must be one with a revid that
326
 
         guarantees that further criss-cross merges will converge. Failing to
327
 
         do so have performance implications.
328
 
    """
329
 
    # sort lexicographically so that we always get a stable result.
330
 
 
331
 
    # TODO: while 'sort' is the easiest (and nearly the only possible solution)
332
 
    # with the current implementation, chosing the oldest revision is known to
333
 
    # provide better results (as in matching user expectations). The most
334
 
    # common use case being manual cherry-pick from an already existing
335
 
    # revision.
336
 
    return sorted(annotated_lines)[0]
337
 
 
338
 
 
339
233
def _find_matching_unannotated_lines(output_lines, plain_child_lines,
340
234
                                     child_lines, start_child, end_child,
341
235
                                     right_lines, start_right, end_right,
346
240
    :param plain_child_lines: The unannotated new lines for the child text
347
241
    :param child_lines: Lines for the child text which have been annotated
348
242
        for the left parent
349
 
 
350
 
    :param start_child: Position in plain_child_lines and child_lines to start
351
 
        the match searching
352
 
    :param end_child: Last position in plain_child_lines and child_lines to
353
 
        search for a match
 
243
    :param start_child: Position in plain_child_lines and child_lines to start the
 
244
        match searching
 
245
    :param end_child: Last position in plain_child_lines and child_lines to search
 
246
        for a match
354
247
    :param right_lines: The annotated lines for the whole text for the right
355
248
        parent
356
249
    :param start_right: Position in right_lines to start the match
392
285
                    if len(heads) == 1:
393
286
                        output_append((iter(heads).next(), left[1]))
394
287
                    else:
395
 
                        # Both claim different origins, get a stable result.
396
 
                        # If the result is not stable, there is a risk a
397
 
                        # performance degradation as criss-cross merges will
398
 
                        # flip-flop the attribution.
399
 
                        if _break_annotation_tie is None:
400
 
                            output_append(
401
 
                                _old_break_annotation_tie([left, right]))
402
 
                        else:
403
 
                            output_append(_break_annotation_tie([left, right]))
 
288
                        # Both claim different origins, sort lexicographically
 
289
                        # so that we always get a stable result.
 
290
                        output_append(sorted([left, right])[0])
404
291
        last_child_idx = child_idx + match_len
405
292
 
406
293
 
430
317
    matching_left_and_right = _get_matching_blocks(right_parent_lines,
431
318
                                                   annotated_lines)
432
319
    for right_idx, left_idx, match_len in matching_left_and_right:
433
 
        # annotated lines from last_left_idx to left_idx did not match the
434
 
        # lines from last_right_idx to right_idx, the raw lines should be
435
 
        # compared to determine what annotations need to be updated
 
320
        # annotated lines from last_left_idx to left_idx did not match the lines from
 
321
        # last_right_idx
 
322
        # to right_idx, the raw lines should be compared to determine what annotations
 
323
        # need to be updated
436
324
        if last_right_idx == right_idx or last_left_idx == left_idx:
437
325
            # One of the sides is empty, so this is a pure insertion
438
326
            lines_extend(annotated_lines[last_left_idx:left_idx])
450
338
        # If left and right agree on a range, just push that into the output
451
339
        lines_extend(annotated_lines[left_idx:left_idx + match_len])
452
340
    return lines
453
 
 
454
 
 
455
 
try:
456
 
    from bzrlib._annotator_pyx import Annotator
457
 
except ImportError:
458
 
    from bzrlib._annotator_py import Annotator