ncurses 5.4
[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,2003 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.14 2003/05/10 20:33:49 jmc 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 <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>NAME</H2><PRE>
50        <STRONG>form_field_validation</STRONG> - data type validation for fields
51
52
53 </PRE>
54 <H2>SYNOPSIS</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>DESCRIPTION</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  not  copied,  only  a
92             reference to it is stored in the field. So you should
93             avoid using a list that lives in automatic  variables
94             on the 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><A HREF="regcomp.3x.html">regcomp(3x)</A></STRONG>  and
128             <STRONG><A HREF="regexec.3x.html">regexec(3x)</A></STRONG>. Please notice that the  regular  expres-
129             sion  must  match  the  whole  field. If you have for
130             example an eight  character  wide  field,  a  regular
131             expression  "^[0-9]*$"  always means that you have to
132             fill all eight positions with digits. If you want  to
133             allow  fewer digits, you may use for example "^[0-9]*
134             *$" which is good for trailing spaces (up to an empty
135             field),  or  "^ *[0-9]* *$" which is good for leading
136             and trailing 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>RETURN VALUE</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>SEE ALSO</H2><PRE>
166        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
167
168
169 </PRE>
170 <H2>NOTES</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>PORTABILITY</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>AUTHORS</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 <HR>
191 <ADDRESS>
192 Man(1) output converted with
193 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
194 </ADDRESS>
195 </BODY>
196 </HTML>