slk.c File Reference

Soft label key functions. More...

#include <curses.h>
#include <stddef.h>
#include <stdlib.h>
#include <string.h>
#include <assert.h>
#include "mucurses.h"
#include "cursor.h"

Go to the source code of this file.

Data Structures
struct	_softlabel
struct	_softlabelkeys

Macros
#define	MIN_SPACE_SIZE   2
#define	SLK_MAX_LABEL_LEN   8
#define	SLK_MAX_NUM_LABELS   12
#define	SLK_MAX_NUM_SPACES   2

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
static void	_enter_slk (void)
static void	_leave_slk (void)
static void	_print_label (struct _softlabel sl)
attr_t	slk_attr (void)
	Return the attribute used for the soft function keys. More...
int	slk_attroff (const chtype attrs)
	Turn off soft function key attributes. More...
int	slk_attron (const chtype attrs)
	Turn on soft function key attributes. More...
int	slk_attrset (const chtype attrs)
	Set soft function key attributes. More...
int	slk_attr_off (const attr_t attrs, void *opts __unused)
	Turn off soft function key attributes. More...
int	slk_attr_on (attr_t attrs, void *opts __unused)
	Turn on soft function key attributes. More...
int	slk_attr_set (const attr_t attrs, short colour_pair_number, void *opts __unused)
	Set soft function key attributes. More...
int	slk_clear (void)
	Clear the soft function key labels from the screen. More...
int	slk_colour (short colour_pair_number)
	Set soft label colour pair. More...
int	slk_init (int fmt)
	Initialise the soft function keys. More...
char *	slk_label (int labnum)
	Return the label for the specified soft key. More...
int	slk_restore (void)
	Restore soft function key labels to the screen. More...
int	slk_set (int labnum, const char *label, int fmt)
	Configure specified soft key. More...

Variables
static struct _softlabelkeys *	slks

Detailed Description

Soft label key functions.

Definition in file slk.c.

Macro Definition Documentation

MIN_SPACE_SIZE

#define MIN_SPACE_SIZE   2

Definition at line 16 of file slk.c.

SLK_MAX_LABEL_LEN

#define SLK_MAX_LABEL_LEN   8

Definition at line 18 of file slk.c.

SLK_MAX_NUM_LABELS

#define SLK_MAX_NUM_LABELS   12

Definition at line 20 of file slk.c.

SLK_MAX_NUM_SPACES

#define SLK_MAX_NUM_SPACES   2

Definition at line 22 of file slk.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

_enter_slk()

static void _enter_slk ( void  )

static

Definition at line 64 of file slk.c.

                                {
        _store_curs_pos ( stdscr, &slks->saved_cursor );
        wattr_get ( stdscr, &slks->saved_attrs, &slks->saved_pair, NULL );
        LINES++;
        wmove ( stdscr, LINES, 0 );
        wattrset ( stdscr, slks->attrs );
}

References _store_curs_pos(), _softlabelkeys::attrs, LINES, NULL, _softlabelkeys::saved_attrs, _softlabelkeys::saved_cursor, _softlabelkeys::saved_pair, slks, stdscr, wattr_get(), wattrset(), and wmove().

Referenced by slk_clear(), and slk_restore().

_leave_slk()

static void _leave_slk ( void  )

static

Definition at line 72 of file slk.c.

                                {
        LINES--;
        wattr_set ( stdscr, slks->saved_attrs, slks->saved_pair, NULL );
        _restore_curs_pos ( stdscr, &slks->saved_cursor );
}

References _restore_curs_pos(), LINES, NULL, _softlabelkeys::saved_attrs, _softlabelkeys::saved_cursor, _softlabelkeys::saved_pair, slks, stdscr, and wattr_set().

Referenced by slk_clear(), and slk_restore().

_print_label()

static void _print_label ( struct _softlabel  sl )

static

Definition at line 78 of file slk.c.

                                                  {
        int space_ch;
        char str[SLK_MAX_LABEL_LEN + 1];

        assert ( slks->max_label_len <= SLK_MAX_LABEL_LEN );
        space_ch = ' ';
        memset ( str, 0, sizeof ( str ) );

        // protect against gaps in the soft label keys array
        if ( ! sl.label[0] ) {
                memset( str, space_ch, (size_t)(slks->max_label_len) );
        } else {
                /* we need to pad the label with varying amounts of leading
                   pad depending on the format of the label */
                if ( sl.fmt == 1 ) {
                        memset( str, space_ch, 
                                (size_t)(slks->max_label_len 
                                         - strlen(sl.label)) / 2 );
                }
                if ( sl.fmt == 2 ) {
                        memset( str, space_ch,
                                (size_t)(slks->max_label_len 
                                         - strlen(sl.label)) );
                }
                strcat(str,sl.label);
                
                // post-padding
                memset(str+strlen(str), space_ch,
                       (size_t)(slks->max_label_len - strlen(str)) );
        }

        // print the formatted label
        _wputstr ( stdscr, str, NOWRAP, slks->max_label_len );
}

References _wputstr(), assert(), _softlabelkeys::max_label_len, memset(), NOWRAP, sl, SLK_MAX_LABEL_LEN, slks, stdscr, strcat(), and strlen().

Referenced by slk_restore().

slk_attr()

attr_t slk_attr

(

void

)

Return the attribute used for the soft function keys.

Return values

attrs

the current attributes of the soft function keys

Definition at line 118 of file slk.c.

                         {
        return ( slks == NULL ? 0 : slks->attrs );
}

References _softlabelkeys::attrs, NULL, and slks.

slk_attroff()

int slk_attroff

(

const chtype

attrs

)

Turn off soft function key attributes.

Parameters

attrs

attribute bit mask

Return values

rc	return status code

Definition at line 128 of file slk.c.

                                       {
        if ( slks == NULL ) 
                return ERR;
        slks->attrs &= ~( attrs & A_ATTRIBUTES );
        return OK;
}

References A_ATTRIBUTES, _softlabelkeys::attrs, ERR, NULL, OK, and slks.

Referenced by slk_attr_off().

slk_attron()

int slk_attron

(

const chtype

attrs

)

Turn on soft function key attributes.

Parameters

attrs

attribute bit mask

Return values

rc	return status code

Definition at line 141 of file slk.c.

                                      {
        if ( slks == NULL )
                return ERR;
        slks->attrs |= ( attrs & A_ATTRIBUTES );
        return OK;
}

References A_ATTRIBUTES, _softlabelkeys::attrs, ERR, NULL, OK, and slks.

Referenced by slk_attr_on().

slk_attrset()

int slk_attrset

(

const chtype

attrs

)

Set soft function key attributes.

Parameters

attrs

attribute bit mask

Return values

rc	return status code

Definition at line 154 of file slk.c.

                                       {
        if ( slks == NULL ) 
                return ERR;
        slks->attrs = ( attrs & A_ATTRIBUTES );
        return OK;
}

References A_ATTRIBUTES, _softlabelkeys::attrs, ERR, NULL, OK, and slks.

slk_attr_off()

int slk_attr_off	(	const attr_t	attrs,
		void *opts	__unused
	)

Turn off soft function key attributes.

Parameters

attrs	attribute bit mask
*opts	undefined (for future implementation)

Return values

rc	return status code

Definition at line 168 of file slk.c.

                                                             {
        return slk_attroff( attrs );
}

References _softlabelkeys::attrs, and slk_attroff().

slk_attr_on()

int slk_attr_on	(	attr_t	attrs,
		void *opts	__unused
	)

Turn on soft function key attributes.

Parameters

attrs	attribute bit mask
*opts	undefined (for future implementation)

Return values

rc	return status code

Definition at line 179 of file slk.c.

                                                      {
        return slk_attron( attrs );
}

References _softlabelkeys::attrs, and slk_attron().

slk_attr_set()

int slk_attr_set	(	const attr_t	attrs,
		short	colour_pair_number,
		void *opts	__unused
	)

Set soft function key attributes.

Parameters

attrs	attribute bit mask
colour_pair_number	colour pair integer
*opts	undefined (for future implementation)

Return values

rc	return status code

Definition at line 191 of file slk.c.

                                         {
        if ( slks == NULL ) 
                return ERR;

        if ( ( unsigned short )colour_pair_number > COLORS )
                return ERR;

        slks->attrs = ( (unsigned short)colour_pair_number << CPAIR_SHIFT ) |
                ( attrs & A_ATTRIBUTES );
        return OK;
}

References A_ATTRIBUTES, _softlabelkeys::attrs, COLORS, CPAIR_SHIFT, ERR, NULL, OK, and slks.

slk_clear()

int slk_clear

(

void

)

Clear the soft function key labels from the screen.

Return values

rc	return status code

Definition at line 209 of file slk.c.

                       {
        if ( slks == NULL )
                return ERR;

        _enter_slk();
        wclrtoeol ( stdscr );
        _leave_slk();

        return OK;
}

References _enter_slk(), _leave_slk(), ERR, NULL, OK, slks, stdscr, and wclrtoeol().

Referenced by slk_refresh().

slk_colour()

int slk_colour

(

short

colour_pair_number

)

Set soft label colour pair.

Definition at line 223 of file slk.c.

                                            {
        if ( slks == NULL ) 
                return ERR;
        if ( ( unsigned short )colour_pair_number > COLORS )
                return ERR;

        slks->attrs = ( (unsigned short)colour_pair_number << CPAIR_SHIFT )
                | ( slks->attrs & A_ATTRIBUTES );

        return OK;
}

References A_ATTRIBUTES, _softlabelkeys::attrs, COLORS, CPAIR_SHIFT, ERR, NULL, OK, and slks.

slk_init()

int slk_init

(

int

fmt

)

Initialise the soft function keys.

Parameters

fmt	format of keys

Return values

rc	return status code

Definition at line 241 of file slk.c.

                         {
        unsigned short nmaj, nmin, nblocks, available_width;

        if ( (unsigned)fmt > 3 ) {
                return ERR;
        }

        /* There seems to be no API call to free this data structure... */
        if ( ! slks )
                slks = calloc(1,sizeof(*slks));
        if ( ! slks )
                return ERR;

        slks->attrs = A_DEFAULT;
        slks->fmt = fmt;
        switch(fmt) {
        case 0:
                nblocks = 8; nmaj = 2; nmin = 5;
                slks->spaces[0] = 2; slks->spaces[1] = 4;
                break;
        case 1:
                nblocks = 8; nmaj = 1; nmin = 6;
                slks->spaces[0] = 3;
                break;
        case 2:
                // same allocations as format 3
        case 3:
                nblocks = 12; nmaj = 2; nmin = 9;
                slks->spaces[0] = 3; slks->spaces[1] = 7;
                break;
        default:
                return ERR;
        }

        // determine maximum label length and major space size
        available_width = COLS - ( ( MIN_SPACE_SIZE * nmaj ) + nmin );
        slks->max_label_len = available_width / nblocks;
        slks->maj_space_len = MIN_SPACE_SIZE + 
                ( available_width % nblocks ) / nmaj;
        slks->num_spaces = nmaj;
        slks->num_labels = nblocks;

        // strip a line from the screen
        LINES -= 1;

        return OK;
}

References A_DEFAULT, _softlabelkeys::attrs, calloc(), COLS, ERR, _softlabelkeys::fmt, fmt, LINES, _softlabelkeys::maj_space_len, _softlabelkeys::max_label_len, MIN_SPACE_SIZE, _softlabelkeys::num_labels, _softlabelkeys::num_spaces, OK, slks, and _softlabelkeys::spaces.

slk_label()

char* slk_label

(

int

labnum

)

Return the label for the specified soft key.

Parameters

labnum

soft key identifier

Return values

label

return label

Definition at line 295 of file slk.c.

                               {
        if ( slks == NULL ) 
                return NULL;

        return slks->fkeys[labnum].label;
}

References _softlabelkeys::fkeys, _softlabel::label, NULL, and slks.

slk_restore()

int slk_restore

(

void

)

Restore soft function key labels to the screen.

Return values

rc	return status code

Definition at line 307 of file slk.c.

                         {
        unsigned int i, j, pos_x,
                *next_space, *last_space;
        chtype space_ch;

        if ( slks == NULL )
                return ERR;

        pos_x = 0;

        _enter_slk();

        space_ch = (chtype)' ' | slks->attrs;
        next_space = &(slks->spaces[0]);
        last_space = &(slks->spaces[slks->num_spaces-1]);

        for ( i = 0; i < slks->num_labels ; i++ ) {
                _print_label( slks->fkeys[i] );
                pos_x += slks->max_label_len;

                if ( i == *next_space ) {
                        for ( j = 0; j < slks->maj_space_len; j++, pos_x++ )
                                _wputch ( stdscr, space_ch, NOWRAP );
                        if ( next_space < last_space )
                                next_space++;
                } else {
                        if ( pos_x < COLS )
                                _wputch ( stdscr, space_ch, NOWRAP );
                        pos_x++;
                }
        }

        _leave_slk();

        return OK;
}

References _enter_slk(), _leave_slk(), _print_label(), _wputch(), _softlabelkeys::attrs, COLS, ERR, _softlabelkeys::fkeys, _softlabelkeys::maj_space_len, _softlabelkeys::max_label_len, NOWRAP, NULL, _softlabelkeys::num_labels, _softlabelkeys::num_spaces, OK, slks, _softlabelkeys::spaces, and stdscr.

Referenced by slk_refresh().

slk_set()

int slk_set	(	int	labnum,
		const char *	label,
		int	fmt
	)

Configure specified soft key.

Parameters

labnum	soft label position to configure
*label	string to use as soft key label
fmt	justification format of label

Return values

rc	return status code

Definition at line 352 of file slk.c.

                                                       {
        if ( slks == NULL ) 
                return ERR;
        if ( (unsigned short)labnum >= slks->num_labels )
                return ERR;
        if ( (unsigned short)fmt >= 3 )
                return ERR;

        strncpy(slks->fkeys[labnum].label, label,
                (sizeof(slks->fkeys[labnum].label) - 1));
        slks->fkeys[labnum].fmt = fmt;

        return OK;
}

References ERR, _softlabelkeys::fkeys, _softlabel::fmt, fmt, _softlabel::label, NULL, _softlabelkeys::num_labels, OK, slks, and strncpy().

Variable Documentation

slks

struct _softlabelkeys* slks

static

Definition at line 55 of file slk.c.

Referenced by _enter_slk(), _leave_slk(), _print_label(), slk_attr(), slk_attr_set(), slk_attroff(), slk_attron(), slk_attrset(), slk_clear(), slk_colour(), slk_init(), slk_label(), slk_restore(), and slk_set().