1 /****************************************************************************
2 * Copyright (c) 1998-2008,2009 Free Software Foundation, Inc. *
4 * Permission is hereby granted, free of charge, to any person obtaining a *
5 * copy of this software and associated documentation files (the *
6 * "Software"), to deal in the Software without restriction, including *
7 * without limitation the rights to use, copy, modify, merge, publish, *
8 * distribute, distribute with modifications, sublicense, and/or sell *
9 * copies of the Software, and to permit persons to whom the Software is *
10 * furnished to do so, subject to the following conditions: *
12 * The above copyright notice and this permission notice shall be included *
13 * in all copies or substantial portions of the Software. *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
16 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
18 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
19 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
20 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
21 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
23 * Except as contained in this notice, the name(s) of the above copyright *
24 * holders shall not be used in advertising or otherwise to promote the *
25 * sale, use or other dealings in this Software without prior written *
27 ****************************************************************************/
29 /****************************************************************************
31 * Gerhard Fuernkranz 1993 (original) *
32 * Zeyd M. Ben-Halim 1992,1995 (sic) *
34 * Juergen Pfeifer 1996-on *
36 ****************************************************************************/
43 #include <curses.priv.h>
47 #define CUR SP_TERMTYPE
50 MODULE_ID("$Id: lib_slk.c,v 1.40 2009/07/19 00:34:07 tom Exp $")
53 * Free any memory related to soft labels, return an error.
56 slk_failed(NCURSES_SP_DCL0)
58 if ((0 != SP_PARM) && SP_PARM->_slk) {
59 FreeIfNeeded(SP_PARM->_slk->ent);
61 SP_PARM->_slk = (SLK *) 0;
67 _nc_format_slks(NCURSES_SP_DCLx int cols)
72 if (!SP_PARM || !SP_PARM->_slk)
75 max_length = SP_PARM->_slk->maxlen;
76 if (SP_PARM->slk_format >= 3) { /* PC style */
77 gap = (cols - 3 * (3 + 4 * max_length)) / 2;
82 for (i = x = 0; i < SP_PARM->_slk->maxlab; i++) {
83 SP_PARM->_slk->ent[i].ent_x = x;
85 x += (i == 3 || i == 7) ? gap : 1;
88 if (SP_PARM->slk_format == 2) { /* 4-4 */
89 gap = cols - (SP_PARM->_slk->maxlab * max_length) - 6;
93 for (i = x = 0; i < SP_PARM->_slk->maxlab; i++) {
94 SP_PARM->_slk->ent[i].ent_x = x;
96 x += (i == 3) ? gap : 1;
99 if (SP_PARM->slk_format == 1) { /* 1 -> 3-2-3 */
100 gap = (cols - (SP_PARM->_slk->maxlab * max_length) - 5)
105 for (i = x = 0; i < SP_PARM->_slk->maxlab; i++) {
106 SP_PARM->_slk->ent[i].ent_x = x;
108 x += (i == 2 || i == 4) ? gap : 1;
111 returnCode(slk_failed(NCURSES_SP_ARG));
114 SP_PARM->_slk->dirty = TRUE;
120 * Initialize soft labels.
121 * Called from newterm()
124 _nc_slk_initialize(WINDOW *stwin, int cols)
133 T((T_CALLED("_nc_slk_initialize()")));
137 sp = _nc_screen_of(stwin);
141 term = TerminalOf(SP_PARM);
144 numlab = InfoOf(SP_PARM).numlabels;
146 if (SP_PARM->_slk) { /* we did this already, so simply return */
148 } else if ((SP_PARM->_slk = typeCalloc(SLK, 1)) == 0)
151 SP_PARM->_slk->hidden = TRUE;
152 SP_PARM->_slk->ent = NULL;
153 if (!SP_PARM->slk_format)
154 SP_PARM->slk_format = _nc_globals.slk_format;
157 * If we use colors, vidputs() will suppress video attributes that conflict
158 * with colors. In that case, we're still guaranteed that "reverse" would
161 if ((InfoOf(SP_PARM).nocolorvideo & 1) == 0)
162 SetAttr(SP_PARM->_slk->attr, A_STANDOUT);
164 SetAttr(SP_PARM->_slk->attr, A_REVERSE);
166 SP_PARM->_slk->maxlab = ((numlab > 0)
168 : MAX_SKEY(SP_PARM->slk_format));
169 SP_PARM->_slk->maxlen = ((numlab > 0)
170 ? InfoOf(SP_PARM).labelwidth * InfoOf(SP_PARM).labelheight
171 : MAX_SKEY_LEN(SP_PARM->slk_format));
172 SP_PARM->_slk->labcnt = ((SP_PARM->_slk->maxlab < MAX_SKEY(SP_PARM->slk_format))
173 ? MAX_SKEY(SP_PARM->slk_format)
174 : SP_PARM->_slk->maxlab);
176 if (SP_PARM->_slk->maxlen <= 0
177 || SP_PARM->_slk->labcnt <= 0
178 || (SP_PARM->_slk->ent = typeCalloc(slk_ent,
179 (unsigned) SP_PARM->_slk->labcnt))
181 returnCode(slk_failed(NCURSES_SP_ARG));
183 max_length = SP_PARM->_slk->maxlen;
184 for (i = 0; i < SP_PARM->_slk->labcnt; i++) {
185 size_t used = max_length + 1;
187 SP_PARM->_slk->ent[i].ent_text = (char *) _nc_doalloc(0, used);
188 if (SP_PARM->_slk->ent[i].ent_text == 0)
189 returnCode(slk_failed(NCURSES_SP_ARG));
190 memset(SP_PARM->_slk->ent[i].ent_text, 0, used);
192 SP_PARM->_slk->ent[i].form_text = (char *) _nc_doalloc(0, used);
193 if (SP_PARM->_slk->ent[i].form_text == 0)
194 returnCode(slk_failed(NCURSES_SP_ARG));
195 memset(SP_PARM->_slk->ent[i].form_text, 0, used);
197 memset(SP_PARM->_slk->ent[i].form_text, ' ', max_length);
198 SP_PARM->_slk->ent[i].visible = (char) (i < SP_PARM->_slk->maxlab);
201 res = _nc_format_slks(NCURSES_SP_ARGx cols);
203 if ((SP_PARM->_slk->win = stwin) == NULL) {
204 returnCode(slk_failed(NCURSES_SP_ARG));
207 /* We now reset the format so that the next newterm has again
208 * per default no SLK keys and may call slk_init again to
209 * define a new layout. (juergen 03-Mar-1999)
211 _nc_globals.slk_format = 0;
216 * Restore the soft labels on the screen.
219 NCURSES_SP_NAME(slk_restore) (NCURSES_SP_DCL0)
221 T((T_CALLED("slk_restore(%p)"), SP_PARM));
225 if (SP_PARM->_slk == NULL)
227 SP_PARM->_slk->hidden = FALSE;
228 SP_PARM->_slk->dirty = TRUE;
230 returnCode(NCURSES_SP_NAME(slk_refresh) (NCURSES_SP_ARG));
237 return NCURSES_SP_NAME(slk_restore) (CURRENT_SCREEN);