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