color.py
482 lines
| 17.1 KiB
| text/x-python
|
PythonLexer
/ hgext / color.py
|
r5787 | # color.py color output for the status and qseries commands | ||
# | ||||
# Copyright (C) 2007 Kevin Christen <kevin.christen@gmail.com> | ||||
# | ||||
|
r5792 | # This program is free software; you can redistribute it and/or modify it | ||
|
r5787 | # under the terms of the GNU General Public License as published by the | ||
|
r5792 | # Free Software Foundation; either version 2 of the License, or (at your | ||
|
r5787 | # 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 | ||||
|
r5792 | # with this program; if not, write to the Free Software Foundation, Inc., | ||
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. | ||||
|
r5787 | |||
|
r8894 | '''colorize output from some commands | ||
|
r5787 | |||
|
r13638 | This extension modifies the status and resolve commands to add color | ||
to their output to reflect file status, the qseries command to add | ||||
color to reflect patch status (applied, unapplied, missing), and to | ||||
diff-related commands to highlight additions, removals, diff headers, | ||||
and trailing whitespace. | ||||
|
r7457 | |||
|
r7988 | Other effects in addition to color, like bold and underlined text, are | ||
|
r13987 | also available. By default, the terminfo database is used to find the | ||
terminal codes used to change color and effect. If terminfo is not | ||||
available, then effects are rendered with the ECMA-48 SGR control | ||||
|
r13635 | function (aka ANSI escape codes). | ||
|
r5787 | |||
|
r12083 | Default effects may be overridden from your configuration file:: | ||
|
r5787 | |||
|
r9206 | [color] | ||
status.modified = blue bold underline red_background | ||||
status.added = green bold | ||||
status.removed = red bold blue_background | ||||
status.deleted = cyan bold underline | ||||
status.unknown = magenta bold underline | ||||
status.ignored = black bold | ||||
|
r5787 | |||
|
r9206 | # 'none' turns off all effects | ||
status.clean = none | ||||
status.copied = none | ||||
|
r5787 | |||
|
r9206 | qseries.applied = blue bold underline | ||
qseries.unapplied = black bold | ||||
qseries.missing = red bold | ||||
|
r7456 | |||
|
r9206 | diff.diffline = bold | ||
diff.extended = cyan bold | ||||
diff.file_a = red bold | ||||
diff.file_b = green bold | ||||
diff.hunk = magenta | ||||
diff.deleted = red | ||||
diff.inserted = green | ||||
diff.changed = white | ||||
diff.trailingwhitespace = bold red_background | ||||
|
r10046 | |||
|
r10223 | resolve.unresolved = red bold | ||
resolve.resolved = green bold | ||||
|
r10046 | bookmarks.current = green | ||
|
r10870 | |||
|
r11969 | branches.active = none | ||
branches.closed = black bold | ||||
branches.current = green | ||||
branches.inactive = none | ||||
|
r13987 | The available effects in terminfo mode are 'blink', 'bold', 'dim', | ||
'inverse', 'invisible', 'italic', 'standout', and 'underline'; in | ||||
ECMA-48 mode, the options are 'bold', 'inverse', 'italic', and | ||||
'underline'. How each is rendered depends on the terminal emulator. | ||||
Some may not be available for a given terminal type, and will be | ||||
silently ignored. | ||||
Because there are only eight standard colors, this module allows you | ||||
to define color names for other color slots which might be available | ||||
for your terminal type, assuming terminfo mode. For instance:: | ||||
color.brightblue = 12 | ||||
color.pink = 207 | ||||
color.orange = 202 | ||||
to set 'brightblue' to color slot 12 (useful for 16 color terminals | ||||
that have brighter colors defined in the upper eight) and, 'pink' and | ||||
'orange' to colors in 256-color xterm's default color cube. These | ||||
defined colors may then be used as any of the pre-defined eight, | ||||
including appending '_background' to set the background to that color. | ||||
The color extension will try to detect whether to use terminfo, ANSI | ||||
codes or Win32 console APIs, unless it is made explicit; e.g.:: | ||||
|
r10870 | |||
[color] | ||||
mode = ansi | ||||
|
r13987 | Any value other than 'ansi', 'win32', 'terminfo', or 'auto' will | ||
disable color. | ||||
|
r10870 | |||
|
r5787 | ''' | ||
|
r14139 | import os | ||
|
r5787 | |||
|
r12089 | from mercurial import commands, dispatch, extensions, ui as uimod, util | ||
|
r5787 | from mercurial.i18n import _ | ||
# start and stop parameters for effects | ||||
|
r10826 | _effects = {'none': 0, 'black': 30, 'red': 31, 'green': 32, 'yellow': 33, | ||
'blue': 34, 'magenta': 35, 'cyan': 36, 'white': 37, 'bold': 1, | ||||
'italic': 3, 'underline': 4, 'inverse': 7, | ||||
'black_background': 40, 'red_background': 41, | ||||
'green_background': 42, 'yellow_background': 43, | ||||
'blue_background': 44, 'purple_background': 45, | ||||
'cyan_background': 46, 'white_background': 47} | ||||
|
r13987 | def _terminfosetup(ui): | ||
'''Initialize terminfo data and the terminal if we're in terminfo mode.''' | ||||
global _terminfo_params | ||||
# If we failed to load curses, we go ahead and return. | ||||
if not _terminfo_params: | ||||
return | ||||
# Otherwise, see what the config file says. | ||||
mode = ui.config('color', 'mode', 'auto') | ||||
if mode not in ('auto', 'terminfo'): | ||||
return | ||||
|
r13998 | _terminfo_params.update((key[6:], (False, int(val))) | ||
|
r13987 | for key, val in ui.configitems('color') | ||
|
r13998 | if key.startswith('color.')) | ||
|
r13987 | |||
try: | ||||
curses.setupterm() | ||||
except curses.error, e: | ||||
_terminfo_params = {} | ||||
return | ||||
for key, (b, e) in _terminfo_params.items(): | ||||
if not b: | ||||
continue | ||||
if not curses.tigetstr(e): | ||||
# Most terminals don't support dim, invis, etc, so don't be | ||||
# noisy and use ui.debug(). | ||||
ui.debug("no terminfo entry for %s\n" % e) | ||||
del _terminfo_params[key] | ||||
if not curses.tigetstr('setaf') or not curses.tigetstr('setab'): | ||||
ui.warn(_("no terminfo entry for setab/setaf: reverting to " | ||||
"ECMA-48 color\n")) | ||||
_terminfo_params = {} | ||||
try: | ||||
import curses | ||||
# Mapping from effect name to terminfo attribute name or color number. | ||||
# This will also force-load the curses module. | ||||
_terminfo_params = {'none': (True, 'sgr0'), | ||||
'standout': (True, 'smso'), | ||||
'underline': (True, 'smul'), | ||||
'reverse': (True, 'rev'), | ||||
'inverse': (True, 'rev'), | ||||
'blink': (True, 'blink'), | ||||
'dim': (True, 'dim'), | ||||
'bold': (True, 'bold'), | ||||
'invisible': (True, 'invis'), | ||||
'italic': (True, 'sitm'), | ||||
'black': (False, curses.COLOR_BLACK), | ||||
'red': (False, curses.COLOR_RED), | ||||
'green': (False, curses.COLOR_GREEN), | ||||
'yellow': (False, curses.COLOR_YELLOW), | ||||
'blue': (False, curses.COLOR_BLUE), | ||||
'magenta': (False, curses.COLOR_MAGENTA), | ||||
'cyan': (False, curses.COLOR_CYAN), | ||||
'white': (False, curses.COLOR_WHITE)} | ||||
except ImportError: | ||||
_terminfo_params = False | ||||
|
r10826 | _styles = {'grep.match': 'red bold', | ||
|
r13361 | 'bookmarks.current': 'green', | ||
|
r11969 | 'branches.active': 'none', | ||
'branches.closed': 'black bold', | ||||
'branches.current': 'green', | ||||
'branches.inactive': 'none', | ||||
|
r10826 | 'diff.changed': 'white', | ||
'diff.deleted': 'red', | ||||
'diff.diffline': 'bold', | ||||
'diff.extended': 'cyan bold', | ||||
'diff.file_a': 'red bold', | ||||
'diff.file_b': 'green bold', | ||||
'diff.hunk': 'magenta', | ||||
'diff.inserted': 'green', | ||||
'diff.trailingwhitespace': 'bold red_background', | ||||
'diffstat.deleted': 'red', | ||||
'diffstat.inserted': 'green', | ||||
|
r13774 | 'ui.prompt': 'yellow', | ||
|
r10826 | 'log.changeset': 'yellow', | ||
'resolve.resolved': 'green bold', | ||||
'resolve.unresolved': 'red bold', | ||||
'status.added': 'green bold', | ||||
'status.clean': 'none', | ||||
'status.copied': 'none', | ||||
'status.deleted': 'cyan bold underline', | ||||
'status.ignored': 'black bold', | ||||
'status.modified': 'blue bold', | ||||
'status.removed': 'red bold', | ||||
|
r11310 | 'status.unknown': 'magenta bold underline'} | ||
|
r10826 | |||
|
r5787 | |||
|
r13987 | def _effect_str(effect): | ||
'''Helper function for render_effects().''' | ||||
bg = False | ||||
if effect.endswith('_background'): | ||||
bg = True | ||||
effect = effect[:-11] | ||||
attr, val = _terminfo_params[effect] | ||||
if attr: | ||||
return curses.tigetstr(val) | ||||
elif bg: | ||||
return curses.tparm(curses.tigetstr('setab'), val) | ||||
else: | ||||
return curses.tparm(curses.tigetstr('setaf'), val) | ||||
|
r8622 | def render_effects(text, effects): | ||
|
r5787 | 'Wrap text in commands to turn on each effect.' | ||
|
r10826 | if not text: | ||
return text | ||||
|
r13987 | if not _terminfo_params: | ||
start = [str(_effects[e]) for e in ['none'] + effects.split()] | ||||
start = '\033[' + ';'.join(start) + 'm' | ||||
stop = '\033[' + str(_effects['none']) + 'm' | ||||
else: | ||||
start = ''.join(_effect_str(effect) | ||||
for effect in ['none'] + effects.split()) | ||||
stop = _effect_str('none') | ||||
|
r7459 | return ''.join([start, text, stop]) | ||
|
r5787 | |||
|
r10826 | def extstyles(): | ||
for name, ext in extensions.extensions(): | ||||
_styles.update(getattr(ext, 'colortable', {})) | ||||
|
r7456 | |||
|
r10826 | def configstyles(ui): | ||
for status, cfgeffects in ui.configitems('color'): | ||||
|
r13987 | if '.' not in status or status.startswith('color.'): | ||
|
r10826 | continue | ||
cfgeffects = ui.configlist('color', status) | ||||
if cfgeffects: | ||||
|
r8945 | good = [] | ||
|
r10826 | for e in cfgeffects: | ||
|
r13987 | if not _terminfo_params and e in _effects: | ||
good.append(e) | ||||
elif e in _terminfo_params or e[:-11] in _terminfo_params: | ||||
|
r8945 | good.append(e) | ||
else: | ||||
ui.warn(_("ignoring unknown color/effect %r " | ||||
"(configured in color.%s)\n") | ||||
|
r10826 | % (e, status)) | ||
_styles[status] = ' '.join(good) | ||||
|
r11555 | class colorui(uimod.ui): | ||
def popbuffer(self, labeled=False): | ||||
if labeled: | ||||
return ''.join(self.label(a, label) for a, label | ||||
in self._buffers.pop()) | ||||
return ''.join(a for a, label in self._buffers.pop()) | ||||
|
r10826 | |||
|
r11555 | _colormode = 'ansi' | ||
def write(self, *args, **opts): | ||||
label = opts.get('label', '') | ||||
if self._buffers: | ||||
self._buffers[-1].extend([(str(a), label) for a in args]) | ||||
elif self._colormode == 'win32': | ||||
for a in args: | ||||
|
r11727 | win32print(a, super(colorui, self).write, **opts) | ||
|
r11555 | else: | ||
return super(colorui, self).write( | ||||
*[self.label(str(a), label) for a in args], **opts) | ||||
|
r10826 | |||
|
r11555 | def write_err(self, *args, **opts): | ||
label = opts.get('label', '') | ||||
if self._colormode == 'win32': | ||||
for a in args: | ||||
|
r11727 | win32print(a, super(colorui, self).write_err, **opts) | ||
|
r11555 | else: | ||
|
r11732 | return super(colorui, self).write_err( | ||
|
r11555 | *[self.label(str(a), label) for a in args], **opts) | ||
|
r10826 | |||
|
r11555 | def label(self, msg, label): | ||
effects = [] | ||||
for l in label.split(): | ||||
s = _styles.get(l, '') | ||||
if s: | ||||
effects.append(s) | ||||
|
r14145 | effects = ' '.join(effects) | ||
|
r11555 | if effects: | ||
return '\n'.join([render_effects(s, effects) | ||||
for s in msg.split('\n')]) | ||||
return msg | ||||
|
r10826 | |||
def uisetup(ui): | ||||
|
r13987 | global _terminfo_params | ||
|
r10871 | if ui.plain(): | ||
return | ||||
|
r14103 | |||
formatted = (os.environ.get('TERM') != 'dumb' and ui.formatted()) | ||||
|
r10870 | mode = ui.config('color', 'mode', 'auto') | ||
if mode == 'auto': | ||||
if os.name == 'nt' and 'TERM' not in os.environ: | ||||
# looks line a cmd.exe console, use win32 API or nothing | ||||
mode = w32effects and 'win32' or 'none' | ||||
else: | ||||
|
r14103 | if not formatted: | ||
|
r14095 | _terminfo_params = False | ||
|
r13987 | else: | ||
|
r14095 | _terminfosetup(ui) | ||
if not _terminfo_params: | ||||
mode = 'ansi' | ||||
else: | ||||
mode = 'terminfo' | ||||
|
r10870 | if mode == 'win32': | ||
if w32effects is None: | ||||
# only warn if color.mode is explicitly set to win32 | ||||
|
r13641 | ui.warn(_('warning: failed to set color mode to %s\n') % mode) | ||
|
r10870 | return | ||
_effects.update(w32effects) | ||||
|
r13987 | elif mode == 'ansi': | ||
_terminfo_params = {} | ||||
elif mode == 'terminfo': | ||||
_terminfosetup(ui) | ||||
|
r13998 | else: | ||
|
r10870 | return | ||
|
r10826 | def colorcmd(orig, ui_, opts, cmd, cmdfunc): | ||
|
r12089 | coloropt = opts['color'] | ||
auto = coloropt == 'auto' | ||||
always = util.parsebool(coloropt) | ||||
if (always or | ||||
|
r14103 | (always is None and auto and formatted)): | ||
|
r11555 | colorui._colormode = mode | ||
colorui.__bases__ = (ui_.__class__,) | ||||
ui_.__class__ = colorui | ||||
|
r10826 | extstyles() | ||
|
r11555 | configstyles(ui_) | ||
|
r10826 | return orig(ui_, opts, cmd, cmdfunc) | ||
extensions.wrapfunction(dispatch, '_runcommand', colorcmd) | ||||
|
r12693 | def extsetup(ui): | ||
commands.globalopts.append( | ||||
('', 'color', 'auto', | ||||
|
r12807 | # i18n: 'always', 'auto', and 'never' are keywords and should | ||
# not be translated | ||||
|
r12693 | _("when to colorize (boolean, always, auto, or never)"), | ||
_('TYPE'))) | ||||
|
r10870 | |||
|
r13641 | if os.name != 'nt': | ||
w32effects = None | ||||
else: | ||||
import re, ctypes | ||||
_kernel32 = ctypes.windll.kernel32 | ||||
_WORD = ctypes.c_ushort | ||||
_INVALID_HANDLE_VALUE = -1 | ||||
class _COORD(ctypes.Structure): | ||||
_fields_ = [('X', ctypes.c_short), | ||||
('Y', ctypes.c_short)] | ||||
class _SMALL_RECT(ctypes.Structure): | ||||
_fields_ = [('Left', ctypes.c_short), | ||||
('Top', ctypes.c_short), | ||||
('Right', ctypes.c_short), | ||||
('Bottom', ctypes.c_short)] | ||||
class _CONSOLE_SCREEN_BUFFER_INFO(ctypes.Structure): | ||||
_fields_ = [('dwSize', _COORD), | ||||
('dwCursorPosition', _COORD), | ||||
('wAttributes', _WORD), | ||||
('srWindow', _SMALL_RECT), | ||||
('dwMaximumWindowSize', _COORD)] | ||||
_STD_OUTPUT_HANDLE = 0xfffffff5L # (DWORD)-11 | ||||
_STD_ERROR_HANDLE = 0xfffffff4L # (DWORD)-12 | ||||
_FOREGROUND_BLUE = 0x0001 | ||||
_FOREGROUND_GREEN = 0x0002 | ||||
_FOREGROUND_RED = 0x0004 | ||||
_FOREGROUND_INTENSITY = 0x0008 | ||||
_BACKGROUND_BLUE = 0x0010 | ||||
_BACKGROUND_GREEN = 0x0020 | ||||
_BACKGROUND_RED = 0x0040 | ||||
_BACKGROUND_INTENSITY = 0x0080 | ||||
_COMMON_LVB_REVERSE_VIDEO = 0x4000 | ||||
_COMMON_LVB_UNDERSCORE = 0x8000 | ||||
|
r10870 | |||
# http://msdn.microsoft.com/en-us/library/ms682088%28VS.85%29.aspx | ||||
w32effects = { | ||||
|
r12277 | 'none': -1, | ||
|
r10870 | 'black': 0, | ||
|
r13641 | 'red': _FOREGROUND_RED, | ||
'green': _FOREGROUND_GREEN, | ||||
'yellow': _FOREGROUND_RED | _FOREGROUND_GREEN, | ||||
'blue': _FOREGROUND_BLUE, | ||||
'magenta': _FOREGROUND_BLUE | _FOREGROUND_RED, | ||||
'cyan': _FOREGROUND_BLUE | _FOREGROUND_GREEN, | ||||
'white': _FOREGROUND_RED | _FOREGROUND_GREEN | _FOREGROUND_BLUE, | ||||
'bold': _FOREGROUND_INTENSITY, | ||||
|
r12278 | 'black_background': 0x100, # unused value > 0x0f | ||
|
r13641 | 'red_background': _BACKGROUND_RED, | ||
'green_background': _BACKGROUND_GREEN, | ||||
'yellow_background': _BACKGROUND_RED | _BACKGROUND_GREEN, | ||||
'blue_background': _BACKGROUND_BLUE, | ||||
'purple_background': _BACKGROUND_BLUE | _BACKGROUND_RED, | ||||
'cyan_background': _BACKGROUND_BLUE | _BACKGROUND_GREEN, | ||||
'white_background': (_BACKGROUND_RED | _BACKGROUND_GREEN | | ||||
_BACKGROUND_BLUE), | ||||
'bold_background': _BACKGROUND_INTENSITY, | ||||
'underline': _COMMON_LVB_UNDERSCORE, # double-byte charsets only | ||||
'inverse': _COMMON_LVB_REVERSE_VIDEO, # double-byte charsets only | ||||
|
r10870 | } | ||
|
r13641 | passthrough = set([_FOREGROUND_INTENSITY, | ||
_BACKGROUND_INTENSITY, | ||||
_COMMON_LVB_UNDERSCORE, | ||||
_COMMON_LVB_REVERSE_VIDEO]) | ||||
|
r12277 | |||
|
r13641 | stdout = _kernel32.GetStdHandle( | ||
_STD_OUTPUT_HANDLE) # don't close the handle returned | ||||
if stdout is None or stdout == _INVALID_HANDLE_VALUE: | ||||
w32effects = None | ||||
else: | ||||
csbi = _CONSOLE_SCREEN_BUFFER_INFO() | ||||
if not _kernel32.GetConsoleScreenBufferInfo( | ||||
stdout, ctypes.byref(csbi)): | ||||
# stdout may not support GetConsoleScreenBufferInfo() | ||||
# when called from subprocess or redirected | ||||
w32effects = None | ||||
else: | ||||
origattr = csbi.wAttributes | ||||
ansire = re.compile('\033\[([^m]*)m([^\033]*)(.*)', | ||||
re.MULTILINE | re.DOTALL) | ||||
|
r10870 | |||
def win32print(text, orig, **opts): | ||||
label = opts.get('label', '') | ||||
|
r12277 | attr = origattr | ||
def mapcolor(val, attr): | ||||
if val == -1: | ||||
return origattr | ||||
elif val in passthrough: | ||||
return attr | val | ||||
elif val > 0x0f: | ||||
return (val & 0x70) | (attr & 0x8f) | ||||
else: | ||||
return (val & 0x07) | (attr & 0xf8) | ||||
|
r10870 | |||
# determine console attributes based on labels | ||||
for l in label.split(): | ||||
style = _styles.get(l, '') | ||||
for effect in style.split(): | ||||
|
r12277 | attr = mapcolor(w32effects[effect], attr) | ||
|
r10870 | |||
# hack to ensure regexp finds data | ||||
if not text.startswith('\033['): | ||||
text = '\033[m' + text | ||||
# Look for ANSI-like codes embedded in text | ||||
m = re.match(ansire, text) | ||||
|
r13919 | try: | ||
while m: | ||||
for sattr in m.group(1).split(';'): | ||||
if sattr: | ||||
attr = mapcolor(int(sattr), attr) | ||||
_kernel32.SetConsoleTextAttribute(stdout, attr) | ||||
orig(m.group(2), **opts) | ||||
m = re.match(ansire, m.group(3)) | ||||
finally: | ||||
# Explicity reset original attributes | ||||
_kernel32.SetConsoleTextAttribute(stdout, origattr) | ||||