1 /****************************************************************************
2 * Copyright 2020 Thomas E. Dickey *
3 * Copyright 1998-2012,2014 Free Software Foundation, Inc. *
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: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
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. *
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 *
28 ****************************************************************************/
30 /****************************************************************************
31 * Author: Juergen Pfeifer, 1995,1997 *
32 ****************************************************************************/
34 /***************************************************************************
36 * Globally used internal routines and the default menu and item structures *
37 ***************************************************************************/
39 #include "menu.priv.h"
41 MODULE_ID("$Id: m_global.c,v 1.31 2020/05/24 01:40:20 anonymous.maarten Exp $")
43 static char mark[] = "-";
45 MENU_EXPORT_VAR(MENU) _nc_Default_Menu = {
46 16, /* Nr. of chars high */
47 1, /* Nr. of chars wide */
48 16, /* Nr. of items high */
49 1, /* Nr. of items wide */
50 16, /* Nr. of formatted items high */
51 1, /* Nr. of formatted items wide */
52 16, /* Nr. of items high (actual) */
53 0, /* length of widest name */
54 0, /* length of widest description */
55 1, /* length of mark */
56 1, /* length of one item */
57 1, /* Spacing for descriptor */
58 1, /* Spacing for columns */
59 1, /* Spacing for rows */
60 (char *)0, /* buffer used to store match chars */
61 0, /* Index into pattern buffer */
62 (WINDOW *)0, /* Window containing entire menu */
63 (WINDOW *)0, /* Portion of menu displayed */
64 (WINDOW *)0, /* User's window */
65 (WINDOW *)0, /* User's subwindow */
66 (ITEM **)0, /* List of items */
67 0, /* Total Nr. of items in menu */
68 (ITEM *)0, /* Current item */
69 0, /* Top row of menu */
70 (chtype)A_REVERSE, /* Attribute for selection */
71 (chtype)A_NORMAL, /* Attribute for nonselection */
72 (chtype)A_UNDERLINE, /* Attribute for inactive */
73 ' ', /* Pad character */
74 (Menu_Hook)0, /* Menu init */
75 (Menu_Hook)0, /* Menu term */
76 (Menu_Hook)0, /* Item init */
77 (Menu_Hook)0, /* Item term */
78 (void *)0, /* userptr */
80 ALL_MENU_OPTS, /* options */
84 MENU_EXPORT_VAR(ITEM) _nc_Default_Item = {
85 { (char *)0, 0 }, /* name */
86 { (char *)0, 0 }, /* description */
87 (MENU *)0, /* Pointer to parent menu */
88 (char *)0, /* Userpointer */
89 ALL_ITEM_OPTS, /* options */
95 (ITEM *)0, /* right */
101 /*---------------------------------------------------------------------------
102 | Facility : libnmenu
103 | Function : static void ComputeMaximum_NameDesc_Lenths(MENU *menu)
105 | Description : Calculates the maximum name and description lengths
106 | of the items connected to the menu
109 +--------------------------------------------------------------------------*/
110 NCURSES_INLINE static void
111 ComputeMaximum_NameDesc_Lengths(MENU * menu)
113 unsigned MaximumNameLength = 0;
114 unsigned MaximumDescriptionLength = 0;
118 assert(menu && menu->items);
119 for (items = menu->items; *items; items++)
121 check = (unsigned)_nc_Calculate_Text_Width(&((*items)->name));
122 if (check > MaximumNameLength)
123 MaximumNameLength = check;
125 check = (unsigned)_nc_Calculate_Text_Width(&((*items)->description));
126 if (check > MaximumDescriptionLength)
127 MaximumDescriptionLength = check;
130 menu->namelen = (short)MaximumNameLength;
131 menu->desclen = (short)MaximumDescriptionLength;
132 T(("ComputeMaximum_NameDesc_Lengths %d,%d", menu->namelen, menu->desclen));
135 /*---------------------------------------------------------------------------
136 | Facility : libnmenu
137 | Function : static void ResetConnectionInfo(MENU *, ITEM **)
139 | Description : Reset all information in the menu and the items in
140 | the item array that indicates a connection
143 +--------------------------------------------------------------------------*/
144 NCURSES_INLINE static void
145 ResetConnectionInfo(MENU * menu, ITEM ** items)
149 assert(menu && items);
150 for (item = items; *item; item++)
153 (*item)->imenu = (MENU *) 0;
157 menu->pattern = (char *)0;
159 menu->items = (ITEM **) 0;
163 /*---------------------------------------------------------------------------
164 | Facility : libnmenu
165 | Function : bool _nc_Connect_Items(MENU *menu, ITEM **items)
167 | Description : Connect the items in the item array to the menu.
168 | Decorate all the items with a number and a backward
169 | pointer to the menu.
171 | Return Values : TRUE - successful connection
172 | FALSE - connection failed
173 +--------------------------------------------------------------------------*/
175 _nc_Connect_Items(MENU * menu, ITEM ** items)
178 unsigned int ItemCount = 0;
182 for (item = items; *item; item++)
186 /* if a item is already connected, reject connection */
191 /* we reached the end, so there was no connected item */
193 for (item = items; *item; item++)
195 if (menu->opt & O_ONEVALUE)
197 (*item)->value = FALSE;
199 (*item)->index = (short)ItemCount++;
200 (*item)->imenu = menu;
210 menu->nitems = (short)ItemCount;
211 ComputeMaximum_NameDesc_Lengths(menu);
212 if ((menu->pattern = typeMalloc(char, (unsigned)(1 + menu->namelen))))
215 set_menu_format(menu, menu->frows, menu->fcols);
216 menu->curitem = *items;
222 /* If we fall through to this point, we have to reset all items connection
223 and inform about a reject connection */
224 ResetConnectionInfo(menu, items);
228 /*---------------------------------------------------------------------------
229 | Facility : libnmenu
230 | Function : void _nc_Disconnect_Items(MENU *menu)
232 | Description : Disconnect the menus item array from the menu
235 +--------------------------------------------------------------------------*/
237 _nc_Disconnect_Items(MENU * menu)
239 if (menu && menu->items)
240 ResetConnectionInfo(menu, menu->items);
243 /*---------------------------------------------------------------------------
244 | Facility : libnmenu
245 | Function : int _nc_Calculate_Text_Width(const TEXT * item)
247 | Description : Calculate the number of columns for a TEXT.
249 | Return Values : the width
250 +--------------------------------------------------------------------------*/
252 _nc_Calculate_Text_Width(const TEXT * item /*FIXME: limit length */ )
254 #if USE_WIDEC_SUPPORT
255 int result = item->length;
257 T((T_CALLED("_nc_menu_text_width(%p)"), (const void *)item));
258 if (result != 0 && item->str != 0)
260 int count = (int)mbstowcs(0, item->str, 0);
264 && (temp = typeMalloc(wchar_t, 2 + count)) != 0)
269 mbstowcs(temp, item->str, (unsigned)count);
270 for (n = 0; n < count; ++n)
272 int test = wcwidth(temp[n]);
288 * Calculate the actual width of a menu entry for wide-characters.
290 #if USE_WIDEC_SUPPORT
292 calculate_actual_width(MENU * menu, bool name)
298 assert(menu && menu->items);
300 if (menu->items != 0)
302 for (items = menu->items; *items; items++)
306 check = _nc_Calculate_Text_Width(&((*items)->name));
310 check = _nc_Calculate_Text_Width(&((*items)->description));
318 width = (name ? menu->namelen : menu->desclen);
321 T(("calculate_actual_width %s = %d/%d",
322 name ? "name" : "desc",
324 name ? menu->namelen : menu->desclen));
328 #define calculate_actual_width(menu, name) (name ? menu->namelen : menu->desclen)
331 /*---------------------------------------------------------------------------
332 | Facility : libnmenu
333 | Function : void _nc_Calculate_Item_Length_and_Width(MENU *menu)
335 | Description : Calculate the length of an item and the width of the
339 +--------------------------------------------------------------------------*/
341 _nc_Calculate_Item_Length_and_Width(MENU * menu)
347 menu->height = (short)(1 + menu->spc_rows * (menu->arows - 1));
349 l = calculate_actual_width(menu, TRUE);
352 if ((menu->opt & O_SHOWDESC) && (menu->desclen > 0))
354 l += calculate_actual_width(menu, FALSE);
358 menu->itemlen = (short)l;
360 l += (menu->cols - 1) * menu->spc_cols; /* for the padding between the columns */
361 menu->width = (short)l;
363 T(("_nc_CalculateItem_Length_and_Width columns %d, item %d, width %d",
369 /*---------------------------------------------------------------------------
370 | Facility : libnmenu
371 | Function : void _nc_Link_Item(MENU *menu)
373 | Description : Statically calculate for every item its four neighbors.
374 | This depends on the orientation of the menu. This
375 | static approach simplifies navigation in the menu a lot.
378 +--------------------------------------------------------------------------*/
380 _nc_Link_Items(MENU * menu)
382 if (menu && menu->items && *(menu->items))
386 int Number_Of_Items = menu->nitems;
387 int col = 0, row = 0;
390 bool cycle = (menu->opt & O_NONCYCLIC) ? FALSE : TRUE;
392 ClrStatus(menu, _LINK_NEEDED);
394 if (menu->opt & O_ROWMAJOR)
396 int Number_Of_Columns = menu->cols;
398 for (i = 0; i < Number_Of_Items; i++)
400 item = menu->items[i];
402 Last_in_Row = row * Number_Of_Columns + (Number_Of_Columns - 1);
405 /* if we are not in the leftmost column, we can use the
406 predecessor in the items array */
408 (cycle ? menu->items[(Last_in_Row >= Number_Of_Items) ?
409 Number_Of_Items - 1 :
413 item->right = ((col < (Number_Of_Columns - 1)) &&
414 ((i + 1) < Number_Of_Items)
417 (cycle ? menu->items[row * Number_Of_Columns] :
421 Last_in_Column = (menu->rows - 1) * Number_Of_Columns + col;
423 item->up = (row) ? menu->items[i - Number_Of_Columns] :
424 (cycle ? menu->items[(Last_in_Column >= Number_Of_Items) ?
425 Number_Of_Items - 1 :
429 item->down = ((i + Number_Of_Columns) < Number_Of_Items)
431 menu->items[i + Number_Of_Columns] :
432 (cycle ? menu->items[(row + 1) < menu->rows ?
433 Number_Of_Items - 1 : col] :
435 item->x = (short)col;
436 item->y = (short)row;
437 if (++col == Number_Of_Columns)
446 int Number_Of_Rows = menu->rows;
448 for (j = 0; j < Number_Of_Items; j++)
450 item = menu->items[i = (col * Number_Of_Rows + row)];
452 Last_in_Column = (menu->cols - 1) * Number_Of_Rows + row;
455 menu->items[i - Number_Of_Rows] :
456 (cycle ? (Last_in_Column >= Number_Of_Items) ?
457 menu->items[Last_in_Column - Number_Of_Rows] :
458 menu->items[Last_in_Column] :
461 item->right = ((i + Number_Of_Rows) < Number_Of_Items)
463 menu->items[i + Number_Of_Rows] :
464 (cycle ? menu->items[row] : (ITEM *) 0);
466 Last_in_Row = col * Number_Of_Rows + (Number_Of_Rows - 1);
471 menu->items[(Last_in_Row >= Number_Of_Items) ?
472 Number_Of_Items - 1 :
476 item->down = (row < (Number_Of_Rows - 1))
478 (menu->items[((i + 1) < Number_Of_Items) ?
480 (col - 1) * Number_Of_Rows + row + 1]) :
482 menu->items[col * Number_Of_Rows] :
486 item->x = (short)col;
487 item->y = (short)row;
488 if ((++row) == Number_Of_Rows)
498 /*---------------------------------------------------------------------------
499 | Facility : libnmenu
500 | Function : void _nc_Show_Menu(const MENU* menu)
502 | Description : Update the window that is associated with the menu
505 +--------------------------------------------------------------------------*/
507 _nc_Show_Menu(const MENU * menu)
513 if ((menu->status & _POSTED) && !(menu->status & _IN_DRIVER))
515 /* adjust the internal subwindow to start on the current top */
517 mvderwin(menu->sub, menu->spc_rows * menu->toprow, 0);
518 win = Get_Menu_Window(menu);
523 if (menu->height < maxy)
525 if (menu->width < maxx)
528 copywin(menu->sub, win, 0, 0, 0, 0, maxy - 1, maxx - 1, 0);
529 pos_menu_cursor(menu);
533 /*---------------------------------------------------------------------------
534 | Facility : libnmenu
535 | Function : void _nc_New_TopRow_and_CurrentItem(
538 | ITEM *new_current_item)
540 | Description : Redisplay the menu so that the given row becomes the
541 | top row and the given item becomes the new current
545 +--------------------------------------------------------------------------*/
547 _nc_New_TopRow_and_CurrentItem(
550 ITEM * new_current_item)
553 bool mterm_called = FALSE;
554 bool iterm_called = FALSE;
557 if (menu->status & _POSTED)
559 if (new_current_item != menu->curitem)
561 Call_Hook(menu, itemterm);
564 if (new_toprow != menu->toprow)
566 Call_Hook(menu, menuterm);
570 cur_item = menu->curitem;
572 menu->toprow = (short)(((menu->rows - menu->frows) >= 0)
573 ? min(menu->rows - menu->frows, new_toprow)
575 menu->curitem = new_current_item;
579 Call_Hook(menu, menuinit);
583 /* this means, move from the old current_item to the new one... */
584 Move_To_Current_Item(menu, cur_item);
585 Call_Hook(menu, iteminit);
587 if (mterm_called || iterm_called)
592 pos_menu_cursor(menu);
595 { /* if we are not posted, this is quite simple */
596 menu->toprow = (short)(((menu->rows - menu->frows) >= 0)
597 ? min(menu->rows - menu->frows, new_toprow)
599 menu->curitem = new_current_item;
603 /* m_global.c ends here */