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