# color.py color output for Mercurial commands

#

# Copyright (C) 2007 Kevin Christen <kevin.christen@gmail.com>

#

# This software may be used and distributed according to the terms of the

# GNU General Public License version 2 or any later version.

'''colorize output from some commands

The color extension colorizes output from several Mercurial commands.

For example, the diff command shows additions in green and deletions

in red, while the status command shows modified files in magenta. Many

other commands have analogous colors. It is possible to customize

these colors.

Effects

-------

Other effects in addition to color, like bold and underlined text, are

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

function (aka ANSI escape codes).

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.

Labels

------

Text receives color effects depending on the labels that it has. Many

default Mercurial commands emit labelled text. You can also define

your own labels in templates using the label function, see :hg:`help

templates`. A single portion of text may have more than one label. In

that case, effects given to the last label will override any other

effects. This includes the special "none" effect, which nullifies

other effects.

Labels are normally invisible. In order to see these labels and their

position in the text, use the global --color=debug option. The same

anchor text may be associated to multiple labels, e.g.

  [log.changeset changeset.secret|changeset:   22611:6f0a53c8f587]

The following are the default effects for some default labels. Default

effects may be overridden from your configuration file::

  [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

  # 'none' turns off all effects

  status.clean = none

  status.copied = none

  qseries.applied = blue bold underline

  qseries.unapplied = black bold

  qseries.missing = red bold

  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.tab =

  diff.trailingwhitespace = bold red_background

  # Blank so it inherits the style of the surrounding label

  changeset.public =

  changeset.draft =

  changeset.secret =

  resolve.unresolved = red bold

  resolve.resolved = green bold

  bookmarks.active = green

  branches.active = none

  branches.closed = black bold

  branches.current = green

  branches.inactive = none

  tags.normal = green

  tags.local = black bold

  rebase.rebased = blue

  rebase.remaining = red bold

  shelve.age = cyan

  shelve.newest = green bold

  shelve.name = blue bold

  histedit.remaining = red bold

Custom colors

-------------

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.

Modes

-----

By default, the color extension will use ANSI mode (or win32 mode on

Windows) if it detects a terminal. To override auto mode (to enable

terminfo mode, for example), set the following configuration option::

  [color]

  mode = terminfo

Any value other than 'ansi', 'win32', 'terminfo', or 'auto' will

disable color.

Note that on some systems, terminfo mode may cause problems when using

color with the pager extension and less -R. less with the -R option

will only display ECMA-48 color codes, and terminfo mode may sometimes

emit codes that less doesn't understand. You can work around this by

either using ansi mode (or auto mode), or by using less -r (which will

pass through all terminal control codes, not just color control

codes).

On some systems (such as MSYS in Windows), the terminal may support

a different color mode than the pager (activated via the "pager"

extension). It is possible to define separate modes depending on whether

the pager is active::

  [color]

  mode = auto

  pagermode = ansi

If ``pagermode`` is not defined, the ``mode`` will be used.

'''

import os

from mercurial import cmdutil, commands, dispatch, extensions, subrepo, util

from mercurial import ui as uimod

from mercurial import templater, error

from mercurial.i18n import _

cmdtable = {}

command = cmdutil.command(cmdtable)

# Note for extension authors: ONLY specify testedwith = 'internal' for

# extensions which SHIP WITH MERCURIAL. Non-mainline extensions should

# be specifying the version(s) of Mercurial they are tested with, or

# leave the attribute unspecified.

testedwith = 'internal'

# start and stop parameters for effects

_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}

def _terminfosetup(ui, mode):

    '''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.

    if mode not in ('auto', 'terminfo'):

        return

    _terminfo_params.update((key[6:], (False, int(val)))

        for key, val in ui.configitems('color')

        if key.startswith('color.'))

    try:

        curses.setupterm()

    except curses.error as 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'):

        # Only warn about missing terminfo entries if we explicitly asked for

        # terminfo mode.

        if mode == "terminfo":

            ui.warn(_("no terminfo entry for setab/setaf: reverting to "

              "ECMA-48 color\n"))

        _terminfo_params = {}

def _modesetup(ui, coloropt):

    global _terminfo_params

    if coloropt == 'debug':

        return 'debug'

    auto = (coloropt == 'auto')

    always = not auto and util.parsebool(coloropt)

    if not always and not auto:

        return None

    formatted = always or (os.environ.get('TERM') != 'dumb' and ui.formatted())

    mode = ui.config('color', 'mode', 'auto')

    # If pager is active, color.pagermode overrides color.mode.

    if getattr(ui, 'pageractive', False):

        mode = ui.config('color', 'pagermode', mode)

    realmode = mode

    if mode == 'auto':

        if os.name == 'nt':

            term = os.environ.get('TERM')

            # TERM won't be defined in a vanilla cmd.exe environment.

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

            if (term and 'xterm' in term) or not w32effects:

                realmode = 'ansi'

            else:

                realmode = 'win32'

        else:

            realmode = 'ansi'

    def modewarn():

        # only warn if color.mode was explicitly set and we're in

        # an interactive terminal

        if mode == realmode and ui.interactive():

            ui.warn(_('warning: failed to set color mode to %s\n') % mode)

    if realmode == 'win32':

        _terminfo_params = {}

        if not w32effects:

            modewarn()

            return None

        _effects.update(w32effects)

    elif realmode == 'ansi':

        _terminfo_params = {}

    elif realmode == 'terminfo':

        _terminfosetup(ui, mode)

        if not _terminfo_params:

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

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 = {}

_styles = {'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',

           'changeset.public' : '',

           'changeset.draft' : '',

           'changeset.secret' : '',

           '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'}

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)

def render_effects(text, effects):

    'Wrap text in commands to turn on each effect.'

    if not text:

        return text

    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')

    return ''.join([start, text, stop])

def extstyles():

    for name, ext in extensions.extensions():

        _styles.update(getattr(ext, 'colortable', {}))

def valideffect(effect):

    'Determine if the effect is valid or not.'

    good = False

    if not _terminfo_params and effect in _effects:

        good = True

    elif effect in _terminfo_params or effect[:-11] in _terminfo_params:

        good = True

    return good

def configstyles(ui):

    for status, cfgeffects in ui.configitems('color'):

        if '.' not in status or status.startswith('color.'):