Debian Codegraph @

src/shared/pretty-print.h

raw
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2 #pragma once
3
4 #include <stdio.h>
5 #include <string.h>
6
7 #include "ansi-color.h"
8 #include "fileio.h"
9 #include "shared-forward.h"
10 #include "glyph-util.h"
11
12 #define CYLON_BUFFER_EXTRA (2*STRLEN(ANSI_RED) + STRLEN(ANSI_HIGHLIGHT_RED) + 2*STRLEN(ANSI_NORMAL))
13
14 void draw_cylon(char buffer[], size_t buflen, unsigned width, unsigned pos);
15
16 void print_separator(void);
17
18 int file_url_from_path(const char *path, char **ret);
19
20 bool urlify_enabled(void);
21
22 int terminal_urlify(const char *url, const char *text, char **ret);
23 int terminal_urlify_path(const char *path, const char *text, char **ret);
24 int terminal_urlify_man_full(const char *page, const char *section, const char *suffix, char **ret);
25 static inline int terminal_urlify_man(const char *page, const char *section, char **ret) {
26 return terminal_urlify_man_full(page, section, " man page", ret);
27 }
28
29 typedef enum CatFlags {
30 CAT_CONFIG_OFF = 0,
31 CAT_CONFIG_ON = 1 << 0,
32 CAT_FORMAT_HAS_SECTIONS = 1 << 1, /* Sections are meaningful for this file format */
33 CAT_TLDR = 1 << 2, /* Only print comments and relevant section headers */
34 } CatFlags;
35
36 int cat_files_full(const ConfFile *file, ConfFile * const *dropins, size_t n_dropins, CatFlags flags);
37 int cat_files(const char *file, char **dropins, CatFlags flags);
38 int conf_files_cat(const char *root, const char *name, CatFlags flags);
39
40 #define RED_CROSS_MARK_MAX (STRLEN(ANSI_HIGHLIGHT_RED) + STRLEN("✗") + STRLEN(ANSI_NORMAL) + 1)
41 #define GREEN_CHECK_MARK_MAX (STRLEN(ANSI_HIGHLIGHT_GREEN) + STRLEN("✓") + STRLEN(ANSI_NORMAL) + 1)
42
43 static inline const char* red_cross_mark_internal(char buffer[static RED_CROSS_MARK_MAX]) {
44 assert(buffer);
45 assert_se(stpcpy(stpcpy(stpcpy(buffer, ansi_highlight_red()), glyph(GLYPH_CROSS_MARK)), ansi_normal()) < buffer + RED_CROSS_MARK_MAX);
46 return buffer;
47 }
48
49 static inline const char* green_check_mark_internal(char buffer[static GREEN_CHECK_MARK_MAX]) {
50 assert(buffer);
51 assert_se(stpcpy(stpcpy(stpcpy(buffer, ansi_highlight_green()), glyph(GLYPH_CHECK_MARK)), ansi_normal()) < buffer + GREEN_CHECK_MARK_MAX);
52 return buffer;
53 }
54
55 #define RED_CROSS_MARK() red_cross_mark_internal((char[RED_CROSS_MARK_MAX]) {})
56 #define GREEN_CHECK_MARK() green_check_mark_internal((char[GREEN_CHECK_MARK_MAX]) {})
57
58 #define COLOR_MARK_BOOL(b) ((b) ? GREEN_CHECK_MARK() : RED_CROSS_MARK())
59
60 int terminal_tint_color(double hue, char **ret);
61
62 bool shall_tint_background(void);
63
64 void draw_progress_bar(const char *prefix, double percentage);
65 int draw_progress_barf(double percentage, const char *prefixf, ...) _printf_(2, 3);
66 void clear_progress_bar(const char *prefix);
67 void draw_progress_bar_unbuffered(const char *prefix, double percentage);
68 void clear_progress_bar_unbuffered(const char *prefix);
69
70 static inline FILE* enable_buffering(FILE *f, char *buffer, size_t size) {
71 assert(f);
72 assert(buffer);
73 assert(size > 0);
74
75 if (setvbuf(f, buffer, _IOFBF, size) != 0)
76 return NULL;
77
78 return f;
79 }
80
81 static inline void fflush_and_disable_bufferingp(FILE **p) {
82 assert(p);
83
84 if (*p) {
85 fflush(*p);
86 setvbuf(*p, NULL, _IONBF, 0); /* Disable buffering again. */
87 }
88 }
89
90 /* Even though the macro below is slightly generic, but it may not work most streams except for stderr,
91 * as stdout is buffered and fopen() enables buffering by default. */
92 #define _WITH_BUFFERED_STREAM(f, size, p) \
93 _unused_ _cleanup_(fflush_and_disable_bufferingp) FILE *p = \
94 enable_buffering(f, (char[size]) {}, size)
95
96 #define WITH_BUFFERED_STDERR \
97 _WITH_BUFFERED_STREAM(stderr, LONG_LINE_MAX, UNIQ_T(p, UNIQ))
98
99 #define WITH_BUFFERED_STDOUT \
100 _WITH_BUFFERED_STREAM(stdout, LONG_LINE_MAX, UNIQ_T(p, UNIQ))