src/basic/terminal-util.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 #include <stdarg.h>
   5 #include <stdbool.h>
   6 #include <stdio.h>
   7 #include <sys/types.h>
   8
   9 #include "macro.h"
  10 #include "time-util.h"
  11
  12 /* Regular colors */
  13 #define ANSI_BLACK   "\x1B[0;30m"
  14 #define ANSI_RED     "\x1B[0;31m"
  15 #define ANSI_GREEN   "\x1B[0;32m"
  16 #define ANSI_YELLOW  "\x1B[0;33m"
  17 #define ANSI_BLUE    "\x1B[0;34m"
  18 #define ANSI_MAGENTA "\x1B[0;35m"
  19 #define ANSI_CYAN    "\x1B[0;36m"
  20 #define ANSI_WHITE   "\x1B[0;37m"
  21
  22 /* Bold/highlighted */
  23 #define ANSI_HIGHLIGHT_BLACK   "\x1B[0;1;30m"
  24 #define ANSI_HIGHLIGHT_RED     "\x1B[0;1;31m"
  25 #define ANSI_HIGHLIGHT_GREEN   "\x1B[0;1;32m"
  26 #define ANSI_HIGHLIGHT_YELLOW  "\x1B[0;1;33m"
  27 #define ANSI_HIGHLIGHT_BLUE    "\x1B[0;1;34m"
  28 #define ANSI_HIGHLIGHT_MAGENTA "\x1B[0;1;35m"
  29 #define ANSI_HIGHLIGHT_CYAN    "\x1B[0;1;36m"
  30 #define ANSI_HIGHLIGHT_WHITE   "\x1B[0;1;37m"
  31
  32 /* Underlined */
  33 #define ANSI_HIGHLIGHT_BLACK_UNDERLINE   "\x1B[0;1;4;30m"
  34 #define ANSI_HIGHLIGHT_RED_UNDERLINE     "\x1B[0;1;4;31m"
  35 #define ANSI_HIGHLIGHT_GREEN_UNDERLINE   "\x1B[0;1;4;32m"
  36 #define ANSI_HIGHLIGHT_YELLOW_UNDERLINE  "\x1B[0;1;4;33m"
  37 #define ANSI_HIGHLIGHT_BLUE_UNDERLINE    "\x1B[0;1;4;34m"
  38 #define ANSI_HIGHLIGHT_MAGENTA_UNDERLINE "\x1B[0;1;4;35m"
  39 #define ANSI_HIGHLIGHT_CYAN_UNDERLINE    "\x1B[0;1;4;36m"
  40 #define ANSI_HIGHLIGHT_WHITE_UNDERLINE   "\x1B[0;1;4;37m"
  41
  42 /* Other ANSI codes */
  43 #define ANSI_UNDERLINE "\x1B[0;4m"
  44 #define ANSI_HIGHLIGHT "\x1B[0;1;39m"
  45 #define ANSI_HIGHLIGHT_UNDERLINE "\x1B[0;1;4m"
  46
  47 /* Reset/clear ANSI styles */
  48 #define ANSI_NORMAL "\x1B[0m"
  49
  50 /* Erase characters until the end of the line */
  51 #define ANSI_ERASE_TO_END_OF_LINE "\x1B[K"
  52
  53 /* Move cursor up one line */
  54 #define ANSI_REVERSE_LINEFEED "\x1BM"
  55
  56 /* Set cursor to top left corner and clear screen */
  57 #define ANSI_HOME_CLEAR "\x1B[H\x1B[2J"
  58
  59 int reset_terminal_fd(int fd, bool switch_to_text);
  60 int reset_terminal(const char *name);
  61
  62 int open_terminal(const char *name, int mode);
  63
  64 /* Flags for tweaking the way we become the controlling process of a terminal. */
  65 typedef enum AcquireTerminalFlags {
  66         /* Try to become the controlling process of the TTY. If we can't return -EPERM. */
  67         ACQUIRE_TERMINAL_TRY        = 0,
  68
  69         /* Tell the kernel to forcibly make us the controlling process of the TTY. Returns -EPERM if the kernel doesn't allow that. */
  70         ACQUIRE_TERMINAL_FORCE      = 1,
  71
  72         /* If we can't become the controlling process of the TTY right-away, then wait until we can. */
  73         ACQUIRE_TERMINAL_WAIT       = 2,
  74
  75         /* Pick one of the above, and then OR this flag in, in order to request permissive behaviour, if we can't become controlling process then don't mind */
  76         ACQUIRE_TERMINAL_PERMISSIVE = 1 << 2,
  77 } AcquireTerminalFlags;
  78
  79 int acquire_terminal(const char *name, AcquireTerminalFlags flags, usec_t timeout);
  80 int release_terminal(void);
  81
  82 int terminal_vhangup_fd(int fd);
  83 int terminal_vhangup(const char *name);
  84
  85 int chvt(int vt);
  86
  87 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
  88 int ask_char(char *ret, const char *replies, const char *text, ...) _printf_(3, 4);
  89 int ask_string(char **ret, const char *text, ...) _printf_(2, 3);
  90
  91 int vt_disallocate(const char *name);
  92
  93 int resolve_dev_console(char **ret);
  94 int get_kernel_consoles(char ***ret);
  95 bool tty_is_vc(const char *tty);
  96 bool tty_is_vc_resolve(const char *tty);
  97 bool tty_is_console(const char *tty) _pure_;
  98 int vtnr_from_tty(const char *tty);
  99 const char *default_term_for_tty(const char *tty);
 100
 101 int make_console_stdio(void);
 102
 103 int fd_columns(int fd);
 104 unsigned columns(void);
 105 int fd_lines(int fd);
 106 unsigned lines(void);
 107
 108 void columns_lines_cache_reset(int _unused_ signum);
 109 void reset_terminal_feature_caches(void);
 110
 111 bool on_tty(void);
 112 bool terminal_is_dumb(void);
 113 bool colors_enabled(void);
 114 bool underline_enabled(void);
 115 bool dev_console_colors_enabled(void);
 116
 117 #define DEFINE_ANSI_FUNC(name, NAME)                            \
 118         static inline const char *ansi_##name(void) {           \
 119                 return colors_enabled() ? ANSI_##NAME : "";     \
 120         }
 121
 122 #define DEFINE_ANSI_FUNC_UNDERLINE(name, NAME, REPLACEMENT)             \
 123         static inline const char *ansi_##name(void) {                   \
 124                 return underline_enabled() ? ANSI_##NAME :              \
 125                         colors_enabled() ? ANSI_##REPLACEMENT : "";     \
 126         }
 127
 128 DEFINE_ANSI_FUNC(highlight,                  HIGHLIGHT);
 129 DEFINE_ANSI_FUNC(highlight_red,              HIGHLIGHT_RED);
 130 DEFINE_ANSI_FUNC(highlight_green,            HIGHLIGHT_GREEN);
 131 DEFINE_ANSI_FUNC(highlight_yellow,           HIGHLIGHT_YELLOW);
 132 DEFINE_ANSI_FUNC(highlight_blue,             HIGHLIGHT_BLUE);
 133 DEFINE_ANSI_FUNC(highlight_magenta,          HIGHLIGHT_MAGENTA);
 134 DEFINE_ANSI_FUNC(normal,                     NORMAL);
 135
 136 DEFINE_ANSI_FUNC_UNDERLINE(underline,                  UNDERLINE, NORMAL);
 137 DEFINE_ANSI_FUNC_UNDERLINE(highlight_underline,        HIGHLIGHT_UNDERLINE, HIGHLIGHT);
 138 DEFINE_ANSI_FUNC_UNDERLINE(highlight_red_underline,    HIGHLIGHT_RED_UNDERLINE, HIGHLIGHT_RED);
 139 DEFINE_ANSI_FUNC_UNDERLINE(highlight_green_underline,  HIGHLIGHT_GREEN_UNDERLINE, HIGHLIGHT_GREEN);
 140 DEFINE_ANSI_FUNC_UNDERLINE(highlight_yellow_underline, HIGHLIGHT_YELLOW_UNDERLINE, HIGHLIGHT_YELLOW);
 141 DEFINE_ANSI_FUNC_UNDERLINE(highlight_blue_underline,   HIGHLIGHT_BLUE_UNDERLINE, HIGHLIGHT_BLUE);
 142
 143 int get_ctty_devnr(pid_t pid, dev_t *d);
 144 int get_ctty(pid_t, dev_t *_devnr, char **r);
 145
 146 int getttyname_malloc(int fd, char **r);
 147 int getttyname_harder(int fd, char **r);
 148
 149 int ptsname_malloc(int fd, char **ret);
 150 int ptsname_namespace(int pty, char **ret);
 151
 152 int openpt_in_namespace(pid_t pid, int flags);
 153 int open_terminal_in_namespace(pid_t pid, const char *name, int mode);
 154
 155 int vt_default_utf8(void);
 156 int vt_reset_keyboard(int fd);
 157 int vt_restore(int fd);