ui_notcurses_input.c File Reference

NotCurses UI backend — input handling. More...

#include "ui_backend.h"
#include "ui_notcurses_internal.h"
#include <errno.h>
#include <notcurses/notcurses.h>
#include <poll.h>
#include <string.h>
#include <termios.h>

Include dependency graph for ui_notcurses_input.c:

Go to the source code of this file.

Functions
void	ui_flush_input ()
	Flush any pending input events from the NotCurses context. This function discards any input events that have been queued but not yet processed.
int	ui_get_event (UiSurface *s, ss_t w, UiChyron *chyron, UiEvent *ev, int timeout_ms)
	Wait for an input event from the NotCurses context.
int	ui_get_event_no_mouse (UiSurface *target, ss_t w, UiEvent *ev)
	Wait for an input event from the NotCurses context, ignoring mouse events.
uint	ui_get_plane_idx (UiSurface *s, struct ncplane *plane)
	Get the index of a given ncplane in the UiSurface's plane array.
int	ui_getch ()
	Wait for a single input character from the NotCurses context.
int	ui_mice_enable (int mask)
	Enable or disable mouse events for the NotCurses context.
int	ui_mousemask (int mask)
	Set the mouse event mask for the NotCurses context.
NcPlane *	ui_ncplane_clicked (UiSurface *s, ss_t w, ncinput *ni)
	Determine which ncplane was clicked based on the mouse event coordinates.

Detailed Description

NotCurses UI backend — input handling.

Translates NotCurses ncinput events into the portable UiEvent representation defined in ui_backend.h.

Definition in file ui_notcurses_input.c.

Function Documentation

ui_flush_input()

void ui_flush_input

(

)

Flush any pending input events from the NotCurses context. This function discards any input events that have been queued but not yet processed.

Definition at line 105 of file ui_notcurses_input.c.

                      {
    int fd = notcurses_inputready_fd(ui->nc);
    tcflush(fd, TCIOFLUSH);
}

References ui.

ui_get_event()

int ui_get_event	(	UiSurface *	s,
		ss_t	w,
		UiChyron *	chyron,
		UiEvent *	ev,
		int	timeout_ms )

Wait for an input event from the NotCurses context.

Parameters

ui	UI runtime context.
target	Unused for NotCurses (events are global to the context).
ev	Output UiEvent structure.
timeout_ms	Milliseconds to wait; -1 = block indefinitely.

Returns

0 on success, -1 if ui or ev is NULL.

Definition at line 117 of file ui_notcurses_input.c.

                                                                                      {
    if (!ui || !ev)
        return -1;
    memset(ev, 0, sizeof(*ev));
    ncinput ni;
    memset(&ni, 0, sizeof(ni));
    ui_render();
    ui_flush_input();
    if (timeout_ms < 0)
        timeout_ms = -1;
    if (timeout_ms > 1) {
        // ------------------------------------------------------------
        // Poll for input on the TTY and any registered external files
        // ------------------------------------------------------------
        struct pollfd fds[1 + MAX_EXT_FDS];
        int token_id;
        int reg_idx;
        memset(fds, 0, sizeof(fds));
        fds[0].fd = notcurses_inputready_fd(ui->nc);
        fds[0].events = POLLIN;
        nfds_t nfds = 1;
        nfds_t ext_start_idx = nfds;
        for (nfds_t i = 0; i < ui_ctx.ext_nfds; i++) {
            fds[nfds].fd = ui_ctx.ext_fds[i].fd;
            fds[nfds].events = POLLIN;
            nfds++;
        }
        int poll_rc = poll(fds, nfds, timeout_ms);
        if (poll_rc < 0) {
            if (errno == EINTR)
                return 0; // continue
            return -1;
        }
        if (poll_rc == 0) { // timed out with no input
            ni.id = UIKEY_TIMEOUT;
            return ni.id;
        }
        bool ui_ready = (fds[0].revents & POLLIN);
        if (!ui_ready) {
            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;
                }
            }
        } else {
            timeout_ms = 0;
        }
    }
    memset(ev, 0, sizeof(*ev));
    ui_render();
    if (timeout_ms < 0) {
        do {
            notcurses_get_blocking(ui->nc, &ni);
        } while (ni.evtype == NCTYPE_RELEASE ||
                 ni.id == NCKEY_INVALID || ni.id == NCKEY_MOTION || ni.id == NCKEY_SIGNAL);
    } else {
        struct timespec ts = {
            .tv_sec = timeout_ms / 1000,
            .tv_nsec = (long)(timeout_ms % 1000) * 1000000L,
        };
        do {
            notcurses_get(ui->nc, &ts, &ni);
        } while (ni.evtype == NCTYPE_RELEASE || ni.id == NCKEY_MOTION || ni.id == NCKEY_INVALID);
    }
    ev->key = translate_nckey(ni.id, &ni);
    ev->alt = ncinput_alt_p(&ni);
    ev->ctrl = ncinput_ctrl_p(&ni);
    ev->shift = ncinput_shift_p(&ni);
    if (ev->key == UIKEY_CHAR)
        ev->ch = ni.id; /* Unicode codepoint */
    else if (ev->key == UIKEY_MOUSE) {
        if (ni.id == NCKEY_BUTTON4)
            ev->mouse_action = UIKEY_SCROLL_UP;
        else if (ni.id == NCKEY_BUTTON5)
            ev->mouse_action = UIKEY_SCROLL_DOWN;
        else if (ni.id == NCKEY_BUTTON1 && ni.evtype == NCTYPE_PRESS) {
            ev->mouse_action = UIKEY_BUTTON1_PRESSED;
            struct ncplane *clicked = ui_ncplane_clicked(s, w, &ni);
            ev->y = ni.y;
            ev->x = ni.x;
            ev->in_win = ui_get_plane_idx(s, clicked);
            if (chyron) {
                if (ev->in_win == chyron->w && ev->y == chyron->y) {
                    ev->mouse_action = UIKEY_BUTTON1_CLICKED;
                    ev->key = ui_get_chyron_key(chyron, ev->x);
                    return ev->key;
                } else
                    return 0;
            } else {
                if (ev->in_win == w) {
                    ev->mouse_action = UIKEY_BUTTON1_CLICKED;
                    ev->key = ev->y;
                    return ev->key;
                } else
                    return 0;
            }
        }
    }
    return ni.id;
}

References UiEvent::alt, UiEvent::ch, UiEvent::ctrl, ui_context_t::ext_fds, ui_context_t::ext_nfds, ext_fd_reg_t::fd, UiEvent::in_win, UiEvent::key, UiEvent::mouse_action, UiEvent::shift, ext_fd_reg_t::token_id, ui, ui_ctx, ui_flush_input(), ui_get_chyron_key(), ui_render(), UiEvent::x, and UiEvent::y.

Here is the call graph for this function:

ui_get_event_no_mouse()

int ui_get_event_no_mouse	(	UiSurface *	target,
		ss_t	w,
		UiEvent *	ev )

Wait for an input event from the NotCurses context, ignoring mouse events.

Wait for an input event on target (or stdscr if NULL) without mouse support.

Parameters

target	Unused for NotCurses (events are global to the context).
ev	Output UiEvent structure.

Returns

The NotCurses key code, or -1 if ui or ev is NULL.

Definition at line 239 of file ui_notcurses_input.c.

                                                                  {
    (void)target;
    (void)w;
    if (!ui || !ev)
        return -1;
    memset(ev, 0, sizeof(*ev));
    ncinput ni;
    notcurses_mice_disable(ui->nc);
    do {
        notcurses_get(ui->nc, NULL, &ni);
    } while (ni.id == NCKEY_INVALID);
    ev->key = translate_nckey(ni.id, &ni);
    ev->alt = ncinput_alt_p(&ni);
    ev->ctrl = ncinput_ctrl_p(&ni);
    ev->shift = ncinput_shift_p(&ni);
    if (ev->key == UIKEY_CHAR)
        ev->ch = ni.id;
    return ni.id;
}

References UiEvent::alt, UiEvent::ch, UiEvent::ctrl, UiEvent::key, UiEvent::shift, ui, and ui_flush_input().

Here is the call graph for this function:

ui_get_plane_idx()

uint ui_get_plane_idx	(	UiSurface *	s,
		struct ncplane *	plane )

Get the index of a given ncplane in the UiSurface's plane array.

Parameters

s	The UiSurface containing the planes.
plane	The ncplane to find.

Returns

The index of the plane in the UiSurface's mplane array, or -1 if not found.

Definition at line 263 of file ui_notcurses_input.c.

                                                           {
    for (ss_t w = BOX; w < SUB_SFC_MAX; ++w) {
        if (s->mplane[w] == plane)
            return w;
    }
    return -1;
}

References SUB_SFC_MAX.

ui_getch()

int ui_getch

(

)

Wait for a single input character from the NotCurses context.

Returns

The NotCurses key code, or -1 if ui is NULL.

Definition at line 222 of file ui_notcurses_input.c.

               {
    if (!ui)
        return -1;
    ncinput ni;
    do {
        notcurses_get(ui->nc, NULL, &ni);
    } while (ni.evtype == NCTYPE_RELEASE ||
             ni.id == NCKEY_INVALID ||
             ni.id == NCKEY_MOTION ||
             ni.id == NCKEY_SIGNAL);
    return ni.id;
}

References ui.

ui_mice_enable()

int ui_mice_enable

(

int

mask

)

Enable or disable mouse events for the NotCurses context.

Enable or disable mouse support.

Parameters

mask	The mouse event mask to enable. If 0, all mouse events are enabled.

Returns

0 on success, or -1 if ui is NULL.

Definition at line 310 of file ui_notcurses_input.c.

                             {
    if (mask)
        notcurses_mice_enable(ui->nc, mask);
    else {
        notcurses_mice_enable(ui->nc, NCMICE_BUTTON_EVENT);
    }
    return 0;
}

References ui.

ui_mousemask()

int ui_mousemask

(

int

mask

)

Set the mouse event mask for the NotCurses context.

Enable or disable mouse support.

Parameters

mask	The mouse event mask to set. If 0, all mouse events are enabled.

Returns

0 on success, or -1 if ui is NULL.

Definition at line 297 of file ui_notcurses_input.c.

                           {
    if (!ui)
        return 0;
    if (mask)
        notcurses_mice_enable(ui->nc, mask);
    else
        notcurses_mice_enable(ui->nc, NCMICE_BUTTON_EVENT);
    return 0;
}

References ui.

Referenced by menu_cmd_processor(), and picker().

Here is the caller graph for this function:

ui_ncplane_clicked()

NcPlane * ui_ncplane_clicked	(	UiSurface *	s,
		ss_t	w,
		ncinput *	ni )

Determine which ncplane was clicked based on the mouse event coordinates.

Parameters

s	The UiSurface containing the planes.
w	The index of the plane to check for clicks.
ni	The NotCurses input event containing mouse coordinates.

Returns

The ncplane that was clicked, or NULL if no plane was clicked.

Definition at line 276 of file ui_notcurses_input.c.

                                                               {
    NcPlane *pile_member = s->mplane[w];
    struct ncplane *cur = ncpile_top(pile_member);
    while (cur != NULL) {
        int y = ni->y, x = ni->x;
        if (ncplane_translate_abs(cur, &y, &x)) {
            ni->y = y;
            ni->x = x;
            return cur;
        }
        cur = ncplane_below(cur);
    }
    return NULL;
}