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 #if 0 /// UNNEEDED by elogind
  51 int reset_terminal_fd(int fd, bool switch_to_text);
  52 int reset_terminal(const char *name);
  53 #endif // 0
  54
  55 int open_terminal(const char *name, int mode);
  56 #if 0 /// UNNEEDED by elogind
  57 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
  58 int release_terminal(void);
  59
  60 int terminal_vhangup_fd(int fd);
  61 int terminal_vhangup(const char *name);
  62 #endif // 0
  63
  64 int chvt(int vt);
  65
  66 #if 0 /// UNNEEDED by elogind
  67 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
  68 int ask_char(char *ret, const char *replies, const char *text, ...) _printf_(3, 4);
  69 int ask_string(char **ret, const char *text, ...) _printf_(2, 3);
  70
  71 int vt_disallocate(const char *name);
  72
  73 char *resolve_dev_console(char **active);
  74 #endif // 0
  75 int get_kernel_consoles(char ***consoles);
  76 bool tty_is_vc(const char *tty);
  77 #if 0 /// UNNEEDED by elogind
  78 bool tty_is_vc_resolve(const char *tty);
  79 #endif // 0
  80 bool tty_is_console(const char *tty) _pure_;
  81 int vtnr_from_tty(const char *tty);
  82 #if 0 /// UNNEEDED by elogind
  83 const char *default_term_for_tty(const char *tty);
  84 #endif // 0
  85
  86 int make_stdio(int fd);
  87 int make_null_stdio(void);
  88 #if 0 /// UNNEEDED by elogind
  89 int make_console_stdio(void);
  90 #endif // 0
  91
  92 int fd_columns(int fd);
  93 unsigned columns(void);
  94 int fd_lines(int fd);
  95 unsigned lines(void);
  96 #if 0 /// UNNEEDED by elogind
  97 void columns_lines_cache_reset(int _unused_ signum);
  98 #endif // 0
  99
 100 bool on_tty(void);
 101 bool terminal_is_dumb(void);
 102 bool colors_enabled(void);
 103
 104 static inline const char *ansi_underline(void) {
 105         return colors_enabled() ? ANSI_UNDERLINE : "";
 106 }
 107
 108 static inline const char *ansi_highlight(void) {
 109         return colors_enabled() ? ANSI_HIGHLIGHT : "";
 110 }
 111
 112 static inline const char *ansi_highlight_underline(void) {
 113         return colors_enabled() ? ANSI_HIGHLIGHT_UNDERLINE : "";
 114 }
 115
 116 static inline const char *ansi_highlight_red(void) {
 117         return colors_enabled() ? ANSI_HIGHLIGHT_RED : "";
 118 }
 119
 120 static inline const char *ansi_highlight_green(void) {
 121         return colors_enabled() ? ANSI_HIGHLIGHT_GREEN : "";
 122 }
 123
 124 static inline const char *ansi_highlight_yellow(void) {
 125         return colors_enabled() ? ANSI_HIGHLIGHT_YELLOW : "";
 126 }
 127
 128 static inline const char *ansi_highlight_blue(void) {
 129         return colors_enabled() ? ANSI_HIGHLIGHT_BLUE : "";
 130 }
 131
 132 static inline const char *ansi_highlight_red_underline(void) {
 133         return colors_enabled() ? ANSI_HIGHLIGHT_RED_UNDERLINE : "";
 134 }
 135
 136 static inline const char *ansi_highlight_green_underline(void) {
 137         return colors_enabled() ? ANSI_HIGHLIGHT_GREEN_UNDERLINE : "";
 138 }
 139
 140 static inline const char *ansi_highlight_yellow_underline(void) {
 141         return colors_enabled() ? ANSI_HIGHLIGHT_YELLOW_UNDERLINE : "";
 142 }
 143
 144 static inline const char *ansi_highlight_blue_underline(void) {
 145         return colors_enabled() ? ANSI_HIGHLIGHT_BLUE_UNDERLINE : "";
 146 }
 147
 148 static inline const char *ansi_normal(void) {
 149         return colors_enabled() ? ANSI_NORMAL : "";
 150 }
 151
 152 int get_ctty_devnr(pid_t pid, dev_t *d);
 153 int get_ctty(pid_t, dev_t *_devnr, char **r);
 154
 155 int getttyname_malloc(int fd, char **r);
 156 int getttyname_harder(int fd, char **r);
 157
 158 #if 0 /// UNNEEDED by elogind
 159 int ptsname_malloc(int fd, char **ret);
 160 int ptsname_namespace(int pty, char **ret);
 161
 162 int openpt_in_namespace(pid_t pid, int flags);
 163 int open_terminal_in_namespace(pid_t pid, const char *name, int mode);
 164 #endif // 0