Skip to content
charmOS docs

Console report composer

include/console/report.h View source View on GitHub

Structs

Section titled “Structs”

report_line

Section titled “report_line”
struct report_line {
    char    *buf;
    size_t  cap;
    size_t  len;
    size_t  col;
    size_t  max_col;
    size_t  glyph_at;
    bool    full;
    bool    truncated;
};

report_target

Section titled “report_target”
struct report_target {
    struct report_panes  *panes;
    struct report_box    *box;
    uint16_t             width;
    uint8_t              indent;
    uint8_t              pane;
};

report_box

Section titled “report_box”
struct report_box {
    struct report_target  target;
    uint16_t              inner;
};

report_fields

Section titled “report_fields”
struct report_fields {
    struct report_target  target;
    uint8_t               per_row;
    uint8_t               in_row;
    uint8_t               keyw;
    uint8_t               valw;
    struct report_line    line;
    char                  storage[REPORT_LINE_MAX];
};

report_panes

Section titled “report_panes”
struct report_panes {
    uint8_t     n;
    uint16_t    width[REPORT_PANES_MAX];
    const char  *title[REPORT_PANES_MAX];
    uint8_t     title_sev[REPORT_PANES_MAX];
    uint16_t    nrows[REPORT_PANES_MAX];
    uint32_t    dropped[REPORT_PANES_MAX];
    bool        stacked;
    bool        undivided;
    char        text[REPORT_PANES_MAX][REPORT_PANE_ROWS][REPORT_PANE_LINE_MAX];
    bool        rule[REPORT_PANES_MAX][REPORT_PANE_ROWS];
};

Functions

Section titled “Functions”

report_line_init

Section titled “report_line_init”
void report_line_init(struct report_line *l, char *buf, size_t cap, size_t max_col);

report_line_reset

Section titled “report_line_reset”
void report_line_reset(struct report_line *l);

report_line_puts

Section titled “report_line_puts”
void report_line_puts(struct report_line *l, const char *s);

report_line_printf

Section titled “report_line_printf”
void report_line_printf(struct report_line *l, const char *fmt);

report_line_vprintf

Section titled “report_line_vprintf”
void report_line_vprintf(struct report_line *l, const char *fmt, va_list ap);

report_line_pad_to

Section titled “report_line_pad_to”
void report_line_pad_to(struct report_line *l, size_t col);

report_line_repeat

Section titled “report_line_repeat”
void report_line_repeat(struct report_line *l, const char *glyph, size_t n);

report_line_field

Section titled “report_line_field”
void report_line_field(struct report_line *l, const char *s, size_t width);

report_line_right

Section titled “report_line_right”
void report_line_right(struct report_line *l, const char *s);

report_line_str

Section titled “report_line_str”
const char * report_line_str(const struct report_line *l);

report_line_width

Section titled “report_line_width”
size_t report_line_width(const struct report_line *l);

report_line_truncated

Section titled “report_line_truncated”
bool report_line_truncated(const struct report_line *l);

report_strwidth

Section titled “report_strwidth”
size_t report_strwidth(const char *s);

report_console

Section titled “report_console”
struct report_target report_console(void);

report_console_indent

Section titled “report_console_indent”
struct report_target report_console_indent(uint16_t indent);

report_pane

Section titled “report_pane”
struct report_target report_pane(struct report_panes *panes, uint32_t pane);

report_target_indent

Section titled “report_target_indent”
struct report_target report_target_indent(struct report_target tgt, uint16_t indent);

report_target_width

Section titled “report_target_width”
uint16_t report_target_width(const struct report_target *tgt);

report_puts

Section titled “report_puts”
void report_puts(struct report_target *tgt, const char *s);

report_printf

Section titled “report_printf”
void report_printf(struct report_target *tgt, const char *fmt);

report_blank

Section titled “report_blank”
void report_blank(struct report_target *tgt);

report_line_emit

Section titled “report_line_emit”
void report_line_emit(struct report_target *tgt, struct report_line *l);

report_rule

Section titled “report_rule”
void report_rule(struct report_target *tgt, const char *title);

report_rule_sev

Section titled “report_rule_sev”
void report_rule_sev(struct report_target *tgt, enum term_sev sev, const char *title);

report_wrap

Section titled “report_wrap”
void report_wrap(struct report_target *tgt, const char *text);

report_wrap_printf

Section titled “report_wrap_printf”
void report_wrap_printf(struct report_target *tgt, const char *fmt);

report_box_open

Section titled “report_box_open”
void report_box_open(struct report_box *b, struct report_target target, const char *title, uint16_t inner);

report_box_printf

Section titled “report_box_printf”
void report_box_printf(struct report_box *b, const char *fmt);

report_box_body

Section titled “report_box_body”
struct report_target report_box_body(struct report_box *b);

report_box_close

Section titled “report_box_close”
void report_box_close(struct report_box *b);

report_section_begin

Section titled “report_section_begin”
bool report_section_begin(const char *name);

report_section_begin_at

Section titled “report_section_begin_at”
bool report_section_begin_at(struct report_target *tgt, const char *name);

report_section_claim

Section titled “report_section_claim”
bool report_section_claim(const char *name);

report_section_claim_at

Section titled “report_section_claim_at”
bool report_section_claim_at(struct report_target *tgt, const char *name);

report_section_end

Section titled “report_section_end”
void report_section_end(void);

report_section_current

Section titled “report_section_current”
const char * report_section_current(void);

report_fields_begin

Section titled “report_fields_begin”
void report_fields_begin(struct report_fields *g, struct report_target target, uint32_t keyw, uint32_t valw);

report_field

Section titled “report_field”
void report_field(struct report_fields *g, const char *key, const char *fmt);

report_field_full

Section titled “report_field_full”
void report_field_full(struct report_fields *g, const char *key, const char *fmt);

report_fields_end

Section titled “report_fields_end”
void report_fields_end(struct report_fields *g);

report_panes_begin

Section titled “report_panes_begin”
void report_panes_begin(struct report_panes *panes, uint32_t n, const uint8_t *weights);

report_panes_undivided

Section titled “report_panes_undivided”
void report_panes_undivided(struct report_panes *panes);

report_panes_title

Section titled “report_panes_title”
void report_panes_title(struct report_panes *panes, uint32_t pane, enum term_sev sev, const char *title);

report_panes_top

Section titled “report_panes_top”
void report_panes_top(struct report_panes *panes);

report_panes_bottom

Section titled “report_panes_bottom”
void report_panes_bottom(struct report_panes *panes, enum term_sev sev, const char *title);

report_panes_carry

Section titled “report_panes_carry”
void report_panes_carry(struct report_panes *panes);

report_panes_flush

Section titled “report_panes_flush”
void report_panes_flush(struct report_panes *panes);

report_pane_rows

Section titled “report_pane_rows”
uint16_t report_pane_rows(const struct report_panes *panes, uint32_t pane);

report_panes_rows_max

Section titled “report_panes_rows_max”
uint16_t report_panes_rows_max(const struct report_panes *panes);

report_panes_panic

Section titled “report_panes_panic”
struct report_panes * report_panes_panic(void);

report_enter_panic

Section titled “report_enter_panic”
void report_enter_panic(void);

Macros

Section titled “Macros”

REPORT_LINE_MAX

Section titled “REPORT_LINE_MAX”
#define REPORT_LINE_MAX 1024

REPORT_LINE

Section titled “REPORT_LINE”
#define REPORT_LINE(name, width) \
    char name##_storage[REPORT_LINE_MAX]; \
    struct report_line name; \
    report_line_init(&name, name##_storage, sizeof(name##_storage), (width))

REPORT_FIELD_GAP

Section titled “REPORT_FIELD_GAP”
#define REPORT_FIELD_GAP 2

REPORT_PANES_MAX

Section titled “REPORT_PANES_MAX”
#define REPORT_PANES_MAX 3

REPORT_PANE_ROWS

Section titled “REPORT_PANE_ROWS”
#define REPORT_PANE_ROWS 48

REPORT_PANE_LINE_MAX

Section titled “REPORT_PANE_LINE_MAX”
#define REPORT_PANE_LINE_MAX 384

REPORT_PANE_MIN_WIDTH

Section titled “REPORT_PANE_MIN_WIDTH”
#define REPORT_PANE_MIN_WIDTH 24

REPORT_PANE_GAP

Section titled “REPORT_PANE_GAP”
#define REPORT_PANE_GAP 3