~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/status.py

  • Committer: Martin Pool
  • Date: 2005-07-04 08:06:51 UTC
  • Revision ID: mbp@sourcefrog.net-20050704080651-6ecec49164359e48
- track pending-merges

- unit tests for this

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
#
 
1
# (C) 2005 Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
import sys
18
 
 
19
 
from bzrlib import (
20
 
    delta as _mod_delta,
21
 
    tree,
22
 
    )
23
 
from bzrlib.diff import _raise_if_nonexistent
24
 
import bzrlib.errors as errors
25
 
from bzrlib.log import line_log
26
 
from bzrlib.osutils import is_inside_any
27
 
from bzrlib.symbol_versioning import (deprecated_function,
28
 
        zero_eight,
29
 
        )
30
 
from bzrlib.trace import warning
31
 
 
32
 
# TODO: when showing single-line logs, truncate to the width of the terminal
33
 
# if known, but only if really going to the terminal (not into a file)
34
 
 
35
 
 
36
 
@deprecated_function(zero_eight)
37
 
def show_status(branch, show_unchanged=None,
 
17
 
 
18
 
 
19
def show_status(branch, show_unchanged=False,
38
20
                specific_files=None,
39
 
                show_ids=False,
40
 
                to_file=None,
41
 
                show_pending=True,
42
 
                revision=None):
43
 
    """Display summary of changes.
44
 
 
45
 
    Please use show_tree_status instead.
46
 
 
47
 
    By default this compares the working tree to a previous revision. 
48
 
    If the revision argument is given, summarizes changes between the 
49
 
    working tree and another, or between two revisions.
50
 
 
51
 
    The result is written out as Unicode and to_file should be able 
52
 
    to encode that.
53
 
 
54
 
    show_unchanged
55
 
        If set, includes unchanged files.
 
21
                show_ids=False):
 
22
    """Display single-line status for non-ignored working files.
 
23
 
 
24
    show_all
 
25
        If true, show unmodified files too.
56
26
 
57
27
    specific_files
58
28
        If set, only show the status of files in this list.
59
 
 
60
 
    show_ids
61
 
        If set, includes each file's id.
62
 
 
63
 
    to_file
64
 
        If set, write to this file (default stdout.)
65
 
 
66
 
    show_pending
67
 
        If set, write pending merges.
68
 
 
69
 
    revision
70
 
        If None the compare latest revision with working tree
71
 
        If one revision show compared it with working tree.
72
 
        If two revisions show status between first and second.
73
 
    """
74
 
    show_tree_status(branch.bzrdir.open_workingtree(), show_unchanged, 
75
 
                     specific_files, show_ids, to_file, show_pending, revision)
76
 
 
77
 
 
78
 
def show_tree_status(wt, show_unchanged=None,
79
 
                     specific_files=None,
80
 
                     show_ids=False,
81
 
                     to_file=None,
82
 
                     show_pending=True,
83
 
                     revision=None,
84
 
                     short=False):
85
 
    """Display summary of changes.
86
 
 
87
 
    By default this compares the working tree to a previous revision. 
88
 
    If the revision argument is given, summarizes changes between the 
89
 
    working tree and another, or between two revisions.
90
 
 
91
 
    The result is written out as Unicode and to_file should be able 
92
 
    to encode that.
93
 
 
94
 
    If showing the status of a working tree, extra information is included
95
 
    about unknown files, conflicts, and pending merges.
96
 
 
97
 
    :param show_unchanged: Deprecated parameter. If set, includes unchanged 
98
 
        files.
99
 
    :param specific_files: If set, a list of filenames whose status should be
100
 
        shown.  It is an error to give a filename that is not in the working 
101
 
        tree, or in the working inventory or in the basis inventory.
102
 
    :param show_ids: If set, includes each file's id.
103
 
    :param to_file: If set, write to this file (default stdout.)
104
 
    :param show_pending: If set, write pending merges.
105
 
    :param revision: If None the compare latest revision with working tree
106
 
        If not None it must be a RevisionSpec list.
107
 
        If one revision show compared it with working tree.
108
 
        If two revisions show status between first and second.
109
 
    :param short: If True, gives short SVN-style status lines
110
 
    """
111
 
    if show_unchanged is not None:
112
 
        warn("show_status_trees with show_unchanged has been deprecated "
113
 
             "since bzrlib 0.9", DeprecationWarning, stacklevel=2)
114
 
 
115
 
    if to_file is None:
116
 
        to_file = sys.stdout
 
29
    """
 
30
    import sys
 
31
    from bzrlib.diff import compare_trees
117
32
    
118
 
    wt.lock_read()
 
33
    branch.lock_read()
119
34
    try:
120
 
        new_is_working_tree = True
121
 
        if revision is None:
122
 
            if wt.last_revision() != wt.branch.last_revision():
123
 
                warning("working tree is out of date, run 'bzr update'")
124
 
            new = wt
125
 
            old = new.basis_tree()
126
 
        elif len(revision) > 0:
127
 
            try:
128
 
                rev_id = revision[0].in_history(wt.branch).rev_id
129
 
                old = wt.branch.repository.revision_tree(rev_id)
130
 
            except errors.NoSuchRevision, e:
131
 
                raise errors.BzrCommandError(str(e))
132
 
            if (len(revision) > 1) and (revision[1].spec is not None):
133
 
                try:
134
 
                    rev_id = revision[1].in_history(wt.branch).rev_id
135
 
                    new = wt.branch.repository.revision_tree(rev_id)
136
 
                    new_is_working_tree = False
137
 
                except errors.NoSuchRevision, e:
138
 
                    raise errors.BzrCommandError(str(e))
139
 
            else:
140
 
                new = wt
141
 
        old.lock_read()
142
 
        new.lock_read()
143
 
        try:
144
 
            _raise_if_nonexistent(specific_files, old, new)
145
 
            if short:
146
 
                changes = new._iter_changes(old, show_unchanged, specific_files,
147
 
                    require_versioned=False)
148
 
                reporter = _mod_delta.ChangeReporter(old.inventory,
149
 
                    output_file=to_file)
150
 
                _mod_delta.report_changes(changes, reporter)
151
 
            else:
152
 
                delta = new.changes_from(old, want_unchanged=show_unchanged,
153
 
                                      specific_files=specific_files)
154
 
                delta.show(to_file,
155
 
                           show_ids=show_ids,
156
 
                           show_unchanged=show_unchanged,
157
 
                           short_status=short)
158
 
            short_status_letter = '? '
159
 
            if not short:
160
 
                short_status_letter = ''
161
 
            list_paths('unknown', new.unknowns(), specific_files, to_file,
162
 
                       short_status_letter)
163
 
            conflict_title = False
164
 
            # show the new conflicts only for now. XXX: get them from the delta.
165
 
            for conflict in new.conflicts():
166
 
                if not short and conflict_title is False:
167
 
                    print >> to_file, "conflicts:"
168
 
                    conflict_title = True
169
 
                if short:
170
 
                    prefix = 'C  '
171
 
                else:
172
 
                    prefix = ' '
173
 
                print >> to_file, "%s %s" % (prefix, conflict)
174
 
            if new_is_working_tree and show_pending:
175
 
                show_pending_merges(new, to_file, short)
176
 
        finally:
177
 
            old.unlock()
178
 
            new.unlock()
 
35
 
 
36
        old = branch.basis_tree()
 
37
        new = branch.working_tree()
 
38
 
 
39
        delta = compare_trees(old, new, want_unchanged=show_unchanged,
 
40
                              specific_files=specific_files)
 
41
 
 
42
        delta.show(sys.stdout, show_ids=show_ids,
 
43
                   show_unchanged=show_unchanged)
 
44
 
 
45
        unknowns = new.unknowns()
 
46
        done_header = False
 
47
        for path in unknowns:
 
48
            # FIXME: Should also match if the unknown file is within a
 
49
            # specified directory.
 
50
            if specific_files:
 
51
                if path not in specific_files:
 
52
                    continue
 
53
            if not done_header:
 
54
                print 'unknown:'
 
55
                done_header = True
 
56
            print ' ', path
179
57
    finally:
180
 
        wt.unlock()
181
 
 
182
 
def show_pending_merges(new, to_file, short=False):
183
 
    """Write out a display of pending merges in a working tree."""
184
 
    parents = new.get_parent_ids()
185
 
    if len(parents) < 2:
186
 
        return
187
 
    pending = parents[1:]
188
 
    branch = new.branch
189
 
    last_revision = parents[0]
190
 
    if not short:
191
 
        print >>to_file, 'pending merges:'
192
 
    if last_revision is not None:
193
 
        try:
194
 
            ignore = set(branch.repository.get_ancestry(last_revision))
195
 
        except errors.NoSuchRevision:
196
 
            # the last revision is a ghost : assume everything is new 
197
 
            # except for it
198
 
            ignore = set([None, last_revision])
199
 
    else:
200
 
        ignore = set([None])
201
 
    # TODO: this could be improved using merge_sorted - we'd get the same 
202
 
    # output rather than one level of indent.
203
 
    for merge in pending:
204
 
        ignore.add(merge)
205
 
        try:
206
 
            from bzrlib.osutils import terminal_width
207
 
            width = terminal_width()
208
 
            m_revision = branch.repository.get_revision(merge)
209
 
            if short:
210
 
                prefix = 'P  '
211
 
            else:
212
 
                prefix = ' '
213
 
            print >> to_file, prefix, line_log(m_revision, width - 4)
214
 
            inner_merges = branch.repository.get_ancestry(merge)
215
 
            assert inner_merges[0] is None
216
 
            inner_merges.pop(0)
217
 
            inner_merges.reverse()
218
 
            for mmerge in inner_merges:
219
 
                if mmerge in ignore:
220
 
                    continue
221
 
                mm_revision = branch.repository.get_revision(mmerge)
222
 
                if short:
223
 
                    prefix = 'P.  '
224
 
                else:
225
 
                    prefix = '   '
226
 
                print >> to_file, prefix, line_log(mm_revision, width - 5)
227
 
                ignore.add(mmerge)
228
 
        except errors.NoSuchRevision:
229
 
            if short:
230
 
                prefix = 'P  '
231
 
            else:
232
 
                prefix = ' '
233
 
            print >> to_file, prefix, merge
 
58
        branch.unlock()
234
59
        
235
 
def list_paths(header, paths, specific_files, to_file, short_status_letter=''):
236
 
    done_header = False
237
 
    for path in paths:
238
 
        if specific_files and not is_inside_any(specific_files, path):
239
 
            continue
240
 
        if not short_status_letter and not done_header:
241
 
            print >>to_file, '%s:' % header
242
 
            done_header = True
243
 
        print >>to_file, '%s  %s' % (short_status_letter, path)