blob: 2da52efd2e36392a7cfa0ae9da4985f3fb1a4343 [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301.\"***************************************************************************
2.\" Copyright (c) 1998-2003,2006 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.16 2006/12/24 16:08:08 tom 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
36int set_field_type(FIELD *field, FIELDTYPE *type, ...);
37.br
38FIELDTYPE *field_type(const FIELD *field);
39.br
40void *field_arg(const FIELD *field);
41.sp
42FIELDTYPE *TYPE_ALNUM;
43.br
44FIELDTYPE *TYPE_ALPHA;
45.br
46FIELDTYPE *TYPE_ENUM;
47.br
48FIELDTYPE *TYPE_INTEGER;
49.br
50FIELDTYPE *TYPE_NUMERIC;
51.br
52FIELDTYPE *TYPE_REGEXP;
53.br
54FIELDTYPE *TYPE_IPV4;
55.br
56.SH DESCRIPTION
57The function \fBset_field_type\fR declares a data type for a given form field.
58This is the type checked by validation functions.
59The predefined types are as follows:
60.TP 5
61TYPE_ALNUM
62Alphanumeric data. Requires a third \fBint\fR argument, a minimum field width.
63.TP 5
64TYPE_ALPHA
65Character data. Requires a third \fBint\fR argument, a minimum field width.
66.TP 5
67TYPE_ENUM
68Accept one of a specified set of strings. Requires a third \fB(char **)\fR
69argument pointing to a string list; a fourth \fBint\fR flag argument to enable
70case-sensitivity; and a fifth \fBint\fR flag argument specifying whether a partial
71match must be a unique one (if this flag is off, a prefix matches the first
72of any set of more than one list elements with that prefix). Please notice
73that the string list is not copied, only a reference to it is stored in the
74field. So you should avoid using a list that lives in automatic variables
75on the stack.
76.TP 5
77TYPE_INTEGER
78Integer data, parsable to an integer by \fBatoi(3)\fR. Requires a third
79\fBint\fR argument controlling the precision, a fourth \fBlong\fR argument
80constraining minimum value, and a fifth \fBlong\fR constraining maximum value.
81If the maximum value is less than or equal to the minimum value, the range is
82simply ignored. On return the field buffer is formatted according to the
83\fBprintf\fR format specification ".*ld", where the '*' is replaced by the
84precision argument.
85For details of the precision handling see \fBprintf's\fR man-page.
86.TP 5
87TYPE_NUMERIC
88Numeric data (may have a decimal-point part). Requires a third
89\fBint\fR argument controlling the precision, a fourth \fBdouble\fR
90argument constraining minimum value, and a fifth \fBdouble\fR constraining
91maximum value. If your system supports locales, the decimal point character
92to be used must be the one specified by your locale.
93If the maximum value is less than or equal to the minimum value, the range is
94simply ignored. On return the field buffer is formatted according to the
95\fBprintf\fR format specification ".*f", where the '*' is replaced by the
96precision argument.
97For details of the precision handling see \fBprintf's\fR man-page.
98.TP 5
99TYPE_REGEXP
100Regular expression data. Requires a regular expression \fB(char *)\fR third argument;
101the data is valid if the regular expression matches it. Regular expressions
102are in the format of \fBregcomp\fR and \fBregexec\fR. Please notice
103that the regular expression must match the whole field. If you have for
104example an eight character wide field, a regular expression "^[0-9]*$" always
105means that you have to fill all eight positions with digits. If you want to
106allow fewer digits, you may use for example "^[0-9]* *$" which is good for
107trailing spaces (up to an empty field), or "^ *[0-9]* *$" which is good for
108leading and trailing spaces around the digits.
109.TP 5
110TYPE_IPV4
111An Internet Protocol Version 4 address. This requires no additional argument. It
112is checked whether or not the buffer has the form a.b.c.d, where a,b,c and d are
113numbers between 0 and 255. Trailing blanks in the buffer are ignored. The address
114itself is not validated. Please note that this is an ncurses extension. This
115field type may not be available in other curses implementations.
116.PP
117It is possible to set up new programmer-defined field types. See the
118\fBform_fieldtype\fR(3X) manual page.
119.SH RETURN VALUE
120The functions \fBfield_type\fR and \fBfield_arg\fR return \fBNULL\fR on
121error. The function \fBset_field_type\fR returns one of the following:
122.TP 5
123.B E_OK
124The routine succeeded.
125.TP 5
126.B E_SYSTEM_ERROR
127System error occurred (see \fBerrno\fR).
128.SH SEE ALSO
129\fBcurses\fR(3X), \fBform\fR(3X).
130.SH NOTES
131The header file \fB<form.h>\fR automatically includes the header file
132\fB<curses.h>\fR.
133.SH PORTABILITY
134These routines emulate the System V forms library. They were not supported on
135Version 7 or BSD versions.
136.SH AUTHORS
137Juergen Pfeifer. Manual pages and adaptation for new curses by Eric
138S. Raymond.
139.\"#
140.\"# The following sets edit modes for GNU EMACS
141.\"# Local Variables:
142.\"# mode:nroff
143.\"# fill-column:79
144.\"# End: