ncurses 6.1 - patch 20190831
[ncurses.git] / form / form.h
1 /****************************************************************************
2  * Copyright (c) 1998-2018,2019 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.h,v 0.29 2019/01/19 21:26:13 Leon.Winter Exp $ */
34
35 #ifndef FORM_H
36 #define FORM_H
37 /* *INDENT-OFF*/
38
39 #include <curses.h>
40 #include <eti.h>
41
42 #ifdef __cplusplus
43   extern "C" {
44 #endif
45
46 #ifndef FORM_PRIV_H
47 typedef void *FIELD_CELL;
48 #endif
49
50 #ifndef NCURSES_FIELD_INTERNALS
51 #define NCURSES_FIELD_INTERNALS /* nothing */
52 #endif
53
54 typedef int Form_Options;
55 typedef int Field_Options;
56
57         /**********
58         *  _PAGE  *
59         **********/
60
61 typedef struct pagenode
62 #if !NCURSES_OPAQUE_FORM
63 {
64   short pmin;           /* index of first field on page                 */
65   short pmax;           /* index of last field on page                  */
66   short smin;           /* index of top leftmost field on page          */
67   short smax;           /* index of bottom rightmost field on page      */
68 }
69 #endif /* !NCURSES_OPAQUE_FORM */
70 _PAGE;
71
72         /**********
73         *  FIELD  *
74         **********/
75
76 typedef struct fieldnode
77 #if 1                   /* not yet: !NCURSES_OPAQUE_FORM */
78 {
79   unsigned short        status;         /* flags                        */
80   short                 rows;           /* size in rows                 */
81   short                 cols;           /* size in cols                 */
82   short                 frow;           /* first row                    */
83   short                 fcol;           /* first col                    */
84   int                   drows;          /* dynamic rows                 */
85   int                   dcols;          /* dynamic cols                 */
86   int                   maxgrow;        /* maximum field growth         */
87   int                   nrow;           /* off-screen rows              */
88   short                 nbuf;           /* additional buffers           */
89   short                 just;           /* justification                */
90   short                 page;           /* page on form                 */
91   short                 index;          /* into form -> field           */
92   int                   pad;            /* pad character                */
93   chtype                fore;           /* foreground attribute         */
94   chtype                back;           /* background attribute         */
95   Field_Options         opts;           /* options                      */
96   struct fieldnode *    snext;          /* sorted order pointer         */
97   struct fieldnode *    sprev;          /* sorted order pointer         */
98   struct fieldnode *    link;           /* linked field chain           */
99   struct formnode *     form;           /* containing form              */
100   struct typenode *     type;           /* field type                   */
101   void *                arg;            /* argument for type            */
102   FIELD_CELL *          buf;            /* field buffers                */
103   void *                usrptr;         /* user pointer                 */
104   /*
105    * The wide-character configuration requires extra information.  Because
106    * there are existing applications that manipulate the members of FIELD
107    * directly, we cannot make the struct opaque, except by changing the ABI. 
108    * Offsets of members up to this point are the same in the narrow- and
109    * wide-character configuration.  But note that the type of buf depends on
110    * the configuration, and is made opaque for that reason.
111    */
112   NCURSES_FIELD_INTERNALS
113 }
114 #endif /* NCURSES_OPAQUE_FORM */
115 FIELD;
116
117
118         /*********
119         *  FORM  *
120         *********/
121
122 typedef struct formnode
123 #if 1                   /* not yet: !NCURSES_OPAQUE_FORM */
124 {
125   unsigned short        status;         /* flags                        */
126   short                 rows;           /* size in rows                 */
127   short                 cols;           /* size in cols                 */
128   int                   currow;         /* current row in field window  */
129   int                   curcol;         /* current col in field window  */
130   int                   toprow;         /* in scrollable field window   */
131   int                   begincol;       /* in horiz. scrollable field   */
132   short                 maxfield;       /* number of fields             */
133   short                 maxpage;        /* number of pages              */
134   short                 curpage;        /* index into page              */
135   Form_Options          opts;           /* options                      */
136   WINDOW *              win;            /* window                       */
137   WINDOW *              sub;            /* subwindow                    */
138   WINDOW *              w;              /* window for current field     */
139   FIELD **              field;          /* field [maxfield]             */
140   FIELD *               current;        /* current field                */
141   _PAGE *               page;           /* page [maxpage]               */
142   void *                usrptr;         /* user pointer                 */
143
144   void                  (*forminit)(struct formnode *);
145   void                  (*formterm)(struct formnode *);
146   void                  (*fieldinit)(struct formnode *);
147   void                  (*fieldterm)(struct formnode *);
148
149 }
150 #endif /* !NCURSES_OPAQUE_FORM */
151 FORM;
152
153
154         /**************
155         *  FIELDTYPE  *
156         **************/
157
158 typedef struct typenode
159 #if !NCURSES_OPAQUE_FORM
160 {
161   unsigned short        status;                 /* flags                    */
162   long                  ref;                    /* reference count          */
163   struct typenode *     left;                   /* ptr to operand for |     */
164   struct typenode *     right;                  /* ptr to operand for |     */
165
166   void* (*makearg)(va_list *);                  /* make fieldtype arg       */
167   void* (*copyarg)(const void *);               /* copy fieldtype arg       */
168   void  (*freearg)(void *);                     /* free fieldtype arg       */
169
170 #if NCURSES_INTEROP_FUNCS
171   union {
172     bool (*ofcheck)(FIELD *,const void *);      /* field validation         */
173     bool (*gfcheck)(FORM*,FIELD *,const void*); /* generic field validation */
174   } fieldcheck;
175   union {
176     bool (*occheck)(int,const void *);          /* character validation     */
177     bool (*gccheck)(int,FORM*,
178                     FIELD*,const void*);        /* generic char validation  */
179   } charcheck;
180   union {
181     bool (*onext)(FIELD *,const void *);        /* enumerate next value     */
182     bool (*gnext)(FORM*,FIELD*,const void*);    /* generic enumerate next   */
183   } enum_next;
184   union {
185     bool (*oprev)(FIELD *,const void *);        /* enumerate prev value     */
186     bool (*gprev)(FORM*,FIELD*,const void*);    /* generic enumerate prev   */
187   } enum_prev;
188   void* (*genericarg)(void*);                   /* Alternate Arg method     */
189 #else
190   bool  (*fcheck)(FIELD *,const void *);        /* field validation     */
191   bool  (*ccheck)(int,const void *);            /* character validation */
192
193   bool  (*next)(FIELD *,const void *);          /* enumerate next value */
194   bool  (*prev)(FIELD *,const void *);          /* enumerate prev value */
195 #endif
196 }
197 #endif /* !NCURSES_OPAQUE_FORM */
198 FIELDTYPE;
199
200 typedef void (*Form_Hook)(FORM *);
201
202         /***************************
203         *  miscellaneous #defines  *
204         ***************************/
205
206 /* field justification */
207 #define NO_JUSTIFICATION        (0)
208 #define JUSTIFY_LEFT            (1)
209 #define JUSTIFY_CENTER          (2)
210 #define JUSTIFY_RIGHT           (3)
211
212 /* field options */
213 #define O_VISIBLE               (0x0001U)
214 #define O_ACTIVE                (0x0002U)
215 #define O_PUBLIC                (0x0004U)
216 #define O_EDIT                  (0x0008U)
217 #define O_WRAP                  (0x0010U)
218 #define O_BLANK                 (0x0020U)
219 #define O_AUTOSKIP              (0x0040U)
220 #define O_NULLOK                (0x0080U)
221 #define O_PASSOK                (0x0100U)
222 #define O_STATIC                (0x0200U)
223 #define O_DYNAMIC_JUSTIFY       (0x0400U)       /* ncurses extension    */
224 #define O_NO_LEFT_STRIP         (0x0800U)       /* ncurses extension    */
225 #define O_EDGE_INSERT_STAY      (0x1000U)       /* ncurses extension    */
226 #define O_INPUT_LIMIT           (0x2000U)       /* ncurses extension    */
227
228 /* form options */
229 #define O_NL_OVERLOAD           (0x0001U)
230 #define O_BS_OVERLOAD           (0x0002U)
231
232 /* form driver commands */
233 #define REQ_NEXT_PAGE    (KEY_MAX + 1)  /* move to next page            */
234 #define REQ_PREV_PAGE    (KEY_MAX + 2)  /* move to previous page        */
235 #define REQ_FIRST_PAGE   (KEY_MAX + 3)  /* move to first page           */
236 #define REQ_LAST_PAGE    (KEY_MAX + 4)  /* move to last page            */
237
238 #define REQ_NEXT_FIELD   (KEY_MAX + 5)  /* move to next field           */
239 #define REQ_PREV_FIELD   (KEY_MAX + 6)  /* move to previous field       */
240 #define REQ_FIRST_FIELD  (KEY_MAX + 7)  /* move to first field          */
241 #define REQ_LAST_FIELD   (KEY_MAX + 8)  /* move to last field           */
242 #define REQ_SNEXT_FIELD  (KEY_MAX + 9)  /* move to sorted next field    */
243 #define REQ_SPREV_FIELD  (KEY_MAX + 10) /* move to sorted prev field    */
244 #define REQ_SFIRST_FIELD (KEY_MAX + 11) /* move to sorted first field   */
245 #define REQ_SLAST_FIELD  (KEY_MAX + 12) /* move to sorted last field    */
246 #define REQ_LEFT_FIELD   (KEY_MAX + 13) /* move to left to field        */
247 #define REQ_RIGHT_FIELD  (KEY_MAX + 14) /* move to right to field       */
248 #define REQ_UP_FIELD     (KEY_MAX + 15) /* move to up to field          */
249 #define REQ_DOWN_FIELD   (KEY_MAX + 16) /* move to down to field        */
250
251 #define REQ_NEXT_CHAR    (KEY_MAX + 17) /* move to next char in field   */
252 #define REQ_PREV_CHAR    (KEY_MAX + 18) /* move to prev char in field   */
253 #define REQ_NEXT_LINE    (KEY_MAX + 19) /* move to next line in field   */
254 #define REQ_PREV_LINE    (KEY_MAX + 20) /* move to prev line in field   */
255 #define REQ_NEXT_WORD    (KEY_MAX + 21) /* move to next word in field   */
256 #define REQ_PREV_WORD    (KEY_MAX + 22) /* move to prev word in field   */
257 #define REQ_BEG_FIELD    (KEY_MAX + 23) /* move to first char in field  */
258 #define REQ_END_FIELD    (KEY_MAX + 24) /* move after last char in fld  */
259 #define REQ_BEG_LINE     (KEY_MAX + 25) /* move to beginning of line    */
260 #define REQ_END_LINE     (KEY_MAX + 26) /* move after last char in line */
261 #define REQ_LEFT_CHAR    (KEY_MAX + 27) /* move left in field           */
262 #define REQ_RIGHT_CHAR   (KEY_MAX + 28) /* move right in field          */
263 #define REQ_UP_CHAR      (KEY_MAX + 29) /* move up in field             */
264 #define REQ_DOWN_CHAR    (KEY_MAX + 30) /* move down in field           */
265
266 #define REQ_NEW_LINE     (KEY_MAX + 31) /* insert/overlay new line      */
267 #define REQ_INS_CHAR     (KEY_MAX + 32) /* insert blank char at cursor  */
268 #define REQ_INS_LINE     (KEY_MAX + 33) /* insert blank line at cursor  */
269 #define REQ_DEL_CHAR     (KEY_MAX + 34) /* delete char at cursor        */
270 #define REQ_DEL_PREV     (KEY_MAX + 35) /* delete char before cursor    */
271 #define REQ_DEL_LINE     (KEY_MAX + 36) /* delete line at cursor        */
272 #define REQ_DEL_WORD     (KEY_MAX + 37) /* delete word at cursor        */
273 #define REQ_CLR_EOL      (KEY_MAX + 38) /* clear to end of line         */
274 #define REQ_CLR_EOF      (KEY_MAX + 39) /* clear to end of field        */
275 #define REQ_CLR_FIELD    (KEY_MAX + 40) /* clear entire field           */
276 #define REQ_OVL_MODE     (KEY_MAX + 41) /* begin overlay mode           */
277 #define REQ_INS_MODE     (KEY_MAX + 42) /* begin insert mode            */
278 #define REQ_SCR_FLINE    (KEY_MAX + 43) /* scroll field forward a line  */
279 #define REQ_SCR_BLINE    (KEY_MAX + 44) /* scroll field backward a line */
280 #define REQ_SCR_FPAGE    (KEY_MAX + 45) /* scroll field forward a page  */
281 #define REQ_SCR_BPAGE    (KEY_MAX + 46) /* scroll field backward a page */
282 #define REQ_SCR_FHPAGE   (KEY_MAX + 47) /* scroll field forward  half page */
283 #define REQ_SCR_BHPAGE   (KEY_MAX + 48) /* scroll field backward half page */
284 #define REQ_SCR_FCHAR    (KEY_MAX + 49) /* horizontal scroll char       */
285 #define REQ_SCR_BCHAR    (KEY_MAX + 50) /* horizontal scroll char       */
286 #define REQ_SCR_HFLINE   (KEY_MAX + 51) /* horizontal scroll line       */
287 #define REQ_SCR_HBLINE   (KEY_MAX + 52) /* horizontal scroll line       */
288 #define REQ_SCR_HFHALF   (KEY_MAX + 53) /* horizontal scroll half line  */
289 #define REQ_SCR_HBHALF   (KEY_MAX + 54) /* horizontal scroll half line  */
290
291 #define REQ_VALIDATION   (KEY_MAX + 55) /* validate field               */
292 #define REQ_NEXT_CHOICE  (KEY_MAX + 56) /* display next field choice    */
293 #define REQ_PREV_CHOICE  (KEY_MAX + 57) /* display prev field choice    */
294
295 #define MIN_FORM_COMMAND (KEY_MAX + 1)  /* used by form_driver          */
296 #define MAX_FORM_COMMAND (KEY_MAX + 57) /* used by form_driver          */
297
298 #if defined(MAX_COMMAND)
299 #  if (MAX_FORM_COMMAND > MAX_COMMAND)
300 #    error Something is wrong -- MAX_FORM_COMMAND is greater than MAX_COMMAND
301 #  elif (MAX_COMMAND != (KEY_MAX + 128))
302 #    error Something is wrong -- MAX_COMMAND is already inconsistently defined.
303 #  endif
304 #else
305 #  define MAX_COMMAND (KEY_MAX + 128)
306 #endif
307
308         /*************************
309         *  standard field types  *
310         *************************/
311 extern NCURSES_EXPORT_VAR(FIELDTYPE *) TYPE_ALPHA;
312 extern NCURSES_EXPORT_VAR(FIELDTYPE *) TYPE_ALNUM;
313 extern NCURSES_EXPORT_VAR(FIELDTYPE *) TYPE_ENUM;
314 extern NCURSES_EXPORT_VAR(FIELDTYPE *) TYPE_INTEGER;
315 extern NCURSES_EXPORT_VAR(FIELDTYPE *) TYPE_NUMERIC;
316 extern NCURSES_EXPORT_VAR(FIELDTYPE *) TYPE_REGEXP;
317
318         /************************************
319         *  built-in additional field types  *
320         *  They are not defined in SVr4     *
321         ************************************/
322 extern NCURSES_EXPORT_VAR(FIELDTYPE *) TYPE_IPV4;      /* Internet IP Version 4 address */
323
324         /***********************
325         *  FIELDTYPE routines  *
326         ***********************/
327 extern NCURSES_EXPORT(FIELDTYPE *) new_fieldtype (
328                     bool (* const field_check)(FIELD *,const void *),
329                     bool (* const char_check)(int,const void *));
330 extern NCURSES_EXPORT(FIELDTYPE *) link_fieldtype(
331                     FIELDTYPE *, FIELDTYPE *);
332
333 extern NCURSES_EXPORT(int)      free_fieldtype (FIELDTYPE *);
334 extern NCURSES_EXPORT(int)      set_fieldtype_arg (FIELDTYPE *,
335                     void * (* const make_arg)(va_list *),
336                     void * (* const copy_arg)(const void *),
337                     void (* const free_arg)(void *));
338 extern NCURSES_EXPORT(int)       set_fieldtype_choice (FIELDTYPE *,
339                     bool (* const next_choice)(FIELD *,const void *),
340                     bool (* const prev_choice)(FIELD *,const void *));
341
342         /*******************
343         *  FIELD routines  *
344         *******************/
345 extern NCURSES_EXPORT(FIELD *)  new_field (int,int,int,int,int,int);
346 extern NCURSES_EXPORT(FIELD *)  dup_field (FIELD *,int,int);
347 extern NCURSES_EXPORT(FIELD *)  link_field (FIELD *,int,int);
348
349 extern NCURSES_EXPORT(int)      free_field (FIELD *);
350 extern NCURSES_EXPORT(int)      field_info (const FIELD *,int *,int *,int *,int *,int *,int *);
351 extern NCURSES_EXPORT(int)      dynamic_field_info (const FIELD *,int *,int *,int *);
352 extern NCURSES_EXPORT(int)      set_max_field ( FIELD *,int);
353 extern NCURSES_EXPORT(int)      move_field (FIELD *,int,int);
354 extern NCURSES_EXPORT(int)      set_field_type (FIELD *,FIELDTYPE *,...);
355 extern NCURSES_EXPORT(int)      set_new_page (FIELD *,bool);
356 extern NCURSES_EXPORT(int)      set_field_just (FIELD *,int);
357 extern NCURSES_EXPORT(int)      field_just (const FIELD *);
358 extern NCURSES_EXPORT(int)      set_field_fore (FIELD *,chtype);
359 extern NCURSES_EXPORT(int)      set_field_back (FIELD *,chtype);
360 extern NCURSES_EXPORT(int)      set_field_pad (FIELD *,int);
361 extern NCURSES_EXPORT(int)      field_pad (const FIELD *);
362 extern NCURSES_EXPORT(int)      set_field_buffer (FIELD *,int,const char *);
363 extern NCURSES_EXPORT(int)      set_field_status (FIELD *,bool);
364 extern NCURSES_EXPORT(int)      set_field_userptr (FIELD *, void *);
365 extern NCURSES_EXPORT(int)      set_field_opts (FIELD *,Field_Options);
366 extern NCURSES_EXPORT(int)      field_opts_on (FIELD *,Field_Options);
367 extern NCURSES_EXPORT(int)      field_opts_off (FIELD *,Field_Options);
368
369 extern NCURSES_EXPORT(chtype)   field_fore (const FIELD *);
370 extern NCURSES_EXPORT(chtype)   field_back (const FIELD *);
371
372 extern NCURSES_EXPORT(bool)     new_page (const FIELD *);
373 extern NCURSES_EXPORT(bool)     field_status (const FIELD *);
374
375 extern NCURSES_EXPORT(void *)   field_arg (const FIELD *);
376
377 extern NCURSES_EXPORT(void *)   field_userptr (const FIELD *);
378
379 extern NCURSES_EXPORT(FIELDTYPE *)      field_type (const FIELD *);
380
381 extern NCURSES_EXPORT(char *)   field_buffer (const FIELD *,int);
382
383 extern NCURSES_EXPORT(Field_Options)    field_opts (const FIELD *);
384
385         /******************
386         *  FORM routines  *
387         ******************/
388
389 extern NCURSES_EXPORT(FORM *)   new_form (FIELD **);
390
391 extern NCURSES_EXPORT(FIELD **) form_fields (const FORM *);
392 extern NCURSES_EXPORT(FIELD *)  current_field (const FORM *);
393
394 extern NCURSES_EXPORT(WINDOW *) form_win (const FORM *);
395 extern NCURSES_EXPORT(WINDOW *) form_sub (const FORM *);
396
397 extern NCURSES_EXPORT(Form_Hook)        form_init (const FORM *);
398 extern NCURSES_EXPORT(Form_Hook)        form_term (const FORM *);
399 extern NCURSES_EXPORT(Form_Hook)        field_init (const FORM *);
400 extern NCURSES_EXPORT(Form_Hook)        field_term (const FORM *);
401
402 extern NCURSES_EXPORT(int)      free_form (FORM *);
403 extern NCURSES_EXPORT(int)      set_form_fields (FORM *,FIELD **);
404 extern NCURSES_EXPORT(int)      field_count (const FORM *);
405 extern NCURSES_EXPORT(int)      set_form_win (FORM *,WINDOW *);
406 extern NCURSES_EXPORT(int)      set_form_sub (FORM *,WINDOW *);
407 extern NCURSES_EXPORT(int)      set_current_field (FORM *,FIELD *);
408 extern NCURSES_EXPORT(int)      unfocus_current_field (FORM *);
409 extern NCURSES_EXPORT(int)      field_index (const FIELD *);
410 extern NCURSES_EXPORT(int)      set_form_page (FORM *,int);
411 extern NCURSES_EXPORT(int)      form_page (const FORM *);
412 extern NCURSES_EXPORT(int)      scale_form (const FORM *,int *,int *);
413 extern NCURSES_EXPORT(int)      set_form_init (FORM *,Form_Hook);
414 extern NCURSES_EXPORT(int)      set_form_term (FORM *,Form_Hook);
415 extern NCURSES_EXPORT(int)      set_field_init (FORM *,Form_Hook);
416 extern NCURSES_EXPORT(int)      set_field_term (FORM *,Form_Hook);
417 extern NCURSES_EXPORT(int)      post_form (FORM *);
418 extern NCURSES_EXPORT(int)      unpost_form (FORM *);
419 extern NCURSES_EXPORT(int)      pos_form_cursor (FORM *);
420 extern NCURSES_EXPORT(int)      form_driver (FORM *,int);
421 # if NCURSES_WIDECHAR
422 extern NCURSES_EXPORT(int)      form_driver_w (FORM *,int,wchar_t);
423 # endif
424 extern NCURSES_EXPORT(int)      set_form_userptr (FORM *,void *);
425 extern NCURSES_EXPORT(int)      set_form_opts (FORM *,Form_Options);
426 extern NCURSES_EXPORT(int)      form_opts_on (FORM *,Form_Options);
427 extern NCURSES_EXPORT(int)      form_opts_off (FORM *,Form_Options);
428 extern NCURSES_EXPORT(int)      form_request_by_name (const char *);
429
430 extern NCURSES_EXPORT(const char *)     form_request_name (int);
431
432 extern NCURSES_EXPORT(void *)   form_userptr (const FORM *);
433
434 extern NCURSES_EXPORT(Form_Options)     form_opts (const FORM *);
435
436 extern NCURSES_EXPORT(bool)     data_ahead (const FORM *);
437 extern NCURSES_EXPORT(bool)     data_behind (const FORM *);
438
439 #if NCURSES_SP_FUNCS
440 extern NCURSES_EXPORT(FORM *)   NCURSES_SP_NAME(new_form) (SCREEN*, FIELD **);
441 #endif
442
443 #ifdef __cplusplus
444   }
445 #endif
446 /* *INDENT-ON*/
447
448 #endif /* FORM_H */