Initializing View I/O

Populate the C-Menu View Struct and Connect Input. More...

Files
file	init_view.c
	Initialize C-Menu View Screen IO and Input.

Functions
int	init_view_full_screen (Init *init)
	Initialize C-Menu View in full screen mode.
void	view_calc_full_screen_dimensions (Init *init)
	Calculate the dimensions for full screen mode.
int	init_view_boxwin (Init *init, char *title)
	Initialize the C-Menu View in box window mode.
void	view_calc_win_dimensions (Init *init, char *title)
	Calculate the dimensions and position of the box window for C-Menu View.
int	view_init_input (View *view, char *file_name)
	Initialize the input for a C-Menu View.

Detailed Description

Populate the C-Menu View Struct and Connect Input.

Function Documentation

init_view_boxwin()

int init_view_boxwin	(	Init *	init,
		char *	title )

Initialize the C-Menu View in box window mode.

Note

sets up the view structure for box window mode, adjusts dimensions based on screen size, and creates a new pad for the view. It also configures various parameters such as scroll lines, command line position, and tab size.

Parameters

init	Pointer to the Init structure containing view settings.
title	Title for the box window.

Returns

0 on success, -1 on failure.

view->cmdln_win: status or command line window

view->ln_win: line number window

pad for main content

Definition at line 172 of file init_view.c.

                                              {
    view = init->view;
 
    if (view->tab_stop <= 0)
        view->tab_stop = TABSIZE;
    set_tabsize(view->tab_stop);
    view->f_full_screen = false;
 
    view_calc_win_dimensions(init, title);
    if (title != nullptr && title[0] != '\0')
        strnz__cpy(view->title, title, MAXLEN - 1);
    else {
        if (view->argv != nullptr && view->argv[0] != nullptr &&
            view->argv[0][0] != '\0')
            strnz__cpy(view->title, view->argv[0], MAXLEN - 1);
    }
#ifdef DEBUG_RESIZE
    ssnprintf(em0, MAXLEN - 1,
              "init_view_boxwin(): view->box: begy=%d, begx=%d, lines=%d, "
              "cols=%d, title=%s",
              view->begy, view->begx, view->lines + 2, view->cols + 2,
              view->title);
    write_cmenu_log_nt(em0);
#endif
    if (box_new(view->lines, view->cols, view->begy, view->begx, view->title,
                false)) {
        ssnprintf(em0, MAXLEN - 1, "%s, line: %d", __FILE__, __LINE__ - 1);
        ssnprintf(em1, MAXLEN - 1, "win_new(%d, %d, %d, %d, %s) failed",
                  view->lines, view->cols, view->begy, view->begx, view->title);
        em2[0] = '\0';
        display_error(em0, em1, em2, nullptr);
        return (-1);
    }
    view->box = win_box[win_ptr];

    view->cmdln_win =
        newwin(1, view->cols, view->begy + view->lines, view->begx + 1);
    keypad(view->cmdln_win, true);
    idlok(view->cmdln_win, false);
    idcok(view->cmdln_win, false);
    wbkgrnd(view->cmdln_win, &CCC_WIN);
    wbkgrndset(view->cmdln_win, &CCC_WIN);
    scrollok(view->cmdln_win, false);
#ifdef DEBUG_IMMEDOK
    immedok(view->cmdln_win, true);
#endif

#ifdef DEBUG_RESIZE
    ssnprintf(em0, MAXLEN - 1,
              "init_view_boxwin(): view->ln_win: begy=%d, begx=%d, lines=%d, "
              "cols=%d, scroll_lines=%d",
              view->begy, view->begx, view->ln_win_lines, view->ln_win_cols,
              view->scroll_lines);
    write_cmenu_log_nt(em0);
#endif
    if (view->f_ln) {
        view->ln_win = newwin(view->ln_win_lines, view->ln_win_cols,
                              view->begy + 1, view->begx + 1);
        keypad(view->ln_win, false);
        idlok(view->ln_win, false);
        idcok(view->ln_win, false);
        wbkgrnd(view->ln_win, &CCC_LN);
        wbkgrndset(view->ln_win, &CCC_LN);
        scrollok(view->ln_win, true);
        wsetscrreg(view->ln_win, 0, view->scroll_lines - 1);
    }
#ifdef DEBUG_IMMEDOK
    immedok(view->ln_win, true);
#endif
    view->pad = newpad(view->lines - 1, PAD_COLS);
    keypad(view->pad, true);
    idlok(view->pad, false);
    idcok(view->pad, false);
    wbkgrnd(view->pad, &CCC_WIN);
    wbkgrndset(view->pad, &CCC_WIN);
    scrollok(view->pad, true);
    wsetscrreg(view->pad, 0, view->scroll_lines - 1);
#ifdef DEBUG_IMMEDOK
    immedok(view->pad, true);
#endif
    return (0);
}

References View::argv, View::begx, View::begy, View::box, box_new(), CCC_LN, CCC_WIN, View::cmdln_win, View::cols, display_error(), em0, em1, em2, View::f_full_screen, View::f_ln, View::lines, View::ln_win, View::ln_win_cols, View::ln_win_lines, View::pad, View::scroll_lines, ssnprintf(), strnz__cpy(), View::tab_stop, View::title, Init::view, view, view_calc_win_dimensions(), win_box, and win_ptr.

Referenced by main(), and popup_view().

Here is the call graph for this function:

Here is the caller graph for this function:

init_view_full_screen()

int init_view_full_screen

(

Init *

init

)

Initialize C-Menu View in full screen mode.

Note

This function sets up the view structure for full screen mode and creates a new pad for the view.

Parameters

init	Pointer to the Init structure containing view settings.

Returns

0 on success, -1 on failure.

The function creates the following windows:
1. view->cmdln_win: Status or Command Line
2. view->ln_win: Line Number Window
3. view->pad: Main Content Pad

view->cmdln_win: status or command line window

view->ln_win: line number window

view->cmdln_win: status or command line window

Definition at line 45 of file init_view.c.

                                      {
    view = init->view;
 
    if (view->tab_stop <= 0)
        view->tab_stop = TABSIZE;
    set_tabsize(view->tab_stop);
    view->f_full_screen = true;
    view_calc_full_screen_dimensions(init);
#ifdef DEBUG_RESIZE
    ssnprintf(em0, MAXLEN - 1,
              "init_view_full_screen(): lines=%d, cols=%d, "
              "ln_win_lines=%d, ln_win_cols=%d, "
              "scroll_lines=%d",
              view->lines, view->cols, view->ln_win_lines, view->ln_win_cols,
              view->scroll_lines);
#endif
    view->cmdln_win =
        newwin(1, view->cols, view->begy + view->lines - 1, view->begx);
    keypad(view->cmdln_win, true);
    idlok(view->cmdln_win, false);
    idcok(view->cmdln_win, false);
    wbkgrnd(view->cmdln_win, &CCC_WIN);
    wbkgrndset(view->cmdln_win, &CCC_WIN);
    scrollok(view->cmdln_win, false);
#ifdef DEBUG_IMMEDOK
    immedok(view->cmdln_win, true);
#endif
    view->ln_win = newwin(view->ln_win_lines - 1, view->ln_win_cols, 0, 0);
    keypad(view->ln_win, false);
    idlok(view->ln_win, false);
    idcok(view->ln_win, false);
    wbkgrnd(view->ln_win, &CCC_LN);
    wbkgrndset(view->ln_win, &CCC_LN);
    scrollok(view->ln_win, true);
    wsetscrreg(view->ln_win, 0, view->scroll_lines - 1);
#ifdef DEBUG_IMMEDOK
    immedok(view->ln_win, true);
#endif
    view->pad = newpad(view->lines - 1, PAD_COLS);
    if (view->pad == nullptr) {
        ssnprintf(em0, MAXLEN - 1, "%s, line: %d", __FILE__, __LINE__ - 2);
        ssnprintf(em1, MAXLEN - 1, "newpad(%d, %d) failed", view->lines,
                  PAD_COLS);
        em2[0] = '\0';
        display_error(em0, em1, em2, nullptr);
        abend(-1, "init_view_full_screen: newpad() failed");
    }
    keypad(view->pad, false);
    idlok(view->pad, false);
    idcok(view->pad, false);
    wbkgrnd(view->pad, &CCC_WIN);
    wbkgrndset(view->pad, &CCC_WIN);
    scrollok(view->pad, true);
    wsetscrreg(view->pad, 0, view->scroll_lines - 1);
#ifdef DEBUG_IMMEDOK
    immedok(view->pad, true);
#endif
    return 0;
}

References abend(), View::begx, View::begy, CCC_LN, CCC_WIN, View::cmdln_win, View::cols, display_error(), em0, em1, em2, View::f_full_screen, View::lines, View::ln_win, View::ln_win_cols, View::ln_win_lines, View::pad, View::scroll_lines, ssnprintf(), View::tab_stop, Init::view, view, and view_calc_full_screen_dimensions().

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

view_calc_full_screen_dimensions()

void view_calc_full_screen_dimensions

(

Init *

init

)

Calculate the dimensions for full screen mode.

This function calculates the dimensions for the full screen mode of the C-Menu View. It retrieves the maximum dimensions of the standard screen and sets the view parameters accordingly. It also resizes the line number window and command line window based on the new dimensions.

Parameters

init	Pointer to the Init structure containing view settings.

Definition at line 140 of file init_view.c.

                                                  {
    view = init->view;
    getmaxyx(stdscr, view->lines, view->cols);
    view->ln_win_lines = view->lines;
    view->ln_win_cols = 8;
    view->scroll_lines = view->lines - 1;
#ifdef DEBUG_RESIZE
    ssnprintf(
        em0, MAXLEN - 1,
        "view->lines=%d, view->cols=%d, view->maxrows=%d, view->maxcols=%d",
        view->lines, view->cols, view->smaxrow, view->smaxcol);
    write_cmenu_log_nt(em0);
#endif
    view->cmd_line = 0;
    view->pminrow = 0;
    view->pmincol = 0;
    view->sminrow = 0;
    view->smincol = 0;
    view->smaxrow = view->lines - 1;
    view->smaxcol = view->cols - 1;
    view->ln = view->page_top_ln + view->scroll_lines;
    view->page_bot_ln = view->ln;
}

References View::cmd_line, View::cols, View::lines, View::ln, View::ln_win_cols, View::ln_win_lines, View::page_bot_ln, View::page_top_ln, View::pmincol, View::pminrow, View::scroll_lines, View::smaxcol, View::smaxrow, View::smincol, View::sminrow, Init::view, and view.

Referenced by init_view_full_screen(), and view_full_screen_resize().

Here is the caller graph for this function:

view_calc_win_dimensions()

void view_calc_win_dimensions	(	Init *	init,
		char *	title )

Calculate the dimensions and position of the box window for C-Menu View.

This function calculates the dimensions and position of the box window for the C-Menu View based on the screen size and any specified parameters in the Init structure. It ensures that the box window fits within the screen dimensions and adjusts its size and position accordingly.

Parameters

init	Pointer to the Init structure containing view settings.
title	Title for the box window, used to ensure minimum width if provided.

Use view->lines and view->cols if set, otherwise calculate based on screen size with some padding. Ensure the view fits within the screen dimensions.

Definition at line 367 of file init_view.c.

                                                       {
    int scr_lines, scr_cols;
    view = init->view;
    getmaxyx(stdscr, scr_lines, scr_cols);
    int len = strlen(title);

 
    if (init->lines != 0 && view->lines == 0)
        view->lines = init->lines;
    if (view->lines == 0)
        view->lines = scr_lines * 3 / 4;
    if (view->lines > scr_lines - 3)
        view->lines = scr_lines - 3;
 
    if (init->cols != 0 && view->cols == 0)
        view->cols = init->cols;
    if (view->cols == 0)
        view->cols = scr_cols * 3 / 4;
    if (view->cols < len + 4)
        view->cols = len + 4;
    if (view->cols > scr_cols - 4)
        view->cols = scr_cols - 4;
 
    if (init->begy != 0 && view->begy == 0)
        view->begy = init->begy;
    if (view->begy == 0)
        view->begy = (scr_lines - view->lines) / 5;
    if (view->begy + view->lines > scr_lines - 2)
        view->begy = scr_lines - view->lines - 2;
 
    if (init->begx != 0 && view->begx == 0)
        view->begx = init->begx;
    if (view->begx == 0)
        view->begx = (scr_cols - view->cols) / 5;
    if (view->begx + view->cols > scr_cols - 2)
        view->begx = scr_cols - view->cols - 2;
 
    view->ln_win_lines = view->lines - 1;
    if (view->f_ln)
        view->ln_win_cols = 8;
    else
        view->ln_win_cols = 0;
 
    view->scroll_lines = view->lines - 1;
    view->cmd_line = 0;
 
    view->pminrow = 0;
    view->pmincol = 0;
    view->sminrow = view->begy + 1;
    view->smincol = view->begx + 1;
    view->smaxrow = view->begy + view->lines;
    view->smaxcol = view->begx + view->cols;
 
    view->ln = view->page_top_ln + view->scroll_lines;
    view->page_bot_ln = view->ln;
}

References Init::begx, View::begx, Init::begy, View::begy, View::cmd_line, Init::cols, View::cols, View::f_ln, Init::lines, View::lines, View::ln, View::ln_win_cols, View::ln_win_lines, View::page_bot_ln, View::page_top_ln, View::pmincol, View::pminrow, View::scroll_lines, View::smaxcol, View::smaxrow, View::smincol, View::sminrow, Init::view, and view.

Referenced by init_view_boxwin(), popup_view(), and view_win_resize().

Here is the caller graph for this function:

view_init_input()

int view_init_input	(	View *	view,
		char *	file_name )

Initialize the input for a C-Menu View.

This function initializes the input for view, which can be a file, standard input, or a provider command to be initiated by view. It handles different input sources and sets up the necessary file descriptors and memory mapping for efficient access.

Parameters

view	Pointer to the View structure to be initialized.
file_name	Name of the input file or "-" for standard input.

Returns

true on success, false on failure.

Note

if a provider command is specified, set up a pipe to read its output. A child process is spawned, and view, the parent process, reads from the pipe.

If input is from a pipe or standard input, clone it to a temporary file. This allows for memory-mapping the input later. It does not support real-time updates to the input, but it allows for efficient access to the data.

Open the input file for reading and get its size.

< 200ms timeout to check for input

If user cancels while waiting for view input, kill provider_cmd child process and close pipe

If error occurs while waiting for view input, kill provider_cmd child process and close pipe

If timeout occurs while waiting for view input, kill provider_cmd child process and close pipe

If unexpected error occurs while waiting for view input, kill provider_cmd child process and close pipe

Definition at line 443 of file init_view.c.

                                                 {
    struct stat sb;
    int idx = 0;
    pid_t pid = -1;
    int pipe_fd[2];
    int s_argc = 0;
    char *s_argv[MAXARGS];
    char tmp_str[MAXLEN];
    view->f_in_pipe = false;
    if (strcmp(file_name, "-") == 0) {
        file_name = "/dev/stdin";
        view->f_in_pipe = true;
    }
    if (view->provider_cmd[0] != '\0') {
        s_argc = str_to_args(s_argv, view->provider_cmd, MAXARGS - 1);
        if (pipe(pipe_fd) == -1) {
            Perror("pipe(pipe_fd) failed in init_view");
            return -1;
        }
        if ((pid = fork()) == -1) {
            Perror("fork() failed in init_view");
            return -1;
        }
        if (pid == 0) { // Child
            close(pipe_fd[P_READ]);
            dup2(pipe_fd[P_WRITE], STDOUT_FILENO);
            close(pipe_fd[P_WRITE]);
            execvp(s_argv[0], s_argv);
            strnz__cpy(tmp_str, "Can't exec view start cmd: ", MAXLEN - 1);
            strnz__cat(tmp_str, s_argv[0], MAXLEN - 1);
            Perror(tmp_str);
            exit(EXIT_FAILURE);
        }
        // Back to parent
        destroy_argv(s_argc, s_argv);
        close(pipe_fd[P_WRITE]);
        dup2(pipe_fd[P_READ], STDIN_FILENO);
        view->in_fd = dup(STDIN_FILENO);
        view->f_in_pipe = true;
    } else {
        if (view->f_in_pipe)
            view->in_fd = dup(STDIN_FILENO);
        else {
            /*----------------------------------------------------------------------*/
            expand_tilde(file_name, MAXLEN - 1);
            view->in_fd = open(file_name, O_RDONLY);
            if (view->in_fd == -1) {
                ssnprintf(em0, MAXLEN - 1, "%s, line: %d", __FILE__,
                          __LINE__ - 3);
                ssnprintf(em1, MAXLEN - 1, "open %s", file_name);
                strerror_r(errno, em2, MAXLEN);
                display_error(em0, em1, em2, nullptr);
                return -1;
            }
            if (fstat(view->in_fd, &sb) == -1) {
                ssnprintf(em0, MAXLEN - 1, "%s, line: %d", __FILE__,
                          __LINE__ - 1);
                ssnprintf(em1, MAXLEN - 1, "fstat %s", file_name);
                strerror_r(errno, em2, MAXLEN);
                display_error(em0, em1, em2, nullptr);
                close(view->in_fd);
                return -1;
            }
            view->file_size = sb.st_size;
            if (view->file_size == 0) {
                close(view->in_fd);
                ssnprintf(em0, MAXLEN - 1, "%s, line: %d", __FILE__,
                          __LINE__ - 1);
                ssnprintf(em1, MAXLEN - 1, "file %s is empty", file_name);
                strerror_r(errno, em2, MAXLEN);
                display_error(em0, em1, em2, nullptr);
                return -1;
            }
            if (!S_ISREG(sb.st_mode))
                view->f_in_pipe = true;
        }
        /*----------------------------------------------------------------------*/
    }
    if (view->f_in_pipe) {
        char tmp_filename[] = "/tmp/view_XXXXXX";
        char buf[VBUFSIZ];
        ssize_t bytes_read = 0;
        ssize_t bytes_written = 0;
        close(view->in_fd);
        view->in_fd = mkstemp(tmp_filename);
        if (view->in_fd == -1) {
            abend(-1, "failed to mkstemp");
            exit(EXIT_FAILURE);
        }
        unlink(tmp_filename);
        /*-----------------------------------------------------------------*/
        bool f_wait = false;
        int ready;
        fd_set read_fds;
        struct timeval timeout;
        Chyron *wait_chyron = nullptr;
        WINDOW *wait_win = nullptr;
        int remaining;
        FD_ZERO(&read_fds);
        FD_SET(STDIN_FILENO, &read_fds);
        timeout.tv_sec = 0;
        timeout.tv_usec = 200000; 
        ready = select(STDIN_FILENO + 1, &read_fds, nullptr, nullptr, &timeout);
        if (ready == 0) {
            f_wait = true;
            remaining = wait_timeout;
            wait_chyron = wait_mk_chyron();
            wait_win = wait_mk_win(wait_chyron, "WAITING for VIEW INPUT");
        }
        cmd_key = 0;
        while (ready == 0 && remaining > 0 && cmd_key != KEY_F(9)) {
            cmd_key = wait_continue(wait_win, wait_chyron, remaining);
            if (cmd_key == KEY_F(9))
                break;
            FD_ZERO(&read_fds);
            FD_SET(STDIN_FILENO, &read_fds);
            timeout.tv_sec = 0;
            timeout.tv_usec = 0;
            ready =
                select(STDIN_FILENO + 1, &read_fds, nullptr, nullptr, &timeout);
            remaining--;
        }
        if (f_wait) {
            if (wait_chyron != nullptr)
                wait_destroy(wait_chyron);
        }
        if (cmd_key == KEY_F(9)) {
            if (view->f_in_pipe && pid > 0) {
                kill(pid, SIGKILL);
                waitpid(pid, nullptr, 0);
                close(pipe_fd[P_READ]);
            }
            Perror("No view input available");
            return -1;
        }
        if (ready == -1) {
            Perror("Error waiting for view input");
            if (view->f_in_pipe && pid > 0) {
                kill(pid, SIGKILL);
                waitpid(pid, nullptr, 0);
                close(pipe_fd[P_READ]);
            }
            return -1;
        }
        if (ready == 0) {
            Perror("Timeout waiting for view input");
            if (view->f_in_pipe && pid > 0) {
                kill(pid, SIGKILL);
                waitpid(pid, nullptr, 0);
                close(pipe_fd[P_READ]);
            }
            return -1;
        }
        if (ready == 1 && !FD_ISSET(STDIN_FILENO, &read_fds)) {
            Perror("Unexpected error waiting for view input");
            if (view->f_in_pipe && pid > 0) {
                kill(pid, SIGKILL);
                waitpid(pid, nullptr, 0);
                close(pipe_fd[P_READ]);
            }
            return -1;
        }
        /*-----------------------------------------------------------------*/
        while ((bytes_read = read(STDIN_FILENO, buf, sizeof(buf))) > 0) {
            if (write(view->in_fd, buf, bytes_read) != bytes_read) {
                abend(-1, "unable to write tmp");
                exit(EXIT_FAILURE);
            }
            bytes_written += bytes_read;
        }
        if (bytes_written == 0) {
            abend(-1, "unable to read stdin");
            exit(EXIT_FAILURE);
        }
        if (fstat(view->in_fd, &sb) == -1) {
            abend(-1, "fstat failed");
            exit(EXIT_FAILURE);
        }
        view->file_size = sb.st_size;
        if (view->file_size == 0) {
            close(view->in_fd);
            strnz__cpy(tmp_str, "no standard input", MAXLEN - 1);
            abend(-1, tmp_str);
            exit(EXIT_FAILURE);
        }
        waitpid_with_timeout(pid, wait_timeout);
        // waitpid(-1, nullptr, 0);
    }
    //  Memory-map the input file for efficient access.
    view->buf =
        mmap(nullptr, view->file_size, PROT_READ, MAP_PRIVATE, view->in_fd, 0);
    if (view->buf == MAP_FAILED) {
        ssnprintf(em0, MAXLEN - 1, "%s, line: %d", __FILE__, __LINE__ - 2);
        ssnprintf(em1, MAXLEN - 1, "mmap %s", file_name);
        strerror_r(errno, em2, MAXLEN);
        display_error(em0, em1, em2, nullptr);
        close(view->in_fd);
        return -1;
    }
    close(view->in_fd);
    view->file_size = sb.st_size;
    view->prev_file_pos = NULL_POSITION;
    view->buf_curr_ptr = view->buf;
    if (view->cmd_all[0] != '\0')
        strnz__cpy(view->cmd, view->cmd_all, MAXLEN - 1);
    for (idx = 0; idx < NMARKS; idx++)
        view->mark_tbl[idx] = NULL_POSITION;
    strnz__cpy(view->cur_file_str, file_name, MAXLEN - 1);
    base_name(view->file_name, view->cur_file_str);
    return 0;
}

References abend(), base_name(), View::buf, View::buf_curr_ptr, View::cmd, View::cmd_all, cmd_key, View::cur_file_str, destroy_argv(), display_error(), em0, em1, em2, expand_tilde(), View::f_in_pipe, View::file_name, View::file_size, View::in_fd, View::mark_tbl, Perror(), View::prev_file_pos, View::provider_cmd, ssnprintf(), str_to_args(), strnz__cat(), strnz__cpy(), wait_continue(), wait_destroy(), wait_mk_chyron(), wait_mk_win(), wait_timeout, and waitpid_with_timeout().

Referenced by view_file().

Here is the call graph for this function:

Here is the caller graph for this function: