This is an archive of the discontinued Mercurial Phabricator instance.

Differential D119

color: add autoterminfo option to prefer terminfo over ansi for non-windows
AbandonedPublic

Authored by spectral on Jul 17 2017, 11:15 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Summary

If color.mode=auto in the config (this is the default) then color.py currently
checks if using windows, and if not, uses 'ansi'. This means that to get
terminfo-based terminal support, one has to specify color.mode=terminfo
explicitly; this enables several warnings if a user's terminal does not actually
have support for terminfo (for example, we failed to load curses, or the
terminal does not have a 'setaf' entry).

If color.autoterminfo is True, we will attempt to use terminfo, and *silently*
fallback to 'ansi' if it is not viable.

This patch does nothing to change the ui.debug messages that are output if
terminfo is chosen but the terminal does not support one of the "default"
features, such as 'dim' or 'invis'. Therefore, the fallback to 'ansi' if
terminfo is not available will be silent, but if terminfo *is* available but
does not support every feature, invocations with --debug will still see/start
to see "no terminfo entry for <feature>" messages.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

spectral created this revision.Jul 17 2017, 11:15 PM
simonfar added a subscriber: simonfar.Jul 18 2017, 11:56 AM

Looks good to me, though.

mercurial/color.py
259–264

For the real reviewer - this combines with modewarn() above to do the silent fallback promised above.

krbullock added a subscriber: krbullock.Jul 18 2017, 4:50 PM

I like this, but I'd rather not take it right before a freeze. Can we revisit this for 4.4?

spectral removed subscribers: krbullock, simonfar.Jul 18 2017, 5:06 PM
In D119#2012, @krbullock wrote:

I like this, but I'd rather not take it right before a freeze. Can we revisit this for 4.4?

I'm fine with waiting. I was on the fence with whether to send this now or not anyway, and I understand the concern about finalizing a config option name. Closing/abandoning now, will try to reopen after the freeze. :)

spectral abandoned this revision.Jul 18 2017, 5:07 PM
indygreg added a subscriber: indygreg.Jul 23 2017, 2:05 PM

Can we refactor color.mode=auto to do something reasonable, like detect and use terminfo if it is available? It always struck me as strange that auto doesn't actually get you the best possible experience.

FWIW, I think the color code needs to be massively refactored to support "nice things" like native 256 color usage, different profiles for different background colors, color blind awareness, customization based on TERM, etc.

Revision Contents
Changeset List

PathPackages
Mmercurial/color.py (6 lines)
Mmercurial/help/config.txt (16 lines)
AMtests/hgterm-dumb.ti (4 lines)
Mtests/test-status-color.t (43 lines)

Diff 230

mercurial/color.py

realmode = 'ansi' realmode = 'ansi'
else: else:
realmode = 'win32' realmode = 'win32'
# An empty w32effects is a clue that stdout is redirected, and thus # An empty w32effects is a clue that stdout is redirected, and thus
# cannot enable VT mode. # cannot enable VT mode.
elif mode == 'ansi' and w32effects and not ansienviron: elif mode == 'ansi' and w32effects and not ansienviron:
win32.enablevtmode() win32.enablevtmode()
elif mode == 'auto': elif mode == 'auto':
if ui.configbool('color', 'autoterminfo', False):
# If terminfo setup fails, we will still fallback to ansi, below.
realmode = 'terminfo'
else:
realmode = 'ansi' realmode = 'ansi'
def modewarn(): def modewarn():
# only warn if color.mode was explicitly set and we're in # only warn if color.mode was explicitly set and we're in
# a formatted terminal # a formatted terminal
if mode == realmode and ui.formatted(): if mode == realmode and ui.formatted():
ui.warn(_('warning: failed to set color mode to %s\n') % mode) ui.warn(_('warning: failed to set color mode to %s\n') % mode)
if realmode == 'win32': if realmode == 'win32':
ui._terminfoparams.clear() ui._terminfoparams.clear()
if not w32effects: if not w32effects:
modewarn() modewarn()
return None return None
elif realmode == 'ansi': elif realmode == 'ansi':
ui._terminfoparams.clear() ui._terminfoparams.clear()
elif realmode == 'terminfo': elif realmode == 'terminfo':
_terminfosetup(ui, mode) _terminfosetup(ui, mode)
if not ui._terminfoparams: if not ui._terminfoparams:
## FIXME Shouldn't we return None in this case too? ## FIXME Shouldn't we return None in this case too?
modewarn() modewarn()
realmode = 'ansi' realmode = 'ansi'
simonfarUnsubmitted
Not Done

For the real reviewer - this combines with modewarn() above to do the silent fallback promised above.

simonfar: For the real reviewer - this combines with `modewarn()` above to do the silent fallback…
else: else:
return None return None
if always or (auto and formatted): if always or (auto and formatted):
return realmode return realmode
return None return None
def configstyles(ui): def configstyles(ui):

mercurial/help/config.txt

for credentials as usual if required by the remote. for credentials as usual if required by the remote.
``color`` ``color``
--------- ---------
Configure the Mercurial color mode. For details about how to define your custom Configure the Mercurial color mode. For details about how to define your custom
effect and style see :hg:`help color`. effect and style see :hg:`help color`.
``autoterminfo``
Make ``color.mode=auto`` attempt ``terminfo`` before falling back to
``ansi``. Does not have an effect on Windows systems. (default: False)
``mode`` ``mode``
String: control the method used to output color. One of ``auto``, ``ansi``, String: control the method used to output color. One of ``auto``, ``ansi``,
``win32``, ``terminfo`` or ``debug``. In auto mode, Mercurial will ``win32``, ``terminfo`` or ``debug``. In auto mode, Mercurial will change
use ANSI mode by default (or win32 mode prior to Windows 10) if it detects a its behavior depending on the OS and the value of autoterminfo, by default
terminal. Any invalid value will disable color. it uses ANSI mode (win32 mode prior to Windows 10) if it detects a terminal.
Any invalid value will disable color.
``pagermode`` ``pagermode``
String: optional override of ``color.mode`` used with pager. String: optional override of ``color.mode`` used with pager.
On some systems, terminfo mode may cause problems when using On some systems, terminfo mode may cause problems when using
color with ``less -R`` as a pager program. less with the -R option color with ``less -R`` as a pager program. less with the -R option
will only display ECMA-48 color codes, and terminfo mode may sometimes 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 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 specifying ``ansi`` here, or by using less -r (which will pass through all
pass through all terminal control codes, not just color control terminal control codes, not just color control codes).
codes).
On some systems (such as MSYS in Windows), the terminal may support On some systems (such as MSYS in Windows), the terminal may support
a different color mode than the pager program. a different color mode than the pager program.
``commands`` ``commands``
------------ ------------
``status.relative`` ``status.relative``

tests/hgterm-dumb.ti

  • This file was added.
hgterm-dumb,
am,
cols#80,
bel=^G, cr=^M, cud1=^J, ind=^J,

tests/test-status-color.t

\x1b[30m\x1b[30m modified\x1b[30m (esc) \x1b[30m\x1b[30m modified\x1b[30m (esc)
\x1b[30m\x1b[31m\x1b[2mR \x1b[30m\x1b[30m\x1b[31m\x1b[2mremoved\x1b[30m (esc) \x1b[30m\x1b[31m\x1b[2mR \x1b[30m\x1b[30m\x1b[31m\x1b[2mremoved\x1b[30m (esc)
\x1b[30m\x1b[36m\x1b[2m\x1b[4m! \x1b[30m\x1b[30m\x1b[36m\x1b[2m\x1b[4mdeleted\x1b[30m (esc) \x1b[30m\x1b[36m\x1b[2m\x1b[4m! \x1b[30m\x1b[30m\x1b[36m\x1b[2m\x1b[4mdeleted\x1b[30m (esc)
\x1b[30m\x1b[35m\x1b[2m\x1b[4m? \x1b[30m\x1b[30m\x1b[35m\x1b[2m\x1b[4munknown\x1b[30m (esc) \x1b[30m\x1b[35m\x1b[2m\x1b[4m? \x1b[30m\x1b[30m\x1b[35m\x1b[2m\x1b[4munknown\x1b[30m (esc)
\x1b[30m\x1b[30m\x1b[2mI \x1b[30m\x1b[30m\x1b[30m\x1b[2mignored\x1b[30m (esc) \x1b[30m\x1b[30m\x1b[2mI \x1b[30m\x1b[30m\x1b[30m\x1b[2mignored\x1b[30m (esc)
\x1b[30m\x1b[88mC \x1b[30m\x1b[30m\x1b[88m.hgignore\x1b[30m (esc) \x1b[30m\x1b[88mC \x1b[30m\x1b[30m\x1b[88m.hgignore\x1b[30m (esc)
\x1b[30m\x1b[88mC \x1b[30m\x1b[30m\x1b[88mmodified\x1b[30m (esc) \x1b[30m\x1b[88mC \x1b[30m\x1b[30m\x1b[88mmodified\x1b[30m (esc)
color.autoterminfo chooses terminfo if it's viable:
$ TERM=hgterm TERMINFO="$TESTTMP/terminfo" hg status --config color.mode=auto --config color.autoterminfo=1 --config color.status.clean=dim -A
\x1b[30m\x1b[32m\x1b[2mA \x1b[30m\x1b[30m\x1b[32m\x1b[2madded\x1b[30m (esc)
\x1b[30m\x1b[32m\x1b[2mA \x1b[30m\x1b[30m\x1b[32m\x1b[2mcopied\x1b[30m (esc)
\x1b[30m\x1b[30m modified\x1b[30m (esc)
\x1b[30m\x1b[31m\x1b[2mR \x1b[30m\x1b[30m\x1b[31m\x1b[2mremoved\x1b[30m (esc)
\x1b[30m\x1b[36m\x1b[2m\x1b[4m! \x1b[30m\x1b[30m\x1b[36m\x1b[2m\x1b[4mdeleted\x1b[30m (esc)
\x1b[30m\x1b[35m\x1b[2m\x1b[4m? \x1b[30m\x1b[30m\x1b[35m\x1b[2m\x1b[4munknown\x1b[30m (esc)
\x1b[30m\x1b[30m\x1b[2mI \x1b[30m\x1b[30m\x1b[30m\x1b[2mignored\x1b[30m (esc)
\x1b[30m\x1b[88mC \x1b[30m\x1b[30m\x1b[88m.hgignore\x1b[30m (esc)
\x1b[30m\x1b[88mC \x1b[30m\x1b[30m\x1b[88mmodified\x1b[30m (esc)
ECMA fallback warning with mode=terminfo explicit:
$ TERMINFO="$TESTTMP/terminfo" tic "$TESTDIR/hgterm-dumb.ti"
$ TERM=hgterm-dumb TERMINFO="$TESTTMP/terminfo" hg status --config color.mode=terminfo -A
no terminfo entry for setab/setaf: reverting to ECMA-48 color
no terminfo entry for setab/setaf: reverting to ECMA-48 color
no terminfo entry for setab/setaf: reverting to ECMA-48 color
\x1b[0;32;1mA \x1b[0m\x1b[0;32;1madded\x1b[0m (esc)
\x1b[0;32;1mA \x1b[0m\x1b[0;32;1mcopied\x1b[0m (esc)
\x1b[0;0m modified\x1b[0m (esc)
\x1b[0;31;1mR \x1b[0m\x1b[0;31;1mremoved\x1b[0m (esc)
\x1b[0;36;1;4m! \x1b[0m\x1b[0;36;1;4mdeleted\x1b[0m (esc)
\x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4munknown\x1b[0m (esc)
\x1b[0;30;1mI \x1b[0m\x1b[0;30;1mignored\x1b[0m (esc)
\x1b[0;0mC \x1b[0m\x1b[0;0m.hgignore\x1b[0m (esc)
\x1b[0;0mC \x1b[0m\x1b[0;0mmodified\x1b[0m (esc)
No fallback warning with autoterminfo:
$ TERM=hgterm-dumb TERMINFO="$TESTTMP/terminfo" hg status --config color.mode=auto --config color.autoterminfo=1 -A
\x1b[0;32;1mA \x1b[0m\x1b[0;32;1madded\x1b[0m (esc)
\x1b[0;32;1mA \x1b[0m\x1b[0;32;1mcopied\x1b[0m (esc)
\x1b[0;0m modified\x1b[0m (esc)
\x1b[0;31;1mR \x1b[0m\x1b[0;31;1mremoved\x1b[0m (esc)
\x1b[0;36;1;4m! \x1b[0m\x1b[0;36;1;4mdeleted\x1b[0m (esc)
\x1b[0;35;1;4m? \x1b[0m\x1b[0;35;1;4munknown\x1b[0m (esc)
\x1b[0;30;1mI \x1b[0m\x1b[0;30;1mignored\x1b[0m (esc)
\x1b[0;0mC \x1b[0m\x1b[0;0m.hgignore\x1b[0m (esc)
\x1b[0;0mC \x1b[0m\x1b[0;0mmodified\x1b[0m (esc)
#endif #endif
$ echo "^ignoreddir$" > .hgignore $ echo "^ignoreddir$" > .hgignore
$ mkdir ignoreddir $ mkdir ignoreddir
$ touch ignoreddir/file $ touch ignoreddir/file
hg status ignoreddir/file: hg status ignoreddir/file: