~bzr-pqm/bzr/bzr.dev

# Copyright (C) 2005, 2006 Canonical Ltd

#

# This program is free software; you can redistribute it and/or modify

# it under the terms of the GNU General Public License as published by

# the Free Software Foundation; either version 2 of the License, or

# (at your option) any later version.

#

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU General Public License for more details.

#

# You should have received a copy of the GNU General Public License

# along with this program; if not, write to the Free Software

# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

import sys

from bzrlib.diff import _raise_if_nonexistent

import bzrlib.errors as errors

from bzrlib.log import line_log

from bzrlib.osutils import is_inside_any

from bzrlib.symbol_versioning import (deprecated_function,

        zero_eight,

        )

from bzrlib.trace import warning

# TODO: when showing single-line logs, truncate to the width of the terminal

# if known, but only if really going to the terminal (not into a file)

@deprecated_function(zero_eight)

def show_status(branch, show_unchanged=None,

                specific_files=None,

                show_ids=False,

                to_file=None,

                show_pending=True,

                revision=None):

    """Display summary of changes.

    Please use show_tree_status instead.

    By default this compares the working tree to a previous revision. 

    If the revision argument is given, summarizes changes between the 

    working tree and another, or between two revisions.

    The result is written out as Unicode and to_file should be able 

    to encode that.

    show_unchanged

        If set, includes unchanged files.

    specific_files

        If set, only show the status of files in this list.

    show_ids

        If set, includes each file's id.

    to_file

        If set, write to this file (default stdout.)

    show_pending

        If set, write pending merges.

    revision

        If None the compare latest revision with working tree

        If one revision show compared it with working tree.

        If two revisions show status between first and second.

    """

    show_tree_status(branch.bzrdir.open_workingtree(), show_unchanged, 

                     specific_files, show_ids, to_file, show_pending, revision)

def show_tree_status(wt, show_unchanged=None,

                     specific_files=None,

                     show_ids=False,

                     to_file=None,

                     show_pending=True,

                     revision=None,

                     short=False):

    """Display summary of changes.

    By default this compares the working tree to a previous revision. 

    If the revision argument is given, summarizes changes between the 

    working tree and another, or between two revisions.

    The result is written out as Unicode and to_file should be able 

    to encode that.

    If showing the status of a working tree, extra information is included

    about unknown files, conflicts, and pending merges.

    :param show_unchanged: Deprecated parameter. If set, includes unchanged 

        files.

    :param specific_files: If set, a list of filenames whose status should be

        shown.  It is an error to give a filename that is not in the working 

        tree, or in the working inventory or in the basis inventory.

    :param show_ids: If set, includes each file's id.

    :param to_file: If set, write to this file (default stdout.)

    :param show_pending: If set, write pending merges.

    :param revision: If None the compare latest revision with working tree

        If not None it must be a RevisionSpec list.

        If one revision show compared it with working tree.

        If two revisions show status between first and second.

    :param short: If True, gives short SVN-style status lines

    """

    if show_unchanged is not None:

        warn("show_status_trees with show_unchanged has been deprecated "

             "since bzrlib 0.9", DeprecationWarning, stacklevel=2)

    if to_file is None:

        to_file = sys.stdout

    wt.lock_read()

    try:

        new_is_working_tree = True

        if revision is None:

            if wt.last_revision() != wt.branch.last_revision():

                warning("working tree is out of date, run 'bzr update'")

            new = wt

            old = new.basis_tree()

        elif len(revision) > 0:

            try:

                rev_id = revision[0].in_history(wt.branch).rev_id

                old = wt.branch.repository.revision_tree(rev_id)

            except errors.NoSuchRevision, e:

                raise errors.BzrCommandError(str(e))

            if (len(revision) > 1) and (revision[1].spec is not None):

                try:

                    rev_id = revision[1].in_history(wt.branch).rev_id

                    new = wt.branch.repository.revision_tree(rev_id)

                    new_is_working_tree = False

                except errors.NoSuchRevision, e:

                    raise errors.BzrCommandError(str(e))

            else:

                new = wt

        _raise_if_nonexistent(specific_files, old, new)

        delta = new.changes_from(old, want_unchanged=show_unchanged,

                              specific_files=specific_files)

        delta.show(to_file,

                   show_ids=show_ids,

                   show_unchanged=show_unchanged,

                   short_status=short)

        short_status_letter = '?'

        if not short:

            short_status_letter = ''

        list_paths('unknown', new.unknowns(), specific_files, to_file,

                   short_status_letter)

        conflict_title = False

        # show the new conflicts only for now. XXX: get them from the delta.

        for conflict in new.conflicts():

            if not short and conflict_title is False:

                print >> to_file, "conflicts:"

                conflict_title = True

            if short:

                prefix = 'C '

            else:

                prefix = ' '

            print >> to_file, "%s %s" % (prefix, conflict)

        if new_is_working_tree and show_pending:

            show_pending_merges(new, to_file, short)

    finally:

        wt.unlock()

def show_pending_merges(new, to_file, short=False):

    """Write out a display of pending merges in a working tree."""

    parents = new.get_parent_ids()

    if len(parents) < 2:

        return

    pending = parents[1:]

    branch = new.branch

    last_revision = parents[0]

    if not short:

        print >>to_file, 'pending merges:'

    if last_revision is not None:

        try:

            ignore = set(branch.repository.get_ancestry(last_revision))

        except errors.NoSuchRevision:

            # the last revision is a ghost : assume everything is new 

            # except for it

            ignore = set([None, last_revision])

    else:

        ignore = set([None])

    # TODO: this could be improved using merge_sorted - we'd get the same 

    # output rather than one level of indent.

    for merge in pending:

        ignore.add(merge)

        try:

            from bzrlib.osutils import terminal_width

            width = terminal_width()

            m_revision = branch.repository.get_revision(merge)

            if short:

                prefix = 'P '

            else:

                prefix = ' '

            print >> to_file, prefix, line_log(m_revision, width - 4)

            inner_merges = branch.repository.get_ancestry(merge)

            assert inner_merges[0] is None

            inner_merges.pop(0)

            inner_merges.reverse()

            for mmerge in inner_merges:

                if mmerge in ignore:

                    continue

                mm_revision = branch.repository.get_revision(mmerge)

                if short:

                    prefix = 'P. '

                else:

                    prefix = '   '

                print >> to_file, prefix, line_log(mm_revision, width - 5)

                ignore.add(mmerge)

        except errors.NoSuchRevision:

            if short:

                prefix = 'P '

            else:

                prefix = ' '

            print >> to_file, prefix, merge

def list_paths(header, paths, specific_files, to_file, short_status_letter=''):

    done_header = False

    for path in paths:

        if specific_files and not is_inside_any(specific_files, path):

            continue

        if not short_status_letter and not done_header:

            print >>to_file, '%s:' % header

            done_header = True

        print >>to_file, '%s  %s' % (short_status_letter, path)