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