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
#[cfg(feature = "tty")]
use crossterm::style::{style, Stylize};
use unicode_width::UnicodeWidthStr;
use super::content_split::measure_text_width;
use super::content_split::split_line;
use crate::cell::Cell;
use crate::row::Row;
use crate::style::CellAlignment;
#[cfg(feature = "tty")]
use crate::style::{map_attribute, map_color};
use crate::table::Table;
use crate::utils::ColumnDisplayInfo;
pub fn delimiter(cell: &Cell, info: &ColumnDisplayInfo, table: &Table) -> char {
// Determine, which delimiter should be used
if let Some(delimiter) = cell.delimiter {
delimiter
} else if let Some(delimiter) = info.delimiter {
delimiter
} else if let Some(delimiter) = table.delimiter {
delimiter
} else {
' '
}
}
/// Returns the formatted content of the table.
/// The content is organized in the following structure
///
/// tc stands for table content and represents the returned value
/// ``` text
/// column1 column2
/// row1 tc[0][0][0] tc[0][0][1] <-line1
/// tc[0][1][0] tc[0][1][1] <-line2
/// tc[0][2][0] tc[0][2][1] <-line3
///
/// row2 tc[1][0][0] tc[1][0][1] <-line1
/// tc[1][1][0] tc[1][1][1] <-line2
/// tc[1][2][0] tc[1][2][1] <-line3
/// ```
///
/// The strings for each row will be padded and aligned according to their respective column.
pub fn format_content(table: &Table, display_info: &[ColumnDisplayInfo]) -> Vec<Vec<Vec<String>>> {
// The content of the whole table
let mut table_content = Vec::with_capacity(table.rows.len() + 1);
// Format table header if it exists
if let Some(header) = table.header() {
table_content.push(format_row(header, display_info, table));
}
for row in table.rows.iter() {
table_content.push(format_row(row, display_info, table));
}
table_content
}
pub fn format_row(
row: &Row,
display_infos: &[ColumnDisplayInfo],
table: &Table,
) -> Vec<Vec<String>> {
// The content of this specific row
let mut temp_row_content = Vec::with_capacity(display_infos.len());
let mut cell_iter = row.cells.iter();
// Now iterate over all cells and handle them according to their alignment
for info in display_infos.iter() {
if info.is_hidden {
cell_iter.next();
continue;
}
// Each cell is divided into several lines divided by newline
// Every line that's too long will be split into multiple lines
let mut cell_lines = Vec::new();
// Check if the row has as many cells as the table has columns.
// If that's not the case, create a new cell with empty spaces.
let cell = if let Some(cell) = cell_iter.next() {
cell
} else {
cell_lines.push(" ".repeat(info.width().into()));
temp_row_content.push(cell_lines);
continue;
};
let delimiter = delimiter(cell, info, table);
// Iterate over each line and split it into multiple lines, if necessary.
// Newlines added by the user will be preserved.
for line in cell.content.iter() {
if measure_text_width(line) > info.content_width.into() {
let mut parts = split_line(line, info, delimiter);
cell_lines.append(&mut parts);
} else {
cell_lines.push(line.into());
}
}
// Remove all unneeded lines of this cell, if the row's content should be
// truncated and there're too many lines in this cell.
// This also inserts a '...' string so users know that there's truncated stuff.
if let Some(lines) = row.max_height {
if cell_lines.len() > lines {
let _ = cell_lines.split_off(lines);
// Direct access.
let last_line = cell_lines
.get_mut(lines - 1)
.expect("We know it's this long.");
// we are truncate the line, so we might cuttoff a ansi code
#[cfg(feature = "custom_styling")]
{
let stripped = console::strip_ansi_codes(last_line).to_string();
*last_line = stripped;
}
// Don't do anything if the column is smaller then 6 characters
let width: usize = info.content_width.into();
if width >= 6 {
// Truncate the line if '...' doesn't fit
if last_line.width() >= width - 3 {
let surplus = (last_line.width() + 3) - width;
last_line.truncate(last_line.width() - surplus);
}
last_line.push_str("...");
}
}
}
// Iterate over all generated lines of this cell and align them
let cell_lines = cell_lines
.iter()
.map(|line| align_line(table, info, cell, line.to_string()));
temp_row_content.push(cell_lines.collect());
}
// Right now, we have a different structure than desired.
// The content is organized by `row->cell->line`.
// We want to remove the cell from our datastructure, since this makes the next step a lot easier.
// In the end it should look like this: `row->lines->column`.
// To achieve this, we calculate the max amount of lines for the current row.
// Afterwards, we iterate over each cell and convert the current structure to the desired one.
// This step basically transforms this:
// tc[0][0][0] tc[0][1][0]
// tc[0][0][1] tc[0][1][1]
// tc[0][0][2] This part of the line is missing
//
// to this:
// tc[0][0][0] tc[0][0][1]
// tc[0][1][0] tc[0][1][1]
// tc[0][2][0] tc[0][2][1] <- Now filled with placeholder (spaces)
let max_lines = temp_row_content.iter().map(Vec::len).max().unwrap_or(0);
let mut row_content = Vec::with_capacity(max_lines * display_infos.len());
// Each column should have `max_lines` for this row.
// Cells content with fewer lines will simply be topped up with empty strings.
for index in 0..max_lines {
let mut line = Vec::with_capacity(display_infos.len());
let mut cell_iter = temp_row_content.iter();
for info in display_infos.iter() {
if info.is_hidden {
continue;
}
let cell = cell_iter.next().unwrap();
match cell.get(index) {
// The current cell has content for this line. Append it
Some(content) => line.push(content.clone()),
// The current cell doesn't have content for this line.
// Fill with a placeholder (empty spaces)
None => line.push(" ".repeat(info.width().into())),
}
}
row_content.push(line);
}
row_content
}
/// Apply the alignment for a column. Alignment can be either Left/Right/Center.
/// In every case all lines will be exactly the same character length `info.width - padding long`
/// This is needed, so we can simply insert it into the border frame later on.
/// Padding is applied in this function as well.
#[allow(unused_variables)]
fn align_line(table: &Table, info: &ColumnDisplayInfo, cell: &Cell, mut line: String) -> String {
let content_width = info.content_width;
let remaining: usize = usize::from(content_width).saturating_sub(measure_text_width(&line));
// Apply the styling before aligning the line, if the user requests it.
// That way non-delimiter whitespaces won't have stuff like underlines.
#[cfg(feature = "tty")]
if table.should_style() && table.style_text_only {
line = style_line(line, cell);
}
// Determine the alignment of the column cells.
// Cell settings overwrite the columns Alignment settings.
// Default is Left
let alignment = if let Some(alignment) = cell.alignment {
alignment
} else if let Some(alignment) = info.cell_alignment {
alignment
} else {
CellAlignment::Left
};
// Apply left/right/both side padding depending on the alignment of the column
match alignment {
CellAlignment::Left => {
line += &" ".repeat(remaining);
}
CellAlignment::Right => {
line = " ".repeat(remaining) + &line;
}
CellAlignment::Center => {
let left_padding = (remaining as f32 / 2f32).ceil() as usize;
let right_padding = (remaining as f32 / 2f32).floor() as usize;
line = " ".repeat(left_padding) + &line + &" ".repeat(right_padding);
}
}
line = pad_line(&line, info);
#[cfg(feature = "tty")]
if table.should_style() && !table.style_text_only {
return style_line(line, cell);
}
line
}
/// Apply the column's padding to this line
fn pad_line(line: &str, info: &ColumnDisplayInfo) -> String {
let mut padded_line = String::new();
padded_line += &" ".repeat(info.padding.0.into());
padded_line += line;
padded_line += &" ".repeat(info.padding.1.into());
padded_line
}
#[cfg(feature = "tty")]
fn style_line(line: String, cell: &Cell) -> String {
// Just return the line, if there's no need to style.
if cell.fg.is_none() && cell.bg.is_none() && cell.attributes.is_empty() {
return line;
}
let mut content = style(line);
// Apply text color
if let Some(color) = cell.fg {
content = content.with(map_color(color));
}
// Apply background color
if let Some(color) = cell.bg {
content = content.on(map_color(color));
}
for attribute in cell.attributes.iter() {
content = content.attribute(map_attribute(*attribute));
}
content.to_string()
}