Porytiles
Loading...
Searching...
No Matches
stderr_styled_user_diagnostics.cpp
Go to the documentation of this file.
1#include "porytiles/xcut/diagnostics/stderr_styled_user_diagnostics.hpp"
2
3#include <iostream>
4#include <ranges>
5#include <string>
6#include <vector>
7
8#include "porytiles/utilities/panic/panic.hpp"
9#include "porytiles/utilities/text/text_formatter.hpp"
10
11namespace porytiles {
12
13void StderrStyledUserDiagnostics::remark(const std::string &tag, const std::vector<std::string> &lines) const
14{
15 assert_or_panic(!lines.empty(), "lines vector is empty");
16 assert_or_panic(!tag.empty(), "tag is empty");
17
18 std::cerr << formatter().style("remark ", Style::bold | Style::blue)
19 << formatter().style("[", Style::bold | Style::blue) << formatter().style(tag, Style::bold | Style::blue)
20 << formatter().style("]:", Style::bold | Style::blue) << std::endl;
21 std::cerr << formatter().style("│", Style::bold | Style::blue) << std::endl;
22 for (const auto &line : lines) {
23 std::cerr << formatter().style("│", Style::bold | Style::blue) << " " << line << std::endl;
24 }
25 std::cerr << formatter().style("│", Style::bold | Style::blue) << std::endl;
26}
27
28void StderrStyledUserDiagnostics::warning(const std::string &tag, const std::vector<std::string> &lines) const
29{
30 assert_or_panic(!lines.empty(), "lines vector is empty");
31 assert_or_panic(!tag.empty(), "tag is empty");
32
33 std::cerr << formatter().style("warning ", Style::bold | Style::magenta)
34 << formatter().style("[", Style::bold | Style::magenta)
35 << formatter().style(tag, Style::bold | Style::magenta)
36 << formatter().style("]:", Style::bold | Style::magenta) << std::endl;
37 std::cerr << formatter().style("│", Style::bold | Style::magenta) << std::endl;
38 for (const auto &line : lines) {
39 std::cerr << formatter().style("│", Style::bold | Style::magenta) << " " << line << std::endl;
40 }
41 std::cerr << formatter().style("│", Style::bold | Style::magenta) << std::endl;
42}
43
44void StderrStyledUserDiagnostics::error(const std::string &tag, const std::vector<std::string> &lines) const
45{
46 assert_or_panic(!lines.empty(), "lines vector is empty");
47 assert_or_panic(!tag.empty(), "tag is empty");
48
49 std::cerr << formatter().style("error ", Style::bold | Style::red)
50 << formatter().style("[", Style::bold | Style::red) << formatter().style(tag, Style::bold | Style::red)
51 << formatter().style("]:", Style::bold | Style::red) << std::endl;
52 std::cerr << formatter().style("│", Style::bold | Style::red) << std::endl;
53 for (const auto &line : lines) {
54 std::cerr << formatter().style("│", Style::bold | Style::red) << " " << line << std::endl;
55 }
56 std::cerr << formatter().style("│", Style::bold | Style::red) << std::endl;
57}
58
59void StderrStyledUserDiagnostics::emit_fatal_proximate(const Error &err) const
60{
61 auto lines = err.details(formatter());
62 if (!lines.empty()) {
63 std::cerr << formatter().style("fatal:", Style::bold | Style::red) << std::endl;
64 std::cerr << formatter().style("│", Style::bold | Style::red) << std::endl;
65 for (const auto &line : lines) {
66 std::cerr << formatter().style("│", Style::bold | Style::red) << " " << line << std::endl;
67 }
68 std::cerr << formatter().style("│", Style::bold | Style::red) << std::endl;
69 }
70}
71
72void StderrStyledUserDiagnostics::emit_fatal_step(const Error &err) const
73{
74 std::cerr << formatter().style("├ caused by:", Style::bold | Style::red) << std::endl;
75 std::cerr << formatter().style("│", Style::bold | Style::red) << " " << std::endl;
76
77 auto lines = err.details(formatter());
78 if (!lines.empty()) {
79 std::cerr << formatter().style("│", Style::bold | Style::red) << " " << lines.at(0) << std::endl;
80 for (const auto &line : std::ranges::views::drop(lines, 1)) {
81 std::cerr << formatter().style("│", Style::bold | Style::red) << " " << line << std::endl;
82 }
83 }
84 std::cerr << formatter().style("│", Style::bold | Style::red) << std::endl;
85}
86
87void StderrStyledUserDiagnostics::emit_fatal_root(const Error &err) const
88{
89 std::cerr << formatter().style("├ root cause:", Style::bold | Style::red) << std::endl;
90 std::cerr << formatter().style("│", Style::bold | Style::red) << " " << std::endl;
91
92 auto lines = err.details(formatter());
93 if (!lines.empty()) {
94 std::cerr << formatter().style("│", Style::bold | Style::red) << " " << lines.at(0) << std::endl;
95 for (const auto &line : std::ranges::views::drop(lines, 1)) {
96 std::cerr << formatter().style("│", Style::bold | Style::red) << " " << line << std::endl;
97 }
98 }
99 std::cerr << formatter().style("│", Style::bold | Style::red) << std::endl;
100}
101
102void StderrStyledUserDiagnostics::remark_note(const std::string &tag, const std::vector<std::string> &lines) const
103{
104 emit_note_impl(tag, lines);
105}
106
107void StderrStyledUserDiagnostics::warning_note(const std::string &tag, const std::vector<std::string> &lines) const
108{
109 emit_note_impl(tag, lines);
110}
111
112void StderrStyledUserDiagnostics::error_note(const std::string &tag, const std::vector<std::string> &lines) const
113{
114 emit_note_impl(tag, lines);
115}
116
117void StderrStyledUserDiagnostics::emit_note_impl(const std::string &tag, const std::vector<std::string> &lines) const
118{
119 assert_or_panic(!lines.empty(), "lines vector is empty");
120 assert_or_panic(!tag.empty(), "tag is empty");
121
122 std::cerr << formatter().style("note ", Style::bold | Style::cyan)
123 << formatter().style("[", Style::bold | Style::cyan) << formatter().style(tag, Style::bold | Style::cyan)
124 << formatter().style("]:", Style::bold | Style::cyan) << std::endl;
125 std::cerr << formatter().style("│", Style::bold | Style::cyan) << std::endl;
126 for (const auto &line : lines) {
127 std::cerr << formatter().style("│", Style::bold | Style::cyan) << " " << line << std::endl;
128 }
129 std::cerr << formatter().style("│", Style::bold | Style::cyan) << std::endl;
130}
131
132} // namespace porytiles
porytiles::Error
Abstract interface for all error types used in ChainableResult error chains.
Definition error.hpp:19
porytiles::Error::details
virtual std::vector< std::string > details(const TextFormatter &formatter) const =0
Returns a formatted multi-line string representation of the error.
porytiles::StderrStyledUserDiagnostics::error
void error(const std::string &tag, const std::vector< std::string > &lines) const override
Display a multi-line tagged error message to stderr.
Definition stderr_styled_user_diagnostics.cpp:44
porytiles::StderrStyledUserDiagnostics::warning_note
void warning_note(const std::string &tag, const std::vector< std::string > &lines) const override
Display a multi-line tagged note associated with a warning to stderr.
Definition stderr_styled_user_diagnostics.cpp:107
porytiles::StderrStyledUserDiagnostics::emit_fatal_proximate
void emit_fatal_proximate(const Error &err) const override
Emit the proximate (immediate) error in a fatal error chain to stderr.
Definition stderr_styled_user_diagnostics.cpp:59
porytiles::StderrStyledUserDiagnostics::remark
void remark(const std::string &tag, const std::vector< std::string > &lines) const override
Display a multi-line tagged informational remark to stderr.
Definition stderr_styled_user_diagnostics.cpp:13
porytiles::StderrStyledUserDiagnostics::remark_note
void remark_note(const std::string &tag, const std::vector< std::string > &lines) const override
Display a multi-line tagged note associated with a remark to stderr.
Definition stderr_styled_user_diagnostics.cpp:102
porytiles::StderrStyledUserDiagnostics::emit_fatal_root
void emit_fatal_root(const Error &err) const override
Emit the root cause error in a fatal error chain to stderr.
Definition stderr_styled_user_diagnostics.cpp:87
porytiles::StderrStyledUserDiagnostics::emit_fatal_step
void emit_fatal_step(const Error &err) const override
Emit an intermediate step error in a fatal error chain to stderr.
Definition stderr_styled_user_diagnostics.cpp:72
porytiles::StderrStyledUserDiagnostics::warning
void warning(const std::string &tag, const std::vector< std::string > &lines) const override
Display a multi-line tagged warning to stderr.
Definition stderr_styled_user_diagnostics.cpp:28
porytiles::StderrStyledUserDiagnostics::error_note
void error_note(const std::string &tag, const std::vector< std::string > &lines) const override
Display a multi-line tagged note associated with an error to stderr.
Definition stderr_styled_user_diagnostics.cpp:112
porytiles::Style::magenta
static const Style magenta
Magenta foreground color.
Definition text_formatter.hpp:82
porytiles::Style::red
static const Style red
Red foreground color.
Definition text_formatter.hpp:78
porytiles::Style::cyan
static const Style cyan
Cyan foreground color.
Definition text_formatter.hpp:83
porytiles::Style::blue
static const Style blue
Blue foreground color.
Definition text_formatter.hpp:81
porytiles::Style::bold
static const Style bold
Bold text formatting.
Definition text_formatter.hpp:70
porytiles::TextFormatter::style
virtual std::string style(const std::string &text, Style styles) const =0
Applies styling to a text string.
porytiles::UserDiagnostics::formatter
const TextFormatter & formatter() const
Definition user_diagnostics.hpp:460
porytiles::assert_or_panic
void assert_or_panic(bool condition, const StringViewSourceLoc &s)
Conditionally panics if the given condition is false.
Definition panic.cpp:53
stderr_styled_user_diagnostics.hpp
text_formatter.hpp