mucurses.c File Reference

MuCurses core functions. More...

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

Go to the source code of this file.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
static void	_wupdcurs (WINDOW *win)
	Update cursor position.
void	_wputch (WINDOW *win, chtype ch, int wrap)
	Write a single character rendition to a window.
void	_wputc (WINDOW *win, char c, int wrap)
	Write a single character to a window.
void	_wcursback (WINDOW *win)
	Retreat the cursor back one position (useful for a whole host of ops)
void	_wputchstr (WINDOW *win, const chtype *chstr, int wrap, int n)
	Write a chtype string to a window.
void	_wputstr (WINDOW *win, const char *str, int wrap, int n)
	Write a standard c-style string to a window.
int	wmove (WINDOW *win, int y, int x)
	Move a window's cursor to the specified position.
int	curs_set (int visibility)
	Set cursor visibility.

Variables
WINDOW	_stdscr

Detailed Description

MuCurses core functions.

Definition in file mucurses.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

References __nonnull, ch, x, and y.

_wupdcurs()

void _wupdcurs ( WINDOW * win )

static

Update cursor position.

Parameters

*win	window in which to update position

Definition at line 39 of file mucurses.c.

                                      {
        win->scr->movetoyx ( win->scr, win->ori_y + win->curs_y,
                             win->ori_x + win->curs_x );
}

References _curses_window::curs_x, _curses_window::curs_y, _curses_screen::movetoyx, _curses_window::ori_x, _curses_window::ori_y, and _curses_window::scr.

Referenced by _wcursback(), _wputch(), and wmove().

_wputch()

void _wputch	(	WINDOW *	win,
		chtype	ch,
		int	wrap )

Write a single character rendition to a window.

Parameters

*win	window in which to write
ch	character rendition to write
wrap	wrap "switch"

Definition at line 51 of file mucurses.c.

                                                  {
        /* make sure we set the screen cursor to the right position
           first! */
        _wupdcurs(win);
        win->scr->putc(win->scr, ch);
        if ( ++(win->curs_x) - win->width == 0 ) {
                if ( wrap == WRAP ) {
                        win->curs_x = 0;
                        /* specification says we should really scroll,
                           but we have no buffer to scroll with, so we
                           can only overwrite back at the beginning of
                           the window */
                        if ( ++(win->curs_y) - win->height == 0 )
                                win->curs_y = 0;
                } else {
                        (win->curs_x)--;
                }
        }
}

References _wupdcurs(), ch, _curses_window::curs_x, _curses_window::curs_y, _curses_window::height, _curses_screen::putc, _curses_window::scr, _curses_window::width, and WRAP.

Referenced by _printw_handler(), _wgetc(), _wputc(), _wputchstr(), delwin(), slk_restore(), waddch(), wborder(), wgetch(), whline(), and wvline().

_wputc()

void _wputc	(	WINDOW *	win,
		char	c,
		int	wrap )

Write a single character to a window.

Parameters

*win	window in which to write
c	character rendition to write
wrap	wrap "switch"

Definition at line 78 of file mucurses.c.

                                              {
        _wputch ( win, ( ( ( unsigned char ) c ) | win->attrs ), wrap );
}

References _wputch(), and _curses_window::attrs.

Referenced by _wputstr(), wclrtobot(), wclrtoeol(), and wdelch().

_wcursback()

void _wcursback

(

WINDOW *

win

)

Retreat the cursor back one position (useful for a whole host of ops)

Parameters

*win	window in which to retreat

Definition at line 88 of file mucurses.c.

                                {
        if ( win->curs_x == 0 ) {
                if ( win->curs_y == 0 )
                        win->curs_y = win->height - 1;
                win->curs_x = win->width = 1;
        } else {
                win->curs_x--;
        }
 
        _wupdcurs(win);
}

References _wupdcurs(), _curses_window::curs_x, _curses_window::curs_y, _curses_window::height, and _curses_window::width.

Referenced by wdelch(), wgetch(), and wgetnstr().

_wputchstr()

void _wputchstr	(	WINDOW *	win,
		const chtype *	chstr,
		int	wrap,
		int	n )

Write a chtype string to a window.

Parameters

*win	window in which to write
*chstr	chtype string
wrap	wrap "switch"
n	write at most n chtypes

Definition at line 108 of file mucurses.c.

                                                                      {
        for ( ; *chstr && n-- ; chstr++ ) {
                _wputch(win,*chstr,wrap);
        }
}

References _wputch().

Referenced by waddchnstr().

_wputstr()

void _wputstr	(	WINDOW *	win,
		const char *	str,
		int	wrap,
		int	n )

Write a standard c-style string to a window.

Parameters

*win	window in which to write
*str	string
wrap	wrap "switch"
n	write at most n chars from *str

Definition at line 122 of file mucurses.c.

                                                                {
        for ( ; *str && n-- ; str++ ) {
                _wputc ( win, *str, wrap );
        }
}

References _wputc().

Referenced by _print_label(), and waddnstr().

wmove()

int wmove	(	WINDOW *	win,
		int	y,
		int	x )

Move a window's cursor to the specified position.

Parameters

*win	window to be operated on
y	Y position
x	X position

Return values

rc	return status code

Definition at line 136 of file mucurses.c.

                                        {
        /* chech for out-of-bounds errors */
        if ( ( (unsigned)y >= win->height ) ||
             ( (unsigned)x >= win->width ) ) {
                return ERR;
        }
 
        win->curs_y = y;
        win->curs_x = x;
        _wupdcurs(win);
        return OK;
}

References _wupdcurs(), _curses_window::curs_x, _curses_window::curs_y, ERR, _curses_window::height, OK, _curses_window::width, x, and y.

Referenced by _enter_slk(), _restore_curs_pos(), delwin(), move(), mvaddch(), mvaddchnstr(), mvaddchstr(), mvaddnstr(), mvaddstr(), mvdelch(), mvgetch(), mvgetnstr(), mvgetstr(), mvhline(), mvvline(), mvwaddch(), mvwaddchnstr(), mvwaddchstr(), mvwaddnstr(), mvwaddstr(), mvwdelch(), mvwgetch(), mvwgetnstr(), mvwgetstr(), mvwhline(), mvwvline(), wborder(), wdeleteln(), werase(), and wvline().

curs_set()

int curs_set

(

int

visibility

)

Set cursor visibility.

Parameters

visibility

cursor visibility

Definition at line 154 of file mucurses.c.

                                {
        stdscr->scr->cursor ( stdscr->scr, visibility );
        return OK;
}

References OK, and stdscr.

Referenced by endwin(), main_loop(), settings_ui(), and show_menu().

Variable Documentation

_stdscr

WINDOW _stdscr

Initial value:

= {
        .attrs = A_DEFAULT,
        .ori_y = 0,
        .ori_x = 0,
        .curs_y = 0,
        .curs_x = 0,
        .scr = &_ansi_screen,
}

Definition at line 21 of file mucurses.c.

                 {
        .attrs = A_DEFAULT,
        .ori_y = 0,
        .ori_x = 0,
        .curs_y = 0,
        .curs_x = 0,
        .scr = &_ansi_screen,
};