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