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 <syslog.h>
   8 #include <sys/types.h>
   9
  10 #include "macro.h"
  11 #include "time-util.h"
  12
  13 /* Regular colors */
  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_GREY    "\x1B[0;38;5;245m"
  20
  21 /* Bold/highlighted */
  22 #define ANSI_HIGHLIGHT_RED               "\x1B[0;1;31m"
  23 #define ANSI_HIGHLIGHT_GREEN             "\x1B[0;1;32m"
  24 #define ANSI_HIGHLIGHT_YELLOW            "\x1B[0;1;38;5;185m"
  25 #define ANSI_HIGHLIGHT_BLUE              "\x1B[0;1;34m"
  26 #define ANSI_HIGHLIGHT_MAGENTA           "\x1B[0;1;35m"
  27 #define ANSI_HIGHLIGHT_GREY              "\x1B[0;1;38;5;245m"
  28 #define ANSI_HIGHLIGHT_YELLOW4           "\x1B[0;1;38;5;100m"
  29
  30 /* Underlined */
  31 #define ANSI_GREY_UNDERLINE              "\x1B[0;4;38;5;245m"
  32 #define ANSI_HIGHLIGHT_RED_UNDERLINE     "\x1B[0;1;4;31m"
  33 #define ANSI_HIGHLIGHT_GREEN_UNDERLINE   "\x1B[0;1;4;32m"
  34 #define ANSI_HIGHLIGHT_YELLOW_UNDERLINE  "\x1B[0;1;4;38;5;185m"
  35 #define ANSI_HIGHLIGHT_BLUE_UNDERLINE    "\x1B[0;1;4;34m"
  36 #define ANSI_HIGHLIGHT_MAGENTA_UNDERLINE "\x1B[0;1;4;35m"
  37 #define ANSI_HIGHLIGHT_GREY_UNDERLINE    "\x1B[0;1;4;38;5;245m"
  38
  39 /* Other ANSI codes */
  40 #define ANSI_UNDERLINE "\x1B[0;4m"
  41 #define ANSI_HIGHLIGHT "\x1B[0;1;39m"
  42 #define ANSI_HIGHLIGHT_UNDERLINE "\x1B[0;1;4m"
  43
  44 /* Reset/clear ANSI styles */
  45 #define ANSI_NORMAL "\x1B[0m"
  46
  47 /* Erase characters until the end of the line */
  48 #define ANSI_ERASE_TO_END_OF_LINE "\x1B[K"
  49
  50 /* Move cursor up one line */
  51 #define ANSI_REVERSE_LINEFEED "\x1BM"
  52
  53 /* Set cursor to top left corner and clear screen */
  54 #define ANSI_HOME_CLEAR "\x1B[H\x1B[2J"
  55
  56 int reset_terminal_fd(int fd, bool switch_to_text);
  57 int reset_terminal(const char *name);
  58
  59 int open_terminal(const char *name, int mode);
  60
  61 /* Flags for tweaking the way we become the controlling process of a terminal. */
  62 typedef enum AcquireTerminalFlags {
  63         /* Try to become the controlling process of the TTY. If we can't return -EPERM. */
  64         ACQUIRE_TERMINAL_TRY        = 0,
  65
  66         /* Tell the kernel to forcibly make us the controlling process of the TTY. Returns -EPERM if the kernel doesn't allow that. */
  67         ACQUIRE_TERMINAL_FORCE      = 1,
  68
  69         /* If we can't become the controlling process of the TTY right-away, then wait until we can. */
  70         ACQUIRE_TERMINAL_WAIT       = 2,
  71
  72         /* 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 */
  73         ACQUIRE_TERMINAL_PERMISSIVE = 1 << 2,
  74 } AcquireTerminalFlags;
  75
  76 int acquire_terminal(const char *name, AcquireTerminalFlags flags, usec_t timeout);
  77 int release_terminal(void);
  78
  79 int terminal_vhangup_fd(int fd);
  80 int terminal_vhangup(const char *name);
  81
  82 int chvt(int vt);
  83
  84 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
  85 int ask_char(char *ret, const char *replies, const char *text, ...) _printf_(3, 4);
  86 int ask_string(char **ret, const char *text, ...) _printf_(2, 3);
  87
  88 int vt_disallocate(const char *name);
  89
  90 int resolve_dev_console(char **ret);
  91 int get_kernel_consoles(char ***ret);
  92 bool tty_is_vc(const char *tty);
  93 bool tty_is_vc_resolve(const char *tty);
  94 bool tty_is_console(const char *tty) _pure_;
  95 int vtnr_from_tty(const char *tty);
  96 const char *default_term_for_tty(const char *tty);
  97
  98 int make_console_stdio(void);
  99
 100 int fd_columns(int fd);
 101 unsigned columns(void);
 102 int fd_lines(int fd);
 103 unsigned lines(void);
 104
 105 void columns_lines_cache_reset(int _unused_ signum);
 106 void reset_terminal_feature_caches(void);
 107
 108 bool on_tty(void);
 109 bool terminal_is_dumb(void);
 110 bool colors_enabled(void);
 111 bool underline_enabled(void);
 112 bool dev_console_colors_enabled(void);
 113
 114 #define DEFINE_ANSI_FUNC(name, NAME)                            \
 115         static inline const char *ansi_##name(void) {           \
 116                 return colors_enabled() ? ANSI_##NAME : "";     \
 117         }
 118
 119 #define DEFINE_ANSI_FUNC_UNDERLINE(name, NAME, REPLACEMENT)             \
 120         static inline const char *ansi_##name(void) {                   \
 121                 return underline_enabled() ? ANSI_##NAME :              \
 122                         colors_enabled() ? ANSI_##REPLACEMENT : "";     \
 123         }
 124
 125 DEFINE_ANSI_FUNC(normal,            NORMAL);
 126 DEFINE_ANSI_FUNC(highlight,         HIGHLIGHT);
 127 DEFINE_ANSI_FUNC(red,               RED);
 128 DEFINE_ANSI_FUNC(green,             GREEN);
 129 DEFINE_ANSI_FUNC(yellow,            YELLOW);
 130 DEFINE_ANSI_FUNC(blue,              BLUE);
 131 DEFINE_ANSI_FUNC(magenta,           MAGENTA);
 132 DEFINE_ANSI_FUNC(grey,              GREY);
 133 DEFINE_ANSI_FUNC(highlight_red,     HIGHLIGHT_RED);
 134 DEFINE_ANSI_FUNC(highlight_green,   HIGHLIGHT_GREEN);
 135 DEFINE_ANSI_FUNC(highlight_yellow,  HIGHLIGHT_YELLOW);
 136 DEFINE_ANSI_FUNC(highlight_blue,    HIGHLIGHT_BLUE);
 137 DEFINE_ANSI_FUNC(highlight_magenta, HIGHLIGHT_MAGENTA);
 138 DEFINE_ANSI_FUNC(highlight_grey,    HIGHLIGHT_GREY);
 139
 140 DEFINE_ANSI_FUNC_UNDERLINE(underline,                   UNDERLINE, NORMAL);
 141 DEFINE_ANSI_FUNC_UNDERLINE(highlight_underline,         HIGHLIGHT_UNDERLINE, HIGHLIGHT);
 142 DEFINE_ANSI_FUNC_UNDERLINE(grey_underline,              GREY_UNDERLINE, GREY);
 143 DEFINE_ANSI_FUNC_UNDERLINE(highlight_red_underline,     HIGHLIGHT_RED_UNDERLINE, HIGHLIGHT_RED);
 144 DEFINE_ANSI_FUNC_UNDERLINE(highlight_green_underline,   HIGHLIGHT_GREEN_UNDERLINE, HIGHLIGHT_GREEN);
 145 DEFINE_ANSI_FUNC_UNDERLINE(highlight_yellow_underline,  HIGHLIGHT_YELLOW_UNDERLINE, HIGHLIGHT_YELLOW);
 146 DEFINE_ANSI_FUNC_UNDERLINE(highlight_blue_underline,    HIGHLIGHT_BLUE_UNDERLINE, HIGHLIGHT_BLUE);
 147 DEFINE_ANSI_FUNC_UNDERLINE(highlight_magenta_underline, HIGHLIGHT_MAGENTA_UNDERLINE, HIGHLIGHT_MAGENTA);
 148 DEFINE_ANSI_FUNC_UNDERLINE(highlight_grey_underline,    HIGHLIGHT_GREY_UNDERLINE, HIGHLIGHT_GREY);
 149
 150 int get_ctty_devnr(pid_t pid, dev_t *d);
 151 int get_ctty(pid_t, dev_t *_devnr, char **r);
 152
 153 int getttyname_malloc(int fd, char **r);
 154 int getttyname_harder(int fd, char **r);
 155
 156 int ptsname_malloc(int fd, char **ret);
 157
 158 int openpt_allocate(int flags, char **ret_slave);
 159 int openpt_allocate_in_namespace(pid_t pid, int flags, char **ret_slave);
 160 int open_terminal_in_namespace(pid_t pid, const char *name, int mode);
 161
 162 int vt_default_utf8(void);
 163 int vt_reset_keyboard(int fd);
 164 int vt_restore(int fd);
 165 int vt_release(int fd, bool restore_vt);
 166
 167 void get_log_colors(int priority, const char **on, const char **off, const char **highlight);
 168
 169 /* This assumes there is a 'tty' group */
 170 #define TTY_MODE 0620