ui_notcurses_input.c File Reference

NotCurses UI backend — input handling. More...

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

Include dependency graph for ui_notcurses_input.c:

Go to the source code of this file.

Functions
uint	get_plane_idx (UiSurface *s, struct ncplane *plane)
NcPlane *	ncplane_clicked (UiSurface *s, uint w, ncinput *ni)
int	ui_get_event (UiSurface *s, uint w, UiEvent *ev, int timeout_ms)
	Wait for an input event from the NotCurses context.
int	ui_get_event_multi (UiSurface *s, uint w, UiEvent *ev, int timeout_ms)
int	ui_get_event_multix (UiSurface *s, uint w, UiEvent *ev, int timeout_ms)
int	ui_get_event_no_mouse (UiSurface *target, uint w, UiEvent *ev)
int	ui_getch ()

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

get_plane_idx()

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

Definition at line 249 of file ui_notcurses_input.c.

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

References SUB_SFC_MAX.

Referenced by ui_get_event_multi().

Here is the caller graph for this function:

ncplane_clicked()

NcPlane * ncplane_clicked	(	UiSurface *	s,
		uint	w,
		ncinput *	ni )

Definition at line 259 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;
}

ui_get_event()

int ui_get_event	(	UiSurface *	s,
		uint	w,
		UiEvent *	ev,
		int	timeout_ms )

Wait for an input event from the NotCurses context.

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

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 104 of file ui_notcurses_input.c.

                                                                    {
    if (!ui || !ev)
        return -1;
    memset(ev, 0, sizeof(*ev));
 
    ncinput ni;
    // ui_cursor_enable(s, w, true);
    // tcflush(0, TCIFLUSH);
    if (timeout_ms < 0) {
        do {
            // notcurses_get(ui->nc, NULL, &ni);
            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_INVALID);
    }
    // notcurses_cursor_disable(ui->nc);
    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 == UI_KEY_CHAR) {
        ev->ch = ni.id; /* Unicode codepoint */
    } else if (ev->key == UI_KEY_MOUSE) {
        ev->y = ni.y;
        ev->x = ni.x;
        if (ni.id == NCKEY_BUTTON4)
            ev->mouse_action = UI_MOUSE_SCROLL_UP;
        else if (ni.id == NCKEY_BUTTON5)
            ev->mouse_action = UI_MOUSE_SCROLL_DOWN;
        else if (ni.evtype == NCTYPE_PRESS)
            ev->mouse_action = UI_MOUSE_PRESS;
        else if (ni.evtype == NCTYPE_RELEASE)
            ev->mouse_action = UI_MOUSE_RELEASE;
    }
    return ni.id;
}

References UiEvent::alt, UiEvent::bstate, UiEvent::ch, UiEvent::ctrl, UiEvent::key, UiEvent::mouse_action, UiEvent::mouse_inside, UiRuntime::nc, UiEvent::shift, ui, UI_KEY_CHAR, UI_KEY_MOUSE, UI_MOUSE_PRESS, UI_MOUSE_RELEASE, UI_MOUSE_SCROLL_DOWN, UI_MOUSE_SCROLL_UP, UiEvent::x, and UiEvent::y.

Referenced by action_disposition(), answer_yn(), cf_accept(), display_error(), menu_cmd_processor(), notcurses_input(), and Perror().

Here is the caller graph for this function:

ui_get_event_multi()

int ui_get_event_multi	(	UiSurface *	s,
		uint	w,
		UiEvent *	ev,
		int	timeout_ms )

Definition at line 181 of file ui_notcurses_input.c.

                                                                          {
    if (!ui || !ev)
        return -1;
    memset(ev, 0, sizeof(*ev));
    ncinput ni;
    if (timeout_ms < 0)
        do {
            notcurses_get(ui->nc, NULL, &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_INVALID);
    }
    // notcurses_cursor_disable(ui->nc);
    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 == UI_KEY_CHAR) {
        ev->ch = ni.id; /* Unicode codepoint */
    } else if (ev->key == UI_KEY_MOUSE) {
        if (ni.id == NCKEY_BUTTON1) {
            struct ncplane *nn = ncplane_clicked(s, w, &ni);
            ev->in_win = get_plane_idx(s, nn);
            ev->key = 0;
        }
    }
    ev->y = ni.y;
    ev->x = ni.x;
    if (ni.id == NCKEY_BUTTON4)
        ev->mouse_action = UI_MOUSE_SCROLL_UP;
    else if (ni.id == NCKEY_BUTTON5)
        ev->mouse_action = UI_MOUSE_SCROLL_DOWN;
    else if (ni.evtype == NCTYPE_PRESS)
        ev->mouse_action = UI_MOUSE_PRESS;
    else if (ni.evtype == NCTYPE_RELEASE)
        ev->mouse_action = UI_MOUSE_RELEASE;
    return ni.id;
}

References UiEvent::alt, UiEvent::bstate, UiEvent::ch, UiEvent::chyron, UiEvent::ctrl, get_plane_idx(), UiEvent::in_win, UiEvent::key, UiEvent::mouse_action, UiRuntime::nc, ncplane_clicked(), UiEvent::shift, SUB_SFC_MAX, ui, UI_KEY_CHAR, UI_KEY_MOUSE, UI_MOUSE_NONE, UI_MOUSE_PRESS, UI_MOUSE_RELEASE, UI_MOUSE_SCROLL_DOWN, UI_MOUSE_SCROLL_UP, WIN, UiEvent::x, and UiEvent::y.

Referenced by field_editor(), form_post(), form_process(), and picker().

Here is the call graph for this function:

Here is the caller graph for this function:

ui_get_event_multix()

int ui_get_event_multix	(	UiSurface *	s,
		uint	w,
		UiEvent *	ev,
		int	timeout_ms )

Definition at line 164 of file ui_notcurses_input.c.

                                                                           {
    (void)timeout_ms;
    (void)ev;
    (void)w;
    (void)s;
    if (!ui)
        return -1;
    ncinput ni;
    do {
        // notcurses_get_blocking(ui->nc, &ni);
        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 UiRuntime::nc, and ui.

ui_get_event_no_mouse()

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

Definition at line 229 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 == UI_KEY_CHAR)
        ev->ch = ni.id;
    return ni.id;
}

References UiEvent::alt, UiEvent::ch, UiEvent::ctrl, UiEvent::key, UiRuntime::nc, UiEvent::shift, ui, and UI_KEY_CHAR.

Referenced by get_cmd_char().

Here is the caller graph for this function:

ui_getch()

int ui_getch

(

)

Definition at line 151 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 nc, UiRuntime::nc, and ui.

Referenced by ui_notcurses_init().

Here is the caller graph for this function: