Spaces:
Running
Running
/**************************************************************************** | |
* Copyright 2018-2019-2020,2021 Thomas E. Dickey * | |
* Copyright 1998-2016,2017 Free Software Foundation, Inc. * | |
* * | |
* Permission is hereby granted, free of charge, to any person obtaining a * | |
* copy of this software and associated documentation files (the * | |
* "Software"), to deal in the Software without restriction, including * | |
* without limitation the rights to use, copy, modify, merge, publish, * | |
* distribute, distribute with modifications, sublicense, and/or sell * | |
* copies of the Software, and to permit persons to whom the Software is * | |
* furnished to do so, subject to the following conditions: * | |
* * | |
* The above copyright notice and this permission notice shall be included * | |
* in all copies or substantial portions of the Software. * | |
* * | |
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * | |
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * | |
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * | |
* IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * | |
* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * | |
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * | |
* THE USE OR OTHER DEALINGS IN THE SOFTWARE. * | |
* * | |
* Except as contained in this notice, the name(s) of the above copyright * | |
* holders shall not be used in advertising or otherwise to promote the * | |
* sale, use or other dealings in this Software without prior written * | |
* authorization. * | |
****************************************************************************/ | |
/**************************************************************************** | |
* Author: Juergen Pfeifer, 1995,1997 * | |
****************************************************************************/ | |
/* $Id: form.h,v 0.32 2021/06/17 21:26:02 tom Exp $ */ | |
/* *INDENT-OFF*/ | |
extern "C" { | |
typedef void *FIELD_CELL; | |
typedef int Form_Options; | |
typedef int Field_Options; | |
/********** | |
* _PAGE * | |
**********/ | |
typedef struct pagenode | |
#if !NCURSES_OPAQUE_FORM | |
{ | |
short pmin; /* index of first field on page */ | |
short pmax; /* index of last field on page */ | |
short smin; /* index of top leftmost field on page */ | |
short smax; /* index of bottom rightmost field on page */ | |
} | |
_PAGE; | |
/********** | |
* FIELD * | |
**********/ | |
typedef struct fieldnode | |
#if 1 /* not yet: !NCURSES_OPAQUE_FORM */ | |
{ | |
unsigned short status; /* flags */ | |
short rows; /* size in rows */ | |
short cols; /* size in cols */ | |
short frow; /* first row */ | |
short fcol; /* first col */ | |
int drows; /* dynamic rows */ | |
int dcols; /* dynamic cols */ | |
int maxgrow; /* maximum field growth */ | |
int nrow; /* off-screen rows */ | |
short nbuf; /* additional buffers */ | |
short just; /* justification */ | |
short page; /* page on form */ | |
short index; /* into form -> field */ | |
int pad; /* pad character */ | |
chtype fore; /* foreground attribute */ | |
chtype back; /* background attribute */ | |
Field_Options opts; /* options */ | |
struct fieldnode * snext; /* sorted order pointer */ | |
struct fieldnode * sprev; /* sorted order pointer */ | |
struct fieldnode * link; /* linked field chain */ | |
struct formnode * form; /* containing form */ | |
struct typenode * type; /* field type */ | |
void * arg; /* argument for type */ | |
FIELD_CELL * buf; /* field buffers */ | |
void * usrptr; /* user pointer */ | |
/* | |
* The wide-character configuration requires extra information. Because | |
* there are existing applications that manipulate the members of FIELD | |
* directly, we cannot make the struct opaque, except by changing the ABI. | |
* Offsets of members up to this point are the same in the narrow- and | |
* wide-character configuration. But note that the type of buf depends on | |
* the configuration, and is made opaque for that reason. | |
*/ | |
NCURSES_FIELD_INTERNALS | |
} | |
FIELD; | |
/********* | |
* FORM * | |
*********/ | |
typedef struct formnode | |
#if 1 /* not yet: !NCURSES_OPAQUE_FORM */ | |
{ | |
unsigned short status; /* flags */ | |
short rows; /* size in rows */ | |
short cols; /* size in cols */ | |
int currow; /* current row in field window */ | |
int curcol; /* current col in field window */ | |
int toprow; /* in scrollable field window */ | |
int begincol; /* in horiz. scrollable field */ | |
short maxfield; /* number of fields */ | |
short maxpage; /* number of pages */ | |
short curpage; /* index into page */ | |
Form_Options opts; /* options */ | |
WINDOW * win; /* window */ | |
WINDOW * sub; /* subwindow */ | |
WINDOW * w; /* window for current field */ | |
FIELD ** field; /* field [maxfield] */ | |
FIELD * current; /* current field */ | |
_PAGE * page; /* page [maxpage] */ | |
void * usrptr; /* user pointer */ | |
void (*forminit)(struct formnode *); | |
void (*formterm)(struct formnode *); | |
void (*fieldinit)(struct formnode *); | |
void (*fieldterm)(struct formnode *); | |
} | |
FORM; | |
/************** | |
* FIELDTYPE * | |
**************/ | |
typedef struct typenode | |
#if !NCURSES_OPAQUE_FORM | |
{ | |
unsigned short status; /* flags */ | |
long ref; /* reference count */ | |
struct typenode * left; /* ptr to operand for | */ | |
struct typenode * right; /* ptr to operand for | */ | |
void* (*makearg)(va_list *); /* make fieldtype arg */ | |
void* (*copyarg)(const void *); /* copy fieldtype arg */ | |
void (*freearg)(void *); /* free fieldtype arg */ | |
union { | |
bool (*ofcheck)(FIELD *,const void *); /* field validation */ | |
bool (*gfcheck)(FORM*,FIELD *,const void*); /* generic field validation */ | |
} fieldcheck; | |
union { | |
bool (*occheck)(int,const void *); /* character validation */ | |
bool (*gccheck)(int,FORM*, | |
FIELD*,const void*); /* generic char validation */ | |
} charcheck; | |
union { | |
bool (*onext)(FIELD *,const void *); /* enumerate next value */ | |
bool (*gnext)(FORM*,FIELD*,const void*); /* generic enumerate next */ | |
} enum_next; | |
union { | |
bool (*oprev)(FIELD *,const void *); /* enumerate prev value */ | |
bool (*gprev)(FORM*,FIELD*,const void*); /* generic enumerate prev */ | |
} enum_prev; | |
void* (*genericarg)(void*); /* Alternate Arg method */ | |
bool (*fcheck)(FIELD *,const void *); /* field validation */ | |
bool (*ccheck)(int,const void *); /* character validation */ | |
bool (*next)(FIELD *,const void *); /* enumerate next value */ | |
bool (*prev)(FIELD *,const void *); /* enumerate prev value */ | |
} | |
FIELDTYPE; | |
typedef void (*Form_Hook)(FORM *); | |
/*************************** | |
* miscellaneous #defines * | |
***************************/ | |
/* field justification */ | |
/* field options */ | |
/* form options */ | |
/* form driver commands */ | |
/************************* | |
* standard field types * | |
*************************/ | |
extern FORM_EXPORT_VAR(FIELDTYPE *) TYPE_ALPHA; | |
extern FORM_EXPORT_VAR(FIELDTYPE *) TYPE_ALNUM; | |
extern FORM_EXPORT_VAR(FIELDTYPE *) TYPE_ENUM; | |
extern FORM_EXPORT_VAR(FIELDTYPE *) TYPE_INTEGER; | |
extern FORM_EXPORT_VAR(FIELDTYPE *) TYPE_NUMERIC; | |
extern FORM_EXPORT_VAR(FIELDTYPE *) TYPE_REGEXP; | |
/************************************ | |
* built-in additional field types * | |
* They are not defined in SVr4 * | |
************************************/ | |
extern FORM_EXPORT_VAR(FIELDTYPE *) TYPE_IPV4; /* Internet IP Version 4 address */ | |
/*********************** | |
* FIELDTYPE routines * | |
***********************/ | |
extern FORM_EXPORT(FIELDTYPE *) new_fieldtype ( | |
bool (* const field_check)(FIELD *,const void *), | |
bool (* const char_check)(int,const void *)); | |
extern FORM_EXPORT(FIELDTYPE *) link_fieldtype( | |
FIELDTYPE *, FIELDTYPE *); | |
extern FORM_EXPORT(int) free_fieldtype (FIELDTYPE *); | |
extern FORM_EXPORT(int) set_fieldtype_arg (FIELDTYPE *, | |
void * (* const make_arg)(va_list *), | |
void * (* const copy_arg)(const void *), | |
void (* const free_arg)(void *)); | |
extern FORM_EXPORT(int) set_fieldtype_choice (FIELDTYPE *, | |
bool (* const next_choice)(FIELD *,const void *), | |
bool (* const prev_choice)(FIELD *,const void *)); | |
/******************* | |
* FIELD routines * | |
*******************/ | |
extern FORM_EXPORT(FIELD *) new_field (int,int,int,int,int,int); | |
extern FORM_EXPORT(FIELD *) dup_field (FIELD *,int,int); | |
extern FORM_EXPORT(FIELD *) link_field (FIELD *,int,int); | |
extern FORM_EXPORT(int) free_field (FIELD *); | |
extern FORM_EXPORT(int) field_info (const FIELD *,int *,int *,int *,int *,int *,int *); | |
extern FORM_EXPORT(int) dynamic_field_info (const FIELD *,int *,int *,int *); | |
extern FORM_EXPORT(int) set_max_field ( FIELD *,int); | |
extern FORM_EXPORT(int) move_field (FIELD *,int,int); | |
extern FORM_EXPORT(int) set_field_type (FIELD *,FIELDTYPE *,...); | |
extern FORM_EXPORT(int) set_new_page (FIELD *,bool); | |
extern FORM_EXPORT(int) set_field_just (FIELD *,int); | |
extern FORM_EXPORT(int) field_just (const FIELD *); | |
extern FORM_EXPORT(int) set_field_fore (FIELD *,chtype); | |
extern FORM_EXPORT(int) set_field_back (FIELD *,chtype); | |
extern FORM_EXPORT(int) set_field_pad (FIELD *,int); | |
extern FORM_EXPORT(int) field_pad (const FIELD *); | |
extern FORM_EXPORT(int) set_field_buffer (FIELD *,int,const char *); | |
extern FORM_EXPORT(int) set_field_status (FIELD *,bool); | |
extern FORM_EXPORT(int) set_field_userptr (FIELD *, void *); | |
extern FORM_EXPORT(int) set_field_opts (FIELD *,Field_Options); | |
extern FORM_EXPORT(int) field_opts_on (FIELD *,Field_Options); | |
extern FORM_EXPORT(int) field_opts_off (FIELD *,Field_Options); | |
extern FORM_EXPORT(chtype) field_fore (const FIELD *); | |
extern FORM_EXPORT(chtype) field_back (const FIELD *); | |
extern FORM_EXPORT(bool) new_page (const FIELD *); | |
extern FORM_EXPORT(bool) field_status (const FIELD *); | |
extern FORM_EXPORT(void *) field_arg (const FIELD *); | |
extern FORM_EXPORT(void *) field_userptr (const FIELD *); | |
extern FORM_EXPORT(FIELDTYPE *) field_type (const FIELD *); | |
extern FORM_EXPORT(char *) field_buffer (const FIELD *,int); | |
extern FORM_EXPORT(Field_Options) field_opts (const FIELD *); | |
/****************** | |
* FORM routines * | |
******************/ | |
extern FORM_EXPORT(FORM *) new_form (FIELD **); | |
extern FORM_EXPORT(FIELD **) form_fields (const FORM *); | |
extern FORM_EXPORT(FIELD *) current_field (const FORM *); | |
extern FORM_EXPORT(WINDOW *) form_win (const FORM *); | |
extern FORM_EXPORT(WINDOW *) form_sub (const FORM *); | |
extern FORM_EXPORT(Form_Hook) form_init (const FORM *); | |
extern FORM_EXPORT(Form_Hook) form_term (const FORM *); | |
extern FORM_EXPORT(Form_Hook) field_init (const FORM *); | |
extern FORM_EXPORT(Form_Hook) field_term (const FORM *); | |
extern FORM_EXPORT(int) free_form (FORM *); | |
extern FORM_EXPORT(int) set_form_fields (FORM *,FIELD **); | |
extern FORM_EXPORT(int) field_count (const FORM *); | |
extern FORM_EXPORT(int) set_form_win (FORM *,WINDOW *); | |
extern FORM_EXPORT(int) set_form_sub (FORM *,WINDOW *); | |
extern FORM_EXPORT(int) set_current_field (FORM *,FIELD *); | |
extern FORM_EXPORT(int) unfocus_current_field (FORM *); | |
extern FORM_EXPORT(int) field_index (const FIELD *); | |
extern FORM_EXPORT(int) set_form_page (FORM *,int); | |
extern FORM_EXPORT(int) form_page (const FORM *); | |
extern FORM_EXPORT(int) scale_form (const FORM *,int *,int *); | |
extern FORM_EXPORT(int) set_form_init (FORM *,Form_Hook); | |
extern FORM_EXPORT(int) set_form_term (FORM *,Form_Hook); | |
extern FORM_EXPORT(int) set_field_init (FORM *,Form_Hook); | |
extern FORM_EXPORT(int) set_field_term (FORM *,Form_Hook); | |
extern FORM_EXPORT(int) post_form (FORM *); | |
extern FORM_EXPORT(int) unpost_form (FORM *); | |
extern FORM_EXPORT(int) pos_form_cursor (FORM *); | |
extern FORM_EXPORT(int) form_driver (FORM *,int); | |
extern FORM_EXPORT(int) form_driver_w (FORM *,int,wchar_t); | |
extern FORM_EXPORT(int) set_form_userptr (FORM *,void *); | |
extern FORM_EXPORT(int) set_form_opts (FORM *,Form_Options); | |
extern FORM_EXPORT(int) form_opts_on (FORM *,Form_Options); | |
extern FORM_EXPORT(int) form_opts_off (FORM *,Form_Options); | |
extern FORM_EXPORT(int) form_request_by_name (const char *); | |
extern FORM_EXPORT(const char *) form_request_name (int); | |
extern FORM_EXPORT(void *) form_userptr (const FORM *); | |
extern FORM_EXPORT(Form_Options) form_opts (const FORM *); | |
extern FORM_EXPORT(bool) data_ahead (const FORM *); | |
extern FORM_EXPORT(bool) data_behind (const FORM *); | |
extern FORM_EXPORT(FORM *) NCURSES_SP_NAME(new_form) (SCREEN*, FIELD **); | |
} | |
/* *INDENT-ON*/ | |