##// END OF EJS Templates
color: Do not pass --color, --no-color parameters to wrapped function...
David Soria Parra -
r10045:d1f9640e default
parent child Browse files
Show More
@@ -1,314 +1,318
1 # color.py color output for the status and qseries commands
1 # color.py color output for the status and qseries commands
2 #
2 #
3 # Copyright (C) 2007 Kevin Christen <kevin.christen@gmail.com>
3 # Copyright (C) 2007 Kevin Christen <kevin.christen@gmail.com>
4 #
4 #
5 # This program is free software; you can redistribute it and/or modify it
5 # This program is free software; you can redistribute it and/or modify it
6 # under the terms of the GNU General Public License as published by the
6 # under the terms of the GNU General Public License as published by the
7 # Free Software Foundation; either version 2 of the License, or (at your
7 # Free Software Foundation; either version 2 of the License, or (at your
8 # option) any later version.
8 # option) any later version.
9 #
9 #
10 # This program is distributed in the hope that it will be useful, but
10 # This program is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
13 # Public License for more details.
13 # Public License for more details.
14 #
14 #
15 # You should have received a copy of the GNU General Public License along
15 # You should have received a copy of the GNU General Public License along
16 # with this program; if not, write to the Free Software Foundation, Inc.,
16 # with this program; if not, write to the Free Software Foundation, Inc.,
17 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
17 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18
18
19 '''colorize output from some commands
19 '''colorize output from some commands
20
20
21 This extension modifies the status command to add color to its output
21 This extension modifies the status command to add color to its output
22 to reflect file status, the qseries command to add color to reflect
22 to reflect file status, the qseries command to add color to reflect
23 patch status (applied, unapplied, missing), and to diff-related
23 patch status (applied, unapplied, missing), and to diff-related
24 commands to highlight additions, removals, diff headers, and trailing
24 commands to highlight additions, removals, diff headers, and trailing
25 whitespace.
25 whitespace.
26
26
27 Other effects in addition to color, like bold and underlined text, are
27 Other effects in addition to color, like bold and underlined text, are
28 also available. Effects are rendered with the ECMA-48 SGR control
28 also available. Effects are rendered with the ECMA-48 SGR control
29 function (aka ANSI escape codes). This module also provides the
29 function (aka ANSI escape codes). This module also provides the
30 render_text function, which can be used to add effects to any text.
30 render_text function, which can be used to add effects to any text.
31
31
32 Default effects may be overridden from the .hgrc file::
32 Default effects may be overridden from the .hgrc file::
33
33
34 [color]
34 [color]
35 status.modified = blue bold underline red_background
35 status.modified = blue bold underline red_background
36 status.added = green bold
36 status.added = green bold
37 status.removed = red bold blue_background
37 status.removed = red bold blue_background
38 status.deleted = cyan bold underline
38 status.deleted = cyan bold underline
39 status.unknown = magenta bold underline
39 status.unknown = magenta bold underline
40 status.ignored = black bold
40 status.ignored = black bold
41
41
42 # 'none' turns off all effects
42 # 'none' turns off all effects
43 status.clean = none
43 status.clean = none
44 status.copied = none
44 status.copied = none
45
45
46 qseries.applied = blue bold underline
46 qseries.applied = blue bold underline
47 qseries.unapplied = black bold
47 qseries.unapplied = black bold
48 qseries.missing = red bold
48 qseries.missing = red bold
49
49
50 diff.diffline = bold
50 diff.diffline = bold
51 diff.extended = cyan bold
51 diff.extended = cyan bold
52 diff.file_a = red bold
52 diff.file_a = red bold
53 diff.file_b = green bold
53 diff.file_b = green bold
54 diff.hunk = magenta
54 diff.hunk = magenta
55 diff.deleted = red
55 diff.deleted = red
56 diff.inserted = green
56 diff.inserted = green
57 diff.changed = white
57 diff.changed = white
58 diff.trailingwhitespace = bold red_background
58 diff.trailingwhitespace = bold red_background
59 '''
59 '''
60
60
61 import os, sys
61 import os, sys
62
62
63 from mercurial import cmdutil, commands, extensions, error
63 from mercurial import cmdutil, commands, extensions, error
64 from mercurial.i18n import _
64 from mercurial.i18n import _
65
65
66 # start and stop parameters for effects
66 # start and stop parameters for effects
67 _effect_params = {'none': 0,
67 _effect_params = {'none': 0,
68 'black': 30,
68 'black': 30,
69 'red': 31,
69 'red': 31,
70 'green': 32,
70 'green': 32,
71 'yellow': 33,
71 'yellow': 33,
72 'blue': 34,
72 'blue': 34,
73 'magenta': 35,
73 'magenta': 35,
74 'cyan': 36,
74 'cyan': 36,
75 'white': 37,
75 'white': 37,
76 'bold': 1,
76 'bold': 1,
77 'italic': 3,
77 'italic': 3,
78 'underline': 4,
78 'underline': 4,
79 'inverse': 7,
79 'inverse': 7,
80 'black_background': 40,
80 'black_background': 40,
81 'red_background': 41,
81 'red_background': 41,
82 'green_background': 42,
82 'green_background': 42,
83 'yellow_background': 43,
83 'yellow_background': 43,
84 'blue_background': 44,
84 'blue_background': 44,
85 'purple_background': 45,
85 'purple_background': 45,
86 'cyan_background': 46,
86 'cyan_background': 46,
87 'white_background': 47}
87 'white_background': 47}
88
88
89 def render_effects(text, effects):
89 def render_effects(text, effects):
90 'Wrap text in commands to turn on each effect.'
90 'Wrap text in commands to turn on each effect.'
91 start = [str(_effect_params[e]) for e in ['none'] + effects]
91 start = [str(_effect_params[e]) for e in ['none'] + effects]
92 start = '\033[' + ';'.join(start) + 'm'
92 start = '\033[' + ';'.join(start) + 'm'
93 stop = '\033[' + str(_effect_params['none']) + 'm'
93 stop = '\033[' + str(_effect_params['none']) + 'm'
94 return ''.join([start, text, stop])
94 return ''.join([start, text, stop])
95
95
96 def colorstatus(orig, ui, repo, *pats, **opts):
96 def colorstatus(orig, ui, repo, *pats, **opts):
97 '''run the status command with colored output'''
97 '''run the status command with colored output'''
98
98
99 delimiter = opts['print0'] and '\0' or '\n'
99 delimiter = opts['print0'] and '\0' or '\n'
100
100
101 nostatus = opts.get('no_status')
101 nostatus = opts.get('no_status')
102 opts['no_status'] = False
102 opts['no_status'] = False
103 # run status and capture its output
103 # run status and capture its output
104 ui.pushbuffer()
104 ui.pushbuffer()
105 retval = orig(ui, repo, *pats, **opts)
105 retval = orig(ui, repo, *pats, **opts)
106 # filter out empty strings
106 # filter out empty strings
107 lines_with_status = [ line for line in ui.popbuffer().split(delimiter) if line ]
107 lines_with_status = [ line for line in ui.popbuffer().split(delimiter) if line ]
108
108
109 if nostatus:
109 if nostatus:
110 lines = [l[2:] for l in lines_with_status]
110 lines = [l[2:] for l in lines_with_status]
111 else:
111 else:
112 lines = lines_with_status
112 lines = lines_with_status
113
113
114 # apply color to output and display it
114 # apply color to output and display it
115 for i in xrange(len(lines)):
115 for i in xrange(len(lines)):
116 status = _status_abbreviations[lines_with_status[i][0]]
116 status = _status_abbreviations[lines_with_status[i][0]]
117 effects = _status_effects[status]
117 effects = _status_effects[status]
118 if effects:
118 if effects:
119 lines[i] = render_effects(lines[i], effects)
119 lines[i] = render_effects(lines[i], effects)
120 ui.write(lines[i] + delimiter)
120 ui.write(lines[i] + delimiter)
121 return retval
121 return retval
122
122
123 _status_abbreviations = { 'M': 'modified',
123 _status_abbreviations = { 'M': 'modified',
124 'A': 'added',
124 'A': 'added',
125 'R': 'removed',
125 'R': 'removed',
126 '!': 'deleted',
126 '!': 'deleted',
127 '?': 'unknown',
127 '?': 'unknown',
128 'I': 'ignored',
128 'I': 'ignored',
129 'C': 'clean',
129 'C': 'clean',
130 ' ': 'copied', }
130 ' ': 'copied', }
131
131
132 _status_effects = { 'modified': ['blue', 'bold'],
132 _status_effects = { 'modified': ['blue', 'bold'],
133 'added': ['green', 'bold'],
133 'added': ['green', 'bold'],
134 'removed': ['red', 'bold'],
134 'removed': ['red', 'bold'],
135 'deleted': ['cyan', 'bold', 'underline'],
135 'deleted': ['cyan', 'bold', 'underline'],
136 'unknown': ['magenta', 'bold', 'underline'],
136 'unknown': ['magenta', 'bold', 'underline'],
137 'ignored': ['black', 'bold'],
137 'ignored': ['black', 'bold'],
138 'clean': ['none'],
138 'clean': ['none'],
139 'copied': ['none'], }
139 'copied': ['none'], }
140
140
141 def colorqseries(orig, ui, repo, *dummy, **opts):
141 def colorqseries(orig, ui, repo, *dummy, **opts):
142 '''run the qseries command with colored output'''
142 '''run the qseries command with colored output'''
143 ui.pushbuffer()
143 ui.pushbuffer()
144 retval = orig(ui, repo, **opts)
144 retval = orig(ui, repo, **opts)
145 patchlines = ui.popbuffer().splitlines()
145 patchlines = ui.popbuffer().splitlines()
146 patchnames = repo.mq.series
146 patchnames = repo.mq.series
147
147
148 for patch, patchname in zip(patchlines, patchnames):
148 for patch, patchname in zip(patchlines, patchnames):
149 if opts['missing']:
149 if opts['missing']:
150 effects = _patch_effects['missing']
150 effects = _patch_effects['missing']
151 # Determine if patch is applied.
151 # Determine if patch is applied.
152 elif [ applied for applied in repo.mq.applied
152 elif [ applied for applied in repo.mq.applied
153 if patchname == applied.name ]:
153 if patchname == applied.name ]:
154 effects = _patch_effects['applied']
154 effects = _patch_effects['applied']
155 else:
155 else:
156 effects = _patch_effects['unapplied']
156 effects = _patch_effects['unapplied']
157
157
158 patch = patch.replace(patchname, render_effects(patchname, effects), 1)
158 patch = patch.replace(patchname, render_effects(patchname, effects), 1)
159 ui.write(patch + '\n')
159 ui.write(patch + '\n')
160 return retval
160 return retval
161
161
162 _patch_effects = { 'applied': ['blue', 'bold', 'underline'],
162 _patch_effects = { 'applied': ['blue', 'bold', 'underline'],
163 'missing': ['red', 'bold'],
163 'missing': ['red', 'bold'],
164 'unapplied': ['black', 'bold'], }
164 'unapplied': ['black', 'bold'], }
165 def colorwrap(orig, *args):
165 def colorwrap(orig, *args):
166 '''wrap ui.write for colored diff output'''
166 '''wrap ui.write for colored diff output'''
167 def _colorize(s):
167 def _colorize(s):
168 lines = s.split('\n')
168 lines = s.split('\n')
169 for i, line in enumerate(lines):
169 for i, line in enumerate(lines):
170 stripline = line
170 stripline = line
171 if line and line[0] in '+-':
171 if line and line[0] in '+-':
172 # highlight trailing whitespace, but only in changed lines
172 # highlight trailing whitespace, but only in changed lines
173 stripline = line.rstrip()
173 stripline = line.rstrip()
174 for prefix, style in _diff_prefixes:
174 for prefix, style in _diff_prefixes:
175 if stripline.startswith(prefix):
175 if stripline.startswith(prefix):
176 lines[i] = render_effects(stripline, _diff_effects[style])
176 lines[i] = render_effects(stripline, _diff_effects[style])
177 break
177 break
178 if line != stripline:
178 if line != stripline:
179 lines[i] += render_effects(
179 lines[i] += render_effects(
180 line[len(stripline):], _diff_effects['trailingwhitespace'])
180 line[len(stripline):], _diff_effects['trailingwhitespace'])
181 return '\n'.join(lines)
181 return '\n'.join(lines)
182 orig(*[_colorize(s) for s in args])
182 orig(*[_colorize(s) for s in args])
183
183
184 def colorshowpatch(orig, self, node):
184 def colorshowpatch(orig, self, node):
185 '''wrap cmdutil.changeset_printer.showpatch with colored output'''
185 '''wrap cmdutil.changeset_printer.showpatch with colored output'''
186 oldwrite = extensions.wrapfunction(self.ui, 'write', colorwrap)
186 oldwrite = extensions.wrapfunction(self.ui, 'write', colorwrap)
187 try:
187 try:
188 orig(self, node)
188 orig(self, node)
189 finally:
189 finally:
190 self.ui.write = oldwrite
190 self.ui.write = oldwrite
191
191
192 def colordiffstat(orig, s):
192 def colordiffstat(orig, s):
193 lines = s.split('\n')
193 lines = s.split('\n')
194 for i, line in enumerate(lines):
194 for i, line in enumerate(lines):
195 if line and line[-1] in '+-':
195 if line and line[-1] in '+-':
196 name, graph = line.rsplit(' ', 1)
196 name, graph = line.rsplit(' ', 1)
197 graph = graph.replace('-',
197 graph = graph.replace('-',
198 render_effects('-', _diff_effects['deleted']))
198 render_effects('-', _diff_effects['deleted']))
199 graph = graph.replace('+',
199 graph = graph.replace('+',
200 render_effects('+', _diff_effects['inserted']))
200 render_effects('+', _diff_effects['inserted']))
201 lines[i] = ' '.join([name, graph])
201 lines[i] = ' '.join([name, graph])
202 orig('\n'.join(lines))
202 orig('\n'.join(lines))
203
203
204 def colordiff(orig, ui, repo, *pats, **opts):
204 def colordiff(orig, ui, repo, *pats, **opts):
205 '''run the diff command with colored output'''
205 '''run the diff command with colored output'''
206 if opts.get('stat'):
206 if opts.get('stat'):
207 wrapper = colordiffstat
207 wrapper = colordiffstat
208 else:
208 else:
209 wrapper = colorwrap
209 wrapper = colorwrap
210 oldwrite = extensions.wrapfunction(ui, 'write', wrapper)
210 oldwrite = extensions.wrapfunction(ui, 'write', wrapper)
211 try:
211 try:
212 orig(ui, repo, *pats, **opts)
212 orig(ui, repo, *pats, **opts)
213 finally:
213 finally:
214 ui.write = oldwrite
214 ui.write = oldwrite
215
215
216 def colorchurn(orig, ui, repo, *pats, **opts):
216 def colorchurn(orig, ui, repo, *pats, **opts):
217 '''run the churn command with colored output'''
217 '''run the churn command with colored output'''
218 if not opts.get('diffstat'):
218 if not opts.get('diffstat'):
219 return orig(ui, repo, *pats, **opts)
219 return orig(ui, repo, *pats, **opts)
220 oldwrite = extensions.wrapfunction(ui, 'write', colordiffstat)
220 oldwrite = extensions.wrapfunction(ui, 'write', colordiffstat)
221 try:
221 try:
222 orig(ui, repo, *pats, **opts)
222 orig(ui, repo, *pats, **opts)
223 finally:
223 finally:
224 ui.write = oldwrite
224 ui.write = oldwrite
225
225
226 _diff_prefixes = [('diff', 'diffline'),
226 _diff_prefixes = [('diff', 'diffline'),
227 ('copy', 'extended'),
227 ('copy', 'extended'),
228 ('rename', 'extended'),
228 ('rename', 'extended'),
229 ('old', 'extended'),
229 ('old', 'extended'),
230 ('new', 'extended'),
230 ('new', 'extended'),
231 ('deleted', 'extended'),
231 ('deleted', 'extended'),
232 ('---', 'file_a'),
232 ('---', 'file_a'),
233 ('+++', 'file_b'),
233 ('+++', 'file_b'),
234 ('@', 'hunk'),
234 ('@', 'hunk'),
235 ('-', 'deleted'),
235 ('-', 'deleted'),
236 ('+', 'inserted')]
236 ('+', 'inserted')]
237
237
238 _diff_effects = {'diffline': ['bold'],
238 _diff_effects = {'diffline': ['bold'],
239 'extended': ['cyan', 'bold'],
239 'extended': ['cyan', 'bold'],
240 'file_a': ['red', 'bold'],
240 'file_a': ['red', 'bold'],
241 'file_b': ['green', 'bold'],
241 'file_b': ['green', 'bold'],
242 'hunk': ['magenta'],
242 'hunk': ['magenta'],
243 'deleted': ['red'],
243 'deleted': ['red'],
244 'inserted': ['green'],
244 'inserted': ['green'],
245 'changed': ['white'],
245 'changed': ['white'],
246 'trailingwhitespace': ['bold', 'red_background']}
246 'trailingwhitespace': ['bold', 'red_background']}
247
247
248 def extsetup(ui):
248 def extsetup(ui):
249 '''Initialize the extension.'''
249 '''Initialize the extension.'''
250 _setupcmd(ui, 'diff', commands.table, colordiff, _diff_effects)
250 _setupcmd(ui, 'diff', commands.table, colordiff, _diff_effects)
251 _setupcmd(ui, 'incoming', commands.table, None, _diff_effects)
251 _setupcmd(ui, 'incoming', commands.table, None, _diff_effects)
252 _setupcmd(ui, 'log', commands.table, None, _diff_effects)
252 _setupcmd(ui, 'log', commands.table, None, _diff_effects)
253 _setupcmd(ui, 'outgoing', commands.table, None, _diff_effects)
253 _setupcmd(ui, 'outgoing', commands.table, None, _diff_effects)
254 _setupcmd(ui, 'tip', commands.table, None, _diff_effects)
254 _setupcmd(ui, 'tip', commands.table, None, _diff_effects)
255 _setupcmd(ui, 'status', commands.table, colorstatus, _status_effects)
255 _setupcmd(ui, 'status', commands.table, colorstatus, _status_effects)
256
256
257 try:
257 try:
258 mq = extensions.find('mq')
258 mq = extensions.find('mq')
259 _setupcmd(ui, 'qdiff', mq.cmdtable, colordiff, _diff_effects)
259 _setupcmd(ui, 'qdiff', mq.cmdtable, colordiff, _diff_effects)
260 _setupcmd(ui, 'qseries', mq.cmdtable, colorqseries, _patch_effects)
260 _setupcmd(ui, 'qseries', mq.cmdtable, colorqseries, _patch_effects)
261 except KeyError:
261 except KeyError:
262 mq = None
262 mq = None
263
263
264 try:
264 try:
265 rec = extensions.find('record')
265 rec = extensions.find('record')
266 _setupcmd(ui, 'record', rec.cmdtable, colordiff, _diff_effects)
266 _setupcmd(ui, 'record', rec.cmdtable, colordiff, _diff_effects)
267 except KeyError:
267 except KeyError:
268 rec = None
268 rec = None
269
269
270 if mq and rec:
270 if mq and rec:
271 _setupcmd(ui, 'qrecord', rec.cmdtable, colordiff, _diff_effects)
271 _setupcmd(ui, 'qrecord', rec.cmdtable, colordiff, _diff_effects)
272 try:
272 try:
273 churn = extensions.find('churn')
273 churn = extensions.find('churn')
274 _setupcmd(ui, 'churn', churn.cmdtable, colorchurn, _diff_effects)
274 _setupcmd(ui, 'churn', churn.cmdtable, colorchurn, _diff_effects)
275 except KeyError:
275 except KeyError:
276 churn = None
276 churn = None
277
277
278 def _setupcmd(ui, cmd, table, func, effectsmap):
278 def _setupcmd(ui, cmd, table, func, effectsmap):
279 '''patch in command to command table and load effect map'''
279 '''patch in command to command table and load effect map'''
280 def nocolor(orig, *args, **opts):
280 def nocolor(orig, *args, **opts):
281
281
282 if (opts['no_color'] or opts['color'] == 'never' or
282 if (opts['no_color'] or opts['color'] == 'never' or
283 (opts['color'] == 'auto' and (os.environ.get('TERM') == 'dumb'
283 (opts['color'] == 'auto' and (os.environ.get('TERM') == 'dumb'
284 or not sys.__stdout__.isatty()))):
284 or not sys.__stdout__.isatty()))):
285 del opts['no_color']
286 del opts['color']
285 return orig(*args, **opts)
287 return orig(*args, **opts)
286
288
287 oldshowpatch = extensions.wrapfunction(cmdutil.changeset_printer,
289 oldshowpatch = extensions.wrapfunction(cmdutil.changeset_printer,
288 'showpatch', colorshowpatch)
290 'showpatch', colorshowpatch)
291 del opts['no_color']
292 del opts['color']
289 try:
293 try:
290 if func is not None:
294 if func is not None:
291 return func(orig, *args, **opts)
295 return func(orig, *args, **opts)
292 return orig(*args, **opts)
296 return orig(*args, **opts)
293 finally:
297 finally:
294 cmdutil.changeset_printer.showpatch = oldshowpatch
298 cmdutil.changeset_printer.showpatch = oldshowpatch
295
299
296 entry = extensions.wrapcommand(table, cmd, nocolor)
300 entry = extensions.wrapcommand(table, cmd, nocolor)
297 entry[1].extend([
301 entry[1].extend([
298 ('', 'color', 'auto', _("when to colorize (always, auto, or never)")),
302 ('', 'color', 'auto', _("when to colorize (always, auto, or never)")),
299 ('', 'no-color', None, _("don't colorize output (DEPRECATED)")),
303 ('', 'no-color', None, _("don't colorize output (DEPRECATED)")),
300 ])
304 ])
301
305
302 for status in effectsmap:
306 for status in effectsmap:
303 configkey = cmd + '.' + status
307 configkey = cmd + '.' + status
304 effects = ui.configlist('color', configkey)
308 effects = ui.configlist('color', configkey)
305 if effects:
309 if effects:
306 good = []
310 good = []
307 for e in effects:
311 for e in effects:
308 if e in _effect_params:
312 if e in _effect_params:
309 good.append(e)
313 good.append(e)
310 else:
314 else:
311 ui.warn(_("ignoring unknown color/effect %r "
315 ui.warn(_("ignoring unknown color/effect %r "
312 "(configured in color.%s)\n")
316 "(configured in color.%s)\n")
313 % (e, configkey))
317 % (e, configkey))
314 effectsmap[status] = good
318 effectsmap[status] = good
General Comments 0
You need to be logged in to leave comments. Login now