| /** |
| * \file libyasm/valparam.h |
| * \brief YASM value/parameter interface. |
| * |
| * \rcs |
| * $IdPath$ |
| * \endrcs |
| * |
| * \license |
| * Copyright (C) 2001 Peter Johnson |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * - Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * - Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in the |
| * documentation and/or other materials provided with the distribution. |
| * |
| * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND OTHER CONTRIBUTORS ``AS IS'' |
| * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR OTHER CONTRIBUTORS BE |
| * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| * POSSIBILITY OF SUCH DAMAGE. |
| * \endlicense |
| */ |
| #ifndef YASM_VALPARAM_H |
| #define YASM_VALPARAM_H |
| |
| #ifdef YASM_LIB_INTERNAL |
| /** Value/parameter pair. \internal */ |
| struct yasm_valparam { |
| /*@reldef@*/ STAILQ_ENTRY(yasm_valparam) link; /**< Next pair in list */ |
| /*@owned@*/ /*@null@*/ char *val; /**< Value */ |
| /*@owned@*/ /*@null@*/ yasm_expr *param; /**< Parameter */ |
| }; |
| |
| /** Linked list of value/parameter pairs. \internal */ |
| /*@reldef@*/ STAILQ_HEAD(yasm_valparamhead, yasm_valparam); |
| #endif |
| |
| /** Create a new valparam. |
| * \param v value |
| * \param p parameter |
| * \return Newly allocated valparam. |
| */ |
| yasm_valparam *yasm_vp_new(/*@keep@*/ char *v, /*@keep@*/ yasm_expr *p); |
| |
| /** Initialize linked list of valparams. |
| * \param headp linked list |
| */ |
| void yasm_vps_initialize(/*@out@*/ yasm_valparamhead *headp); |
| #ifdef YASM_LIB_INTERNAL |
| #define yasm_vps_initialize(headp) STAILQ_INIT(headp) |
| #endif |
| |
| /** Destroy (free allocated memory for) linked list of valparams. |
| * \warning Deletes val/params. |
| * \param headp linked list |
| */ |
| void yasm_vps_delete(yasm_valparamhead *headp); |
| |
| /** Append valparam to tail of linked list. |
| * \param headp linked list |
| * \param vp valparam |
| */ |
| void yasm_vps_append(yasm_valparamhead *headp, /*@keep@*/ yasm_valparam *vp); |
| #ifdef YASM_LIB_INTERNAL |
| #define yasm_vps_append(headp, vp) do { \ |
| if (vp) \ |
| STAILQ_INSERT_TAIL(headp, vp, link); \ |
| } while(0) |
| #endif |
| |
| /** Get first valparam in linked list. |
| * \param headp linked list |
| * \return First valparam in linked list. |
| */ |
| /*@null@*/ /*@dependent@*/ yasm_valparam *yasm_vps_first |
| (yasm_valparamhead *headp); |
| #ifdef YASM_LIB_INTERNAL |
| #define yasm_vps_first(headp) STAILQ_FIRST(headp) |
| #endif |
| |
| /** Get next valparam in linked list. |
| * \param cur previous valparam in linked list |
| * \return Next valparam in linked list. |
| */ |
| /*@null@*/ /*@dependent@*/ yasm_valparam *yasm_vps_next(yasm_valparam *cur); |
| #ifdef YASM_LIB_INTERNAL |
| #define yasm_vps_next(cur) STAILQ_NEXT(cur, link) |
| |
| /** Iterate through linked list of valparams. |
| * \internal |
| * \param iter iterator variable |
| * \param headp linked list |
| */ |
| #define yasm_vps_foreach(iter, headp) STAILQ_FOREACH(iter, headp, link) |
| #endif |
| |
| /** Print linked list of valparams. For debugging purposes. |
| * \param f file |
| * \param headp linked list |
| */ |
| void yasm_vps_print(FILE *f, /*@null@*/ const yasm_valparamhead *headp); |
| |
| #endif |