1 /****************************************************************************
2 * Copyright 2020 Thomas E. Dickey *
3 * Copyright 1998-2010,2012 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 * Create and destroy menu items *
37 * Set and get marker string for menu *
38 ***************************************************************************/
40 #include "menu.priv.h"
48 MODULE_ID("$Id: m_item_new.c,v 1.36 2020/12/12 00:38:08 tom Exp $")
50 /*---------------------------------------------------------------------------
52 | Function : bool Is_Printable_String(const char *s)
54 | Description : Checks whether or not the string contains only printable
57 | Return Values : TRUE - if string is printable
58 | FALSE - if string contains non-printable characters
59 +--------------------------------------------------------------------------*/
61 Is_Printable_String(const char *s)
66 int count = (int)mbstowcs(0, s, 0);
72 && (temp = typeCalloc(wchar_t, (2 + (unsigned)count))) != 0)
76 mbstowcs(temp, s, (unsigned)count);
77 for (n = 0; n < count; ++n)
78 if (!iswprint((wint_t)temp[n]))
89 if (!isprint(UChar(*s)))
100 /*---------------------------------------------------------------------------
101 | Facility : libnmenu
102 | Function : ITEM *new_item(char *name, char *description)
104 | Description : Create a new item with name and description. Return
105 | a pointer to this new item.
106 | N.B.: an item must(!) have a name.
108 | Return Values : The item pointer or NULL if creation failed.
109 +--------------------------------------------------------------------------*/
111 new_item(const char *name, const char *description)
115 T((T_CALLED("new_item(\"%s\", \"%s\")"),
117 description ? description : ""));
119 if (!name || (*name == '\0') || !Is_Printable_String(name))
122 SET_ERROR(E_BAD_ARGUMENT);
126 item = typeCalloc(ITEM, 1);
130 *item = _nc_Default_Item; /* hope we have struct assignment */
132 item->name.length = (unsigned short)strlen(name);
133 item->name.str = name;
135 if (description && (*description != '\0') &&
136 Is_Printable_String(description))
138 item->description.length = (unsigned short)strlen(description);
139 item->description.str = description;
143 item->description.length = 0;
144 item->description.str = (char *)0;
148 SET_ERROR(E_SYSTEM_ERROR);
153 /*---------------------------------------------------------------------------
154 | Facility : libnmenu
155 | Function : int free_item(ITEM *item)
157 | Description : Free the allocated storage for this item.
158 | N.B.: a connected item can't be freed.
160 | Return Values : E_OK - success
161 | E_BAD_ARGUMENT - invalid value has been passed
162 | E_CONNECTED - item is still connected to a menu
163 +--------------------------------------------------------------------------*/
165 free_item(ITEM *item)
167 T((T_CALLED("free_item(%p)"), (void *)item));
170 RETURN(E_BAD_ARGUMENT);
180 /*---------------------------------------------------------------------------
181 | Facility : libnmenu
182 | Function : int set_menu_mark( MENU *menu, const char *mark )
184 | Description : Set the mark string used to indicate the current
185 | item (single-valued menu) or the selected items
186 | (multi-valued menu).
187 | The mark argument may be NULL, in which case no
189 | This might be a little bit tricky, because this may
190 | affect the geometry of the menu, which we don't allow
191 | if it is already posted.
193 | Return Values : E_OK - success
194 | E_BAD_ARGUMENT - an invalid value has been passed
195 | E_SYSTEM_ERROR - no memory to store mark
196 +--------------------------------------------------------------------------*/
198 set_menu_mark(MENU *menu, const char *mark)
202 T((T_CALLED("set_menu_mark(%p,%s)"), (void *)menu, _nc_visbuf(mark)));
204 if (mark && (*mark != '\0') && Is_Printable_String(mark))
205 l = (short)strlen(mark);
211 char *old_mark = menu->mark;
212 unsigned short old_status = menu->status;
214 if (menu->status & _POSTED)
216 /* If the menu is already posted, the geometry is fixed. Then
217 we can only accept a mark with exactly the same length */
218 if (menu->marklen != l)
219 RETURN(E_BAD_ARGUMENT);
224 menu->mark = strdup(mark);
227 if (menu != &_nc_Default_Menu)
228 SetStatus(menu, _MARK_ALLOCATED);
232 menu->mark = old_mark;
233 menu->marklen = (short)((old_mark != 0) ? strlen(old_mark) : 0);
234 RETURN(E_SYSTEM_ERROR);
238 menu->mark = (char *)0;
240 if ((old_status & _MARK_ALLOCATED) && old_mark)
243 if (menu->status & _POSTED)
250 /* Recalculate the geometry */
251 _nc_Calculate_Item_Length_and_Width(menu);
256 returnCode(set_menu_mark(&_nc_Default_Menu, mark));
261 /*---------------------------------------------------------------------------
262 | Facility : libnmenu
263 | Function : char *menu_mark(const MENU *menu)
265 | Description : Return a pointer to the marker string
267 | Return Values : The marker string pointer or NULL if no marker defined
268 +--------------------------------------------------------------------------*/
269 MENU_EXPORT(const char *)
270 menu_mark(const MENU *menu)
272 T((T_CALLED("menu_mark(%p)"), (const void *)menu));
273 returnPtr(Normalize_Menu(menu)->mark);