f79a157aa5fc7dd1ed4d5cbe3d4253931fa3fa83
[ncurses.git] / form / fld_arg.c
1 /****************************************************************************
2  * Copyright (c) 1998-2003,2004 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_arg.c,v 1.11 2004/12/25 22:20:18 tom Exp $")
36
37 /*---------------------------------------------------------------------------
38 |   Facility      :  libnform
39 |   Function      :  int set_fieldtype_arg(
40 |                            FIELDTYPE *typ,
41 |                            void * (* const make_arg)(va_list *),
42 |                            void * (* const copy_arg)(const void *),
43 |                            void   (* const free_arg)(void *) )
44 |
45 |   Description   :  Connects to the type additional arguments necessary
46 |                    for a set_field_type call. The various function pointer
47 |                    arguments are:
48 |                       make_arg : allocates a structure for the field
49 |                                  specific parameters.
50 |                       copy_arg : duplicate the structure created by
51 |                                  make_arg
52 |                       free_arg : Release the memory allocated by make_arg
53 |                                  or copy_arg
54 |
55 |                    At least make_arg must be non-NULL.
56 |                    You may pass NULL for copy_arg and free_arg if your
57 |                    make_arg function doesn't allocate memory and your
58 |                    arg fits into the storage for a (void*).
59 |
60 |   Return Values :  E_OK           - success
61 |                    E_BAD_ARGUMENT - invalid argument
62 +--------------------------------------------------------------------------*/
63 NCURSES_EXPORT(int)
64 set_fieldtype_arg(FIELDTYPE *typ,
65                   void *(*const make_arg)(va_list *),
66                   void *(*const copy_arg)(const void *),
67                   void (*const free_arg) (void *))
68 {
69   T((T_CALLED("set_fieldtype_arg(%p,%p,%p,%p)"),
70      typ, make_arg, copy_arg, free_arg));
71
72   if (typ != 0 && make_arg != (void *)0)
73     {
74       typ->status |= _HAS_ARGS;
75       typ->makearg = make_arg;
76       typ->copyarg = copy_arg;
77       typ->freearg = free_arg;
78       RETURN(E_OK);
79     }
80   RETURN(E_BAD_ARGUMENT);
81 }
82
83 /*---------------------------------------------------------------------------
84 |   Facility      :  libnform
85 |   Function      :  void *field_arg(const FIELD *field)
86 |
87 |   Description   :  Retrieve pointer to the fields argument structure.
88 |
89 |   Return Values :  Pointer to structure or NULL if none is defined.
90 +--------------------------------------------------------------------------*/
91 NCURSES_EXPORT(void *)
92 field_arg(const FIELD *field)
93 {
94   T((T_CALLED("field_arg(%p)"), field));
95   returnVoidPtr(Normalize_Field(field)->arg);
96 }
97
98 /* fld_arg.c ends here */