]>
Commit | Line | Data |
---|---|---|
53e1b683 | 1 | /* SPDX-License-Identifier: LGPL-2.1+ */ |
288a74cc RC |
2 | #pragma once |
3 | ||
288a74cc | 4 | #include <stdarg.h> |
71d35b6b | 5 | #include <stdbool.h> |
288a74cc | 6 | #include <stdio.h> |
37b8d2f6 | 7 | #include <syslog.h> |
11c3a366 | 8 | #include <sys/types.h> |
288a74cc RC |
9 | |
10 | #include "macro.h" | |
11 | #include "time-util.h" | |
12 | ||
6d1d8f66 | 13 | /* Regular colors */ |
6d1d8f66 AR |
14 | #define ANSI_RED "\x1B[0;31m" |
15 | #define ANSI_GREEN "\x1B[0;32m" | |
16 | #define ANSI_YELLOW "\x1B[0;33m" | |
17 | #define ANSI_BLUE "\x1B[0;34m" | |
18 | #define ANSI_MAGENTA "\x1B[0;35m" | |
bb40c125 | 19 | #define ANSI_GREY "\x1B[0;38;5;245m" |
6d1d8f66 AR |
20 | |
21 | /* Bold/highlighted */ | |
6d1d8f66 AR |
22 | #define ANSI_HIGHLIGHT_RED "\x1B[0;1;31m" |
23 | #define ANSI_HIGHLIGHT_GREEN "\x1B[0;1;32m" | |
a9009769 | 24 | #define ANSI_HIGHLIGHT_YELLOW "\x1B[0;1;38;5;185m" |
6d1d8f66 AR |
25 | #define ANSI_HIGHLIGHT_BLUE "\x1B[0;1;34m" |
26 | #define ANSI_HIGHLIGHT_MAGENTA "\x1B[0;1;35m" | |
1530bf25 | 27 | #define ANSI_HIGHLIGHT_GREY "\x1B[0;1;38;5;245m" |
6d1d8f66 AR |
28 | |
29 | /* Underlined */ | |
6d1d8f66 AR |
30 | #define ANSI_HIGHLIGHT_RED_UNDERLINE "\x1B[0;1;4;31m" |
31 | #define ANSI_HIGHLIGHT_GREEN_UNDERLINE "\x1B[0;1;4;32m" | |
32 | #define ANSI_HIGHLIGHT_YELLOW_UNDERLINE "\x1B[0;1;4;33m" | |
33 | #define ANSI_HIGHLIGHT_BLUE_UNDERLINE "\x1B[0;1;4;34m" | |
34 | #define ANSI_HIGHLIGHT_MAGENTA_UNDERLINE "\x1B[0;1;4;35m" | |
1530bf25 | 35 | #define ANSI_HIGHLIGHT_GREY_UNDERLINE "\x1B[0;1;4;38;5;245m" |
6d1d8f66 AR |
36 | |
37 | /* Other ANSI codes */ | |
1fc464f6 LP |
38 | #define ANSI_UNDERLINE "\x1B[0;4m" |
39 | #define ANSI_HIGHLIGHT "\x1B[0;1;39m" | |
1fc464f6 | 40 | #define ANSI_HIGHLIGHT_UNDERLINE "\x1B[0;1;4m" |
6d1d8f66 AR |
41 | |
42 | /* Reset/clear ANSI styles */ | |
1fc464f6 LP |
43 | #define ANSI_NORMAL "\x1B[0m" |
44 | ||
6d1d8f66 | 45 | /* Erase characters until the end of the line */ |
288a74cc RC |
46 | #define ANSI_ERASE_TO_END_OF_LINE "\x1B[K" |
47 | ||
82554307 T |
48 | /* Move cursor up one line */ |
49 | #define ANSI_REVERSE_LINEFEED "\x1BM" | |
50 | ||
1fc464f6 LP |
51 | /* Set cursor to top left corner and clear screen */ |
52 | #define ANSI_HOME_CLEAR "\x1B[H\x1B[2J" | |
53 | ||
288a74cc RC |
54 | int reset_terminal_fd(int fd, bool switch_to_text); |
55 | int reset_terminal(const char *name); | |
56 | ||
57 | int open_terminal(const char *name, int mode); | |
8854d795 LP |
58 | |
59 | /* Flags for tweaking the way we become the controlling process of a terminal. */ | |
60 | typedef enum AcquireTerminalFlags { | |
61 | /* Try to become the controlling process of the TTY. If we can't return -EPERM. */ | |
ef31828d | 62 | ACQUIRE_TERMINAL_TRY = 0, |
8854d795 LP |
63 | |
64 | /* Tell the kernel to forcibly make us the controlling process of the TTY. Returns -EPERM if the kernel doesn't allow that. */ | |
ef31828d | 65 | ACQUIRE_TERMINAL_FORCE = 1, |
8854d795 LP |
66 | |
67 | /* If we can't become the controlling process of the TTY right-away, then wait until we can. */ | |
ef31828d | 68 | ACQUIRE_TERMINAL_WAIT = 2, |
8854d795 LP |
69 | |
70 | /* 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 */ | |
ef31828d | 71 | ACQUIRE_TERMINAL_PERMISSIVE = 1 << 2, |
8854d795 LP |
72 | } AcquireTerminalFlags; |
73 | ||
74 | int acquire_terminal(const char *name, AcquireTerminalFlags flags, usec_t timeout); | |
288a74cc RC |
75 | int release_terminal(void); |
76 | ||
77 | int terminal_vhangup_fd(int fd); | |
78 | int terminal_vhangup(const char *name); | |
79 | ||
80 | int chvt(int vt); | |
81 | ||
82 | int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl); | |
83 | int ask_char(char *ret, const char *replies, const char *text, ...) _printf_(3, 4); | |
84 | int ask_string(char **ret, const char *text, ...) _printf_(2, 3); | |
85 | ||
86 | int vt_disallocate(const char *name); | |
87 | ||
7b912648 | 88 | int resolve_dev_console(char **ret); |
bef41af2 | 89 | int get_kernel_consoles(char ***ret); |
288a74cc RC |
90 | bool tty_is_vc(const char *tty); |
91 | bool tty_is_vc_resolve(const char *tty); | |
92 | bool tty_is_console(const char *tty) _pure_; | |
93 | int vtnr_from_tty(const char *tty); | |
94 | const char *default_term_for_tty(const char *tty); | |
95 | ||
288a74cc RC |
96 | int make_console_stdio(void); |
97 | ||
288a74cc RC |
98 | int fd_columns(int fd); |
99 | unsigned columns(void); | |
100 | int fd_lines(int fd); | |
101 | unsigned lines(void); | |
c6063244 | 102 | |
288a74cc | 103 | void columns_lines_cache_reset(int _unused_ signum); |
c6063244 | 104 | void reset_terminal_feature_caches(void); |
288a74cc RC |
105 | |
106 | bool on_tty(void); | |
ac96418b | 107 | bool terminal_is_dumb(void); |
40c9fe4c | 108 | bool colors_enabled(void); |
526664f6 | 109 | bool underline_enabled(void); |
c2b32159 | 110 | bool dev_console_colors_enabled(void); |
288a74cc | 111 | |
5c98198f ZJS |
112 | #define DEFINE_ANSI_FUNC(name, NAME) \ |
113 | static inline const char *ansi_##name(void) { \ | |
114 | return colors_enabled() ? ANSI_##NAME : ""; \ | |
f6a8265b | 115 | } |
5c98198f | 116 | |
526664f6 LP |
117 | #define DEFINE_ANSI_FUNC_UNDERLINE(name, NAME, REPLACEMENT) \ |
118 | static inline const char *ansi_##name(void) { \ | |
119 | return underline_enabled() ? ANSI_##NAME : \ | |
120 | colors_enabled() ? ANSI_##REPLACEMENT : ""; \ | |
f6a8265b | 121 | } |
526664f6 | 122 | |
003aa3e0 LP |
123 | DEFINE_ANSI_FUNC(normal, NORMAL); |
124 | DEFINE_ANSI_FUNC(highlight, HIGHLIGHT); | |
125 | DEFINE_ANSI_FUNC(red, RED); | |
126 | DEFINE_ANSI_FUNC(green, GREEN); | |
127 | DEFINE_ANSI_FUNC(yellow, YELLOW); | |
128 | DEFINE_ANSI_FUNC(blue, BLUE); | |
129 | DEFINE_ANSI_FUNC(magenta, MAGENTA); | |
130 | DEFINE_ANSI_FUNC(grey, GREY); | |
131 | DEFINE_ANSI_FUNC(highlight_red, HIGHLIGHT_RED); | |
132 | DEFINE_ANSI_FUNC(highlight_green, HIGHLIGHT_GREEN); | |
133 | DEFINE_ANSI_FUNC(highlight_yellow, HIGHLIGHT_YELLOW); | |
134 | DEFINE_ANSI_FUNC(highlight_blue, HIGHLIGHT_BLUE); | |
135 | DEFINE_ANSI_FUNC(highlight_magenta, HIGHLIGHT_MAGENTA); | |
136 | DEFINE_ANSI_FUNC(highlight_grey, HIGHLIGHT_GREY); | |
137 | ||
138 | DEFINE_ANSI_FUNC_UNDERLINE(underline, UNDERLINE, NORMAL); | |
139 | DEFINE_ANSI_FUNC_UNDERLINE(highlight_underline, HIGHLIGHT_UNDERLINE, HIGHLIGHT); | |
140 | DEFINE_ANSI_FUNC_UNDERLINE(highlight_red_underline, HIGHLIGHT_RED_UNDERLINE, HIGHLIGHT_RED); | |
141 | DEFINE_ANSI_FUNC_UNDERLINE(highlight_green_underline, HIGHLIGHT_GREEN_UNDERLINE, HIGHLIGHT_GREEN); | |
142 | DEFINE_ANSI_FUNC_UNDERLINE(highlight_yellow_underline, HIGHLIGHT_YELLOW_UNDERLINE, HIGHLIGHT_YELLOW); | |
143 | DEFINE_ANSI_FUNC_UNDERLINE(highlight_blue_underline, HIGHLIGHT_BLUE_UNDERLINE, HIGHLIGHT_BLUE); | |
144 | DEFINE_ANSI_FUNC_UNDERLINE(highlight_magenta_underline, HIGHLIGHT_MAGENTA_UNDERLINE, HIGHLIGHT_MAGENTA); | |
145 | DEFINE_ANSI_FUNC_UNDERLINE(highlight_grey_underline, HIGHLIGHT_GREY_UNDERLINE, HIGHLIGHT_GREY); | |
526664f6 | 146 | |
288a74cc RC |
147 | int get_ctty_devnr(pid_t pid, dev_t *d); |
148 | int get_ctty(pid_t, dev_t *_devnr, char **r); | |
149 | ||
150 | int getttyname_malloc(int fd, char **r); | |
151 | int getttyname_harder(int fd, char **r); | |
a07c35c3 | 152 | |
66cb2fde | 153 | int ptsname_malloc(int fd, char **ret); |
a07c35c3 | 154 | int ptsname_namespace(int pty, char **ret); |
66cb2fde LP |
155 | |
156 | int openpt_in_namespace(pid_t pid, int flags); | |
40e1f4ea | 157 | int open_terminal_in_namespace(pid_t pid, const char *name, int mode); |
c83f349c LP |
158 | |
159 | int vt_default_utf8(void); | |
bb5ac84d | 160 | int vt_verify_kbmode(int fd); |
c83f349c | 161 | int vt_reset_keyboard(int fd); |
6179ede1 | 162 | int vt_restore(int fd); |
27dafac9 | 163 | int vt_release(int fd, bool restore_vt); |
37b8d2f6 ZJS |
164 | |
165 | void get_log_colors(int priority, const char **on, const char **off, const char **highlight); | |
1802d5f2 LP |
166 | |
167 | /* This assumes there is a 'tty' group */ | |
168 | #define TTY_MODE 0620 |