1 /**************************************************************************** 2 * Copyright 2018-2024,2025 Thomas E. Dickey * 3 * Copyright 1998-2016,2017 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 /* $Id: form.priv.h,v 0.52 2025/11/01 20:16:03 tom Exp $ */ 35 36 #ifndef FORM_PRIV_H 37 #define FORM_PRIV_H 1 38 /* *INDENT-OFF*/ 39 #include "curses.priv.h" 40 41 #define NCURSES_OPAQUE_FORM 0 42 43 #include "mf_common.h" 44 45 #if USE_WIDEC_SUPPORT 46 #if HAVE_WCTYPE_H 47 #include <wctype.h> 48 #endif 49 50 #define FIELD_CELL NCURSES_CH_T 51 52 #define NCURSES_FIELD_INTERNALS char** expanded; WINDOW *working; 53 #define NCURSES_FIELD_EXTENSION , (char **)0, (WINDOW *)0 54 55 #else 56 57 #define FIELD_CELL char 58 59 #define NCURSES_FIELD_EXTENSION /* nothing */ 60 61 #endif 62 63 #include "form.h" 64 65 /*********************** 66 * Default objects * 67 ***********************/ 68 extern FORM_EXPORT_VAR(FORM *) _nc_Default_Form; 69 extern FORM_EXPORT_VAR(FIELD *) _nc_Default_Field; 70 extern FORM_EXPORT_VAR(FIELDTYPE *) _nc_Default_FieldType; 71 72 /* form status values */ 73 #define _OVLMODE (0x04U) /* Form is in overlay mode */ 74 #define _WINDOW_MODIFIED (0x10U) /* Current field window has been modified */ 75 #define _FCHECK_REQUIRED (0x20U) /* Current field needs validation */ 76 77 /* field status values */ 78 #define _CHANGED (0x01U) /* Field has been changed */ 79 #define _NEWTOP (0x02U) /* Vertical scrolling occurred */ 80 #define _NEWPAGE (0x04U) /* field begins new page of form */ 81 #define _MAY_GROW (0x08U) /* dynamic field may still grow */ 82 83 /* fieldtype status values */ 84 #define _LINKED_TYPE (0x01U) /* Type is a linked type */ 85 #define _HAS_ARGS (0x02U) /* Type has arguments */ 86 #define _HAS_CHOICE (0x04U) /* Type has choice methods */ 87 #define _RESIDENT (0x08U) /* Type is built-in */ 88 #define _GENERIC (0x10U) /* A generic field type */ 89 90 /* This are the field options required to be a selectable field in field 91 navigation requests */ 92 #define O_SELECTABLE (O_ACTIVE | O_VISIBLE) 93 94 /* If form is NULL replace form argument by default-form */ 95 #define Normalize_Form(form) \ 96 ((form) = (form != NULL) ? (form) : _nc_Default_Form) 97 98 /* If field is NULL replace field argument by default-field */ 99 #define Normalize_Field(field) \ 100 ((field) = (field != NULL) ? (field) : _nc_Default_Field) 101 102 #if NCURSES_SP_FUNCS 103 #define Get_Form_Screen(form) \ 104 ((form)->win ? _nc_screen_of((form->win)):CURRENT_SCREEN) 105 #else 106 #define Get_Form_Screen(form) CURRENT_SCREEN 107 #endif 108 109 /* Retrieve form's window */ 110 #define Get_Form_Window(form) \ 111 ((form)->sub \ 112 ? (form)->sub \ 113 : ((form)->win \ 114 ? (form)->win \ 115 : StdScreen(Get_Form_Screen(form)))) 116 117 /* Calculate the size for a single buffer for this field */ 118 #define Buffer_Length(field) ((field)->drows * (field)->dcols) 119 120 /* Calculate the total size of all buffers for this field */ 121 #define Total_Buffer_Size(field) \ 122 ( (size_t)(Buffer_Length(field) + 1) * (size_t)(1+(field)->nbuf) * sizeof(FIELD_CELL) ) 123 124 /* Logic to determine whether or not a field is single lined */ 125 #define Single_Line_Field(field) \ 126 (((field)->rows + (field)->nrow) == 1) 127 128 #define Field_Has_Option(f,o) ((((unsigned)(f)->opts) & o) != 0) 129 130 /* Logic to determine whether or not a field is selectable */ 131 #define Field_Is_Selectable(f) (((unsigned)((f)->opts) & O_SELECTABLE)==O_SELECTABLE) 132 #define Field_Is_Not_Selectable(f) (((unsigned)((f)->opts) & O_SELECTABLE)!=O_SELECTABLE) 133 134 typedef struct typearg 135 { 136 struct typearg *left; 137 struct typearg *right; 138 } 139 TypeArgument; 140 141 /* This is a dummy request code (normally invalid) to be used internally 142 with the form_driver() routine to position to the first active field 143 on the form 144 */ 145 #define FIRST_ACTIVE_MAGIC (-291056) 146 147 #define ALL_FORM_OPTS ( \ 148 O_NL_OVERLOAD |\ 149 O_BS_OVERLOAD ) 150 151 #define STD_FIELD_OPTS (Field_Options)( \ 152 O_VISIBLE |\ 153 O_ACTIVE |\ 154 O_PUBLIC |\ 155 O_EDIT |\ 156 O_WRAP |\ 157 O_BLANK |\ 158 O_AUTOSKIP|\ 159 O_NULLOK |\ 160 O_PASSOK |\ 161 O_STATIC) 162 163 #define ALL_FIELD_OPTS (Field_Options)( \ 164 STD_FIELD_OPTS |\ 165 O_DYNAMIC_JUSTIFY |\ 166 O_NO_LEFT_STRIP |\ 167 O_EDGE_INSERT_STAY |\ 168 O_INPUT_LIMIT) 169 170 #define C_BLANK ' ' 171 #define is_blank(c) ((c)==C_BLANK) 172 173 #define C_ZEROS '\0' 174 175 #define MAX_DIGITS 64 176 #define MaxDigits(n) ((n) > MAX_DIGITS ? MAX_DIGITS : ((n) > 0 ? (n) : 0)) 177 178 extern FORM_EXPORT(TypeArgument *) _nc_Make_Argument (const FIELDTYPE*, va_list*, int*); 179 extern FORM_EXPORT(TypeArgument *) _nc_Copy_Argument (const FIELDTYPE*, const TypeArgument*, int*); 180 extern FORM_EXPORT(void) _nc_Free_Argument (const FIELDTYPE*, TypeArgument*); 181 extern FORM_EXPORT(bool) _nc_Copy_Type (FIELD*, FIELD const *); 182 extern FORM_EXPORT(void) _nc_Free_Type (FIELD *); 183 184 extern FORM_EXPORT(int) _nc_Synchronize_Attributes (FIELD*); 185 extern FORM_EXPORT(int) _nc_Synchronize_Options (FIELD*, Field_Options); 186 extern FORM_EXPORT(int) _nc_Set_Form_Page (FORM*, int, FIELD*); 187 extern FORM_EXPORT(int) _nc_Refresh_Current_Field (FORM*); 188 extern FORM_EXPORT(FIELD *) _nc_First_Active_Field (FORM*); 189 extern FORM_EXPORT(bool) _nc_Internal_Validation (FORM*); 190 extern FORM_EXPORT(int) _nc_Set_Current_Field (FORM*, FIELD*); 191 extern FORM_EXPORT(int) _nc_Position_Form_Cursor (FORM*); 192 extern FORM_EXPORT(void) _nc_Unset_Current_Field(FORM *form); 193 194 #if NCURSES_INTEROP_FUNCS 195 extern FORM_EXPORT(FIELDTYPE *) _nc_TYPE_INTEGER(void); 196 extern FORM_EXPORT(FIELDTYPE *) _nc_TYPE_ALNUM(void); 197 extern FORM_EXPORT(FIELDTYPE *) _nc_TYPE_ALPHA(void); 198 extern FORM_EXPORT(FIELDTYPE *) _nc_TYPE_ENUM(void); 199 extern FORM_EXPORT(FIELDTYPE *) _nc_TYPE_NUMERIC(void); 200 extern FORM_EXPORT(FIELDTYPE *) _nc_TYPE_REGEXP(void); 201 extern FORM_EXPORT(FIELDTYPE *) _nc_TYPE_IPV4(void); 202 203 extern FORM_EXPORT(FIELDTYPE *) 204 _nc_generic_fieldtype(bool (*const field_check) (FORM*, 205 FIELD *, 206 const void *), 207 bool (*const char_check) (int, 208 FORM*, 209 FIELD*, 210 const void *), 211 bool (*const next)(FORM*,FIELD*,const void*), 212 bool (*const prev)(FORM*,FIELD*,const void*), 213 void (*freecallback)(void*)); 214 extern FORM_EXPORT(int) _nc_set_generic_fieldtype(FIELD*, FIELDTYPE*, int (*)(void**)); 215 extern FORM_EXPORT(WINDOW*) _nc_form_cursor(const FORM* , int* , int* ); 216 217 #define INIT_FT_FUNC(func) {func} 218 #else 219 #define INIT_FT_FUNC(func) func 220 #endif 221 222 extern FORM_EXPORT(void) _nc_get_fieldbuffer(FORM*, FIELD*, FIELD_CELL*); 223 224 #if USE_WIDEC_SUPPORT 225 extern FORM_EXPORT(wchar_t *) _nc_Widen_String(char *, int *); 226 #endif 227 228 #ifdef TRACE 229 230 #define returnField(code) TRACE_RETURN1(code,field) 231 #define returnFieldPtr(code) TRACE_RETURN1(code,field_ptr) 232 #define returnForm(code) TRACE_RETURN1(code,form) 233 #define returnFieldType(code) TRACE_RETURN1(code,field_type) 234 #define returnFormHook(code) TRACE_RETURN1(code,form_hook) 235 236 extern FORM_EXPORT(FIELD **) _nc_retrace_field_ptr (FIELD **); 237 extern FORM_EXPORT(FIELD *) _nc_retrace_field (FIELD *); 238 extern FORM_EXPORT(FIELDTYPE *) _nc_retrace_field_type (FIELDTYPE *); 239 extern FORM_EXPORT(FORM *) _nc_retrace_form (FORM *); 240 extern FORM_EXPORT(Form_Hook) _nc_retrace_form_hook (Form_Hook); 241 242 #else /* !TRACE */ 243 244 #define returnFieldPtr(code) return code 245 #define returnFieldType(code) return code 246 #define returnField(code) return code 247 #define returnForm(code) return code 248 #define returnFormHook(code) return code 249 250 #endif /* TRACE/!TRACE */ 251 252 /* 253 * Use Check_CTYPE_Field() to simplify FIELDTYPE's that use only the ccheck() 254 * function. 255 */ 256 #if USE_WIDEC_SUPPORT 257 #define Check_CTYPE_Field(result, buffer, width, ccheck) \ 258 while (*buffer && *buffer == ' ') \ 259 buffer++; \ 260 if (*buffer) \ 261 { \ 262 bool blank = FALSE; \ 263 int len; \ 264 int n; \ 265 wchar_t *list = _nc_Widen_String((char *)buffer, &len); \ 266 if (list != NULL) \ 267 { \ 268 result = TRUE; \ 269 for (n = 0; n < len; ++n) \ 270 { \ 271 if (blank) \ 272 { \ 273 if (list[n] != ' ') \ 274 { \ 275 result = FALSE; \ 276 break; \ 277 } \ 278 } \ 279 else if (list[n] == ' ') \ 280 { \ 281 blank = TRUE; \ 282 result = (n + 1 >= width); \ 283 } \ 284 else if (!ccheck((int) list[n], NULL)) \ 285 { \ 286 result = FALSE; \ 287 break; \ 288 } \ 289 } \ 290 free(list); \ 291 } \ 292 } 293 #else 294 #define Check_CTYPE_Field(result, buffer, width, ccheck) \ 295 while (*buffer && *buffer == ' ') \ 296 buffer++; \ 297 if (*buffer) \ 298 { \ 299 unsigned char *s = buffer; \ 300 int l = -1; \ 301 while (*buffer && ccheck(*buffer, NULL)) \ 302 buffer++; \ 303 l = (int)(buffer - s); \ 304 while (*buffer && *buffer == ' ') \ 305 buffer++; \ 306 result = ((*buffer || (l < width)) ? FALSE : TRUE); \ 307 } 308 #endif 309 /* *INDENT-ON*/ 310 311 #endif /* FORM_PRIV_H */ 312