91b08151f8eec4f2b80e239f815b9bd21a5836f2
[ncurses.git] / form / form.priv.h
1 /****************************************************************************
2  * Copyright (c) 1998 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 <Juergen.Pfeifer@T-Online.de> 1995,1997        *
31  ****************************************************************************/
32
33 #include "mf_common.h"
34 #include "form.h"
35
36 /* form  status values */
37 #define _OVLMODE         (0x04) /* Form is in overlay mode                */
38 #define _WINDOW_MODIFIED (0x10) /* Current field window has been modified */
39 #define _FCHECK_REQUIRED (0x20) /* Current field needs validation         */
40
41 /* field status values */
42 #define _CHANGED         (0x01) /* Field has been changed                 */
43 #define _NEWTOP          (0x02) /* Vertical scrolling occured             */
44 #define _NEWPAGE         (0x04) /* field begins new page of form          */
45 #define _MAY_GROW        (0x08) /* dynamic field may still grow           */
46
47 /* fieldtype status values */
48 #define _LINKED_TYPE     (0x01) /* Type is a linked type                  */
49 #define _HAS_ARGS        (0x02) /* Type has arguments                     */
50 #define _HAS_CHOICE      (0x04) /* Type has choice methods                */
51 #define _RESIDENT        (0x08) /* Type is builtin                        */
52
53 /* This are the field options required to be a selectable field in field
54    navigation requests */
55 #define O_SELECTABLE (O_ACTIVE | O_VISIBLE)
56
57 /* If form is NULL replace form argument by default-form */
58 #define Normalize_Form(form)  ((form)=(form)?(form):_nc_Default_Form)
59
60 /* If field is NULL replace field argument by default-field */
61 #define Normalize_Field(field)  ((field)=(field)?(field):_nc_Default_Field)
62
63 /* Retrieve forms window */
64 #define Get_Form_Window(form) \
65   ((form)->sub?(form)->sub:((form)->win?(form)->win:stdscr))
66
67 /* Calculate the size for a single buffer for this field */
68 #define Buffer_Length(field) ((field)->drows * (field)->dcols)
69
70 /* Calculate the total size of all buffers for this field */
71 #define Total_Buffer_Size(field) \
72    ( (Buffer_Length(field) + 1) * (1+(field)->nbuf) )
73
74 /* Logic to determine whether or not a field is single lined */
75 #define Single_Line_Field(field) \
76    (((field)->rows + (field)->nrow) == 1)
77
78 /* Logic to determine whether or not a field is selectable */
79 #define Field_Is_Selectable(f)     (((f)->opts & O_SELECTABLE)==O_SELECTABLE)
80 #define Field_Is_Not_Selectable(f) (((f)->opts & O_SELECTABLE)!=O_SELECTABLE)
81
82 typedef struct typearg {
83   struct typearg *left;
84   struct typearg *right;
85 } TypeArgument;
86
87 /* This is a dummy request code (normally invalid) to be used internally
88    with the form_driver() routine to position to the first active field
89    on the form
90 */
91 #define FIRST_ACTIVE_MAGIC (-291056)
92
93 #define ALL_FORM_OPTS  (                \
94                         O_NL_OVERLOAD  |\
95                         O_BS_OVERLOAD   )
96
97 #define ALL_FIELD_OPTS (           \
98                         O_VISIBLE |\
99                         O_ACTIVE  |\
100                         O_PUBLIC  |\
101                         O_EDIT    |\
102                         O_WRAP    |\
103                         O_BLANK   |\
104                         O_AUTOSKIP|\
105                         O_NULLOK  |\
106                         O_PASSOK  |\
107                         O_STATIC   )
108
109
110 #define C_BLANK ' '
111 #define is_blank(c) ((c)==C_BLANK)
112
113 extern const FIELDTYPE* _nc_Default_FieldType;
114
115 extern TypeArgument* _nc_Make_Argument(const FIELDTYPE*,va_list*,int*);
116 extern TypeArgument *_nc_Copy_Argument(const FIELDTYPE*,const TypeArgument*, int*);
117 extern void _nc_Free_Argument(const FIELDTYPE*,TypeArgument*);
118 extern bool _nc_Copy_Type(FIELD*, FIELD const *);
119 extern void _nc_Free_Type(FIELD *);
120
121 extern int _nc_Synchronize_Attributes(FIELD*);
122 extern int _nc_Synchronize_Options(FIELD*,Field_Options);
123 extern int _nc_Set_Form_Page(FORM*,int,FIELD*);
124 extern int _nc_Refresh_Current_Field(FORM*);
125 extern FIELD* _nc_First_Active_Field(FORM*);
126 extern bool _nc_Internal_Validation(FORM*);
127 extern int _nc_Set_Current_Field(FORM*,FIELD*);
128 extern int _nc_Position_Form_Cursor(FORM*);