Error Handling

Display Error messages. More...

Functions
bool	ui_action_disposition (char *title, char *action_str)
	Display a simple action disposition message window or print to stderr.
int	ui_answer_yn (char *msg0, char *msg1, char *msg2, char *msg3)
	Accept a single letter answer.
int	ui_display_error (char *msg0, char *msg1, char *msg2, char *msg3)
	Display an error message window or print to stderr.
int	ui_perror (char *emsg_str)
	Display a simple error message window or print to stderr.
int	ui_poll_reg_read_fd (int timeout_ms)
	Poll for input on registered external files.
void	ui_register_read_fd (int fd, int token_id)
	Register an external file descriptor for polling.
int	ui_timeout_prompt (char *msg0, char *msg1, uint timeout_ms, uint timeout_secs)
	Display a timeout prompt window or print to stderr.
void	ui_unregister_read_fd (int fd)
	Unregister an external file descriptor from polling.
int	ui_update_timeout_prompt (UiSurface *sfc, ss_t w, uint timeout_ms)
	Update the timeout prompt with the remaining time.

Detailed Description

Display Error messages.

Function Documentation

ui_action_disposition()

bool ui_action_disposition	(	char *	title,
		char *	action_str )

Display a simple action disposition message window or print to stderr.

ui_action_disposition

Parameters

title	Window title
action_str	Action description string

Returns

true if successful

Definition at line 1311 of file ui_common.c.

                                                          {
    uint len;
    uint line, col;
 
    if (!f_ncurses_open && !f_notcurses_open) {
        fprintf(stderr, "\n%s\n", title);
        fprintf(stderr, "%s\n", action_str);
        return true;
    }
    len = max(strlen(title), strlen(action_str));
    uint maxy, maxx;
    ui_get_screen_size(&maxy, &maxx);
    col = (maxx - len - 4) / 2;
    line = (maxy - 4) / 2;
    if (ui_tracked_sfc_box(2, len, line, col, title)) {
        ssnprintf(em0, MAXLEN - 1, _("ui_tracked_sfc_box(%d, %d, %d, %d, %s) failed"), 4,
                  line, line, col, title);
        ui_perror(em0);
    }
    UiSurface *sfc = ui_surface[sfc_ptr];
    UiChyron *chyron = ui_new_chyron(sfc, WIN);
    ui_set_chyron_key(chyron, 10, _("F10 Continue"), UIKEY_F10);
    ui_compile_chyron(chyron);
    UiEvent event;
    ui_draw_text(sfc, WIN, 0, 1, action_str);
    ui_display_chyron(sfc, WIN, chyron, 1, 0);
    event.y = event.x = -1;
    cmd_key = ui_get_event(sfc, WIN, chyron, &event, -1);
    ui_cm_surface_destroy(sfc);
    ui_destroy_chyron(chyron);
    return true;
}

References cmd_key, em0, f_ncurses_open, f_notcurses_open, sfc_ptr, ssnprintf(), ui_cm_surface_destroy(), ui_compile_chyron(), ui_destroy_chyron(), ui_display_chyron(), ui_draw_text(), ui_get_event(), ui_get_screen_size(), ui_new_chyron(), ui_perror(), ui_set_chyron_key(), ui_surface, ui_tracked_sfc_box(), UiEvent::x, and UiEvent::y.

Here is the call graph for this function:

ui_answer_yn()

int ui_answer_yn	(	char *	msg0,
		char *	msg1,
		char *	msg2,
		char *	msg3 )

Accept a single letter answer.

ui_answer_yn

Parameters

msg0	First error message line
msg1	Second error message line
msg2	Third error message line
msg3	Fourth error message line

Returns

Key code of user command

Definition at line 972 of file ui_common.c.

                                                                 {
    char title[MAXLEN];
    uint line, pos, msg_l, msg0_l, msg1_l, msg2_l, msg3_l;
 
    if (!f_ncurses_open && f_notcurses_open) {
        fprintf(stderr, _("\n\n%s\n%s\n%s\n%s\n\n"), msg0, msg1, msg2, msg3);
        return 1;
    }
    uint maxy, maxx;
    ui_get_screen_size(&maxy, &maxx);
    msg0_l = strlen(msg0);
    msg1_l = strlen(msg1);
    msg2_l = strlen(msg2);
    msg3_l = strlen(msg3);
    msg_l = max(msg0_l, msg1_l);
    msg_l = max(msg_l, msg2_l);
    msg_l = max(msg_l, msg3_l);
    msg_l = max(msg_l, 50);
    msg_l = min(msg_l, maxx - 4);
    pos = ((maxx - msg_l) - 4) / 2;
    line = (maxy - 6) / 2;
    strnz__cpy(title, _("Notification"), MAXLEN - 1);
    if (ui_tracked_sfc_box(5, msg_l, line, pos, title)) {
        ssnprintf(title, MAXLEN - 1, _("ui_tracked_sfc_box(%d, %d, %d, %d, %s) failed"), 5,
                  msg_l + 2, line, pos, title);
        ui_abend(-1, title);
    }
    UiSurface *sfc = ui_surface[sfc_ptr];
    UiChyron *chyron = ui_new_chyron(sfc, WIN);
    ui_set_chyron_key(chyron, 1, _("F1 Help"), UIKEY_F01);
    ui_set_chyron_key(chyron, 2, _("N - No"), 'n');
    ui_set_chyron_key(chyron, 3, _("Y - Yes"), 'y');
    ui_compile_chyron(chyron);
    UiEvent event;
    ui_draw_text(sfc, WIN, 0, 1, msg0);
    ui_draw_text(sfc, WIN, 1, 1, msg1);
    ui_draw_text(sfc, WIN, 2, 1, msg2);
    ui_draw_text(sfc, WIN, 3, 1, msg3);
    ui_display_chyron(sfc, WIN, chyron, 4, chyron->l + 1);
    do {
        ui_curs_set(1);
        event.y = event.x = -1;
        cmd_key = ui_get_event(sfc, WIN, chyron, &event, -1);
        if (cmd_key == UIKEY_F01 || cmd_key == 'N' || cmd_key == 'n' || cmd_key == 'Y' || cmd_key == 'y')
            break;
    } while (1);
    ui_cm_surface_destroy(sfc);
    ui_destroy_chyron(chyron);
    return (cmd_key);
}

References cmd_key, f_ncurses_open, f_notcurses_open, sfc_ptr, ssnprintf(), strnz__cpy(), ui_abend(), ui_cm_surface_destroy(), ui_compile_chyron(), ui_curs_set(), ui_destroy_chyron(), ui_display_chyron(), ui_draw_text(), ui_get_event(), ui_get_screen_size(), ui_new_chyron(), ui_set_chyron_key(), ui_surface, ui_tracked_sfc_box(), UiEvent::x, and UiEvent::y.

Referenced by write_view_buffer().

Here is the call graph for this function:

Here is the caller graph for this function:

ui_display_error()

int ui_display_error	(	char *	msg0,
		char *	msg1,
		char *	msg2,
		char *	msg3 )

Display an error message window or print to stderr.

ui_display_error

Parameters

msg0	First error message line
msg1	Second error message line
msg2	Third error message line
msg3	Fourth error message line

Returns

Key code of user command

Definition at line 1200 of file ui_common.c.

                                                                     {
    char title[MAXLEN];
    uint line, pos, msg_l, msg0_l, msg1_l, msg2_l, msg3_l;
    if (!f_ncurses_open && !f_notcurses_open) {
        fprintf(stderr, "\n\n%s\n", msg0);
        fprintf(stderr, "%s\n", msg1);
        fprintf(stderr, "%s\n", msg2);
        fprintf(stderr, "%s\n\n", msg3);
        return 1;
    }
    uint maxy, maxx;
    ui_get_screen_size(&maxy, &maxx);
    msg0_l = strlen(msg0);
    msg1_l = strlen(msg1);
    msg2_l = strlen(msg2);
    msg3_l = strlen(msg3);
    msg_l = max(msg0_l, msg1_l);
    msg_l = max(msg_l, msg2_l);
    msg_l = max(msg_l, msg3_l);
    msg_l = max(msg_l, 50);
    msg_l = min(msg_l, maxx - 4);
 
    pos = ((maxx - msg_l) - 4) / 2;
    line = (maxy - 6) / 2;
    strnz__cpy(title, _("Notification"), MAXLEN - 1);
    if (ui_tracked_sfc_box(5, msg_l, line, pos, title)) {
        ssnprintf(title, MAXLEN - 1, _("ui_tracked_sfc_box(%d, %d, %d, %d, %s) failed"), 5,
                  msg_l + 2, line, pos, title);
        ui_abend(-1, title);
    }
    UiSurface *sfc = ui_surface[sfc_ptr];
    UiChyron *chyron = ui_new_chyron(sfc, WIN);
    ui_set_chyron_key(chyron, 1, _("F1 Help"), UIKEY_F01);
    ui_set_chyron_key(chyron, 9, _("F9 Cancel"), UIKEY_F09);
    ui_set_chyron_key(chyron, 10, _("F10 Continue"), UIKEY_F10);
    ui_compile_chyron(chyron);
    UiEvent event;
    ui_draw_text(sfc, WIN, 0, 1, msg0);
    ui_draw_text(sfc, WIN, 1, 1, msg1);
    ui_draw_text(sfc, WIN, 2, 1, msg2);
    ui_draw_text(sfc, WIN, 3, 1, msg3);
    ui_display_chyron(sfc, WIN, chyron, 4, chyron->l + 1);
    do {
        event.y = event.x = -1;
        cmd_key = ui_get_event(sfc, WIN, chyron, &event, -1);
        if (cmd_key == UIKEY_F09 || cmd_key == UIKEY_F10 || cmd_key == 'q' || cmd_key == 'Q')
            break;
    } while (1);
    ui_cm_surface_destroy(sfc);
    ui_destroy_chyron(chyron);
    return (cmd_key);
}

References cmd_key, f_ncurses_open, f_notcurses_open, sfc_ptr, ssnprintf(), strnz__cpy(), ui_abend(), ui_cm_surface_destroy(), ui_compile_chyron(), ui_destroy_chyron(), ui_display_chyron(), ui_draw_text(), ui_get_event(), ui_get_screen_size(), ui_new_chyron(), ui_set_chyron_key(), ui_surface, ui_tracked_sfc_box(), UiEvent::x, and UiEvent::y.

Referenced by enter_file_spec(), form_desc_error(), form_parse_desc(), form_process(), form_read_data(), form_write(), mk_dir(), new_init(), new_pick(), new_view(), parse_menu_description(), ui_add_pair(), ui_get_event(), ui_surface_box(), ui_surface_new(), verify_dir(), verify_file(), view_cmd_processor(), view_init_input(), and write_view_buffer().

Here is the call graph for this function:

Here is the caller graph for this function:

ui_perror()

int ui_perror

(

char *

emsg_str

)

Display a simple error message window or print to stderr.

ui_perror

Parameters

emsg_str

Error message string

Returns

Key code of user command

Definition at line 1257 of file ui_common.c.

                              {
    char emsg[MAXLEN];
    unsigned in_key;
    uint line, pos, cols;
    char title[MAXLEN];
    char tmp_str[MAXLEN];
    bool f_xwgetch = true;
    if (emsg_str[0] == '␛' && emsg_str[1] == 'w') {
        emsg_str += 2;
        f_xwgetch = false;
    }
    strnz__cpy(emsg, emsg_str, 79);
    if (!f_ncurses_open && !f_notcurses_open) {
        fprintf(stderr, "\n%s\n", emsg);
        return 1;
    }
    uint maxy, maxx;
    ui_get_screen_size(&maxy, &maxx);
    cols = strnz(emsg, maxx - 4);
    cols = max(cols, 50);
    pos = (maxx - cols - 4) / 2;
    line = (maxy - 4) / 2;
    strnz__cpy(title, _("Notification"), MAXLEN - 1);
    if (ui_tracked_sfc_box(2, cols, line, pos, title)) {
        ssnprintf(tmp_str, MAXLEN - 1, _("ui_tracked_sfc_box(%d, %d, %d, %d, %s, %b) failed"),
                  4, line, line, pos, title);
        ui_log(ERROR, "%s", tmp_str);
        exit(EXIT_FAILURE);
    }
    UiSurface *sfc = ui_surface[sfc_ptr];
    UiChyron *chyron = ui_new_chyron(sfc, WIN);
    ui_set_chyron_key(chyron, 1, _("F1 Help"), UIKEY_F01);
    ui_set_chyron_key(chyron, 9, _("F9 Cancel"), UIKEY_F09);
    ui_set_chyron_key(chyron, 10, _("F10 Continue"), UIKEY_F10);
    ui_compile_chyron(chyron);
    UiEvent event;
    ui_draw_text(sfc, WIN, 0, 1, emsg_str);
    ui_display_chyron(sfc, WIN, chyron, 1, chyron->l + 1);
    if (f_xwgetch) {
        event.y = event.x = -1;
        in_key = ui_get_event(sfc, WIN, chyron, &event, -1);
    } else {
        in_key = UIKEY_F10;
    }
    ui_destroy_chyron(chyron);
    ui_cm_surface_destroy(sfc);
    return (in_key);
}

References f_ncurses_open, f_notcurses_open, sfc_ptr, ssnprintf(), strnz(), strnz__cpy(), ui_cm_surface_destroy(), ui_compile_chyron(), ui_destroy_chyron(), ui_display_chyron(), ui_draw_text(), ui_get_event(), ui_get_screen_size(), ui_new_chyron(), ui_set_chyron_key(), ui_surface, ui_tracked_sfc_box(), UiEvent::x, and UiEvent::y.

Referenced by display_form(), exec_objects(), field_editor(), fork_exec(), form_engine(), form_exec_receiver(), form_fmt_field(), form_process(), form_validate_field(), go_to_line(), go_to_mark(), go_to_percent(), increment_ln(), init_form(), init_pick(), initialize_line_table(), mapp_initialization(), menu_engine(), new_pick(), open_pick_win(), pad_refresh(), parse_menu_description(), popup_ckeys(), search(), ui_action_disposition(), view_cmd_processor(), view_init_input(), and write_config().

Here is the call graph for this function:

Here is the caller graph for this function:

ui_poll_reg_read_fd()

int ui_poll_reg_read_fd

(

int

timeout_ms

)

Poll for input on registered external files.

ui_poll_reg_read_fd

Parameters

timeout_ms

Timeout in milliseconds

Returns

Token ID of the external file that has input, or 0 if no input

This function polls for input on registered external files. It uses the poll() system call to wait for input on the file descriptors of the registered external files. If input is available, it returns the token ID of the external file that has input. If no input is available within the specified timeout, it returns 0. If an error occurs during polling, it returns -1.

Definition at line 1155 of file ui_common.c.

                                        {
    if (timeout_ms <= 0)
        return 0;
    // ------------------------------------------------------------
    // Poll for input on registered external files
    // ------------------------------------------------------------
    int token_id = 0;
    int reg_idx;
    nfds_t nfds = 0;
    nfds_t ext_start_idx = ui_ctx.ext_nfds;
    struct pollfd fds[1 + MAX_EXT_FDS];
    memset(fds, 0, sizeof(fds));
    for (nfds_t i = 0; i < ui_ctx.ext_nfds; i++) {
        fds[nfds].fd = ui_ctx.ext_fds[i].fd;
        fds[nfds].events = POLLIN; // also POLLERR | POLLHUP | POLLNVAL
        nfds++;
    }
    int poll_rc = poll(fds, nfds, timeout_ms);
    if (poll_rc < 0) {
        if (errno == EINTR)
            return 0;
        return -1;
    }
    if (poll_rc == 0)
        return 0;
    for (nfds_t i = ext_start_idx; i < nfds; i++) {
        if (fds[i].revents & (POLLIN | POLLHUP | POLLERR)) {
            reg_idx = i - ext_start_idx;
            token_id = ui_ctx.ext_fds[reg_idx].token_id;
            return token_id;
        }
    }
    return 0;
}

References ui_context_t::ext_fds, ui_context_t::ext_nfds, ext_fd_reg_t::fd, ext_fd_reg_t::token_id, and ui_ctx.

Referenced by view_init_input().

Here is the caller graph for this function:

ui_register_read_fd()

void ui_register_read_fd	(	int	fd,
		int	token_id )

Register an external file descriptor for polling.

ui_register_read_fd

Parameters

fd	File descriptor to register
token_id	Token ID associated with the file descriptor

This function registers an external file descriptor for polling. It adds the file descriptor and its associated token ID to the list of registered external file descriptors. If the maximum number of registered file descriptors is reached, it does not register the new file descriptor.

Definition at line 1117 of file ui_common.c.

                                               {
    char tmp_str[MAXLEN];
    if (ui_ctx.ext_nfds < MAX_EXT_FDS) {
        ui_ctx.ext_fds[ui_ctx.ext_nfds] = (ext_fd_reg_t){fd, token_id};
        ui_ctx.ext_nfds++;
        ssnprintf(tmp_str, MAXLEN - 1, "ui_ctx.ext_nfds = %ld", ui_ctx.ext_nfds);
    }
}

References ui_context_t::ext_fds, ui_context_t::ext_nfds, ssnprintf(), and ui_ctx.

Referenced by view_init_input().

Here is the call graph for this function:

Here is the caller graph for this function:

ui_timeout_prompt()

int ui_timeout_prompt	(	char *	msg0,
		char *	msg1,
		uint	timeout_ms,
		uint	timeout_secs )

Display a timeout prompt window or print to stderr.

ui_timeout_prompt

Parameters

msg0	First message line
msg1	Second message line
timeout_ms	Timeout in milliseconds
timeout_secs	Timeout in seconds to add if F10 is pressed

Returns

Key code of user command

Definition at line 1033 of file ui_common.c.

                                                                                  {
    char title[MAXLEN];
    uint line, pos, msg_l, msg0_l, msg1_l;
    if (!f_ncurses_open && !f_notcurses_open) {
        fprintf(stderr, "\n\n%s\n", msg0);
        fprintf(stderr, "%s\n", msg1);
        return 1;
    }
    uint maxy, maxx;
    ui_get_screen_size(&maxy, &maxx);
    msg0_l = strlen(msg0);
    msg1_l = strlen(msg1);
    msg_l = max(msg0_l, msg1_l);
    msg_l = max(msg_l, 50);
    msg_l = min(msg_l, maxx - 4);
 
    pos = ((maxx - msg_l) - 4) / 2;
    line = (maxy - 6) / 2;
    strnz__cpy(title, _("Notification"), MAXLEN - 1);
    if (ui_tracked_sfc_box(5, msg_l, line, pos, title)) {
        ssnprintf(title, MAXLEN - 1, _("ui_tracked_sfc_box(%d, %d, %d, %d, %s) failed"), 5,
                  msg_l + 2, line, pos, title);
        ui_abend(-1, title);
    }
    UiSurface *sfc = ui_surface[sfc_ptr];
    UiChyron *chyron = ui_new_chyron(sfc, WIN);
    ui_set_chyron_key(chyron, 1, _("F1 Help"), UIKEY_F01);
    ui_set_chyron_key(chyron, 9, _("F9 Cancel"), UIKEY_F09);
    ui_set_chyron_key(chyron, 10, _("F10 Continue"), UIKEY_F10);
    ui_compile_chyron(chyron);
    UiEvent event;
    ui_draw_text(sfc, WIN, 0, 1, msg0);
    ui_draw_text(sfc, WIN, 1, 1, msg1);
    ssnprintf(em3, MAXLEN - 1, _("Timeout in %d seconds"), timeout_ms / 1000);
    ui_draw_text(sfc, WIN, 3, 1, em3);
    ui_display_chyron(sfc, WIN, chyron, 4, chyron->l + 1);
    do {
        event.y = event.x = -1;
        cmd_key = ui_get_event(sfc, WIN, chyron, &event, 1000);
        if (cmd_key == UIKEY_F09 || cmd_key == 'q' || cmd_key == 'Q' || cmd_key == UIKEY_STREAM_DATA)
            break;
        if (cmd_key == UIKEY_F10)
            timeout_ms += timeout_secs * 1000;
        else
            timeout_ms -= 1000;
        ui_update_timeout_prompt(sfc, WIN, timeout_ms);
    } while (timeout_ms > 0);
    ui_cm_surface_destroy(sfc);
    ui_destroy_chyron(chyron);
    ui_render();
    return cmd_key;
}

References cmd_key, em3, f_ncurses_open, f_notcurses_open, sfc_ptr, ssnprintf(), strnz__cpy(), ui_abend(), ui_cm_surface_destroy(), ui_compile_chyron(), ui_destroy_chyron(), ui_display_chyron(), ui_draw_text(), ui_get_event(), ui_get_screen_size(), ui_new_chyron(), ui_render(), ui_set_chyron_key(), ui_surface, ui_tracked_sfc_box(), ui_update_timeout_prompt(), UiEvent::x, and UiEvent::y.

Referenced by view_init_input().

Here is the call graph for this function:

Here is the caller graph for this function:

ui_unregister_read_fd()

void ui_unregister_read_fd

(

int

fd

)

Unregister an external file descriptor from polling.

ui_unregister_read_fd

Parameters

fd	File descriptor to unregister

This function unregisters an external file descriptor from polling. It removes the file descriptor and its associated token ID from the list of registered external file descriptors. If the file descriptor is not found in the list, it does nothing.

Definition at line 1134 of file ui_common.c.

                                   {
    for (nfds_t i = 0; i < ui_ctx.ext_nfds; i++) {
        if (ui_ctx.ext_fds[i].fd == fd) {
            ui_ctx.ext_fds[i] = ui_ctx.ext_fds[ui_ctx.ext_nfds - 1];
            ui_ctx.ext_nfds--;
            break;
        }
    }
}

References ui_context_t::ext_fds, ui_context_t::ext_nfds, ext_fd_reg_t::fd, and ui_ctx.

Referenced by view_init_input().

Here is the caller graph for this function:

ui_update_timeout_prompt()

int ui_update_timeout_prompt	(	UiSurface *	sfc,
		ss_t	w,
		uint	timeout_ms )

Update the timeout prompt with the remaining time.

ui_update_timeout_prompt

Parameters

sfc	Pointer to the UiSurface structure
w	Window index (WIN or BOX)
timeout_ms	Remaining timeout in milliseconds

Returns

0 on success, 1 if not in a curses environment

This function updates the timeout prompt displayed on the specified surface and window with the remaining time in seconds. If not in a curses environment, it prints the timeout message to stderr.

Definition at line 1096 of file ui_common.c.

                                                                      {
    if (!f_ncurses_open && !f_notcurses_open) {
        fprintf(stderr, _("Timeout in %d seconds\n"), timeout_ms / 1000);
        return 1;
    }
    ssnprintf(em3, MAXLEN - 1, _("%d seconds"), timeout_ms / 1000);
    ui_draw_text(sfc, w, 3, 12, em3);
    ui_wclrtoeol(sfc, w);
    ui_render();
    return 0;
}

References em3, f_ncurses_open, f_notcurses_open, ssnprintf(), ui_draw_text(), ui_render(), and ui_wclrtoeol().

Referenced by ui_timeout_prompt().

Here is the call graph for this function:

Here is the caller graph for this function: