c3f90ba5cb4e987615198881b7c919e488ccc107
[ncurses.git] / man / form_field_validation.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
3 .\"                                                                          *
4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
5 .\" copy of this software and associated documentation files (the            *
6 .\" "Software"), to deal in the Software without restriction, including      *
7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
9 .\" copies of the Software, and to permit persons to whom the Software is    *
10 .\" furnished to do so, subject to the following conditions:                 *
11 .\"                                                                          *
12 .\" The above copyright notice and this permission notice shall be included  *
13 .\" in all copies or substantial portions of the Software.                   *
14 .\"                                                                          *
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22 .\"                                                                          *
23 .\" Except as contained in this notice, the name(s) of the above copyright   *
24 .\" holders shall not be used in advertising or otherwise to promote the     *
25 .\" sale, use or other dealings in this Software without prior written       *
26 .\" authorization.                                                           *
27 .\"***************************************************************************
28 .\"
29 .'" $Id: form_field_validation.3x,v 1.10 1998/03/11 21:12:53 juergen Exp $
30 .TH form_field_validation 3X ""
31 .SH NAME
32 \fBform_field_validation\fR - data type validation for fields 
33 .SH SYNOPSIS
34 \fB#include <form.h>\fR
35 .br
36 int set_field_type(FIELD *field, FIELDTYPE *type, ...);
37 .br
38 FIELDTYPE *field_type(const FIELD *field);
39 .br
40 void *field_arg(const FIELD *field);
41 .br
42 .SH DESCRIPTION
43 The function \fBset_field_type\fR declares a data type for a given form field.
44 This is the type checked by validation functions.  The types are as follows:
45 .TP 5
46 TYPE_ALNUM
47 Alphanumeric data.  Requires a third \fBint\fR argument, a minimum field width.
48 .TP 5
49 TYPE_ALPHA
50 Character data.  Requires a third \fBint\fR argument, a minimum field width.
51 .TP 5
52 TYPE_ENUM
53 Accept one of a specified set of strings.  Requires a third \fB(char **)\fR
54 argument pointing to a string list; a fourth \fBint\fR flag argument to enable
55 case-sensitivity; and a fifth \fBint\fR flag argument specifying whether a partial
56 match must be a unique one (if this flag is off, a prefix matches the first
57 of any set of more than one list elements with that prefix). Please notice
58 that the string list is not copied, only a reference to it is stored in the
59 field. So you should avoid to use a list that lives in automatic variables
60 on the stack.
61 .TP 5
62 TYPE_INTEGER
63 Integer data, parsable to an integer by \fBatoi(3)\fR.  Requires a third
64 \fBint\fR argument controlling the precision, a fourth \fBlong\fR argument 
65 constraining minimum value, and a fifth \fBlong\fR constraining maximum value.
66 If the maximum value is less or equal the minimum value, the range is simply
67 ignored. On return the field buffer is formatted according to the \fBprintf\fR
68 format specification ".*ld", where the '*' is replaced by the precision argument.
69 For details of the precision handling see \fBprintf's\fR man-page.
70 .TP 5
71 TYPE_NUMERIC
72 Numeric data (may have a decimal-point part). Requires a third
73 \fBint\fR argument controlling the precision, a fourth \fBdouble\fR
74 argument constraining minimum value, and a fifth \fBdouble\fR constraining 
75 maximum value. If your system supports locale's, the decimal point character
76 to be used must be the one specified by your locale.
77 If the maximum value is less or equal the minimum value, the range is simply
78 ignored. On return the field buffer is formatted according to the \fBprintf\fR
79 format specification ".*f", where the '*' is replaced by the precision argument.
80 For details of the precision handling see \fBprintf's\fR man-page.
81 .TP 5
82 TYPE_REGEXP
83 Regular expression data.  Requires a regular expression \fB(char *)\fR third argument;
84 the data is valid if the regular expression matches it.  Regular expressions
85 are in the format of \fBregcomp\fR(3X) and \fBregexec\fR(3X). Please notice
86 that the regular expression must match the whole field. If you have for
87 example an eight character wide field, a regular expression "^[0-9]*$" always
88 means that you have to fill all eight positions with digits. If you want to
89 allow fewer digits, you may use for example "^[0-9]* *$" which is good for
90 trailing spaces (up to an empty field), or "^ *[0-9]* *$" which is good for
91 leading and trailing spaces around the digits.
92 .TP 5
93 TYPE_IPV4
94 An Internet Protocol Version 4 address. This requires no additional argument. It
95 is checked whether or not the buffer has the form a.b.c.d, where a,b,c and d are
96 numbers between 0 and 255. Trailing blanks in the buffer are ignored. The address
97 itself is not validated. Please note that this is an ncurses extension. This
98 field type may not be available in other curses implementations.
99
100 It is possible to set up new programmer-defined field types.  See the
101 \fBform_fieldtype\fR(3X) manual page.
102 .SH RETURN VALUE
103 The functions \fBfield_type\fR and \fBfield_arg\fR return \fBNULL\fR on
104 error. The function \fBset_field_type\fR returns one of the following:
105 .TP 5
106 \fBE_OK\fR
107 The routine succeeded.
108 .TP 5
109 \fBE_SYSTEM_ERROR\fR
110 System error occurred (see \fBerrno\fR).
111 .SH SEE ALSO
112 \fBcurses\fR(3X), \fBform\fR(3X).
113 .SH NOTES
114 The header file \fB<form.h>\fR automatically includes the header file
115 \fB<curses.h>\fR.
116 .SH PORTABILITY
117 These routines emulate the System V forms library.  They were not supported on
118 Version 7 or BSD versions.
119 .SH AUTHORS
120 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
121 S. Raymond.
122 .\"#
123 .\"# The following sets edit modes for GNU EMACS
124 .\"# Local Variables:
125 .\"# mode:nroff
126 .\"# fill-column:79
127 .\"# End: