core/text/table

text_table

Types

Aligned_Value :: struct {
	alignment: Cell_Alignment,
	value:     any,
}

Source

Cell :: struct {
	text:      string,
	width:     int,
	alignment: Cell_Alignment,
}

Source

Cell_Alignment :: enum int {
	Left   = 0,
	Center = 1,
	Right  = 2,
}

Source

Decorations :: struct {
	// These are strings, because of multi-codepoint Unicode graphemes.
	// Connecting decorations:
	sw:   string,
	s:    string,
	se:   string,
	// Straight lines:
	vert: string,
	horz: string,
}

Source

Table :: struct {
	lpad:             int,
	rpad:             int,
	cells:            [dynamic]Cell,
	caption:          string,
	nr_rows:          int,
	nr_cols:          int,
	has_header_row:   bool,
	table_allocator:  runtime.Allocator,
	format_allocator: runtime.Allocator,
	// The following are computed on build()
	colw:             [dynamic]int,
	tblw:             int,
}

Source

Width_Proc :: proc(str: string) -> (int)Source

Determines the width of a string used in the table for alignment purposes.

Procedures

aligned_header_of_values :: proc(tbl: ^Table, alignment: Cell_Alignment, values, loc = #caller_location)Source

aligned_row_of_values :: proc(tbl: ^Table, alignment: Cell_Alignment, values, loc = #caller_location)Source

ascii_width_proc :: proc(str: string) -> (int)Source

build :: proc(tbl: ^Table, width_proc: Width_Proc)Source

caption :: proc(tbl: ^Table, value: string)Source

destroy :: proc(tbl: ^Table)Source

first_row :: proc(tbl: ^Table) -> (int)Source

format :: proc(tbl: ^Table, _fmt: string, args) -> (string)Source

get_cell :: proc(tbl: ^Table, row: int, col: int, loc = #caller_location) -> (^Cell)Source

header_of_aligned_values :: proc(tbl: ^Table, aligned_values: []Aligned_Value, loc = #caller_location)Source

header_of_values :: proc(tbl: ^Table, values, loc = #caller_location)Source

header_row :: proc(tbl: ^Table) -> (int)Source

init_with_allocator :: proc(tbl: ^Table, format_allocator = context.temp_allocator, table_allocator: mem.Allocator = context.allocator) -> (^Table)

Source

init_with_mem_arena :: proc(tbl: ^Table, format_arena: ^mem.Arena, table_allocator: mem.Allocator = context.allocator) -> (^Table)

Source

init_with_virtual_arena :: proc(tbl: ^Table, format_arena: ^virtual.Arena, table_allocator: mem.Allocator = context.allocator) -> (^Table)

Source

last_row :: proc(tbl: ^Table) -> (int)Source

TODO: This should work correctly when #3262 is fixed. row :: proc {

row_of_values,
	aligned_row_of_values,
	row_of_aligned_values,
}

padding :: proc(tbl: ^Table, lpad: int, rpad: int)Source

row :: proc(tbl: ^Table, values, loc = #caller_location)Source

row_of_aligned_values :: proc(tbl: ^Table, aligned_values: []Aligned_Value, loc = #caller_location)Source

row_of_values :: proc(tbl: ^Table, values, loc = #caller_location)Source

set_cell_alignment :: proc(tbl: ^Table, row: int, col: int, alignment: Cell_Alignment, loc = #caller_location)Source

set_cell_value :: proc(tbl: ^Table, row: int, col: int, value: any, loc = #caller_location)Source

set_cell_value_and_alignment :: proc(
	tbl:       ^Table,
	row:       int,
	col:       int,
	value:     any,
	alignment: Cell_Alignment,
	loc:       _ = #caller_location,
)

Source

stdio_writer :: proc() -> (io.Writer)Source

strings_builder_writer :: proc(b: ^strings.Builder) -> (io.Writer)Source

unicode_width_proc :: proc(str: string) -> (width: int)Source

write_byte_repeat :: proc(w: io.Writer, n: int, b: u8)Source

write_decorated_table :: proc(w: io.Writer, tbl: ^Table, decorations: Decorations, width_proc: Width_Proc)Source

write_html_table :: proc(w: io.Writer, tbl: ^Table)Source

write_markdown_table :: proc(w: io.Writer, tbl: ^Table, width_proc: Width_Proc)Source

Renders table according to GitHub Flavored Markdown (GFM) specification

write_plain_table :: proc(w: io.Writer, tbl: ^Table, width_proc: Width_Proc)Source

write_table_cell :: proc(w: io.Writer, tbl: ^Table, row: int, col: int)Source

write_text_align :: proc(
	w:         io.Writer,
	text:      string,
	alignment: Cell_Alignment,
	lpad:      int,
	rpad:      int,
	space:     int,
)

Source

Procedure Groups

init :: proc{init_with_allocator, init_with_virtual_arena, init_with_mem_arena}Source

text_table

Types

Procedures

Procedure Groups

Find anything

Settings