Merge lp:~jelmer/brz/colordiff into lp:brz

[Jelmer Vernooij]

Add support for a --color={auto,never,always} argument to 'brz diff'.

Add support for a --color={auto,never,always} argument to 'brz diff'.

[Jelmer Vernooij (jelmer)]

review: Approve

[The Breezy Bot (the-breezy-bot)]

Running landing tests failed
https://ci.breezy-vcs.org/job/brz/job/brz-land/678/

[The Breezy Bot (the-breezy-bot)]

Running landing tests failed
https://ci.breezy-vcs.org/job/brz/job/brz-land/679/

=== modified file 'breezy/builtins.py'
--- breezy/builtins.py	2020-01-30 19:30:52 +0000
+++ breezy/builtins.py	2020-01-31 03:06:15 +0000
@@ -2335,14 +2335,27 @@
                help='How many lines of context to show.',
                type=int,
                ),
+        RegistryOption.from_kwargs(
+            'color',
+            help='Color mode to use.',
+            title='Color Mode', value_switches=False, enum_switch=True,
+            never='Never colorize output.',
+            auto='Only colorize output if terminal supports it and STDOUT is a'
+            ' TTY.',
+            always='Always colorize output (default).'),
+        Option(
+            'check-style',
+            help=('Warn if trailing whitespace or spurious changes have been'
+                  '  added.'))
         ]
+
     aliases = ['di', 'dif']
     encoding_type = 'exact'
 
     @display_command
     def run(self, revision=None, file_list=None, diff_options=None,
             prefix=None, old=None, new=None, using=None, format=None,
-            context=None):
+            context=None, color='never'):
         from .diff import (get_trees_and_branches_to_diff_locked,
                            show_diff_trees)
 
@@ -2375,7 +2388,17 @@
             file_list, revision, old, new, self._exit_stack, apply_view=True)
         # GNU diff on Windows uses ANSI encoding for filenames
         path_encoding = osutils.get_diff_header_encoding()
-        return show_diff_trees(old_tree, new_tree, self.outf,
+        outf = self.outf
+        if color == 'auto':
+            from .terminal import has_ansi_colors
+            if has_ansi_colors():
+                color = 'always'
+            else:
+                color = 'never'
+        if 'always' == color:
+            from .colordiff import DiffWriter
+            outf = DiffWriter(outf)
+        return show_diff_trees(old_tree, new_tree, outf,
                                specific_files=specific_files,
                                external_diff_options=diff_options,
                                old_label=old_label, new_label=new_label,

=== added file 'breezy/colordiff.py'
--- breezy/colordiff.py	1970-01-01 00:00:00 +0000
+++ breezy/colordiff.py	2020-01-31 03:06:15 +0000
@@ -0,0 +1,197 @@
+# Copyright (C) 2006 Aaron Bentley
+# <[e-mail]>
+#
+# 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+from __future__ import absolute_import
+
+import re
+import sys
+from os.path import expanduser
+import patiencediff
+
+from . import trace, terminal
+from .commands import get_cmd_object
+from .patches import (hunk_from_header, InsertLine, RemoveLine,
+                      ContextLine, Hunk, HunkLine)
+
+
+GLOBAL_COLORDIFFRC = '/etc/colordiffrc'
+
+class LineParser(object):
+
+    def parse_line(self, line):
+        if line.startswith(b"@"):
+            return hunk_from_header(line)
+        elif line.startswith(b"+"):
+            return InsertLine(line[1:])
+        elif line.startswith(b"-"):
+            return RemoveLine(line[1:])
+        elif line.startswith(b" "):
+            return ContextLine(line[1:])
+        else:
+            return line
+
+
+def read_colordiffrc(path):
+    colors = {}
+    with open(path, 'r') as f:
+        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
+
+            colors[key] = val
+    return colors
+
+
+class DiffWriter(object):
+
+    def __init__(self, target, check_style=False):
+        self.target = target
+        self.lp = LineParser()
+        self.chunks = []
+        self.colors = {
+            'metaline': 'darkyellow',
+            'plain': 'darkwhite',
+            'newtext': 'darkblue',
+            'oldtext': 'darkred',
+            'diffstuff': 'darkgreen',
+            'trailingspace': 'yellow',
+            'leadingtabs': 'magenta',
+            'longline': 'cyan',
+        }
+        if GLOBAL_COLORDIFFRC is not None:
+            self._read_colordiffrc(GLOBAL_COLORDIFFRC)
+        self._read_colordiffrc(expanduser('~/.colordiffrc'))
+        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:
+            self.colors.update(read_colordiffrc(path))
+        except IOError:
+            pass
+
+    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)
+            if not isinstance(item, bytes):
+                item = item.as_bytes()
+            string = terminal.colorstring(item, color)
+        else:
+            string = str(item)
+        self.target.write(string)
+
+    def write(self, text):
+        newstuff = text.split(b'\n')
+        for newchunk in newstuff[:-1]:
+            self._writeline(b''.join(self.chunks + [newchunk, b'\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(br'^([\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(b'++ ')):
+                    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, bytes) and item.startswith(b'==='):
+            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)
+        if no_ws_matched < ws_matched:
+            raise AssertionError
+        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 = ([], [])

=== added file 'breezy/terminal.py'
--- breezy/terminal.py	1970-01-01 00:00:00 +0000
+++ breezy/terminal.py	2020-01-31 03:06:15 +0000
@@ -0,0 +1,87 @@
+# Copyright (C) 2004 Aaron Bentley
+# <[e-mail]>
+#
+# 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+from __future__ import absolute_import
+
+import os
+import sys
+
+__docformat__ = "restructuredtext"
+__doc__ = "Terminal control functionality"
+
+def has_ansi_colors():
+    # XXX The whole color handling should be rewritten to use terminfo
+    # XXX before we get there, checking for setaf capability should do.
+    # XXX See terminfo(5) for all the gory details.
+    if sys.platform == "win32":
+        return False
+    if not sys.stdout.isatty():
+        return False
+    import curses
+    try:
+        curses.setupterm()
+    except curses.error:
+        return False
+    return bool(curses.tigetstr('setaf'))
+
+colors = {
+    "black": b"0",
+    "red": b"1",
+    "green": b"2",
+    "yellow": b"3",
+    "blue": b"4",
+    "magenta": b"5",
+    "cyan": b"6",
+    "white": b"7"
+}
+
+def colorstring(text, fgcolor=None, bgcolor=None):
+    """
+    Returns a string using ANSI control codes to set the text color.
+
+    :param text: The text to set the color for.
+    :type text: string
+    :param fgcolor: The foreground color to use
+    :type fgcolor: string
+    :param bgcolor: The background color to use
+    :type bgcolor: string
+    """
+    code = []
+
+    if fgcolor:
+        if fgcolor.startswith('dark'):
+            code.append(b'0')
+            fgcolor = fgcolor[4:]
+        else:
+            code.append(b'1')
+
+        code.append(b'3' + colors[fgcolor])
+
+    if bgcolor:
+        code.append(b'4' + colors[bgcolor])
+
+    return b"".join((b"\033[", b';'.join(code), b"m", text, b"\033[0m"))
+
+
+def term_title(title):
+    term = os.environ.get('TERM', '')
+    if term.startswith('xterm') or term == 'dtterm':
+        return "\033]0;%s\007" % title
+    return str()
+
+
+# arch-tag: a79b9993-146e-4a51-8bae-a13791703ddd

=== modified file 'breezy/tests/blackbox/test_diff.py'
--- breezy/tests/blackbox/test_diff.py	2019-07-07 18:59:49 +0000
+++ breezy/tests/blackbox/test_diff.py	2020-01-31 03:06:15 +0000
@@ -269,6 +269,28 @@
                              "+contents of branch1/file\n"
                              "\n", subst_dates(out))
 
+    def test_diff_color_always(self):
+        from ...terminal import colorstring
+        from ... import colordiff
+        self.overrideAttr(colordiff, 'GLOBAL_COLORDIFFRC', None)
+        self.example_branches()
+        branch2_tree = workingtree.WorkingTree.open_containing('branch2')[0]
+        self.build_tree_contents([('branch2/file', b'even newer content')])
+        branch2_tree.commit(message='update file once more')
+
+        out, err = self.run_bzr('diff --color=always -r revno:2:branch2..revno:1:branch1',
+                                retcode=1)
+        self.assertEqual('', err)
+        self.assertEqualDiff((
+            colorstring(b"=== modified file 'file'\n", 'darkyellow') +
+            colorstring(b"--- old/file\tYYYY-MM-DD HH:MM:SS +ZZZZ\n", 'darkred') +
+            colorstring(b"+++ new/file\tYYYY-MM-DD HH:MM:SS +ZZZZ\n", 'darkblue') +
+            colorstring(b"@@ -1 +1 @@\n", 'darkgreen') +
+            colorstring(b"-new content\n", 'darkred') +
+            colorstring(b"+contents of branch1/file\n", 'darkblue') +
+            colorstring(b"\n", 'darkwhite')).decode(),
+            subst_dates(out))
+
     def example_branch2(self):
         branch1_tree = self.make_branch_and_tree('branch1')
         self.build_tree_contents([('branch1/file1', b'original line\n')])

=== modified file 'doc/en/release-notes/brz-3.1.txt'
--- doc/en/release-notes/brz-3.1.txt	2020-01-30 17:54:42 +0000
+++ doc/en/release-notes/brz-3.1.txt	2020-01-31 03:06:15 +0000
@@ -46,6 +46,11 @@
    have installed and speeds up import time since psutil brings in
    various other modules. (Jelmer Vernooij)
 
+ * ``brz diff`` now has a --color argument that can write
+   color diff output. This is based on the cdiff code in
+   bzrtools by Aaron Bentley.
+   (Jelmer Vernooij, #376594)
+
  * Information about tree references can now be updated on remote
    branches. (Jelmer Vernooij)