2 ****************************************************************************
3 * Copyright (c) 1998-2010,2017 Free Software Foundation, Inc. *
5 * Permission is hereby granted, free of charge, to any person obtaining a *
6 * copy of this software and associated documentation files (the *
7 * "Software"), to deal in the Software without restriction, including *
8 * without limitation the rights to use, copy, modify, merge, publish, *
9 * distribute, distribute with modifications, sublicense, and/or sell *
10 * copies of the Software, and to permit persons to whom the Software is *
11 * furnished to do so, subject to the following conditions: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
24 * Except as contained in this notice, the name(s) of the above copyright *
25 * holders shall not be used in advertising or otherwise to promote the *
26 * sale, use or other dealings in this Software without prior written *
28 ****************************************************************************
29 * @Id: form_field_validation.3x,v 1.21 2017/11/20 01:28:31 tom Exp @
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>form_field_validation 3x</TITLE>
37 <link rev=made href="mailto:bug-ncurses@gnu.org">
38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
41 <H1 class="no-header">form_field_validation 3x</H1>
43 <STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG> <STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG>
48 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
49 <STRONG>form_field_validation</STRONG> - data type validation for fields
52 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
53 <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
54 int set_field_type(FIELD *field, FIELDTYPE *type, ...);
55 FIELDTYPE *field_type(const FIELD *field);
56 void *field_arg(const FIELD *field);
58 FIELDTYPE *TYPE_ALNUM;
59 FIELDTYPE *TYPE_ALPHA;
61 FIELDTYPE *TYPE_INTEGER;
62 FIELDTYPE *TYPE_NUMERIC;
63 FIELDTYPE *TYPE_REGEXP;
67 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
68 The function <STRONG>set_field_type</STRONG> declares a data type for a given form
69 field. This is the type checked by validation functions. The prede-
70 fined types are as follows:
73 Alphanumeric data. Requires a third <STRONG>int</STRONG> argument, a minimum field
77 Character data. Requires a third <STRONG>int</STRONG> argument, a minimum field
81 Accept one of a specified set of strings. Requires a third <STRONG>(char</STRONG>
82 <STRONG>**)</STRONG> argument pointing to a string list; a fourth <STRONG>int</STRONG> flag argument
83 to enable case-sensitivity; and a fifth <STRONG>int</STRONG> flag argument specify-
84 ing whether a partial match must be a unique one (if this flag is
85 off, a prefix matches the first of any set of more than one list
86 elements with that prefix). Please notice that the string list is
87 copied. So you may use a list that lives in automatic variables on
91 Integer data, parsable to an integer by <STRONG>atoi(3)</STRONG>. Requires a third
92 <STRONG>int</STRONG> argument controlling the precision, a fourth <STRONG>long</STRONG> argument
93 constraining minimum value, and a fifth <STRONG>long</STRONG> constraining maximum
94 value. If the maximum value is less than or equal to the minimum
95 value, the range is simply ignored. On return the field buffer is
96 formatted according to the <STRONG>printf</STRONG> format specification ".*ld",
97 where the '*' is replaced by the precision argument. For details
98 of the precision handling see <STRONG>printf's</STRONG> man-page.
101 Numeric data (may have a decimal-point part). Requires a third <STRONG>int</STRONG>
102 argument controlling the precision, a fourth <STRONG>double</STRONG> argument con-
103 straining minimum value, and a fifth <STRONG>double</STRONG> constraining maximum
104 value. If your system supports locales, the decimal point charac-
105 ter to be used must be the one specified by your locale. If the
106 maximum value is less than or equal to the minimum value, the
107 range is simply ignored. On return the field buffer is formatted
108 according to the <STRONG>printf</STRONG> format specification ".*f", where the '*'
109 is replaced by the precision argument. For details of the preci-
110 sion handling see <STRONG>printf's</STRONG> man-page.
113 Regular expression data. Requires a regular expression <STRONG>(char</STRONG> <STRONG>*)</STRONG>
114 third argument; the data is valid if the regular expression
115 matches it. Regular expressions are in the format of <STRONG>regcomp</STRONG> and
116 <STRONG>regexec</STRONG>. Please notice that the regular expression must match the
117 whole field. If you have for example an eight character wide
118 field, a regular expression "^[0-9]*$" always means that you have
119 to fill all eight positions with digits. If you want to allow
120 fewer digits, you may use for example "^[0-9]* *$" which is good
121 for trailing spaces (up to an empty field), or "^ *[0-9]* *$"
122 which is good for leading and trailing spaces around the digits.
125 An Internet Protocol Version 4 address. This requires no addi-
126 tional argument. It is checked whether or not the buffer has the
127 form a.b.c.d, where a,b,c and d are numbers between 0 and 255.
128 Trailing blanks in the buffer are ignored. The address itself is
129 not validated. Please note that this is an ncurses extension. This
130 field type may not be available in other curses implementations.
132 It is possible to set up new programmer-defined field types. See the
133 <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG> manual page.
136 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
137 The functions <STRONG>field_type</STRONG> and <STRONG>field_arg</STRONG> return <STRONG>NULL</STRONG> on error. The func-
138 tion <STRONG>set_field_type</STRONG> returns one of the following:
140 <STRONG>E_OK</STRONG> The routine succeeded.
142 <STRONG>E_SYSTEM_ERROR</STRONG>
143 System error occurred (see <STRONG>errno</STRONG>).
146 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
147 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>, <STRONG><A HREF="form_variables.3x.html">form_variables(3x)</A></STRONG>.
150 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
151 The header file <STRONG><form.h></STRONG> automatically includes the header file
152 <STRONG><curses.h></STRONG>.
155 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
156 These routines emulate the System V forms library. They were not sup-
157 ported on Version 7 or BSD versions.
160 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
161 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
166 <STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG>
170 <li><a href="#h2-NAME">NAME</a></li>
171 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
172 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
173 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
174 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
175 <li><a href="#h2-NOTES">NOTES</a></li>
176 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
177 <li><a href="#h2-AUTHORS">AUTHORS</a></li>