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 <stdbool.h>
  23 #include <stdarg.h>
  24 #include <stdio.h>
  25
  26 #include "macro.h"
  27 #include "time-util.h"
  28
  29 #define ANSI_RED "\x1B[0;31m"
  30 #define ANSI_GREEN "\x1B[0;32m"
  31 #define ANSI_UNDERLINE "\x1B[0;4m"
  32 #define ANSI_HIGHLIGHT "\x1B[0;1;39m"
  33 #define ANSI_HIGHLIGHT_RED "\x1B[0;1;31m"
  34 #define ANSI_HIGHLIGHT_GREEN "\x1B[0;1;32m"
  35 #define ANSI_HIGHLIGHT_YELLOW "\x1B[0;1;33m"
  36 #define ANSI_HIGHLIGHT_BLUE "\x1B[0;1;34m"
  37 #define ANSI_HIGHLIGHT_UNDERLINE "\x1B[0;1;4m"
  38 #define ANSI_NORMAL "\x1B[0m"
  39
  40 #define ANSI_ERASE_TO_END_OF_LINE "\x1B[K"
  41
  42 /* Set cursor to top left corner and clear screen */
  43 #define ANSI_HOME_CLEAR "\x1B[H\x1B[2J"
  44
  45 int reset_terminal_fd(int fd, bool switch_to_text);
  46 int reset_terminal(const char *name);
  47
  48 int open_terminal(const char *name, int mode);
  49 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
  50 int release_terminal(void);
  51
  52 int terminal_vhangup_fd(int fd);
  53 int terminal_vhangup(const char *name);
  54
  55 int chvt(int vt);
  56
  57 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
  58 int ask_char(char *ret, const char *replies, const char *text, ...) _printf_(3, 4);
  59 int ask_string(char **ret, const char *text, ...) _printf_(2, 3);
  60
  61 int vt_disallocate(const char *name);
  62
  63 char *resolve_dev_console(char **active);
  64 bool tty_is_vc(const char *tty);
  65 bool tty_is_vc_resolve(const char *tty);
  66 bool tty_is_console(const char *tty) _pure_;
  67 int vtnr_from_tty(const char *tty);
  68 const char *default_term_for_tty(const char *tty);
  69
  70 void warn_melody(void);
  71
  72 int make_stdio(int fd);
  73 int make_null_stdio(void);
  74 int make_console_stdio(void);
  75
  76 int status_vprintf(const char *status, bool ellipse, bool ephemeral, const char *format, va_list ap) _printf_(4,0);
  77 int status_printf(const char *status, bool ellipse, bool ephemeral, const char *format, ...) _printf_(4,5);
  78
  79 int fd_columns(int fd);
  80 unsigned columns(void);
  81 int fd_lines(int fd);
  82 unsigned lines(void);
  83 void columns_lines_cache_reset(int _unused_ signum);
  84
  85 bool on_tty(void);
  86
  87 static inline const char *ansi_underline(void) {
  88         return on_tty() ? ANSI_UNDERLINE : "";
  89 }
  90
  91 static inline const char *ansi_highlight(void) {
  92         return on_tty() ? ANSI_HIGHLIGHT : "";
  93 }
  94
  95 static inline const char *ansi_highlight_underline(void) {
  96         return on_tty() ? ANSI_HIGHLIGHT_UNDERLINE : "";
  97 }
  98
  99 static inline const char *ansi_highlight_red(void) {
 100         return on_tty() ? ANSI_HIGHLIGHT_RED : "";
 101 }
 102
 103 static inline const char *ansi_highlight_green(void) {
 104         return on_tty() ? ANSI_HIGHLIGHT_GREEN : "";
 105 }
 106
 107 static inline const char *ansi_highlight_yellow(void) {
 108         return on_tty() ? ANSI_HIGHLIGHT_YELLOW : "";
 109 }
 110
 111 static inline const char *ansi_highlight_blue(void) {
 112         return on_tty() ? ANSI_HIGHLIGHT_BLUE : "";
 113 }
 114
 115 static inline const char *ansi_normal(void) {
 116         return on_tty() ? ANSI_NORMAL : "";
 117 }
 118
 119 int get_ctty_devnr(pid_t pid, dev_t *d);
 120 int get_ctty(pid_t, dev_t *_devnr, char **r);
 121
 122 int getttyname_malloc(int fd, char **r);
 123 int getttyname_harder(int fd, char **r);
 124
 125 int ptsname_namespace(int pty, char **ret);