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