d48d5d605a8a58769e60ebd0f9731e267412292f
[ncurses.git] / doc / html / man / form_field_validation.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc.              *
4   *                                                                          *
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:                 *
12   *                                                                          *
13   * The above copyright notice and this permission notice shall be included  *
14   * in all copies or substantial portions of the Software.                   *
15   *                                                                          *
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.                               *
23   *                                                                          *
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       *
27   * authorization.                                                           *
28   ****************************************************************************
29   * @Id: form_field_validation.3x,v 1.20 2010/12/04 18:38:55 tom Exp @
30 -->
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
32 <HTML>
33 <HEAD>
34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35 <meta name="generator" content="Manpage converted by man2html - see http://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">
39 </HEAD>
40 <BODY>
41 <H1>form_field_validation 3x</H1>
42 <HR>
43 <PRE>
44 <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>
45
46
47
48
49 </PRE>
50 <H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <STRONG>form_field_validation</STRONG> - data type validation for fields
52
53
54 </PRE>
55 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
57        int set_field_type(FIELD *field, FIELDTYPE *type, ...);
58        FIELDTYPE *field_type(const FIELD *field);
59        void *field_arg(const FIELD *field);
60
61        FIELDTYPE *TYPE_ALNUM;
62        FIELDTYPE *TYPE_ALPHA;
63        FIELDTYPE *TYPE_ENUM;
64        FIELDTYPE *TYPE_INTEGER;
65        FIELDTYPE *TYPE_NUMERIC;
66        FIELDTYPE *TYPE_REGEXP;
67        FIELDTYPE *TYPE_IPV4;
68
69
70 </PRE>
71 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
72        The  function  <STRONG>set_field_type</STRONG>  declares  a data type for a
73        given form field.  This is the type checked by  validation
74        functions.  The predefined types are as follows:
75
76        TYPE_ALNUM
77             Alphanumeric  data.  Requires a third <STRONG>int</STRONG> argument, a
78             minimum field width.
79
80        TYPE_ALPHA
81             Character data.  Requires a  third  <STRONG>int</STRONG>  argument,  a
82             minimum field width.
83
84        TYPE_ENUM
85             Accept one of a specified set of strings.  Requires a
86             third <STRONG>(char</STRONG> <STRONG>**)</STRONG> argument pointing to a string list; a
87             fourth  <STRONG>int</STRONG> flag argument to enable case-sensitivity;
88             and a fifth <STRONG>int</STRONG> flag argument  specifying  whether  a
89             partial  match  must be a unique one (if this flag is
90             off, a prefix matches the first of any  set  of  more
91             than  one  list  elements  with  that prefix). Please
92             notice that the string list is copied. So you may use
93             a  list  that  lives  in  automatic  variables on the
94             stack.
95
96        TYPE_INTEGER
97             Integer data, parsable  to  an  integer  by  <STRONG>atoi(3)</STRONG>.
98             Requires  a third <STRONG>int</STRONG> argument controlling the preci-
99             sion, a fourth  <STRONG>long</STRONG>  argument  constraining  minimum
100             value,  and  a fifth <STRONG>long</STRONG> constraining maximum value.
101             If the maximum value is less than  or  equal  to  the
102             minimum value, the range is simply ignored. On return
103             the field buffer is formatted according to the <STRONG>printf</STRONG>
104             format   specification   ".*ld",  where  the  '*'  is
105             replaced by the precision argument.  For  details  of
106             the precision handling see <STRONG>printf's</STRONG> man-page.
107
108        TYPE_NUMERIC
109             Numeric   data   (may  have  a  decimal-point  part).
110             Requires a third <STRONG>int</STRONG> argument controlling the  preci-
111             sion,  a  fourth <STRONG>double</STRONG> argument constraining minimum
112             value, and a fifth <STRONG>double</STRONG> constraining maximum value.
113             If  your  system  supports locales, the decimal point
114             character to be used must be  the  one  specified  by
115             your  locale.   If  the maximum value is less than or
116             equal to the  minimum  value,  the  range  is  simply
117             ignored.  On  return  the  field  buffer is formatted
118             according to the <STRONG>printf</STRONG> format  specification  ".*f",
119             where  the '*' is replaced by the precision argument.
120             For details of the precision  handling  see  <STRONG>printf's</STRONG>
121             man-page.
122
123        TYPE_REGEXP
124             Regular  expression data.  Requires a regular expres-
125             sion <STRONG>(char</STRONG> <STRONG>*)</STRONG> third argument; the data  is  valid  if
126             the  regular  expression matches it.  Regular expres-
127             sions are in  the  format  of  <STRONG>regcomp</STRONG>  and  <STRONG>regexec</STRONG>.
128             Please  notice that the regular expression must match
129             the whole field. If you have  for  example  an  eight
130             character wide field, a regular expression "^[0-9]*$"
131             always means that you have to fill  all  eight  posi-
132             tions with digits. If you want to allow fewer digits,
133             you may use for example "^[0-9]* *$"  which  is  good
134             for  trailing  spaces  (up  to an empty field), or "^
135             *[0-9]* *$" which is good for  leading  and  trailing
136             spaces around the digits.
137
138        TYPE_IPV4
139             An Internet Protocol Version 4 address. This requires
140             no additional argument. It is checked whether or  not
141             the  buffer  has  the form a.b.c.d, where a,b,c and d
142             are numbers between 0 and 255. Trailing blanks in the
143             buffer  are  ignored. The address itself is not vali-
144             dated. Please note that this is an ncurses extension.
145             This  field type may not be available in other curses
146             implementations.
147
148        It is possible to  set  up  new  programmer-defined  field
149        types.  See the <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG> manual page.
150
151
152 </PRE>
153 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
154        The  functions  <STRONG>field_type</STRONG>  and  <STRONG>field_arg</STRONG>  return <STRONG>NULL</STRONG> on
155        error. The function <STRONG>set_field_type</STRONG> returns one of the fol-
156        lowing:
157
158        <STRONG>E_OK</STRONG> The routine succeeded.
159
160        <STRONG>E_SYSTEM_ERROR</STRONG>
161             System error occurred (see <STRONG>errno</STRONG>).
162
163
164 </PRE>
165 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
166        <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>.
167
168
169 </PRE>
170 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
171        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
172        file <STRONG>&lt;curses.h&gt;</STRONG>.
173
174
175 </PRE>
176 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
177        These routines emulate the System V forms  library.   They
178        were not supported on Version 7 or BSD versions.
179
180
181 </PRE>
182 <H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
183        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
184        curses by Eric S. Raymond.
185
186
187
188                                               <STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG>
189 </PRE>
190 <div class="nav">
191 <ul>
192 <li><a href="#h2-NAME">NAME</a></li>
193 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
194 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
195 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
196 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
197 <li><a href="#h2-NOTES">NOTES</a></li>
198 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
199 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
200 </ul>
201 </div>
202 </BODY>
203 </HTML>