Manage the View Display. More...

Functions
void	display_line (View *view)
	Display Line on Padparam View *view data structure.
void	display_line_eod (View *view)
	Display End of Data.
int	display_prompt (View view, char s)
	Display Command Line Prompt.
void	display_split_line (View *view)
	Display Split Line on Pad.
int	fmt_line (View *view)
	Format Line for Display.
void	log_cc_buf (View *view)
	Log Complex Character Buffer.
void	log_split_lines (View *view)
	Log Split Lines.
void	log_stripped_line_out (View *view)
	Log Stripped Line Output.
void	log_strnz (char *str, uint len)
	Log String with Specified Length.
int	pad_refresh (View *view)
	Refresh Pad and Line Number Window.
void	parse_ansi_str (char ansi_str, attr_t attrs, ushort *cpx)
	Parse ANSI SGR Escape Sequence.
void	view_display_help (Init *init)
	Display View Help File.
void	view_display_page (View *view)
	Display Current Page.

Detailed Description

Manage the View Display.

Function Documentation

◆ display_line()

void display_line ( View * view )

Display Line on Padparam View *view data structure.

This function displays a single line of text on the ncurses pad. If line numbering is enabled (view->f_ln), it is formatted and displayed at the beginning of the line with the specified attributes and color pair.

Because get_next_char calls increment_ln upon encountering a line feed and increment_ln advances view->ln_no after updating the line table, the line number displayed is one greater than the index to the line table. That means the line counter begins with 1, while the table origin is 0. __display_line

Definition at line 1412 of file view_engine.c.

                              {
    char ln_s[16];
 
    UiSurface *sfc = view->sfc;
    if (view->wrap && view->cur.sl_cnt > 0) {
        if (view->cur.sl_idx < view->cur.sl_cnt) {
            display_split_line(view);
            return;
        }
    }
    if (view->cury > view->scroll_lines - 1)
        view->cury = view->scroll_lines - 1;
    if (view->f_ln) {
        ssnprintf(ln_s, 8, "%7jd", view->ln_no);
        ui_cursor_move(sfc, LNNO, view->cury, 0);
        ui_wclrtoeol(sfc, LNNO);
        ui_mvwaddstr(sfc, LNNO, view->cury, 0, ln_s);
    }
    ui_render();
    ui_cursor_move(sfc, PAD, view->cury, 0);
    ui_wclrtoeol(sfc, PAD);
#ifdef UAL_UI
    ui_mvwadd_wchstr(sfc, PAD, view->cury, 0, view->cmplx_buf);
#else
    ui_mvwadd_wchstr(sfc, PAD, view->cury, 0, (struct nccell *)view->cmplx_buf);
#endif
    if (view->cury == 0)
        view->page_top_ln_no = view->ln_no;
    if (view->cury == view->scroll_lines - 1)
        view->page_bot_ln_no = view->ln_no;
    view->cury++;
}

References View::cmplx_buf, View::cur, View::cury, display_split_line(), View::f_ln, View::ln_no, View::page_bot_ln_no, View::page_top_ln_no, View::scroll_lines, View::sfc, SplitLine::sl_cnt, SplitLine::sl_idx, ssnprintf(), ui_cursor_move(), ui_mvwadd_wchstr(), ui_mvwaddstr(), ui_render(), ui_wclrtoeol(), and View::wrap.

Referenced by scroll_next(), scroll_prev(), search(), and view_display_page().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ display_line_eod()

void display_line_eod ( View * view )

Display End of Data.

Parameters

view	data structure

This function is called when the end of the file is reached and there are no more lines to display. It clears the remaining lines in the pad and line number window (if line numbering is enabled) to ensure that no residual content from previous lines is displayed.

Definition at line 1503 of file view_engine.c.

                                  {
    UiSurface *sfc = view->sfc;
    if (view->f_ln) {
        ui_cursor_move(sfc, LNNO, view->cury, 0);
        ui_wclrtobot(sfc, LNNO);
    }
    ui_cursor_move(sfc, PAD, view->cury, 0);
    ui_wclrtobot(sfc, PAD);
    view->page_bot_ln_no = view->ln_no;
    view->ln_no_max = view->ln_no;
}

References View::cury, View::f_ln, View::ln_no, View::ln_no_max, View::page_bot_ln_no, View::sfc, ui_cursor_move(), and ui_wclrtobot().

Referenced by view_display_page().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ display_prompt()

int display_prompt	(	View *	view,
		char *	s )

Display Command Line Prompt.

Parameters

view	is the current view data structure
s	is the prompt string

Definition at line 2577 of file view_engine.c.

                                        {
    char message_str[PAD_COLS + 1];
    uint l;
    UiSurface *sfc = view->sfc;
    l = strnz__cpy(message_str, s, PAD_COLS);
    ui_cursor_move(sfc, CMDLN, view->cmd_line, 0);
    if (l != 0) {
        ui_wclrtoeol(sfc, CMDLN);
        ui_bkgdset(sfc, CMDLN, &cell_nt_rev);
        ui_mvwaddstr(sfc, CMDLN, view->cmd_line, 0, " ");
        ui_mvwaddstr(sfc, CMDLN, view->cmd_line, 1, message_str);
        ui_waddstr(sfc, CMDLN, " ");
        ui_bkgdset(sfc, CMDLN, &cell_nt);
        ui_getyx(sfc, CMDLN, &view->cmd_line, &view->curx);
        ui_cursor_move(sfc, CMDLN, view->cmd_line, view->curx);
    }
    return (view->curx);
}

References cell_nt, cell_nt_rev, View::cmd_line, View::curx, View::sfc, strnz__cpy(), ui_bkgdset(), ui_cursor_move(), ui_getyx(), ui_mvwaddstr(), ui_waddstr(), and ui_wclrtoeol().

Referenced by get_cmd_char(), lp(), new_view_file(), and view_cmd_processor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ display_split_line()

void display_split_line ( View * view )

Display Split Line on Pad.

Parameters

view	data structure

This function is used to display a line that has been split into multiple segments due to wrapping. It iterates through the segments of the current line (stored in view->cur.sl_cc and view->cur.sl_cells) and displays each segment on the pad, along with the corresponding line number if line numbering is enabled. The function also updates the top and bottom line numbers of the page based on the current position in the split line.

Definition at line 1454 of file view_engine.c.

                                    {
    char ln_s[16];
    UiSurface *sfc = view->sfc;
    if (view->cury > view->scroll_lines - 1)
        view->cury = view->scroll_lines - 1;
 
    for (uint i = view->cur.sl_idx; i < view->cur.sl_cnt; i++) {
        if (i == 0) {
            if (view->f_ln) {
                ssnprintf(ln_s, 8, "%7jd", view->ln_no);
                ui_cursor_move(sfc, LNNO, view->cury, 0);
                ui_wclrtoeol(sfc, LNNO);
                ui_mvwaddstr(sfc, LNNO, view->cury, 0, ln_s);
            }
        } else {
            if (view->f_ln) {
                ui_cursor_move(sfc, LNNO, view->cury, 0);
                ui_wclrtoeol(sfc, LNNO);
            }
        }
        ui_cursor_move(sfc, PAD, view->cury, 0);
        ui_wclrtoeol(sfc, PAD);
        ui_wadd_wchnstr(sfc, PAD, view->cur.sl_cc[i], view->cur.sl_cells[i]);
        if (view->cury == 0) {
            view->page_top_ln_no = view->ln_no;
            view->page_top_sl = true;
            view->page_top_sl_idx = i;
            view->page_top_sl_cnt = view->cur.sl_cnt;
        }
        if (view->cury == view->scroll_lines - 1) {
            view->page_bot_ln_no = view->ln_no;
            view->page_bot_sl = true;
            view->page_bot_sl_idx = i;
            view->page_bot_sl_cnt = view->cur.sl_cnt;
            view->page_bot_ln_no = view->ln_no;
        }
        view->cury++;
        if (view->cury == view->scroll_lines)
            break;
    }
}

References View::cur, View::cury, View::f_ln, View::ln_no, View::page_bot_ln_no, View::page_bot_sl, View::page_bot_sl_cnt, View::page_bot_sl_idx, View::page_top_ln_no, View::page_top_sl, View::page_top_sl_cnt, View::page_top_sl_idx, View::scroll_lines, View::sfc, SplitLine::sl_cc, SplitLine::sl_cells, SplitLine::sl_cnt, SplitLine::sl_idx, ssnprintf(), ui_cursor_move(), ui_mvwaddstr(), ui_wadd_wchnstr(), and ui_wclrtoeol().

Referenced by display_line().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fmt_line()

int fmt_line ( View * view )

Format Line for Display.

Parameters

view	pointer to View structure containing line input and output buffers

Returns: length of formatted line in characters

This function processes the input line from view->line_in_s, handling ANSI escape sequences for text attributes and colors, as well as multi-byte characters. It converts the input line into a formatted line suitable for display in the terminal, storing the result in view->cmplx_buf and view->stripped_line_out. The function returns the length of the formatted line in characters, which may be used for tracking the maximum column width of the displayed content. __fmt_line

Definition at line 2109 of file view_engine.c.

                         {
    char ansi_tok[MAXLEN];
    uint i = 0, j = 0, x = 0;
    uint len = 0;
    uint tab_spaces = 0;
    uint char_width;
    attr_t attrs = WA_NORMAL;
    ushort cpx = cp_nt;
    UiCell cc = {};
    wchar_t wstr[2] = {L'\0', L'\0'};
    char *in_str = view->line_in_s;
    uint sl_cols = 0;
    uint sl_cells = 0;
    uint word_cells = 0;
    UiCell *cmplx_buf = view->cmplx_buf;
    view->cur.sl_idx = 0;
    view->cur.sl_cnt = 0;
    view->cur.sl_cols[0] = 0;
    view->cur.sl_cells[0] = 0;
    view->cur.sl_s[0] = nullptr;
    view->cur.sl_cc[0] = nullptr;
    char *sl_s = view->stripped_line_out;
    UiCell *sl_cc = view->cmplx_buf;
    rtrim(view->line_out_s);
    mbstate_t mbstate;
    memset(&mbstate, 0, sizeof(mbstate));
    uint word_cols = 0;
    uint sl_maxlen = PAD_COLS - 1;
    if (view->f_eod) {
        view->ln_no_max = view->ln_no;
        return 0;
    }
    if (view->wrap)
        sl_maxlen = view->cols;
    if (view->f_ln)
        sl_maxlen -= view->ln_win_cols;
    memset(view->stripped_line_out, 0, sizeof(view->stripped_line_out));
    while (in_str[i] != '\0') {        // line
        while (1) {                    // ANSI SGR, Character, and Word
            if (in_str[i] == '\033') { // ANSI SGR
                if (in_str[i + 1] == '[') {
                    len = strcspn(&in_str[i], "mK ") + 1;
                    memcpy(ansi_tok, &in_str[i], len + 1);
                    ansi_tok[len] = '\0';
                    if (ansi_tok[0] == '\0') {
                        if (i + 2 < MAXLEN)
                            i += 2;
                        continue;
                    }
                    if (len == 0 || in_str[i + len - 1] == ' ') {
                        i += 2;
                        continue;
                    } else if (in_str[i + len - 1] == 'K') {
                        i += len;
                        continue;
                    }
                    parse_ansi_str(ansi_tok, &attrs, &cpx);
                    i += len;
                } else {
                    i++;
                    continue;
                }
            } else { // Character and Word
                if (in_str[i] == ' ' || in_str[i] == '-') {
                    if (view->wrap && (sl_cols + word_cols) > (sl_maxlen - 1))
                        break;
                    (in_str[i] == '-') ? (wstr[0] = L'-') : (wstr[0] = L' ');
                    wstr[1] = L'\0';
                    ui_set_cell(view->sfc, PAD, &cc, wstr, attrs, cpx, nullptr);
                    view->stripped_line_out[x++] = in_str[i];
                    cmplx_buf[j++] = cc;
                    if (view->wrap) {
                        sl_cols += word_cols + 1;
                        word_cols = 0;
                        sl_cells += word_cells + 1;
                        word_cells = 0;
                    }
                    i++;
                    continue;
                }
                if (in_str[i] == '\0') {
                    if (view->wrap) {
                        if (sl_cols + word_cols + 1 > sl_maxlen - 1)
                            break;
                        sl_cols += word_cols;
                        word_cols = 0;
                        sl_cells += word_cells;
                        word_cells = 0;
                    }
                    break;
                }
                if (in_str[i] == '\t') {
                    tab_spaces = view->tab_stop - ((sl_cols + word_cols) % view->tab_stop);
                    if (view->wrap && sl_cols + word_cols + tab_spaces > sl_maxlen - 1)
                        break;
                    wstr[0] = L' ';
                    wstr[1] = L'\0';
                    ui_set_cell(view->sfc, PAD, &cc, wstr, attrs, cpx, nullptr);
                    for (uint z = 0; z < tab_spaces; z++) {
                        view->stripped_line_out[x++] = ' ';
                        cmplx_buf[j++] = cc;
                    }
                    if (view->wrap) {
                        sl_cols += word_cols + tab_spaces;
                        word_cols = 0;
                        sl_cells += word_cells + tab_spaces;
                        word_cells = 0;
                    }
                    i++;
                    continue;
                }
                wstr[1] = L'\0';
                len = mbrtowc(wstr, &in_str[i], MB_CUR_MAX, &mbstate);
                if (len <= 0) {
                    wstr[0] = L'?';
                    wstr[1] = L'\0';
                    len = 1;
                }
                char_width = wcwidth(wstr[0]);
                if (x > PAD_COLS - 1)
                    return -1;
                view->stripped_line_out[x++] = in_str[i];
                if (char_width > 1)
                    for (uint n = 1; n < char_width; n++)
                        view->stripped_line_out[x++] = ' ';
                ui_set_cell(view->sfc, PAD, &cc, wstr, attrs, cpx, nullptr);
                if (j > PAD_COLS - 1)
                    return -1;
                cmplx_buf[j++] = cc;
                i += len;
                if (view->wrap) {
                    word_cols += char_width;
                    word_cells++;
                }
                continue;
            } // END Character and Word
        } // END WHILE - ANSI SGR, Character, and Word
        if (view->wrap) {        // handle line wrapping
            if (word_cols > 0) { // break line, add last word to next line
                if (sl_cols <= sl_maxlen) {
                    view->cur.sl_s[view->cur.sl_idx] = sl_s;
                    view->cur.sl_cc[view->cur.sl_idx] = sl_cc;
                    view->cur.sl_cols[view->cur.sl_idx] = sl_cols;
                    view->cur.sl_cells[view->cur.sl_idx] = sl_cells;
                    view->cur.sl_idx++;
                    sl_s = &sl_s[sl_cols];
                    sl_cc = &sl_cc[sl_cells];
                    sl_cols > view->maxcol ? view->maxcol = sl_cols : 0;
                    sl_cols = word_cols;
                    sl_cells = word_cells;
                    word_cols = 0;
                    word_cells = 0;
                }
            }
            while (sl_cols > sl_maxlen - 1) { // split long lines
                uint safe_cells = 0;
                uint safe_cols = 0;
                while (safe_cols < sl_maxlen && safe_cells < sl_cells) {
                    wchar_t wstr_chk[CCHARW_MAX];
                    attr_t attr_chk;
                    short cpx_chk;
                    ui_get_cell(view->sfc, PAD, &sl_cc[safe_cells], wstr_chk, &attr_chk, &cpx_chk, nullptr);
                    uint cw = wcwidth(wstr_chk[0]);
                    if (safe_cols + cw > sl_maxlen)
                        break;
                    safe_cols += cw;
                    safe_cells++;
                }
                if (safe_cells == 0) {
                    safe_cells = 1;
                    safe_cols = sl_maxlen;
                }
                view->cur.sl_s[view->cur.sl_idx] = sl_s;
                view->cur.sl_cc[view->cur.sl_idx] = sl_cc;
                view->cur.sl_cols[view->cur.sl_idx] = safe_cols;
                view->cur.sl_cells[view->cur.sl_idx] = safe_cells;
                view->cur.sl_idx++;
                sl_s = &sl_s[safe_cells];
                sl_cc = &sl_cc[safe_cells];
                sl_cols > view->maxcol ? view->maxcol = sl_cols : 0;
                sl_cols -= safe_cols;
                sl_cells -= safe_cells;
                word_cols = 0;
                word_cells = 0;
            } // END WHILE - split long lines
        } // END IF - handle line wrapping
        j > view->maxcol ? view->maxcol = j : 0;
    } // END WHILE - line
    if (view->wrap) { // finish and commit wrap state
        if (view->cur.sl_idx > 0) {
            view->cur.sl_s[view->cur.sl_idx] = sl_s;
            view->cur.sl_cc[view->cur.sl_idx] = sl_cc;
            view->cur.sl_cols[view->cur.sl_idx] = sl_cols;
            view->cur.sl_cells[view->cur.sl_idx] = sl_cells;
            view->cur.sl_idx++;
            view->cur.sl_cc[view->cur.sl_idx] = nullptr;
            view->cur.sl_s[view->cur.sl_idx] = nullptr;
            view->cur.sl_cnt = view->cur.sl_idx;
            view->cur.sl_idx = 0;
        }
        view->cur.sl_ln_no = view->ln_no;
    }
#ifdef DEBUG_WRAP
    // log_split_lines(view);
    log_cc_buf(view);
    // log_stripped_line_out(view);
#endif
    //-------------------------------------------------------------------------
    wstr[0] = '\0';
    wstr[1] = '\0';
    ui_set_cell(view->sfc, PAD, &cc, wstr, WA_NORMAL, cpx, nullptr);
    cmplx_buf[j] = cc;
    view->stripped_line_out[x] = '\0';
    return j;
}

References View::cmplx_buf, View::cols, cp_nt, View::cur, View::f_eod, View::f_ln, View::line_in_s, View::line_out_s, View::ln_no, View::ln_no_max, View::ln_win_cols, View::maxcol, parse_ansi_str(), rtrim(), SplitLine::sl_cc, SplitLine::sl_cells, SplitLine::sl_cnt, SplitLine::sl_cols, SplitLine::sl_idx, SplitLine::sl_ln_no, SplitLine::sl_s, View::stripped_line_out, View::tab_stop, and View::wrap.

Referenced by page_prev(), scroll_next(), scroll_prev(), search(), and view_display_page().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ log_cc_buf()

void log_cc_buf ( View * view )

Log Complex Character Buffer.

Parameters

view	pointer to View structure containing complex character buffer (view->cmplx_buf)

This function logs the contents of the complex character buffer (view->cmplx_buf) for debugging purposes. It iterates through the split lines (if any) and logs each line to the cmenu log, converting wide characters to their corresponding single-byte representation for easier viewing.

Definition at line 2352 of file view_engine.c.

                            {
    char tmp_str[PAD_COLS];
 
    for (uint k = 0; k < view->cur.sl_cnt; k++) {
        memset(tmp_str, 0, sizeof(tmp_str));
        for (uint c = 0; c < view->cur.sl_cells[k]; c++) {
            wchar_t wstr[CCHARW_MAX];
            attr_t attrs;
            short cpx;
            ui_get_cell(view->sfc, PAD, &view->cur.sl_cc[k][c], wstr, &attrs, &cpx, nullptr);
            if (wstr[0] == L'\0')
                tmp_str[c] = ' ';
            else
                tmp_str[c] = (char)wstr[0];
        }
        ui_log(INFO, "%s:", tmp_str);
    }
}

References View::cur, SplitLine::sl_cc, SplitLine::sl_cells, and SplitLine::sl_cnt.

◆ log_split_lines()

void log_split_lines ( View * view )

Log Split Lines.

Parameters

view	pointer to View structure containing split line information

This function logs the contents of the split lines stored in the view structure for debugging purposes. It iterates through the split lines and logs each line to the cmenu log, converting wide characters to their corresponding single-byte representation for easier viewing.

Definition at line 2391 of file view_engine.c.

                                 {
    char tmp_str[MAXLEN];
 
    for (uint k = 0; k < view->cur.sl_cnt; k++) {
        if (view->cur.sl_cols[k] > 0) {
            memset(tmp_str, 0, sizeof(tmp_str));
            char *s = view->cur.sl_s[k];
            char *d = tmp_str;
            char *e = view->cur.sl_s[k] + view->cur.sl_cols[k];
            while (s < e)
                *d++ = *s++;
            *d = '\0';
            ui_log(INFO, "%s:", tmp_str);
        }
    }
}

References View::cur, SplitLine::sl_cnt, SplitLine::sl_cols, and SplitLine::sl_s.

◆ log_stripped_line_out()

void log_stripped_line_out ( View * view )

Log Stripped Line Output.

Parameters

view	pointer to View structure containing stripped line output buffer

This function logs the contents of the stripped line output buffer (view->stripped_line_out) for debugging purposes. It iterates through the split lines (if any) and logs each line to the cmenu log.

Definition at line 2332 of file view_engine.c.

                                       {
    char tmp_str[PAD_COLS];
    ui_log(INFO, "%s:", view->stripped_line_out);
    for (uint k = 0; k < view->cur.sl_cnt; k++) {
        memset(tmp_str, 0, sizeof(tmp_str));
        for (uint c = 0; c < view->cur.sl_cols[k]; c++)
            tmp_str[c] = view->cur.sl_s[k][c];
        ui_log(INFO, "%s:", tmp_str);
    }
}

References View::cur, SplitLine::sl_cnt, SplitLine::sl_cols, SplitLine::sl_s, and View::stripped_line_out.

◆ log_strnz()

void log_strnz	(	char *	str,
		uint	len )

Log String with Specified Length.

Parameters

str	pointer to the string to log
len	length of the string to log

This function logs a specified number of characters from a given string to the cmenu log. It copies the specified length of the string into a temporary buffer and then writes it to the log.

Definition at line 2378 of file view_engine.c.

                                    {
    char tmp_str[MAXLEN];
    strnz__cpy(tmp_str, str, len);
    ui_log(INFO, "%s:", tmp_str);
}

References strnz__cpy().

Here is the call graph for this function:

◆ pad_refresh()

int pad_refresh ( View * view )

Refresh Pad and Line Number Window.

Parameters

view	data structure

Returns: OK on success, ERR on failure __pad_refresh

Definition at line 2069 of file view_engine.c.

                            {
#ifdef UAL_UI
    int rc = 0;
    // touchwin(view->sfc->mwin[WIN2]);
    // rc = pnoutrefresh(view->sfc->mwin[WIN2], view->pminrow, view->pmincol,
    // view->sminrow,
    //                  view->smincol, view->smaxrow, view->smaxcol);
    rc = prefresh(view->sfc->mwin[PAD],
                  view->pminrow,
                  view->pmincol,
                  view->sminrow,
                  view->smincol,
                  view->smaxrow,
                  view->smaxcol);
    if (rc == ERR) {
        ssnprintf(em0, MAXLEN - 1, _("%s:%d prefresh(view->sfc->mwin[WIN2], pminrow=%d, pmincol=%d, smaxrow=%d, smaxcol=%d) returned %d\n"),
                  __FILE__, __LINE__ - 1, view->pminrow, view->pmincol, view->smaxrow, view->smaxcol, rc);
        ui_perror(em0);
    }
#else
    (void)view;
#endif
    ui_render();
    return 0;
}

References em0, View::pmincol, View::pminrow, View::sfc, View::smaxcol, View::smaxrow, View::smincol, View::sminrow, ssnprintf(), ui_perror(), and ui_render().

Referenced by get_cmd_arg(), get_cmd_char(), and new_view_file().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parse_ansi_str()

void parse_ansi_str	(	char *	ansi_str,
		attr_t *	attrs,
		ushort *	cpx )

Parse ANSI SGR Escape Sequence.

Parameters

ansi_str	is the ANSI escape sequence string to parse
attrs	is a pointer to an attr_t variable where the parsed attributes will be stored
cpx	is a pointer to an int variable where the parsed color pair index will be stored

This function parses ANSI escape sequences, which it converts to color pairs and attributes used to construct complex character cells or extended grapheme clusters.

Note

ANSI Select Graphics Rendition (SGR), ECMA-48, (ISO/IEC 6429)

Extends Color Pair and Color arrays as necessary

SGR specification types:

 RGB:

     foreground \033[38;2;r;g;bm
     background \033[48;2;r;g;bm

     Where r, g, b are the red, green, and blue color components (0-255)

 XTERM 256-color:

     foreground \033[38;5;xm
     background \033[48;5;xm

     Where x is the 256-color index (0-255)
     uses ui_xterm256_idx_to_rgb() to convert the 256-color index to RGB

 8-color:

     foreground \033[3cm
     background \033[4cm

     Where c is the color code (0 for black, 1 for red, 2 for green, 3
for yellow, 4 for blue, 5 for magenta, 6 for cyan, 7 for white).

 Attributes:

     \033[am

     Where a is the attribute code (1 for bold, 2 for dim, 3 for italic,
4 for underline, 5 for blink, 7 for reverse, 8 for invis). The function
also supports resetting attributes and colors to default using \033[0m.

 see also: ui_xterm256_idx_to_rgb(), ui_color_from_rgb(), extended_pair_content(),
ui_add_pair()

__parse_ansi_str

Definition at line 2461 of file view_engine.c.

                                                                {
    char *tok;
    char t0, t1;
    char tstr[3];
    uint len, x_idx;
    uint fg, bg;
    uint fg_clr, bg_clr;
    char *ansi_p = ansi_str + 2;
    ui_pair_content(*cpx, &fg_clr, &bg_clr);
    fg = fg_clr;
    bg = bg_clr;
    RGB rgb;
    tok = strtok((char *)ansi_p, ";m");
    bool a_toi_error = false;
    while (1) {
        if (tok == nullptr || *tok == '\0')
            break;
        len = strlen(tok);
        if (len == 2) {
            t0 = tok[0];
            t1 = tok[1];
            if (t0 == '3' || t0 == '4') {
                if (t1 == '8') {
                    tok = strtok(nullptr, ";m");
                    if (tok != nullptr) {
                        if (*tok == '5') {
                            tok = strtok(nullptr, ";m");
                            if (tok != nullptr) {
                                x_idx = a_toi(tok, &a_toi_error);
                                rgb = ui_xterm256_idx_to_rgb(x_idx);
                            }
                        } else if (*tok == '2') {
                            tok = strtok(nullptr, ";m");
                            rgb.r = a_toi(tok, &a_toi_error);
                            tok = strtok(nullptr, ";m");
                            rgb.g = a_toi(tok, &a_toi_error);
                            tok = strtok(nullptr, ";m");
                            rgb.b = a_toi(tok, &a_toi_error);
                        }
                    }
                    if (t0 == '3')
                        fg_clr = ui_color_from_rgb(&rgb);
                    else if (t0 == '4')
                        bg_clr = ui_color_from_rgb(&rgb);
                } else if (t1 == '9') {
                    if (t0 == '3')
                        fg_clr = CLR_NT_FG;
                    else if (t0 == '4')
                        bg_clr = CLR_NT_BG;
                } else if (t1 >= '0' && t1 <= '7') {
                    if (t0 == '3') {
                        tstr[0] = t1;
                        tstr[1] = '\0';
                        x_idx = a_toi(tstr, &a_toi_error);
                        rgb = ui_xterm256_idx_to_rgb(x_idx);
                        fg_clr = ui_color_from_rgb(&rgb);
                    } else if (t0 == '4') {
                        tstr[0] = t1;
                        tstr[1] = '\0';
                        x_idx = a_toi(tstr, &a_toi_error);
                        rgb = ui_xterm256_idx_to_rgb(x_idx);
                        bg_clr = ui_color_from_rgb(&rgb);
                    }
                }
            } else if (t0 == '0') {
                *tok = t1;
                len = 1;
            }
        }
        if (len == 1) {
            if (*tok == '0') {
                *attrs = WA_NORMAL;
                fg_clr = CLR_NT_FG;
                bg_clr = CLR_NT_BG;
            } else {
                switch (a_toi(tok, &a_toi_error)) {
                case 1:
                    *attrs |= WA_BOLD;
                    break;
                case 2:
                    *attrs |= WA_DIM;
                    break;
                case 3:
                    *attrs |= WA_ITALIC;
                    break;
                case 4:
                    *attrs |= WA_UNDERLINE;
                    break;
                case 5:
                    *attrs |= WA_BLINK;
                    break;
                case 7:
                    *attrs |= WA_REVERSE;
                    break;
                case 8:
                    *attrs |= WA_INVIS;
                    break;
                default:
                    break;
                }
            }
        } else if (len == 0) {
            *attrs = WA_NORMAL;
            fg_clr = CLR_NT_FG;
            bg_clr = CLR_NT_BG;
        }
        tok = strtok(nullptr, ";m");
    }
    if (!a_toi_error && (fg_clr != fg || bg_clr != bg))
        *cpx = ui_add_pair(fg_clr, bg_clr);
    return;
}

References a_toi(), CLR_NT_BG, CLR_NT_FG, ui_add_pair(), ui_color_from_rgb(), ui_pair_content(), and ui_xterm256_idx_to_rgb().

Referenced by fmt_line().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ view_display_help()

void view_display_help ( Init * init )

Display View Help File.

Parameters

init	is the current initialization data structure.

The current View context is set aside by assigning the view structure to "view_save" while the help file is displayed using a new, separate view structure. The help file is specified by the VIEW_HELP_FILE macro can be set to a default help file path or overridden by the user through an environment variable. After the help file is closed, the original view is restored and the page is redisplayed. It may be necessary to reassign view after calling this function because the init->view pointer is temporarily set to nullptr during the help file display, and the original view is restored afterward. The default screen size for help can be set in the code below. If set to 0, popup_view will determine reasonable maximal size based on the terminal dimensions. The help file may contain Unicode characters and ANSI escape sequences for formatting, which will be properly handled and displayed by popup_view.

Definition at line 2615 of file view_engine.c.

                                   {
    char tmp_str[MAXLEN];
    uint eargc = 0;
    char *eargv[MAXARGS];
    View *view = init->view;
    if (view->f_help_spec || view->help_spec[0] != '\0')
        strnz__cpy(tmp_str, view->help_spec, MAXLEN - 1);
    else {
        strnz__cpy(tmp_str, init->mapp_help, MAXLEN - 1);
        strnz__cat(tmp_str, "/", MAXLEN - 1);
        strnz__cat(tmp_str, VIEW_HELP_FILE, MAXLEN - 1);
    }
    eargv[eargc++] = strdup("view");
    eargv[eargc++] = strdup("-N");
    eargv[eargc++] = strdup(tmp_str);
    eargv[eargc] = nullptr;
    init->lines = 48;
    init->cols = 72;
    init->begy = 0;
    init->begx = 0;
    strnz__cpy(init->title, "View Help", MAXLEN - 1);
    popup_view(init, eargc, eargv, init->lines, init->cols, init->begy,
               init->begx);
    destroy_argv(eargc, eargv);
    init->view->f_redisplay_page = true;
}

References Init::begx, Init::begy, Init::cols, destroy_argv(), View::f_help_spec, View::f_redisplay_page, View::help_spec, Init::lines, Init::mapp_help, popup_view(), strnz__cat(), strnz__cpy(), Init::title, and Init::view.

Referenced by view_cmd_processor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ view_display_page()

void view_display_page ( View * view )

Display Current Page.

Parameters

view	data structure __display_page

Definition at line 1364 of file view_engine.c.

                                   {
    view->cury = 0;
    view->page_top_sl = false;
    view->page_bot_sl = false;
    UiSurface *sfc = view->sfc;
    ui_cursor_move(sfc, PAD, 0, 0);
    if (view->f_ln)
        ui_cursor_move(sfc, LNNO, 0, 0);
    view->ln_no = view->page_top_ln_no;
    view->page_top_ln_no = 0;
    view->page_bot_ln_no = 0;
    while (view->cury < view->scroll_lines) {
        get_line(view, view->ln_no);
        if (view->f_eod) {
            view->ln_no_max = view->ln_no;
            break;
        }
        fmt_line(view);
        if (view->wrap && view->cury == 0)
            view->cur.sl_idx = view->page_top_sl_idx;
        display_line(view);
        ui_render();
        view->ln_no++;
    }
    if (view->f_eod) {
        view->ln_no_max = view->ln_no;
        display_line_eod(view);
    }
    view->ln_no--;
    view->page_bot_end_pos = view->file_pos - 1;
    view->page_bot_pos = view->file_pos;
    view->page_bot_ln_no = view->ln_no;
}

References View::cur, View::cury, display_line(), display_line_eod(), View::f_eod, View::f_ln, View::file_pos, fmt_line(), get_line(), View::ln_no, View::ln_no_max, View::page_bot_end_pos, View::page_bot_ln_no, View::page_bot_pos, View::page_bot_sl, View::page_top_ln_no, View::page_top_sl, View::page_top_sl_idx, View::scroll_lines, View::sfc, SplitLine::sl_idx, ui_cursor_move(), ui_render(), and View::wrap.

Referenced by page_next(), and view_cmd_processor().

Here is the call graph for this function:

Here is the caller graph for this function:

Functions

Detailed Description

Function Documentation

◆ display_line()

◆ display_line_eod()

◆ display_prompt()

◆ display_split_line()

◆ fmt_line()

◆ log_cc_buf()

◆ log_split_lines()

◆ log_stripped_line_out()

◆ log_strnz()

◆ pad_refresh()

◆ parse_ansi_str()

◆ view_display_help()

◆ view_display_page()