term_grid-0.1.7/.gitignore010064400007650000024000000000221277157240700137100ustar0000000000000000target Cargo.lock term_grid-0.1.7/.travis.yml010064400007650000024000000001431325101664600140250ustar0000000000000000language: rust rust: - stable - beta - nightly matrix: allow_failures: - rust: nightly term_grid-0.1.7/Cargo.toml.orig010064400007650000024000000005421325102004700145740ustar0000000000000000[package] name = "term_grid" description = "Library for formatting strings into a grid layout" authors = ["Ben S "] documentation = "https://docs.rs/term_grid/" repository = "https://github.com/ogham/rust-term-grid" license = "MIT" readme = "README.md" version = "0.1.7" [lib] name = "term_grid" [dependencies] unicode-width = "0.1.3" term_grid-0.1.7/Cargo.toml0000644000000015640000000000000110600ustar00# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO # # When uploading crates to the registry Cargo will automatically # "normalize" Cargo.toml files for maximal compatibility # with all versions of Cargo and also rewrite `path` dependencies # to registry (e.g. crates.io) dependencies # # If you believe there's an error in this file please file an # issue against the rust-lang/cargo repository. If you're # editing this file be aware that the upstream Cargo.toml # will likely look very different (and much more reasonable) [package] name = "term_grid" version = "0.1.7" authors = ["Ben S "] description = "Library for formatting strings into a grid layout" documentation = "https://docs.rs/term_grid/" readme = "README.md" license = "MIT" repository = "https://github.com/ogham/rust-term-grid" [lib] name = "term_grid" [dependencies.unicode-width] version = "0.1.3" term_grid-0.1.7/examples/basic.rs010064400007650000024000000007511277157240700151760ustar0000000000000000extern crate term_grid; use term_grid::{Grid, GridOptions, Direction, Filling}; fn main() { let mut grid = Grid::new(GridOptions { direction: Direction::TopToBottom, filling: Filling::Spaces(2), }); for i in 0..40 { grid.add(format!("{}", 2_isize.pow(i)).into()) } if let Some(grid_display) = grid.fit_into_width(40) { println!("{}", grid_display); } else { println!("Couldn't fit grid into 40 columns!"); } } term_grid-0.1.7/LICENCE010064400007650000024000000020561325101316400126760ustar0000000000000000MIT License Copyright (c) 2018 Benjamin Sago Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. term_grid-0.1.7/README.md010064400007650000024000000070121325101346200131660ustar0000000000000000# rust-term-grid [![term_grid on crates.io](http://meritbadge.herokuapp.com/term_grid)](https://crates.io/crates/term_grid) [![Build status](https://travis-ci.org/ogham/rust-term-grid.svg?branch=master)](https://travis-ci.org/ogham/rust-term-grid) This library arranges textual data in a grid format suitable for fixed-width fonts, using an algorithm to minimise the amount of space needed. ### [View the Rustdoc](https://docs.rs/term_grid) # Installation This crate works with [Cargo](http://crates.io). Add the following to your `Cargo.toml` dependencies section: ```toml [dependencies] term_grid = "0.1" ``` ## Usage This library arranges textual data in a grid format suitable for fixed-width fonts, using an algorithm to minimise the amount of space needed. For example: ```rust use term_grid::{Grid, GridOptions, Direction, Filling}; let mut grid = Grid::new(GridOptions { filling: Filling::Spaces(1), direction: Direction::LeftToRight, }); for s in vec!["one", "two", "three", "four", "five", "six", "seven", "eight", "nine", "ten", "eleven", "twelve"] { grid.add(s.into()); } println!("{}", grid.fit_into_width(24).unwrap()); ``` Produces the following tabular result: ``` one two three four five six seven eight nine ten eleven twelve ``` ## Creating a grid To add data to a grid, first create a new `Grid` value, and then add cells to them with the `add` method. There are two options that must be specified in the `GridOptions` value that dictate how the grid is formatted: - `filling`: what to put in between two columns - either a number of spaces, or a text string; - `direction`, which specifies whether the cells should go along rows, or columns: - `Direction::LeftToRight` starts them in the top left and moves *rightwards*, going to the start of a new row after reaching the final column; - `Direction::TopToBottom` starts them in the top left and moves *downwards*, going to the top of a new column after reaching the final row. ## Displaying a grid When display a grid, you can either specify the number of columns in advance, or try to find the maximum number of columns that can fit in an area of a given width. Splitting a series of cells into columns - or, in other words, starting a new row every *n* cells - is achieved with the `fit_into_columns` method on a `Grid` value. It takes as its argument the number of columns. Trying to fit as much data onto one screen as possible is the main use case for specifying a maximum width instead. This is achieved with the `fit_into_width` method. It takes the maximum allowed width, including separators, as its argument. However, it returns an *optional* `Display` value, depending on whether any of the cells actually had a width greater than the maximum width! If this is the case, your best bet is to just output the cells with one per line. ## Cells and data Grids do not take `String`s or `&str`s - they take `Cells`. A **Cell** is a struct containing an individual cell’s contents, as a string, and its pre-computed length, which gets used when calculating a grid’s final dimensions. Usually, you want the *Unicode width* of the string to be used for this, so you can turn a `String` into a `Cell` with the `.into()` method. However, you may also want to supply your own width: when you already know the width in advance, or when you want to change the measurement, such as skipping over terminal control characters. For cases like these, the fields on the `Cell` values are public, meaning you can construct your own instances as necessary. term_grid-0.1.7/src/lib.rs010064400007650000024000000444751325101600400136230ustar0000000000000000#![crate_name = "term_grid"] #![crate_type = "rlib"] #![crate_type = "dylib"] #![deny(unsafe_code)] #![warn(missing_copy_implementations)] #![warn(missing_debug_implementations)] #![warn(missing_docs)] #![warn(trivial_numeric_casts)] #![warn(unreachable_pub)] #![warn(unused_results)] //! This library arranges textual data in a grid format suitable for //! fixed-width fonts, using an algorithm to minimise the amount of space //! needed. For example: //! //! ```rust //! use term_grid::{Grid, GridOptions, Direction, Filling}; //! //! let mut grid = Grid::new(GridOptions { //! filling: Filling::Spaces(1), //! direction: Direction::LeftToRight, //! }); //! //! for s in vec!["one", "two", "three", "four", "five", "six", "seven", //! "eight", "nine", "ten", "eleven", "twelve"] { //! grid.add(s.into()); //! } //! //! println!("{}", grid.fit_into_width(24).unwrap()); //! ``` //! //! Produces the following tabular result: //! //! ```text //! one two three four //! five six seven eight //! nine ten eleven twelve //! ``` //! //! //! ## Creating a grid //! //! To add data to a grid, first create a new `Grid` value, and then add //! cells to them with the `add` method. //! //! There are two options that must be specified in the `GridOptions` value //! that dictate how the grid is formatted: //! //! - `filling`: what to put in between two columns - either a number of //! spaces, or a text string; //! - `direction`, which specifies whether the cells should go along //! rows, or columns: //! - `Direction::LeftToRight` starts them in the top left and //! moves *rightwards*, going to the start of a new row after reaching the //! final column; //! - `Direction::TopToBottom` starts them in the top left and moves //! *downwards*, going to the top of a new column after reaching the final //! row. //! //! //! ## Displaying a grid //! //! When display a grid, you can either specify the number of columns in advance, //! or try to find the maximum number of columns that can fit in an area of a //! given width. //! //! Splitting a series of cells into columns - or, in other words, starting a new //! row every *n* cells - is achieved with the `fit_into_columns` method on a //! `Grid` value. It takes as its argument the number of columns. //! //! Trying to fit as much data onto one screen as possible is the main use case //! for specifying a maximum width instead. This is achieved with the //! `fit_into_width` method. It takes the maximum allowed width, including //! separators, as its argument. However, it returns an *optional* `Display` //! value, depending on whether any of the cells actually had a width greater than //! the maximum width! If this is the case, your best bet is to just output the //! cells with one per line. //! //! //! ## Cells and data //! //! Grids to not take `String`s or `&str`s - they take `Cells`. //! //! A **Cell** is a struct containing an individual cell’s contents, as a string, //! and its pre-computed length, which gets used when calculating a grid’s final //! dimensions. Usually, you want the *Unicode width* of the string to be used for //! this, so you can turn a `String` into a `Cell` with the `.into()` method. //! //! However, you may also want to supply your own width: when you already know the //! width in advance, or when you want to change the measurement, such as skipping //! over terminal control characters. For cases like these, the fields on the //! `Cell` values are public, meaning you can construct your own instances as //! necessary. use std::cmp::max; use std::convert; use std::fmt; use std::iter::repeat; extern crate unicode_width; use unicode_width::UnicodeWidthStr; /// A **Cell** is the combination of a string and its pre-computed length. /// /// The easiest way to create a Cell is just by using `string.into()`, which /// uses the **unicode width** of the string (see the `unicode_width` crate). /// However, the fields are public, if you wish to provide your own length. #[derive(PartialEq, Debug)] pub struct Cell { /// The string to display when this cell gets rendered. pub contents: String, /// The pre-computed length of the string. pub width: Width, } impl convert::From for Cell { fn from(string: String) -> Self { Cell { width: UnicodeWidthStr::width(&*string), contents: string, } } } impl<'a> convert::From<&'a str> for Cell { fn from(string: &'a str) -> Self { Cell { width: UnicodeWidthStr::width(&*string), contents: string.into(), } } } /// Direction cells should be written in - either across, or downwards. #[derive(PartialEq, Debug, Copy, Clone)] pub enum Direction { /// Starts at the top left and moves rightwards, going back to the first /// column for a new row - like a typewriter. LeftToRight, /// Starts at the top left and moves downwards, going back to the first /// row for a new column - like how `ls` lists files by default. TopToBottom, } /// The width of a cell, in columns. pub type Width = usize; /// The text to put in between each pair of columns. #[derive(PartialEq, Debug)] pub enum Filling { /// A certain number of spaces. Spaces(Width), /// The same string, every time. Text(String), } impl Filling { fn width(&self) -> Width { match *self { Filling::Spaces(w) => w, Filling::Text(ref t) => UnicodeWidthStr::width(&t[..]), } } } /// The user-assignable options for a grid view that should be passed into /// `Grid::new()`. #[derive(PartialEq, Debug)] pub struct GridOptions { /// Direction that the cells should be written in - either across, or /// downwards. pub direction: Direction, /// Number of spaces to put in between each column of cells. pub filling: Filling, } #[derive(PartialEq, Debug)] struct Dimensions { /// The number of lines in the grid. num_lines: Width, /// The width of each column in the grid. The length of this vector serves /// as the number of columns. widths: Vec, } impl Dimensions { fn total_width(&self, separator_width: Width) -> Width { if self.widths.is_empty() { 0 } else { let values = self.widths.iter().sum::(); let separators = separator_width * (self.widths.len() - 1); values + separators } } } /// Everything needed to format the cells with the grid options. /// /// For more information, see the module-level documentation. #[derive(PartialEq, Debug)] pub struct Grid { options: GridOptions, cells: Vec, } impl Grid { /// Creates a new grid view with the given options. pub fn new(options: GridOptions) -> Grid { let cells = Vec::new(); Grid { options, cells } } /// Reserves space in the vector for the given number of additional cells /// to be added. (See `vec#reserve`) pub fn reserve(&mut self, additional: usize) { self.cells.reserve(additional) } /// Adds another cell onto the vector. pub fn add(&mut self, cell: Cell) { self.cells.push(cell) } /// Returns a displayable grid that's been packed to fit into the given /// width in the fewest number of rows. /// /// Returns `None` if any of the cells has a width greater than the /// maximum width. pub fn fit_into_width(&self, maximum_width: Width) -> Option { self.width_dimensions(maximum_width) .map(|dims| Display { grid: self, dimensions: dims, }) } /// Returns a displayable grid with the given number of columns, and no /// maximum width. pub fn fit_into_columns(&self, num_columns: usize) -> Display { Display { grid: self, dimensions: self.columns_dimensions(num_columns), } } fn columns_dimensions(&self, num_columns: usize) -> Dimensions { let mut num_lines = self.cells.len() / num_columns; if self.cells.len() % num_columns != 0 { num_lines += 1; } self.column_widths(num_lines, num_columns) } fn column_widths(&self, num_lines: usize, num_columns: usize) -> Dimensions { let mut widths: Vec = repeat(0).take(num_columns).collect(); for (index, cell) in self.cells.iter().enumerate() { let index = match self.options.direction { Direction::LeftToRight => index % num_columns, Direction::TopToBottom => index / num_lines, }; widths[index] = max(widths[index], cell.width); } Dimensions { num_lines, widths } } fn width_dimensions(&self, maximum_width: Width) -> Option { // TODO: this function could almost certainly be optimised... // surely not *all* of the numbers of lines are worth searching through! let cell_count = self.cells.len(); if cell_count == 0 { return Some(Dimensions { num_lines: 0, widths: Vec::new() }); } if cell_count == 1 { let the_cell = &self.cells[0]; if the_cell.width <= maximum_width { return Some(Dimensions { num_lines: 1, widths: vec![ the_cell.width ] }); } else { return None; } } // Instead of numbers of columns, try to find the fewest number of *lines* // that the output will fit in. for num_lines in 1 .. cell_count { // The number of columns is the number of cells divided by the number // of lines, *rounded up*. let mut num_columns = cell_count / num_lines; if cell_count % num_lines != 0 { num_columns += 1; } // Early abort: if there are so many columns that the width of the // *column separators* is bigger than the width of the screen, then // don't even try to tabulate it. // This is actually a necessary check, because the width is stored as // a usize, and making it go negative makes it huge instead, but it // also serves as a speed-up. let total_separator_width = (num_columns - 1) * self.options.filling.width(); if maximum_width < total_separator_width { continue; } // Remove the separator width from the available space. let adjusted_width = maximum_width - total_separator_width; let potential_dimensions = self.column_widths(num_lines, num_columns); if potential_dimensions.widths.iter().sum::() < adjusted_width { return Some(potential_dimensions); } } // If you get here you have really wide cells. None } } /// A displayable representation of a Grid. #[derive(PartialEq, Debug)] pub struct Display<'grid> { /// The grid to display. grid: &'grid Grid, /// The pre-computed column widths for this grid. dimensions: Dimensions, } impl<'grid> Display<'grid> { /// Returns how many columns this display takes up, based on the separator /// width and the number and width of the columns. pub fn width(&self) -> Width { self.dimensions.total_width(self.grid.options.filling.width()) } /// Returns how many rows this display takes up. pub fn row_count(&self) -> usize { self.dimensions.num_lines } /// Returns whether this display takes up as many columns as were allotted /// to it. /// /// It's possible to construct tables that don't actually use up all the /// columns that they could, such as when there are more columns than /// cells! In this case, a column would have a width of zero. This just /// checks for that. pub fn is_complete(&self) -> bool { self.dimensions.widths.iter().all(|&x| x > 0) } } impl<'grid> fmt::Display for Display<'grid> { fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> { for y in 0 .. self.dimensions.num_lines { for x in 0 .. self.dimensions.widths.len() { let num = match self.grid.options.direction { Direction::LeftToRight => y * self.dimensions.widths.len() + x, Direction::TopToBottom => y + self.dimensions.num_lines * x, }; // Abandon a line mid-way through if that's where the cells end if num >= self.grid.cells.len() { continue; } let cell = &self.grid.cells[num]; if x == self.dimensions.widths.len() - 1 { // The final column doesn't need to have trailing spaces try!(write!(f, "{}", cell.contents)); } else { assert!(self.dimensions.widths[x] >= cell.width); match self.grid.options.filling { Filling::Spaces(n) => { let extra_spaces = self.dimensions.widths[x] - cell.width + n; try!(write!(f, "{}", pad_string(&cell.contents, extra_spaces))); }, Filling::Text(ref t) => { let extra_spaces = self.dimensions.widths[x] - cell.width; try!(write!(f, "{}{}", pad_string(&cell.contents, extra_spaces), t)); }, } } } try!(write!(f, "\n")); } Ok(()) } } /// Pad a string with the given number of spaces. fn spaces(length: usize) -> String { repeat(" ").take(length).collect() } /// Pad a string with the given alignment and number of spaces. /// /// This doesn't take the width the string *should* be, rather the number /// of spaces to add. fn pad_string(string: &str, padding: usize) -> String { format!("{}{}", string, spaces(padding)) } #[cfg(test)] mod test { use super::*; #[test] fn no_items() { let grid = Grid::new(GridOptions { direction: Direction::TopToBottom, filling: Filling::Spaces(2), }); let display = grid.fit_into_width(40).unwrap(); assert_eq!(display.dimensions.num_lines, 0); assert!(display.dimensions.widths.is_empty()); assert_eq!(display.width(), 0); } #[test] fn one_item() { let mut grid = Grid::new(GridOptions { direction: Direction::TopToBottom, filling: Filling::Spaces(2), }); grid.add(Cell::from("1")); let display = grid.fit_into_width(40).unwrap(); assert_eq!(display.dimensions.num_lines, 1); assert_eq!(display.dimensions.widths, vec![ 1 ]); assert_eq!(display.width(), 1); } #[test] fn one_item_exact_width() { let mut grid = Grid::new(GridOptions { direction: Direction::TopToBottom, filling: Filling::Spaces(2), }); grid.add(Cell::from("1234567890")); let display = grid.fit_into_width(10).unwrap(); assert_eq!(display.dimensions.num_lines, 1); assert_eq!(display.dimensions.widths, vec![ 10 ]); assert_eq!(display.width(), 10); } #[test] fn one_item_just_over() { let mut grid = Grid::new(GridOptions { direction: Direction::TopToBottom, filling: Filling::Spaces(2), }); grid.add(Cell::from("1234567890!")); assert_eq!(grid.fit_into_width(10), None); } #[test] fn two_small_items() { let mut grid = Grid::new(GridOptions { direction: Direction::TopToBottom, filling: Filling::Spaces(2), }); grid.add(Cell::from("1")); grid.add(Cell::from("2")); let display = grid.fit_into_width(40).unwrap(); assert_eq!(display.dimensions.num_lines, 1); assert_eq!(display.dimensions.widths, vec![ 1, 1 ]); assert_eq!(display.width(), 1 + 2 + 1); } #[test] fn two_medium_size_items() { let mut grid = Grid::new(GridOptions { direction: Direction::TopToBottom, filling: Filling::Spaces(2), }); grid.add(Cell::from("hello there")); grid.add(Cell::from("how are you today?")); let display = grid.fit_into_width(40).unwrap(); assert_eq!(display.dimensions.num_lines, 1); assert_eq!(display.dimensions.widths, vec![ 11, 18 ]); assert_eq!(display.width(), 11 + 2 + 18); } #[test] fn two_big_items() { let mut grid = Grid::new(GridOptions { direction: Direction::TopToBottom, filling: Filling::Spaces(2), }); grid.add(Cell::from("nuihuneihsoenhisenouiuteinhdauisdonhuisudoiosadiuohnteihaosdinhteuieudi")); grid.add(Cell::from("oudisnuthasuouneohbueobaugceoduhbsauglcobeuhnaeouosbubaoecgueoubeohubeo")); assert_eq!(grid.fit_into_width(40), None); } #[test] fn that_example_from_earlier() { let mut grid = Grid::new(GridOptions { filling: Filling::Spaces(1), direction: Direction::LeftToRight, }); for s in vec!["one", "two", "three", "four", "five", "six", "seven", "eight", "nine", "ten", "eleven", "twelve"] { grid.add(Cell::from(s)); } let bits = "one two three four\nfive six seven eight\nnine ten eleven twelve\n"; assert_eq!(grid.fit_into_width(24).unwrap().to_string(), bits); assert_eq!(grid.fit_into_width(24).unwrap().row_count(), 3); } #[test] fn huge_separator() { let mut grid = Grid::new(GridOptions { filling: Filling::Spaces(100), direction: Direction::LeftToRight, }); grid.add("a".into()); grid.add("b".into()); assert_eq!(grid.fit_into_width(99), None); } #[test] fn huge_yet_unused_separator() { let mut grid = Grid::new(GridOptions { filling: Filling::Spaces(100), direction: Direction::LeftToRight, }); grid.add("abcd".into()); let display = grid.fit_into_width(99).unwrap(); assert_eq!(display.dimensions.num_lines, 1); assert_eq!(display.dimensions.widths, vec![ 4 ]); assert_eq!(display.width(), 4); } }