src/basic/terminal-util.h

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