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