ncurses 4.1
[ncurses.git] / form / form.h
1 /*-----------------------------------------------------------------------------+
2 |           The ncurses form library is  Copyright (C) 1995-1997               |
3 |             by Juergen Pfeifer <Juergen.Pfeifer@T-Online.de>                 |
4 |                          All Rights Reserved.                                |
5 |                                                                              |
6 | Permission to use, copy, modify, and distribute this software and its        |
7 | documentation for any purpose and without fee is hereby granted, provided    |
8 | that the above copyright notice appear in all copies and that both that      |
9 | copyright notice and this permission notice appear in supporting             |
10 | documentation, and that the name of the above listed copyright holder(s) not |
11 | be used in advertising or publicity pertaining to distribution of the        |
12 | software without specific, written prior permission.                         | 
13 |                                                                              |
14 | THE ABOVE LISTED COPYRIGHT HOLDER(S) DISCLAIM ALL WARRANTIES WITH REGARD TO  |
15 | THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FIT-  |
16 | NESS, IN NO EVENT SHALL THE ABOVE LISTED COPYRIGHT HOLDER(S) BE LIABLE FOR   |
17 | ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RE- |
18 | SULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, |
19 | NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH    |
20 | THE USE OR PERFORMANCE OF THIS SOFTWARE.                                     |
21 +-----------------------------------------------------------------------------*/
22
23 #ifndef FORM_H
24 #define FORM_H
25
26 #include <curses.h>
27 #include <eti.h>
28
29 #ifdef __cplusplus
30   extern "C" {
31 #endif
32
33 typedef int Form_Options;
34 typedef int Field_Options;
35
36         /**********
37         *  _PAGE  *
38         **********/
39
40 typedef struct {
41   short pmin;     /* index of first field on page            */
42   short pmax;     /* index of last field on page             */
43   short smin;     /* index of top leftmost field on page     */
44   short smax;     /* index of bottom rightmost field on page */
45 } _PAGE;
46
47         /**********
48         *  FIELD  *
49         **********/
50
51 typedef struct fieldnode {
52   unsigned short        status;   /* flags                      */
53   short                 rows;     /* size in rows               */
54   short                 cols;     /* size in cols               */
55   short                 frow;     /* first row                  */
56   short                 fcol;     /* first col                  */
57   int                   drows;    /* dynamic rows               */
58   int                   dcols;    /* dynamic cols               */
59   int                   maxgrow;  /* maximum field growth       */
60   int                   nrow;     /* offscreen rows             */
61   short                 nbuf;     /* additional buffers         */
62   short                 just;     /* justification              */
63   short                 page;     /* page on form               */
64   short                 index;    /* into form -> field         */
65   int                   pad;      /* pad character              */
66   chtype                fore;     /* foreground attribute       */
67   chtype                back;     /* background attribute       */
68   Field_Options         opts;     /* options                    */
69   struct fieldnode *    snext;    /* sorted order pointer       */
70   struct fieldnode *    sprev;    /* sorted order pointer       */
71   struct fieldnode *    link;     /* linked field chain         */
72   struct formnode *     form;     /* containing form            */
73   struct typenode *     type;     /* field type                 */
74   void *                arg;      /* argument for type          */
75   char *                buf;      /* field buffers              */
76   const void *          usrptr;   /* user pointer               */
77 } FIELD;
78
79         /**************
80         *  FIELDTYPE  *
81         **************/
82
83 typedef struct typenode {
84   unsigned short        status;                /* flags                */
85   long                  ref;                   /* reference count      */
86   struct typenode *     left;                  /* ptr to operand for | */
87   struct typenode *     right;                 /* ptr to operand for | */
88
89   void* (*makearg)(va_list *);                 /* make fieldtype arg   */
90   void* (*copyarg)(const void *);              /* copy fieldtype arg   */
91   void  (*freearg)(void *);                    /* free fieldtype arg   */
92
93   bool  (*fcheck)(FIELD *,const void *);       /* field validation     */
94   bool  (*ccheck)(int,const void *);           /* character validation */
95
96   bool  (*next)(FIELD *,const void *);         /* enumerate next value */
97   bool  (*prev)(FIELD *,const void *);         /* enumerate prev value */
98
99 } FIELDTYPE;
100
101         /*********
102         *  FORM  *
103         *********/
104
105 typedef struct formnode {
106   unsigned short        status;   /* flags                      */
107   short                 rows;     /* size in rows               */
108   short                 cols;     /* size in cols               */
109   int                   currow;   /* current row in field window*/
110   int                   curcol;   /* current col in field window*/
111   int                   toprow;   /* in scrollable field window */
112   int                   begincol; /* in horiz. scrollable field */
113   short                 maxfield; /* number of fields           */
114   short                 maxpage;  /* number of pages            */
115   short                 curpage;  /* index into page            */
116   Form_Options          opts;     /* options                    */
117   WINDOW *              win;      /* window                     */
118   WINDOW *              sub;      /* subwindow                  */
119   WINDOW *              w;        /* window for current field   */
120   FIELD **              field;    /* field [maxfield]           */
121   FIELD *               current;  /* current field              */
122   _PAGE *               page;     /* page [maxpage]             */
123   const void *          usrptr;   /* user pointer               */
124
125   void                  (*forminit)(struct formnode *);
126   void                  (*formterm)(struct formnode *);
127   void                  (*fieldinit)(struct formnode *);
128   void                  (*fieldterm)(struct formnode *);
129
130 } FORM;
131
132 typedef void (*Form_Hook)(FORM *);
133
134         /***************************
135         *  miscellaneous #defines  *
136         ***************************/
137
138 /* field justification */
139 #define NO_JUSTIFICATION        (0)
140 #define JUSTIFY_LEFT            (1)
141 #define JUSTIFY_CENTER          (2)
142 #define JUSTIFY_RIGHT           (3)
143
144 /* field options */
145 #define O_VISIBLE               (0x0001)
146 #define O_ACTIVE                (0x0002)
147 #define O_PUBLIC                (0x0004)
148 #define O_EDIT                  (0x0008)
149 #define O_WRAP                  (0x0010)
150 #define O_BLANK                 (0x0020)
151 #define O_AUTOSKIP              (0x0040)
152 #define O_NULLOK                (0x0080)
153 #define O_PASSOK                (0x0100)
154 #define O_STATIC                (0x0200)
155
156 /* form options */
157 #define O_NL_OVERLOAD           (0x0001)
158 #define O_BS_OVERLOAD           (0x0002)
159
160 /* form driver commands */
161 #define REQ_NEXT_PAGE    (KEY_MAX + 1)  /* move to next page            */
162 #define REQ_PREV_PAGE    (KEY_MAX + 2)  /* move to previous page        */
163 #define REQ_FIRST_PAGE   (KEY_MAX + 3)  /* move to first page           */
164 #define REQ_LAST_PAGE    (KEY_MAX + 4)  /* move to last page            */
165
166 #define REQ_NEXT_FIELD   (KEY_MAX + 5)  /* move to next field           */
167 #define REQ_PREV_FIELD   (KEY_MAX + 6)  /* move to previous field       */
168 #define REQ_FIRST_FIELD  (KEY_MAX + 7)  /* move to first field          */
169 #define REQ_LAST_FIELD   (KEY_MAX + 8)  /* move to last field           */
170 #define REQ_SNEXT_FIELD  (KEY_MAX + 9)  /* move to sorted next field    */
171 #define REQ_SPREV_FIELD  (KEY_MAX + 10) /* move to sorted prev field    */
172 #define REQ_SFIRST_FIELD (KEY_MAX + 11) /* move to sorted first field   */
173 #define REQ_SLAST_FIELD  (KEY_MAX + 12) /* move to sorted last field    */
174 #define REQ_LEFT_FIELD   (KEY_MAX + 13) /* move to left to field        */
175 #define REQ_RIGHT_FIELD  (KEY_MAX + 14) /* move to right to field       */
176 #define REQ_UP_FIELD     (KEY_MAX + 15) /* move to up to field          */
177 #define REQ_DOWN_FIELD   (KEY_MAX + 16) /* move to down to field        */
178
179 #define REQ_NEXT_CHAR    (KEY_MAX + 17) /* move to next char in field   */
180 #define REQ_PREV_CHAR    (KEY_MAX + 18) /* move to prev char in field   */
181 #define REQ_NEXT_LINE    (KEY_MAX + 19) /* move to next line in field   */
182 #define REQ_PREV_LINE    (KEY_MAX + 20) /* move to prev line in field   */
183 #define REQ_NEXT_WORD    (KEY_MAX + 21) /* move to next word in field   */
184 #define REQ_PREV_WORD    (KEY_MAX + 22) /* move to prev word in field   */
185 #define REQ_BEG_FIELD    (KEY_MAX + 23) /* move to first char in field  */
186 #define REQ_END_FIELD    (KEY_MAX + 24) /* move after last char in fld  */
187 #define REQ_BEG_LINE     (KEY_MAX + 25) /* move to beginning of line    */
188 #define REQ_END_LINE     (KEY_MAX + 26) /* move after last char in line */
189 #define REQ_LEFT_CHAR    (KEY_MAX + 27) /* move left in field           */
190 #define REQ_RIGHT_CHAR   (KEY_MAX + 28) /* move right in field          */
191 #define REQ_UP_CHAR      (KEY_MAX + 29) /* move up in field             */
192 #define REQ_DOWN_CHAR    (KEY_MAX + 30) /* move down in field           */
193
194 #define REQ_NEW_LINE     (KEY_MAX + 31) /* insert/overlay new line      */
195 #define REQ_INS_CHAR     (KEY_MAX + 32) /* insert blank char at cursor  */
196 #define REQ_INS_LINE     (KEY_MAX + 33) /* insert blank line at cursor  */
197 #define REQ_DEL_CHAR     (KEY_MAX + 34) /* delete char at cursor        */
198 #define REQ_DEL_PREV     (KEY_MAX + 35) /* delete char before cursor    */
199 #define REQ_DEL_LINE     (KEY_MAX + 36) /* delete line at cursor        */
200 #define REQ_DEL_WORD     (KEY_MAX + 37) /* delete line at cursor        */
201 #define REQ_CLR_EOL      (KEY_MAX + 38) /* clear to end of line         */
202 #define REQ_CLR_EOF      (KEY_MAX + 39) /* clear to end of field        */
203 #define REQ_CLR_FIELD    (KEY_MAX + 40) /* clear entire field           */
204 #define REQ_OVL_MODE     (KEY_MAX + 41) /* begin overlay mode           */
205 #define REQ_INS_MODE     (KEY_MAX + 42) /* begin insert mode            */
206 #define REQ_SCR_FLINE    (KEY_MAX + 43) /* scroll field forward a line  */
207 #define REQ_SCR_BLINE    (KEY_MAX + 44) /* scroll field backward a line */
208 #define REQ_SCR_FPAGE    (KEY_MAX + 45) /* scroll field forward a page  */
209 #define REQ_SCR_BPAGE    (KEY_MAX + 46) /* scroll field backward a page */
210 #define REQ_SCR_FHPAGE   (KEY_MAX + 47) /* scroll field forward  half page */
211 #define REQ_SCR_BHPAGE   (KEY_MAX + 48) /* scroll field backward half page */
212 #define REQ_SCR_FCHAR    (KEY_MAX + 49) /* horizontal scroll char          */
213 #define REQ_SCR_BCHAR    (KEY_MAX + 50) /* horizontal scroll char          */
214 #define REQ_SCR_HFLINE   (KEY_MAX + 51) /* horizontal scroll line          */
215 #define REQ_SCR_HBLINE   (KEY_MAX + 52) /* horizontal scroll line          */
216 #define REQ_SCR_HFHALF   (KEY_MAX + 53) /* horizontal scroll half line     */
217 #define REQ_SCR_HBHALF   (KEY_MAX + 54) /* horizontal scroll half line     */
218
219 #define REQ_VALIDATION   (KEY_MAX + 55) /* validate field               */
220 #define REQ_NEXT_CHOICE  (KEY_MAX + 56) /* display next field choice    */
221 #define REQ_PREV_CHOICE  (KEY_MAX + 57) /* display prev field choice    */
222
223 #define MIN_FORM_COMMAND (KEY_MAX + 1)  /* used by form_driver          */
224 #define MAX_FORM_COMMAND (KEY_MAX + 57) /* used by form_driver          */
225
226 #if defined(MAX_COMMAND)
227 #  if (MAX_FORM_COMMAND > MAX_COMMAND)
228 #    error Something is wrong -- MAX_FORM_COMMAND is greater than MAX_COMMAND
229 #  elif (MAX_COMMAND != (KEY_MAX + 128))
230 #    error Something is wrong -- MAX_COMMAND is already inconsistently defined.
231 #  endif
232 #else
233 #  define MAX_COMMAND (KEY_MAX + 128)
234 #endif
235
236         /*************************
237         *  standard field types  *
238         *************************/
239 extern FIELDTYPE *TYPE_ALPHA,
240                  *TYPE_ALNUM,
241                  *TYPE_ENUM,
242                  *TYPE_INTEGER,
243                  *TYPE_NUMERIC,
244                  *TYPE_REGEXP;
245
246         /************************************
247         *  built-in additional field types  *
248         *  They are not defined in SVr4     *
249         ************************************/
250 extern FIELDTYPE *TYPE_IPV4;      /* Internet IP Version 4 address */
251
252         /*********************** 
253         *   Default objects    *
254         ***********************/ 
255 extern FORM  *_nc_Default_Form;
256 extern FIELD *_nc_Default_Field;
257
258
259         /***********************
260         *  FIELDTYPE routines  *
261         ***********************/
262 extern FIELDTYPE 
263                 *new_fieldtype(
264                     bool (* const field_check)(FIELD *,const void *),
265                     bool (* const char_check)(int,const void *)),
266                 *link_fieldtype(FIELDTYPE *,FIELDTYPE *);
267
268 extern int      free_fieldtype(FIELDTYPE *),
269                 set_fieldtype_arg(FIELDTYPE *,
270                     void * (* const make_arg)(va_list *),
271                     void * (* const copy_arg)(const void *),
272                     void (* const free_arg)(void *)),
273                 set_fieldtype_choice (FIELDTYPE *,
274                     bool (* const next_choice)(FIELD *,const void *),
275                     bool (* const prev_choice)(FIELD *,const void *));
276
277         /*******************
278         *  FIELD routines  *
279         *******************/
280 extern FIELD    *new_field(int,int,int,int,int,int),
281                 *dup_field(FIELD *,int,int),
282                 *link_field(FIELD *,int,int);
283
284 extern int      free_field(FIELD *),
285                 field_info(const FIELD *,int *,int *,int *,int *,int *,int *),
286                 dynamic_field_info(const FIELD *,int *,int *,int *),
287                 set_max_field( FIELD *,int),
288                 move_field(FIELD *,int,int),
289                 set_field_type(FIELD *,FIELDTYPE *,...),
290                 set_new_page(FIELD *,bool),
291                 set_field_just(FIELD *,int),
292                 field_just(const FIELD *),
293                 set_field_fore(FIELD *,chtype),
294                 set_field_back(FIELD *,chtype),
295                 set_field_pad(FIELD *,int),
296                 field_pad(const FIELD *),
297                 set_field_buffer(FIELD *,int,const char *),
298                 set_field_status(FIELD *,bool),
299                 set_field_userptr(FIELD *,const void *),
300                 set_field_opts(FIELD *,Field_Options),
301                 field_opts_on(FIELD *,Field_Options),
302                 field_opts_off(FIELD *,Field_Options);
303
304 extern chtype   field_fore(const FIELD *),
305                 field_back(const FIELD *);
306
307 extern bool     new_page(const FIELD *),
308                 field_status(const FIELD *);
309
310 extern void     *field_arg(const FIELD *);
311
312 extern const void                
313                 *field_userptr(const FIELD *);
314
315 extern FIELDTYPE
316                 *field_type(const FIELD *);
317
318 extern char*    field_buffer(const FIELD *,int);
319
320 extern Field_Options  
321                 field_opts(const FIELD *);
322
323         /******************
324         *  FORM routines  *
325         ******************/
326 extern FORM     *new_form(FIELD **);
327
328 extern FIELD    **form_fields(const FORM *),
329                 *current_field(const FORM *);
330
331 extern WINDOW   *form_win(const FORM *),
332                 *form_sub(const FORM *);
333
334 extern Form_Hook
335                 form_init(const FORM *),
336                 form_term(const FORM *),
337                 field_init(const FORM *),
338                 field_term(const FORM *);
339
340 extern int      free_form(FORM *),
341                 set_form_fields(FORM *,FIELD **),
342                 field_count(const FORM *),
343                 set_form_win(FORM *,WINDOW *),
344                 set_form_sub(FORM *,WINDOW *),
345                 set_current_field(FORM *,FIELD *),
346                 field_index(const FIELD *),
347                 set_form_page(FORM *,int),
348                 form_page(const FORM *),
349                 scale_form(const FORM *,int *,int *),
350                 set_form_init(FORM *,Form_Hook),
351                 set_form_term(FORM *,Form_Hook),
352                 set_field_init(FORM *,Form_Hook),
353                 set_field_term(FORM *,Form_Hook),
354                 post_form(FORM *),
355                 unpost_form(FORM *),
356                 pos_form_cursor(FORM *),
357                 form_driver(FORM *,int),
358                 set_form_userptr(FORM *,const void *),
359                 set_form_opts(FORM *,Form_Options),
360                 form_opts_on(FORM *,Form_Options),
361                 form_opts_off(FORM *,Form_Options),
362                 form_request_by_name(const char *);
363
364 extern const char
365                 *form_request_name(int);
366
367 extern const void
368                 *form_userptr(const FORM *);
369
370 extern Form_Options
371                 form_opts(const FORM *);
372
373 extern bool     data_ahead(const FORM *),
374                 data_behind(const FORM *);
375
376 #ifdef __cplusplus
377   }
378 #endif
379
380 #endif  /* FORM_H */