X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fform_field_validation.3x;h=5f78748bd0fac8e740a936dc3e43481e1bd95e89;hp=2da52efd2e36392a7cfa0ae9da4985f3fb1a4343;hb=17c5992a16be94247b83f2bbb9accdd9b7e7bb72;hpb=f70db18a0c3c6a828d8a5999be37239f01c9d98a diff --git a/man/form_field_validation.3x b/man/form_field_validation.3x index 2da52efd..5f78748b 100644 --- a/man/form_field_validation.3x +++ b/man/form_field_validation.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2003,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2017,2018 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 * @@ -26,10 +26,14 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_validation.3x,v 1.16 2006/12/24 16:08:08 tom Exp $ +.\" $Id: form_field_validation.3x,v 1.23 2018/07/28 21:18:11 tom Exp $ .TH form_field_validation 3X "" +.de bP +.ie n .IP \(bu 4 +.el .IP \(bu 2 +.. .SH NAME -\fBform_field_validation\fR - data type validation for fields +\fBform_field_validation\fR \- data type validation for fields .SH SYNOPSIS \fB#include \fR .br @@ -59,66 +63,106 @@ This is the type checked by validation functions. The predefined types are as follows: .TP 5 TYPE_ALNUM -Alphanumeric data. Requires a third \fBint\fR argument, a minimum field width. +Alphanumeric data. +Requires a third \fBint\fR argument, a minimum field width. .TP 5 TYPE_ALPHA -Character data. Requires a third \fBint\fR argument, a minimum field width. +Character data. +Requires a third \fBint\fR argument, a minimum field width. .TP 5 TYPE_ENUM -Accept one of a specified set of strings. Requires a third \fB(char **)\fR -argument pointing to a string list; a fourth \fBint\fR flag argument to enable -case-sensitivity; and a fifth \fBint\fR flag argument specifying whether a partial -match must be a unique one (if this flag is off, a prefix matches the first -of any set of more than one list elements with that prefix). Please notice -that the string list is not copied, only a reference to it is stored in the -field. So you should avoid using a list that lives in automatic variables -on the stack. +Accept one of a specified set of strings. +Requires additional parameters: +.RS +.bP +a third \fB(char **)\fR argument pointing to a string list; +.bP +a fourth \fBint\fR flag argument to enable case-sensitivity; +.bP +and a fifth \fBint\fR flag argument specifying whether a partial +match must be a unique one. +If this flag is off, a prefix matches the first +of any set of more than one list elements with that prefix. +.IP +The library copies the string list, +so you may use a list that lives in automatic variables on the stack. +.RE .TP 5 TYPE_INTEGER -Integer data, parsable to an integer by \fBatoi(3)\fR. Requires a third -\fBint\fR argument controlling the precision, a fourth \fBlong\fR argument -constraining minimum value, and a fifth \fBlong\fR constraining maximum value. +Integer data, parsable to an integer by \fBatoi\fP(3). +Requires additional parameters: +.RS +.bP +a third \fBint\fR argument controlling the precision, +.bP +a fourth \fBlong\fR argument constraining minimum value, +.bP +and a fifth \fBlong\fR constraining maximum value. If the maximum value is less than or equal to the minimum value, the range is -simply ignored. On return the field buffer is formatted according to the +simply ignored. +On return, the field buffer is formatted according to the \fBprintf\fR format specification ".*ld", where the '*' is replaced by the precision argument. +.IP For details of the precision handling see \fBprintf's\fR man-page. +.RE .TP 5 TYPE_NUMERIC -Numeric data (may have a decimal-point part). Requires a third -\fBint\fR argument controlling the precision, a fourth \fBdouble\fR -argument constraining minimum value, and a fifth \fBdouble\fR constraining -maximum value. If your system supports locales, the decimal point character -to 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 is -simply ignored. On return the field buffer is formatted according to the +Numeric data (may have a decimal-point part). +This requires additional parameters: +.RS +.bP +a third \fBint\fR argument controlling the precision, +.bP +a fourth \fBdouble\fR argument constraining minimum value, +.bP +and a fifth \fBdouble\fR constraining maximum value. +If your system supports locales, +the decimal point character must be the one specified by your locale. +If the maximum value is less than or equal to the minimum value, +the range is simply ignored. +.IP +On return, the field buffer is formatted according to the \fBprintf\fR format specification ".*f", where the '*' is replaced by the precision argument. +.IP For details of the precision handling see \fBprintf's\fR man-page. +.RE .TP 5 TYPE_REGEXP -Regular expression data. Requires a regular expression \fB(char *)\fR third argument; -the data is valid if the regular expression matches it. Regular expressions -are in the format of \fBregcomp\fR and \fBregexec\fR. Please notice -that the regular expression must match the whole field. If you have for -example an eight character wide field, a regular expression "^[0-9]*$" always -means that you have to fill all eight positions with digits. If you want to -allow fewer digits, you may use for example "^[0-9]* *$" which is good for -trailing spaces (up to an empty field), or "^ *[0-9]* *$" which is good for +Regular expression data. +Requires a regular expression \fB(char *)\fR third argument. +The data is valid if the regular expression matches it. +.IP +Regular expressions +are in the format of \fBregcomp\fR and \fBregexec\fR. +.IP +The regular expression must match the whole field. +If you have for example, an eight character wide field, +a regular expression "^[0\-9]*$" always +means that you have to fill all eight positions with digits. +If you want to allow fewer digits, +you may use for example "^[0\-9]* *$" which is good for +trailing spaces (up to an empty field), +or "^ *[0\-9]* *$" which is good for leading and trailing spaces around the digits. .TP 5 TYPE_IPV4 -An Internet Protocol Version 4 address. This requires no additional argument. It -is checked whether or not the buffer has the form a.b.c.d, where a,b,c and d are -numbers between 0 and 255. Trailing blanks in the buffer are ignored. The address -itself is not validated. Please note that this is an ncurses extension. This -field type may not be available in other curses implementations. +An Internet Protocol Version 4 address. +This requires no additional argument. +The library checks whether or not the buffer has the form a.b.c.d, +where a,b,c and d are numbers between 0 and 255. +Trailing blanks in the buffer are ignored. +The address itself is not validated. +.IP +This is an ncurses extension; +this field type may not be available in other curses implementations. .PP -It is possible to set up new programmer-defined field types. See the -\fBform_fieldtype\fR(3X) manual page. +It is possible to set up new programmer-defined field types. +See the \fBform_fieldtype\fR(3X) manual page. .SH RETURN VALUE -The functions \fBfield_type\fR and \fBfield_arg\fR return \fBNULL\fR on -error. The function \fBset_field_type\fR returns one of the following: +The functions \fBfield_type\fR and \fBfield_arg\fR return \fBNULL\fR on error. +The function \fBset_field_type\fR returns one of the following: .TP 5 .B E_OK The routine succeeded. @@ -126,19 +170,16 @@ The routine succeeded. .B E_SYSTEM_ERROR System error occurred (see \fBerrno\fR). .SH SEE ALSO -\fBcurses\fR(3X), \fBform\fR(3X). +\fBcurses\fR(3X), +\fBform\fR(3X), +\fBform_variables\fR(3X). .SH NOTES The header file \fB\fR automatically includes the header file \fB\fR. .SH PORTABILITY -These routines emulate the System V forms library. They were not supported on +These routines emulate the System V forms library. +They were not supported on Version 7 or BSD versions. .SH AUTHORS -Juergen Pfeifer. Manual pages and adaptation for new curses by Eric -S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond.