mucurses.h File Reference

MuCurses core implementation specific header file. More...

Go to the source code of this file.

Macros
#define	WRAP   0
#define	NOWRAP   1

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
void	_wputch (WINDOW *win, chtype ch, int wrap) __nonnull
	Write a single character rendition to a window.
void	_wputc (WINDOW *win, char c, int wrap) __nonnull
	Write a single character to a window.
void	_wputchstr (WINDOW *win, const chtype *chstr, int wrap, int n) __nonnull
	Write a chtype string to a window.
void	_wputstr (WINDOW *win, const char *str, int wrap, int n) __nonnull
	Write a standard c-style string to a window.
void	_wcursback (WINDOW *win) __nonnull
	Retreat the cursor back one position (useful for a whole host of ops)

Variables
SCREEN	_ansi_screen

Detailed Description

MuCurses core implementation specific header file.

Definition in file mucurses.h.

Macro Definition Documentation

WRAP

#define WRAP   0

Definition at line 13 of file mucurses.h.

Referenced by _printw_handler(), _wgetc(), _wputch(), delwin(), waddch(), waddnstr(), wborder(), wclrtobot(), wclrtoeol(), and wgetch().

NOWRAP

#define NOWRAP   1

Definition at line 14 of file mucurses.h.

Referenced by _print_label(), slk_restore(), waddchnstr(), wborder(), wdelch(), whline(), and wvline().

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

_wputch()

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

extern

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 )

extern

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().

_wputchstr()

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

extern

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 )

extern

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().

_wcursback()

void _wcursback ( WINDOW * win )

extern

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().

Variable Documentation

_ansi_screen

SCREEN _ansi_screen

extern

Definition at line 94 of file ansi_screen.c.

                      {
        .init           = ansiscr_init,
        .exit           = ansiscr_exit,
        .erase          = ansiscr_erase,
        .movetoyx       = ansiscr_movetoyx,
        .putc           = ansiscr_putc,
        .getc           = ansiscr_getc,
        .peek           = ansiscr_peek,
        .cursor         = ansiscr_cursor,
};