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
// Copyright (c) tabular-rs Contributors
// SPDX-License-Identifier: MIT OR Apache-2.0
use super::width_string::WidthString;
use std::fmt::{Debug, Display, Formatter};
/// Type for building a [`Table`] row.
///
/// Make a new one with [`Row::new()`], then add to it with [`Row::with_cell()`].
/// Or make a complete one with the [`row!()`] macro or [`Row::from_cells()`].
///
/// # Examples
///
/// ```
/// use tabular::row;
///
/// # fn main() {
/// let table = tabular::Table::new("{:>} ({:<}) {:<}")
/// .with_row(row!(1, "I", "one"))
/// .with_row(row!(5, "V", "five"))
/// .with_row(row!(10, "X", "ten"))
/// .with_row(row!(50, "L", "fifty"))
/// .with_row(row!(100, "C", "one-hundred"));
///
/// assert_eq!( format!("\n{}", table),
/// r#"
/// 1 (I) one
/// 5 (V) five
/// 10 (X) ten
/// 50 (L) fifty
/// 100 (C) one-hundred
/// "# );
/// # }
/// ```
///
/// [`Table`]: struct.Table.html
/// [`row!()`]: macro.row.html
/// [`Row::new()`]: struct.Row.html#method.new
/// [`Row::from_cells()`]: struct.Row.html#method.from_cells
/// [`Row::with_cell()`]: struct.Row.html#method.with_cell
#[derive(Clone, Default)]
pub struct Row(pub(crate) Vec<WidthString>);
impl Row {
/// Makes a new, empty table row.
pub fn new() -> Self {
Row(Vec::new())
}
/// Adds a cell to this table row.
///
/// # Examples
///
/// ```
/// struct DirEntry {
/// size: usize,
/// is_directory: bool,
/// name: String,
/// }
///
/// impl DirEntry {
/// fn to_row(&self) -> tabular::Row {
/// tabular::Row::new()
/// .with_cell(self.size)
/// .with_cell(if self.is_directory { "d" } else { "" })
/// .with_cell(&self.name)
/// }
/// }
/// ```
#[must_use]
pub fn with_cell<S: Display>(mut self, value: S) -> Self {
self.add_cell(value);
self
}
/// Adds a cell to this table row.
///
/// This performs the same work as [`with_cell`], but it's is convenient for adding cells in
/// a loop without having to reassign the row each time. See the example for [`len`].
///
/// [`with_cell`]: #method.with_cell
/// [`len`]: #method.len
pub fn add_cell<S: Display>(&mut self, value: S) -> &mut Self {
self.0.push(WidthString::new(value));
self
}
/// Adds a cell to this table row after stripping ANSI escape sequences.
///
/// If the table is being printed out to a terminal that supports ANSI escape sequences,
/// cell widths need to account for that.
#[must_use]
#[cfg(feature = "ansi-cell")]
pub fn with_ansi_cell<S: Display>(mut self, value: S) -> Self {
self.add_ansi_cell(value);
self
}
/// Adds a cell to this table row with a custom width.
///
/// Similar to [`Self::with_ansi_cell`], except it returns `&mut Self` rather than `Self`.
#[cfg(feature = "ansi-cell")]
pub fn add_ansi_cell<S: Display>(&mut self, value: S) -> &mut Self {
self.0.push(WidthString::new_ansi(value));
self
}
/// Adds a cell to this table row with a custom width.
///
/// Cell widths are normally calculated by looking at the string. In some cases, such as if the
/// string contains escape sequences of some sort, users may wish to specify a specific width
/// to use for a custom cell.
#[must_use]
pub fn with_custom_width_cell<S: Display>(mut self, value: S, width: usize) -> Self {
self.add_custom_width_cell(value, width);
self
}
/// Adds a cell to this table row with a custom width.
///
/// Similar to [`Self::with_custom_width_cell`], except it returns `&mut Self` rather than `Self`.
pub fn add_custom_width_cell<S: Display>(&mut self, value: S, width: usize) -> &mut Self {
self.0.push(WidthString::custom_width(value, width));
self
}
/// Builds a row from an iterator over strings.
///
/// # Examples
///
/// ```
/// # use tabular::*;
/// use std::fmt::Display;
///
/// struct Matrix<'a, T: 'a> {
/// width: usize,
/// height: usize,
/// data: &'a [T],
/// }
///
/// impl<'a, T: Display> Display for Matrix<'a, T> {
/// fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
/// let ncols = self.width;
/// let row_spec: String =
/// std::iter::repeat("{:>} ".chars()).take(ncols).flat_map(|x| x).collect();
///
/// let mut table = Table::new(row_spec.trim_end());
///
/// for row_index in 0 .. self.height {
/// table.add_row(Row::from_cells(
/// self.data[row_index * ncols ..]
/// .iter().take(ncols)
/// .map(|elt: &T| elt.to_string())));
/// }
///
/// write!(f, "{}", table)
/// }
/// }
///
/// print!("{}", Matrix {
/// width: 3,
/// height: 2,
/// data: &[1, 23, 456, 7890, 12345, 678901],
/// });
/// ```
pub fn from_cells<S, I>(values: I) -> Self
where
S: Into<String>,
I: IntoIterator<Item = S>,
{
Row(values
.into_iter()
.map(Into::into)
.map(WidthString::new)
.collect())
}
/// The number of cells in this row.
///
/// # Examples
///
/// It's probably not actually useful, because you are unlikely to come
/// upon a row whose size you don't already know. But it's useful for stating
/// [`Table::add_row`]'s invariant.
///
/// ```
/// # use tabular::*;
/// # use std::fmt::Display;
/// fn print_ragged_matrix<T: Display>(matrix: &[&[T]]) {
/// let ncols = matrix.iter().map(|row| row.len()).max().unwrap_or(0);
///
/// let mut row_spec = String::with_capacity(5 * ncols);
/// for _ in 0 .. ncols {
/// row_spec.push_str("{:>} ");
/// }
///
/// let mut table = Table::new(row_spec.trim_end());
///
/// for row in matrix {
/// let mut table_row = Row::from_cells(row.iter().map(ToString::to_string));
///
/// // Don't remember how to count or subtract but I'll get there eventually.
/// while table_row.len() < table.column_count() {
/// table_row.add_cell("");
/// }
/// }
///
/// print!("{}", table);
/// }
///
/// print_ragged_matrix(&[&[1, 2, 3, 4, 5], &[12, 23, 34], &[123, 234], &[1234]]);
/// ```
///
/// [`Table::add_row`]: struct.Table.html#method.add_row
pub fn len(&self) -> usize {
self.0.len()
}
/// Whether the row is empty
pub fn is_empty(&self) -> bool {
self.0.is_empty()
}
}
impl Debug for Row {
fn fmt(&self, f: &mut Formatter) -> ::std::fmt::Result {
write!(f, "Row::from_cells(vec!{:?})", self.0)
}
}
#[derive(Clone, Debug)]
pub enum InternalRow {
Cells(Vec<WidthString>),
Heading(String),
}