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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
use std::io;
use colored::Colorize;
use itertools::Itertools;
use crate::error::TableError;
use crate::table::{Align, Border, Cell, Content, Overflow, Renderer};
use super::FormatterFunc;
/// This is the main entry point of the lib, which represents the table to render.
///
/// For more information, please see the lib's documentation.
#[derive(Clone)]
pub struct Table {
table: Vec<Vec<Cell>>,
border: Border,
}
impl Table {
/// Create a new table with a header and some rows.
///
/// When `splitter` is set to true, this will automatically add a splitter between header and contents.
///
/// > This is the recommended way to create a new table, so for details see the lib's documentation.
pub fn create(header: Vec<Cell>, mut cell: Vec<Vec<Cell>>, splitter: bool) -> Table {
let mut v = if splitter {
let dat = header
.iter()
.map(|_| {
Cell::default()
.with_content(Content::Splitter)
.with_formatter(vec![FormatterFunc::Normal(Colorize::bold)])
})
.collect_vec();
let mut v = vec![header
.into_iter()
.map(|c| c.with_formatter(vec![FormatterFunc::Normal(Colorize::bold)]))
.collect_vec()];
v.push(dat);
v
} else {
vec![header]
};
v.append(&mut cell);
Self {
table: v,
border: Border::NONE,
}
}
/// Create a new table with some rows.
pub fn new(table: Vec<Vec<Cell>>) -> Table {
Self {
table,
border: Border::NONE,
}
}
pub fn with_border(mut self, border: Border) -> Table {
self.border = border;
self
}
pub fn set_border(&mut self, border: Border) {
self.border = border;
}
/// This function will overwrite the `overflow` property of every cells in the table.
pub fn overwrite_overflow(&mut self, overflow: Overflow) {
for row in self.table.iter_mut() {
for cell in row.iter_mut() {
cell.set_overflow(overflow)
}
}
}
/// This will render the table according to the render settings. See the lib's documentation for more information.
///
/// See [Renderer]
///
/// [Renderer]: ../enum.Renderer.html
pub fn rendered_by(
&self,
setting: Renderer,
writer: &mut impl io::Write,
) -> Result<(), TableError> {
match setting {
Renderer::Normal => self.render(writer),
Renderer::Raw => self.render_raw(writer),
Renderer::Markdown => self.render_markdown(writer),
}
}
/// This will render a markdown-formatted table.
///
/// See also [rendered_by].
///
/// [rendered_by]: #method.rendered_by
pub fn render_markdown(&self, writer: &mut impl io::Write) -> Result<(), TableError> {
self.validate()?;
let mut rows = self.table.iter();
if let Some(h) = rows.next() {
let setting_row = h
.iter()
.map(|c| match c.get_align() {
Align::Left => ":--",
Align::Center => ":-:",
Align::Right => "--:",
})
.join("┃");
let hr = h
.iter()
.map(|c| match c.get_content() {
Content::None => "".to_string(),
Content::Splitter => "━━━".to_string(),
Content::Text(ref text) => text.clone(),
})
.join("┃");
writeln!(writer, "┃{}┃", hr)?;
writeln!(writer, "┃{}┃", setting_row)?;
for row in rows {
let hr = row
.iter()
.map(|c| match c.get_content() {
Content::None => "".to_string(),
Content::Splitter => "━━━".to_string(),
Content::Text(ref text) => text.clone(),
})
.join("┃");
writeln!(writer, "┃{}┃", hr)?;
}
} else {
writeln!(writer, "┃┃\n┃-┃")?;
}
Ok(())
}
/// This will render a raw table without any formatting.
///
/// See also [rendered_by].
///
/// [rendered_by]: #method.rendered_by
pub fn render_raw(&self, writer: &mut impl io::Write) -> Result<(), TableError> {
let w = self.validate()?;
let widths = self.update_width(w)?;
let table_width = widths.iter().map(|v| v + 2).sum::<usize>()
+ if self.border.left { 1 } else { 0 }
+ if self.border.right { 1 } else { 0 };
if self.border.top {
writeln!(writer, "{}", "━".repeat(table_width))?;
}
for (y, row) in self.table.iter().enumerate() {
if self.border.left {
write!(writer, "┃")?;
}
let mut pass: Vec<usize> = vec![];
'cell: for (x, cell) in row.iter().enumerate() {
if pass.binary_search(&x).is_ok() {
continue 'cell;
}
if let Some(cell_width) = widths.get(x) {
let render_width = if let Some(merge_width) = cell.get_merge() {
let cells = row.get((x + 1)..=(x + merge_width));
if let Some(merged) = cells {
let mut mv_width = vec![];
for (mx, cm) in merged.iter().enumerate() {
if !matches!(cm.get_content(), Content::None) {
Err(TableError::MergeOverwrite { x: x + mx + 1, y })?
}
if let Some(mw) = widths.get(mx + x + 1) {
mv_width.push(mw + 2);
} else {
Err(TableError::Unexpected(
"Render merge failed(index error)".to_string(),
))?
}
pass.push(x + mx + 1);
}
mv_width.into_iter().sum::<usize>() + cell_width
} else {
Err(TableError::MergeOutOfTable {
x,
y,
merge: merge_width,
max: w - x - 1,
})?
}
} else {
*cell_width
};
let rendered = cell.render_with_width_raw(render_width);
write!(writer, "{}", rendered)?;
} else {
Err(TableError::Unexpected(
"Getting width failed(index error)".to_string(),
))?
}
}
if self.border.right {
write!(writer, "┃")?;
}
writeln!(writer)?;
}
if self.border.bottom {
writeln!(writer, "{}", "━".repeat(table_width))?;
}
Ok(())
}
/// This will render a table with formatting you defined.
///
/// See also [rendered_by].
///
/// [rendered_by]: #method.rendered_by
pub fn render(&self, writer: &mut impl io::Write) -> Result<(), TableError> {
let w = self.validate()?;
let widths = self.update_width(w)?;
let table_width = widths.iter().map(|v| v + 2).sum::<usize>()
+ if self.border.left { 1 } else { 0 }
+ if self.border.right { 1 } else { 0 };
if self.border.top {
writeln!(writer, "{}", "━".repeat(table_width).bold())?;
}
for (y, row) in self.table.iter().enumerate() {
if self.border.left {
write!(writer, "{}", "┃".bold())?;
}
let mut pass: Vec<usize> = vec![];
'cell: for (x, cell) in row.iter().enumerate() {
if pass.binary_search(&x).is_ok() {
continue 'cell;
}
if let Some(cell_width) = widths.get(x) {
let render_width = if let Some(merge_width) = cell.get_merge() {
let cells = row.get((x + 1)..=(x + merge_width));
if let Some(merged) = cells {
let mut mv_width = vec![];
for (mx, cm) in merged.iter().enumerate() {
if !matches!(cm.get_content(), Content::None) {
Err(TableError::MergeOverwrite { x: x + mx + 1, y })?
}
if let Some(mw) = widths.get(mx + x + 1) {
mv_width.push(mw + 2);
} else {
Err(TableError::Unexpected(
"Render merge failed(index error)".to_string(),
))?
}
pass.push(x + mx + 1);
}
mv_width.into_iter().sum::<usize>() + cell_width
} else {
Err(TableError::MergeOutOfTable {
x,
y,
merge: merge_width,
max: w - x - 1,
})?
}
} else {
*cell_width
};
let rendered = cell.render_with_width(render_width);
write!(writer, "{}", rendered)?;
} else {
Err(TableError::Unexpected(
"Getting width failed(index error)".to_string(),
))?
}
}
if self.border.right {
write!(writer, "{}", "┃".bold())?;
}
writeln!(writer)?;
}
if self.border.bottom {
writeln!(writer, "{}", "━".repeat(table_width).bold())?;
}
Ok(())
}
fn update_width(&self, w: usize) -> Result<Vec<usize>, TableError> {
let mut v = std::iter::repeat(0).take(w).collect_vec();
for row in self.table.iter() {
for (index, cell) in row.iter().enumerate() {
if let Some(c) = v.get_mut(index) {
if let Some(iw) = cell.get_width() {
if iw > *c {
*c = iw;
}
}
} else {
Err(TableError::Unexpected(
"Update width failed(index error)".to_string(),
))?
}
}
}
Ok(v)
}
/// Check if the table is valid. The `usize` represents how many columns the table has.
///
/// > This will be automatically checked when rendering, but you could also check it manually before it renders.
pub fn validate(&self) -> Result<usize, TableError> {
let mut t = self.table.iter();
if let Some(v) = t.next() {
let e = v.len();
for (index, iv) in t.enumerate() {
let l = iv.len();
if l != e {
return Err(TableError::InvalidTableSize {
row: index + 1,
expected: e,
actual: l,
});
}
}
Ok(e)
} else {
Ok(0)
}
}
}
#[test]
fn test_merge_cell() {
let table = Table::new(vec![
(0..5)
.map(|_| {
Cell::default()
.with_content(Content::Splitter)
.with_width(Some(5))
})
.collect_vec(),
vec![
Cell::default().with_content(Content::Splitter),
Cell::default()
.with_content(Content::new("123123123"))
.with_merge(Some(2)),
Cell::default().with_content(Content::None),
Cell::default().with_content(Content::None),
Cell::default().with_content(Content::Splitter),
],
]);
let mut v = vec![];
let r = table.render(&mut v);
if let Err(e) = r {
println!("{}", e);
} else {
println!("{}", String::from_utf8(v).unwrap());
}
}