Debian Codegraph @

Utilities/KWSys/Terminal.c

raw
1 /* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
2 file Copyright.txt or https://cmake.org/licensing#kwsys for details. */
3 #if !defined(_WIN32) && !defined(__APPLE__) && !defined(__OpenBSD__)
4 /* NOLINTNEXTLINE(bugprone-reserved-identifier) */
5 # define _XOPEN_SOURCE 600
6 #endif
7 #include "kwsysPrivate.h"
8 #include KWSYS_HEADER(Terminal.h)
9
10 /* Work-around CMake dependency scanning limitation. This must
11 duplicate the above list of headers. */
12 #if 0
13 # include "Terminal.h.in"
14 #endif
15
16 /* Configure support for this platform. */
17 #if defined(_WIN32)
18 # define KWSYS_TERMINAL_SUPPORT_CONSOLE
19 #endif
20 #if !defined(_WIN32)
21 # define KWSYS_TERMINAL_ISATTY_WORKS
22 #endif
23
24 /* Include needed system APIs. */
25
26 #include <stdarg.h> /* va_list */
27 #include <stdlib.h> /* getenv */
28 #include <string.h> /* strcmp */
29
30 #if defined(KWSYS_TERMINAL_SUPPORT_CONSOLE)
31 # include <io.h> /* _get_osfhandle */
32 # include <windows.h> /* SetConsoleTextAttribute */
33 #endif
34
35 #if defined(KWSYS_TERMINAL_ISATTY_WORKS)
36 # include <unistd.h> /* isatty */
37 #else
38 # include <sys/stat.h> /* fstat */
39 #endif
40
41 static int kwsysTerminalStreamIsVT100(FILE* stream, int default_vt100,
42 int default_tty);
43 static void kwsysTerminalSetVT100Color(FILE* stream, int color);
44 #if defined(KWSYS_TERMINAL_SUPPORT_CONSOLE)
45 static HANDLE kwsysTerminalGetStreamHandle(FILE* stream);
46 static void kwsysTerminalSetConsoleColor(HANDLE hOut,
47 CONSOLE_SCREEN_BUFFER_INFO* hOutInfo,
48 FILE* stream, int color);
49 #endif
50
51 void kwsysTerminal_cfprintf(int color, FILE* stream, const char* format, ...)
52 {
53 /* Setup the stream with the given color if possible. */
54 int pipeIsConsole = 0;
55 int pipeIsVT100 = 0;
56 int default_vt100 = color & kwsysTerminal_Color_AssumeVT100;
57 int default_tty = color & kwsysTerminal_Color_AssumeTTY;
58 #if defined(KWSYS_TERMINAL_SUPPORT_CONSOLE)
59 CONSOLE_SCREEN_BUFFER_INFO hOutInfo;
60 HANDLE hOut = kwsysTerminalGetStreamHandle(stream);
61 if (GetConsoleScreenBufferInfo(hOut, &hOutInfo)) {
62 pipeIsConsole = 1;
63 kwsysTerminalSetConsoleColor(hOut, &hOutInfo, stream, color);
64 }
65 #endif
66 if (!pipeIsConsole &&
67 kwsysTerminalStreamIsVT100(stream, default_vt100, default_tty)) {
68 pipeIsVT100 = 1;
69 kwsysTerminalSetVT100Color(stream, color);
70 }
71
72 /* Format the text into the stream. */
73 {
74 va_list var_args;
75 va_start(var_args, format);
76 vfprintf(stream, format, var_args);
77 va_end(var_args);
78 }
79
80 /* Restore the normal color state for the stream. */
81 #if defined(KWSYS_TERMINAL_SUPPORT_CONSOLE)
82 if (pipeIsConsole) {
83 kwsysTerminalSetConsoleColor(hOut, &hOutInfo, stream,
84 kwsysTerminal_Color_Normal);
85 }
86 #endif
87 if (pipeIsVT100) {
88 kwsysTerminalSetVT100Color(stream, kwsysTerminal_Color_Normal);
89 }
90 }
91
92 /* Detect cases when a stream is definitely not interactive. */
93 #if !defined(KWSYS_TERMINAL_ISATTY_WORKS)
94 static int kwsysTerminalStreamIsNotInteractive(FILE* stream)
95 {
96 /* The given stream is definitely not interactive if it is a regular
97 file. */
98 struct stat stream_stat;
99 if (fstat(fileno(stream), &stream_stat) == 0) {
100 if (stream_stat.st_mode & S_IFREG) {
101 return 1;
102 }
103 }
104 return 0;
105 }
106 #endif
107
108 /* List of terminal names known to support VT100 color escape sequences. */
109 static const char* kwsysTerminalVT100Names[] = { "Eterm",
110 "alacritty",
111 "alacritty-direct",
112 "ansi",
113 "color-xterm",
114 "con132x25",
115 "con132x30",
116 "con132x43",
117 "con132x60",
118 "con80x25",
119 "con80x28",
120 "con80x30",
121 "con80x43",
122 "con80x50",
123 "con80x60",
124 "cons25",
125 "console",
126 "cygwin",
127 "dtterm",
128 "eterm-color",
129 "gnome",
130 "gnome-256color",
131 "konsole",
132 "konsole-256color",
133 "kterm",
134 "linux",
135 "msys",
136 "linux-c",
137 "mach-color",
138 "mlterm",
139 "putty",
140 "putty-256color",
141 "rxvt",
142 "rxvt-256color",
143 "rxvt-cygwin",
144 "rxvt-cygwin-native",
145 "rxvt-unicode",
146 "rxvt-unicode-256color",
147 "screen",
148 "screen-256color",
149 "screen-256color-bce",
150 "screen-bce",
151 "screen-w",
152 "screen.linux",
153 "st-256color",
154 "tmux",
155 "tmux-256color",
156 "vt100",
157 "xterm",
158 "xterm-16color",
159 "xterm-256color",
160 "xterm-88color",
161 "xterm-color",
162 "xterm-debian",
163 "xterm-kitty",
164 "xterm-termite",
165 0 };
166
167 /* Detect whether a stream is displayed in a VT100-compatible terminal. */
168 static int kwsysTerminalStreamIsVT100(FILE* stream, int default_vt100,
169 int default_tty)
170 {
171 /* Force color according to http://bixense.com/clicolors/ convention. */
172 {
173 const char* clicolor_force = getenv("CLICOLOR_FORCE");
174 if (clicolor_force && *clicolor_force &&
175 strcmp(clicolor_force, "0") != 0) {
176 return 1;
177 }
178 }
179
180 /* Disable color according to http://bixense.com/clicolors/ convention. */
181 {
182 const char* clicolor = getenv("CLICOLOR");
183 if (clicolor && strcmp(clicolor, "0") == 0) {
184 return 0;
185 }
186 }
187
188 /* GNU make 4.1+ may tell us that its output is destined for a TTY. */
189 {
190 const char* termout = getenv("MAKE_TERMOUT");
191 if (termout && *termout != '\0') {
192 return 1;
193 }
194 }
195
196 /* If running inside emacs the terminal is not VT100. Some emacs
197 seem to claim the TERM is xterm even though they do not support
198 VT100 escapes. */
199 {
200 const char* emacs = getenv("EMACS");
201 if (emacs && *emacs == 't') {
202 return 0;
203 }
204 }
205
206 /* Check for a valid terminal. */
207 if (!default_vt100) {
208 const char** t = 0;
209 const char* term = getenv("TERM");
210 if (term) {
211 for (t = kwsysTerminalVT100Names; *t && strcmp(term, *t) != 0; ++t) {
212 }
213 }
214 if (!(t && *t)) {
215 return 0;
216 }
217 }
218
219 #if defined(KWSYS_TERMINAL_ISATTY_WORKS)
220 /* Make sure the stream is a tty. */
221 (void)default_tty;
222 return isatty(fileno(stream)) ? 1 : 0;
223 #else
224 /* Check for cases in which the stream is definitely not a tty. */
225 if (kwsysTerminalStreamIsNotInteractive(stream)) {
226 return 0;
227 }
228
229 /* Use the provided default for whether this is a tty. */
230 return default_tty;
231 #endif
232 }
233
234 /* VT100 escape sequence strings. */
235 #if defined(__MVS__)
236 /* if building on z/OS (aka MVS), assume we are using EBCDIC */
237 # define ESCAPE_CHAR "\47"
238 #else
239 # define ESCAPE_CHAR "\33"
240 #endif
241
242 #define KWSYS_TERMINAL_VT100_NORMAL ESCAPE_CHAR "[0m"
243 #define KWSYS_TERMINAL_VT100_BOLD ESCAPE_CHAR "[1m"
244 #define KWSYS_TERMINAL_VT100_UNDERLINE ESCAPE_CHAR "[4m"
245 #define KWSYS_TERMINAL_VT100_BLINK ESCAPE_CHAR "[5m"
246 #define KWSYS_TERMINAL_VT100_INVERSE ESCAPE_CHAR "[7m"
247 #define KWSYS_TERMINAL_VT100_FOREGROUND_BLACK ESCAPE_CHAR "[30m"
248 #define KWSYS_TERMINAL_VT100_FOREGROUND_RED ESCAPE_CHAR "[31m"
249 #define KWSYS_TERMINAL_VT100_FOREGROUND_GREEN ESCAPE_CHAR "[32m"
250 #define KWSYS_TERMINAL_VT100_FOREGROUND_YELLOW ESCAPE_CHAR "[33m"
251 #define KWSYS_TERMINAL_VT100_FOREGROUND_BLUE ESCAPE_CHAR "[34m"
252 #define KWSYS_TERMINAL_VT100_FOREGROUND_MAGENTA ESCAPE_CHAR "[35m"
253 #define KWSYS_TERMINAL_VT100_FOREGROUND_CYAN ESCAPE_CHAR "[36m"
254 #define KWSYS_TERMINAL_VT100_FOREGROUND_WHITE ESCAPE_CHAR "[37m"
255 #define KWSYS_TERMINAL_VT100_BACKGROUND_BLACK ESCAPE_CHAR "[40m"
256 #define KWSYS_TERMINAL_VT100_BACKGROUND_RED ESCAPE_CHAR "[41m"
257 #define KWSYS_TERMINAL_VT100_BACKGROUND_GREEN ESCAPE_CHAR "[42m"
258 #define KWSYS_TERMINAL_VT100_BACKGROUND_YELLOW ESCAPE_CHAR "[43m"
259 #define KWSYS_TERMINAL_VT100_BACKGROUND_BLUE ESCAPE_CHAR "[44m"
260 #define KWSYS_TERMINAL_VT100_BACKGROUND_MAGENTA ESCAPE_CHAR "[45m"
261 #define KWSYS_TERMINAL_VT100_BACKGROUND_CYAN ESCAPE_CHAR "[46m"
262 #define KWSYS_TERMINAL_VT100_BACKGROUND_WHITE ESCAPE_CHAR "[47m"
263
264 /* Write VT100 escape sequences to the stream for the given color. */
265 static void kwsysTerminalSetVT100Color(FILE* stream, int color)
266 {
267 if (color == kwsysTerminal_Color_Normal) {
268 fprintf(stream, KWSYS_TERMINAL_VT100_NORMAL);
269 return;
270 }
271
272 switch (color & kwsysTerminal_Color_ForegroundMask) {
273 case kwsysTerminal_Color_Normal:
274 fprintf(stream, KWSYS_TERMINAL_VT100_NORMAL);
275 break;
276 case kwsysTerminal_Color_ForegroundBlack:
277 fprintf(stream, KWSYS_TERMINAL_VT100_FOREGROUND_BLACK);
278 break;
279 case kwsysTerminal_Color_ForegroundRed:
280 fprintf(stream, KWSYS_TERMINAL_VT100_FOREGROUND_RED);
281 break;
282 case kwsysTerminal_Color_ForegroundGreen:
283 fprintf(stream, KWSYS_TERMINAL_VT100_FOREGROUND_GREEN);
284 break;
285 case kwsysTerminal_Color_ForegroundYellow:
286 fprintf(stream, KWSYS_TERMINAL_VT100_FOREGROUND_YELLOW);
287 break;
288 case kwsysTerminal_Color_ForegroundBlue:
289 fprintf(stream, KWSYS_TERMINAL_VT100_FOREGROUND_BLUE);
290 break;
291 case kwsysTerminal_Color_ForegroundMagenta:
292 fprintf(stream, KWSYS_TERMINAL_VT100_FOREGROUND_MAGENTA);
293 break;
294 case kwsysTerminal_Color_ForegroundCyan:
295 fprintf(stream, KWSYS_TERMINAL_VT100_FOREGROUND_CYAN);
296 break;
297 case kwsysTerminal_Color_ForegroundWhite:
298 fprintf(stream, KWSYS_TERMINAL_VT100_FOREGROUND_WHITE);
299 break;
300 }
301 switch (color & kwsysTerminal_Color_BackgroundMask) {
302 case kwsysTerminal_Color_BackgroundBlack:
303 fprintf(stream, KWSYS_TERMINAL_VT100_BACKGROUND_BLACK);
304 break;
305 case kwsysTerminal_Color_BackgroundRed:
306 fprintf(stream, KWSYS_TERMINAL_VT100_BACKGROUND_RED);
307 break;
308 case kwsysTerminal_Color_BackgroundGreen:
309 fprintf(stream, KWSYS_TERMINAL_VT100_BACKGROUND_GREEN);
310 break;
311 case kwsysTerminal_Color_BackgroundYellow:
312 fprintf(stream, KWSYS_TERMINAL_VT100_BACKGROUND_YELLOW);
313 break;
314 case kwsysTerminal_Color_BackgroundBlue:
315 fprintf(stream, KWSYS_TERMINAL_VT100_BACKGROUND_BLUE);
316 break;
317 case kwsysTerminal_Color_BackgroundMagenta:
318 fprintf(stream, KWSYS_TERMINAL_VT100_BACKGROUND_MAGENTA);
319 break;
320 case kwsysTerminal_Color_BackgroundCyan:
321 fprintf(stream, KWSYS_TERMINAL_VT100_BACKGROUND_CYAN);
322 break;
323 case kwsysTerminal_Color_BackgroundWhite:
324 fprintf(stream, KWSYS_TERMINAL_VT100_BACKGROUND_WHITE);
325 break;
326 }
327 if (color & kwsysTerminal_Color_ForegroundBold) {
328 fprintf(stream, KWSYS_TERMINAL_VT100_BOLD);
329 }
330 }
331
332 #if defined(KWSYS_TERMINAL_SUPPORT_CONSOLE)
333
334 # define KWSYS_TERMINAL_MASK_FOREGROUND \
335 (FOREGROUND_BLUE | FOREGROUND_GREEN | FOREGROUND_RED | \
336 FOREGROUND_INTENSITY)
337 # define KWSYS_TERMINAL_MASK_BACKGROUND \
338 (BACKGROUND_BLUE | BACKGROUND_GREEN | BACKGROUND_RED | \
339 BACKGROUND_INTENSITY)
340
341 /* Get the Windows handle for a FILE stream. */
342 static HANDLE kwsysTerminalGetStreamHandle(FILE* stream)
343 {
344 /* Get the C-library file descriptor from the stream. */
345 int fd = fileno(stream);
346
347 # if defined(__CYGWIN__)
348 /* Cygwin seems to have an extra pipe level. If the file descriptor
349 corresponds to stdout or stderr then obtain the matching windows
350 handle directly. */
351 if (fd == fileno(stdout)) {
352 return GetStdHandle(STD_OUTPUT_HANDLE);
353 } else if (fd == fileno(stderr)) {
354 return GetStdHandle(STD_ERROR_HANDLE);
355 }
356 # endif
357
358 /* Get the underlying Windows handle for the descriptor. */
359 return (HANDLE)_get_osfhandle(fd);
360 }
361
362 /* Set color attributes in a Windows console. */
363 static void kwsysTerminalSetConsoleColor(HANDLE hOut,
364 CONSOLE_SCREEN_BUFFER_INFO* hOutInfo,
365 FILE* stream, int color)
366 {
367 WORD attributes = 0;
368 switch (color & kwsysTerminal_Color_ForegroundMask) {
369 case kwsysTerminal_Color_Normal:
370 attributes |= hOutInfo->wAttributes & KWSYS_TERMINAL_MASK_FOREGROUND;
371 break;
372 case kwsysTerminal_Color_ForegroundBlack:
373 attributes |= 0;
374 break;
375 case kwsysTerminal_Color_ForegroundRed:
376 attributes |= FOREGROUND_RED;
377 break;
378 case kwsysTerminal_Color_ForegroundGreen:
379 attributes |= FOREGROUND_GREEN;
380 break;
381 case kwsysTerminal_Color_ForegroundYellow:
382 attributes |= FOREGROUND_RED | FOREGROUND_GREEN;
383 break;
384 case kwsysTerminal_Color_ForegroundBlue:
385 attributes |= FOREGROUND_BLUE;
386 break;
387 case kwsysTerminal_Color_ForegroundMagenta:
388 attributes |= FOREGROUND_RED | FOREGROUND_BLUE;
389 break;
390 case kwsysTerminal_Color_ForegroundCyan:
391 attributes |= FOREGROUND_BLUE | FOREGROUND_GREEN;
392 break;
393 case kwsysTerminal_Color_ForegroundWhite:
394 attributes |= FOREGROUND_BLUE | FOREGROUND_GREEN | FOREGROUND_RED;
395 break;
396 }
397 switch (color & kwsysTerminal_Color_BackgroundMask) {
398 case kwsysTerminal_Color_Normal:
399 attributes |= hOutInfo->wAttributes & KWSYS_TERMINAL_MASK_BACKGROUND;
400 break;
401 case kwsysTerminal_Color_BackgroundBlack:
402 attributes |= 0;
403 break;
404 case kwsysTerminal_Color_BackgroundRed:
405 attributes |= BACKGROUND_RED;
406 break;
407 case kwsysTerminal_Color_BackgroundGreen:
408 attributes |= BACKGROUND_GREEN;
409 break;
410 case kwsysTerminal_Color_BackgroundYellow:
411 attributes |= BACKGROUND_RED | BACKGROUND_GREEN;
412 break;
413 case kwsysTerminal_Color_BackgroundBlue:
414 attributes |= BACKGROUND_BLUE;
415 break;
416 case kwsysTerminal_Color_BackgroundMagenta:
417 attributes |= BACKGROUND_RED | BACKGROUND_BLUE;
418 break;
419 case kwsysTerminal_Color_BackgroundCyan:
420 attributes |= BACKGROUND_BLUE | BACKGROUND_GREEN;
421 break;
422 case kwsysTerminal_Color_BackgroundWhite:
423 attributes |= BACKGROUND_BLUE | BACKGROUND_GREEN | BACKGROUND_RED;
424 break;
425 }
426 if (color & kwsysTerminal_Color_ForegroundBold) {
427 attributes |= FOREGROUND_INTENSITY;
428 }
429 if (color & kwsysTerminal_Color_BackgroundBold) {
430 attributes |= BACKGROUND_INTENSITY;
431 }
432 fflush(stream);
433 SetConsoleTextAttribute(hOut, attributes);
434 }
435 #endif