ncurses 4.2
[ncurses.git] / ncurses / lib_slk.c
1 /****************************************************************************
2  * Copyright (c) 1998 Free Software Foundation, Inc.                        *
3  *                                                                          *
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:                 *
11  *                                                                          *
12  * The above copyright notice and this permission notice shall be included  *
13  * in all copies or substantial portions of the Software.                   *
14  *                                                                          *
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.                               *
22  *                                                                          *
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       *
26  * authorization.                                                           *
27  ****************************************************************************/
28
29 /****************************************************************************
30  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
31  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
32  ****************************************************************************/
33
34 /*
35  *      lib_slk.c
36  *      Soft key routines.
37  */
38
39 #include <curses.priv.h>
40
41 #include <ctype.h>
42 #include <term.h>       /* num_labels, label_*, plab_norm */
43
44 MODULE_ID("$Id: lib_slk.c,v 1.14 1998/02/11 12:13:56 tom Exp $")
45
46 /*
47  * We'd like to move these into the screen context structure, but cannot,
48  * because slk_init() is called before initscr()/newterm().
49  */
50 int _nc_slk_format;  /* one more than format specified in slk_init() */
51
52 /*
53  * Paint the info line for the PC style SLK emulation.
54  *
55  */
56 static void
57 slk_paint_info(WINDOW *win)
58 {
59   if (win && _nc_slk_format==4)
60     {
61       int i;
62
63       mvwhline (win,0,0,0,getmaxx(win));
64       wmove (win,0,0);
65
66       for (i = 0; i < SP->_slk->maxlab; i++) {
67         if (win && _nc_slk_format==4)
68           {
69             mvwaddch(win,0,SP->_slk->ent[i].x,'F');
70             if (i<9)
71               waddch(win,'1'+i);
72             else
73               {
74                 waddch(win,'1');
75                 waddch(win,'0' + (i-9));
76               }
77           }
78       }
79     }
80 }
81
82 /*
83  * Initialize soft labels.
84  * Called from newterm()
85  */
86 int
87 _nc_slk_initialize(WINDOW *stwin, int cols)
88 {
89 int i, x;
90 char *p;
91
92         T(("slk_initialize()"));
93
94         if (SP->_slk)
95           { /* we did this already, so simply return */
96             return(OK);
97           }
98         else
99           if ((SP->_slk = typeCalloc(SLK, 1)) == 0)
100             return(ERR);
101
102         SP->_slk->ent    = NULL;
103         SP->_slk->buffer = NULL;
104         SP->_slk->attr   = A_STANDOUT;
105
106 #ifdef num_labels
107         SP->_slk->maxlab = (num_labels > 0) ? num_labels : MAX_SKEY;
108         SP->_slk->maxlen = (num_labels > 0) ? label_width * label_height : MAX_SKEY_LEN;
109         SP->_slk->labcnt = (SP->_slk->maxlab < MAX_SKEY) ? MAX_SKEY : SP->_slk->maxlab;
110 #else
111         SP->_slk->labcnt = SP->_slk->maxlab = MAX_SKEY;
112         SP->_slk->maxlen = MAX_SKEY_LEN;
113 #endif /* num_labels */
114
115         SP->_slk->ent = typeCalloc(slk_ent, SP->_slk->labcnt);
116         if (SP->_slk->ent == NULL)
117           goto exception;
118
119         p = SP->_slk->buffer = (char*) calloc(2*SP->_slk->labcnt,(1+SP->_slk->maxlen));
120         if (SP->_slk->buffer == NULL)
121           goto exception;
122
123         for (i = 0; i < SP->_slk->labcnt; i++) {
124                 SP->_slk->ent[i].text = p;
125                 p += (1 + SP->_slk->maxlen);
126                 SP->_slk->ent[i].form_text = p;
127                 p += (1 + SP->_slk->maxlen);
128                 memset(SP->_slk->ent[i].form_text, ' ', (unsigned)(SP->_slk->maxlen));
129                 SP->_slk->ent[i].visible = (i < SP->_slk->maxlab);
130         }
131         if (_nc_slk_format >= 3) /* PC style */
132           {
133             int gap = (cols - 3 * (3 + 4*SP->_slk->maxlen))/2;
134
135             if (gap < 1)
136               gap = 1;
137
138             for (i = x = 0; i < SP->_slk->maxlab; i++) {
139               SP->_slk->ent[i].x = x;
140               x += SP->_slk->maxlen;
141               x += (i==3 || i==7) ? gap : 1;
142             }
143             if (_nc_slk_format == 4)
144               slk_paint_info (stwin);
145           }
146         else {
147           if (_nc_slk_format == 2) {    /* 4-4 */
148             int gap = cols - (SP->_slk->maxlab * SP->_slk->maxlen) - 6;
149
150             if (gap < 1)
151                         gap = 1;
152             for (i = x = 0; i < SP->_slk->maxlab; i++) {
153               SP->_slk->ent[i].x = x;
154               x += SP->_slk->maxlen;
155               x += (i == 3) ? gap : 1;
156             }
157           }
158           else
159             {
160               if (_nc_slk_format == 1) { /* 1 -> 3-2-3 */
161                 int gap = (cols - (SP->_slk->maxlab * SP->_slk->maxlen) - 5) / 2;
162
163                 if (gap < 1)
164                   gap = 1;
165                 for (i = x = 0; i < SP->_slk->maxlab; i++) {
166                   SP->_slk->ent[i].x = x;
167                   x += SP->_slk->maxlen;
168                   x += (i == 2 || i == 4) ? gap : 1;
169                 }
170               }
171               else
172                 goto exception;
173             }
174         }
175         SP->_slk->dirty = TRUE;
176         if ((SP->_slk->win = stwin) == NULL)
177         {
178         exception:
179                 if (SP->_slk)
180                 {
181                    FreeIfNeeded(SP->_slk->buffer);
182                    FreeIfNeeded(SP->_slk->ent);
183                    free(SP->_slk);
184                    SP->_slk = (SLK*)0;
185                    return(ERR);
186                 }
187         }
188
189         return(OK);
190 }
191
192
193 /*
194  * Restore the soft labels on the screen.
195  */
196 int
197 slk_restore(void)
198 {
199         T((T_CALLED("slk_restore()")));
200
201         if (SP->_slk == NULL)
202                 return(ERR);
203         SP->_slk->hidden = FALSE;
204         SP->_slk->dirty = TRUE;
205         /* we have to repaint info line eventually */
206         slk_paint_info(SP->_slk->win);
207
208         returnCode(slk_refresh());
209 }