ncurses 5.7 - patch 20090815
[ncurses.git] / form / form.priv.h
1 /****************************************************************************
2  * Copyright (c) 1998-2008,2009 Free Software Foundation, Inc.              *
3  *                                                                          *
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:                 *
11  *                                                                          *
12  * The above copyright notice and this permission notice shall be included  *
13  * in all copies or substantial portions of the Software.                   *
14  *                                                                          *
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.                               *
22  *                                                                          *
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       *
26  * authorization.                                                           *
27  ****************************************************************************/
28
29 /****************************************************************************
30  *   Author:  Juergen Pfeifer, 1995,1997                                    *
31  ****************************************************************************/
32
33 /* $Id: form.priv.h,v 0.28 2009/04/11 21:27:04 tom Exp $ */
34
35 #ifndef FORM_PRIV_H
36 #define FORM_PRIV_H 1
37
38 #include "curses.priv.h"
39 #include "mf_common.h"
40
41 #if USE_WIDEC_SUPPORT
42 #if HAVE_WCTYPE_H
43 #include <wctype.h>
44 #endif
45
46 #ifndef MB_LEN_MAX
47 #define MB_LEN_MAX 8 /* should be >= MB_CUR_MAX, but that may be a function */
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 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;
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
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)
92
93 /* If form is NULL replace form argument by default-form */
94 #define Normalize_Form(form) \
95   ((form) = (form != 0) ? (form) : _nc_Default_Form)
96
97 /* If field is NULL replace field argument by default-field */
98 #define Normalize_Field(field) \
99   ((field) = (field != 0) ? (field) : _nc_Default_Field)
100
101 #if NCURSES_SP_FUNCS
102 #define Get_Form_Screen(form) \
103   ((form)->win ? _nc_screen_of((form->win)):CURRENT_SCREEN)
104 #endif
105
106 /* Retrieve forms window */
107 #define Get_Form_Window(form) \
108   ((form)->sub?(form)->sub:((form)->win?(form)->win:stdscr))
109
110 /* Calculate the size for a single buffer for this field */
111 #define Buffer_Length(field) ((field)->drows * (field)->dcols)
112
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) )
116
117 /* Logic to determine whether or not a field is single lined */
118 #define Single_Line_Field(field) \
119    (((field)->rows + (field)->nrow) == 1)
120
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)
124
125 typedef struct typearg
126   {
127     struct typearg *left;
128     struct typearg *right;
129   }
130 TypeArgument;
131
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
134    on the form
135 */
136 #define FIRST_ACTIVE_MAGIC (-291056)
137
138 #define ALL_FORM_OPTS  (                \
139                         O_NL_OVERLOAD  |\
140                         O_BS_OVERLOAD   )
141
142 #define ALL_FIELD_OPTS (Field_Options)( \
143                         O_VISIBLE |\
144                         O_ACTIVE  |\
145                         O_PUBLIC  |\
146                         O_EDIT    |\
147                         O_WRAP    |\
148                         O_BLANK   |\
149                         O_AUTOSKIP|\
150                         O_NULLOK  |\
151                         O_PASSOK  |\
152                         O_STATIC   )
153
154 #define C_BLANK ' '
155 #define is_blank(c) ((c)==C_BLANK)
156
157 #define C_ZEROS '\0'
158
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 *);
164
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*);
173
174 #if USE_WIDEC_SUPPORT
175 extern NCURSES_EXPORT(wchar_t *) _nc_Widen_String(char *, int *);
176 #endif
177
178 #ifdef TRACE
179
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)
185
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);
191
192 #else /* !TRACE */
193
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
199
200 #endif /* TRACE/!TRACE */
201
202 /*
203  * Use Check_CTYPE_Field() to simplify FIELDTYPE's that use only the ccheck()
204  * function.
205  */
206 #if USE_WIDEC_SUPPORT
207 #define Check_CTYPE_Field(result, buffer, width, ccheck) \
208   while (*buffer && *buffer == ' ') \
209     buffer++; \
210   if (*buffer) \
211     { \
212       bool blank = FALSE; \
213       int len; \
214       int n; \
215       wchar_t *list = _nc_Widen_String((char *)buffer, &len); \
216       if (list != 0) \
217         { \
218           result = TRUE; \
219           for (n = 0; n < len; ++n) \
220             { \
221               if (blank) \
222                 { \
223                   if (list[n] != ' ') \
224                     { \
225                       result = FALSE; \
226                       break; \
227                     } \
228                 } \
229               else if (list[n] == ' ') \
230                 { \
231                   blank = TRUE; \
232                   result = (n + 1 >= width); \
233                 } \
234               else if (!ccheck(list[n], NULL)) \
235                 { \
236                   result = FALSE; \
237                   break; \
238                 } \
239             } \
240           free(list); \
241         } \
242     }
243 #else
244 #define Check_CTYPE_Field(result, buffer, width, ccheck) \
245   while (*buffer && *buffer == ' ') \
246     buffer++; \
247   if (*buffer) \
248     { \
249       unsigned char *s = buffer; \
250       int l = -1; \
251       while (*buffer && ccheck(*buffer, NULL)) \
252         buffer++; \
253       l = (int)(buffer - s); \
254       while (*buffer && *buffer == ' ') \
255         buffer++; \
256       result = ((*buffer || (l < width)) ? FALSE : TRUE); \
257     }
258 #endif
259
260 #endif /* FORM_PRIV_H */