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