1 /****************************************************************************
2 * Copyright 2018,2020 Thomas E. Dickey *
3 * Copyright 1998-2012,2016 Free Software Foundation, Inc. *
5 * Permission is hereby granted, free of charge, to any person obtaining a *
6 * copy of this software and associated documentation files (the *
7 * "Software"), to deal in the Software without restriction, including *
8 * without limitation the rights to use, copy, modify, merge, publish, *
9 * distribute, distribute with modifications, sublicense, and/or sell *
10 * copies of the Software, and to permit persons to whom the Software is *
11 * furnished to do so, subject to the following conditions: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
24 * Except as contained in this notice, the name(s) of the above copyright *
25 * holders shall not be used in advertising or otherwise to promote the *
26 * sale, use or other dealings in this Software without prior written *
28 ****************************************************************************/
30 /****************************************************************************
31 * Author: Juergen Pfeifer, 1995,1997 *
32 ****************************************************************************/
34 #include "form.priv.h"
36 MODULE_ID("$Id: fld_arg.c,v 1.18 2020/12/11 22:05:24 tom Exp $")
38 /*---------------------------------------------------------------------------
40 | Function : int set_fieldtype_arg(
42 | void * (* const make_arg)(va_list *),
43 | void * (* const copy_arg)(const void *),
44 | void (* const free_arg)(void *) )
46 | Description : Connects to the type additional arguments necessary
47 | for a set_field_type call. The various function pointer
49 | make_arg : allocates a structure for the field
50 | specific parameters.
51 | copy_arg : duplicate the structure created by
53 | free_arg : Release the memory allocated by make_arg
56 | At least make_arg must be non-NULL.
57 | You may pass NULL for copy_arg and free_arg if your
58 | make_arg function doesn't allocate memory and your
59 | arg fits into the storage for a (void*).
61 | Return Values : E_OK - success
62 | E_BAD_ARGUMENT - invalid argument
63 +--------------------------------------------------------------------------*/
65 set_fieldtype_arg(FIELDTYPE *typ,
66 void *(*const make_arg)(va_list *),
67 void *(*const copy_arg)(const void *),
68 void (*const free_arg) (void *))
72 T((T_CALLED("set_fieldtype_arg(%p,%s,%s,%s)"),
74 TR_FUNC_ARG(0, make_arg),
75 TR_FUNC_ARG(1, copy_arg),
76 TR_FUNC_ARG(2, free_arg)));
78 if (typ != 0 && make_arg != (void *)0)
80 SetStatus(typ, _HAS_ARGS);
81 typ->makearg = make_arg;
82 typ->copyarg = copy_arg;
83 typ->freearg = free_arg;
86 RETURN(E_BAD_ARGUMENT);
89 /*---------------------------------------------------------------------------
91 | Function : void *field_arg(const FIELD *field)
93 | Description : Retrieve pointer to the field's argument structure.
95 | Return Values : Pointer to structure or NULL if none is defined.
96 +--------------------------------------------------------------------------*/
98 field_arg(const FIELD *field)
100 T((T_CALLED("field_arg(%p)"), (const void *)field));
101 returnVoidPtr(Normalize_Field(field)->arg);
104 /* fld_arg.c ends here */