1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
#include "Toolbox.hpp"
/*!
* Erases display and moves cursor to top left corner via ANSI escape sequences: \c ESC[2J \c ESC[1;1H
*
* \warning Not all terminals support any or all ANSI escape sequences
*
* \note Source: https://stackoverflow.com/a/52895729/12036073
*/
void clear() {
std::cout << u8"\033[2J\033[1;1H";
}
/*!
* Sub boxes are like normal boxes, but indented with 4 spaces.
*/
void _printSubBoxSpacing() {
std::cout << " ";
}
/* Title boxes */
/*! \param title C-style string, there are no size checks so it could wrap
*
* Prints the title, surrounded by "===".
*/
void titleBox(const char* title) {
std::cout << std::endl << "=== " << title << " ===" << std::endl;
}
/*! \param title C-style string, there are no size checks so it could wrap
*
* Prints the title, surrounded by "---".
*/
void subTitleBox(const char* title) {
std::cout << std::endl << "--- " << title << " ---" << std::endl;
}
/* Status boxes */
/*! \param message C-style string, there are no size checks so it could wrap
*
* Success boxes start with "<S>" and print the message.
*
* \remark Success/Warning/Error boxes start with "<C>" where C is an appropriate character.
*/
void successBox(const char* message) {
std::cout << "<S> " << message << std::endl;
}
/*!
* \copydetails successBox()
* \sa _printSubBoxSpacing()
*/
void successSubBox(const char* message) {
_printSubBoxSpacing();
successBox(message);
}
/*! \param message C-style string, there are no size checks so it could wrap
*
* Warning boxes start with "<W>" and print the message.
*
* \remark Success/Warning/Error boxes start with "<C>" where C is an appropriate character.
*/
void warningBox(const char* message) {
std::cout << "<W> " << message << std::endl;
}
/*!
* \copydetails warningBox()
* \sa _printSubBoxSpacing()
*/
void warningSubBox(const char* message) {
_printSubBoxSpacing();
warningBox(message);
}
/*! \param message C-style string, there are no size checks so it could wrap
*
* Error boxes start with "<E>" and print the message.
*
* \remark Success/Warning/Error boxes start with "<C>" where C is an appropriate character.
*/
void errorBox(const char* message) {
std::cout << "<E> " << message << std::endl;
}
/*!
* \copydetails errorBox()
* \sa _printSubBoxSpacing()
*/
void errorSubBox(const char* message) {
_printSubBoxSpacing();
errorBox(message);
}
/* Input line boxes */
/*! \param label C-style string, there are no size checks so it could wrap
*
* Prints "(+)" and then the given label.
* It doesn't create spacing after label, so it should exist in the label itself.
*
* \remark Semi-internal means the function is defined in the header out of necessity (for templated functions)
*/
void _printInputBoxLabel(const char* label) {
std::cout << "(+) " << label;
}
void __inputLineBoxGetInput(char* output, unsigned maxWidth, bool ignore) {
if (ignore)
std::cin.ignore();
std::cin.getline(output, maxWidth);
}
/*! \param label C-style string, there are no size check so it could wrap
* \param output Pointer to a char array
* \param maxWidth Maximum count of characters to read from user input. output MUST be able to hold that many characters!
* \param ignore Whether or not to ignore the first new-line delimiter.
* true by default, should be set to false only when an inputLineBox/SubBox has been issued directly prior or when it's the very first issued box command.
*
* Prints "(+)" before the label.
*/
void inputLineBox(const char* label, char* output, unsigned maxWidth, bool ignore) {
_printInputBoxLabel(label);
__inputLineBoxGetInput(output, maxWidth, ignore);
}
/*!
* \copydetails inputLineBox()
* \sa _printSubBoxSpacing()
*/
void inputLineSubBox(const char* label, char* output, unsigned maxWidth, bool ignore) {
_printSubBoxSpacing();
_printInputBoxLabel(label);
__inputLineBoxGetInput(output, maxWidth, ignore);
}
/*! \param ignore Whether or not to ignore the first new-line delimiter.
* true by default, should be set to false only when an inputLineBox/SubBox has been issued directly prior or when it's the very first issued box command.
*
* Prints a "Press enter to continue" message and waits for the user
*/
void pressEnterToContinue(bool ignore) {
char tmp;
inputLineBox("[Press enter to continue]", &tmp, 1, ignore);
}
/* Ordered list */
int orderedListIndex = 1;
/*!
* Prints the latests ordered list index, surrounded by square brackets, and increments the ordered list index.
*
* \remark There are no size checks, so list index could overflow.
*
* \remark Semi-internal means the function is defined in the header out of necessity (for templated functions)
*/
void _printOrderedListBeginning() {
std::cout << "[" << orderedListIndex++ << "] ";
}
/*! \param starter Sets the starting number by which ordered list will enumerate
*
* \remark Although starter can be a negative number, ordered list will always increment up the number.
*/
void resetOrderedList(int starter) {
orderedListIndex = starter;
}
/* Table */
void __printTableHeaderNumber(unsigned number) {
std::cout << ":" << ((number < 100) ? " " : "") << number << ((number < 10) ? " " : "");
}
void __printTableColumnHeader(unsigned start, unsigned count) {
std::cout << ": ";
for (unsigned i = 0; i < count; i++)
__printTableHeaderNumber(start++);
std::cout << ":" << std::endl;
for (unsigned i = 0; i <= count; i++)
std::cout << "====";
std::cout << "=" << std::endl;
}
void __printTableLine(unsigned columns) {
std::cout << ":===";
for (unsigned i = 0; i < columns; i++)
std::cout << "+---";
std::cout << ":" << std::endl;
}
/*! \param startNumber The number by which column and row enumeration begins
* \param columns How many columns the table should have
* \param items C-style string, each cell is a single character from the string
*
* Prints a string as a grid/table of characters from top to bottom, left to right.
* The first character is on the top left, the last one is on the bottom right.
*
* Table is printed until a terminating zero is encountered.
* The rows are "calculated" from the columns count and the items length.
*/
void table(unsigned startNumber, unsigned columns, const char* items) {
__printTableColumnHeader(startNumber, columns);
__printTableHeaderNumber(startNumber);
for (unsigned i = 0, colInd = 0, rowInd = 0; items[i] != '\0'; i++, (++colInd) %= columns) {
if (colInd == 0 && i != 0) {
std::cout << ":" << std::endl;
__printTableLine(columns);
__printTableHeaderNumber((++rowInd) + startNumber);
}
std::cout << ((colInd == 0) ? "║ " : "| ") << items[rowInd * columns + colInd] << " ";
}
std::cout << ":" << std::endl;
}
|
