kb.c File Reference

MuCurses keyboard input handling functions. More...

#include <curses.h>
#include <stddef.h>
#include <unistd.h>
#include "mucurses.h"

Go to the source code of this file.

Macros
#define	INPUT_DELAY   200
#define	INPUT_DELAY_TIMEOUT   1000

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
static int	_wgetc (WINDOW *win)
int	wgetch (WINDOW *win)
	Pop a character from the FIFO into a window.
int	wgetnstr (WINDOW *win, char *str, int n)
	Read at most n characters from the FIFO into a window.
int	echo (void)
int	noecho (void)

Variables
int	m_delay
bool	m_echo
bool	m_cbreak

Detailed Description

MuCurses keyboard input handling functions.

Definition in file kb.c.

Macro Definition Documentation

INPUT_DELAY

#define INPUT_DELAY   200

Definition at line 13 of file kb.c.

Referenced by _wgetc().

INPUT_DELAY_TIMEOUT

#define INPUT_DELAY_TIMEOUT   1000

Definition at line 14 of file kb.c.

Referenced by _wgetc().

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

_wgetc()

int _wgetc ( WINDOW * win )

static

Definition at line 24 of file kb.c.

                                  {
        int timer, c;
 
        if ( win == NULL )
                return ERR;
 
        timer = INPUT_DELAY_TIMEOUT;
        while ( ! win->scr->peek( win->scr ) ) {
                if ( m_delay == 0 ) // non-blocking read
                        return ERR;
                if ( timer > 0 ) {  // time-limited blocking read
                        if ( m_delay > 0 )
                                timer -= INPUT_DELAY;
                        mdelay( INPUT_DELAY );
                } else { return ERR; } // non-blocking read
        }
 
        c = win->scr->getc( win->scr );
 
        if ( m_echo && ( c >= 32 && c <= 126 ) ) // printable ASCII characters
                _wputch( win, (chtype) ( c | win->attrs ), WRAP );
 
        return c;
}

References _wputch(), _curses_window::attrs, ERR, _curses_screen::getc, INPUT_DELAY, INPUT_DELAY_TIMEOUT, m_delay, m_echo, mdelay(), NULL, _curses_screen::peek, _curses_window::scr, and WRAP.

Referenced by wgetch(), and wgetnstr().

wgetch()

int wgetch

(

WINDOW *

win

)

Pop a character from the FIFO into a window.

Parameters

*win	window in which to echo input

Return values

c	char from input stream

Definition at line 55 of file kb.c.

                           {
        int c;
 
        c = _wgetc( win );
 
        if ( m_echo ) {
                if ( c >= KEY_MIN ) {
                        switch(c) {
                        case KEY_LEFT :
                        case KEY_BACKSPACE :
                                _wcursback( win );
                                wdelch( win );
                                break;
                        default :
                                beep();
                                break;
                        }
                } else {
                        _wputch( win, (chtype)( c | win->attrs ), WRAP );
                }
        }
 
        return c;
}

References _wcursback(), _wgetc(), _wputch(), _curses_window::attrs, beep(), KEY_BACKSPACE, KEY_LEFT, KEY_MIN, m_echo, wdelch(), and WRAP.

Referenced by getch(), mvgetch(), and mvwgetch().

wgetnstr()

int wgetnstr	(	WINDOW *	win,
		char *	str,
		int	n )

Read at most n characters from the FIFO into a window.

Parameters

*win	window in which to echo input
*str	pointer to string in which to store result
n	maximum number of characters to read into string (inc. NUL)

Return values

rc	return status code

Definition at line 88 of file kb.c.

                                               {
        char *_str;
        int c;
 
        if ( n == 0 ) {
                *str = '\0';
                return OK;
        }
 
        _str = str;
 
        while ( ( c = _wgetc( win ) ) != ERR ) {
                /* termination enforcement - don't let us go past the
                   end of the allocated buffer... */
                if ( n == 0 && ( c >= 32 && c <= 126 ) ) {
                        _wcursback( win );
                        wdelch( win );
                } else {
                        if ( c >= 32 && c <= 126 ) {
                                *(_str++) = c; n--;
                        } else {
                                switch(c) {
                                case KEY_LEFT :
                                case KEY_BACKSPACE :
                                        _wcursback( win );
                                        wdelch( win );
                                        break;
                                case KEY_ENTER :
                                        *_str = '\0';
                                        return OK;
                                default :
                                        beep();
                                        break;
                                }
                        }
                }
        }
 
        return ERR;
}

References _wcursback(), _wgetc(), beep(), ERR, KEY_BACKSPACE, KEY_ENTER, KEY_LEFT, OK, and wdelch().

Referenced by getnstr(), getstr(), mvgetnstr(), mvgetstr(), mvwgetnstr(), mvwgetstr(), and wgetstr().

echo()

int echo

(

void

)

Definition at line 133 of file kb.c.

                  {
        m_echo = TRUE;
        return OK;
}

References m_echo, OK, and TRUE.

Referenced by COMMAND(), fc_els_echo_detect(), fc_els_echo_rx_request(), fc_els_echo_rx_response(), fc_els_echo_tx(), icmp_rx_echo_reply(), icmp_rx_echo_request(), icmp_tx_echo(), icmp_tx_echo_reply(), icmp_tx_echo_request(), ping_deliver(), and ping_rx().

noecho()

int noecho

(

void

)

Definition at line 141 of file kb.c.

                    {
        m_echo = FALSE;
        return OK;
}

References FALSE, m_echo, and OK.

Variable Documentation

m_delay

int m_delay

Definition at line 16 of file kb.c.

Referenced by _wgetc().

m_echo

bool m_echo

Definition at line 21 of file kb.c.

Referenced by _wgetc(), echo(), noecho(), and wgetch().

m_cbreak

bool m_cbreak

Definition at line 22 of file kb.c.