color.py
518 lines
| 17.0 KiB
| text/x-python
|
PythonLexer
/ mercurial / color.py
|
r30652 | # utility for color output for Mercurial commands | ||
# | ||||
# Copyright (C) 2007 Kevin Christen <kevin.christen@gmail.com> and other | ||||
# | ||||
# This software may be used and distributed according to the terms of the | ||||
# GNU General Public License version 2 or any later version. | ||||
from __future__ import absolute_import | ||||
|
r31521 | import re | ||
|
r30971 | from .i18n import _ | ||
|
r31101 | from . import ( | ||
encoding, | ||||
pycompat, | ||||
util | ||||
) | ||||
|
r31067 | |||
|
r30968 | try: | ||
import curses | ||||
# Mapping from effect name to terminfo attribute name (or raw code) or | ||||
# color number. This will also force-load the curses module. | ||||
|
r31113 | _baseterminfoparams = { | ||
|
r31109 | '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, ''), | ||||
} | ||||
|
r30968 | except ImportError: | ||
curses = None | ||||
|
r31113 | _baseterminfoparams = {} | ||
|
r30968 | |||
|
r30967 | # start and stop parameters for effects | ||
|
r31109 | _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, | ||||
'dim': 2, | ||||
'black_background': 40, | ||||
'red_background': 41, | ||||
'green_background': 42, | ||||
'yellow_background': 43, | ||||
'blue_background': 44, | ||||
'purple_background': 45, | ||||
'cyan_background': 46, | ||||
'white_background': 47, | ||||
} | ||||
|
r30967 | |||
|
r31116 | _defaultstyles = { | ||
|
r31109 | 'grep.match': 'red bold', | ||
'grep.linenumber': 'green', | ||||
'grep.rev': 'green', | ||||
'grep.change': 'green', | ||||
'grep.sep': 'cyan', | ||||
'grep.filename': 'magenta', | ||||
'grep.user': 'magenta', | ||||
'grep.date': 'magenta', | ||||
'bookmarks.active': 'green', | ||||
'branches.active': 'none', | ||||
'branches.closed': 'black bold', | ||||
'branches.current': 'green', | ||||
'branches.inactive': 'none', | ||||
'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.tab': '', | ||||
'diff.trailingwhitespace': 'bold red_background', | ||||
|
r34487 | 'changeset.public': '', | ||
'changeset.draft': '', | ||||
'changeset.secret': '', | ||||
|
r31109 | 'diffstat.deleted': 'red', | ||
'diffstat.inserted': 'green', | ||||
'histedit.remaining': 'red bold', | ||||
'ui.prompt': 'yellow', | ||||
'log.changeset': 'yellow', | ||||
'patchbomb.finalsummary': '', | ||||
'patchbomb.from': 'magenta', | ||||
'patchbomb.to': 'cyan', | ||||
'patchbomb.subject': 'green', | ||||
'patchbomb.diffstats': '', | ||||
'rebase.rebased': 'blue', | ||||
'rebase.remaining': 'red bold', | ||||
'resolve.resolved': 'green bold', | ||||
'resolve.unresolved': 'red bold', | ||||
'shelve.age': 'cyan', | ||||
'shelve.newest': 'green bold', | ||||
'shelve.name': 'blue 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', | ||||
'status.unknown': 'magenta bold underline', | ||||
'tags.normal': 'green', | ||||
'tags.local': 'black bold', | ||||
} | ||||
|
r30653 | |||
def loadcolortable(ui, extname, colortable): | ||||
|
r31116 | _defaultstyles.update(colortable) | ||
|
r30969 | |||
|
r33643 | def _terminfosetup(ui, mode, formatted): | ||
|
r31100 | '''Initialize terminfo data and the terminal if we're in terminfo mode.''' | ||
# If we failed to load curses, we go ahead and return. | ||||
if curses is None: | ||||
return | ||||
# Otherwise, see what the config file says. | ||||
if mode not in ('auto', 'terminfo'): | ||||
return | ||||
|
r31113 | ui._terminfoparams.update(_baseterminfoparams) | ||
|
r31100 | |||
for key, val in ui.configitems('color'): | ||||
if key.startswith('color.'): | ||||
newval = (False, int(val), '') | ||||
|
r31113 | ui._terminfoparams[key[6:]] = newval | ||
|
r31100 | elif key.startswith('terminfo.'): | ||
newval = (True, '', val.replace('\\E', '\x1b')) | ||||
|
r31113 | ui._terminfoparams[key[9:]] = newval | ||
|
r31100 | try: | ||
curses.setupterm() | ||||
except curses.error as e: | ||||
|
r31113 | ui._terminfoparams.clear() | ||
|
r31100 | return | ||
|
r31113 | for key, (b, e, c) in ui._terminfoparams.items(): | ||
|
r31100 | if not b: | ||
continue | ||||
if not c and 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) | ||||
|
r31113 | del ui._terminfoparams[key] | ||
|
r31100 | if not curses.tigetstr('setaf') or not curses.tigetstr('setab'): | ||
# Only warn about missing terminfo entries if we explicitly asked for | ||||
|
r33643 | # terminfo mode and we're in a formatted terminal. | ||
if mode == "terminfo" and formatted: | ||||
|
r31100 | ui.warn(_("no terminfo entry for setab/setaf: reverting to " | ||
"ECMA-48 color\n")) | ||||
|
r31113 | ui._terminfoparams.clear() | ||
|
r31100 | |||
|
r31110 | def setup(ui): | ||
|
r31105 | """configure color on a ui | ||
|
r31110 | That function both set the colormode for the ui object and read | ||
|
r31105 | the configuration looking for custom colors and effect definitions.""" | ||
|
r31110 | mode = _modesetup(ui) | ||
|
r31106 | ui._colormode = mode | ||
|
r31105 | if mode and mode != 'debug': | ||
configstyles(ui) | ||||
|
r31110 | def _modesetup(ui): | ||
|
r31103 | if ui.plain(): | ||
return None | ||||
|
r33522 | config = ui.config('ui', 'color') | ||
|
r31110 | if config == 'debug': | ||
|
r31101 | return 'debug' | ||
|
r31110 | auto = (config == 'auto') | ||
|
r32103 | always = False | ||
if not auto and util.parsebool(config): | ||||
|
r32104 | # We want the config to behave like a boolean, "on" is actually auto, | ||
# but "always" value is treated as a special case to reduce confusion. | ||||
if ui.configsource('ui', 'color') == '--color' or config == 'always': | ||||
|
r32103 | always = True | ||
else: | ||||
auto = True | ||||
|
r31101 | if not always and not auto: | ||
return None | ||||
formatted = (always or (encoding.environ.get('TERM') != 'dumb' | ||||
and ui.formatted())) | ||||
r33176 | mode = ui.config('color', 'mode') | |||
|
r31101 | |||
# If pager is active, color.pagermode overrides color.mode. | ||||
if getattr(ui, 'pageractive', False): | ||||
mode = ui.config('color', 'pagermode', mode) | ||||
realmode = mode | ||||
|
r32665 | if pycompat.osname == 'nt': | ||
from . import win32 | ||||
term = encoding.environ.get('TERM') | ||||
# TERM won't be defined in a vanilla cmd.exe environment. | ||||
|
r31101 | |||
|
r32665 | # UNIX-like environments on Windows such as Cygwin and MSYS will | ||
# set TERM. They appear to make a best effort attempt at setting it | ||||
# to something appropriate. However, not all environments with TERM | ||||
# defined support ANSI. | ||||
ansienviron = term and 'xterm' in term | ||||
if mode == 'auto': | ||||
# Since "ansi" could result in terminal gibberish, we error on the | ||||
# side of selecting "win32". However, if w32effects is not defined, | ||||
# we almost certainly don't support "win32", so don't even try. | ||||
# w32ffects is not populated when stdout is redirected, so checking | ||||
# it first avoids win32 calls in a state known to error out. | ||||
if ansienviron or not w32effects or win32.enablevtmode(): | ||||
|
r31101 | realmode = 'ansi' | ||
else: | ||||
realmode = 'win32' | ||||
|
r32665 | # An empty w32effects is a clue that stdout is redirected, and thus | ||
# cannot enable VT mode. | ||||
elif mode == 'ansi' and w32effects and not ansienviron: | ||||
win32.enablevtmode() | ||||
elif mode == 'auto': | ||||
realmode = 'ansi' | ||||
|
r31101 | |||
def modewarn(): | ||||
# only warn if color.mode was explicitly set and we're in | ||||
# a formatted terminal | ||||
|
r33643 | if mode == realmode and formatted: | ||
|
r31101 | ui.warn(_('warning: failed to set color mode to %s\n') % mode) | ||
if realmode == 'win32': | ||||
|
r31113 | ui._terminfoparams.clear() | ||
|
r31101 | if not w32effects: | ||
modewarn() | ||||
return None | ||||
elif realmode == 'ansi': | ||||
|
r31113 | ui._terminfoparams.clear() | ||
|
r31101 | elif realmode == 'terminfo': | ||
|
r33643 | _terminfosetup(ui, mode, formatted) | ||
|
r31113 | if not ui._terminfoparams: | ||
|
r31101 | ## FIXME Shouldn't we return None in this case too? | ||
modewarn() | ||||
realmode = 'ansi' | ||||
else: | ||||
return None | ||||
if always or (auto and formatted): | ||||
return realmode | ||||
return None | ||||
|
r30971 | def configstyles(ui): | ||
|
r31116 | ui._styles.update(_defaultstyles) | ||
|
r30971 | for status, cfgeffects in ui.configitems('color'): | ||
if '.' not in status or status.startswith(('color.', 'terminfo.')): | ||||
continue | ||||
cfgeffects = ui.configlist('color', status) | ||||
if cfgeffects: | ||||
good = [] | ||||
for e in cfgeffects: | ||||
|
r31112 | if valideffect(ui, e): | ||
|
r30971 | good.append(e) | ||
else: | ||||
ui.warn(_("ignoring unknown color/effect %r " | ||||
"(configured in color.%s)\n") | ||||
% (e, status)) | ||||
|
r31115 | ui._styles[status] = ' '.join(good) | ||
|
r30971 | |||
|
r31689 | def _activeeffects(ui): | ||
'''Return the effects map for the color mode set on the ui.''' | ||||
if ui._colormode == 'win32': | ||||
return w32effects | ||||
elif ui._colormode is not None: | ||||
return _effects | ||||
return {} | ||||
|
r31112 | def valideffect(ui, effect): | ||
|
r30969 | 'Determine if the effect is valid or not.' | ||
|
r31689 | return ((not ui._terminfoparams and effect in _activeeffects(ui)) | ||
|
r31113 | or (effect in ui._terminfoparams | ||
or effect[:-11] in ui._terminfoparams)) | ||||
|
r30972 | |||
|
r31112 | def _effect_str(ui, effect): | ||
|
r30972 | '''Helper function for render_effects().''' | ||
bg = False | ||||
if effect.endswith('_background'): | ||||
bg = True | ||||
effect = effect[:-11] | ||||
try: | ||||
|
r31113 | attr, val, termcode = ui._terminfoparams[effect] | ||
|
r30972 | except KeyError: | ||
return '' | ||||
if attr: | ||||
if termcode: | ||||
return termcode | ||||
else: | ||||
return curses.tigetstr(val) | ||||
elif bg: | ||||
return curses.tparm(curses.tigetstr('setab'), val) | ||||
else: | ||||
return curses.tparm(curses.tigetstr('setaf'), val) | ||||
|
r30973 | |||
|
r31518 | def _mergeeffects(text, start, stop): | ||
"""Insert start sequence at every occurrence of stop sequence | ||||
|
r34133 | >>> s = _mergeeffects(b'cyan', b'[C]', b'|') | ||
>>> s = _mergeeffects(s + b'yellow', b'[Y]', b'|') | ||||
>>> s = _mergeeffects(b'ma' + s + b'genta', b'[M]', b'|') | ||||
>>> s = _mergeeffects(b'red' + s, b'[R]', b'|') | ||||
|
r31518 | >>> s | ||
'[R]red[M]ma[Y][C]cyan|[R][M][Y]yellow|[R][M]genta|' | ||||
""" | ||||
parts = [] | ||||
for t in text.split(stop): | ||||
if not t: | ||||
continue | ||||
parts.extend([start, t, stop]) | ||||
return ''.join(parts) | ||||
|
r31112 | def _render_effects(ui, text, effects): | ||
|
r30973 | 'Wrap text in commands to turn on each effect.' | ||
if not text: | ||||
return text | ||||
|
r31113 | if ui._terminfoparams: | ||
|
r31112 | start = ''.join(_effect_str(ui, effect) | ||
|
r31071 | for effect in ['none'] + effects.split()) | ||
|
r31112 | stop = _effect_str(ui, 'none') | ||
|
r31071 | else: | ||
|
r31689 | activeeffects = _activeeffects(ui) | ||
|
r31716 | start = [pycompat.bytestr(activeeffects[e]) | ||
for e in ['none'] + effects.split()] | ||||
|
r30973 | start = '\033[' + ';'.join(start) + 'm' | ||
|
r31716 | stop = '\033[' + pycompat.bytestr(activeeffects['none']) + 'm' | ||
|
r31518 | return _mergeeffects(text, start, stop) | ||
|
r31067 | |||
|
r31521 | _ansieffectre = re.compile(br'\x1b\[[0-9;]*m') | ||
def stripeffects(text): | ||||
"""Strip ANSI control codes which could be inserted by colorlabel()""" | ||||
return _ansieffectre.sub('', text) | ||||
|
r31086 | def colorlabel(ui, msg, label): | ||
"""add color control code according to the mode""" | ||||
if ui._colormode == 'debug': | ||||
if label and msg: | ||||
if msg[-1] == '\n': | ||||
msg = "[%s|%s]\n" % (label, msg[:-1]) | ||||
else: | ||||
msg = "[%s|%s]" % (label, msg) | ||||
elif ui._colormode is not None: | ||||
effects = [] | ||||
for l in label.split(): | ||||
|
r31115 | s = ui._styles.get(l, '') | ||
|
r31086 | if s: | ||
effects.append(s) | ||||
|
r31112 | elif valideffect(ui, l): | ||
|
r31086 | effects.append(l) | ||
effects = ' '.join(effects) | ||||
if effects: | ||||
|
r31112 | msg = '\n'.join([_render_effects(ui, line, effects) | ||
|
r31086 | for line in msg.split('\n')]) | ||
return msg | ||||
|
r31067 | w32effects = None | ||
if pycompat.osname == 'nt': | ||||
import 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 = 0xfffffff5 # (DWORD)-11 | ||||
_STD_ERROR_HANDLE = 0xfffffff4 # (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 | ||||
# http://msdn.microsoft.com/en-us/library/ms682088%28VS.85%29.aspx | ||||
w32effects = { | ||||
'none': -1, | ||||
'black': 0, | ||||
'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, | ||||
'black_background': 0x100, # unused value > 0x0f | ||||
'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 | ||||
} | ||||
|
r32291 | passthrough = {_FOREGROUND_INTENSITY, | ||
_BACKGROUND_INTENSITY, | ||||
_COMMON_LVB_UNDERSCORE, | ||||
_COMMON_LVB_REVERSE_VIDEO} | ||||
|
r31067 | |||
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) | ||||
|
r31114 | def win32print(ui, writefunc, *msgs, **opts): | ||
|
r31089 | for text in msgs: | ||
|
r31114 | _win32print(ui, text, writefunc, **opts) | ||
|
r31089 | |||
|
r31114 | def _win32print(ui, text, writefunc, **opts): | ||
|
r31067 | label = opts.get('label', '') | ||
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) | ||||
# determine console attributes based on labels | ||||
for l in label.split(): | ||||
|
r31115 | style = ui._styles.get(l, '') | ||
|
r31067 | for effect in style.split(): | ||
try: | ||||
attr = mapcolor(w32effects[effect], attr) | ||||
except KeyError: | ||||
# w32effects could not have certain attributes so we skip | ||||
# them if not found | ||||
pass | ||||
# 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) | ||||
try: | ||||
while m: | ||||
for sattr in m.group(1).split(';'): | ||||
if sattr: | ||||
attr = mapcolor(int(sattr), attr) | ||||
|
r31499 | ui.flush() | ||
|
r31067 | _kernel32.SetConsoleTextAttribute(stdout, attr) | ||
|
r31088 | writefunc(m.group(2), **opts) | ||
|
r31067 | m = re.match(ansire, m.group(3)) | ||
finally: | ||||
# Explicitly reset original attributes | ||||
|
r31499 | ui.flush() | ||
|
r31067 | _kernel32.SetConsoleTextAttribute(stdout, origattr) | ||