1999-08-24 01:06:48 +00:00
|
|
|
'\" t
|
|
|
|
.\"***************************************************************************
|
2020-02-19 16:58:06 +00:00
|
|
|
.\" Copyright 2018-2019,2020 Thomas E. Dickey *
|
|
|
|
.\" Copyright 1998-2006,2010 Free Software Foundation, Inc. *
|
1999-08-24 01:06:48 +00:00
|
|
|
.\" *
|
|
|
|
.\" 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. *
|
|
|
|
.\"***************************************************************************
|
|
|
|
.\"
|
2021-02-25 17:22:00 +00:00
|
|
|
.\" $Id: form_fieldtype.3x,v 1.28 2020/12/12 17:11:21 tom Exp $
|
|
|
|
.de bP
|
|
|
|
.ie n .IP \(bu 4
|
|
|
|
.el .IP \(bu 2
|
|
|
|
..
|
2000-10-11 07:31:01 +00:00
|
|
|
.TH form_fieldtype 3X ""
|
1999-08-24 01:06:48 +00:00
|
|
|
.SH NAME
|
2014-02-28 19:18:07 +00:00
|
|
|
\fBform_fieldtype\fR \- define validation-field types
|
1999-08-24 01:06:48 +00:00
|
|
|
.SH SYNOPSIS
|
|
|
|
\fB#include <form.h>\fR
|
2021-02-25 17:22:00 +00:00
|
|
|
.sp
|
|
|
|
\fBFIELDTYPE *new_fieldtype(\fP
|
|
|
|
\fBbool (* const \fP\fIfield_check\fP\fB)(FIELD *, const void *),\fP
|
|
|
|
\fBbool (* const \fP\fIchar_check\fP\fB)(int, const void *));\fP
|
1999-08-24 01:06:48 +00:00
|
|
|
.br
|
2021-02-25 17:22:00 +00:00
|
|
|
\fBint free_fieldtype(FIELDTYPE *\fP\fIfieldtype\fP\fB);\fP
|
|
|
|
.sp
|
|
|
|
\fBint set_fieldtype_arg(\fP
|
|
|
|
\fBFIELDTYPE *\fP\fIfieldtype\fP\fB,\fP
|
|
|
|
\fBvoid *(* const \fP\fImake_arg\fP\fB)(va_list *),\fP
|
|
|
|
\fBvoid *(* const \fP\fIcopy_arg\fP\fB)(const void *),\fP
|
|
|
|
\fBvoid (* const \fP\fIfree_arg\fP\fB)(void *));\fP
|
1999-08-24 01:06:48 +00:00
|
|
|
.br
|
2021-02-25 17:22:00 +00:00
|
|
|
\fBint set_fieldtype_choice(\fP
|
|
|
|
\fBFIELDTYPE *\fP\fIfieldtype\fP\fB,\fP
|
|
|
|
\fBbool (* const \fP\fInext_choice\fP\fB)(FIELD *, const void *),\fP
|
|
|
|
\fBbool (* const \fP\fIprev_choice\fP\fB)(FIELD *, const void *));\fP
|
|
|
|
.sp
|
|
|
|
\fBFIELDTYPE *link_fieldtype(FIELDTYPE *\fP\fItype1\fP\fB,\fP
|
|
|
|
\fBFIELDTYPE *\fP\fItype2\fP\fB);\fP
|
1999-08-24 01:06:48 +00:00
|
|
|
.SH DESCRIPTION
|
2021-02-25 17:22:00 +00:00
|
|
|
.SS new_fieldtype
|
1999-08-24 01:06:48 +00:00
|
|
|
The function \fBnew_fieldtype\fR creates a new field type usable for data
|
2020-02-07 08:36:41 +00:00
|
|
|
validation.
|
2021-02-25 17:22:00 +00:00
|
|
|
Its parameters are function pointers:
|
|
|
|
.TP 5
|
|
|
|
\fIfield_check\fR
|
|
|
|
This function checks the
|
2007-01-20 07:32:02 +00:00
|
|
|
validity of an entered data string whenever the user attempts to leave a field.
|
2021-02-25 17:22:00 +00:00
|
|
|
It has two arguments:
|
|
|
|
.RS
|
|
|
|
.bP
|
1999-08-24 01:06:48 +00:00
|
|
|
The (FIELD *) argument is passed in so the validation predicate can see the
|
2021-02-25 17:22:00 +00:00
|
|
|
field's buffer, sizes and other attributes.
|
|
|
|
.bP
|
|
|
|
The second argument is an
|
1999-08-24 01:06:48 +00:00
|
|
|
argument-block structure, about which more below.
|
2021-02-25 17:22:00 +00:00
|
|
|
.RE
|
|
|
|
.TP 5
|
|
|
|
\fIchar_check\fR
|
|
|
|
This function validates input characters as they are entered.
|
|
|
|
The form library passes it the character to be checked
|
|
|
|
and a pointer to an argument-block structure.
|
|
|
|
.SS free_fieldtype
|
2007-01-20 07:32:02 +00:00
|
|
|
.PP
|
2021-02-25 17:22:00 +00:00
|
|
|
The \fBfree_fieldtype\fR function
|
|
|
|
frees the space allocated for a given validation type by \fBnew_fieldtype\fP.
|
|
|
|
.SS set_fieldtype_arg
|
2007-01-20 07:32:02 +00:00
|
|
|
.PP
|
2020-02-07 08:36:41 +00:00
|
|
|
The function \fBset_fieldtype_arg\fR associates
|
2021-02-25 17:22:00 +00:00
|
|
|
three storage-management functions with a field type:
|
|
|
|
.TP 5
|
|
|
|
\fImake_arg\fR
|
|
|
|
This function is automatically applied to the
|
1999-08-24 01:06:48 +00:00
|
|
|
list of arguments you give \fBset_field_type\fR when attaching validation
|
2021-02-25 17:22:00 +00:00
|
|
|
to a field.
|
|
|
|
It stores the arguments in an allocated argument-block
|
|
|
|
object which is used when validating input.
|
|
|
|
.TP 5
|
|
|
|
\fIcopy_arg\fR
|
|
|
|
This function may be used by applications to copy argument-blocks.
|
|
|
|
.TP 5
|
|
|
|
\fIfree_arg\fR
|
|
|
|
Frees an argument-block structure.
|
|
|
|
.PP
|
|
|
|
You must supply the \fImake_arg\fR function.
|
|
|
|
The other two are optional: you may supply NULL for them.
|
|
|
|
In this case, the form library assumes
|
2007-01-20 07:32:02 +00:00
|
|
|
that \fImake_arg\fR does not allocate memory but simply loads the
|
1999-08-24 01:06:48 +00:00
|
|
|
argument into a single scalar value.
|
2021-02-25 17:22:00 +00:00
|
|
|
.SS set_fieldtype_choice
|
2007-01-20 07:32:02 +00:00
|
|
|
.PP
|
1999-08-24 01:06:48 +00:00
|
|
|
The form driver requests \fBREQ_NEXT_CHOICE\fR and \fBREQ_PREV_CHOICE\fR assume
|
|
|
|
that the possible values of a field form an ordered set, and provide the forms
|
2007-01-20 07:32:02 +00:00
|
|
|
user with a way to move through the set.
|
2021-02-25 17:22:00 +00:00
|
|
|
.PP
|
2007-01-20 07:32:02 +00:00
|
|
|
The \fBset_fieldtype_choice\fR
|
1999-08-24 01:06:48 +00:00
|
|
|
function allows forms programmers to define successor and predecessor functions
|
2007-01-20 07:32:02 +00:00
|
|
|
for the field type.
|
|
|
|
These functions take the field pointer and an
|
1999-08-24 01:06:48 +00:00
|
|
|
argument-block structure as arguments.
|
2021-02-25 17:22:00 +00:00
|
|
|
.SS link_fieldtype
|
|
|
|
.PP
|
|
|
|
The function \fBlink_fieldtype\fR creates
|
|
|
|
a new field type from the two given types.
|
|
|
|
They are connected by an logical 'OR'.
|
1999-08-24 01:06:48 +00:00
|
|
|
.SH RETURN VALUE
|
|
|
|
The pointer-valued routines return NULL on error.
|
2021-02-25 17:22:00 +00:00
|
|
|
They set \fBerrno\fP according to their success:
|
2007-01-20 07:32:02 +00:00
|
|
|
.TP 5
|
|
|
|
.B E_OK
|
|
|
|
The routine succeeded.
|
|
|
|
.TP 5
|
|
|
|
.B E_BAD_ARGUMENT
|
|
|
|
Routine detected an incorrect or out-of-range argument.
|
|
|
|
.TP 5
|
|
|
|
.B E_SYSTEM_ERROR
|
|
|
|
System error occurred, e.g., malloc failure.
|
|
|
|
.PP
|
1999-08-24 01:06:48 +00:00
|
|
|
The integer-valued routines return one of the following codes on
|
|
|
|
error:
|
|
|
|
.TP 5
|
2007-01-20 07:32:02 +00:00
|
|
|
.B E_OK
|
1999-08-24 01:06:48 +00:00
|
|
|
The routine succeeded.
|
|
|
|
.TP 5
|
2007-01-20 07:32:02 +00:00
|
|
|
.B E_BAD_ARGUMENT
|
1999-08-24 01:06:48 +00:00
|
|
|
Routine detected an incorrect or out-of-range argument.
|
|
|
|
.TP 5
|
2007-01-20 07:32:02 +00:00
|
|
|
.B E_CONNECTED
|
1999-08-24 01:06:48 +00:00
|
|
|
The field is already connected to a form.
|
2007-01-20 07:32:02 +00:00
|
|
|
.TP 5
|
|
|
|
.B E_CURRENT
|
|
|
|
The field is the current field.
|
|
|
|
.TP 5
|
|
|
|
.B E_SYSTEM_ERROR
|
2020-02-07 08:36:41 +00:00
|
|
|
System error occurred (see \fBerrno\fR(3)).
|
1999-08-24 01:06:48 +00:00
|
|
|
.SH SEE ALSO
|
2021-02-25 17:22:00 +00:00
|
|
|
\fBcurses\fR(3X),
|
|
|
|
\fBform\fR(3X),
|
|
|
|
\fBform_field_validation\fR(3X).
|
1999-08-24 01:06:48 +00:00
|
|
|
.SH NOTES
|
|
|
|
The header file \fB<form.h>\fR automatically includes the header file
|
|
|
|
\fB<curses.h>\fR.
|
|
|
|
.SH PORTABILITY
|
2020-02-07 08:36:41 +00:00
|
|
|
These routines emulate the System V forms library.
|
|
|
|
They were not supported on
|
1999-08-24 01:06:48 +00:00
|
|
|
Version 7 or BSD versions.
|
|
|
|
.SH AUTHORS
|
2020-02-07 08:36:41 +00:00
|
|
|
Juergen Pfeifer.
|
|
|
|
Manual pages and adaptation for new curses by Eric S. Raymond.
|