ncurses 5.3
[ncurses.git] / doc / html / man / form_field_validation.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   ****************************************************************************
4   * Copyright (c) 1998,2002 Free Software Foundation, Inc.                   *
5   *                                                                          *
6   * Permission is hereby granted, free of charge, to any person obtaining a  *
7   * copy of this software and associated documentation files (the            *
8   * "Software"), to deal in the Software without restriction, including      *
9   * without limitation the rights to use, copy, modify, merge, publish,      *
10   * distribute, distribute with modifications, sublicense, and/or sell       *
11   * copies of the Software, and to permit persons to whom the Software is    *
12   * furnished to do so, subject to the following conditions:                 *
13   *                                                                          *
14   * The above copyright notice and this permission notice shall be included  *
15   * in all copies or substantial portions of the Software.                   *
16   *                                                                          *
17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
24   *                                                                          *
25   * Except as contained in this notice, the name(s) of the above copyright   *
26   * holders shall not be used in advertising or otherwise to promote the     *
27   * sale, use or other dealings in this Software without prior written       *
28   * authorization.                                                           *
29   ****************************************************************************
30   * @Id: form_field_validation.3x,v 1.12 2002/02/16 22:39:52 tom Exp @
31 -->
32 <HTML>
33 <HEAD>
34 <TITLE>form_field_validation 3x</TITLE>
35 <link rev=made href="mailto:bug-ncurses@gnu.org">
36 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
37 </HEAD>
38 <BODY>
39 <H1>form_field_validation 3x</H1>
40 <HR>
41 <PRE>
42 <!-- Manpage converted by man2html 3.0.1 -->
43
44 </PRE>
45 <H2>NAME</H2><PRE>
46        <STRONG>form_field_validation</STRONG> - data type validation for fields
47
48
49 </PRE>
50 <H2>SYNOPSIS</H2><PRE>
51        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
52        int set_field_type(FIELD *field, FIELDTYPE *type, ...);
53        FIELDTYPE *field_type(const FIELD *field);
54        void *field_arg(const FIELD *field);
55
56
57 </PRE>
58 <H2>DESCRIPTION</H2><PRE>
59        The  function  <STRONG>set_field_type</STRONG>  declares  a data type for a
60        given form field.  This is the type checked by  validation
61        functions.  The types are as follows:
62
63        TYPE_ALNUM
64             Alphanumeric  data.  Requires a third <STRONG>int</STRONG> argument, a
65             minimum field width.
66
67        TYPE_ALPHA
68             Character data.  Requires a  third  <STRONG>int</STRONG>  argument,  a
69             minimum field width.
70
71        TYPE_ENUM
72             Accept one of a specified set of strings.  Requires a
73             third <STRONG>(char</STRONG> <STRONG>**)</STRONG> argument pointing to a string list; a
74             fourth  <STRONG>int</STRONG> flag argument to enable case-sensitivity;
75             and a fifth <STRONG>int</STRONG> flag argument  specifying  whether  a
76             partial  match  must be a unique one (if this flag is
77             off, a prefix matches the first of any  set  of  more
78             than  one  list  elements  with  that prefix). Please
79             notice that the string list is  not  copied,  only  a
80             reference to it is stored in the field. So you should
81             avoid to use a list that lives in automatic variables
82             on the stack.
83
84        TYPE_INTEGER
85             Integer  data,  parsable  to  an  integer by <STRONG>atoi(3)</STRONG>.
86             Requires a third <STRONG>int</STRONG> argument controlling the  preci-
87             sion,  a  fourth  <STRONG>long</STRONG>  argument constraining minimum
88             value, and a fifth <STRONG>long</STRONG> constraining  maximum  value.
89             If  the  maximum  value  is less or equal the minimum
90             value, the range is simply  ignored.  On  return  the
91             field  buffer  is  formatted  according to the <STRONG>printf</STRONG>
92             format  specification  ".*ld",  where  the   '*'   is
93             replaced  by  the precision argument.  For details of
94             the precision handling see <STRONG>printf's</STRONG> man-page.
95
96        TYPE_NUMERIC
97             Numeric  data  (may  have  a   decimal-point   part).
98             Requires  a third <STRONG>int</STRONG> argument controlling the preci-
99             sion, a fourth <STRONG>double</STRONG> argument  constraining  minimum
100             value, and a fifth <STRONG>double</STRONG> constraining maximum value.
101             If your system supports locale's, the  decimal  point
102             character  to  be  used  must be the one specified by
103             your locale.  If the maximum value is less  or  equal
104             the  minimum  value,  the range is simply ignored. On
105             return the field buffer is formatted according to the
106             <STRONG>printf</STRONG>  format  specification ".*f", where the '*' is
107             replaced by the precision argument.  For  details  of
108             the precision handling see <STRONG>printf's</STRONG> man-page.
109
110        TYPE_REGEXP
111             Regular  expression data.  Requires a regular expres-
112             sion <STRONG>(char</STRONG> <STRONG>*)</STRONG> third argument; the data  is  valid  if
113             the  regular  expression matches it.  Regular expres-
114             sions  are  in  the   format   of   <STRONG><A HREF="regcomp.3x.html">regcomp(3x)</A></STRONG>   and
115             <STRONG><A HREF="regexec.3x.html">regexec(3x)</A></STRONG>.  Please  notice that the regular expres-
116             sion must match the whole  field.  If  you  have  for
117             example  an  eight  character  wide  field, a regular
118             expression "^[0-9]*$" always means that you  have  to
119             fill  all eight positions with digits. If you want to
120             allow fewer digits, you may use for example  "^[0-9]*
121             *$" which is good for trailing spaces (up to an empty
122             field), or "^ *[0-9]* *$" which is good  for  leading
123             and trailing spaces around the digits.
124
125        TYPE_IPV4
126             An Internet Protocol Version 4 address. This requires
127             no additional argument. It is checked whether or  not
128             the  buffer  has  the form a.b.c.d, where a,b,c and d
129             are numbers between 0 and 255. Trailing blanks in the
130             buffer  are  ignored. The address itself is not vali-
131             dated. Please note that this is an ncurses extension.
132             This  field type may not be available in other curses
133             implementations.
134
135             It is possible to set up new programmer-defined field
136             types.  See the <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG> manual page.
137
138
139 </PRE>
140 <H2>RETURN VALUE</H2><PRE>
141        The  functions  <STRONG>field_type</STRONG>  and  <STRONG>field_arg</STRONG>  return <STRONG>NULL</STRONG> on
142        error. The function <STRONG>set_field_type</STRONG> returns one of the fol-
143        lowing:
144
145        <STRONG>E_OK</STRONG> The routine succeeded.
146
147        <STRONG>E_SYSTEM_ERROR</STRONG>
148             System error occurred (see <STRONG>errno</STRONG>).
149
150
151 </PRE>
152 <H2>SEE ALSO</H2><PRE>
153        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
154
155
156 </PRE>
157 <H2>NOTES</H2><PRE>
158        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
159        file <STRONG>&lt;curses.h&gt;</STRONG>.
160
161
162 </PRE>
163 <H2>PORTABILITY</H2><PRE>
164        These routines emulate the System V forms  library.   They
165        were not supported on Version 7 or BSD versions.
166
167
168 </PRE>
169 <H2>AUTHORS</H2><PRE>
170        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
171        curses by Eric S. Raymond.
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221 </PRE>
222 <HR>
223 <ADDRESS>
224 Man(1) output converted with
225 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
226 </ADDRESS>
227 </BODY>
228 </HTML>