ncurses 5.6 - patch 20070203
[ncurses.git] / form / fld_newftyp.c
1 /****************************************************************************
2  * Copyright (c) 1998-2004,2007 Free Software Foundation, Inc.              *
3  *                                                                          *
4  * Permission is hereby granted, free of charge, to any person obtaining a  *
5  * copy of this software and associated documentation files (the            *
6  * "Software"), to deal in the Software without restriction, including      *
7  * without limitation the rights to use, copy, modify, merge, publish,      *
8  * distribute, distribute with modifications, sublicense, and/or sell       *
9  * copies of the Software, and to permit persons to whom the Software is    *
10  * furnished to do so, subject to the following conditions:                 *
11  *                                                                          *
12  * The above copyright notice and this permission notice shall be included  *
13  * in all copies or substantial portions of the Software.                   *
14  *                                                                          *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22  *                                                                          *
23  * Except as contained in this notice, the name(s) of the above copyright   *
24  * holders shall not be used in advertising or otherwise to promote the     *
25  * sale, use or other dealings in this Software without prior written       *
26  * authorization.                                                           *
27  ****************************************************************************/
28
29 /****************************************************************************
30  *   Author:  Juergen Pfeifer, 1995,1997                                    *
31  ****************************************************************************/
32
33 #include "form.priv.h"
34
35 MODULE_ID("$Id: fld_newftyp.c,v 1.14 2007/02/03 23:37:46 tom Exp $")
36
37 static FIELDTYPE const default_fieldtype =
38 {
39   0,                            /* status                                      */
40   0L,                           /* reference count                             */
41   (FIELDTYPE *)0,               /* pointer to left  operand                    */
42   (FIELDTYPE *)0,               /* pointer to right operand                    */
43   NULL,                         /* makearg function                            */
44   NULL,                         /* copyarg function                            */
45   NULL,                         /* freearg function                            */
46   NULL,                         /* field validation function                   */
47   NULL,                         /* Character check function                    */
48   NULL,                         /* enumerate next function                     */
49   NULL                          /* enumerate previous function                 */
50 };
51
52 NCURSES_EXPORT_VAR(const FIELDTYPE *)
53 _nc_Default_FieldType = &default_fieldtype;
54
55 /*---------------------------------------------------------------------------
56 |   Facility      :  libnform
57 |   Function      :  FIELDTYPE *new_fieldtype(
58 |                       bool (* const field_check)(FIELD *,const void *),
59 |                       bool (* const char_check) (int, const void *) )
60 |
61 |   Description   :  Create a new fieldtype. The application programmer must
62 |                    write a field_check and a char_check function and give
63 |                    them as input to this call.
64 |                    If an error occurs, errno is set to
65 |                       E_BAD_ARGUMENT  - invalid arguments
66 |                       E_SYSTEM_ERROR  - system error (no memory)
67 |
68 |   Return Values :  Fieldtype pointer or NULL if error occurred
69 +--------------------------------------------------------------------------*/
70 NCURSES_EXPORT(FIELDTYPE *)
71 new_fieldtype(bool (*const field_check) (FIELD *, const void *),
72               bool (*const char_check) (int, const void *))
73 {
74   FIELDTYPE *nftyp = (FIELDTYPE *)0;
75
76   T((T_CALLED("new_fieldtype(%p,%p)"), field_check, char_check));
77   if ((field_check) || (char_check))
78     {
79       nftyp = (FIELDTYPE *)malloc(sizeof(FIELDTYPE));
80
81       if (nftyp)
82         {
83           T((T_CREATE("fieldtype %p"), nftyp));
84           *nftyp = default_fieldtype;
85           nftyp->fcheck = field_check;
86           nftyp->ccheck = char_check;
87         }
88       else
89         {
90           SET_ERROR(E_SYSTEM_ERROR);
91         }
92     }
93   else
94     {
95       SET_ERROR(E_BAD_ARGUMENT);
96     }
97   returnFieldType(nftyp);
98 }
99
100 /*---------------------------------------------------------------------------
101 |   Facility      :  libnform
102 |   Function      :  int free_fieldtype(FIELDTYPE *typ)
103 |
104 |   Description   :  Release the memory associated with this fieldtype.
105 |
106 |   Return Values :  E_OK            - success
107 |                    E_CONNECTED     - there are fields referencing the type
108 |                    E_BAD_ARGUMENT  - invalid fieldtype pointer
109 +--------------------------------------------------------------------------*/
110 NCURSES_EXPORT(int)
111 free_fieldtype(FIELDTYPE *typ)
112 {
113   T((T_CALLED("free_fieldtype(%p)"), typ));
114
115   if (!typ)
116     RETURN(E_BAD_ARGUMENT);
117
118   if (typ->ref != 0)
119     RETURN(E_CONNECTED);
120
121   if (typ->status & _RESIDENT)
122     RETURN(E_CONNECTED);
123
124   if (typ->status & _LINKED_TYPE)
125     {
126       if (typ->left)
127         typ->left->ref--;
128       if (typ->right)
129         typ->right->ref--;
130     }
131   free(typ);
132   RETURN(E_OK);
133 }
134
135 /* fld_newftyp.c ends here */