xref: /freebsd/contrib/ncurses/menu/m_post.c (revision caf6fbd81a21a5bd5fac57a0163582bbc8968920)
1 /****************************************************************************
2  * Copyright (c) 1998-2003,2004 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:  Juergen Pfeifer, 1995,1997                                    *
31  ****************************************************************************/
32 
33 /***************************************************************************
34 * Module m_post                                                            *
35 * Write or erase menus from associated subwindows                          *
36 ***************************************************************************/
37 
38 #include "menu.priv.h"
39 
40 MODULE_ID("$Id: m_post.c,v 1.26 2004/12/25 23:57:04 tom Exp $")
41 
42 /*---------------------------------------------------------------------------
43 |   Facility      :  libnmenu
44 |   Function      :  void _nc_Post_Item(MENU *menu, ITEM *item)
45 |
46 |   Description   :  Draw the item in the menus window at the current
47 |                    window position
48 |
49 |   Return Values :  -
50 +--------------------------------------------------------------------------*/
51 NCURSES_EXPORT(void)
52 _nc_Post_Item(const MENU * menu, const ITEM * item)
53 {
54   int i;
55   chtype ch;
56   int item_x, item_y;
57   int count = 0;
58   bool isfore = FALSE, isback = FALSE, isgrey = FALSE;
59   int name_len;
60   int desc_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, 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, menu->fore);
83 	      isfore = TRUE;
84 	    }
85 	  waddstr(menu->win, menu->mark);
86 	  if (isfore)
87 	    {
88 	      wattron(menu->win, 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, 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, menu->grey);
105       isgrey = TRUE;
106     }
107   else
108     {
109       if (item->value || item == menu->curitem)
110 	{
111 	  wattron(menu->win, menu->fore);
112 	  isfore = TRUE;
113 	}
114       else
115 	{
116 	  wattron(menu->win, 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 
135       for (ch = ' ', i = 0; i < menu->spc_desc; i++)
136 	{
137 	  if (i == m)
138 	    {
139 	      waddch(menu->win, menu->pad);
140 	      getyx(menu->win, cy, cx);
141 	    }
142 	  else
143 	    waddch(menu->win, ch);
144 	}
145       if (item->description.length)
146 	waddnstr(menu->win, item->description.str, item->description.length);
147       desc_len = _nc_Calculate_Text_Width(&(item->description));
148       for (ch = ' ', i = menu->desclen - desc_len; i > 0; i--)
149 	{
150 	  waddch(menu->win, ch);
151 	}
152       count += menu->desclen + menu->spc_desc;
153 
154       if (menu->spc_rows > 1)
155 	{
156 	  int j, k, ncy, ncx;
157 
158 	  assert(cx >= 0 && cy >= 0);
159 	  getyx(menu->win, ncy, ncx);
160 	  if (isgrey)
161 	    wattroff(menu->win, menu->grey);
162 	  else if (isfore)
163 	    wattroff(menu->win, menu->fore);
164 	  wattron(menu->win, menu->back);
165 	  for (j = 1; j < menu->spc_rows; j++)
166 	    {
167 	      if ((item_y + j) < getmaxy(menu->win))
168 		{
169 		  wmove(menu->win, item_y + j, item_x);
170 		  for (k = 0; k < count; k++)
171 		    waddch(menu->win, ' ');
172 		}
173 	      if ((cy + j) < getmaxy(menu->win))
174 		mvwaddch(menu->win, cy + j, cx - 1, menu->pad);
175 	    }
176 	  wmove(menu->win, ncy, ncx);
177 	  if (!isback)
178 	    wattroff(menu->win, menu->back);
179 	}
180     }
181 
182   /* Remove attributes */
183   if (isfore)
184     wattroff(menu->win, menu->fore);
185   if (isback)
186     wattroff(menu->win, menu->back);
187   if (isgrey)
188     wattroff(menu->win, menu->grey);
189 }
190 
191 /*---------------------------------------------------------------------------
192 |   Facility      :  libnmenu
193 |   Function      :  void _nc_Draw_Menu(const MENU *)
194 |
195 |   Description   :  Display the menu in its windows
196 |
197 |   Return Values :  -
198 +--------------------------------------------------------------------------*/
199 NCURSES_EXPORT(void)
200 _nc_Draw_Menu(const MENU * menu)
201 {
202   ITEM *item = menu->items[0];
203   ITEM *lasthor, *lastvert;
204   ITEM *hitem;
205   int y = 0;
206   chtype s_bkgd;
207 
208   assert(item && menu->win);
209 
210   s_bkgd = getbkgd(menu->win);
211   wbkgdset(menu->win, menu->back);
212   werase(menu->win);
213   wbkgdset(menu->win, s_bkgd);
214 
215   lastvert = (menu->opt & O_NONCYCLIC) ? (ITEM *) 0 : item;
216 
217   do
218     {
219       wmove(menu->win, y, 0);
220 
221       hitem = item;
222       lasthor = (menu->opt & O_NONCYCLIC) ? (ITEM *) 0 : hitem;
223 
224       do
225 	{
226 	  _nc_Post_Item(menu, hitem);
227 
228 	  wattron(menu->win, menu->back);
229 	  if (((hitem = hitem->right) != lasthor) && hitem)
230 	    {
231 	      int i, j, cy, cx;
232 	      chtype ch = ' ';
233 
234 	      getyx(menu->win, cy, cx);
235 	      for (j = 0; j < menu->spc_rows; j++)
236 		{
237 		  wmove(menu->win, cy + j, cx);
238 		  for (i = 0; i < menu->spc_cols; i++)
239 		    {
240 		      waddch(menu->win, ch);
241 		    }
242 		}
243 	      wmove(menu->win, cy, cx + menu->spc_cols);
244 	    }
245 	}
246       while (hitem && (hitem != lasthor));
247       wattroff(menu->win, menu->back);
248 
249       item = item->down;
250       y += menu->spc_rows;
251 
252     }
253   while (item && (item != lastvert));
254 }
255 
256 /*---------------------------------------------------------------------------
257 |   Facility      :  libnmenu
258 |   Function      :  int post_menu(MENU *)
259 |
260 |   Description   :  Post a menu to the screen. This makes it visible.
261 |
262 |   Return Values :  E_OK                - success
263 |                    E_BAD_ARGUMENT      - not a valid menu pointer
264 |                    E_SYSTEM_ERROR      - error in lower layers
265 |                    E_NOT_CONNECTED     - No items connected to menu
266 |                    E_BAD_STATE         - Menu in userexit routine
267 |                    E_POSTED            - Menu already posted
268 +--------------------------------------------------------------------------*/
269 NCURSES_EXPORT(int)
270 post_menu(MENU * menu)
271 {
272   T((T_CALLED("post_menu(%p)"), menu));
273 
274   if (!menu)
275     RETURN(E_BAD_ARGUMENT);
276 
277   if (menu->status & _IN_DRIVER)
278     RETURN(E_BAD_STATE);
279 
280   if (menu->status & _POSTED)
281     RETURN(E_POSTED);
282 
283   if (menu->items && *(menu->items))
284     {
285       int y;
286       int h = 1 + menu->spc_rows * (menu->rows - 1);
287 
288       WINDOW *win = Get_Menu_Window(menu);
289       int maxy = getmaxy(win);
290 
291       if ((menu->win = newpad(h, menu->width)))
292 	{
293 	  y = (maxy >= h) ? h : maxy;
294 	  if (y >= menu->height)
295 	    y = menu->height;
296 	  if (!(menu->sub = subpad(menu->win, y, menu->width, 0, 0)))
297 	    RETURN(E_SYSTEM_ERROR);
298 	}
299       else
300 	RETURN(E_SYSTEM_ERROR);
301 
302       if (menu->status & _LINK_NEEDED)
303 	_nc_Link_Items(menu);
304     }
305   else
306     RETURN(E_NOT_CONNECTED);
307 
308   menu->status |= _POSTED;
309 
310   if (!(menu->opt & O_ONEVALUE))
311     {
312       ITEM **items;
313 
314       for (items = menu->items; *items; items++)
315 	{
316 	  (*items)->value = FALSE;
317 	}
318     }
319 
320   _nc_Draw_Menu(menu);
321 
322   Call_Hook(menu, menuinit);
323   Call_Hook(menu, iteminit);
324 
325   _nc_Show_Menu(menu);
326 
327   RETURN(E_OK);
328 }
329 
330 /*---------------------------------------------------------------------------
331 |   Facility      :  libnmenu
332 |   Function      :  int unpost_menu(MENU *)
333 |
334 |   Description   :  Detach menu from screen
335 |
336 |   Return Values :  E_OK              - success
337 |                    E_BAD_ARGUMENT    - not a valid menu pointer
338 |                    E_BAD_STATE       - menu in userexit routine
339 |                    E_NOT_POSTED      - menu is not posted
340 +--------------------------------------------------------------------------*/
341 NCURSES_EXPORT(int)
342 unpost_menu(MENU * menu)
343 {
344   WINDOW *win;
345 
346   T((T_CALLED("unpost_menu(%p)"), menu));
347 
348   if (!menu)
349     RETURN(E_BAD_ARGUMENT);
350 
351   if (menu->status & _IN_DRIVER)
352     RETURN(E_BAD_STATE);
353 
354   if (!(menu->status & _POSTED))
355     RETURN(E_NOT_POSTED);
356 
357   Call_Hook(menu, itemterm);
358   Call_Hook(menu, menuterm);
359 
360   win = Get_Menu_Window(menu);
361   werase(win);
362   wsyncup(win);
363 
364   assert(menu->sub);
365   delwin(menu->sub);
366   menu->sub = (WINDOW *)0;
367 
368   assert(menu->win);
369   delwin(menu->win);
370   menu->win = (WINDOW *)0;
371 
372   menu->status &= ~_POSTED;
373 
374   RETURN(E_OK);
375 }
376 
377 /* m_post.c ends here */
378