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.32 2009/11/07 21:26:43 tom Exp $ */
39 #include "mf_common.h"
41 #define UChar(c) ((unsigned char)(c))
49 #define MB_LEN_MAX 8 /* should be >= MB_CUR_MAX, but that may be a function */
52 #define FIELD_CELL NCURSES_CH_T
54 #define NCURSES_FIELD_INTERNALS char** expanded; WINDOW *working;
55 #define NCURSES_FIELD_EXTENSION , (char **)0, (WINDOW *)0
59 #define FIELD_CELL char
61 #define NCURSES_FIELD_EXTENSION /* nothing */
67 /***********************
69 ***********************/
70 extern NCURSES_EXPORT_VAR(FORM
*) _nc_Default_Form
;
71 extern NCURSES_EXPORT_VAR(FIELD
*) _nc_Default_Field
;
72 extern NCURSES_EXPORT_VAR(FIELDTYPE
*) _nc_Default_FieldType
;
74 /* form status values */
75 #define _OVLMODE (0x04U) /* Form is in overlay mode */
76 #define _WINDOW_MODIFIED (0x10U) /* Current field window has been modified */
77 #define _FCHECK_REQUIRED (0x20U) /* Current field needs validation */
79 /* field status values */
80 #define _CHANGED (0x01U) /* Field has been changed */
81 #define _NEWTOP (0x02U) /* Vertical scrolling occurred */
82 #define _NEWPAGE (0x04U) /* field begins new page of form */
83 #define _MAY_GROW (0x08U) /* dynamic field may still grow */
85 /* fieldtype status values */
86 #define _LINKED_TYPE (0x01U) /* Type is a linked type */
87 #define _HAS_ARGS (0x02U) /* Type has arguments */
88 #define _HAS_CHOICE (0x04U) /* Type has choice methods */
89 #define _RESIDENT (0x08U) /* Type is built-in */
90 #define _GENERIC (0x10U) /* A generic field type */
92 /* This are the field options required to be a selectable field in field
93 navigation requests */
94 #define O_SELECTABLE (O_ACTIVE | O_VISIBLE)
96 /* If form is NULL replace form argument by default-form */
97 #define Normalize_Form(form) \
98 ((form) = (form != 0) ? (form) : _nc_Default_Form)
100 /* If field is NULL replace field argument by default-field */
101 #define Normalize_Field(field) \
102 ((field) = (field != 0) ? (field) : _nc_Default_Field)
105 #define Get_Form_Screen(form) \
106 ((form)->win ? _nc_screen_of((form->win)):CURRENT_SCREEN)
108 #define Get_Form_Screen(form) CURRENT_SCREEN
111 /* Retrieve forms window */
112 #define Get_Form_Window(form) \
113 ((form)->sub != NULL \
115 : ((form)->win != NULL \
117 : StdScreen(Get_Form_Screen(form))))
119 /* Calculate the size for a single buffer for this field */
120 #define Buffer_Length(field) ((field)->drows * (field)->dcols)
122 /* Calculate the total size of all buffers for this field */
123 #define Total_Buffer_Size(field) \
124 ( (Buffer_Length(field) + 1) * (1+(field)->nbuf) * sizeof(FIELD_CELL) )
126 /* Logic to determine whether or not a field is single lined */
127 #define Single_Line_Field(field) \
128 (((field)->rows + (field)->nrow) == 1)
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)
134 typedef struct typearg
136 struct typearg
*left
;
137 struct typearg
*right
;
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
145 #define FIRST_ACTIVE_MAGIC (-291056)
147 #define ALL_FORM_OPTS ( \
151 #define ALL_FIELD_OPTS (Field_Options)( \
164 #define is_blank(c) ((c)==C_BLANK)
168 extern NCURSES_EXPORT(TypeArgument
*) _nc_Make_Argument (const FIELDTYPE
*, va_list*, int*);
169 extern NCURSES_EXPORT(TypeArgument
*) _nc_Copy_Argument (const FIELDTYPE
*, const TypeArgument
*, int*);
170 extern NCURSES_EXPORT(void) _nc_Free_Argument (const FIELDTYPE
*, TypeArgument
*);
171 extern NCURSES_EXPORT(bool) _nc_Copy_Type (FIELD
*, FIELD
const *);
172 extern NCURSES_EXPORT(void) _nc_Free_Type (FIELD
*);
174 extern NCURSES_EXPORT(int) _nc_Synchronize_Attributes (FIELD
*);
175 extern NCURSES_EXPORT(int) _nc_Synchronize_Options (FIELD
*, Field_Options
);
176 extern NCURSES_EXPORT(int) _nc_Set_Form_Page (FORM
*, int, FIELD
*);
177 extern NCURSES_EXPORT(int) _nc_Refresh_Current_Field (FORM
*);
178 extern NCURSES_EXPORT(FIELD
*) _nc_First_Active_Field (FORM
*);
179 extern NCURSES_EXPORT(bool) _nc_Internal_Validation (FORM
*);
180 extern NCURSES_EXPORT(int) _nc_Set_Current_Field (FORM
*, FIELD
*);
181 extern NCURSES_EXPORT(int) _nc_Position_Form_Cursor (FORM
*);
183 #if NCURSES_INTEROP_FUNCS
184 extern NCURSES_EXPORT(FIELDTYPE
*) _nc_TYPE_INTEGER(void);
185 extern NCURSES_EXPORT(FIELDTYPE
*) _nc_TYPE_ALNUM(void);
186 extern NCURSES_EXPORT(FIELDTYPE
*) _nc_TYPE_ALPHA(void);
187 extern NCURSES_EXPORT(FIELDTYPE
*) _nc_TYPE_ENUM(void);
188 extern NCURSES_EXPORT(FIELDTYPE
*) _nc_TYPE_NUMERIC(void);
189 extern NCURSES_EXPORT(FIELDTYPE
*) _nc_TYPE_REGEXP(void);
190 extern NCURSES_EXPORT(FIELDTYPE
*) _nc_TYPE_IPV4(void);
192 extern NCURSES_EXPORT(FIELDTYPE
*)
193 _nc_generic_fieldtype(bool (*const field_check
) (FORM
*,
196 bool (*const char_check
) (int,
200 bool (*const next
)(FORM
*,FIELD
*,const void*),
201 bool (*const prev
)(FORM
*,FIELD
*,const void*),
202 void (*freecallback
)(void*));
203 extern NCURSES_EXPORT(int) _nc_set_generic_fieldtype(FIELD
*, FIELDTYPE
*, int (*)(void**));
204 extern NCURSES_EXPORT(WINDOW
*) _nc_form_cursor(const FORM
* , int* , int* );
206 #define INIT_FT_FUNC(func) {func}
208 #define INIT_FT_FUNC(func) func
211 extern NCURSES_EXPORT(void) _nc_get_fieldbuffer(FORM
*, FIELD
*, FIELD_CELL
*);
213 #if USE_WIDEC_SUPPORT
214 extern NCURSES_EXPORT(wchar_t *) _nc_Widen_String(char *, int *);
219 #define returnField(code) TRACE_RETURN(code,field)
220 #define returnFieldPtr(code) TRACE_RETURN(code,field_ptr)
221 #define returnForm(code) TRACE_RETURN(code,form)
222 #define returnFieldType(code) TRACE_RETURN(code,field_type)
223 #define returnFormHook(code) TRACE_RETURN(code,form_hook)
225 extern NCURSES_EXPORT(FIELD
**) _nc_retrace_field_ptr (FIELD
**);
226 extern NCURSES_EXPORT(FIELD
*) _nc_retrace_field (FIELD
*);
227 extern NCURSES_EXPORT(FIELDTYPE
*) _nc_retrace_field_type (FIELDTYPE
*);
228 extern NCURSES_EXPORT(FORM
*) _nc_retrace_form (FORM
*);
229 extern NCURSES_EXPORT(Form_Hook
) _nc_retrace_form_hook (Form_Hook
);
233 #define returnFieldPtr(code) return code
234 #define returnFieldType(code) return code
235 #define returnField(code) return code
236 #define returnForm(code) return code
237 #define returnFormHook(code) return code
239 #endif /* TRACE/!TRACE */
242 * Use Check_CTYPE_Field() to simplify FIELDTYPE's that use only the ccheck()
245 #if USE_WIDEC_SUPPORT
246 #define Check_CTYPE_Field(result, buffer, width, ccheck) \
247 while (*buffer && *buffer == ' ') \
251 bool blank = FALSE; \
254 wchar_t *list = _nc_Widen_String((char *)buffer, &len); \
258 for (n = 0; n < len; ++n) \
262 if (list[n] != ' ') \
268 else if (list[n] == ' ') \
271 result = (n + 1 >= width); \
273 else if (!ccheck(list[n], NULL)) \
283 #define Check_CTYPE_Field(result, buffer, width, ccheck) \
284 while (*buffer && *buffer == ' ') \
288 unsigned char *s = buffer; \
290 while (*buffer && ccheck(*buffer, NULL)) \
292 l = (int)(buffer - s); \
293 while (*buffer && *buffer == ' ') \
295 result = ((*buffer || (l < width)) ? FALSE : TRUE); \
299 #endif /* FORM_PRIV_H */