1 /****************************************************************************
2 * Copyright (c) 1998-2008,2009 Free Software Foundation, Inc. *
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: *
12 * The above copyright notice and this permission notice shall be included *
13 * in all copies or substantial portions of the Software. *
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. *
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 *
27 ****************************************************************************/
29 /****************************************************************************
30 * Author: Juergen Pfeifer, 1995,1997 *
31 ****************************************************************************/
33 /* $Id: form.priv.h,v 0.28 2009/04/11 21:27:04 tom Exp $ */
38 #include "curses.priv.h"
39 #include "mf_common.h"
47 #define MB_LEN_MAX 8 /* should be >= MB_CUR_MAX, but that may be a function */
50 #define FIELD_CELL NCURSES_CH_T
52 #define NCURSES_FIELD_INTERNALS char** expanded; WINDOW *working;
53 #define NCURSES_FIELD_EXTENSION , (char **)0, (WINDOW *)0
57 #define FIELD_CELL char
59 #define NCURSES_FIELD_EXTENSION /* nothing */
65 /***********************
67 ***********************/
68 extern NCURSES_EXPORT_VAR(FORM *) _nc_Default_Form;
69 extern NCURSES_EXPORT_VAR(FIELD *) _nc_Default_Field;
70 extern NCURSES_EXPORT_VAR(FIELDTYPE *) _nc_Default_FieldType;
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 */
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 */
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 */
89 /* This are the field options required to be a selectable field in field
90 navigation requests */
91 #define O_SELECTABLE (O_ACTIVE | O_VISIBLE)
93 /* If form is NULL replace form argument by default-form */
94 #define Normalize_Form(form) \
95 ((form) = (form != 0) ? (form) : _nc_Default_Form)
97 /* If field is NULL replace field argument by default-field */
98 #define Normalize_Field(field) \
99 ((field) = (field != 0) ? (field) : _nc_Default_Field)
102 #define Get_Form_Screen(form) \
103 ((form)->win ? _nc_screen_of((form->win)):CURRENT_SCREEN)
106 /* Retrieve forms window */
107 #define Get_Form_Window(form) \
108 ((form)->sub?(form)->sub:((form)->win?(form)->win:stdscr))
110 /* Calculate the size for a single buffer for this field */
111 #define Buffer_Length(field) ((field)->drows * (field)->dcols)
113 /* Calculate the total size of all buffers for this field */
114 #define Total_Buffer_Size(field) \
115 ( (Buffer_Length(field) + 1) * (1+(field)->nbuf) * sizeof(FIELD_CELL) )
117 /* Logic to determine whether or not a field is single lined */
118 #define Single_Line_Field(field) \
119 (((field)->rows + (field)->nrow) == 1)
121 /* Logic to determine whether or not a field is selectable */
122 #define Field_Is_Selectable(f) (((unsigned)((f)->opts) & O_SELECTABLE)==O_SELECTABLE)
123 #define Field_Is_Not_Selectable(f) (((unsigned)((f)->opts) & O_SELECTABLE)!=O_SELECTABLE)
125 typedef struct typearg
127 struct typearg *left;
128 struct typearg *right;
132 /* This is a dummy request code (normally invalid) to be used internally
133 with the form_driver() routine to position to the first active field
136 #define FIRST_ACTIVE_MAGIC (-291056)
138 #define ALL_FORM_OPTS ( \
142 #define ALL_FIELD_OPTS (Field_Options)( \
155 #define is_blank(c) ((c)==C_BLANK)
159 extern NCURSES_EXPORT(TypeArgument *) _nc_Make_Argument (const FIELDTYPE*, va_list*, int*);
160 extern NCURSES_EXPORT(TypeArgument *) _nc_Copy_Argument (const FIELDTYPE*, const TypeArgument*, int*);
161 extern NCURSES_EXPORT(void) _nc_Free_Argument (const FIELDTYPE*, TypeArgument*);
162 extern NCURSES_EXPORT(bool) _nc_Copy_Type (FIELD*, FIELD const *);
163 extern NCURSES_EXPORT(void) _nc_Free_Type (FIELD *);
165 extern NCURSES_EXPORT(int) _nc_Synchronize_Attributes (FIELD*);
166 extern NCURSES_EXPORT(int) _nc_Synchronize_Options (FIELD*, Field_Options);
167 extern NCURSES_EXPORT(int) _nc_Set_Form_Page (FORM*, int, FIELD*);
168 extern NCURSES_EXPORT(int) _nc_Refresh_Current_Field (FORM*);
169 extern NCURSES_EXPORT(FIELD *) _nc_First_Active_Field (FORM*);
170 extern NCURSES_EXPORT(bool) _nc_Internal_Validation (FORM*);
171 extern NCURSES_EXPORT(int) _nc_Set_Current_Field (FORM*, FIELD*);
172 extern NCURSES_EXPORT(int) _nc_Position_Form_Cursor (FORM*);
174 #if USE_WIDEC_SUPPORT
175 extern NCURSES_EXPORT(wchar_t *) _nc_Widen_String(char *, int *);
180 #define returnField(code) TRACE_RETURN(code,field)
181 #define returnFieldPtr(code) TRACE_RETURN(code,field_ptr)
182 #define returnForm(code) TRACE_RETURN(code,form)
183 #define returnFieldType(code) TRACE_RETURN(code,field_type)
184 #define returnFormHook(code) TRACE_RETURN(code,form_hook)
186 extern NCURSES_EXPORT(FIELD **) _nc_retrace_field_ptr (FIELD **);
187 extern NCURSES_EXPORT(FIELD *) _nc_retrace_field (FIELD *);
188 extern NCURSES_EXPORT(FIELDTYPE *) _nc_retrace_field_type (FIELDTYPE *);
189 extern NCURSES_EXPORT(FORM *) _nc_retrace_form (FORM *);
190 extern NCURSES_EXPORT(Form_Hook) _nc_retrace_form_hook (Form_Hook);
194 #define returnFieldPtr(code) return code
195 #define returnFieldType(code) return code
196 #define returnField(code) return code
197 #define returnForm(code) return code
198 #define returnFormHook(code) return code
200 #endif /* TRACE/!TRACE */
203 * Use Check_CTYPE_Field() to simplify FIELDTYPE's that use only the ccheck()
206 #if USE_WIDEC_SUPPORT
207 #define Check_CTYPE_Field(result, buffer, width, ccheck) \
208 while (*buffer && *buffer == ' ') \
212 bool blank = FALSE; \
215 wchar_t *list = _nc_Widen_String((char *)buffer, &len); \
219 for (n = 0; n < len; ++n) \
223 if (list[n] != ' ') \
229 else if (list[n] == ' ') \
232 result = (n + 1 >= width); \
234 else if (!ccheck(list[n], NULL)) \
244 #define Check_CTYPE_Field(result, buffer, width, ccheck) \
245 while (*buffer && *buffer == ' ') \
249 unsigned char *s = buffer; \
251 while (*buffer && ccheck(*buffer, NULL)) \
253 l = (int)(buffer - s); \
254 while (*buffer && *buffer == ' ') \
256 result = ((*buffer || (l < width)) ? FALSE : TRUE); \
260 #endif /* FORM_PRIV_H */