##// END OF EJS Templates
color: respect HGPLAIN
Steve Borho -
r10871:3f301907 default
parent child Browse files
Show More
@@ -1,276 +1,278
1 1 # color.py color output for the status and qseries commands
2 2 #
3 3 # Copyright (C) 2007 Kevin Christen <kevin.christen@gmail.com>
4 4 #
5 5 # This program is free software; you can redistribute it and/or modify it
6 6 # under the terms of the GNU General Public License as published by the
7 7 # Free Software Foundation; either version 2 of the License, or (at your
8 8 # option) any later version.
9 9 #
10 10 # This program is distributed in the hope that it will be useful, but
11 11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
13 13 # Public License for more details.
14 14 #
15 15 # You should have received a copy of the GNU General Public License along
16 16 # with this program; if not, write to the Free Software Foundation, Inc.,
17 17 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 18
19 19 '''colorize output from some commands
20 20
21 21 This extension modifies the status and resolve commands to add color to their
22 22 output to reflect file status, the qseries command to add color to reflect
23 23 patch status (applied, unapplied, missing), and to diff-related
24 24 commands to highlight additions, removals, diff headers, and trailing
25 25 whitespace.
26 26
27 27 Other effects in addition to color, like bold and underlined text, are
28 28 also available. Effects are rendered with the ECMA-48 SGR control
29 29 function (aka ANSI escape codes). This module also provides the
30 30 render_text function, which can be used to add effects to any text.
31 31
32 32 Default effects may be overridden from the .hgrc file::
33 33
34 34 [color]
35 35 status.modified = blue bold underline red_background
36 36 status.added = green bold
37 37 status.removed = red bold blue_background
38 38 status.deleted = cyan bold underline
39 39 status.unknown = magenta bold underline
40 40 status.ignored = black bold
41 41
42 42 # 'none' turns off all effects
43 43 status.clean = none
44 44 status.copied = none
45 45
46 46 qseries.applied = blue bold underline
47 47 qseries.unapplied = black bold
48 48 qseries.missing = red bold
49 49
50 50 diff.diffline = bold
51 51 diff.extended = cyan bold
52 52 diff.file_a = red bold
53 53 diff.file_b = green bold
54 54 diff.hunk = magenta
55 55 diff.deleted = red
56 56 diff.inserted = green
57 57 diff.changed = white
58 58 diff.trailingwhitespace = bold red_background
59 59
60 60 resolve.unresolved = red bold
61 61 resolve.resolved = green bold
62 62
63 63 bookmarks.current = green
64 64
65 65 The color extension will try to detect whether to use ANSI codes or
66 66 Win32 console APIs, unless it is made explicit::
67 67
68 68 [color]
69 69 mode = ansi
70 70
71 71 Any value other than 'ansi', 'win32', or 'auto' will disable color.
72 72
73 73 '''
74 74
75 75 import os, sys
76 76
77 77 from mercurial import commands, dispatch, extensions
78 78 from mercurial.i18n import _
79 79
80 80 # start and stop parameters for effects
81 81 _effects = {'none': 0, 'black': 30, 'red': 31, 'green': 32, 'yellow': 33,
82 82 'blue': 34, 'magenta': 35, 'cyan': 36, 'white': 37, 'bold': 1,
83 83 'italic': 3, 'underline': 4, 'inverse': 7,
84 84 'black_background': 40, 'red_background': 41,
85 85 'green_background': 42, 'yellow_background': 43,
86 86 'blue_background': 44, 'purple_background': 45,
87 87 'cyan_background': 46, 'white_background': 47}
88 88
89 89 _styles = {'grep.match': 'red bold',
90 90 'diff.changed': 'white',
91 91 'diff.deleted': 'red',
92 92 'diff.diffline': 'bold',
93 93 'diff.extended': 'cyan bold',
94 94 'diff.file_a': 'red bold',
95 95 'diff.file_b': 'green bold',
96 96 'diff.hunk': 'magenta',
97 97 'diff.inserted': 'green',
98 98 'diff.trailingwhitespace': 'bold red_background',
99 99 'diffstat.deleted': 'red',
100 100 'diffstat.inserted': 'green',
101 101 'log.changeset': 'yellow',
102 102 'resolve.resolved': 'green bold',
103 103 'resolve.unresolved': 'red bold',
104 104 'status.added': 'green bold',
105 105 'status.clean': 'none',
106 106 'status.copied': 'none',
107 107 'status.deleted': 'cyan bold underline',
108 108 'status.ignored': 'black bold',
109 109 'status.modified': 'blue bold',
110 110 'status.removed': 'red bold',
111 111 'status.unknown': 'magenta bold underline'}
112 112
113 113
114 114 def render_effects(text, effects):
115 115 'Wrap text in commands to turn on each effect.'
116 116 if not text:
117 117 return text
118 118 start = [str(_effects[e]) for e in ['none'] + effects.split()]
119 119 start = '\033[' + ';'.join(start) + 'm'
120 120 stop = '\033[' + str(_effects['none']) + 'm'
121 121 return ''.join([start, text, stop])
122 122
123 123 def extstyles():
124 124 for name, ext in extensions.extensions():
125 125 _styles.update(getattr(ext, 'colortable', {}))
126 126
127 127 def configstyles(ui):
128 128 for status, cfgeffects in ui.configitems('color'):
129 129 if '.' not in status:
130 130 continue
131 131 cfgeffects = ui.configlist('color', status)
132 132 if cfgeffects:
133 133 good = []
134 134 for e in cfgeffects:
135 135 if e in _effects:
136 136 good.append(e)
137 137 else:
138 138 ui.warn(_("ignoring unknown color/effect %r "
139 139 "(configured in color.%s)\n")
140 140 % (e, status))
141 141 _styles[status] = ' '.join(good)
142 142
143 143 _buffers = None
144 144 def style(msg, label):
145 145 effects = []
146 146 for l in label.split():
147 147 s = _styles.get(l, '')
148 148 if s:
149 149 effects.append(s)
150 150 effects = ''.join(effects)
151 151 if effects:
152 152 return '\n'.join([render_effects(s, effects)
153 153 for s in msg.split('\n')])
154 154 return msg
155 155
156 156 def popbuffer(orig, labeled=False):
157 157 global _buffers
158 158 if labeled:
159 159 return ''.join(style(a, label) for a, label in _buffers.pop())
160 160 return ''.join(a for a, label in _buffers.pop())
161 161
162 162 mode = 'ansi'
163 163 def write(orig, *args, **opts):
164 164 label = opts.get('label', '')
165 165 global _buffers
166 166 if _buffers:
167 167 _buffers[-1].extend([(str(a), label) for a in args])
168 168 elif mode == 'win32':
169 169 for a in args:
170 170 win32print(a, orig, **opts)
171 171 else:
172 172 return orig(*[style(str(a), label) for a in args], **opts)
173 173
174 174 def write_err(orig, *args, **opts):
175 175 label = opts.get('label', '')
176 176 if mode == 'win32':
177 177 for a in args:
178 178 win32print(a, orig, **opts)
179 179 else:
180 180 return orig(*[style(str(a), label) for a in args], **opts)
181 181
182 182 def uisetup(ui):
183 if ui.plain():
184 return
183 185 global mode
184 186 mode = ui.config('color', 'mode', 'auto')
185 187 if mode == 'auto':
186 188 if os.name == 'nt' and 'TERM' not in os.environ:
187 189 # looks line a cmd.exe console, use win32 API or nothing
188 190 mode = w32effects and 'win32' or 'none'
189 191 else:
190 192 mode = 'ansi'
191 193 if mode == 'win32':
192 194 if w32effects is None:
193 195 # only warn if color.mode is explicitly set to win32
194 196 ui.warn(_('win32console not found, please install pywin32\n'))
195 197 return
196 198 _effects.update(w32effects)
197 199 elif mode != 'ansi':
198 200 return
199 201 def colorcmd(orig, ui_, opts, cmd, cmdfunc):
200 202 if (opts['color'] == 'always' or
201 203 (opts['color'] == 'auto' and (os.environ.get('TERM') != 'dumb'
202 204 and sys.__stdout__.isatty()))):
203 205 global _buffers
204 206 _buffers = ui_._buffers
205 207 extensions.wrapfunction(ui_, 'popbuffer', popbuffer)
206 208 extensions.wrapfunction(ui_, 'write', write)
207 209 extensions.wrapfunction(ui_, 'write_err', write_err)
208 210 ui_.label = style
209 211 extstyles()
210 212 configstyles(ui)
211 213 return orig(ui_, opts, cmd, cmdfunc)
212 214 extensions.wrapfunction(dispatch, '_runcommand', colorcmd)
213 215
214 216 commands.globalopts.append(('', 'color', 'auto',
215 217 _("when to colorize (always, auto, or never)")))
216 218
217 219 try:
218 220 import re
219 221 from win32console import *
220 222
221 223 # http://msdn.microsoft.com/en-us/library/ms682088%28VS.85%29.aspx
222 224 w32effects = {
223 225 'none': 0,
224 226 'black': 0,
225 227 'red': FOREGROUND_RED,
226 228 'green': FOREGROUND_GREEN,
227 229 'yellow': FOREGROUND_RED | FOREGROUND_GREEN,
228 230 'blue': FOREGROUND_BLUE,
229 231 'magenta': FOREGROUND_BLUE | FOREGROUND_RED,
230 232 'cyan': FOREGROUND_BLUE | FOREGROUND_GREEN,
231 233 'white': FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE,
232 234 'bold': FOREGROUND_INTENSITY,
233 235 'black_background': 0,
234 236 'red_background': BACKGROUND_RED,
235 237 'green_background': BACKGROUND_GREEN,
236 238 'blue_background': BACKGROUND_BLUE,
237 239 'cyan_background': BACKGROUND_BLUE | BACKGROUND_GREEN,
238 240 'bold_background': FOREGROUND_INTENSITY,
239 241 'underline': COMMON_LVB_UNDERSCORE, # double-byte charsets only
240 242 'inverse': COMMON_LVB_REVERSE_VIDEO, # double-byte charsets only
241 243 }
242 244
243 245 stdout = GetStdHandle(STD_OUTPUT_HANDLE)
244 246 origattr = stdout.GetConsoleScreenBufferInfo()['Attributes']
245 247 ansire = re.compile('\033\[([^m]*)m([^\033]*)(.*)', re.MULTILINE | re.DOTALL)
246 248
247 249 def win32print(text, orig, **opts):
248 250 label = opts.get('label', '')
249 251 attr = 0
250 252
251 253 # determine console attributes based on labels
252 254 for l in label.split():
253 255 style = _styles.get(l, '')
254 256 for effect in style.split():
255 257 attr |= w32effects[effect]
256 258
257 259 # hack to ensure regexp finds data
258 260 if not text.startswith('\033['):
259 261 text = '\033[m' + text
260 262
261 263 # Look for ANSI-like codes embedded in text
262 264 m = re.match(ansire, text)
263 265 while m:
264 266 for sattr in m.group(1).split(';'):
265 267 if sattr:
266 268 val = int(sattr)
267 269 attr = val and attr|val or 0
268 270 stdout.SetConsoleTextAttribute(attr or origattr)
269 271 orig(m.group(2), **opts)
270 272 m = re.match(ansire, m.group(3))
271 273
272 274 # Explicity reset original attributes
273 275 stdout.SetConsoleTextAttribute(origattr)
274 276
275 277 except ImportError:
276 278 w32effects = None
General Comments 0
You need to be logged in to leave comments. Login now