/*****************************************************************************/
/*                                                                           */
/*                                funcdesc.h                                 */
/*                                                                           */
/*           Function descriptor structure for the cc65 C compiler           */
/*                                                                           */
/*                                                                           */
/*                                                                           */
/* (C) 2000-2008 Ullrich von Bassewitz                                       */
/*               Roemerstrasse 52                                            */
/*               D-70794 Filderstadt                                         */
/* EMail:        uz@cc65.org                                                 */
/*                                                                           */
/*                                                                           */
/* This software is provided 'as-is', without any expressed or implied       */
/* warranty.  In no event will the authors be held liable for any damages    */
/* arising from the use of this software.                                    */
/*                                                                           */
/* Permission is granted to anyone to use this software for any purpose,     */
/* including commercial applications, and to alter it and redistribute it    */
/* freely, subject to the following restrictions:                            */
/*                                                                           */
/* 1. The origin of this software must not be misrepresented; you must not   */
/*    claim that you wrote the original software. If you use this software   */
/*    in a product, an acknowledgment in the product documentation would be  */
/*    appreciated but is not required.                                       */
/* 2. Altered source versions must be plainly marked as such, and must not   */
/*    be misrepresented as being the original software.                      */
/* 3. This notice may not be removed or altered from any source              */
/*    distribution.                                                          */
/*                                                                           */
/*****************************************************************************/



#ifndef FUNCDESC_H
#define FUNCDESC_H



/*****************************************************************************/
/*                              struct FuncDesc                              */
/*****************************************************************************/



/* Masks for the Flags field in FuncDesc */
#define FD_NONE                 0x0000U /* No flags                            */
#define FD_EMPTY                0x0001U /* Function with empty param list      */
#define FD_VOID_PARAM           0x0002U /* Function with a void param list     */
#define FD_VARIADIC             0x0004U /* Function with variable param list   */
#define FD_INCOMPLETE_PARAM     0x0008U /* Function with param of unknown size */
#define FD_OLDSTYLE             0x0010U /* Old style (K&R) function            */
#define FD_OLDSTYLE_INTRET      0x0020U /* K&R func has implicit int return    */
#define FD_UNNAMED_PARAMS       0x0040U /* Function has unnamed params         */
#define FD_CALL_WRAPPER         0x0080U /* This function is used as a wrapper  */

/* Bits that must be ignored when comparing funcs */
#define FD_IGNORE   (FD_INCOMPLETE_PARAM | FD_OLDSTYLE | FD_OLDSTYLE_INTRET | FD_UNNAMED_PARAMS | FD_CALL_WRAPPER)

#define WRAPPED_CALL_USE_BANK   0x0100U /* WrappedCall uses .bank() */

/* Function descriptor */
typedef struct FuncDesc FuncDesc;
struct FuncDesc {
    unsigned            Flags;           /* Bitmapped flags FD_...            */
    struct SymTable*    SymTab;          /* Symbol table                      */
    struct SymTable*    TagTab;          /* Symbol table for structs/enums    */
    unsigned            ParamCount;      /* Number of parameters              */
    unsigned            ParamSize;       /* Size of the parameters            */
    struct SymEntry*    LastParam;       /* Pointer to last parameter         */
    struct FuncDesc*    FuncDef;         /* Descriptor used in definition     */
};



/*****************************************************************************/
/*                                   Code                                    */
/*****************************************************************************/



FuncDesc* NewFuncDesc (void);
/* Create a new symbol table with the given name */

void FreeFuncDesc (FuncDesc* D);
/* Free a function descriptor */



/* End of funcdesc.h */

#endif