LIBFORT

These pages contain the API documentation of libfort - simple library to create formatted tables for console applications.

• libfort C API
  • Functions
    • Table lifetime management
      • ft_create_table – create table
      • ft_destroy_table – destroy table
    • Table navigation
      • ft_set_cur_cell – set current cell
      • ft_ln – move current position to the first cell of the next row
      • ft_cur_row – get current row
      • ft_cur_col – get current column
    • Fill table with content
      • ft_printf – fill cells according to the format string
      • ft_printf_ln – fill cells according to the format string and move to the next line
      • ft_write – fill cells with the specified strings
      • ft_write_ln – fill cells with the specified strings and move to the next line
      • ft_nwrite – fill cells with the specified strings
      • ft_nwrite_ln – fill cells with the specified strings and move to the next line
      • ft_row_write – fill cells with the strings from the array
      • ft_row_write_ln – fill cells with the strings from the array and move to the next line
      • ft_table_write – fill cells with the strings from the 2D array
      • ft_table_write_ln – fill cells with the strings from the 2D array and move to the next line
      • ft_add_separator – add horizontal separator
    • Remove content
      • ft_erase_range – erase range of cells
    • Modify appearance of the table
      • ft_set_default_border_style – set default border style for all new created tables
      • ft_set_border_style – modify border style of the table
      • ft_set_default_cell_option – set default cell option for all new created tables
      • ft_set_cell_option – set cell option for the table
      • ft_set_default_tbl_option – set default table option for all new created tables
      • ft_set_tbl_option – set table option for the table
      • ft_set_cell_span – set cell span
    • Others
      • ft_set_memory_funcs – set memory allocation functions for the library
      • ft_set_default_printf_field_separator – Set field separator for ft_printf, ft_printf_ln
      • ft_is_empty – check if table is empty
      • ft_row_count – get number of rows in the table
      • ft_strerror – get string describing the error code
  • Data structures and types
    • ft_table_t – table handler
    • ft_border_chars – structure describing border appearance
    • ft_text_alignment – alignment of cell content
    • ft_row_type – alignment of cell content
• libfort C++ API
  • fort::table – basic table class
    • Table navigation
      • set_cur_cell – set border style
      • cur_row – get row number of the current cell
      • cur_col – get column number of the current cell
    • Fill table with content
      • operator<< – write provided object to the table
      • write – write strings to the table
      • write_ln – write strings to the table and move to the next line
      • range_write – write elements from range to the table
      • range_write_ln – write elements from range to the table and go to the next line
    • String conversions
      • to_string – convert table to string representation
      • c_str – convert table to string representation
    • Modify appearance of the table
      • set_border_style – set border style
      • set_left_margin – set table left margin
      • set_top_margin – set table top margin
      • set_bottom_margin – set table bottom margin
      • set_right_margin – set table right margin
    • Others
      • cell – get cell
      • row – get row
      • column – get column
      • is_empty – check if table is empty
      • row_count – get number of rows in the table
  • fort::property_owner – base class for all objects (table, row, column, cell) for which user can specify properties
    • Modify appearance
      • set_cell_min_width – set minimun width
      • set_cell_text_align – set text alignment
      • set_cell_top_padding – set top padding
      • set_cell_bottom_padding – set bottom padding
      • set_cell_left_padding – set left padding
      • set_cell_right_padding – set right padding
      • set_cell_row_type – set row type
      • set_cell_empty_str_height – set height for empty cell
      • set_cell_content_fg_color – set content foreground color
      • set_cell_bg_color – set cell background color
      • set_cell_content_bg_color – set content background color
      • set_cell_text_style – set cell text style
      • set_cell_content_text_style – set content text style
  • fort::table::table_cell – table cell
  • fort::table::table_row – table row
  • fort::table::table_column – table column
  • fort::table_manipulator – table manipulator
    • fort::header – table manipulator to set current row as a header
    • fort::endr – table manipulator to move current cell to the first cell of the next row
    • fort::separator – table manipulator to add separator
  • Other functions
    • fort::set_default_border_style – set default border style for all new formatted tables
  • Other types
    • fort::text_align – alignment of cell content
    • fort::row_type – type of table row
    • fort::color – color
    • fort::text_style – text style

List of libfort builtin border styles:

                 FT_BASIC_STYLE                                                FT_BASIC2_STYLE                    

+------+--------------------------+------+--------+           +------+--------------------------+------+--------+ 
| Rank | Title                    | Year | Rating |           | Rank | Title                    | Year | Rating | 
+------+--------------------------+------+--------+           +------+--------------------------+------+--------+ 
|  1   | The Shawshank Redemption | 1994 | 9.5    |           |  1   | The Shawshank Redemption | 1994 | 9.5    | 
|  2   | 12 Angry Men             | 1957 | 8.8    |           +------+--------------------------+------+--------+ 
|  3   | It's a Wonderful Life    | 1946 | 8.6    |           |  2   | 12 Angry Men             | 1957 | 8.8    | 
+------+--------------------------+------+--------+           +------+--------------------------+------+--------+ 
|  4   | 2001: A Space Odyssey    | 1968 | 8.5    |           |  3   | It's a Wonderful Life    | 1946 | 8.6    | 
|  5   | Blade Runner             | 1982 | 8.1    |           +------+--------------------------+------+--------+ 
+------+--------------------------+------+--------+           |  4   | 2001: A Space Odyssey    | 1968 | 8.5    | 
                                                              +------+--------------------------+------+--------+ 
                                                              |  5   | Blade Runner             | 1982 | 8.1    | 
                                                              +------+--------------------------+------+--------+ 




                 FT_SIMPLE_STYLE                                               FT_PLAIN_STYLE                     

                                                               -------------------------------------------------  
  Rank   Title                      Year   Rating               Rank   Title                      Year   Rating   
 ------ -------------------------- ------ --------             -------------------------------------------------  
   1     The Shawshank Redemption   1994   9.5                   1     The Shawshank Redemption   1994   9.5      
   2     12 Angry Men               1957   8.8                   2     12 Angry Men               1957   8.8      
   3     It's a Wonderful Life      1946   8.6                   3     It's a Wonderful Life      1946   8.6      
 ------ -------------------------- ------ --------             -------------------------------------------------  
   4     2001: A Space Odyssey      1968   8.5                   4     2001: A Space Odyssey      1968   8.5      
   5     Blade Runner               1982   8.1                   5     Blade Runner               1982   8.1      





                 FT_DOT_STYLE                                                  FT_EMPTY_STYLE                     

...................................................            Rank  Title                     Year  Rating       
: Rank : Title                    : Year : Rating :             1    The Shawshank Redemption  1994  9.5          
:......:..........................:......:........:             2    12 Angry Men              1957  8.8          
:  1   : The Shawshank Redemption : 1994 : 9.5    :             3    It's a Wonderful Life     1946  8.6          
:  2   : 12 Angry Men             : 1957 : 8.8    :                                                               
:  3   : It's a Wonderful Life    : 1946 : 8.6    :             4    2001: A Space Odyssey     1968  8.5          
:......:..........................:......:........:             5    Blade Runner              1982  8.1          
:  4   : 2001: A Space Odyssey    : 1968 : 8.5    :                                                               
:  5   : Blade Runner             : 1982 : 8.1    :                                                               
:......:..........................:......:........:                                                               




                 FT_EMPTY2_STYLE                                               FT_SOLID_STYLE                     

                                                              ┌──────┬──────────────────────────┬──────┬────────┐ 
  Rank   Title                      Year   Rating             │ Rank │ Title                    │ Year │ Rating │ 
   1     The Shawshank Redemption   1994   9.5                ├──────┼──────────────────────────┼──────┼────────┤ 
   2     12 Angry Men               1957   8.8                │  1   │ The Shawshank Redemption │ 1994 │ 9.5    │ 
   3     It's a Wonderful Life      1946   8.6                │  2   │ 12 Angry Men             │ 1957 │ 8.8    │ 
                                                              │  3   │ It's a Wonderful Life    │ 1946 │ 8.6    │ 
   4     2001: A Space Odyssey      1968   8.5                ├──────┼──────────────────────────┼──────┼────────┤ 
   5     Blade Runner               1982   8.1                │  4   │ 2001: A Space Odyssey    │ 1968 │ 8.5    │ 
                                                              │  5   │ Blade Runner             │ 1982 │ 8.1    │ 
                                                              └──────┴──────────────────────────┴──────┴────────╯ 




                 FT_SOLID_ROUND_STYLE                                          FT_NICE_STYLE                      

╭──────┬──────────────────────────┬──────┬────────╮           ╔══════╦══════════════════════════╦══════╦════════╗ 
│ Rank │ Title                    │ Year │ Rating │           ║ Rank ║ Title                    ║ Year ║ Rating ║ 
├──────┼──────────────────────────┼──────┼────────┤           ╠══════╬══════════════════════════╬══════╬════════╣ 
│  1   │ The Shawshank Redemption │ 1994 │ 9.5    │           ║  1   ║ The Shawshank Redemption ║ 1994 ║ 9.5    ║ 
│  2   │ 12 Angry Men             │ 1957 │ 8.8    │           ║  2   ║ 12 Angry Men             ║ 1957 ║ 8.8    ║ 
│  3   │ It's a Wonderful Life    │ 1946 │ 8.6    │           ║  3   ║ It's a Wonderful Life    ║ 1946 ║ 8.6    ║ 
├──────┼──────────────────────────┼──────┼────────┤           ╟──────╫──────────────────────────╫──────╫────────╢ 
│  4   │ 2001: A Space Odyssey    │ 1968 │ 8.5    │           ║  4   ║ 2001: A Space Odyssey    ║ 1968 ║ 8.5    ║ 
│  5   │ Blade Runner             │ 1982 │ 8.1    │           ║  5   ║ Blade Runner             ║ 1982 ║ 8.1    ║ 
╰──────┴──────────────────────────┴──────┴────────╯           ╚══════╩══════════════════════════╩══════╩════════╝ 




                 FT_DOUBLE_STYLE                                               FT_DOUBLE2_STYLE                   

╔══════╦══════════════════════════╦══════╦════════╗           ╔══════╤══════════════════════════╤══════╤════════╗ 
║ Rank ║ Title                    ║ Year ║ Rating ║           ║ Rank │ Title                    │ Year │ Rating ║ 
╠══════╬══════════════════════════╬══════╬════════╣           ╠══════╪══════════════════════════╪══════╪════════╣ 
║  1   ║ The Shawshank Redemption ║ 1994 ║ 9.5    ║           ║  1   │ The Shawshank Redemption │ 1994 │ 9.5    ║ 
║  2   ║ 12 Angry Men             ║ 1957 ║ 8.8    ║           ╟──────┼──────────────────────────┼──────┼────────╢ 
║  3   ║ It's a Wonderful Life    ║ 1946 ║ 8.6    ║           ║  2   │ 12 Angry Men             │ 1957 │ 8.8    ║ 
╠══════╬══════════════════════════╬══════╬════════╣           ╟──────┼──────────────────────────┼──────┼────────╢ 
║  4   ║ 2001: A Space Odyssey    ║ 1968 ║ 8.5    ║           ║  3   │ It's a Wonderful Life    │ 1946 │ 8.6    ║ 
║  5   ║ Blade Runner             ║ 1982 ║ 8.1    ║           ╠══════╪══════════════════════════╪══════╪════════╣ 
╚══════╩══════════════════════════╩══════╩════════╝           ║  4   │ 2001: A Space Odyssey    │ 1968 │ 8.5    ║ 
                                                              ╟──────┼──────────────────────────┼──────┼────────╢ 
                                                              ║  5   │ Blade Runner             │ 1982 │ 8.1    ║ 
                                                              ╚══════╧══════════════════════════╧══════╧════════╝ 




                 FT_BOLD_STYLE                                                 FT_BOLD2_STYLE                     

┏━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━┳━━━━━━━━┓           ┏━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━━━━━┯━━━━━━┯━━━━━━━━┓ 
┃ Rank ┃ Title                    ┃ Year ┃ Rating ┃           ┃ Rank │ Title                    │ Year │ Rating ┃ 
┣━━━━━━╋━━━━━━━━━━━━━━━━━━━━━━━━━━╋━━━━━━╋━━━━━━━━┫           ┣━━━━━━┿━━━━━━━━━━━━━━━━━━━━━━━━━━┿━━━━━━┿━━━━━━━━┫ 
┃  1   ┃ The Shawshank Redemption ┃ 1994 ┃ 9.5    ┃           ┃  1   │ The Shawshank Redemption │ 1994 │ 9.5    ┃ 
┃  2   ┃ 12 Angry Men             ┃ 1957 ┃ 8.8    ┃           ┠──────┼──────────────────────────┼──────┼────────┨ 
┃  3   ┃ It's a Wonderful Life    ┃ 1946 ┃ 8.6    ┃           ┃  2   │ 12 Angry Men             │ 1957 │ 8.8    ┃ 
┣━━━━━━╋━━━━━━━━━━━━━━━━━━━━━━━━━━╋━━━━━━╋━━━━━━━━┫           ┠──────┼──────────────────────────┼──────┼────────┨ 
┃  4   ┃ 2001: A Space Odyssey    ┃ 1968 ┃ 8.5    ┃           ┃  3   │ It's a Wonderful Life    │ 1946 │ 8.6    ┃ 
┃  5   ┃ Blade Runner             ┃ 1982 ┃ 8.1    ┃           ┣━━━━━━┿━━━━━━━━━━━━━━━━━━━━━━━━━━┿━━━━━━┿━━━━━━━━┫ 
┗━━━━━━┻━━━━━━━━━━━━━━━━━━━━━━━━━━┻━━━━━━┻━━━━━━━━┛           ┃  4   │ 2001: A Space Odyssey    │ 1968 │ 8.5    ┃ 
                                                              ┠──────┼──────────────────────────┼──────┼────────┨ 
                                                              ┃  5   │ Blade Runner             │ 1982 │ 8.1    ┃ 
                                                              ┗━━━━━━┷━━━━━━━━━━━━━━━━━━━━━━━━━━┷━━━━━━┷━━━━━━━━┛ 




                 FT_FRAME_STYLE                                                                                   

▛▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▜                                                               
▌ Rank ┃ Title                    ┃ Year ┃ Rating ▐                                                               
▌━━━━━━╋━━━━━━━━━━━━━━━━━━━━━━━━━━╋━━━━━━╋━━━━━━━━▐                                                               
▌  1   ┃ The Shawshank Redemption ┃ 1994 ┃ 9.5    ▐                                                               
▌  2   ┃ 12 Angry Men             ┃ 1957 ┃ 8.8    ▐                                                               
▌  3   ┃ It's a Wonderful Life    ┃ 1946 ┃ 8.6    ▐                                                               
▌━━━━━━╋━━━━━━━━━━━━━━━━━━━━━━━━━━╋━━━━━━╋━━━━━━━━▐                                                               
▌  4   ┃ 2001: A Space Odyssey    ┃ 1968 ┃ 8.5    ▐                                                               
▌  5   ┃ Blade Runner             ┃ 1982 ┃ 8.1    ▐                                                               
▙▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▟                                                                                                                        

Copyright

Copyright © 2017 - 2019 Seleznev Anton. The code is licensed under the MIT License.

Author

Seleznev Anton

See also

https://github.com/seleznevae/libfort to download the source code