1 /**************************************************************************** 2 * Copyright 2020 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_item_new * 36 * Create and destroy menu items * 37 * Set and get marker string for menu * 38 ***************************************************************************/ 39 40 #include "menu.priv.h" 41 42 #if USE_WIDEC_SUPPORT 43 #if HAVE_WCTYPE_H 44 #include <wctype.h> 45 #endif 46 #endif 47 48 MODULE_ID("$Id: m_item_new.c,v 1.34 2020/02/02 23:34:34 tom Exp $") 49 50 /*--------------------------------------------------------------------------- 51 | Facility : libnmenu 52 | Function : bool Is_Printable_String(const char *s) 53 | 54 | Description : Checks whether or not the string contains only printable 55 | characters. 56 | 57 | Return Values : TRUE - if string is printable 58 | FALSE - if string contains non-printable characters 59 +--------------------------------------------------------------------------*/ 60 static bool 61 Is_Printable_String(const char *s) 62 { 63 int result = TRUE; 64 65 #if USE_WIDEC_SUPPORT 66 int count = (int)mbstowcs(0, s, 0); 67 wchar_t *temp = 0; 68 69 assert(s); 70 71 if (count > 0 72 && (temp = typeCalloc(wchar_t, (2 + (unsigned)count))) != 0) 73 { 74 int n; 75 76 mbstowcs(temp, s, (unsigned)count); 77 for (n = 0; n < count; ++n) 78 if (!iswprint((wint_t) temp[n])) 79 { 80 result = FALSE; 81 break; 82 } 83 free(temp); 84 } 85 #else 86 assert(s); 87 while (*s) 88 { 89 if (!isprint(UChar(*s))) 90 { 91 result = FALSE; 92 break; 93 } 94 s++; 95 } 96 #endif 97 return result; 98 } 99 100 /*--------------------------------------------------------------------------- 101 | Facility : libnmenu 102 | Function : ITEM *new_item(char *name, char *description) 103 | 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. 107 | 108 | Return Values : The item pointer or NULL if creation failed. 109 +--------------------------------------------------------------------------*/ 110 NCURSES_EXPORT(ITEM *) 111 new_item(const char *name, const char *description) 112 { 113 ITEM *item; 114 115 T((T_CALLED("new_item(\"%s\", \"%s\")"), 116 name ? name : "", 117 description ? description : "")); 118 119 if (!name || (*name == '\0') || !Is_Printable_String(name)) 120 { 121 item = (ITEM *) 0; 122 SET_ERROR(E_BAD_ARGUMENT); 123 } 124 else 125 { 126 item = typeCalloc(ITEM, 1); 127 if (item) 128 { 129 *item = _nc_Default_Item; /* hope we have struct assignment */ 130 131 item->name.length = (unsigned short)strlen(name); 132 item->name.str = name; 133 134 if (description && (*description != '\0') && 135 Is_Printable_String(description)) 136 { 137 item->description.length = (unsigned short)strlen(description); 138 item->description.str = description; 139 } 140 else 141 { 142 item->description.length = 0; 143 item->description.str = (char *)0; 144 } 145 } 146 else 147 SET_ERROR(E_SYSTEM_ERROR); 148 } 149 returnItem(item); 150 } 151 152 /*--------------------------------------------------------------------------- 153 | Facility : libnmenu 154 | Function : int free_item(ITEM *item) 155 | 156 | Description : Free the allocated storage for this item. 157 | N.B.: a connected item can't be freed. 158 | 159 | Return Values : E_OK - success 160 | E_BAD_ARGUMENT - invalid value has been passed 161 | E_CONNECTED - item is still connected to a menu 162 +--------------------------------------------------------------------------*/ 163 NCURSES_EXPORT(int) 164 free_item(ITEM * item) 165 { 166 T((T_CALLED("free_item(%p)"), (void *)item)); 167 168 if (!item) 169 RETURN(E_BAD_ARGUMENT); 170 171 if (item->imenu) 172 RETURN(E_CONNECTED); 173 174 free(item); 175 176 RETURN(E_OK); 177 } 178 179 /*--------------------------------------------------------------------------- 180 | Facility : libnmenu 181 | Function : int set_menu_mark( MENU *menu, const char *mark ) 182 | 183 | Description : Set the mark string used to indicate the current 184 | item (single-valued menu) or the selected items 185 | (multi-valued menu). 186 | The mark argument may be NULL, in which case no 187 | marker is used. 188 | This might be a little bit tricky, because this may 189 | affect the geometry of the menu, which we don't allow 190 | if it is already posted. 191 | 192 | Return Values : E_OK - success 193 | E_BAD_ARGUMENT - an invalid value has been passed 194 | E_SYSTEM_ERROR - no memory to store mark 195 +--------------------------------------------------------------------------*/ 196 NCURSES_EXPORT(int) 197 set_menu_mark(MENU * menu, const char *mark) 198 { 199 short l; 200 201 T((T_CALLED("set_menu_mark(%p,%s)"), (void *)menu, _nc_visbuf(mark))); 202 203 if (mark && (*mark != '\0') && Is_Printable_String(mark)) 204 l = (short)strlen(mark); 205 else 206 l = 0; 207 208 if (menu) 209 { 210 char *old_mark = menu->mark; 211 unsigned short old_status = menu->status; 212 213 if (menu->status & _POSTED) 214 { 215 /* If the menu is already posted, the geometry is fixed. Then 216 we can only accept a mark with exactly the same length */ 217 if (menu->marklen != l) 218 RETURN(E_BAD_ARGUMENT); 219 } 220 menu->marklen = l; 221 if (l) 222 { 223 menu->mark = strdup(mark); 224 if (menu->mark) 225 { 226 if (menu != &_nc_Default_Menu) 227 SetStatus(menu, _MARK_ALLOCATED); 228 } 229 else 230 { 231 menu->mark = old_mark; 232 menu->marklen = (short)((old_mark != 0) ? strlen(old_mark) : 0); 233 RETURN(E_SYSTEM_ERROR); 234 } 235 } 236 else 237 menu->mark = (char *)0; 238 239 if ((old_status & _MARK_ALLOCATED) && old_mark) 240 free(old_mark); 241 242 if (menu->status & _POSTED) 243 { 244 _nc_Draw_Menu(menu); 245 _nc_Show_Menu(menu); 246 } 247 else 248 { 249 /* Recalculate the geometry */ 250 _nc_Calculate_Item_Length_and_Width(menu); 251 } 252 } 253 else 254 { 255 returnCode(set_menu_mark(&_nc_Default_Menu, mark)); 256 } 257 RETURN(E_OK); 258 } 259 260 /*--------------------------------------------------------------------------- 261 | Facility : libnmenu 262 | Function : char *menu_mark(const MENU *menu) 263 | 264 | Description : Return a pointer to the marker string 265 | 266 | Return Values : The marker string pointer or NULL if no marker defined 267 +--------------------------------------------------------------------------*/ 268 NCURSES_EXPORT(const char *) 269 menu_mark(const MENU * menu) 270 { 271 T((T_CALLED("menu_mark(%p)"), (const void *)menu)); 272 returnPtr(Normalize_Menu(menu)->mark); 273 } 274 275 /* m_item_new.c */ 276