utils/text/table.cpp

45 /// Applies user overrides to the column widths of a table.
47 /// \param table The table from which to calculate the column widths.
48 /// \param user_widths The column widths provided by the user.  This vector must
68                     "User-provided column widths must be larger than the "
69                     "column contents (except for the width_refill column)");
78 /// Locates the refill column, if any.
82 ///     be width_refill, which is the column we are looking for.
84 /// \return The index of the refill column with a width_refill width if any, or
85 /// otherwise the index of the last column (which is the default refill column).
100 /// On output, a column of the widths vector is truncated to a shorter length
106 ///     width_refill; if not, a default column is refilled.
140 /// \param is_last Whether the text being processed belongs to the last column
141 ///     of a row or not.  Values in the last column should not be padded to
166 /// \param column The column being refilled.
172             const text::table_row::size_type column,
175     const std::vector< std::string > rows = text::refill(row[column],
176                                                          widths[column]);
184             if (j == column)
201 /// \param separator The column separator to use.
212     for (text::table_row::size_type column = 0; column < row.size(); ++column) {
213         if (widths[column] > row[column].length())
214             textual_rows[0][column] = pad_cell(row[column], widths[column],
215                                                column == row.size() - 1);
217             refill_cell(row, widths, column, textual_rows);
252 /// Gets the width of a column.
254 /// The returned value is not valid if add_row() is called again, as the column
257 /// \param column The index of the column of which to get the width.  Must be
260 /// \return The width of a column.
262 text::table::column_width(const widths_vector::size_type column) const
264     PRE(column < _column_widths.size());
265     return _column_widths[column];
328 /// Column width to denote that the column has to fit all of its cells.
332 /// Column width to denote that the column can be refilled to fit the table.
345 /// Sets the width of a column.
348 /// widest cell in the column.  One of the columns can have a width of
349 /// width_refill, which indicates that the column will be refilled if the table
352 /// \param column The index of the column to set the width for.
353 /// \param width The width to set the column to.
357 text::table_formatter::set_column_width(const table_row::size_type column,
363             if (i != column)
365                         "Only one column width can be set to width_refill");
370     if (_column_widths.size() < column + 1)
371         _column_widths.resize(column + 1, width_auto);
372     _column_widths[column] = width;