+<!--
+ ****************************************************************************
+ * Copyright 2018-2023,2024 Thomas E. Dickey *
+ * Copyright 1998-2010,2017 Free Software Foundation, Inc. *
+ * *
+ * Permission is hereby granted, free of charge, to any person obtaining a *
+ * copy of this software and associated documentation files (the *
+ * "Software"), to deal in the Software without restriction, including *
+ * without limitation the rights to use, copy, modify, merge, publish, *
+ * distribute, distribute with modifications, sublicense, and/or sell *
+ * copies of the Software, and to permit persons to whom the Software is *
+ * furnished to do so, subject to the following conditions: *
+ * *
+ * The above copyright notice and this permission notice shall be included *
+ * in all copies or substantial portions of the Software. *
+ * *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
+ * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
+ * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
+ * *
+ * Except as contained in this notice, the name(s) of the above copyright *
+ * holders shall not be used in advertising or otherwise to promote the *
+ * sale, use or other dealings in this Software without prior written *
+ * authorization. *
+ ****************************************************************************
+ * @Id: form_field_validation.3x,v 1.53 2024/03/16 15:35:01 tom Exp @
+-->
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
+<HEAD>
+<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
+<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
+<TITLE>form_field_validation 3x 2024-03-16 ncurses 6.4 Library calls</TITLE>
+<link rel="author" href="mailto:bug-ncurses@gnu.org">
+
+</HEAD>
<BODY>
+<H1 class="no-header">form_field_validation 3x 2024-03-16 ncurses 6.4 Library calls</H1>
<PRE>
-<!-- Manpage converted by man2html 3.0.1 -->
+<STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG> Library calls <STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG>
-</PRE>
-<H2>NAME</H2><PRE>
- <B>form_field_validation</B> - data type validation for fields
-</PRE>
-<H2>SYNOPSIS</H2><PRE>
- <B>#include</B> <B><form.h></B>
- int set_field_type(FIELD *field, FIELDTYPE *type, ...);
- FIELDTYPE *field_type(const FIELD *field);
- void *field_arg(const FIELD *field);
+</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
+ <STRONG>form_field_validation</STRONG> - data type validation for fields
-</PRE>
-<H2>DESCRIPTION</H2><PRE>
- The function <B>set_field_type</B> declares a data type for a
- given form field. This is the type checked by validation
- functions. The types are as follows:
-
- TYPE_ALNUM
- Alphanumeric data. Requires a third <B>int</B> argument, a
- minimum field width.
-
- TYPE_ALPHA
- Character data. Requires a third <B>int</B> argument, a
- minimum field width.
-
- TYPE_ENUM
- Accept one of a specified set of strings. Requires a
- third <B>(char</B> <B>**)</B> argument pointing to a string list; a
- fourth <B>int</B> flag argument to enable case-sensitivity;
- and a fifth <B>int</B> flag argument specifying whether a
- partial match must be a unique one (if this flag is
- off, a prefix matches the first of any set of more
- than one list elements with that prefix). Please
- notice that the string list is not copied, only a
- reference to it is stored in the field. So you should
- avoid to use a list that lives in automatic variables
- on the stack.
-
- TYPE_INTEGER
- Integer data, parsable to an integer by <B>atoi(3)</B>.
- Requires a third <B>int</B> argument controlling the preci-
- sion, a fourth <B>long</B> argument constraining minimum
- value, and a fifth <B>long</B> constraining maximum value.
- If the maximum value is less or equal the minimum
- value, the range is simply ignored. On return the
- field buffer is formatted according to the <B>printf</B>
- format specification ".*ld", where the '*' is
- replaced by the precision argument. For details of
- the precision handling see <B>printf's</B> man-page.
-
- TYPE_NUMERIC
- Numeric data (may have a decimal-point part).
- Requires a third <B>int</B> argument controlling the preci-
- sion, a fourth <B>double</B> argument constraining minimum
- value, and a fifth <B>double</B> constraining maximum value.
- If your system supports locale's, the decimal point
- character to be used must be the one specified by
- your locale. If the maximum value is less or equal
- the minimum value, the range is simply ignored. On
- return the field buffer is formatted according to the
- <B>printf</B> format specification ".*f", where the '*' is
- replaced by the precision argument. For details of
- the precision handling see <B>printf's</B> man-page.
-
- TYPE_REGEXP
- Regular expression data. Requires a regular expres-
- sion <B>(char</B> <B>*)</B> third argument; the data is valid if
- the regular expression matches it. Regular expres-
- sions are in the format of <B><A HREF="regcomp.3x.html">regcomp(3x)</A></B> and
- <B><A HREF="regexec.3x.html">regexec(3x)</A></B>. Please notice that the regular expres-
- sion must match the whole field. If you have for
- example an eight character wide field, a regular
- expression "^[0-9]*$" always means that you have to
- fill all eight positions with digits. If you want to
- allow fewer digits, you may use for example "^[0-9]*
- *$" which is good for trailing spaces (up to an empty
- field), or "^ *[0-9]* *$" which is good for leading
- and trailing spaces around the digits.
-
- TYPE_IPV4
- An Internet Protocol Version 4 address. This requires
- no additional argument. It is checked whether or not
- the buffer has the form a.b.c.d, where a,b,c and d
- are numbers between 0 and 255. Trailing blanks in the
- buffer are ignored. The address itself is not vali-
- dated. Please note that this is an ncurses extension.
- This field type may not be available in other curses
- implementations.
-
- It is possible to set up new programmer-defined field
- types. See the <B><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></B> manual page.
+</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
+ <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
-</PRE>
-<H2>RETURN VALUE</H2><PRE>
- The functions <B>field_type</B> and <B>field_arg</B> return <B>NULL</B> on
- error. The function <B>set_field_type</B> returns one of the fol-
- lowing:
+ <STRONG>void</STRONG> <STRONG>*field_arg(const</STRONG> <STRONG>FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>);</STRONG>
+ <STRONG>FIELDTYPE</STRONG> <STRONG>*field_type(const</STRONG> <STRONG>FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>);</STRONG>
+ <STRONG>int</STRONG> <STRONG>set_field_type(FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>,</STRONG> <STRONG>FIELDTYPE</STRONG> <STRONG>*</STRONG><EM>type</EM><STRONG>,</STRONG> <STRONG>...);</STRONG>
- <B>E_OK</B> The routine succeeded.
+ <EM>/*</EM> <EM>predefined</EM> <EM>field</EM> <EM>types</EM> <EM>*/</EM>
+ <STRONG>FIELDTYPE</STRONG> <STRONG>*TYPE_ALNUM;</STRONG>
+ <STRONG>FIELDTYPE</STRONG> <STRONG>*TYPE_ALPHA;</STRONG>
+ <STRONG>FIELDTYPE</STRONG> <STRONG>*TYPE_ENUM;</STRONG>
+ <STRONG>FIELDTYPE</STRONG> <STRONG>*TYPE_INTEGER;</STRONG>
+ <STRONG>FIELDTYPE</STRONG> <STRONG>*TYPE_NUMERIC;</STRONG>
+ <STRONG>FIELDTYPE</STRONG> <STRONG>*TYPE_REGEXP;</STRONG>
+ <STRONG>FIELDTYPE</STRONG> <STRONG>*TYPE_IPV4;</STRONG>
- <B>E_SYSTEM_ERROR</B>
- System error occurred (see <B>errno</B>).
+</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
+ By default, no validation is done on form fields. You can associate a
+ form with with a <EM>field</EM> <EM>type</EM>, making the form library validate input.
-</PRE>
-<H2>SEE ALSO</H2><PRE>
- <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="form.3x.html">form(3x)</A></B>.
+</PRE><H3><a name="h3-field_arg">field_arg</a></H3><PRE>
+ Returns a pointer to the field's argument block. The <EM>argument</EM> <EM>block</EM> is
+ an opaque structure containing a copy of the arguments provided in a
+ <STRONG>set_field_type</STRONG> call.
-</PRE>
-<H2>NOTES</H2><PRE>
- The header file <B><form.h></B> automatically includes the header
- file <B><curses.h></B>.
+</PRE><H3><a name="h3-field_type">field_type</a></H3><PRE>
+ Returns a pointer to the <EM>field</EM> <EM>type</EM> associated with the form field,
+ i.e., by calling <STRONG>set_field_type</STRONG>.
-</PRE>
-<H2>PORTABILITY</H2><PRE>
- These routines emulate the System V forms library. They
- were not supported on Version 7 or BSD versions.
+</PRE><H3><a name="h3-set_field_type">set_field_type</a></H3><PRE>
+ The function <STRONG>set_field_type</STRONG> associates a field type with a given form
+ field. This is the type checked by validation functions. Most field
+ types are configurable, via arguments which the caller provides when
+ calling <STRONG>set_field_type</STRONG>.
-</PRE>
-<H2>AUTHORS</H2><PRE>
- Juergen Pfeifer. Manual pages and adaptation for new
- curses by Eric S. Raymond.
+ Several field types are predefined by the form library.
+
+
+</PRE><H2><a name="h2-PREDEFINED-TYPES">PREDEFINED TYPES</a></H2><PRE>
+ It is possible to set up new programmer-defined field types. Field
+ types are implemented via the <STRONG>FIELDTYPE</STRONG> data structure, which contains
+ several pointers to functions.
+
+ See the <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG> manual page, which describes functions which
+ can be used to construct a field-type dynamically.
+
+ The predefined types are as follows:
+</PRE><H3><a name="h3-TYPE_ALNUM">TYPE_ALNUM</a></H3><PRE>
+ Alphanumeric data. Required parameter:
+ <STRONG>o</STRONG> a third <STRONG>int</STRONG> argument, a minimum field width.
+</PRE><H3><a name="h3-TYPE_ALPHA">TYPE_ALPHA</a></H3><PRE>
+ Character data. Required parameter:
+ <STRONG>o</STRONG> a third <STRONG>int</STRONG> argument, a minimum field width.
+</PRE><H3><a name="h3-TYPE_ENUM">TYPE_ENUM</a></H3><PRE>
+ Accept one of a specified set of strings. Required parameters:
+ <STRONG>o</STRONG> a third <STRONG>(char</STRONG> <STRONG>**)</STRONG> argument pointing to a string list;
+ <STRONG>o</STRONG> a fourth <STRONG>int</STRONG> flag argument to enable case-sensitivity;
+ <STRONG>o</STRONG> a fifth <STRONG>int</STRONG> flag argument specifying whether a partial match must
+ be a unique one. If this flag is off, a prefix matches the first
+ of any set of more than one list elements with that prefix.
+ The library copies the string list, so you may use a list that lives in
+ automatic variables on the stack.
+</PRE><H3><a name="h3-TYPE_INTEGER">TYPE_INTEGER</a></H3><PRE>
+ Integer data, parsable to an integer by <STRONG>atoi(3)</STRONG>. Required parameters:
+ <STRONG>o</STRONG> a third <STRONG>int</STRONG> argument controlling the precision,
+ <STRONG>o</STRONG> a fourth <STRONG>long</STRONG> argument constraining minimum value,
+ <STRONG>o</STRONG> a fifth <STRONG>long</STRONG> constraining maximum value. If the maximum value is
+ less than or equal to the minimum value, the range is simply
+ ignored.
+ On return, the field buffer is formatted according to the <STRONG>printf</STRONG> format
+ specification ".*ld", where the "*" is replaced by the precision
+ argument.
+ For details of the precision handling see <STRONG>printf(3)</STRONG>.
+</PRE><H3><a name="h3-TYPE_NUMERIC">TYPE_NUMERIC</a></H3><PRE>
+ Numeric data (may have a decimal-point part). Required parameters:
+ <STRONG>o</STRONG> a third <STRONG>int</STRONG> argument controlling the precision,
+ <STRONG>o</STRONG> a fourth <STRONG>double</STRONG> argument constraining minimum value,
+ <STRONG>o</STRONG> and a fifth <STRONG>double</STRONG> constraining maximum value. If your system
+ supports locales, the decimal point character must be the one
+ specified by your locale. If the maximum value is less than or
+ equal to the minimum value, the range is simply ignored.
+ On return, the field buffer is formatted according to the <STRONG>printf</STRONG> format
+ specification ".*f", where the "*" is replaced by the precision
+ argument.
+ For details of the precision handling see <STRONG>printf(3)</STRONG>.
+</PRE><H3><a name="h3-TYPE_REGEXP">TYPE_REGEXP</a></H3><PRE>
+ Regular expression data. Required parameter:
+ <STRONG>o</STRONG> a third argument, a regular expression <STRONG>(char</STRONG> <STRONG>*)</STRONG> string. The data
+ is valid if the regular expression matches it.
+ Regular expressions are in the format of <STRONG>regcomp</STRONG> and <STRONG>regexec</STRONG>.
+ The regular expression must match the whole field. If you have for
+ example, an eight character wide field, a regular expression "^[0-9]*$"
+ always means that you have to fill all eight positions with digits. If
+ you want to allow fewer digits, you may use for example "^[0-9]* *$"
+ which is good for trailing spaces (up to an empty field), or "^ *[0-9]*
+ *$" which is good for leading and trailing spaces around the digits.
+</PRE><H3><a name="h3-TYPE_IPV4">TYPE_IPV4</a></H3><PRE>
+ An Internet Protocol Version 4 address. Required parameter:
+ <STRONG>o</STRONG> none
+ The form library checks whether or not the buffer has the form <EM>a.b.c.d</EM>,
+ where <EM>a</EM>, <EM>b</EM>, <EM>c</EM>, and <EM>d</EM> are numbers in the range 0 to 255. Trailing
+ blanks in the buffer are ignored. The address itself is not validated.
+ This is an <EM>ncurses</EM> extension; this field type may not be available in
+ other curses implementations.
+</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
+ The functions <STRONG>field_type</STRONG> and <STRONG>field_arg</STRONG> return <STRONG>NULL</STRONG> on error. The
+ function <STRONG>set_field_type</STRONG> returns one of the following:
+ <STRONG>E_OK</STRONG> The routine succeeded.
+ <STRONG>E_SYSTEM_ERROR</STRONG>
+ System error occurred (see <STRONG>errno(3)</STRONG>).
+</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
+ These routines emulate the System V forms library. They were not
+ supported on Version 7 or BSD versions.
+</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
+ Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
+ Raymond.
+</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
+ <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>, <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG>, <STRONG><A HREF="form_variables.3x.html">form_variables(3x)</A></STRONG>
+ncurses 6.4 2024-03-16 <STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG>
</PRE>
-<HR>
-<ADDRESS>
-Man(1) output converted with
-<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
-</ADDRESS>
+<div class="nav">
+<ul>
+<li><a href="#h2-NAME">NAME</a></li>
+<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
+<li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
+<ul>
+<li><a href="#h3-field_arg">field_arg</a></li>
+<li><a href="#h3-field_type">field_type</a></li>
+<li><a href="#h3-set_field_type">set_field_type</a></li>
+</ul>
+</li>
+<li><a href="#h2-PREDEFINED-TYPES">PREDEFINED TYPES</a>
+<ul>
+<li><a href="#h3-TYPE_ALNUM">TYPE_ALNUM</a></li>
+<li><a href="#h3-TYPE_ALPHA">TYPE_ALPHA</a></li>
+<li><a href="#h3-TYPE_ENUM">TYPE_ENUM</a></li>
+<li><a href="#h3-TYPE_INTEGER">TYPE_INTEGER</a></li>
+<li><a href="#h3-TYPE_NUMERIC">TYPE_NUMERIC</a></li>
+<li><a href="#h3-TYPE_REGEXP">TYPE_REGEXP</a></li>
+<li><a href="#h3-TYPE_IPV4">TYPE_IPV4</a></li>
+</ul>
+</li>
+<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
+<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
+<li><a href="#h2-AUTHORS">AUTHORS</a></li>
+<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
+</ul>
+</div>
</BODY>
</HTML>
projects / ncurses.git / blobdiff