1 /****************************************************************************
2 * Copyright (c) 1998-2004,2005 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.26 2006/12/17 19:47:09 tom Exp $ */
38 #include "curses.priv.h"
39 #include "mf_common.h"
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 /* form status values */
68 #define _OVLMODE (0x04U) /* Form is in overlay mode */
69 #define _WINDOW_MODIFIED (0x10U) /* Current field window has been modified */
70 #define _FCHECK_REQUIRED (0x20U) /* Current field needs validation */
72 /* field status values */
73 #define _CHANGED (0x01U) /* Field has been changed */
74 #define _NEWTOP (0x02U) /* Vertical scrolling occurred */
75 #define _NEWPAGE (0x04U) /* field begins new page of form */
76 #define _MAY_GROW (0x08U) /* dynamic field may still grow */
78 /* fieldtype status values */
79 #define _LINKED_TYPE (0x01U) /* Type is a linked type */
80 #define _HAS_ARGS (0x02U) /* Type has arguments */
81 #define _HAS_CHOICE (0x04U) /* Type has choice methods */
82 #define _RESIDENT (0x08U) /* Type is built-in */
84 /* This are the field options required to be a selectable field in field
85 navigation requests */
86 #define O_SELECTABLE (O_ACTIVE | O_VISIBLE)
88 /* If form is NULL replace form argument by default-form */
89 #define Normalize_Form(form) \
90 ((form) = (form != 0) ? (form) : _nc_Default_Form)
92 /* If field is NULL replace field argument by default-field */
93 #define Normalize_Field(field) \
94 ((field) = (field != 0) ? (field) : _nc_Default_Field)
96 /* Retrieve forms window */
97 #define Get_Form_Window(form) \
98 ((form)->sub?(form)->sub:((form)->win?(form)->win:stdscr))
100 /* Calculate the size for a single buffer for this field */
101 #define Buffer_Length(field) ((field)->drows * (field)->dcols)
103 /* Calculate the total size of all buffers for this field */
104 #define Total_Buffer_Size(field) \
105 ( (Buffer_Length(field) + 1) * (1+(field)->nbuf) * sizeof(FIELD_CELL) )
107 /* Logic to determine whether or not a field is single lined */
108 #define Single_Line_Field(field) \
109 (((field)->rows + (field)->nrow) == 1)
111 /* Logic to determine whether or not a field is selectable */
112 #define Field_Is_Selectable(f) (((unsigned)((f)->opts) & O_SELECTABLE)==O_SELECTABLE)
113 #define Field_Is_Not_Selectable(f) (((unsigned)((f)->opts) & O_SELECTABLE)!=O_SELECTABLE)
115 typedef struct typearg
117 struct typearg *left;
118 struct typearg *right;
122 /* This is a dummy request code (normally invalid) to be used internally
123 with the form_driver() routine to position to the first active field
126 #define FIRST_ACTIVE_MAGIC (-291056)
128 #define ALL_FORM_OPTS ( \
132 #define ALL_FIELD_OPTS (Field_Options)( \
145 #define is_blank(c) ((c)==C_BLANK)
149 extern NCURSES_EXPORT_VAR(const FIELDTYPE *) _nc_Default_FieldType;
151 extern NCURSES_EXPORT(TypeArgument *) _nc_Make_Argument (const FIELDTYPE*, va_list*, int*);
152 extern NCURSES_EXPORT(TypeArgument *) _nc_Copy_Argument (const FIELDTYPE*, const TypeArgument*, int*);
153 extern NCURSES_EXPORT(void) _nc_Free_Argument (const FIELDTYPE*, TypeArgument*);
154 extern NCURSES_EXPORT(bool) _nc_Copy_Type (FIELD*, FIELD const *);
155 extern NCURSES_EXPORT(void) _nc_Free_Type (FIELD *);
157 extern NCURSES_EXPORT(int) _nc_Synchronize_Attributes (FIELD*);
158 extern NCURSES_EXPORT(int) _nc_Synchronize_Options (FIELD*, Field_Options);
159 extern NCURSES_EXPORT(int) _nc_Set_Form_Page (FORM*, int, FIELD*);
160 extern NCURSES_EXPORT(int) _nc_Refresh_Current_Field (FORM*);
161 extern NCURSES_EXPORT(FIELD *) _nc_First_Active_Field (FORM*);
162 extern NCURSES_EXPORT(bool) _nc_Internal_Validation (FORM*);
163 extern NCURSES_EXPORT(int) _nc_Set_Current_Field (FORM*, FIELD*);
164 extern NCURSES_EXPORT(int) _nc_Position_Form_Cursor (FORM*);
166 #if USE_WIDEC_SUPPORT
167 extern NCURSES_EXPORT(wchar_t *) _nc_Widen_String(char *, int *);
172 #define returnField(code) TRACE_RETURN(code,field)
173 #define returnFieldPtr(code) TRACE_RETURN(code,field_ptr)
174 #define returnForm(code) TRACE_RETURN(code,form)
175 #define returnFieldType(code) TRACE_RETURN(code,field_type)
176 #define returnFormHook(code) TRACE_RETURN(code,form_hook)
178 extern NCURSES_EXPORT(FIELD **) _nc_retrace_field_ptr (FIELD **);
179 extern NCURSES_EXPORT(FIELD *) _nc_retrace_field (FIELD *);
180 extern NCURSES_EXPORT(FIELDTYPE *) _nc_retrace_field_type (FIELDTYPE *);
181 extern NCURSES_EXPORT(FORM *) _nc_retrace_form (FORM *);
182 extern NCURSES_EXPORT(Form_Hook) _nc_retrace_form_hook (Form_Hook);
186 #define returnFieldPtr(code) return code
187 #define returnFieldType(code) return code
188 #define returnField(code) return code
189 #define returnForm(code) return code
190 #define returnFormHook(code) return code
192 #endif /* TRACE/!TRACE */
195 * Use Check_CTYPE_Field() to simplify FIELDTYPE's that use only the ccheck()
198 #if USE_WIDEC_SUPPORT
199 #define Check_CTYPE_Field(result, buffer, width, ccheck) \
200 while (*buffer && *buffer == ' ') \
204 bool blank = FALSE; \
207 wchar_t *list = _nc_Widen_String((char *)buffer, &len); \
211 for (n = 0; n < len; ++n) \
215 if (list[n] != ' ') \
221 else if (list[n] == ' ') \
224 result = (n + 1 >= width); \
226 else if (!ccheck(list[n], NULL)) \
236 #define Check_CTYPE_Field(result, buffer, width, ccheck) \
237 while (*buffer && *buffer == ' ') \
241 unsigned char *s = buffer; \
243 while (*buffer && ccheck(*buffer, NULL)) \
245 l = (int)(buffer - s); \
246 while (*buffer && *buffer == ' ') \
248 result = ((*buffer || (l < width)) ? FALSE : TRUE); \
252 #endif /* FORM_PRIV_H */