.\"***************************************************************************.\" Copyright (c) 1998-2002,2003 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.                                                           *.\"***************************************************************************.\".\" $Id: form_field_validation.3x,v 1.14 2003/05/10 20:33:49 jmc Exp $.TH form_field_validation 3X "".SH NAME\fBform_field_validation\fR - data type validation for fields.SH SYNOPSIS\fB#include <form.h>\fR.brint set_field_type(FIELD *field, FIELDTYPE *type, ...);.brFIELDTYPE *field_type(const FIELD *field);.brvoid *field_arg(const FIELD *field);.spFIELDTYPE *TYPE_ALNUM;.brFIELDTYPE *TYPE_ALPHA;.brFIELDTYPE *TYPE_ENUM;.brFIELDTYPE *TYPE_INTEGER;.brFIELDTYPE *TYPE_NUMERIC;.brFIELDTYPE *TYPE_REGEXP;.brFIELDTYPE *TYPE_IPV4;.br.SH DESCRIPTIONThe function \fBset_field_type\fR declares a data type for a given form field.This is the type checked by validation functions.The predefined types are as follows:.TP 5TYPE_ALNUMAlphanumeric data.  Requires a third \fBint\fR argument, a minimum field width..TP 5TYPE_ALPHACharacter data.  Requires a third \fBint\fR argument, a minimum field width..TP 5TYPE_ENUMAccept one of a specified set of strings.  Requires a third \fB(char **)\fRargument pointing to a string list; a fourth \fBint\fR flag argument to enablecase-sensitivity; and a fifth \fBint\fR flag argument specifying whether a partialmatch must be a unique one (if this flag is off, a prefix matches the firstof any set of more than one list elements with that prefix). Please noticethat the string list is not copied, only a reference to it is stored in thefield. So you should avoid using a list that lives in automatic variableson the stack..TP 5TYPE_INTEGERInteger data, parsable to an integer by \fBatoi(3)\fR.  Requires a third\fBint\fR argument controlling the precision, a fourth \fBlong\fR argumentconstraining minimum value, and a fifth \fBlong\fR constraining maximum value.If the maximum value is less than or equal to the minimum value, the range issimply ignored. On return the field buffer is formatted according to the\fBprintf\fR format specification ".*ld", where the '*' is replaced by theprecision argument.For details of the precision handling see \fBprintf's\fR man-page..TP 5TYPE_NUMERICNumeric data (may have a decimal-point part). Requires a third\fBint\fR argument controlling the precision, a fourth \fBdouble\fRargument constraining minimum value, and a fifth \fBdouble\fR constrainingmaximum value. If your system supports locales, the decimal point characterto be used must be the one specified by your locale.If the maximum value is less than or equal to the minimum value, the range issimply ignored. On return the field buffer is formatted according to the\fBprintf\fR format specification ".*f", where the '*' is replaced by theprecision argument.For details of the precision handling see \fBprintf's\fR man-page..TP 5TYPE_REGEXPRegular expression data.  Requires a regular expression \fB(char *)\fR third argument;the data is valid if the regular expression matches it.  Regular expressionsare in the format of \fBregcomp\fR(3X) and \fBregexec\fR(3X). Please noticethat the regular expression must match the whole field. If you have forexample an eight character wide field, a regular expression "^[0-9]*$" alwaysmeans that you have to fill all eight positions with digits. If you want toallow fewer digits, you may use for example "^[0-9]* *$" which is good fortrailing spaces (up to an empty field), or "^ *[0-9]* *$" which is good forleading and trailing spaces around the digits..TP 5TYPE_IPV4An Internet Protocol Version 4 address. This requires no additional argument. Itis checked whether or not the buffer has the form a.b.c.d, where a,b,c and d arenumbers between 0 and 255. Trailing blanks in the buffer are ignored. The addressitself is not validated. Please note that this is an ncurses extension. Thisfield type may not be available in other curses implementations..PPIt is possible to set up new programmer-defined field types.  See the\fBform_fieldtype\fR(3X) manual page..SH RETURN VALUEThe functions \fBfield_type\fR and \fBfield_arg\fR return \fBNULL\fR onerror. The function \fBset_field_type\fR returns one of the following:.TP 5\fBE_OK\fRThe routine succeeded..TP 5\fBE_SYSTEM_ERROR\fRSystem error occurred (see \fBerrno\fR)..SH SEE ALSO\fBcurses\fR(3X), \fBform\fR(3X)..SH NOTESThe header file \fB<form.h>\fR automatically includes the header file\fB<curses.h>\fR..SH PORTABILITYThese routines emulate the System V forms library.  They were not supported onVersion 7 or BSD versions..SH AUTHORSJuergen Pfeifer.  Manual pages and adaptation for new curses by EricS. Raymond..\"#.\"# The following sets edit modes for GNU EMACS.\"# Local Variables:.\"# mode:nroff.\"# fill-column:79.\"# End: