10e3d5408SPeter Wemm /****************************************************************************
2d8977eafSRong-En Fan * Copyright 2020 Thomas E. Dickey *
30e3d5408SPeter Wemm * Copyright 1998-2010,2011 Free Software Foundation, Inc. *
40e3d5408SPeter Wemm * *
50e3d5408SPeter Wemm * Permission is hereby granted, free of charge, to any person obtaining a *
60e3d5408SPeter Wemm * copy of this software and associated documentation files (the *
70e3d5408SPeter Wemm * "Software"), to deal in the Software without restriction, including *
80e3d5408SPeter Wemm * without limitation the rights to use, copy, modify, merge, publish, *
90e3d5408SPeter Wemm * distribute, distribute with modifications, sublicense, and/or sell *
100e3d5408SPeter Wemm * copies of the Software, and to permit persons to whom the Software is *
110e3d5408SPeter Wemm * furnished to do so, subject to the following conditions: *
120e3d5408SPeter Wemm * *
130e3d5408SPeter Wemm * The above copyright notice and this permission notice shall be included *
140e3d5408SPeter Wemm * in all copies or substantial portions of the Software. *
150e3d5408SPeter Wemm * *
160e3d5408SPeter Wemm * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
170e3d5408SPeter Wemm * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
180e3d5408SPeter Wemm * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
190e3d5408SPeter Wemm * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
200e3d5408SPeter Wemm * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
210e3d5408SPeter Wemm * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
220e3d5408SPeter Wemm * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
230e3d5408SPeter Wemm * *
240e3d5408SPeter Wemm * Except as contained in this notice, the name(s) of the above copyright *
250e3d5408SPeter Wemm * holders shall not be used in advertising or otherwise to promote the *
260e3d5408SPeter Wemm * sale, use or other dealings in this Software without prior written *
270e3d5408SPeter Wemm * authorization. *
280e3d5408SPeter Wemm ****************************************************************************/
290e3d5408SPeter Wemm
304a1a9510SRong-En Fan /****************************************************************************
314a1a9510SRong-En Fan * Authors: *
324a1a9510SRong-En Fan * Gerhard Fuernkranz 1993 (original) *
334a1a9510SRong-En Fan * Zeyd M. Ben-Halim 1992,1995 (sic) *
344a1a9510SRong-En Fan * Eric S. Raymond *
354a1a9510SRong-En Fan * Juergen Pfeifer 1996-on *
360e3d5408SPeter Wemm * Thomas E. Dickey *
370e3d5408SPeter Wemm ****************************************************************************/
380e3d5408SPeter Wemm
390e3d5408SPeter Wemm /*
400e3d5408SPeter Wemm * lib_slk.c
410e3d5408SPeter Wemm * Soft key routines.
420e3d5408SPeter Wemm */
430e3d5408SPeter Wemm
440e3d5408SPeter Wemm #include <curses.priv.h>
450e3d5408SPeter Wemm #include <ctype.h>
460e3d5408SPeter Wemm
470e3d5408SPeter Wemm #ifndef CUR
48d8977eafSRong-En Fan #define CUR SP_TERMTYPE
490e3d5408SPeter Wemm #endif
500e3d5408SPeter Wemm
510e3d5408SPeter Wemm MODULE_ID("$Id: lib_slk.c,v 1.49 2020/02/02 23:34:34 tom Exp $")
520e3d5408SPeter Wemm
530e3d5408SPeter Wemm #ifdef USE_TERM_DRIVER
547a69bbfbSPeter Wemm #define NumLabels InfoOf(SP_PARM).numlabels
557a69bbfbSPeter Wemm #define NoColorVideo InfoOf(SP_PARM).nocolorvideo
560e3d5408SPeter Wemm #define LabelWidth InfoOf(SP_PARM).labelwidth
570e3d5408SPeter Wemm #define LabelHeight InfoOf(SP_PARM).labelheight
580e3d5408SPeter Wemm #else
590e3d5408SPeter Wemm #define NumLabels num_labels
600e3d5408SPeter Wemm #define NoColorVideo no_color_video
610e3d5408SPeter Wemm #define LabelWidth label_width
620e3d5408SPeter Wemm #define LabelHeight label_height
637a69bbfbSPeter Wemm #endif
640e3d5408SPeter Wemm
650e3d5408SPeter Wemm /*
660e3d5408SPeter Wemm * Free any memory related to soft labels, return an error.
670e3d5408SPeter Wemm */
680e3d5408SPeter Wemm static int
slk_failed(NCURSES_SP_DCL0)690e3d5408SPeter Wemm slk_failed(NCURSES_SP_DCL0)
704a1a9510SRong-En Fan {
710e3d5408SPeter Wemm if ((0 != SP_PARM) && SP_PARM->_slk) {
720e3d5408SPeter Wemm FreeIfNeeded(SP_PARM->_slk->ent);
730e3d5408SPeter Wemm free(SP_PARM->_slk);
744a1a9510SRong-En Fan SP_PARM->_slk = (SLK *) 0;
754a1a9510SRong-En Fan }
764a1a9510SRong-En Fan return ERR;
774a1a9510SRong-En Fan }
784a1a9510SRong-En Fan
794a1a9510SRong-En Fan NCURSES_EXPORT(int)
_nc_format_slks(NCURSES_SP_DCLx int cols)804a1a9510SRong-En Fan _nc_format_slks(NCURSES_SP_DCLx int cols)
814a1a9510SRong-En Fan {
824a1a9510SRong-En Fan int gap, i, x;
834a1a9510SRong-En Fan int max_length;
844a1a9510SRong-En Fan
850e3d5408SPeter Wemm if (!SP_PARM || !SP_PARM->_slk)
864a1a9510SRong-En Fan return ERR;
870e3d5408SPeter Wemm
880e3d5408SPeter Wemm max_length = SP_PARM->_slk->maxlen;
890e3d5408SPeter Wemm if (SP_PARM->slk_format >= 3) { /* PC style */
900e3d5408SPeter Wemm gap = (cols - 3 * (3 + 4 * max_length)) / 2;
910e3d5408SPeter Wemm
920e3d5408SPeter Wemm if (gap < 1)
937a69bbfbSPeter Wemm gap = 1;
940e3d5408SPeter Wemm
950e3d5408SPeter Wemm for (i = x = 0; i < SP_PARM->_slk->maxlab; i++) {
960e3d5408SPeter Wemm SP_PARM->_slk->ent[i].ent_x = x;
970e3d5408SPeter Wemm x += max_length;
984a1a9510SRong-En Fan x += (i == 3 || i == 7) ? gap : 1;
990e3d5408SPeter Wemm }
1004a1a9510SRong-En Fan } else {
1010e3d5408SPeter Wemm if (SP_PARM->slk_format == 2) { /* 4-4 */
1027a69bbfbSPeter Wemm gap = cols - (int) (SP_PARM->_slk->maxlab * max_length) - 6;
1034a1a9510SRong-En Fan
1047a69bbfbSPeter Wemm if (gap < 1)
1054a1a9510SRong-En Fan gap = 1;
1060e3d5408SPeter Wemm for (i = x = 0; i < SP_PARM->_slk->maxlab; i++) {
1070e3d5408SPeter Wemm SP_PARM->_slk->ent[i].ent_x = x;
1080e3d5408SPeter Wemm x += max_length;
1094a1a9510SRong-En Fan x += (i == 3) ? gap : 1;
1104a1a9510SRong-En Fan }
1114a1a9510SRong-En Fan } else {
1124a1a9510SRong-En Fan if (SP_PARM->slk_format == 1) { /* 1 -> 3-2-3 */
1134a1a9510SRong-En Fan gap = (cols - (SP_PARM->_slk->maxlab * max_length) - 5)
1144a1a9510SRong-En Fan / 2;
1154a1a9510SRong-En Fan
1164a1a9510SRong-En Fan if (gap < 1)
1174a1a9510SRong-En Fan gap = 1;
1180e3d5408SPeter Wemm for (i = x = 0; i < SP_PARM->_slk->maxlab; i++) {
1194a1a9510SRong-En Fan SP_PARM->_slk->ent[i].ent_x = x;
1204a1a9510SRong-En Fan x += max_length;
121d8977eafSRong-En Fan x += (i == 2 || i == 4) ? gap : 1;
1224a1a9510SRong-En Fan }
1234a1a9510SRong-En Fan } else {
124d8977eafSRong-En Fan return slk_failed(NCURSES_SP_ARG);
125d8977eafSRong-En Fan }
126d8977eafSRong-En Fan }
1274a1a9510SRong-En Fan }
1280e3d5408SPeter Wemm SP_PARM->_slk->dirty = TRUE;
1294a1a9510SRong-En Fan
1304a1a9510SRong-En Fan return OK;
1314a1a9510SRong-En Fan }
1324a1a9510SRong-En Fan
1334a1a9510SRong-En Fan /*
1340e3d5408SPeter Wemm * Initialize soft labels.
1354a1a9510SRong-En Fan * Called from newterm()
1360e3d5408SPeter Wemm */
1374a1a9510SRong-En Fan NCURSES_EXPORT(int)
_nc_slk_initialize(WINDOW * stwin,int cols)1384a1a9510SRong-En Fan _nc_slk_initialize(WINDOW *stwin, int cols)
1394a1a9510SRong-En Fan {
1404a1a9510SRong-En Fan int i;
1414a1a9510SRong-En Fan int res = OK;
1424a1a9510SRong-En Fan size_t max_length;
1434a1a9510SRong-En Fan SCREEN *sp;
1444a1a9510SRong-En Fan int numlab;
1454a1a9510SRong-En Fan
1464a1a9510SRong-En Fan T((T_CALLED("_nc_slk_initialize()")));
1474a1a9510SRong-En Fan
1480e3d5408SPeter Wemm assert(stwin);
1490e3d5408SPeter Wemm
150d8977eafSRong-En Fan sp = _nc_screen_of(stwin);
1514a1a9510SRong-En Fan if (0 == sp)
1520e3d5408SPeter Wemm returnCode(ERR);
1530e3d5408SPeter Wemm
1540e3d5408SPeter Wemm assert(TerminalOf(SP_PARM));
1550e3d5408SPeter Wemm
1560e3d5408SPeter Wemm numlab = NumLabels;
1574a1a9510SRong-En Fan
1584a1a9510SRong-En Fan if (SP_PARM->_slk) { /* we did this already, so simply return */
1590e3d5408SPeter Wemm returnCode(OK);
1600e3d5408SPeter Wemm } else if ((SP_PARM->_slk = typeCalloc(SLK, 1)) == 0)
1610e3d5408SPeter Wemm returnCode(ERR);
1627a69bbfbSPeter Wemm
163d8977eafSRong-En Fan if (!SP_PARM->slk_format)
1644a1a9510SRong-En Fan SP_PARM->slk_format = _nc_globals.slk_format;
1650e3d5408SPeter Wemm
1660e3d5408SPeter Wemm /*
1670e3d5408SPeter Wemm * If we use colors, vidputs() will suppress video attributes that conflict
1680e3d5408SPeter Wemm * with colors. In that case, we're still guaranteed that "reverse" would
1694a1a9510SRong-En Fan * work.
1704a1a9510SRong-En Fan */
1710e3d5408SPeter Wemm if ((NoColorVideo & 1) == 0)
1720e3d5408SPeter Wemm SetAttr(SP_PARM->_slk->attr, A_STANDOUT);
1737a69bbfbSPeter Wemm else
174d8977eafSRong-En Fan SetAttr(SP_PARM->_slk->attr, A_REVERSE);
1754a1a9510SRong-En Fan
1767a69bbfbSPeter Wemm SP_PARM->_slk->maxlab = (short) ((numlab > 0)
1770e3d5408SPeter Wemm ? numlab
1780e3d5408SPeter Wemm : MAX_SKEY(SP_PARM->slk_format));
1790e3d5408SPeter Wemm SP_PARM->_slk->maxlen = (short) ((numlab > 0)
1800e3d5408SPeter Wemm ? LabelWidth * LabelHeight
1814a1a9510SRong-En Fan : MAX_SKEY_LEN(SP_PARM->slk_format));
1824a1a9510SRong-En Fan SP_PARM->_slk->labcnt = (short) ((SP_PARM->_slk->maxlab < MAX_SKEY(SP_PARM->slk_format))
1830e3d5408SPeter Wemm ? MAX_SKEY(SP_PARM->slk_format)
1840e3d5408SPeter Wemm : SP_PARM->_slk->maxlab);
1857a69bbfbSPeter Wemm
1864a1a9510SRong-En Fan if (SP_PARM->_slk->maxlen <= 0
1870e3d5408SPeter Wemm || SP_PARM->_slk->labcnt <= 0
1880e3d5408SPeter Wemm || (SP_PARM->_slk->ent = typeCalloc(slk_ent,
1890e3d5408SPeter Wemm (size_t) SP_PARM->_slk->labcnt))
1907a69bbfbSPeter Wemm == NULL)
1914a1a9510SRong-En Fan returnCode(slk_failed(NCURSES_SP_ARG));
1920e3d5408SPeter Wemm
1930e3d5408SPeter Wemm max_length = (size_t) SP_PARM->_slk->maxlen;
1940e3d5408SPeter Wemm for (i = 0; i < SP_PARM->_slk->labcnt; i++) {
1950e3d5408SPeter Wemm size_t used = max_length + 1;
1960e3d5408SPeter Wemm
1970e3d5408SPeter Wemm SP_PARM->_slk->ent[i].ent_text = (char *) _nc_doalloc(0, used);
198d8977eafSRong-En Fan if (SP_PARM->_slk->ent[i].ent_text == 0)
199d8977eafSRong-En Fan returnCode(slk_failed(NCURSES_SP_ARG));
2004a1a9510SRong-En Fan memset(SP_PARM->_slk->ent[i].ent_text, 0, used);
2010e3d5408SPeter Wemm
2020e3d5408SPeter Wemm SP_PARM->_slk->ent[i].form_text = (char *) _nc_doalloc(0, used);
2030e3d5408SPeter Wemm if (SP_PARM->_slk->ent[i].form_text == 0)
2040e3d5408SPeter Wemm returnCode(slk_failed(NCURSES_SP_ARG));
2050e3d5408SPeter Wemm
2067a69bbfbSPeter Wemm if (used > 1) {
2070e3d5408SPeter Wemm memset(SP_PARM->_slk->ent[i].form_text, ' ', used - 1);
2080e3d5408SPeter Wemm }
2090e3d5408SPeter Wemm SP_PARM->_slk->ent[i].form_text[used - 1] = '\0';
2100e3d5408SPeter Wemm
2110e3d5408SPeter Wemm SP_PARM->_slk->ent[i].visible = (char) (i < SP_PARM->_slk->maxlab);
2120e3d5408SPeter Wemm }
2130e3d5408SPeter Wemm
2140e3d5408SPeter Wemm res = _nc_format_slks(NCURSES_SP_ARGx cols);
2150e3d5408SPeter Wemm
2160e3d5408SPeter Wemm if ((SP_PARM->_slk->win = stwin) == NULL) {
2170e3d5408SPeter Wemm returnCode(slk_failed(NCURSES_SP_ARG));
2180e3d5408SPeter Wemm }
2190e3d5408SPeter Wemm
220 /* We now reset the format so that the next newterm has again
221 * per default no SLK keys and may call slk_init again to
222 * define a new layout. (juergen 03-Mar-1999)
223 */
224 _nc_globals.slk_format = 0;
225 returnCode(res);
226 }
227
228 /*
229 * Restore the soft labels on the screen.
230 */
231 NCURSES_EXPORT(int)
NCURSES_SP_NAME(slk_restore)232 NCURSES_SP_NAME(slk_restore) (NCURSES_SP_DCL0)
233 {
234 T((T_CALLED("slk_restore(%p)"), (void *) SP_PARM));
235
236 if (0 == SP_PARM)
237 returnCode(ERR);
238 if (SP_PARM->_slk == NULL)
239 returnCode(ERR);
240 SP_PARM->_slk->hidden = FALSE;
241 SP_PARM->_slk->dirty = TRUE;
242
243 returnCode(NCURSES_SP_NAME(slk_refresh) (NCURSES_SP_ARG));
244 }
245
246 #if NCURSES_SP_FUNCS
247 NCURSES_EXPORT(int)
slk_restore(void)248 slk_restore(void)
249 {
250 return NCURSES_SP_NAME(slk_restore) (CURRENT_SCREEN);
251 }
252 #endif
253