2 * Copyright 2008 Peter Harris <git@peter.is-a-geek.org>
8 * Including the appropriate header file for RtlGenRandom causes MSVC to see a
9 * redefinition of types in an incompatible way when including headers below.
11 #undef HAVE_RTLGENRANDOM
12 #include "../git-compat-util.h"
16 #include "win32/lazyload.h"
18 static int fd_is_interactive
[3] = { 0, 0, 0 };
19 #define FD_CONSOLE 0x1
20 #define FD_SWAPPED 0x2
24 ANSI codes used by git: m, K
26 This file is git-specific. Therefore, this file does not attempt
27 to implement any codes that are not used by git.
30 static HANDLE console
;
31 static WORD plain_attr
;
34 static int non_ascii_used
= 0;
35 static HANDLE hthread
, hread
, hwrite
;
36 static HANDLE hconsole1
, hconsole2
;
39 #if !defined(__MINGW64_VERSION_MAJOR) || __MINGW64_VERSION_MAJOR < 5
40 typedef struct _CONSOLE_FONT_INFOEX
{
46 WCHAR FaceName
[LF_FACESIZE
];
47 } CONSOLE_FONT_INFOEX
, *PCONSOLE_FONT_INFOEX
;
51 static void warn_if_raster_font(void)
54 DECLARE_PROC_ADDR(kernel32
.dll
, BOOL
, WINAPI
,
55 GetCurrentConsoleFontEx
, HANDLE
, BOOL
,
56 PCONSOLE_FONT_INFOEX
);
58 /* don't bother if output was ascii only */
62 /* GetCurrentConsoleFontEx is available since Vista */
63 if (INIT_PROC_ADDR(GetCurrentConsoleFontEx
)) {
64 CONSOLE_FONT_INFOEX cfi
;
65 cfi
.cbSize
= sizeof(cfi
);
66 if (GetCurrentConsoleFontEx(console
, 0, &cfi
))
67 fontFamily
= cfi
.FontFamily
;
69 /* pre-Vista: check default console font in registry */
71 if (ERROR_SUCCESS
== RegOpenKeyExA(HKEY_CURRENT_USER
, "Console",
72 0, KEY_READ
, &hkey
)) {
73 DWORD size
= sizeof(fontFamily
);
74 RegQueryValueExA(hkey
, "FontFamily", NULL
, NULL
,
75 (LPVOID
) &fontFamily
, &size
);
80 if (!(fontFamily
& TMPF_TRUETYPE
)) {
81 const wchar_t *msg
= L
"\nWarning: Your console font probably "
82 L
"doesn\'t support Unicode. If you experience strange "
83 L
"characters in the output, consider switching to a "
84 L
"TrueType font such as Consolas!\n";
86 WriteConsoleW(console
, msg
, wcslen(msg
), &dummy
, NULL
);
90 static int is_console(int fd
)
92 CONSOLE_SCREEN_BUFFER_INFO sbi
;
96 static int initialized
= 0;
98 /* get OS handle of the file descriptor */
99 hcon
= (HANDLE
) _get_osfhandle(fd
);
100 if (hcon
== INVALID_HANDLE_VALUE
)
103 /* check if its a device (i.e. console, printer, serial port) */
104 if (GetFileType(hcon
) != FILE_TYPE_CHAR
)
107 /* check if its a handle to a console output screen buffer */
109 if (!GetConsoleMode(hcon
, &mode
))
112 * This code path is only reached if there is no console
113 * attached to stdout/stderr, i.e. we will not need to output
114 * any text to any console, therefore we might just as well
115 * use black as foreground color.
118 } else if (!GetConsoleScreenBufferInfo(hcon
, &sbi
))
121 if (fd
>= 0 && fd
<= 2)
122 fd_is_interactive
[fd
] |= FD_CONSOLE
;
124 /* initialize attributes */
127 attr
= plain_attr
= sbi
.wAttributes
;
135 #define BUFFER_SIZE 4096
136 #define MAX_PARAMS 16
138 static void write_console(unsigned char *str
, size_t len
)
140 /* only called from console_thread, so a static buffer will do */
141 static wchar_t wbuf
[2 * BUFFER_SIZE
+ 1];
144 /* convert utf-8 to utf-16 */
145 int wlen
= xutftowcsn(wbuf
, (char*) str
, ARRAY_SIZE(wbuf
), len
);
147 wchar_t *err
= L
"[invalid]";
148 WriteConsoleW(console
, err
, wcslen(err
), &dummy
, NULL
);
152 /* write directly to console */
153 WriteConsoleW(console
, wbuf
, wlen
, &dummy
, NULL
);
155 /* remember if non-ascii characters are printed */
160 #define FOREGROUND_ALL (FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE)
161 #define BACKGROUND_ALL (BACKGROUND_RED | BACKGROUND_GREEN | BACKGROUND_BLUE)
163 static void set_console_attr(void)
165 WORD attributes
= attr
;
167 attributes
&= ~FOREGROUND_ALL
;
168 attributes
&= ~BACKGROUND_ALL
;
170 /* This could probably use a bitmask
171 instead of a series of ifs */
172 if (attr
& FOREGROUND_RED
)
173 attributes
|= BACKGROUND_RED
;
174 if (attr
& FOREGROUND_GREEN
)
175 attributes
|= BACKGROUND_GREEN
;
176 if (attr
& FOREGROUND_BLUE
)
177 attributes
|= BACKGROUND_BLUE
;
179 if (attr
& BACKGROUND_RED
)
180 attributes
|= FOREGROUND_RED
;
181 if (attr
& BACKGROUND_GREEN
)
182 attributes
|= FOREGROUND_GREEN
;
183 if (attr
& BACKGROUND_BLUE
)
184 attributes
|= FOREGROUND_BLUE
;
186 SetConsoleTextAttribute(console
, attributes
);
189 static void erase_in_line(void)
191 CONSOLE_SCREEN_BUFFER_INFO sbi
;
192 DWORD dummy
; /* Needed for Windows 7 (or Vista) regression */
197 GetConsoleScreenBufferInfo(console
, &sbi
);
198 FillConsoleOutputCharacterA(console
, ' ',
199 sbi
.dwSize
.X
- sbi
.dwCursorPosition
.X
, sbi
.dwCursorPosition
,
203 static void set_attr(char func
, const int *params
, int paramlen
)
208 for (i
= 0; i
< paramlen
; i
++) {
215 attr
|= FOREGROUND_INTENSITY
;
218 case 22: /* normal */
219 attr
&= ~FOREGROUND_INTENSITY
;
224 case 4: /* underline */
225 case 21: /* double underline */
226 /* Wikipedia says this flag does nothing */
227 /* Furthermore, mingw doesn't define this flag
228 attr |= COMMON_LVB_UNDERSCORE; */
230 case 24: /* no underline */
231 /* attr &= ~COMMON_LVB_UNDERSCORE; */
233 case 5: /* slow blink */
234 case 6: /* fast blink */
235 /* We don't have blink, but we do have
236 background intensity */
237 attr
|= BACKGROUND_INTENSITY
;
239 case 25: /* no blink */
240 attr
&= ~BACKGROUND_INTENSITY
;
242 case 7: /* negative */
245 case 27: /* positive */
248 case 8: /* conceal */
249 case 28: /* reveal */
253 attr
&= ~FOREGROUND_ALL
;
256 attr
&= ~FOREGROUND_ALL
;
257 attr
|= FOREGROUND_RED
;
260 attr
&= ~FOREGROUND_ALL
;
261 attr
|= FOREGROUND_GREEN
;
263 case 33: /* Yellow */
264 attr
&= ~FOREGROUND_ALL
;
265 attr
|= FOREGROUND_RED
| FOREGROUND_GREEN
;
268 attr
&= ~FOREGROUND_ALL
;
269 attr
|= FOREGROUND_BLUE
;
271 case 35: /* Magenta */
272 attr
&= ~FOREGROUND_ALL
;
273 attr
|= FOREGROUND_RED
| FOREGROUND_BLUE
;
276 attr
&= ~FOREGROUND_ALL
;
277 attr
|= FOREGROUND_GREEN
| FOREGROUND_BLUE
;
280 attr
|= FOREGROUND_RED
|
284 case 38: /* Unknown */
287 attr
&= ~FOREGROUND_ALL
;
288 attr
|= (plain_attr
& FOREGROUND_ALL
);
291 attr
&= ~BACKGROUND_ALL
;
294 attr
&= ~BACKGROUND_ALL
;
295 attr
|= BACKGROUND_RED
;
298 attr
&= ~BACKGROUND_ALL
;
299 attr
|= BACKGROUND_GREEN
;
301 case 43: /* Yellow */
302 attr
&= ~BACKGROUND_ALL
;
303 attr
|= BACKGROUND_RED
| BACKGROUND_GREEN
;
306 attr
&= ~BACKGROUND_ALL
;
307 attr
|= BACKGROUND_BLUE
;
309 case 45: /* Magenta */
310 attr
&= ~BACKGROUND_ALL
;
311 attr
|= BACKGROUND_RED
| BACKGROUND_BLUE
;
314 attr
&= ~BACKGROUND_ALL
;
315 attr
|= BACKGROUND_GREEN
| BACKGROUND_BLUE
;
318 attr
|= BACKGROUND_RED
|
322 case 48: /* Unknown */
325 attr
&= ~BACKGROUND_ALL
;
326 attr
|= (plain_attr
& BACKGROUND_ALL
);
329 /* Unsupported code */
339 /* Unsupported code */
345 TEXT
= 0, ESCAPE
= 033, BRACKET
= '['
348 static DWORD WINAPI
console_thread(LPVOID unused
)
350 unsigned char buffer
[BUFFER_SIZE
];
352 int start
, end
= 0, c
, parampos
= 0, state
= TEXT
;
353 int params
[MAX_PARAMS
];
356 /* read next chunk of bytes from the pipe */
357 if (!ReadFile(hread
, buffer
+ end
, BUFFER_SIZE
- end
, &bytes
,
359 /* exit if pipe has been closed or disconnected */
360 if (GetLastError() == ERROR_PIPE_NOT_CONNECTED
||
361 GetLastError() == ERROR_BROKEN_PIPE
)
363 /* ignore other errors */
367 /* scan the bytes and handle ANSI control codes */
370 while (end
< bytes
) {
375 /* print text seen so far */
377 write_console(buffer
+ start
,
380 /* then start parsing escape sequence */
382 memset(params
, 0, sizeof(params
));
389 /* continue if "\033[", otherwise bail out */
390 state
= (c
== BRACKET
) ? BRACKET
: TEXT
;
394 /* parse [0-9;]* into array of parameters */
395 if (c
>= '0' && c
<= '9') {
396 params
[parampos
] *= 10;
397 params
[parampos
] += c
- '0';
398 } else if (c
== ';') {
400 * next parameter, bail out if out of
404 if (parampos
>= MAX_PARAMS
)
408 * end of escape sequence, change
411 set_attr(c
, params
, parampos
+ 1);
419 /* print remaining text unless parsing an escape sequence */
420 if (state
== TEXT
&& end
> start
) {
421 /* check for incomplete UTF-8 sequences and fix end */
422 if (buffer
[end
- 1] >= 0x80) {
423 if (buffer
[end
-1] >= 0xc0)
425 else if (end
- 1 > start
&&
426 buffer
[end
- 2] >= 0xe0)
428 else if (end
- 2 > start
&&
429 buffer
[end
- 3] >= 0xf0)
433 /* print remaining complete UTF-8 sequences */
435 write_console(buffer
+ start
, end
- start
);
437 /* move remaining bytes to the front */
439 memmove(buffer
, buffer
+ end
, bytes
- end
);
442 /* all data has been consumed, mark buffer empty */
447 /* check if the console font supports unicode */
448 warn_if_raster_font();
454 static void winansi_exit(void)
456 /* flush all streams */
459 /* signal console thread to exit */
460 FlushFileBuffers(hwrite
);
461 DisconnectNamedPipe(hwrite
);
463 /* wait for console thread to copy remaining data */
464 WaitForSingleObject(hthread
, INFINITE
);
466 /* cleanup handles... */
468 CloseHandle(hthread
);
471 static void die_lasterr(const char *fmt
, ...)
474 va_start(params
, fmt
);
475 errno
= err_win_to_posix(GetLastError());
476 die_errno(fmt
, params
);
481 int winansi_dup2(int oldfd
, int newfd
)
483 int ret
= dup2(oldfd
, newfd
);
485 if (!ret
&& newfd
>= 0 && newfd
<= 2)
486 fd_is_interactive
[newfd
] = oldfd
< 0 || oldfd
> 2 ?
487 0 : fd_is_interactive
[oldfd
];
492 static HANDLE
duplicate_handle(HANDLE hnd
)
494 HANDLE hresult
, hproc
= GetCurrentProcess();
495 if (!DuplicateHandle(hproc
, hnd
, hproc
, &hresult
, 0, TRUE
,
496 DUPLICATE_SAME_ACCESS
))
497 die_lasterr("DuplicateHandle(%li) failed",
498 (long) (intptr_t) hnd
);
502 static HANDLE
swap_osfhnd(int fd
, HANDLE new_handle
)
505 * Create a copy of the original handle associated with fd
506 * because the original will get closed when we dup2().
508 HANDLE handle
= (HANDLE
)_get_osfhandle(fd
);
509 HANDLE duplicate
= duplicate_handle(handle
);
511 /* Create a temp fd associated with the already open "new_handle". */
512 int new_fd
= _open_osfhandle((intptr_t)new_handle
, O_BINARY
);
514 assert((fd
== 1) || (fd
== 2));
517 * Use stock dup2() to re-bind fd to the new handle. Note that
518 * this will implicitly close(1) and close both fd=1 and the
519 * originally associated handle. It will open a new fd=1 and
520 * call DuplicateHandle() on the handle associated with new_fd.
521 * It is because of this implicit close() that we created the
522 * copy of the original.
524 * Note that we need to update the cached console handle to the
525 * duplicated one because the dup2() call will implicitly close
528 * Note that dup2() when given target := {0,1,2} will also
529 * call SetStdHandle(), so we don't need to worry about that.
531 if (console
== handle
)
535 /* Close the temp fd. This explicitly closes "new_handle"
536 * (because it has been associated with it).
541 setvbuf(stderr
, NULL
, _IONBF
, BUFSIZ
);
542 fd_is_interactive
[fd
] |= FD_SWAPPED
;
547 #ifdef DETECT_MSYS_TTY
549 #include <winternl.h>
551 #if defined(_MSC_VER)
553 typedef struct _OBJECT_NAME_INFORMATION
556 WCHAR NameBuffer
[FLEX_ARRAY
];
557 } OBJECT_NAME_INFORMATION
, *POBJECT_NAME_INFORMATION
;
559 #define ObjectNameInformation 1
562 #include <ntstatus.h>
565 static void detect_msys_tty(int fd
)
569 POBJECT_NAME_INFORMATION nameinfo
= (POBJECT_NAME_INFORMATION
) buffer
;
572 /* check if fd is a pipe */
573 HANDLE h
= (HANDLE
) _get_osfhandle(fd
);
574 if (GetFileType(h
) != FILE_TYPE_PIPE
)
578 if (!NT_SUCCESS(NtQueryObject(h
, ObjectNameInformation
,
579 buffer
, sizeof(buffer
) - 2, &result
)))
581 name
= nameinfo
->Name
.Buffer
;
582 name
[nameinfo
->Name
.Length
/ sizeof(*name
)] = 0;
585 * Check if this could be a MSYS2 pty pipe ('msys-XXXX-ptyN-XX')
586 * or a cygwin pty pipe ('cygwin-XXXX-ptyN-XX')
588 if ((!wcsstr(name
, L
"msys-") && !wcsstr(name
, L
"cygwin-")) ||
589 !wcsstr(name
, L
"-pty"))
593 setvbuf(stderr
, NULL
, _IONBF
, BUFSIZ
);
594 fd_is_interactive
[fd
] |= FD_MSYS
;
600 * Wrapper for isatty(). Most calls in the main git code
601 * call isatty(1 or 2) to see if the instance is interactive
602 * and should: be colored, show progress, paginate output.
603 * We lie and give results for what the descriptor WAS at
604 * startup (and ignore any pipe redirection we internally
608 int winansi_isatty(int fd
)
610 if (fd
>= 0 && fd
<= 2)
611 return fd_is_interactive
[fd
] != 0;
615 void winansi_init(void)
620 /* check if either stdout or stderr is a console output screen buffer */
621 con1
= is_console(1);
622 con2
= is_console(2);
624 /* Also compute console bit for fd 0 even though we don't need the result here. */
627 if (!con1
&& !con2
) {
628 #ifdef DETECT_MSYS_TTY
629 /* check if stdin / stdout / stderr are MSYS2 pty pipes */
637 /* create a named pipe to communicate with the console thread */
638 if (swprintf(name
, ARRAY_SIZE(name
) - 1, L
"\\\\.\\pipe\\winansi%lu",
639 GetCurrentProcessId()) < 0)
640 die("Could not initialize winansi pipe name");
641 hwrite
= CreateNamedPipeW(name
, PIPE_ACCESS_OUTBOUND
,
642 PIPE_TYPE_BYTE
| PIPE_WAIT
, 1, BUFFER_SIZE
, 0, 0, NULL
);
643 if (hwrite
== INVALID_HANDLE_VALUE
)
644 die_lasterr("CreateNamedPipe failed");
646 hread
= CreateFileW(name
, GENERIC_READ
, 0, NULL
, OPEN_EXISTING
, 0, NULL
);
647 if (hread
== INVALID_HANDLE_VALUE
)
648 die_lasterr("CreateFile for named pipe failed");
650 /* start console spool thread on the pipe's read end */
651 hthread
= CreateThread(NULL
, 0, console_thread
, NULL
, 0, NULL
);
652 if (hthread
== INVALID_HANDLE_VALUE
)
653 die_lasterr("CreateThread(console_thread) failed");
655 /* schedule cleanup routine */
656 if (atexit(winansi_exit
))
657 die_errno("atexit(winansi_exit) failed");
659 /* redirect stdout / stderr to the pipe */
661 hconsole1
= swap_osfhnd(1, duplicate_handle(hwrite
));
663 hconsole2
= swap_osfhnd(2, duplicate_handle(hwrite
));
667 * Returns the real console handle if stdout / stderr is a pipe redirecting
668 * to the console. Allows spawn / exec to pass the console to the next process.
670 HANDLE
winansi_get_osfhandle(int fd
)
674 if (fd
== 1 && (fd_is_interactive
[1] & FD_SWAPPED
))
676 if (fd
== 2 && (fd_is_interactive
[2] & FD_SWAPPED
))
679 ret
= (HANDLE
)_get_osfhandle(fd
);
682 * There are obviously circumstances under which _get_osfhandle()
683 * returns (HANDLE)-2. This is not documented anywhere, but that is so
684 * clearly an invalid handle value that we can just work around this
685 * and return the correct value for invalid handles.
687 return ret
== (HANDLE
)-2 ? INVALID_HANDLE_VALUE
: ret
;