ncurses 6.2 - patch 20210403
[ncurses.git] / menu / m_post.c
1 /****************************************************************************
2  * Copyright 2020,2021 Thomas E. Dickey                                     *
3  * Copyright 1998-2010,2012 Free Software Foundation, Inc.                  *
4  *                                                                          *
5  * Permission is hereby granted, free of charge, to any person obtaining a  *
6  * copy of this software and associated documentation files (the            *
7  * "Software"), to deal in the Software without restriction, including      *
8  * without limitation the rights to use, copy, modify, merge, publish,      *
9  * distribute, distribute with modifications, sublicense, and/or sell       *
10  * copies of the Software, and to permit persons to whom the Software is    *
11  * furnished to do so, subject to the following conditions:                 *
12  *                                                                          *
13  * The above copyright notice and this permission notice shall be included  *
14  * in all copies or substantial portions of the Software.                   *
15  *                                                                          *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23  *                                                                          *
24  * Except as contained in this notice, the name(s) of the above copyright   *
25  * holders shall not be used in advertising or otherwise to promote the     *
26  * sale, use or other dealings in this Software without prior written       *
27  * authorization.                                                           *
28  ****************************************************************************/
29
30 /****************************************************************************
31  *   Author:  Juergen Pfeifer, 1995,1997                                    *
32  ****************************************************************************/
33
34 /***************************************************************************
35 * Module m_post                                                            *
36 * Write or erase menus from associated subwindows                          *
37 ***************************************************************************/
38
39 #include "menu.priv.h"
40
41 MODULE_ID("$Id: m_post.c,v 1.35 2021/03/27 23:46:29 tom Exp $")
42
43 /*---------------------------------------------------------------------------
44 |   Facility      :  libnmenu
45 |   Function      :  void _nc_Post_Item(MENU *menu, ITEM *item)
46 |
47 |   Description   :  Draw the item in the menus window at the current
48 |                    window position
49 |
50 |   Return Values :  -
51 +--------------------------------------------------------------------------*/
52 MENU_EXPORT(void)
53 _nc_Post_Item(const MENU *menu, const ITEM *item)
54 {
55   int i;
56   chtype ch;
57   int item_x, item_y;
58   int count = 0;
59   bool isfore = FALSE, isback = FALSE, isgrey = FALSE;
60   int name_len;
61
62   assert(menu->win);
63
64   getyx(menu->win, item_y, item_x);
65
66   /* We need a marker iff
67      - it is a onevalued menu and it is the current item
68      - or it has a selection value
69    */
70   wattron(menu->win, (int)menu->back);
71   if (item->value || (item == menu->curitem))
72     {
73       if (menu->marklen)
74         {
75           /* In a multi selection menu we use the fore attribute
76              for a selected marker that is not the current one.
77              This improves visualization of the menu, because now
78              always the 'normal' marker denotes the current
79              item. */
80           if (!(menu->opt & O_ONEVALUE) && item->value && item != menu->curitem)
81             {
82               wattron(menu->win, (int)menu->fore);
83               isfore = TRUE;
84             }
85           waddstr(menu->win, menu->mark);
86           if (isfore)
87             {
88               wattron(menu->win, (int)menu->fore);
89               isfore = FALSE;
90             }
91         }
92     }
93   else                          /* otherwise we have to wipe out the marker area */
94     for (ch = ' ', i = menu->marklen; i > 0; i--)
95       waddch(menu->win, ch);
96   wattroff(menu->win, (int)menu->back);
97   count += menu->marklen;
98
99   /* First we have to calculate the attribute depending on selectability
100      and selection status
101    */
102   if (!(item->opt & O_SELECTABLE))
103     {
104       wattron(menu->win, (int)menu->grey);
105       isgrey = TRUE;
106     }
107   else
108     {
109       if (item->value || item == menu->curitem)
110         {
111           wattron(menu->win, (int)menu->fore);
112           isfore = TRUE;
113         }
114       else
115         {
116           wattron(menu->win, (int)menu->back);
117           isback = TRUE;
118         }
119     }
120
121   waddnstr(menu->win, item->name.str, item->name.length);
122   name_len = _nc_Calculate_Text_Width(&(item->name));
123   for (ch = ' ', i = menu->namelen - name_len; i > 0; i--)
124     {
125       waddch(menu->win, ch);
126     }
127   count += menu->namelen;
128
129   /* Show description if required and available */
130   if ((menu->opt & O_SHOWDESC) && menu->desclen > 0)
131     {
132       int m = menu->spc_desc / 2;
133       int cy = -1, cx = -1;
134       int desc_len;
135
136       for (ch = ' ', i = 0; i < menu->spc_desc; i++)
137         {
138           if (i == m)
139             {
140               waddch(menu->win, menu->pad);
141               getyx(menu->win, cy, cx);
142             }
143           else
144             waddch(menu->win, ch);
145         }
146       if (item->description.length)
147         waddnstr(menu->win, item->description.str, item->description.length);
148       desc_len = _nc_Calculate_Text_Width(&(item->description));
149       for (ch = ' ', i = menu->desclen - desc_len; i > 0; i--)
150         {
151           waddch(menu->win, ch);
152         }
153       count += menu->desclen + menu->spc_desc;
154
155       if (menu->spc_rows > 1)
156         {
157           int j, k, ncy, ncx;
158
159           assert(cx >= 0 && cy >= 0);
160           getyx(menu->win, ncy, ncx);
161           if (isgrey)
162             wattroff(menu->win, (int)menu->grey);
163           else if (isfore)
164             wattroff(menu->win, (int)menu->fore);
165           wattron(menu->win, (int)menu->back);
166           for (j = 1; j < menu->spc_rows; j++)
167             {
168               if ((item_y + j) < getmaxy(menu->win))
169                 {
170                   wmove(menu->win, item_y + j, item_x);
171                   for (k = 0; k < count; k++)
172                     waddch(menu->win, ' ');
173                 }
174               if ((cy + j) < getmaxy(menu->win))
175                 (void)mvwaddch(menu->win, cy + j, cx - 1, menu->pad);
176             }
177           wmove(menu->win, ncy, ncx);
178           if (!isback)
179             wattroff(menu->win, (int)menu->back);
180         }
181     }
182
183   /* Remove attributes */
184   if (isfore)
185     wattroff(menu->win, (int)menu->fore);
186   if (isback)
187     wattroff(menu->win, (int)menu->back);
188   if (isgrey)
189     wattroff(menu->win, (int)menu->grey);
190 }
191
192 /*---------------------------------------------------------------------------
193 |   Facility      :  libnmenu
194 |   Function      :  void _nc_Draw_Menu(const MENU *)
195 |
196 |   Description   :  Display the menu in its windows
197 |
198 |   Return Values :  -
199 +--------------------------------------------------------------------------*/
200 MENU_EXPORT(void)
201 _nc_Draw_Menu(const MENU *menu)
202 {
203   ITEM *item = menu->items[0];
204   ITEM *lastvert;
205   ITEM *hitem;
206   int y = 0;
207   chtype s_bkgd;
208
209   assert(item && menu->win);
210
211   s_bkgd = getbkgd(menu->win);
212   wbkgdset(menu->win, menu->back);
213   werase(menu->win);
214   wbkgdset(menu->win, s_bkgd);
215
216   lastvert = (menu->opt & O_NONCYCLIC) ? (ITEM *)0 : item;
217
218   do
219     {
220       ITEM *lasthor;
221
222       wmove(menu->win, y, 0);
223
224       hitem = item;
225       lasthor = (menu->opt & O_NONCYCLIC) ? (ITEM *)0 : hitem;
226
227       do
228         {
229           _nc_Post_Item(menu, hitem);
230
231           wattron(menu->win, (int)menu->back);
232           if (((hitem = hitem->right) != lasthor) && hitem)
233             {
234               int i, j, cy, cx;
235               chtype ch = ' ';
236
237               getyx(menu->win, cy, cx);
238               for (j = 0; j < menu->spc_rows; j++)
239                 {
240                   wmove(menu->win, cy + j, cx);
241                   for (i = 0; i < menu->spc_cols; i++)
242                     {
243                       waddch(menu->win, ch);
244                     }
245                 }
246               wmove(menu->win, cy, cx + menu->spc_cols);
247             }
248         }
249       while (hitem && (hitem != lasthor));
250       wattroff(menu->win, (int)menu->back);
251
252       item = item->down;
253       y += menu->spc_rows;
254
255     }
256   while (item && (item != lastvert));
257 }
258
259 /*---------------------------------------------------------------------------
260 |   Facility      :  libnmenu
261 |   Function      :  int post_menu(MENU* menu)
262 |
263 |   Description   :  Post a menu to the screen. This makes it visible.
264 |
265 |   Return Values :  E_OK                - success
266 |                    E_BAD_ARGUMENT      - not a valid menu pointer
267 |                    E_SYSTEM_ERROR      - error in lower layers
268 |                    E_NOT_CONNECTED     - No items connected to menu
269 |                    E_BAD_STATE         - Menu in userexit routine
270 |                    E_POSTED            - Menu already posted
271 +--------------------------------------------------------------------------*/
272 MENU_EXPORT(int)
273 post_menu(MENU *menu)
274 {
275   T((T_CALLED("post_menu(%p)"), (void *)menu));
276
277   if (!menu)
278     RETURN(E_BAD_ARGUMENT);
279
280   if (menu->status & _IN_DRIVER)
281     RETURN(E_BAD_STATE);
282
283   if (menu->status & _POSTED)
284     RETURN(E_POSTED);
285
286   if (menu->items && *(menu->items))
287     {
288       int h = 1 + menu->spc_rows * (menu->rows - 1);
289
290       WINDOW *win = Get_Menu_Window(menu);
291       int maxy = getmaxy(win);
292
293       if ((menu->win = newpad(h, menu->width)))
294         {
295           int y = (maxy >= h) ? h : maxy;
296
297           if (y >= menu->height)
298             y = menu->height;
299           if (!(menu->sub = subpad(menu->win, y, menu->width, 0, 0)))
300             RETURN(E_SYSTEM_ERROR);
301         }
302       else
303         RETURN(E_SYSTEM_ERROR);
304
305       if (menu->status & _LINK_NEEDED)
306         _nc_Link_Items(menu);
307     }
308   else
309     RETURN(E_NOT_CONNECTED);
310
311   SetStatus(menu, _POSTED);
312
313   if (!(menu->opt & O_ONEVALUE))
314     {
315       ITEM **items;
316
317       for (items = menu->items; *items; items++)
318         {
319           (*items)->value = FALSE;
320         }
321     }
322
323   _nc_Draw_Menu(menu);
324
325   Call_Hook(menu, menuinit);
326   Call_Hook(menu, iteminit);
327
328   _nc_Show_Menu(menu);
329
330   RETURN(E_OK);
331 }
332
333 /*---------------------------------------------------------------------------
334 |   Facility      :  libnmenu
335 |   Function      :  int unpost_menu(MENU*)
336 |
337 |   Description   :  Detach menu from screen
338 |
339 |   Return Values :  E_OK              - success
340 |                    E_BAD_ARGUMENT    - not a valid menu pointer
341 |                    E_BAD_STATE       - menu in userexit routine
342 |                    E_NOT_POSTED      - menu is not posted
343 +--------------------------------------------------------------------------*/
344 MENU_EXPORT(int)
345 unpost_menu(MENU *menu)
346 {
347   WINDOW *win;
348
349   T((T_CALLED("unpost_menu(%p)"), (void *)menu));
350
351   if (!menu)
352     RETURN(E_BAD_ARGUMENT);
353
354   if (menu->status & _IN_DRIVER)
355     RETURN(E_BAD_STATE);
356
357   if (!(menu->status & _POSTED))
358     RETURN(E_NOT_POSTED);
359
360   Call_Hook(menu, itemterm);
361   Call_Hook(menu, menuterm);
362
363   win = Get_Menu_Window(menu);
364   werase(win);
365   wsyncup(win);
366
367   assert(menu->sub);
368   delwin(menu->sub);
369   menu->sub = (WINDOW *)0;
370
371   assert(menu->win);
372   delwin(menu->win);
373   menu->win = (WINDOW *)0;
374
375   ClrStatus(menu, _POSTED);
376
377   RETURN(E_OK);
378 }
379
380 /* m_post.c ends here */