Terminal.c 15 KB

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