src/basic/terminal-util.h

   1 #pragma once
   2
   3 /***
   4   This file is part of systemd.
   5
   6   Copyright 2010 Lennart Poettering
   7
   8   systemd is free software; you can redistribute it and/or modify it
   9   under the terms of the GNU Lesser General Public License as published by
  10   the Free Software Foundation; either version 2.1 of the License, or
  11   (at your option) any later version.
  12
  13   systemd is distributed in the hope that it will be useful, but
  14   WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16   Lesser General Public License for more details.
  17
  18   You should have received a copy of the GNU Lesser General Public License
  19   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  20 ***/
  21
  22 #include <stdarg.h>
  23 #include <stdbool.h>
  24 #include <stdio.h>
  25 #include <sys/types.h>
  26
  27 #include "macro.h"
  28 #include "time-util.h"
  29
  30 #define ANSI_RED "\x1B[0;31m"
  31 #define ANSI_GREEN "\x1B[0;32m"
  32 #define ANSI_UNDERLINE "\x1B[0;4m"
  33 #define ANSI_HIGHLIGHT "\x1B[0;1;39m"
  34 #define ANSI_HIGHLIGHT_RED "\x1B[0;1;31m"
  35 #define ANSI_HIGHLIGHT_GREEN "\x1B[0;1;32m"
  36 #define ANSI_HIGHLIGHT_YELLOW "\x1B[0;1;33m"
  37 #define ANSI_HIGHLIGHT_BLUE "\x1B[0;1;34m"
  38 #define ANSI_HIGHLIGHT_UNDERLINE "\x1B[0;1;4m"
  39 #define ANSI_HIGHLIGHT_RED_UNDERLINE "\x1B[0;1;4;31m"
  40 #define ANSI_HIGHLIGHT_GREEN_UNDERLINE "\x1B[0;1;4;32m"
  41 #define ANSI_HIGHLIGHT_YELLOW_UNDERLINE "\x1B[0;1;4;33m"
  42 #define ANSI_HIGHLIGHT_BLUE_UNDERLINE "\x1B[0;1;4;34m"
  43 #define ANSI_NORMAL "\x1B[0m"
  44
  45 #define ANSI_ERASE_TO_END_OF_LINE "\x1B[K"
  46
  47 /* Set cursor to top left corner and clear screen */
  48 #define ANSI_HOME_CLEAR "\x1B[H\x1B[2J"
  49
  50 int reset_terminal_fd(int fd, bool switch_to_text);
  51 int reset_terminal(const char *name);
  52
  53 int open_terminal(const char *name, int mode);
  54 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
  55 int release_terminal(void);
  56
  57 int terminal_vhangup_fd(int fd);
  58 int terminal_vhangup(const char *name);
  59
  60 int chvt(int vt);
  61
  62 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
  63 int ask_char(char *ret, const char *replies, const char *text, ...) _printf_(3, 4);
  64 int ask_string(char **ret, const char *text, ...) _printf_(2, 3);
  65
  66 int vt_disallocate(const char *name);
  67
  68 char *resolve_dev_console(char **active);
  69 int get_kernel_consoles(char ***consoles);
  70 bool tty_is_vc(const char *tty);
  71 bool tty_is_vc_resolve(const char *tty);
  72 bool tty_is_console(const char *tty) _pure_;
  73 int vtnr_from_tty(const char *tty);
  74 const char *default_term_for_tty(const char *tty);
  75
  76 int make_stdio(int fd);
  77 int make_null_stdio(void);
  78 int make_console_stdio(void);
  79
  80 int fd_columns(int fd);
  81 unsigned columns(void);
  82 int fd_lines(int fd);
  83 unsigned lines(void);
  84 void columns_lines_cache_reset(int _unused_ signum);
  85
  86 bool on_tty(void);
  87 bool terminal_is_dumb(void);
  88 bool colors_enabled(void);
  89
  90 static inline const char *ansi_underline(void) {
  91         return colors_enabled() ? ANSI_UNDERLINE : "";
  92 }
  93
  94 static inline const char *ansi_highlight(void) {
  95         return colors_enabled() ? ANSI_HIGHLIGHT : "";
  96 }
  97
  98 static inline const char *ansi_highlight_underline(void) {
  99         return colors_enabled() ? ANSI_HIGHLIGHT_UNDERLINE : "";
 100 }
 101
 102 static inline const char *ansi_highlight_red(void) {
 103         return colors_enabled() ? ANSI_HIGHLIGHT_RED : "";
 104 }
 105
 106 static inline const char *ansi_highlight_green(void) {
 107         return colors_enabled() ? ANSI_HIGHLIGHT_GREEN : "";
 108 }
 109
 110 static inline const char *ansi_highlight_yellow(void) {
 111         return colors_enabled() ? ANSI_HIGHLIGHT_YELLOW : "";
 112 }
 113
 114 static inline const char *ansi_highlight_blue(void) {
 115         return colors_enabled() ? ANSI_HIGHLIGHT_BLUE : "";
 116 }
 117
 118 static inline const char *ansi_highlight_red_underline(void) {
 119         return colors_enabled() ? ANSI_HIGHLIGHT_RED_UNDERLINE : "";
 120 }
 121
 122 static inline const char *ansi_highlight_green_underline(void) {
 123         return colors_enabled() ? ANSI_HIGHLIGHT_GREEN_UNDERLINE : "";
 124 }
 125
 126 static inline const char *ansi_highlight_yellow_underline(void) {
 127         return colors_enabled() ? ANSI_HIGHLIGHT_YELLOW_UNDERLINE : "";
 128 }
 129
 130 static inline const char *ansi_highlight_blue_underline(void) {
 131         return colors_enabled() ? ANSI_HIGHLIGHT_BLUE_UNDERLINE : "";
 132 }
 133
 134 static inline const char *ansi_normal(void) {
 135         return colors_enabled() ? ANSI_NORMAL : "";
 136 }
 137
 138 int get_ctty_devnr(pid_t pid, dev_t *d);
 139 int get_ctty(pid_t, dev_t *_devnr, char **r);
 140
 141 int getttyname_malloc(int fd, char **r);
 142 int getttyname_harder(int fd, char **r);
 143
 144 int ptsname_malloc(int fd, char **ret);
 145 int ptsname_namespace(int pty, char **ret);
 146
 147 int openpt_in_namespace(pid_t pid, int flags);
 148 int open_terminal_in_namespace(pid_t pid, const char *name, int mode);