##// END OF EJS Templates
color: drop the 'colorui' class...
Pierre-Yves David -
r31095:b4cb86ab default
parent child Browse files
Show More
@@ -1,374 +1,368
1 1 # color.py color output for Mercurial commands
2 2 #
3 3 # Copyright (C) 2007 Kevin Christen <kevin.christen@gmail.com>
4 4 #
5 5 # This software may be used and distributed according to the terms of the
6 6 # GNU General Public License version 2 or any later version.
7 7
8 8 '''colorize output from some commands
9 9
10 10 The color extension colorizes output from several Mercurial commands.
11 11 For example, the diff command shows additions in green and deletions
12 12 in red, while the status command shows modified files in magenta. Many
13 13 other commands have analogous colors. It is possible to customize
14 14 these colors.
15 15
16 16 Effects
17 17 -------
18 18
19 19 Other effects in addition to color, like bold and underlined text, are
20 20 also available. By default, the terminfo database is used to find the
21 21 terminal codes used to change color and effect. If terminfo is not
22 22 available, then effects are rendered with the ECMA-48 SGR control
23 23 function (aka ANSI escape codes).
24 24
25 25 The available effects in terminfo mode are 'blink', 'bold', 'dim',
26 26 'inverse', 'invisible', 'italic', 'standout', and 'underline'; in
27 27 ECMA-48 mode, the options are 'bold', 'inverse', 'italic', and
28 28 'underline'. How each is rendered depends on the terminal emulator.
29 29 Some may not be available for a given terminal type, and will be
30 30 silently ignored.
31 31
32 32 If the terminfo entry for your terminal is missing codes for an effect
33 33 or has the wrong codes, you can add or override those codes in your
34 34 configuration::
35 35
36 36 [color]
37 37 terminfo.dim = \E[2m
38 38
39 39 where '\E' is substituted with an escape character.
40 40
41 41 Labels
42 42 ------
43 43
44 44 Text receives color effects depending on the labels that it has. Many
45 45 default Mercurial commands emit labelled text. You can also define
46 46 your own labels in templates using the label function, see :hg:`help
47 47 templates`. A single portion of text may have more than one label. In
48 48 that case, effects given to the last label will override any other
49 49 effects. This includes the special "none" effect, which nullifies
50 50 other effects.
51 51
52 52 Labels are normally invisible. In order to see these labels and their
53 53 position in the text, use the global --color=debug option. The same
54 54 anchor text may be associated to multiple labels, e.g.
55 55
56 56 [log.changeset changeset.secret|changeset: 22611:6f0a53c8f587]
57 57
58 58 The following are the default effects for some default labels. Default
59 59 effects may be overridden from your configuration file::
60 60
61 61 [color]
62 62 status.modified = blue bold underline red_background
63 63 status.added = green bold
64 64 status.removed = red bold blue_background
65 65 status.deleted = cyan bold underline
66 66 status.unknown = magenta bold underline
67 67 status.ignored = black bold
68 68
69 69 # 'none' turns off all effects
70 70 status.clean = none
71 71 status.copied = none
72 72
73 73 qseries.applied = blue bold underline
74 74 qseries.unapplied = black bold
75 75 qseries.missing = red bold
76 76
77 77 diff.diffline = bold
78 78 diff.extended = cyan bold
79 79 diff.file_a = red bold
80 80 diff.file_b = green bold
81 81 diff.hunk = magenta
82 82 diff.deleted = red
83 83 diff.inserted = green
84 84 diff.changed = white
85 85 diff.tab =
86 86 diff.trailingwhitespace = bold red_background
87 87
88 88 # Blank so it inherits the style of the surrounding label
89 89 changeset.public =
90 90 changeset.draft =
91 91 changeset.secret =
92 92
93 93 resolve.unresolved = red bold
94 94 resolve.resolved = green bold
95 95
96 96 bookmarks.active = green
97 97
98 98 branches.active = none
99 99 branches.closed = black bold
100 100 branches.current = green
101 101 branches.inactive = none
102 102
103 103 tags.normal = green
104 104 tags.local = black bold
105 105
106 106 rebase.rebased = blue
107 107 rebase.remaining = red bold
108 108
109 109 shelve.age = cyan
110 110 shelve.newest = green bold
111 111 shelve.name = blue bold
112 112
113 113 histedit.remaining = red bold
114 114
115 115 Custom colors
116 116 -------------
117 117
118 118 Because there are only eight standard colors, this module allows you
119 119 to define color names for other color slots which might be available
120 120 for your terminal type, assuming terminfo mode. For instance::
121 121
122 122 color.brightblue = 12
123 123 color.pink = 207
124 124 color.orange = 202
125 125
126 126 to set 'brightblue' to color slot 12 (useful for 16 color terminals
127 127 that have brighter colors defined in the upper eight) and, 'pink' and
128 128 'orange' to colors in 256-color xterm's default color cube. These
129 129 defined colors may then be used as any of the pre-defined eight,
130 130 including appending '_background' to set the background to that color.
131 131
132 132 Modes
133 133 -----
134 134
135 135 By default, the color extension will use ANSI mode (or win32 mode on
136 136 Windows) if it detects a terminal. To override auto mode (to enable
137 137 terminfo mode, for example), set the following configuration option::
138 138
139 139 [color]
140 140 mode = terminfo
141 141
142 142 Any value other than 'ansi', 'win32', 'terminfo', or 'auto' will
143 143 disable color.
144 144
145 145 Note that on some systems, terminfo mode may cause problems when using
146 146 color with the pager extension and less -R. less with the -R option
147 147 will only display ECMA-48 color codes, and terminfo mode may sometimes
148 148 emit codes that less doesn't understand. You can work around this by
149 149 either using ansi mode (or auto mode), or by using less -r (which will
150 150 pass through all terminal control codes, not just color control
151 151 codes).
152 152
153 153 On some systems (such as MSYS in Windows), the terminal may support
154 154 a different color mode than the pager (activated via the "pager"
155 155 extension). It is possible to define separate modes depending on whether
156 156 the pager is active::
157 157
158 158 [color]
159 159 mode = auto
160 160 pagermode = ansi
161 161
162 162 If ``pagermode`` is not defined, the ``mode`` will be used.
163 163 '''
164 164
165 165 from __future__ import absolute_import
166 166
167 167 try:
168 168 import curses
169 169 curses.COLOR_BLACK # force import
170 170 except ImportError:
171 171 curses = None
172 172
173 173 from mercurial.i18n import _
174 174 from mercurial import (
175 175 cmdutil,
176 176 color,
177 177 commands,
178 178 dispatch,
179 179 encoding,
180 180 extensions,
181 181 pycompat,
182 182 subrepo,
183 183 ui as uimod,
184 184 util,
185 185 )
186 186
187 187 cmdtable = {}
188 188 command = cmdutil.command(cmdtable)
189 189 # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for
190 190 # extensions which SHIP WITH MERCURIAL. Non-mainline extensions should
191 191 # be specifying the version(s) of Mercurial they are tested with, or
192 192 # leave the attribute unspecified.
193 193 testedwith = 'ships-with-hg-core'
194 194
195 195 def _terminfosetup(ui, mode):
196 196 '''Initialize terminfo data and the terminal if we're in terminfo mode.'''
197 197
198 198 # If we failed to load curses, we go ahead and return.
199 199 if curses is None:
200 200 return
201 201 # Otherwise, see what the config file says.
202 202 if mode not in ('auto', 'terminfo'):
203 203 return
204 204
205 205 for key, val in ui.configitems('color'):
206 206 if key.startswith('color.'):
207 207 newval = (False, int(val), '')
208 208 color._terminfo_params[key[6:]] = newval
209 209 elif key.startswith('terminfo.'):
210 210 newval = (True, '', val.replace('\\E', '\x1b'))
211 211 color._terminfo_params[key[9:]] = newval
212 212 try:
213 213 curses.setupterm()
214 214 except curses.error as e:
215 215 color._terminfo_params.clear()
216 216 return
217 217
218 218 for key, (b, e, c) in color._terminfo_params.items():
219 219 if not b:
220 220 continue
221 221 if not c and not curses.tigetstr(e):
222 222 # Most terminals don't support dim, invis, etc, so don't be
223 223 # noisy and use ui.debug().
224 224 ui.debug("no terminfo entry for %s\n" % e)
225 225 del color._terminfo_params[key]
226 226 if not curses.tigetstr('setaf') or not curses.tigetstr('setab'):
227 227 # Only warn about missing terminfo entries if we explicitly asked for
228 228 # terminfo mode.
229 229 if mode == "terminfo":
230 230 ui.warn(_("no terminfo entry for setab/setaf: reverting to "
231 231 "ECMA-48 color\n"))
232 232 color._terminfo_params.clear()
233 233
234 234 def _modesetup(ui, coloropt):
235 235 if coloropt == 'debug':
236 236 return 'debug'
237 237
238 238 auto = (coloropt == 'auto')
239 239 always = not auto and util.parsebool(coloropt)
240 240 if not always and not auto:
241 241 return None
242 242
243 243 formatted = (always or (encoding.environ.get('TERM') != 'dumb'
244 244 and ui.formatted()))
245 245
246 246 mode = ui.config('color', 'mode', 'auto')
247 247
248 248 # If pager is active, color.pagermode overrides color.mode.
249 249 if getattr(ui, 'pageractive', False):
250 250 mode = ui.config('color', 'pagermode', mode)
251 251
252 252 realmode = mode
253 253 if mode == 'auto':
254 254 if pycompat.osname == 'nt':
255 255 term = encoding.environ.get('TERM')
256 256 # TERM won't be defined in a vanilla cmd.exe environment.
257 257
258 258 # UNIX-like environments on Windows such as Cygwin and MSYS will
259 259 # set TERM. They appear to make a best effort attempt at setting it
260 260 # to something appropriate. However, not all environments with TERM
261 261 # defined support ANSI. Since "ansi" could result in terminal
262 262 # gibberish, we error on the side of selecting "win32". However, if
263 263 # w32effects is not defined, we almost certainly don't support
264 264 # "win32", so don't even try.
265 265 if (term and 'xterm' in term) or not color.w32effects:
266 266 realmode = 'ansi'
267 267 else:
268 268 realmode = 'win32'
269 269 else:
270 270 realmode = 'ansi'
271 271
272 272 def modewarn():
273 273 # only warn if color.mode was explicitly set and we're in
274 274 # a formatted terminal
275 275 if mode == realmode and ui.formatted():
276 276 ui.warn(_('warning: failed to set color mode to %s\n') % mode)
277 277
278 278 if realmode == 'win32':
279 279 color._terminfo_params.clear()
280 280 if not color.w32effects:
281 281 modewarn()
282 282 return None
283 283 color._effects.update(color.w32effects)
284 284 elif realmode == 'ansi':
285 285 color._terminfo_params.clear()
286 286 elif realmode == 'terminfo':
287 287 _terminfosetup(ui, mode)
288 288 if not color._terminfo_params:
289 289 ## FIXME Shouldn't we return None in this case too?
290 290 modewarn()
291 291 realmode = 'ansi'
292 292 else:
293 293 return None
294 294
295 295 if always or (auto and formatted):
296 296 return realmode
297 297 return None
298 298
299 class colorui(uimod.ui):
300 pass
301
302 299 def uisetup(ui):
303 300 if ui.plain():
304 301 return
305 if not isinstance(ui, colorui):
306 colorui.__bases__ = (ui.__class__,)
307 ui.__class__ = colorui
308 302 def colorcmd(orig, ui_, opts, cmd, cmdfunc):
309 303 mode = _modesetup(ui_, opts['color'])
310 colorui._colormode = mode
304 uimod.ui._colormode = mode
311 305 if mode and mode != 'debug':
312 306 color.configstyles(ui_)
313 307 return orig(ui_, opts, cmd, cmdfunc)
314 308 def colorgit(orig, gitsub, commands, env=None, stream=False, cwd=None):
315 309 if gitsub.ui._colormode and len(commands) and commands[0] == "diff":
316 310 # insert the argument in the front,
317 311 # the end of git diff arguments is used for paths
318 312 commands.insert(1, '--color')
319 313 return orig(gitsub, commands, env, stream, cwd)
320 314 extensions.wrapfunction(dispatch, '_runcommand', colorcmd)
321 315 extensions.wrapfunction(subrepo.gitsubrepo, '_gitnodir', colorgit)
322 316
323 317 def extsetup(ui):
324 318 commands.globalopts.append(
325 319 ('', 'color', 'auto',
326 320 # i18n: 'always', 'auto', 'never', and 'debug' are keywords
327 321 # and should not be translated
328 322 _("when to colorize (boolean, always, auto, never, or debug)"),
329 323 _('TYPE')))
330 324
331 325 @command('debugcolor',
332 326 [('', 'style', None, _('show all configured styles'))],
333 327 'hg debugcolor')
334 328 def debugcolor(ui, repo, **opts):
335 329 """show available color, effects or style"""
336 330 ui.write(('color mode: %s\n') % ui._colormode)
337 331 if opts.get('style'):
338 332 return _debugdisplaystyle(ui)
339 333 else:
340 334 return _debugdisplaycolor(ui)
341 335
342 336 def _debugdisplaycolor(ui):
343 337 oldstyle = color._styles.copy()
344 338 try:
345 339 color._styles.clear()
346 340 for effect in color._effects.keys():
347 341 color._styles[effect] = effect
348 342 if color._terminfo_params:
349 343 for k, v in ui.configitems('color'):
350 344 if k.startswith('color.'):
351 345 color._styles[k] = k[6:]
352 346 elif k.startswith('terminfo.'):
353 347 color._styles[k] = k[9:]
354 348 ui.write(_('available colors:\n'))
355 349 # sort label with a '_' after the other to group '_background' entry.
356 350 items = sorted(color._styles.items(),
357 351 key=lambda i: ('_' in i[0], i[0], i[1]))
358 352 for colorname, label in items:
359 353 ui.write(('%s\n') % colorname, label=label)
360 354 finally:
361 355 color._styles.clear()
362 356 color._styles.update(oldstyle)
363 357
364 358 def _debugdisplaystyle(ui):
365 359 ui.write(_('available style:\n'))
366 360 width = max(len(s) for s in color._styles)
367 361 for label, effects in sorted(color._styles.items()):
368 362 ui.write('%s' % label, label=label)
369 363 if effects:
370 364 # 50
371 365 ui.write(': ')
372 366 ui.write(' ' * (max(0, width - len(label))))
373 367 ui.write(', '.join(ui.label(e, e) for e in effects.split()))
374 368 ui.write('\n')
@@ -1,40 +1,38
1 1 from __future__ import absolute_import, print_function
2 2
3 3 import os
4 from hgext import (
5 color,
6 )
7 4 from mercurial import (
8 5 dispatch,
9 6 ui as uimod,
10 7 )
11 8
12 9 # ensure errors aren't buffered
13 testui = color.colorui()
10 testui = uimod.ui()
14 11 testui.pushbuffer()
15 12 testui.write(('buffered\n'))
16 13 testui.warn(('warning\n'))
17 14 testui.write_err('error\n')
18 15 print(repr(testui.popbuffer()))
19 16
20 17 # test dispatch.dispatch with the same ui object
21 18 hgrc = open(os.environ["HGRCPATH"], 'w')
22 19 hgrc.write('[extensions]\n')
23 20 hgrc.write('color=\n')
24 21 hgrc.close()
25 22
26 23 ui_ = uimod.ui.load()
27 24 ui_.setconfig('ui', 'formatted', 'True')
28 25
29 26 # we're not interested in the output, so write that to devnull
30 27 ui_.fout = open(os.devnull, 'w')
31 28
32 29 # call some arbitrary command just so we go through
33 30 # color's wrapped _runcommand twice.
34 31 def runcmd():
35 32 dispatch.dispatch(dispatch.request(['version', '-q'], ui_))
36 33
37 34 runcmd()
38 print("colored? " + str(issubclass(ui_.__class__, color.colorui)))
35 print("colored? %s" % (ui_._colormode is not None))
39 36 runcmd()
40 print("colored? " + str(issubclass(ui_.__class__, color.colorui)))
37 print("colored? %s" % (ui_._colormode is not None))
38
General Comments 0
You need to be logged in to leave comments. Login now