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