1997-05-15 12:00:00 +08:00
|
|
|
<HTML>
|
1999-10-24 12:32:42 +08:00
|
|
|
<BODY>
|
1997-05-15 12:00:00 +08:00
|
|
|
<PRE>
|
|
|
|
|
<STRONG>form_field_validation</STRONG> - data type validation for fields
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>SYNOPSIS</H2><PRE>
|
1999-10-24 12:32:42 +08:00
|
|
|
<STRONG>#include</STRONG> <STRONG><form.h></STRONG>
|
1997-05-15 12:00:00 +08:00
|
|
|
int set_field_type(FIELD *field, FIELDTYPE *type, ...);
|
|
|
|
|
FIELDTYPE *field_type(const FIELD *field);
|
|
|
|
|
void *field_arg(const FIELD *field);
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>DESCRIPTION</H2><PRE>
|
|
|
|
|
The function <STRONG>set_field_type</STRONG> 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 <STRONG>int</STRONG> argument, a
|
|
|
|
|
minimum field width.
|
|
|
|
|
|
|
|
|
|
TYPE_ALPHA
|
|
|
|
|
Character data. Requires a third <STRONG>int</STRONG> argument, a
|
|
|
|
|
minimum field width.
|
|
|
|
|
|
|
|
|
|
TYPE_ENUM
|
|
|
|
|
Accept one of a specified set of strings. Requires a
|
|
|
|
|
third <STRONG>(char</STRONG> <STRONG>**)</STRONG> argument pointing to a string list; a
|
|
|
|
|
fourth <STRONG>int</STRONG> flag argument to enable case-sensitivity;
|
|
|
|
|
and 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). 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 <STRONG>atoi(3)</STRONG>.
|
|
|
|
|
Requires a third <STRONG>int</STRONG> argument controlling the preci-
|
|
|
|
|
sion, a fourth <STRONG>long</STRONG> argument constraining minimum
|
|
|
|
|
value, and a fifth <STRONG>long</STRONG> 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 <STRONG>printf</STRONG>
|
|
|
|
|
format specification ".*ld", where the '*' is
|
|
|
|
|
replaced by the precision argument. For details of
|
|
|
|
|
the precision handling see <STRONG>printf's</STRONG> man-page.
|
|
|
|
|
|
|
|
|
|
TYPE_NUMERIC
|
|
|
|
|
Numeric data (may have a decimal-point part).
|
|
|
|
|
Requires a third <STRONG>int</STRONG> argument controlling the preci-
|
|
|
|
|
sion, a fourth <STRONG>double</STRONG> argument constraining minimum
|
|
|
|
|
value, and a fifth <STRONG>double</STRONG> constraining maximum value.
|
|
|
|
|
If your system supports locale's, the decimal point
|
|
|
|
|
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's</STRONG> man-page.
|
|
|
|
|
|
|
|
|
|
TYPE_REGEXP
|
|
|
|
|
Regular expression data. Requires a regular expres-
|
|
|
|
|
sion <STRONG>(char</STRONG> <STRONG>*)</STRONG> third argument; the data is valid if
|
|
|
|
|
the regular expression matches it. Regular expres-
|
1998-03-01 12:21:12 +08:00
|
|
|
sions are in the format of <STRONG><A HREF="regcomp.3x.html">regcomp(3X)</A></STRONG> and
|
1997-05-15 12:00:00 +08:00
|
|
|
<STRONG><A HREF="regexec.3x.html">regexec(3X)</A></STRONG>. 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 <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3X)</A></STRONG> manual page.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>RETURN VALUE</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 fol-
|
|
|
|
|
lowing:
|
|
|
|
|
|
|
|
|
|
<STRONG>E_OK</STRONG> The routine succeeded.
|
|
|
|
|
|
|
|
|
|
<STRONG>E_SYSTEM_ERROR</STRONG>
|
|
|
|
|
System error occurred (see <STRONG>errno</STRONG>).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>SEE ALSO</H2><PRE>
|
|
|
|
|
<STRONG><A HREF="ncurses.3x.html">curses(3X)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3X)</A></STRONG>.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>NOTES</H2><PRE>
|
1999-10-24 12:32:42 +08:00
|
|
|
The header file <STRONG><form.h></STRONG> automatically includes the header
|
|
|
|
|
file <STRONG><curses.h></STRONG>.
|
1997-05-15 12:00:00 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>PORTABILITY</H2><PRE>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>AUTHORS</H2><PRE>
|
|
|
|
|
Juergen Pfeifer. Manual pages and adaptation for new
|
|
|
|
|
curses by Eric S. Raymond.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
</BODY>
|
|
|
|
|
</HTML>
|
