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   systemd is free software; you can redistribute it and/or modify it
  10   under the terms of the GNU Lesser General Public License as published by
  11   the Free Software Foundation; either version 2.1 of the License, or
  12   (at your option) any later version.
  13
  14   systemd is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   Lesser General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  21 ***/
  22
  23 #include <stdarg.h>
  24 #include <stdbool.h>
  25 #include <stdio.h>
  26 #include <sys/types.h>
  27
  28 #include "macro.h"
  29 #include "time-util.h"
  30
  31 #define ANSI_RED "\x1B[0;31m"
  32 #define ANSI_GREEN "\x1B[0;32m"
  33 #define ANSI_UNDERLINE "\x1B[0;4m"
  34 #define ANSI_HIGHLIGHT "\x1B[0;1;39m"
  35 #define ANSI_HIGHLIGHT_RED "\x1B[0;1;31m"
  36 #define ANSI_HIGHLIGHT_GREEN "\x1B[0;1;32m"
  37 #define ANSI_HIGHLIGHT_YELLOW "\x1B[0;1;33m"
  38 #define ANSI_HIGHLIGHT_BLUE "\x1B[0;1;34m"
  39 #define ANSI_HIGHLIGHT_UNDERLINE "\x1B[0;1;4m"
  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_NORMAL "\x1B[0m"
  45
  46 #define ANSI_ERASE_TO_END_OF_LINE "\x1B[K"
  47
  48 /* Set cursor to top left corner and clear screen */
  49 #define ANSI_HOME_CLEAR "\x1B[H\x1B[2J"
  50
  51 int reset_terminal_fd(int fd, bool switch_to_text);
  52 int reset_terminal(const char *name);
  53
  54 int open_terminal(const char *name, int mode);
  55 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
  56 int release_terminal(void);
  57
  58 int terminal_vhangup_fd(int fd);
  59 int terminal_vhangup(const char *name);
  60
  61 int chvt(int vt);
  62
  63 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
  64 int ask_char(char *ret, const char *replies, const char *text, ...) _printf_(3, 4);
  65 int ask_string(char **ret, const char *text, ...) _printf_(2, 3);
  66
  67 int vt_disallocate(const char *name);
  68
  69 char *resolve_dev_console(char **active);
  70 int get_kernel_consoles(char ***consoles);
  71 bool tty_is_vc(const char *tty);
  72 bool tty_is_vc_resolve(const char *tty);
  73 bool tty_is_console(const char *tty) _pure_;
  74 int vtnr_from_tty(const char *tty);
  75 const char *default_term_for_tty(const char *tty);
  76
  77 int make_stdio(int fd);
  78 int make_null_stdio(void);
  79 int make_console_stdio(void);
  80
  81 int fd_columns(int fd);
  82 unsigned columns(void);
  83 int fd_lines(int fd);
  84 unsigned lines(void);
  85 void columns_lines_cache_reset(int _unused_ signum);
  86
  87 bool on_tty(void);
  88 bool terminal_is_dumb(void);
  89 bool colors_enabled(void);
  90 bool underline_enabled(void);
  91
  92 #define DEFINE_ANSI_FUNC(name, NAME)                            \
  93         static inline const char *ansi_##name(void) {           \
  94                 return colors_enabled() ? ANSI_##NAME : "";     \
  95         }                                                       \
  96         struct __useless_struct_to_allow_trailing_semicolon__
  97
  98 #define DEFINE_ANSI_FUNC_UNDERLINE(name, NAME, REPLACEMENT)             \
  99         static inline const char *ansi_##name(void) {                   \
 100                 return underline_enabled() ? ANSI_##NAME :              \
 101                         colors_enabled() ? ANSI_##REPLACEMENT : "";     \
 102         }                                                               \
 103         struct __useless_struct_to_allow_trailing_semicolon__
 104
 105
 106 DEFINE_ANSI_FUNC(highlight,                  HIGHLIGHT);
 107 DEFINE_ANSI_FUNC(highlight_red,              HIGHLIGHT_RED);
 108 DEFINE_ANSI_FUNC(highlight_green,            HIGHLIGHT_GREEN);
 109 DEFINE_ANSI_FUNC(highlight_yellow,           HIGHLIGHT_YELLOW);
 110 DEFINE_ANSI_FUNC(highlight_blue,             HIGHLIGHT_BLUE);
 111 DEFINE_ANSI_FUNC(normal,                     NORMAL);
 112
 113 DEFINE_ANSI_FUNC_UNDERLINE(underline,                  UNDERLINE, NORMAL);
 114 DEFINE_ANSI_FUNC_UNDERLINE(highlight_underline,        HIGHLIGHT_UNDERLINE, HIGHLIGHT);
 115 DEFINE_ANSI_FUNC_UNDERLINE(highlight_red_underline,    HIGHLIGHT_RED_UNDERLINE, HIGHLIGHT_RED);
 116 DEFINE_ANSI_FUNC_UNDERLINE(highlight_green_underline,  HIGHLIGHT_GREEN_UNDERLINE, HIGHLIGHT_GREEN);
 117 DEFINE_ANSI_FUNC_UNDERLINE(highlight_yellow_underline, HIGHLIGHT_YELLOW_UNDERLINE, HIGHLIGHT_YELLOW);
 118 DEFINE_ANSI_FUNC_UNDERLINE(highlight_blue_underline,   HIGHLIGHT_BLUE_UNDERLINE, HIGHLIGHT_BLUE);
 119
 120 int get_ctty_devnr(pid_t pid, dev_t *d);
 121 int get_ctty(pid_t, dev_t *_devnr, char **r);
 122
 123 int getttyname_malloc(int fd, char **r);
 124 int getttyname_harder(int fd, char **r);
 125
 126 int ptsname_malloc(int fd, char **ret);
 127 int ptsname_namespace(int pty, char **ret);
 128
 129 int openpt_in_namespace(pid_t pid, int flags);
 130 int open_terminal_in_namespace(pid_t pid, const char *name, int mode);
 131
 132 int vt_default_utf8(void);
 133 int vt_reset_keyboard(int fd);