libfort/README.md

libfort (Library to create FORmatted Tables)

libfort is a simple crossplatform library to create formatted text tables.

Features:

• Easy to integrate (only 2 files)
• Customization of appearance (various border styles and row/column/cell properties for indentation, alignment, padding)
• A number of functions to fill the table (add content by adding separate cells, rows or use printf like functions)
• Support of multiple lines in cells
• Support of wide characters

Design goals

• Maintainability and robustness. libfort is written in C because it is much less complicated than C++ and it can be used in both C and C++ projects and even on platforms without C++ compiler.
• Trivial integration. Therefore all source code files are amalgamed in only 2 files.
• Heavy testing. The goal is to cover 100% of the code (it is not reached yet) and to run tests on all major compilers and platforms.

Integration

Add 2 files ( fort.c and fort.h from lib direrctory) to your C or C++ project and include

#include "fort.h"

in your source code where you will use libfort functions.

For C++ projects that use compiler with C++11 support (and later) there are also availabe convenient C++ wrappers around C functions (see fort.hpp in lib direrctory). In that case instead of fort.h you will need to include

#include "fort.hpp"

Documentation

See wiki of the project.

Getting Started

The common libfort usage pattern:

• create a table (_ft_create_table_);
• fill it with data (_ft_write_ln_, _fr_ptrintf_ln_, _ft_row_write_, ...);
• modify basic table appearance (_ft_set_cell_prop_, ft_set_border_style ...)
• convert table to string representation (_ft_to_string_);
• destroy the table (_ft_destroy_table_)

Here are some examples:

Basic example

/* C API */
#include <stdio.h>
#include "fort.h"
int main(void)
{
    ft_table_t *table = ft_create_table();
    /* Set "header" type for the first row */
    ft_set_cell_prop(table, 0, FT_ANY_COLUMN, FT_CPROP_ROW_TYPE, FT_ROW_HEADER);

    ft_write_ln(table, "N", "Driver", "Time", "Avg Speed");

    ft_write_ln(table, "1", "Ricciardo", "1:25.945", "222.128");
    ft_write_ln(table, "2", "Hamilton", "1:26.373", "221.027");
    ft_write_ln(table, "3", "Verstappen", "1:26.469", "220.782");

    printf("%s\n", ft_to_string(table));
    ft_destroy_table(table);
}

/* C++ API */
#include <iostream>
#include "fort.hpp"
int main(void)
{
    fort::Table table;
    table << fort::header
        << "N" << "Driver" << "Time" << "Avg Speed" << fort::endr
        << "1" << "Ricciardo" << "1:25.945" << "47.362" << fort::endr
        << "2" << "Hamilton" << "1:26.373" << "35.02" << fort::endr
        << "3" << "Verstappen" << "1:26.469" << "29.78" << fort::endr;

    std::cout << table.to_string() << std::endl;
}

Output:

+---+------------+----------+-----------+
| N | Driver     | Time     | Avg Speed |
+---+------------+----------+-----------+
| 1 | Ricciardo  | 1:25.945 | 47.362    |
| 2 | Hamilton   | 1:26.373 | 35.02     |
| 3 | Verstappen | 1:26.469 | 29.78     |
+---+------------+----------+-----------+

Customize table appearance

/* C API */
#include <stdio.h>
#include "fort.h"
int main(void)
{
    ft_table_t *table = ft_create_table();
    /* Change border style */
    ft_set_border_style(table, FT_DOUBLE2_STYLE);

    /* Set "header" type for the first row */
    ft_set_cell_prop(table, 0, FT_ANY_COLUMN, FT_CPROP_ROW_TYPE, FT_ROW_HEADER);
    ft_write_ln(table, "Movie title", "Director", "Year", "Rating");

    ft_write_ln(table, "The Shawshank Redemption", "Frank Darabont", "1994", "9.5");
    ft_write_ln(table, "The Godfather", "Francis Ford Coppola", "1972", "9.2");
    ft_write_ln(table, "2001: A Space Odyssey", "Stanley Kubrick", "1968", "8.5");

    /* Set center alignment for the 1st and 3rd columns */
    ft_set_cell_prop(table, FT_ANY_ROW, 1, FT_CPROP_TEXT_ALIGN, FT_ALIGNED_CENTER);
    ft_set_cell_prop(table, FT_ANY_ROW, 3, FT_CPROP_TEXT_ALIGN, FT_ALIGNED_CENTER);

    printf("%s\n", ft_to_string(table));
    ft_destroy_table(table);
}

/* C++ API */
#include <iostream>
#include "fort.hpp"
int main(void)
{
    fort::Table table;
    /* Change border style */
    table.set_border_style(FT_DOUBLE2_STYLE);

    table << fort::header
        << "Movie title" << "Director" << "Year" << "Rating" << fort::endr
        << "The Shawshank Redemption" << "Frank Darabont" << "1994" << "9.5" << fort::endr
        << "The Godfather" << "Francis Ford Coppola" << "1972" << "9.2" << fort::endr
        << "2001: A Space Odyssey" << "Stanley Kubrick" << "1968" << "8.5" << fort::endr;

    /* Set center alignment for the 1st and 3rd columns */
    table.set_cell_text_align(FT_ANY_ROW, 1, fort::TextAlign::Center);
    table.set_cell_text_align(FT_ANY_ROW, 3, fort::TextAlign::Center);

    std::cout << table.to_string() << std::endl;
}

Output:

╔══════════════════════════╤══════════════════════╤══════╤════════╗
║ Movie title              │       Director       │ Year │ Rating ║
╠══════════════════════════╪══════════════════════╪══════╪════════╣
║ The Shawshank Redemption │    Frank Darabont    │ 1994 │  9.5   ║
╟──────────────────────────┼──────────────────────┼──────┼────────╢
║ The Godfather            │ Francis Ford Coppola │ 1972 │  9.2   ║
╟──────────────────────────┼──────────────────────┼──────┼────────╢
║ 2001: A Space Odyssey    │   Stanley Kubrick    │ 1968 │  8.5   ║
╚══════════════════════════╧══════════════════════╧══════╧════════╝

Different ways to fill table with data

/* C API */
#include <stdio.h>
#include "fort.h"
int main(void)
{
    ft_table_t *table = ft_create_table();
    /* Set "header" type for the first row */
    ft_set_cell_prop(table, 0, FT_ANY_COLUMN, FT_CPROP_ROW_TYPE, FT_ROW_HEADER);
    ft_write_ln(table, "N", "Planet", "Speed, km/s", "Temperature, K");

    /* Fill row with printf like function */
    ft_printf_ln(table, "1|%s|%6.3f|%d", "Mercury", 47.362, 340);

    /* Fill row explicitly with strings */
    ft_write_ln(table, "2", "Venus", "35.02", "737");

    /* Fill row with the array of strings */
    const char *arr[4] = {"3", "Earth", "29.78", "288"};
    ft_row_write_ln(table, 4, arr);

    printf("%s\n", ft_to_string(table));
    ft_destroy_table(table);
}

/* C++ API */
#include <iostream>
#include "fort.hpp"
int main(void)
{
    fort::Table table;
    table << fort::header;
    /* Fill each cell with operator[] */
    table [0][0] = "N";
    table [0][1] = "Planet";
    table [0][2] = "Speed, km/s";
    table [0][3] = "Temperature, K";
    table << fort::endr;

    /* Fill with iostream operator<< */
    table << 1 << "Mercury" << 47.362 << 340 << fort::endr;

    /* Fill row explicitly with strings */
    table.write_ln("2", "Venus", "35.02", "737");

    /* Fill row with data from the container */
    std::vector<std::string> arr = {"3", "Earth", "29.78", "288"};
    table.row_write_ln(std::begin(arr), std::end(arr));

    std::cout << table.to_string() << std::endl;
}

Output:

+---+---------+-------------+----------------+
| N | Planet  | Speed, km/s | Temperature, K |
+---+---------+-------------+----------------+
| 1 | Mercury | 47.362      | 340            |
| 2 | Venus   | 35.02       | 737            |
| 3 | Earth   | 29.78       | 288            |
+---+---------+-------------+----------------+

Supported platforms and compilers

The following compilers are currently used in continuous integration at Travis and AppVeyor:

Compiler	Operating System
GCC 4.8.4	Ubuntu 14.04.3
GCC 4.9.4	Ubuntu 14.04.3
GCC 5.5.0	Ubuntu 14.04.3
GCC 6.4.0	Ubuntu 14.04.3
GCC 7.3.0	Ubuntu 14.04.3
GCC 8.1.0	Ubuntu 14.04.3
Clang 5.0.0	Ubuntu 14.04.3
AppleClang 7.3.0	Darwin Kernel Version 15.6.0
AppleClang 8.1.0	Darwin Kernel Version 16.7.0
AppleClang 9.1.0	Darwin Kernel Version 17.4.0
Visual Studio 2017	Windows Server 2016

Please note:

• In case of clang on OS X before using libfort with wchar_t with real unicode symbols it may be necessary to set setlocale(LC_CTYPE, ""); because otherwise standard function swprintf, that libfort uses internally, may fail and ft_to_string will return error.

License

The class is licensed under the MIT License:

Copyright © 2017 - 2018 Seleznev Anton

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.