pick_engine.c File Reference

pick from a list of choices More...

#include "common.h"
#include <fcntl.h>
#include <stdbool.h>
#include <string.h>
#include <sys/mman.h>
#include <sys/stat.h>
#include <sys/wait.h>
#include <termios.h>
#include <unistd.h>

Include dependency graph for pick_engine.c:

Go to the source code of this file.

Functions
void	deselect_object (Pick *pick)
	Deselects the currently selected object in pick window.
void	destroy_pick_view (Init *init)
	Destroys pick view, unmaps file buffer, and cleans up resources.
void	display_pick_help (Init *init)
	Displays the help screen for the pick interface using view.
void	display_pick_page (Pick *pick)
	Displays current page of objects in pick window.
void	end_pick_view (Init *)
int	exec_objects (Init *init)
	Executes specified command with selected objects as arguments.
int	init_pick (Init *init, int argc, char **argv, uint by, uint bx)
	Initializes pick structure and opens pick input file or pipe.
int	match_objects (Pick *pick, char *s)
	Displays current page of objects in pick window.
int	new_pick_view (Init *init)
	Initializes a new view for displaying file contents in the pick interface.
void	new_view_file (Init *init, char *file)
	Initializes a new view for displaying the contents of a specified file in the pick interface.
int	open_pick_win (Init *)
int	output_objects (Pick *pick)
	Outputs selected objects to specified output file.
int	pick_engine (Init *)
void	pick_std_chyron (Pick *pick)
	Sets standard chyron key states based on pick structure.
int	picker (Init *init, char *field)
	Main loop for handling user input and interactions in the pick interface.
int	read_pick_input (Init *init)
	Reads pick input from file pointer and saves objects into pick structure.
int	read_theme (Init *)
void	remove_right_angle (Pick *)
void	reverse_object (Pick *pick)
	Reverses the display of the currently selected object in pick window.
void	save_object (Pick *pick, char *s)
	Saves a string as an object in the pick structure.
void	toggle_object (Pick *pick)
	Toggles the selection state of the currently selected object in pick window.
void	unreverse_object (Pick *pick)
	Unreverses the display of the currently selected object in pick window.

Variables
int	calculated_idx
int	obj_idx
char const	pagers_editors [12][10]
int	pg_lines
int	pipe_fd [2]
int	tbl_col
int	tbl_cols
int	tbl_line
int	tbl_page
int	tbl_pages
UiMultiMedia	ui_mm

Detailed Description

pick from a list of choices

Author

Bill Waller Copyright (c) 2025 MIT License billx.nosp@m.wall.nosp@m.er@gm.nosp@m.ail..nosp@m.com

Date

2026-02-09

Definition in file pick_engine.c.

Function Documentation

end_pick_view()

void end_pick_view

(

Init *

)

open_pick_win()

int open_pick_win

(

Init *

init

)

Definition at line 247 of file pick_engine.c.

                              {
    uint maxy, maxx;
    uint whitespace_ratio = 15;
    uint usable_lines;
    uint pick_ratio = 50;
    uint tbl_max_cols, pg_max_objs;
 
    Pick *pick = init->pick;
    ui_get_screen_size(&maxy, &maxx);
    // Screen Geometry
    // Calculate pick window size and position based on terminal size and pick
    // parameters
    //
    // Calculate line usage:
    if (pick->begy == 0)
        pick->begy = (maxy * whitespace_ratio) / 200;
    usable_lines = maxy - (maxy * whitespace_ratio) / 100;
    usable_lines -= pick->begy;
    usable_lines -= 5; // Pick overhead lines
    if (pick->p_view_files) {
        if (pick->lines == 0) {
            pick->lines = usable_lines * pick_ratio / 100;
            usable_lines -= pick->lines;
        }
        init->begy = pick->begy + 5 + pick->lines;
        init->begx = 0;
        usable_lines -= 3; // View overhead lines
        init->lines = usable_lines;
        init->cols = maxx - 2;
    } else if (pick->lines == 0)
        pick->lines = usable_lines;
 
    pick->tbl_col_width = max(pick->tbl_col_width, 4);
    pick->tbl_col_width = min(pick->tbl_col_width, (maxx - (2 + pick->begx)));
    pick->m_idx = 0; // master index
    pick->d_idx = 0; // display index
    while (pick->m_idx < pick->m_cnt)
        pick->d_object[pick->d_idx++] = pick->m_object[pick->m_idx++];
    pick->d_cnt = pick->d_idx;
    if (pick->d_cnt <= pick->lines) {
        pick->tbl_lines = pick->d_cnt;
        pick->lines = pick->d_cnt;
        pick->tbl_cols = 1;
    } else {
        tbl_max_cols = ((maxx - (2 + pick->begx)) / (pick->tbl_col_width + 1));
        pg_max_objs = pick->lines * tbl_max_cols;
        if (pick->d_cnt > pg_max_objs)
            pick->tbl_cols = tbl_max_cols;
        else
            pick->tbl_cols = pick->d_cnt / pick->lines;
        pick->tbl_lines = pick->d_cnt / tbl_max_cols;
    }
    pick->tbl_pages = (pick->tbl_lines / (pick->lines - 1)) + 1;
    // pick->lines = (pick->tbl_lines + pick->tbl_pages - 1) / pick->tbl_pages;
    pick->tbl_page = 0;
    // if (pick->begy == 0)
    //     pick->begy = (LINES - pick->lines) / 5;
    // else if (pick->begy + pick->lines > LINES - 4)
    //     pick->begy = LINES - pick->lines - 2;
    pick->width = (pick->tbl_col_width + 1) * pick->tbl_cols;
 
    pick->width = max(pick->width, 60);
    char tmp_str[MAXLEN];
 
    int ui_split_win_lines = 2;
    if (ui_tracked_sfc_split_box(pick->lines, pick->width, ui_split_win_lines, 0, pick->begy, pick->begx, pick->title)) {
        ssnprintf(tmp_str, MAXLEN - 1, "ui_tracked_sfc_split_box(%d, %d, %d, %d, %d, %d, %s) failed",
                  pick->lines, pick->width, ui_split_win_lines, 0, pick->begy, pick->begx, pick->title);
        ui_perror(tmp_str);
        return (1);
    }
    pick->surface = ui_surface[sfc_ptr];
    UiSurface *sfc = pick->surface;
    ui_setscrreg(sfc, WIN, 0, pick->lines - 1);
    ui_scrollok(sfc, WIN, true);
    ui_keypad(sfc, WIN, true);
    pick->separator_line = pick->lines + 1;
 
    pick->x = 1;
 
    pick->chyron = ui_new_chyron(pick->surface, WIN2);
    ui_set_chyron_key(pick->chyron, 1, _("F1 Help"), UIKEY_F01);
    ui_set_chyron_key(pick->chyron, 2, _("F9 Cancel"),
                      UIKEY_F09);
    ui_set_chyron_key(pick->chyron, 3, _("F10 Accept"),
                      UIKEY_F10);
    ui_set_chyron_key(pick->chyron, 4, _("F11 View"),
                      UIKEY_F11);
    ui_set_chyron_key(pick->chyron, 5, _("<q> Quit View"),
                      'q');
    ui_set_chyron_key(pick->chyron, 6, _("<Sp> Process"), ' ');
    ui_set_chyron_key(pick->chyron, 7, _("<Sp> Edit"), ' ');
    ui_set_chyron_key(pick->chyron, 9, _("<Tab> Search"),
                      '\t');
    ui_set_chyron_key(pick->chyron, 10, _("<Tab> Select"),
                      '\t');
    ui_set_chyron_key(pick->chyron, 11, "PgUp",
                      UIKEY_PPAGE);
    ui_set_chyron_key(pick->chyron, 12, "PgDn",
                      UIKEY_NPAGE);
    ui_set_chyron_key(pick->chyron, 13, "INS", UIKEY_IC);
    pick_std_chyron(pick);
    ui_compile_chyron(pick->chyron);
    return 0;
}

References Init::begx, Pick::begx, Init::begy, Pick::begy, Pick::chyron, Init::cols, Pick::d_cnt, Pick::d_idx, Pick::d_object, Init::lines, Pick::lines, Pick::m_cnt, Pick::m_idx, Pick::m_object, Pick::p_view_files, Init::pick, pick_std_chyron(), Pick::separator_line, sfc_ptr, ssnprintf(), Pick::surface, Pick::tbl_col_width, Pick::tbl_cols, Pick::tbl_lines, Pick::tbl_page, Pick::tbl_pages, Pick::title, ui_compile_chyron(), ui_get_screen_size(), ui_keypad(), ui_new_chyron(), ui_perror(), ui_scrollok(), ui_set_chyron_key(), ui_setscrreg(), ui_surface, ui_tracked_sfc_split_box(), Pick::width, and Pick::x.

Referenced by init_pick().

Here is the call graph for this function:

Here is the caller graph for this function:

pick_engine()

int pick_engine

(

Init *

init

)

Enter picker loop to handle user input and interactions

< Buffer for user input in the field

Definition at line 353 of file pick_engine.c.

                            {
    int rc = 0;
    bool f_processed = false;
    Pick *pick = init->pick;
    char field[MAXLEN]; 
    field[0] = '\0';
    display_pick_page(pick);
    do {
        rc = picker(init, field);
        if (rc == UIKEY_F09)
            break;
        if (rc == -1)
            break;
        else {
            if (pick->select_cnt > 0) {
                if (pick->f_out_spec && pick->out_spec[0]) {
                    output_objects(pick);
                    f_processed = true;
                }
                if (pick->f_cmd && pick->cmd[0]) {
                    exec_objects(init);
                    f_processed = true;
                }
                if (pick->f_read_theme) {
                    read_theme(init);
                    f_processed = true;
                }
                if (f_processed) {
                    ui_mvwaddstr(pick->surface, WIN2, 0, 0, _("Selection Processed"));
                    ui_wclrtoeol(pick->surface, WIN2);
                }
            }
        }
        deselect_object(pick);
    } while (1);
    ui_destroy_chyron(pick->chyron);
    return (rc);
}

References Pick::chyron, Pick::cmd, deselect_object(), display_pick_page(), exec_objects(), Pick::f_cmd, Pick::f_out_spec, Pick::f_read_theme, Pick::out_spec, output_objects(), Init::pick, picker(), read_theme(), Pick::select_cnt, Pick::surface, ui_destroy_chyron(), ui_mvwaddstr(), and ui_wclrtoeol().

Referenced by init_pick().

Here is the call graph for this function:

Here is the caller graph for this function:

read_theme()

int read_theme

(

Init *

init

)

Definition at line 615 of file pick_engine.c.

                           {
    int rc;
    expand_tilde(init->mapp_theme, MAXLEN - 1);
    rc = process_config_file(init->mapp_theme, init);
    if (rc)
        return rc;
    SIO *sio = init->sio;
    ui_initialize_sio(sio);
    ui_render();
    return 0;
}

References expand_tilde(), Init::mapp_theme, process_config_file(), Init::sio, ui_initialize_sio(), and ui_render().

Referenced by pick_engine().

Here is the call graph for this function:

Here is the caller graph for this function:

remove_right_angle()

void remove_right_angle

(

Pick *

pick

)

Definition at line 564 of file pick_engine.c.

                                    {
    UiSurface *sfc = pick->surface;
    if (pick->d_idx >= pick->d_cnt)
        pick->d_idx = pick->d_cnt - 1;
    pick->tbl_line = (pick->d_idx / pick->tbl_cols) % pick->lines;
    pick->y = pick->tbl_line + pick->y_offset;
    pick->d_idx = pick->tbl_page * pick->lines * pick->tbl_cols + pick->tbl_col * pick->lines + pick->tbl_line;
    if (pick->f_selected[pick->d_idx])
        ui_mvwadd_wchnstr(sfc, WIN, pick->y, 0, &cell_chk, 1);
    else
        ui_mvwadd_wchnstr(sfc, WIN, pick->y, 0, &cell_sp, 1);
    ui_cursor_move(sfc, WIN, pick->y, 0);
}

References cell_chk, cell_sp, Pick::d_cnt, Pick::d_idx, Pick::f_selected, Pick::lines, Pick::surface, Pick::tbl_col, Pick::tbl_cols, Pick::tbl_line, Pick::tbl_page, ui_cursor_move(), ui_mvwadd_wchnstr(), Pick::y, and Pick::y_offset.

Referenced by picker().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

calculated_idx

int calculated_idx

Definition at line 24 of file pick_engine.c.

obj_idx

int obj_idx

Definition at line 24 of file pick_engine.c.

pagers_editors

char const pagers_editors

Initial value:

= {"view", "view", "less", "more",
           "vi", "vim", "nano", "nvim",
           "pico", "emacs", "edit", ""}

Definition at line 50 of file pick_engine.c.

                                  {"view", "view", "less", "more",
                                     "vi", "vim", "nano", "nvim",
                                     "pico", "emacs", "edit", ""};

pg_lines

int pg_lines

Definition at line 23 of file pick_engine.c.

pipe_fd

int pipe_fd

Definition at line 46 of file pick_engine.c.

Referenced by init_pick().

tbl_col

int tbl_col

Definition at line 23 of file pick_engine.c.

tbl_cols

int tbl_cols

Definition at line 23 of file pick_engine.c.

tbl_line

int tbl_line

Definition at line 23 of file pick_engine.c.

tbl_page

int tbl_page

Definition at line 23 of file pick_engine.c.

tbl_pages

int tbl_pages

Definition at line 23 of file pick_engine.c.

ui_mm

UiMultiMedia ui_mm

Definition at line 48 of file pick_engine.c.