Error Handling

Display Error messages. More...

Functions
void	abend (int ec, char *s)
	Abnormal program termination.
bool	action_disposition (char *title, char *action_str)
	Display a simple action disposition message window or print to stderr.
int	answer_yn (char *msg0, char *msg1, char *msg2, char *msg3)
	Accept a single letter answer.
int	display_error (char *msg0, char *msg1, char *msg2, char *msg3)
	Display an error message window or print to stderr.
WINDOW *	message_win (char *msg)
	Display a message in a window or print to stderr if curses is not available.
int	nf_error (int ec, char *s)
	Display error message and wait for key press.
int	Perror (char *emsg_str)
	Display a simple error message window or print to stderr.
int	wait_continue (WINDOW *wait_win, Chyron *chyron, int remaining)
	Update the waiting message with remaining time and check for user input.
bool	wait_destroy (Chyron *chyron)
	Destroy the waiting message window and chyron.
Chyron *	wait_mk_chyron ()
	Create a Chyron struct for the waiting message.
WINDOW *	wait_mk_win (Chyron *chyron, char *title)
	Display a popup waiting message.
bool	waitpid_with_timeout (pid_t pid, int timeout)
	Wait for a process to finish with a timeout and optional user cancellation.

Detailed Description

Display Error messages.

Function Documentation

abend()

void abend	(	int	ec,
		char *	s )

Abnormal program termination.

abend

Parameters

ec	Exit code
s	Error message

Definition at line 2018 of file dwin.c.

                            {
    destroy_curses();
    restore_shell_tioctl();
    sig_dfl_mode();
    fprintf(stderr, "\n\nABEND: %s (code: %d)\n", s, ec);
    exit(EXIT_FAILURE);
}

References destroy_curses(), restore_shell_tioctl(), and sig_dfl_mode().

Referenced by answer_yn(), display_error(), form_parse_desc(), init_menu_files(), init_pick(), mapp_initialization(), new_chyron(), new_form(), new_init(), new_menu(), new_pick(), new_view(), open_curses(), parse_menu_description(), Perror(), sig_prog_mode(), signal_handler(), view_init_input(), and wait_mk_win().

Here is the call graph for this function:

Here is the caller graph for this function:

action_disposition()

bool action_disposition	(	char *	title,
		char *	action_str )

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

action_disposition

Parameters

title	Window title
action_str	Action description string

Returns

true if successful

Definition at line 1651 of file dwin.c.

                                                       {
    int len;
    int line, col;
    WINDOW *action_disposition_win;
 
    if (!f_curses_open) {
        fprintf(stderr, "\n%s\n", title);
        fprintf(stderr, "%s\n", action_str);
        return true;
    }
    Chyron *chyron = new_chyron();
    set_chyron_key(chyron, 10, "F10 Continue", KEY_F(10));
    compile_chyron(chyron);
    len = max(strlen(title), strlen(action_str));
    col = (COLS - len - 4) / 2;
    line = (LINES - 4) / 2;
    if (box_new(2, len + 2, line, col, title)) {
        ssnprintf(em0, MAXLEN - 1, "box_new(%d, %d, %d, %d, %s) failed", 4,
                  line, line, col, title);
        Perror(em0);
    }
    action_disposition_win = win_win[win_ptr];
    mvwaddstr(action_disposition_win, 0, 1, action_str);
    display_chyron(action_disposition_win, chyron, 1, 0);
    wmove(action_disposition_win, 1, chyron->l);
    cmd_key = xwgetch(action_disposition_win, chyron, 1);
    win_del();
    destroy_chyron(chyron);
    return true;
}

References box_new(), cmd_key, compile_chyron(), destroy_chyron(), display_chyron(), em0, f_curses_open, Chyron::l, new_chyron(), Perror(), set_chyron_key(), ssnprintf(), win_del(), win_ptr, win_win, and xwgetch().

Here is the call graph for this function:

answer_yn()

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

Accept a single letter answer.

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 1406 of file dwin.c.

                                                              {
    char title[MAXLEN];
    int line, pos, msg_l, msg0_l, msg1_l, msg2_l, msg3_l;
    WINDOW *error_win;
 
    if (!f_curses_open) {
        fprintf(stderr, "\n\n%s\n%s\n%s\n%s\n\n", msg0, msg1, msg2, msg3);
        return 1;
    }
 
    Chyron *chyron = new_chyron();
    set_chyron_key(chyron, 1, "F1 Help", KEY_F(1));
    set_chyron_key(chyron, 2, "N - No", 'n');
    set_chyron_key(chyron, 3, "Y - Yes", 'y');
    compile_chyron(chyron);
 
    msg0_l = strnz(msg0, COLS - 4);
    msg1_l = strnz(msg1, COLS - 4);
    msg2_l = strnz(msg2, COLS - 4);
    msg3_l = strnz(msg1, COLS - 4);
    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, chyron->l);
    msg_l = min(msg_l, COLS - 4);
 
    pos = ((COLS - msg_l) - 4) / 2;
    line = (LINES - 6) / 2;
    strnz__cpy(title, "Notification", MAXLEN - 1);
    if (box_new(5, msg_l + 2, line, pos, title)) {
        ssnprintf(title, MAXLEN - 1, "box_new(%d, %d, %d, %d, %s) failed", 5,
                  msg_l + 2, line, pos, title);
        destroy_chyron(chyron);
        abend(-1, title);
    }
    error_win = win_win[win_ptr];
    mvwaddstr(error_win, 0, 1, msg0);
    mvwaddstr(error_win, 1, 1, msg1);
    mvwaddstr(error_win, 2, 1, msg2);
    mvwaddstr(error_win, 3, 1, msg3);
    display_chyron(error_win, chyron, 4, chyron->l + 1);
 
    do {
        curs_set(1);
        cmd_key = xwgetch(error_win, chyron, -1);
        curs_set(0);
        if (cmd_key == KEY_F(1) || cmd_key == 'N' || cmd_key == 'n' || cmd_key == 'Y' || cmd_key == 'y')
            break;
    } while (1);
    win_del();
    destroy_chyron(chyron);
    return (cmd_key);
}

References abend(), box_new(), cmd_key, compile_chyron(), destroy_chyron(), display_chyron(), f_curses_open, Chyron::l, new_chyron(), set_chyron_key(), ssnprintf(), strnz(), strnz__cpy(), win_del(), win_ptr, win_win, and xwgetch().

Referenced by write_view_buffer().

Here is the call graph for this function:

Here is the caller graph for this function:

display_error()

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

Display an error message window or print to stderr.

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 1467 of file dwin.c.

                                                                  {
    char title[MAXLEN];
    int line, pos, msg_l, msg0_l, msg1_l, msg2_l, msg3_l;
    WINDOW *error_win;
 
    if (!f_curses_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;
    }
 
    Chyron *chyron = new_chyron();
    set_chyron_key(chyron, 1, "F1 Help", KEY_F(1));
    set_chyron_key(chyron, 9, "F9 Cancel", KEY_F(9));
    set_chyron_key(chyron, 10, "F10 Continue", KEY_F(10));
    compile_chyron(chyron);
 
    msg0_l = strnz(msg0, COLS - 4);
    msg1_l = strnz(msg1, COLS - 4);
    msg2_l = strnz(msg2, COLS - 4);
    msg3_l = strnz(msg1, COLS - 4);
    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, chyron->l);
    msg_l = min(msg_l, COLS - 4);
 
    pos = ((COLS - msg_l) - 4) / 2;
    line = (LINES - 6) / 2;
    strnz__cpy(title, "Notification", MAXLEN - 1);
    if (box_new(5, msg_l + 2, line, pos, title)) {
        ssnprintf(title, MAXLEN - 1, "box_new(%d, %d, %d, %d, %s) failed", 5,
                  msg_l + 2, line, pos, title);
        destroy_chyron(chyron);
        abend(-1, title);
    }
    error_win = win_win[win_ptr];
    mvwaddstr(error_win, 0, 1, msg0);
    mvwaddstr(error_win, 1, 1, msg1);
    mvwaddstr(error_win, 2, 1, msg2);
    mvwaddstr(error_win, 3, 1, msg3);
    display_chyron(error_win, chyron, 4, chyron->l + 1);
    do {
        cmd_key = xwgetch(error_win, chyron, -1);
        if (cmd_key == KEY_F(9) || cmd_key == KEY_F(10) || cmd_key == 'q' || cmd_key == 'Q')
            break;
    } while (1);
    win_del();
    destroy_chyron(chyron);
    return (cmd_key);
}

References abend(), box_new(), cmd_key, compile_chyron(), destroy_chyron(), display_chyron(), f_curses_open, Chyron::l, new_chyron(), set_chyron_key(), ssnprintf(), strnz(), strnz__cpy(), win_del(), win_ptr, win_win, and xwgetch().

Referenced by dxwgetch(), enter_file_spec(), form_desc_error(), form_parse_desc(), form_process(), form_read_data(), form_write(), get_clr_pair(), mk_dir(), new_init(), new_pick(), new_view(), parse_menu_description(), popup_ckeys(), verify_dir(), verify_file(), view_cmd_processor(), view_init_input(), write_view_buffer(), and xwgetch().

Here is the call graph for this function:

Here is the caller graph for this function:

message_win()

WINDOW * message_win

(

char *

msg

)

Display a message in a window or print to stderr if curses is not available.

Parameters

msg	Message to display

Returns

Pointer to the created window, or nullptr if curses is not available or screen is too small

Definition at line 1377 of file dwin.c.

                       {
    if (!f_curses_open) {
        fprintf(stderr, "\n\n%s\n\n", msg);
        return nullptr;
    }
    if (LINES < 4 || COLS < 42)
        return nullptr;
    int wlines = 3, wcols = 40;
    int wbegy = 0;
    int wbegx = COLS - wcols - 2;
    WINDOW *win = subwin(stdscr, wlines, wcols, wbegy, wbegx);
    if (win == nullptr)
        return win;
    wbkgrndset(win, &CC_BOX);
    wborder_set(win, &ls, &rs, &ts, &bs, &tl, &tr, &bl, &br);
    strnz(msg, 40);
    mvwaddstr(win, 0, 1, msg);
    update_panels();
    doupdate();
    return win;
}

References bl, br, bs, CC_BOX, f_curses_open, ls, rs, strnz(), tl, tr, and ts.

Here is the call graph for this function:

nf_error()

int nf_error	(	int	ec,
		char *	s )

Display error message and wait for key press.

nf_error

Parameters

ec	Error code
s	Error message

Definition at line 2006 of file dwin.c.

                              {
    fprintf(stderr, "ERROR: %s code: %d\n", s, ec);
    fprintf(stderr, "Press a key to continue");
    di_getch();
    fprintf(stderr, "\n");
    return ec;
}

References di_getch().

Here is the call graph for this function:

Perror()

int Perror

(

char *

emsg_str

)

Display a simple error message window or print to stderr.

Perror

Parameters

emsg_str

Error message string

Returns

Key code of user command

Definition at line 1526 of file dwin.c.

                           {
    char emsg[MAXLEN];
    unsigned in_key;
    WINDOW *error_win;
    int len, line, pos;
    char title[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_curses_open) {
        fprintf(stderr, "\n%s\n", emsg);
        return 1;
    }
    Chyron *chyron = new_chyron();
    set_chyron_key(chyron, 1, "F1 Help", KEY_F(1));
    set_chyron_key(chyron, 9, "F9 Cancel", KEY_F(9));
    set_chyron_key(chyron, 10, "F10 Continue", KEY_F(10));
    compile_chyron(chyron);
    len = strnz(emsg, COLS - 4);
    pos = (COLS - len - 4) / 2;
    line = (LINES - 4) / 2;
    strnz__cpy(title, "Notification", MAXLEN - 1);
    if (box_new(2, len + 2, line, pos, title)) {
        ssnprintf(title, MAXLEN - 1, "box_new(%d, %d, %d, %d, %s, %b) failed",
                  4, line, line, pos, title);
        destroy_chyron(chyron);
        abend(-1, title);
    }
    error_win = win_win[win_ptr];
    mvwaddstr(error_win, 0, 1, emsg);
    display_chyron(error_win, chyron, 1, chyron->l + 1);
    if (f_xwgetch) {
        curs_set(1);
        in_key = xwgetch(error_win, chyron, -1);
        curs_set(0);
    } else {
        in_key = KEY_F(10);
    }
    destroy_chyron(chyron);
    win_del();
    return (in_key);
}

References abend(), box_new(), compile_chyron(), destroy_chyron(), display_chyron(), f_curses_open, Chyron::l, new_chyron(), set_chyron_key(), ssnprintf(), strnz(), strnz__cpy(), win_del(), win_ptr, win_win, and xwgetch().

Referenced by action_disposition(), bare_box_new(), box_hsplit_new(), display_form(), exec_objects(), field_editor(), fork_exec(), form_engine(), form_exec_receiver(), form_fmt_field(), form_process(), form_validate_field(), go_to_mark(), go_to_percent(), increment_ln(), init_form(), init_pick(), init_view_boxwin(), init_view_full_screen(), initialize_line_table(), menu_engine(), new_init(), new_pick(), open_pick_win(), pad_refresh(), parse_menu_description(), pick_engine(), popup_ckeys(), search(), ui_init(), view_cmd_processor(), view_init_input(), win2_new(), win_del(), win_new(), and write_config().

Here is the call graph for this function:

Here is the caller graph for this function:

wait_continue()

int wait_continue	(	WINDOW *	wait_win,
		Chyron *	chyron,
		int	remaining )

Update the waiting message with remaining time and check for user input.

wait_continue

Parameters

chyron	Pointer to Chyron struct for displaying key options
wait_win	Pointer to the waiting message window
remaining	Time remaining for the wait in seconds

Returns

true if the wait should continue, false if it should be cancelled

Definition at line 1636 of file dwin.c.

                                                                   {
    char time_str[10];
    ssnprintf(time_str, 9, "%-4d", remaining);
    mvwaddstr(wait_win, 0, 21, time_str);
    display_chyron(wait_win, chyron, 1, 0);
    wmove(wait_win, 1, chyron->l);
    cmd_key = xwgetch(wait_win, chyron, 1);
    return cmd_key;
}

References cmd_key, display_chyron(), Chyron::l, ssnprintf(), and xwgetch().

Referenced by waitpid_with_timeout().

Here is the call graph for this function:

Here is the caller graph for this function:

wait_destroy()

bool wait_destroy

(

Chyron *

chyron

)

Destroy the waiting message window and chyron.

wait_destroy

Parameters

chyron

Pointer to Chyron struct for displaying key options

Returns

true if successful

Definition at line 1621 of file dwin.c.

                                  {
    win_del();
    destroy_chyron(chyron);
    update_panels();
    doupdate();
    return true;
}

References destroy_chyron(), and win_del().

Here is the call graph for this function:

wait_mk_chyron()

Chyron * wait_mk_chyron

(

)

Create a Chyron struct for the waiting message.

wait_mk_chyron

Returns

Pointer to the chyron struct

Definition at line 1576 of file dwin.c.

                 {
    Chyron *chyron = new_chyron();
    set_chyron_key(chyron, 9, "F9 Cancel", KEY_F(9));
    compile_chyron(chyron);
    return chyron;
}

References compile_chyron(), new_chyron(), and set_chyron_key().

Referenced by waitpid_with_timeout().

Here is the call graph for this function:

Here is the caller graph for this function:

wait_mk_win()

WINDOW * wait_mk_win	(	Chyron *	chyron,
		char *	title )

Display a popup waiting message.

wait_mk_win

Parameters

chyron	Pointer to Chyron struct for displaying key options
title	window title

Returns

WINDOW * struct

Definition at line 1589 of file dwin.c.

                                         {
    char wm1[] = "Seconds remaining:";
    int len;
    int line, col;
    WINDOW *wait_win;
 
    if (!f_curses_open) {
        fprintf(stderr, "\n%s\n", title);
        fprintf(stderr, "%s\n", wm1);
        return NULL;
    }
    len = max(strlen(title), strlen(wm1));
    len = max(len, chyron->l);
    len = max(len, 40);
    col = (COLS - len - 4) / 2;
    line = (LINES - 4) / 2;
    if (box_new(2, len + 2, line, col, title)) {
        ssnprintf(title, MAXLEN - 1, "box_new(%d, %d, %d, %d, %s) failed", 4,
                  line, line, col, title);
        abend(-1, title);
    }
    wait_win = win_win[win_ptr];
    mvwaddstr(wait_win, 0, 1, wm1);
    display_chyron(wait_win, chyron, 1, 0);
    wmove(wait_win, 1, chyron->l);
    return wait_win;
}

References abend(), box_new(), display_chyron(), f_curses_open, Chyron::l, ssnprintf(), win_ptr, and win_win.

Referenced by waitpid_with_timeout().

Here is the call graph for this function:

Here is the caller graph for this function:

waitpid_with_timeout()

bool waitpid_with_timeout	(	pid_t	pid,
		int	timeout )

Wait for a process to finish with a timeout and optional user cancellation.

waitpid_with_timeout

Parameters

pid	Process ID to wait for
timeout	Time in seconds to wait before timing out

Returns

true if the process finished, false if it timed out or was cancelled

Definition at line 2033 of file dwin.c.

                                                  {
    int status;
    Chyron *wait_chyron;
    WINDOW *wait_win;
    int remaining = timeout;
    bool rc = false;
 
    waitpid(pid, &status, WNOHANG);
    if (WIFEXITED(status) || WIFSIGNALED(status)) {
        kill(pid, SIGKILL);
        waitpid(pid, &status, 0);
        return true;
    }
    usleep(100000); // Sleep for 200ms */
    wait_chyron = wait_mk_chyron();
    ssnprintf(em0, MAXLEN - 1, "Waiting for process %d to finish...", pid);
    wait_win = wait_mk_win(wait_chyron, em0);
    cmd_key = 0;
    while (remaining > 0 && cmd_key != KEY_F(9)) {
        cmd_key = wait_continue(wait_win, wait_chyron, remaining);
        if (cmd_key == KEY_F(9))
            break;
        if (cmd_key == KEY_F(10)) {
            remaining = timeout;
            continue;
        }
        remaining--;
        waitpid(pid, &status, WNOHANG);
        if (WIFEXITED(status) || WIFSIGNALED(status)) {
            rc = true;
            break;
        }
    }
    kill(pid, SIGKILL);
    waitpid(pid, &status, 0);
    win_del();
    destroy_chyron(wait_chyron);
    update_panels();
    doupdate();
    return rc;
}

References cmd_key, destroy_chyron(), em0, ssnprintf(), wait_continue(), wait_mk_chyron(), wait_mk_win(), and win_del().

Referenced by form_process().

Here is the call graph for this function:

Here is the caller graph for this function: