1 /* SPDX-License-Identifier: LGPL-2.1+ */
5 This file is part of systemd.
7 Copyright 2010 Lennart Poettering
13 #include <sys/types.h>
16 #include "time-util.h"
19 #define ANSI_BLACK "\x1B[0;30m"
20 #define ANSI_RED "\x1B[0;31m"
21 #define ANSI_GREEN "\x1B[0;32m"
22 #define ANSI_YELLOW "\x1B[0;33m"
23 #define ANSI_BLUE "\x1B[0;34m"
24 #define ANSI_MAGENTA "\x1B[0;35m"
25 #define ANSI_CYAN "\x1B[0;36m"
26 #define ANSI_WHITE "\x1B[0;37m"
28 /* Bold/highlighted */
29 #define ANSI_HIGHLIGHT_BLACK "\x1B[0;1;30m"
30 #define ANSI_HIGHLIGHT_RED "\x1B[0;1;31m"
31 #define ANSI_HIGHLIGHT_GREEN "\x1B[0;1;32m"
32 #define ANSI_HIGHLIGHT_YELLOW "\x1B[0;1;33m"
33 #define ANSI_HIGHLIGHT_BLUE "\x1B[0;1;34m"
34 #define ANSI_HIGHLIGHT_MAGENTA "\x1B[0;1;35m"
35 #define ANSI_HIGHLIGHT_CYAN "\x1B[0;1;36m"
36 #define ANSI_HIGHLIGHT_WHITE "\x1B[0;1;37m"
39 #define ANSI_HIGHLIGHT_BLACK_UNDERLINE "\x1B[0;1;4;30m"
40 #define ANSI_HIGHLIGHT_RED_UNDERLINE "\x1B[0;1;4;31m"
41 #define ANSI_HIGHLIGHT_GREEN_UNDERLINE "\x1B[0;1;4;32m"
42 #define ANSI_HIGHLIGHT_YELLOW_UNDERLINE "\x1B[0;1;4;33m"
43 #define ANSI_HIGHLIGHT_BLUE_UNDERLINE "\x1B[0;1;4;34m"
44 #define ANSI_HIGHLIGHT_MAGENTA_UNDERLINE "\x1B[0;1;4;35m"
45 #define ANSI_HIGHLIGHT_CYAN_UNDERLINE "\x1B[0;1;4;36m"
46 #define ANSI_HIGHLIGHT_WHITE_UNDERLINE "\x1B[0;1;4;37m"
48 /* Other ANSI codes */
49 #define ANSI_UNDERLINE "\x1B[0;4m"
50 #define ANSI_HIGHLIGHT "\x1B[0;1;39m"
51 #define ANSI_HIGHLIGHT_UNDERLINE "\x1B[0;1;4m"
53 /* Reset/clear ANSI styles */
54 #define ANSI_NORMAL "\x1B[0m"
56 /* Erase characters until the end of the line */
57 #define ANSI_ERASE_TO_END_OF_LINE "\x1B[K"
59 /* Set cursor to top left corner and clear screen */
60 #define ANSI_HOME_CLEAR "\x1B[H\x1B[2J"
62 int reset_terminal_fd(int fd
, bool switch_to_text
);
63 int reset_terminal(const char *name
);
65 int open_terminal(const char *name
, int mode
);
67 /* Flags for tweaking the way we become the controlling process of a terminal. */
68 typedef enum AcquireTerminalFlags
{
69 /* Try to become the controlling process of the TTY. If we can't return -EPERM. */
70 ACQUIRE_TERMINAL_TRY
= 0,
72 /* Tell the kernel to forcibly make us the controlling process of the TTY. Returns -EPERM if the kernel doesn't allow that. */
73 ACQUIRE_TERMINAL_FORCE
= 1,
75 /* If we can't become the controlling process of the TTY right-away, then wait until we can. */
76 ACQUIRE_TERMINAL_WAIT
= 2,
78 /* 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 */
79 ACQUIRE_TERMINAL_PERMISSIVE
= 4,
80 } AcquireTerminalFlags
;
82 int acquire_terminal(const char *name
, AcquireTerminalFlags flags
, usec_t timeout
);
83 int release_terminal(void);
85 int terminal_vhangup_fd(int fd
);
86 int terminal_vhangup(const char *name
);
90 int read_one_char(FILE *f
, char *ret
, usec_t timeout
, bool *need_nl
);
91 int ask_char(char *ret
, const char *replies
, const char *text
, ...) _printf_(3, 4);
92 int ask_string(char **ret
, const char *text
, ...) _printf_(2, 3);
94 int vt_disallocate(const char *name
);
96 int resolve_dev_console(char **ret
);
97 int get_kernel_consoles(char ***ret
);
98 bool tty_is_vc(const char *tty
);
99 bool tty_is_vc_resolve(const char *tty
);
100 bool tty_is_console(const char *tty
) _pure_
;
101 int vtnr_from_tty(const char *tty
);
102 const char *default_term_for_tty(const char *tty
);
104 int make_console_stdio(void);
106 int fd_columns(int fd
);
107 unsigned columns(void);
108 int fd_lines(int fd
);
109 unsigned lines(void);
111 void columns_lines_cache_reset(int _unused_ signum
);
112 void reset_terminal_feature_caches(void);
115 bool terminal_is_dumb(void);
116 bool colors_enabled(void);
117 bool underline_enabled(void);
118 bool dev_console_colors_enabled(void);
120 #define DEFINE_ANSI_FUNC(name, NAME) \
121 static inline const char *ansi_##name(void) { \
122 return colors_enabled() ? ANSI_##NAME : ""; \
125 #define DEFINE_ANSI_FUNC_UNDERLINE(name, NAME, REPLACEMENT) \
126 static inline const char *ansi_##name(void) { \
127 return underline_enabled() ? ANSI_##NAME : \
128 colors_enabled() ? ANSI_##REPLACEMENT : ""; \
131 DEFINE_ANSI_FUNC(highlight
, HIGHLIGHT
);
132 DEFINE_ANSI_FUNC(highlight_red
, HIGHLIGHT_RED
);
133 DEFINE_ANSI_FUNC(highlight_green
, HIGHLIGHT_GREEN
);
134 DEFINE_ANSI_FUNC(highlight_yellow
, HIGHLIGHT_YELLOW
);
135 DEFINE_ANSI_FUNC(highlight_blue
, HIGHLIGHT_BLUE
);
136 DEFINE_ANSI_FUNC(highlight_magenta
, HIGHLIGHT_MAGENTA
);
137 DEFINE_ANSI_FUNC(normal
, NORMAL
);
139 DEFINE_ANSI_FUNC_UNDERLINE(underline
, UNDERLINE
, NORMAL
);
140 DEFINE_ANSI_FUNC_UNDERLINE(highlight_underline
, HIGHLIGHT_UNDERLINE
, HIGHLIGHT
);
141 DEFINE_ANSI_FUNC_UNDERLINE(highlight_red_underline
, HIGHLIGHT_RED_UNDERLINE
, HIGHLIGHT_RED
);
142 DEFINE_ANSI_FUNC_UNDERLINE(highlight_green_underline
, HIGHLIGHT_GREEN_UNDERLINE
, HIGHLIGHT_GREEN
);
143 DEFINE_ANSI_FUNC_UNDERLINE(highlight_yellow_underline
, HIGHLIGHT_YELLOW_UNDERLINE
, HIGHLIGHT_YELLOW
);
144 DEFINE_ANSI_FUNC_UNDERLINE(highlight_blue_underline
, HIGHLIGHT_BLUE_UNDERLINE
, HIGHLIGHT_BLUE
);
146 int get_ctty_devnr(pid_t pid
, dev_t
*d
);
147 int get_ctty(pid_t
, dev_t
*_devnr
, char **r
);
149 int getttyname_malloc(int fd
, char **r
);
150 int getttyname_harder(int fd
, char **r
);
152 int ptsname_malloc(int fd
, char **ret
);
153 int ptsname_namespace(int pty
, char **ret
);
155 int openpt_in_namespace(pid_t pid
, int flags
);
156 int open_terminal_in_namespace(pid_t pid
, const char *name
, int mode
);
158 int vt_default_utf8(void);
159 int vt_reset_keyboard(int fd
);
161 int terminal_urlify(const char *url
, const char *text
, char **ret
);
162 int terminal_urlify_path(const char *path
, const char *text
, char **ret
);
164 typedef enum CatFlags
{
165 CAT_FLAGS_MAIN_FILE_OPTIONAL
= 1 << 1,
168 int cat_files(const char *file
, char **dropins
, CatFlags flags
);
170 void print_separator(void);