src/basic/terminal-util.h

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