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