~abentley/bzrtools/bzrtools.dev

# Copyright (C) 2006 Aaron Bentley

# <aaron@aaronbentley.com>

#

#    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 re

import sys

from os.path import expanduser

from bzrlib import patiencediff, trace

from bzrlib.commands import get_cmd_object

from bzrlib.patches import (hunk_from_header, InsertLine, RemoveLine,

                            ContextLine, Hunk, HunkLine)

import terminal

class LineParser(object):

    def parse_line(self, line):

        if line.startswith("@"):

            return hunk_from_header(line)

        elif line.startswith("+"):

            return InsertLine(line[1:])

        elif line.startswith("-"):

            return RemoveLine(line[1:])

        elif line.startswith(" "):

            return ContextLine(line[1:])

        else:

            return line

class DiffWriter(object):

    def __init__(self, target, check_style=False, color='always'):

        self.target = target

        self.lp = LineParser()

        self.chunks = []

        from terminal import has_ansi_colors

        if 'always' == color or ('auto' == color and has_ansi_colors()):

            self.colors = {

                'metaline':      'darkyellow',

                'plain':         'darkwhite',

                'newtext':       'darkblue',

                'oldtext':       'darkred',

                'diffstuff':     'darkgreen',

                'trailingspace': 'yellow',

                'leadingtabs':   'magenta',

                'longline':      'cyan',

            }

            self._read_colordiffrc('/etc/colordiffrc')

            self._read_colordiffrc(expanduser('~/.colordiffrc'))

        else:

            self.colors = {

                'metaline':      None,

                'plain':         None,

                'newtext':       None,

                'oldtext':       None,

                'diffstuff':     None,

                'trailingspace': None,

                'leadingtabs':   None,

                'longline':      None,

            }

        self.added_leading_tabs = 0

        self.added_trailing_whitespace = 0

        self.spurious_whitespace = 0

        self.long_lines = 0

        self.max_line_len = 79

        self._new_lines = []

        self._old_lines = []

        self.check_style = check_style

    def _read_colordiffrc(self, path):

        try:

            f = open(path, 'r')

        except IOError:

            return

        for line in f.readlines():

            try:

                key, val = line.split('=')

            except ValueError:

                continue

            key = key.strip()

            val = val.strip()

            tmp = val

            if val.startswith('dark'):

                tmp = val[4:]

            if tmp not in terminal.colors:

                continue

            self.colors[key] = val

    def colorstring(self, type, item, bad_ws_match):

        color = self.colors[type]

        if color is not None:

            if self.check_style and bad_ws_match:

                #highlight were needed

                item.contents = ''.join(terminal.colorstring(txt, color, bcol)

                    for txt, bcol in (

                        (bad_ws_match.group(1).expandtabs(),

                             self.colors['leadingtabs']),

                        (bad_ws_match.group(2)[0:self.max_line_len], None),

                        (bad_ws_match.group(2)[self.max_line_len:],

                             self.colors['longline']),

                        (bad_ws_match.group(3), self.colors['trailingspace'])

                    )) + bad_ws_match.group(4)

            string = terminal.colorstring(str(item), color)

        else:

            string = str(item)

        self.target.write(string)

    def write(self, text):

        newstuff = text.split('\n')

        for newchunk in newstuff[:-1]:

            self._writeline(''.join(self.chunks + [newchunk, '\n']))

            self.chunks = []

        self.chunks = [newstuff[-1]]

    def writelines(self, lines):

        for line in lines:

            self.write(line)

    def _writeline(self, line):

        item = self.lp.parse_line(line)

        bad_ws_match = None

        if isinstance(item, Hunk):

            line_class = 'diffstuff'

            self._analyse_old_new()

        elif isinstance(item, HunkLine):

            bad_ws_match = re.match(r'^([\t]*)(.*?)([\t ]*)(\r?\n)$',

                                    item.contents)

            has_leading_tabs = bool(bad_ws_match.group(1))

            has_trailing_whitespace = bool(bad_ws_match.group(3))

            if isinstance(item, InsertLine):

                if has_leading_tabs:

                    self.added_leading_tabs += 1

                if has_trailing_whitespace:

                    self.added_trailing_whitespace += 1

                if (len(bad_ws_match.group(2)) > self.max_line_len and

                    not item.contents.startswith('++ ')):

                    self.long_lines += 1

                line_class = 'newtext'

                self._new_lines.append(item)

            elif isinstance(item, RemoveLine):

                line_class = 'oldtext'

                self._old_lines.append(item)

            else:

                line_class = 'plain'

        elif isinstance(item, basestring) and item.startswith('==='):

            line_class = 'metaline'

            self._analyse_old_new()

        else:

            line_class = 'plain'

            self._analyse_old_new()

        self.colorstring(line_class, item, bad_ws_match)

    def flush(self):

        self.target.flush()

    @staticmethod

    def _matched_lines(old, new):

        matcher = patiencediff.PatienceSequenceMatcher(None, old, new)

        matched_lines = sum (n for i, j, n in matcher.get_matching_blocks())

        return matched_lines

    def _analyse_old_new(self):

        if (self._old_lines, self._new_lines) == ([], []):

            return

        if not self.check_style:

            return

        old = [l.contents for l in self._old_lines]

        new = [l.contents for l in self._new_lines]

        ws_matched = self._matched_lines(old, new)

        old = [l.rstrip() for l in old]

        new = [l.rstrip() for l in new]

        no_ws_matched = self._matched_lines(old, new)

        assert no_ws_matched >= ws_matched

        if no_ws_matched > ws_matched:

            self.spurious_whitespace += no_ws_matched - ws_matched

            self.target.write('^ Spurious whitespace change above.\n')

        self._old_lines, self._new_lines = ([], [])

def auto_diff_writer(output):

    return DiffWriter(output, color='auto')

def colordiff(color, check_style, *args, **kwargs):

    real_stdout = sys.stdout

    dw = DiffWriter(real_stdout, check_style, color)

    sys.stdout = dw

    try:

        get_cmd_object('diff').run(*args, **kwargs)

    finally:

        sys.stdout = real_stdout

    if check_style:

        if dw.added_leading_tabs > 0:

            trace.warning('%d new line(s) have leading tabs.' %

                          dw.added_leading_tabs)

        if dw.added_trailing_whitespace > 0:

            trace.warning('%d new line(s) have trailing whitespace.' %

                          dw.added_trailing_whitespace)

        if dw.long_lines > 0:

            trace.warning('%d new line(s) exceed(s) %d columns.' %

                          (dw.long_lines, dw.max_line_len))

        if dw.spurious_whitespace > 0:

            trace.warning('%d line(s) have spurious whitespace changes' %

                          dw.spurious_whitespace)