// Copyright (C) 1985-1998 by Symantec
// Copyright (C) 2000-2009 by Digital Mars
// All Rights Reserved
// http://www.digitalmars.com
// Written by Walter Bright
/*
 * This source file is made available for personal use
 * only. The license is in /dmd/src/dmd/backendlicense.txt
 * or /dm/src/dmd/backendlicense.txt
 * For any other uses, please contact Digital Mars.
 */

#if __SC__
#pragma once
#endif

#ifndef CC_H
#define CC_H    1

#ifdef SCPP
#define CPP     (config.flags3 & CFG3cpp)       // if compiling for C++
#else
#if !SPP
#define SCPP            0
#endif
#endif

#ifndef CPP
#define CPP             0
#endif

#ifndef SPP
#define SPP             0
#endif

#ifndef MARS
#define MARS            0       // not compiling MARS code
#endif

#ifndef HTOD
#define HTOD            0
#endif

#define GENOBJ          1       // generating .obj file

#define mskl(i)         (1L << (i))     /* convert int to mask          */

#ifndef STATIC
#define STATIC  static
#endif

#ifndef CEXTERN
#define CEXTERN extern
#endif

// Warnings
enum WM
{
        WM_no_inline    = 1,    //function '%s' is too complicated to inline
        WM_assignment   = 2,    //possible unintended assignment
        WM_nestcomment  = 3,    //comments do not nest
        WM_assignthis   = 4,    //assignment to 'this' is obsolete, use X::operator new/delete
        WM_notagname    = 5,    //no tag name for struct or enum
        WM_valuenotused = 6,    //value of expression is not used
        WM_extra_semi   = 7,    //possible extraneous ';'
        WM_large_auto   = 8,    //very large automatic
        WM_obsolete_del = 9,    //use delete[] rather than delete[expr], expr ignored
        WM_obsolete_inc = 10,   //using operator++() (or --) instead of missing operator++(int)
        WM_init2tmp     = 11,   //non-const reference initialized to temporary
        WM_used_b4_set  = 12,   //variable '%s' used before set
        WM_bad_op       = 13,   //Illegal type/size of operands for the %s instruction
        WM_386_op       = 14,   //Reference to '%s' caused a 386 instruction to be generated
        WM_ret_auto     = 15,   //returning address of automatic '%s'
        WM_ds_ne_dgroup = 16,   //DS is not equal to DGROUP
        WM_unknown_pragma = 17, //unrecognized pragma
        WM_implied_ret  = 18,   //implied return at closing '}' does not return value
        WM_num_args     = 19,   //%d actual arguments expected for %s, had %d
        WM_before_pch   = 20,   //symbols or macros defined before #include of precompiled header
        WM_pch_first    = 21,   //precompiled header must be first #include when -H is used
        WM_pch_config   = 22,
        WM_divby0       = 23,
        WM_badnumber    = 24,
        WM_ccast        = 25,
        WM_obsolete     = 26,
#if TARGET_LINUX || TARGET_OSX || TARGET_FREEBSD || TARGET_SOLARIS
        WM_skip_attribute   = 27, // skip GNUC attribute specification
        WM_warning_message  = 28, // preprocessor warning message
        WM_bad_vastart      = 29, // args for builtin va_start bad
        WM_undefined_inline = 30, // static inline not expanded or defined
#endif
};

// Language for error messages
enum LANG
{       LANGenglish,
        LANGgerman,
        LANGfrench,
        LANGjapanese,
};

#if __I86__

#include        "cdef.h"        // host and target compiler definition

#define INITIALIZED_STATIC_DEF  static

#else
#include        "TGcc.h"
#include        "str4.h"

#if MULTI_FILE
/* Make statics that require re-initialization available */
#define INITIALIZED_STATIC_DEF
#define INITIALIZED_STATIC_REF  extern
#else
#define INITIALIZED_STATIC_DEF  STATIC
#define INITIALIZED_STATIC_REF  error
#endif

#ifndef PASCAL
#define PASCAL pascal
#endif

#define TOOLKIT_H

/* Segments     */
#define CODE    1       /* code segment                 */
#define DATA    2       /* initialized data             */
#define CDATA   3       /* constant data                */
#define UDATA   4       /* uninitialized data           */
#ifndef UNKNOWN
#define UNKNOWN -1      /* unknown segment              */
#endif
#endif

#if MEMMODELS == 1
#define LARGEDATA 0     /* don't want 48 bit pointers */
#define LARGECODE 0
#endif

#ifndef __INTSIZE
#define __INTSIZE       4       // host ints are 4 bytes
#endif

#if SPP || SCPP
#include        "msgs2.h"
#endif
#include        "ty.h"
#if TARGET_LINUX || TARGET_OSX || TARGET_FREEBSD || TARGET_SOLARIS
#include        "../tk/mem.h"
#else
#include        "mem.h"
#endif
#include        "list.h"
#include        "vec.h"

#if SPP
#define COMPILER "Preprocessor"
#define ACTIVITY "preprocessing..."
#elif HTOD
#define COMPILER ".h to D Migration Tool"
#define ACTIVITY "migrating..."
#else
#define COMPILER "C/C++ Compiler"
#define ACTIVITY "compiling..."
#endif

#ifdef DEBUG
#   define debug(a)     (a)
#   define debugx(a)    (a)
#   define debug_assert assert
#else
#   define debug(a)
#   define debugx(a)
#   define debug_assert(e)
#endif


/***************************
 * Print out debugging information.
 */

#ifdef DEBUG
#define debugmes(s)     (debugw && dbg_printf(s))
#define cmes(s)         (debugc && dbg_printf(s))
#define cmes2(s,b)      (debugc && dbg_printf((s),(b)))
#define cmes3(s,b,c)    (debugc && dbg_printf((s),(b),(c)))
#else
#define debugmes(s)
#define cmes(s)
#define cmes2(s,b)
#define cmes3(s,b,c)
#endif

#define TRUE            1
#define FALSE           0

#ifndef ARG_TRUE
#define ARG_TRUE        ,TRUE
#define ARG_FALSE       ,FALSE
#endif

#define arraysize(array)        (sizeof(array) / sizeof(array[0]))

#if TX86

#define IDMAX   900 //467 //254 // identifier max (excluding terminating 0)
#define IDOHD   (4+1+sizeof(int)*3)     // max amount of overhead to ID added by
#define STRMAX  65000           // max length of string (determined by
                                // max ph size)
#else
// USER_IDMAX is the max allowed for a user identifier
// IDMAX in TGcc.h is the maximum mangled name allowed by the target linker
#define USER_IDMAX 254
#endif

enum SC;
struct Thunk;
struct token_t;
struct PARAM;
typedef struct PARAM param_t;
struct block;
struct Classsym;
struct Nspacesym;
struct Outbuffer;
struct Aliassym;
struct dt_t;
typedef struct TYPE type;
typedef struct Symbol symbol;
typedef Symbol Funcsym;
//typedef Symbol Classsym;      // a Symbol that is an SCclass, SCstruct or SCunion
struct elem;
typedef struct MACRO macro_t;
typedef struct BLKLST blklst;
typedef list_t symlist_t;       /* list of pointers to Symbols          */
#if TX86
typedef struct SYMTAB_S symtab_t;
#endif
struct code;

extern Config config;

/////////// Position in source file

typedef struct Srcpos
{
    unsigned Slinnum;           // 0 means no info available
#if TX86
#if SPP || SCPP
    struct Sfile **Sfilptr;     // file
    #define srcpos_sfile(p)     (**(p).Sfilptr)
    #define srcpos_name(p)      (srcpos_sfile(p).SFname)
#endif
#if MARS
    char *Sfilename;
    #define srcpos_name(p)      ((p).SFname)
#endif
#endif
#if M_UNIX
    short Sfilnum;              // file number
#endif
#if SOURCE_OFFSETS
    unsigned long Sfiloff;      // byte offset
#endif
} Srcpos;

#ifndef TOKEN_H
#include "token.h"
#endif

/**********************************
 * Current 'state' of the compiler.
 * Used to gather together most global variables.
 * This struct is saved/restored during function body parsing.
 */

typedef struct Pstate
{
    char STinopeq;              // if in n2_createopeq()
    char STinarglist;           // if !=0, then '>' is the end of a template
                                // argument list, not an operator
    char STinsizeof;            // !=0 if in a sizeof expression. Useful to
                                // prevent <array of> being converted to
                                // <pointer to>.
    char STintemplate;          // if !=0, then expanding a function template
                                // (do not expand template Symbols)
    char STdeferDefaultArg;     // defer parsing of default arg for parameter
    char STnoexpand;            // if !=0, don't expand template symbols
    char STignoretal;           // if !=0 ignore template argument list
    char STexplicitInstantiation;       // if !=0, then template explicit instantiation
    char STexplicitSpecialization;      // if !=0, then template explicit specialization
    char STinconstexp;          // if !=0, then parsing a constant expression
    char STisaddr;              // is this a possible pointer to member expression?
    unsigned STinexp;           // if !=0, then in an expression
#if NTEXCEPTIONS
    char STinfilter;            // if !=0 then in exception filter
    char STinexcept;            // if !=0 then in exception handler
    block *STbfilter;           // current exception filter
#endif
#if TX86
    int STinitseg;              // segment for static constructor function pointer
#endif
    Funcsym *STfuncsym_p;       // if inside a function, then this is the
                                // function Symbol.

#   define funcsym_p (pstate.STfuncsym_p)

    unsigned STflags;
#       define PFLpreprocessor  1       // in preprocessor
#       define preprocessor     (pstate.STflags & PFLpreprocessor)
#       define PFLmasm          2       // in Microsoft-style inline assembler
#       define PFLbasm          4       // in Borland-style inline assembler
#       define inline_asm       (pstate.STflags & (PFLmasm | PFLbasm))
#       define PFLsemi          8       // ';' means start of comment
//#     define PFLautogen       0x10    // automatically generate HX ph file
#       define PFLmftemp        0x20    // if expanding member function template
#       define PFLextdef        0x40    // we had an external def
#       define PFLhxwrote       0x80    // already generated HX ph file
#       define PFLhxdone        0x100   // done with HX ph file
#if TX86
#       define PFLhxread        0x200   // have read in an HX ph file
#       define PFLhxgen         0x400   // need to generate HX ph file
#       define PFLphread        0x800   // read a ph file
#       define PFLcomdef        0x1000  // had a common block
#       define PFLmacdef        0x2000  // defined a macro in the source code
#       define PFLsymdef        0x4000  // declared a global Symbol in the source
#       define PFLinclude       0x8000  // read a .h file
#       define PFLmfc           0x10000 // something will affect MFC compatibility
#endif
#if TX86
    int STinparamlist;          // if != 0, then parser is in
                                // function parameter list
    int STingargs;              // in template argument list
    char SThflag;               // FLAG_XXXX: hydration flag
#define FLAG_INPLACE    0       // in place hydration
#define FLAG_HX         1       // HX file hydration
#define FLAG_SYM        2       // .SYM file hydration

    list_t STincalias;          // list of include aliases
    list_t STsysincalias;       // list of system include aliases
#endif
    Classsym *STclasssym;       // if in the scope of this class
    symlist_t STclasslist;      // list of classes that have deferred inline
                                // functions to parse
    Classsym *STstag;           // returned by struct_searchmember() and with_search()
    SYMIDX STmarksi;            // to determine if temporaries are created
#if !TX86
    int STnest;                 // nesting of ext_def()
    symlist_t STclasslist;      // list of classes that have inline functions
                                // to parse
#endif
    char STnoparse;             // add to classlist instead of parsing
    char STdeferparse;          // defer member func parse
    enum SC STgclass;           // default function storage class
    int STdefertemps;           // defer allocation of temps
    int STdeferaccesscheck;     // defer access check for members (BUG: it
                                // never does get done later)
    int STnewtypeid;            // parsing new-type-id
    int STdefaultargumentexpression;    // parsing default argument expression
#if !TX86
    char STone_id;              // TRUE if only one declaration is allowed, used
                                // for declarations appearing in for statements,
                                // while, if, etc.  that are not allowed to declare multiple
                                // identifiers
    char STno_scope;            // The next lcur should not create it's own scope, the
                                // scoping work has already been done for it
                                // by an enclosing conditional.  This is to make the
                                // conditional expression declarations for RTTI behave as specified
#endif
    block *STbtry;              // current try block
    block *STgotolist;          // threaded goto scoping list
#if MPW_OBJ && TARGET_68K
    short STpush_value;
    short STpop_value;
    char  STdo_push;
#endif
#if !TX86
    char STdo_pop;
    char STprogressShown;       // true if func_body() has already shown progress info
    char STno_ambig;            // true if lookups should not report ambiguous errors
#endif
    long STtdbtimestamp;        // timestamp of tdb file
    Symbol *STlastfunc;         // last function symbol parsed by ext_def()

    // For "point of definition" vs "point of instantiation" template name lookup
    unsigned STsequence;        // sequence number (Ssequence) of next Symbol
    unsigned STmaxsequence;     // won't find Symbols with STsequence larger
                                // than STmaxsequence
} Pstate;

extern Pstate pstate;

#if TX86
/****************************
 * Global variables.
 */

typedef struct Cstate
{
    struct BLKLST *CSfilblk;    // current source file we are parsing
    Symbol *CSlinkage;          // table of forward referenced linkage pragmas
    list_t CSlist_freelist;     // free list for list package
    symtab_t *CSpsymtab;        // pointer to current Symbol table
#if MEMORYHX
    void **CSphx;               // pointer to HX data block
#endif
    char *modname;              // module unique identifier
} Cstate;

extern Cstate cstate;

#endif

/* Bits for sytab[] that give characteristics of storage classes        */
#define SCEXP   1       // valid inside expressions
#define SCKEP   2       // Symbol should be kept even when function is done
#define SCSCT   4       // storage class is valid for use in static ctor
#define SCSS    8       // storage class is on the stack
#define SCRD    0x10    // we can do reaching definitions on these

// Determine if Symbol has a Ssymnum associated with it.
// (That is, it is allocated on the stack or has live variable analysis
//  done on it, so it is stack and register variables.)
#define symbol_isintab(s)       (sytab[(s)->Sclass] & SCSS)

#if defined(__SC__) || defined(_MSC_VER)
typedef char enum_SC;
#else
typedef enum SC enum_SC;
#endif

/******************************************
 * Basic blocks:
 *      Basic blocks are a linked list of all the basic blocks
 *      in a function. startblock heads the list.
 */

#if MARS
struct ClassDeclaration;
struct Declaration;
struct Module;
#endif

struct Blockx
{
#if MARS
    block *startblock;
    block *curblock;
    Funcsym *funcsym;
    Symbol *context;            // eh frame context variable
    int scope_index;            // current scope index
    int next_index;             // value for next scope index
    unsigned flags;             // value to OR into Bflags
    block *tryblock;            // current enclosing try block
    elem *init;                 // static initializer
    ClassDeclaration *classdec;
    Declaration *member;        // member we're compiling for
    Module *module;             // module we're in
#endif
};

typedef struct block
{
    union
    {
        elem *Belem;            // pointer to elem tree
        list_t  Blist;          // list of expressions
    };

    block *Bnext;               // pointer to next block in list
    list_t        Bsucc;        // linked list of pointers to successors
                                //     of this block
    list_t        Bpred;        // and the predecessor list
#if !TX86
    block *Boldnext;            // Saves original pointer to next block in list
#endif
    int Bindex;                 // into created object stack
    int Bendindex;              // index at end of block
    block *Btry;                // BCtry,BC_try: enclosing try block, if any
                                // BC???: if in try-block, points to BCtry or BC_try
                                // note that can't have a BCtry and BC_try in
                                // the same function.
    union
    {   targ_llong      *Bswitch;       // BCswitch: pointer to switch data
        struct {
            regm_t usIasmregs;          // Registers modified
            unsigned char  bIasmrefparam;   // References parameters?
            #define usIasmregs          BS.BIASM.usIasmregs
            #define bIasmrefparam       BS.BIASM.bIasmrefparam
        } BIASM;                        // BCasm

        struct
        {   Symbol *catchvar;           // __throw() fills in this
            #define catchvar BS.BITRY.catchvar
        } BITRY;                        // BCtry

#if SCPP
        struct
        {   type *catchtype;            // one type for each catch block
            #define Bcatchtype BS.BICATCH.catchtype
        } BICATCH;                      // BCcatch
#endif
#if MARS
        struct
        {   Symbol *catchtype;          // one type for each catch block
            #define Bcatchtype BS.BIJCATCH.catchtype
        } BIJCATCH;                     // BCjcatch
#endif
#if NTEXCEPTIONS || MARS
        struct
        {
#if MARS
            Symbol *jcatchvar;          // __j_throw() fills in this
            #define jcatchvar BS.BI_TRY.jcatchvar
#endif
            int Bscope_index;           // index into scope table
            #define Bscope_index BS.BI_TRY.Bscope_index
            int Blast_index;            // enclosing index into scope table
            #define Blast_index BS.BI_TRY.Blast_index
        } BI_TRY;                       // BC_try
#endif

    } BS;
    Srcpos      Bsrcpos;        // line number (0 if not known)
    unsigned char BC;           // exit condition (enum BC)
// NEW
    unsigned char Balign;       // alignment

    unsigned short Bflags;              // flags (BFLxxxx)
        #define BFLvisited    1         // set if block is visited
        #define BFLmark       2         // set if block is visited
        #define BFLjmpoptdone 4         // set when no more jump optimizations
                                        //  are possible for this block
        #define BFLnostackopt 8         // set when stack elimination should not
                                        // be done
#if NTEXCEPTIONS
        #define BFLehcode     0x10      // set when we need to load exception code
        #define BFLunwind     0x1000    // do local_unwind following block
#endif
#if TARGET_POWERPC
        #define BFLstructret  0x10      /* Set if a struct return is changed to
                                           block type BCret.  This is done to avoid
                                           error messages */
#endif
        #define BFLnomerg      0x20     // do not merge with other blocks
#if TX86
        #define BFLprolog      0x80     // generate function prolog
        #define BFLepilog      0x100    // generate function epilog
        #define BFLrefparam    0x200    // referenced parameter
        #define BFLreflocal    0x400    // referenced local
        #define BFLoutsideprolog 0x800  // outside function prolog/epilog
        #define BFLlabel        0x2000  // block preceded by label
#else
        #define BFLlooprt      0x40     // set if looprotate() changes it's Bnext
#endif
        #define BFLvolatile     0x4000  // block is volatile
    code        *Bcode;         // code generated for this block

    unsigned Bweight;           // relative number of times this block
                                // is executed (optimizer and codegen)

    unsigned    Bdfoidx;        // index of this block in dfo[]
    union
    {
        // CPP
        struct
        {
            SYMIDX      symstart;       // (symstart <= symnum < symend) Symbols
            SYMIDX      symend;         // are declared in this block
            block       *endscope;      // block that forms the end of the
                                        // scope for the declared Symbols
            unsigned blknum;            // position of block from startblock
            Symbol      *Binitvar;      // !=NULL points to an auto variable with
                                        // an explicit or implicit initializer
            block       *gotolist;      // BCtry, BCcatch: backward list of try scopes
            block       *gotothread;    // BCgoto: threaded list of goto's to
                                        // unknown labels

            #define Bsymstart   _BLU._UP.symstart
            #define Bsymend     _BLU._UP.symend
            #define Bendscope   _BLU._UP.endscope
            #define Bblknum     _BLU._UP.blknum
            #define Binitvar    _BLU._UP.Binitvar
            #define Bgotolist   _BLU._UP.gotolist
            #define Bgotothread _BLU._UP.gotothread
        }_UP;

        // OPTIMIZER
        struct
        {
            vec_t       Bdom;           // mask of dominators for this block
            vec_t       Binrd;
            vec_t       Boutrd;         // IN and OUT for reaching definitions
            vec_t       Binlv;
            vec_t       Boutlv;         // IN and OUT for live variables
            vec_t       Bin;
            vec_t       Bout;           // IN and OUT for other flow analyses
            vec_t       Bgen;
            vec_t       Bkill;          // pointers to bit vectors used by data
                                        // flow analysis

            // BCiftrue can have different vectors for the 2nd successor:
            vec_t       Bout2;
            vec_t       Bgen2;
            vec_t       Bkill2;

            #define Bdom        _BLU._UO.Bdom
            #define Binrd       _BLU._UO.Binrd
            #define Boutrd      _BLU._UO.Boutrd
            #define Binlv       _BLU._UO.Binlv
            #define Boutlv      _BLU._UO.Boutlv
            #define Bin         _BLU._UO.Bin
            #define Bout        _BLU._UO.Bout
            #define Bgen        _BLU._UO.Bgen
            #define Bkill       _BLU._UO.Bkill
            #define Bout2       _BLU._UO.Bout2
            #define Bgen2       _BLU._UO.Bgen2
            #define Bkill2      _BLU._UO.Bkill2
        }_UO;

        // CODGEN
        struct
        {
            targ_size_t Btablesize;     // BCswitch, BCjmptab
            targ_size_t Btableoffset;   // BCswitch, BCjmptab
            targ_size_t Boffset;        // code offset of start of this block
            targ_size_t Bsize;          // code size of this block
            con_t       Bregcon;        // register state at block exit
            targ_size_t Btryoff;        // BCtry: offset of try block data

            #define Btablesize          _BLU._UD.Btablesize
            #define Btableoffset        _BLU._UD.Btableoffset
            #define Boffset             _BLU._UD.Boffset
            #define Bsize               _BLU._UD.Bsize
//          #define Bcode               _BLU._UD.Bcode
            #define Bregcon             _BLU._UD.Bregcon
            #define Btryoff             _BLU._UD.Btryoff
        } _UD;
    } _BLU;
    TARGET_structBLOCK
} block;

#define list_block(l)   ((block *) list_ptr(l))
#if !TX86
#define block_calloc()  ((block *) MEM_PH_CALLOC(sizeof(block)))
#endif

/** Basic block control flow operators. **/

enum BC {
    BCgoto      = 1,    // goto Bsucc block
    BCiftrue    = 2,    // if (Belem) goto Bsucc[0] else Bsucc[1]
    BCret       = 3,    // return (no return value)
    BCretexp    = 4,    // return with return value
    BCexit      = 5,    // never reaches end of block (like exit() was called)
    BCasm       = 6,    // inline assembler block (Belem is NULL, Bcode
                        // contains code generated).
                        // These blocks have one or more successors in Bsucc,
                        // never 0
    BCswitch    = 7,    // switch statement
                        // Bswitch points to switch data
                        // Default is Bsucc
                        // Cases follow in linked list
    BCifthen    = 8,    // a BCswitch is converted to if-then
                        // statements
    BCjmptab    = 9,    // a BCswitch is converted to a jump
                        // table (switch value is index into
                        // the table)
    BCtry       = 10,   // C++ try block
                        // first block in a try-block. The first block in
                        // Bsucc is the next one to go to, subsequent
                        // blocks are the catch blocks
    BCcatch     = 11,   // C++ catch block
    BCjump      = 12,   // Belem specifies (near) address to jump to
    BC_try      = 13,   // SEH: first block of try-except or try-finally
                        // Jupiter, Mars: try-catch or try-finally
    BC_filter   = 14,   // SEH exception-filter (always exactly one block)
    BC_finally  = 15,   // first block of SEH termination-handler,
                        // or finally block
    BC_ret      = 16,   // last block of SEH termination-handler or finally block
    BC_except   = 17,   // first block of SEH exception-handler
    BCjcatch    = 18,   // first block of Jupiter or Mars catch-block
    BCjplace    = 19,   // Jupiter: placeholder
    BCMAX
};

/**********************************
 * Functions
 */

typedef struct SYMTAB_S
{
    SYMIDX top;                 // 1 past end
    SYMIDX symmax;              // max # of entries in tab[] possible
    Symbol **tab;               // local Symbol table
} symtab_t;

typedef struct FUNC_S
{
    symlist_t Fsymtree;         // local Symbol table
    block *Fstartblock;         // list of blocks comprising function
    symtab_t Flocsym;           // local Symbol table
    Srcpos Fstartline;          // starting line # of function
    Srcpos Fendline;            // line # of closing brace of function
    Symbol *F__func__;          // symbol for __func__[] string
    unsigned Fflags;
#       define Fpending  1      // if function has been queued for being written
#       define Foutput   2      /* if function has been written out     */
#       define Finline   0x10   /* if SCinline, and function really is inline */
#       define Foverload 0x20   /* if function can be overloaded        */
#       define Ftypesafe 0x40   /* if function name needs type appended */
#       define Fmustoutput 0x80 /* set for forward ref'd functions that */
                                /* must be output                       */
#       define Finlinenest 0x1000 /* used as a marker to prevent nested */
                                /* inlines from expanding               */
#       define Flinkage 0x2000  /* linkage is already specified         */
#       define Fstatic  0x4000  /* static member function (no this)     */
#       define Foperator 4      /* if operator overload                 */
#       define Fcast     8      /* if cast overload                     */
#       define Fvirtual 0x100   /* if function is a virtual function    */
#       define Fctor    0x200   /* if function is a constructor         */
#       define Fdtor    0x400   /* if function is a destructor          */
#       define Fnotparent 0x800 /* if function is down Foversym chain   */
#       define Fbitcopy 0x8000  /* it's a simple bitcopy (op=() or X(X&)) */
#       define Fpure     0x10000        // pure function
#       define Finstance 0x20000        // function is an instance of a template
#       define Ffixed    0x40000        // ctor has had cpp_fixconstructor() run on it,
                                        // dtor has had cpp_fixdestructor()
#       define Fintro    0x80000        // function doesn't hide a previous virtual function
#if !TX86
#       define Fstcstd   0x100000       // static constructor or static destructor
#endif
#       define Fkeeplink 0x200000       // don't change linkage to default
#       define Fnodebug  0x400000       // do not generate debug info for this function
#       define Fgen      0x800000       // compiler generated function
#       define Finvariant 0x1000000     // __invariant function
#       define Fexplicit  0x2000000     // explicit constructor
#       define Fsurrogate 0x4000000     // surrogate call function
    unsigned Fflags3;
        #define Fvtblgen        0x01    // generate vtbl[] when this function is defined
        #define Femptyexc       0x02    // empty exception specification (obsolete, use Tflags & TFemptyexc)
        #define Fcppeh          0x04    // uses C++ EH
        #define Fdeclared       0x10    // already declared function Symbol
        #define Fmark           0x20    // has unbalanced OPctor's
        #define Fnteh           0x08    // uses NT Structured EH
        #define Fdoinline       0x40    // do inline walk
        #define Foverridden     0x80    // ignore for overriding purposes
#if TARGET_LINUX || TARGET_OSX || TARGET_FREEBSD || TARGET_SOLARIS
        #define Fnowrite        0x100   // SCinline should never output definition
#else
        #define Fjmonitor       0x100   // Jupiter synchronized function
#endif
        #define Fnosideeff      0x200   // function has no side effects
        #define F3badoparrow    0x400   // bad operator->()
        #define Fmain           0x800   // function is main() or wmain()
        #define Fnested         0x1000  // D nested function with 'this'
        #define Fmember         0x2000  // D member function with 'this'
        #define Fnotailrecursion 0x4000 // no tail recursion optimizations
        #define Ffakeeh         0x8000  // allocate space for NT EH context sym anyway
    unsigned char Foper;        // operator number (OPxxxx) if Foperator

    Symbol *Fparsescope;        // use this scope to parse friend functions
                                // which are defined within a class, so the
                                // class is in scope, but are not members
                                // of the class

    Classsym *Fclass;           // if member of a class, this is the class
                                // (I think this is redundant with Sscope)
    Funcsym *Foversym;          // overloaded function at same scope
    symlist_t Fclassfriends;    /* Symbol list of classes of which this */
                                /* function is a friend                 */
    block *Fbaseblock;          // block where base initializers get attached
    block *Fbaseendblock;       // block where member destructors get attached
    elem *Fbaseinit;            /* list of member initializers (meminit_t) */
                                /* this field has meaning only for      */
                                /* functions which are constructors     */
    struct token_t *Fbody;      /* if deferred parse, this is the list  */
                                /* of tokens that make up the function  */
                                /* body                                 */
                                // also used if SCfunctempl, SCftexpspec
    unsigned Fsequence;         // sequence number at point of definition
    union
    {
        Symbol *Ftempl;         // if Finstance this is the template that generated it
        struct Thunk *Fthunk;   // !=NULL if this function is actually a thunk
    };
    Funcsym *Falias;            // SCfuncalias: function Symbol referenced
                                // by using-declaration
#if TX86
    symlist_t Fthunks;          // list of thunks off of this function
#endif
    param_t *Farglist;          // SCfunctempl: the template-parameter-list
    param_t *Fptal;             // Finstance: this is the template-argument-list
                                // SCftexpspec: for explicit specialization, this
                                // is the template-argument-list
    list_t Ffwdrefinstances;    // SCfunctempl: list of forward referenced instances
    list_t Fexcspec;            // List of types in the exception-specification
                                // (NULL if none or empty)
    Funcsym *Fexplicitspec;     // SCfunctempl, SCftexpspec: threaded list
                                // of SCftexpspec explicit specializations
    Funcsym *Fsurrogatesym;     // Fsurrogate: surrogate cast function

#if TARGET_LINUX || TARGET_OSX || TARGET_FREEBSD || TARGET_SOLARIS
    char *Fredirect;            // redirect function name to this name in object
#endif
    TARGET_structFUNC_S
} func_t;

#if TX86
#define func_calloc()   ((func_t *) mem_fcalloc(sizeof(func_t)))
#define func_free(f)    mem_ffree(f)
#else
#define func_calloc()   ((func_t *) MEM_PH_CALLOC(sizeof(func_t)))
#define func_free(f)    MEM_PH_FREE(f)
#endif

/**************************
 * Item in list for member initializer.
 */

typedef struct MEMINIT
{
    list_t  MIelemlist;         /* arg list for initializer             */
    Symbol *MIsym;              /* if NULL, then this initializer is    */
                                /* for the base class. Otherwise, this  */
                                /* is the member that needs the ctor    */
                                /* called for it                        */
} meminit_t;


/************************************
 * Base classes are a list of these.
 */

typedef struct BASECLASS
{
    Classsym         *BCbase;           // base class Symbol
    struct BASECLASS *BCnext;           // next base class
    targ_size_t       BCoffset;         // offset from start of derived class to this
#if VBTABLES
    unsigned short    BCvbtbloff;       // for BCFvirtual, offset from start of
                                        //     vbtbl[] to entry for this virtual base.
                                        //     Valid in Sbase list
#else
    targ_size_t memoffset;      /* for BCFvirtual, offset from this to
                                   pointer to virtual base class.
                                   Valid in Sbase list
                                 */
    Symbol *param;              /* parameter for this Symbol (in        */
                                /* Svirtbase list only)                 */
#endif
    symlist_t         BCpublics;        // public members of base class (list is freeable)
    list_t            BCmptrlist;       // (in Smptrbase only) this is the vtbl
                                        // (NULL if not different from base class's vtbl
    Symbol           *BCvtbl;           // Symbol for vtbl[] array (in Smptrbase list)
                                        // Symbol for vbtbl[] array (in Svbptrbase list)
    unsigned          BCflags;          // base class flags
#define BCFpublic       1                   // base class is public
#define BCFprotected    2                   // base class is protected
#define BCFprivate      4                   // base class is private
#define BCFpmask        (BCFpublic | BCFprotected | BCFprivate)

#define BCFvirtual      8                   // base class is virtual
#define BCFvfirst       0x10                // virtual base class, and this is the
                                            // first virtual appearance of it
#define BCFnewvtbl      0x20                // new vtbl generated for this base class
#define BCFvirtprim     0x40                // Primary base class of a virtual base class
#define BCFdependent    0x80                // base class is a dependent type
    Classsym         *BCparent;         // immediate parent of this base class
                                        //     in Smptrbase
#if TX86
    struct BASECLASS *BCpbase;          // parent base, NULL if did not come from a parent
#endif
} baseclass_t;

#define baseclass_malloc()      ((baseclass_t *)mem_fmalloc(sizeof(baseclass_t)))
#define baseclass_free(b)       ((void)(b))

/*************************
 * For virtual tables.
 */

typedef struct MPTR
{   targ_short     MPd;
    targ_short     MPi;
    Symbol        *MPf;
    Symbol        *MPparent;    // immediate parent of this base class
                                //   in Smptrbase
    unsigned char  MPflags;
#define MPTRvirtual     1       // it's an offset to a virtual base
#define MPTRcovariant   2       // need covariant return pointer adjustment
} mptr_t;

#define list_mptr(l)    ((mptr_t *) list_ptr(l))


/***********************************
 * Information gathered about externally defined template member functions,
 * member data, and member classes.
 */

struct TMF
{
    Classsym *stag;             // if !=NULL, this is the enclosing class
    token_t *tbody;             // tokens making it up
    token_t *to;                // pointer within tbody where we left off in
                                // template_function_decl()
    param_t *temp_arglist;      // template parameter list
    int member_class;           // 1: it's a member class

    // These are for member templates
    int castoverload;           // 1: it's a user defined cast
    char *name;                 // name of template (NULL if castoverload)
    int member_template;        // 0: regular template
                                // 1: member template
    param_t *temp_arglist2;     // if member template,
                                // then member's template parameter list

    param_t *ptal;              // if explicit specialization, this is the
                                // explicit template-argument-list
    Symbol *sclassfriend;       // if member function is a friend of class X,
                                // this is class X
    unsigned access_specifier;
};

/***********************************
 * Information gathered about primary member template explicit specialization.
 */

struct TME
{
    /* Given:
     *  template<> template<class T2> struct A<short>::B { };
     *  temp_arglist2 = <class T2>
     *  name = "B"
     *  ptal = <short>
     */
    param_t *ptal;              // explicit template-argument-list for enclosing
                                // template A
    symbol *stempl;             // template symbol for B
};

/***********************************
 * Information gathered about nested explicit specializations.
 */

struct TMNE
{
    /* For:
     *  template<> template<> struct A<short>::B<double> { };
     */

    enum_TK tk;                 // TKstruct / TKclass / TKunion
    char *name;                 // name of template, i.e. "B"
    param_t *ptal;              // explicit template-argument-list for enclosing
                                // template A, i.e. "short"
    token_t *tdecl;             // the tokens "<double> { }"
};

/***********************************
 * Information gathered about nested class friends.
 */

struct TMNF
{
    /* Given:
     *  template<class T> struct A { struct B { }; };
     *  class C { template<class T> friend struct A<T>::B;
     */
    token_t *tdecl;             // the tokens "A<T>::B;"
    param_t *temp_arglist;      // <class T>
    Classsym *stag;             // the class symbol C
    symbol *stempl;             // the template symbol A
};

/***********************************
 * Special information for class templates.
 */

typedef struct TEMPLATE
{
    symlist_t     TMinstances;  // list of Symbols that are instances
    param_t      *TMptpl;       // template-parameter-list
    struct token_t *TMbody;     // tokens making up class body
    unsigned TMsequence;        // sequence number at point of definition
    list_t TMmemberfuncs;       // templates for member functions (list of TMF's)
    list_t TMexplicit;          // list of TME's: primary member template explicit specializations
    list_t TMnestedexplicit;    // list of TMNE's: primary member template nested explicit specializations
    Symbol *TMnext;             // threaded list of template classes headed
                                // up by template_class_list
    enum_TK        TMtk;        // TKstruct, TKclass or TKunion
    int            TMflags;     // STRxxx flags

    symbol *TMprimary;          // primary class template
    symbol *TMpartial;          // next class template partial specialization
    param_t *TMptal;            // template-argument-list for partial specialization
                                // (NULL for primary class template)
    list_t TMfriends;           // list of Classsym's for which any instantiated
                                // classes of this template will be friends of
    list_t TMnestedfriends;     // list of TMNF's
    int TMflags2;               // !=0 means dummy template created by template_createargtab()
} template_t;

/***********************************
 * Special information for enums.
 */

typedef struct ENUM
{
    unsigned SEflags;
#define SENnotagname    1       // no tag name for enum
#define SENforward      2       // forward referenced enum

    Symbol *SEalias;            // pointer to identifier E to use if
                                /* enum was defined as:                 */
                                /*      typedef enum { ... } E;         */
    symlist_t SEenumlist;       // all members of enum
} enum_t;

/***********************************
 * Special information for structs.
 */

typedef struct STRUCT
{
    targ_size_t Sstructsize;    // size of struct
    symlist_t Sfldlst;          // all members of struct (list freeable)
    Symbol *Sroot;              // root of binary tree Symbol table
    unsigned Salignsize;        // size of struct for alignment purposes
    unsigned char Sstructalign; // struct member alignment in effect
    unsigned long Sflags;
#define STRanonymous    0x01    // set for unions with no tag names
#define STRglobal       0x02    // defined at file scope
#define STRnotagname    0x04    // struct/class with no tag name
#define STRoutdef       0x08    // we've output the debug definition
#define STRbitfields    0x10    // set if struct contains bit fields
#define STRpredef       0x1000 // a predefined struct
#define STRunion        0x4000  // actually, it's a union

#define STRabstract     0x20    // abstract class
#define STRbitcopy      0x40    // set if operator=() is merely a bit copy
#define STRanyctor      0x80    // set if any constructors were defined
                                // by the user
#define STRnoctor       0x100   // no constructors allowed
#define STRgen          0x200   // if struct is an instantiation of a
                                // template class, and was generated by
                                // that template
#define STRvtblext      0x400   // generate vtbl[] only when first member function
                                // definition is encountered (see Fvtblgen)
#define STRexport       0x800   // all member functions are to be _export
#define STRclass        0x8000  // it's a class, not a struct
#if TX86
#define STRimport       0x40000 // imported class
#define STRstaticmems   0x80000 // class has static members
#endif
#define STR0size        0x100000        // zero sized struct
#define STRinstantiating 0x200000       // if currently being instantiated
#define STRexplicit     0x400000        // if explicit template instantiation
#define STRgenctor0     0x800000        // need to gen X::X()
    tym_t ptrtype;              // type of pointer to refer to classes by
    unsigned short access;      // current access privilege, here so
                                // enum declarations can get at it
    targ_size_t Snonvirtsize;   // size of struct excluding virtual classes
    list_t Svirtual;            // freeable list of mptrs
                                // that go into vtbl[]
#if TX86
    list_t *Spvirtder;          // pointer into Svirtual that points to start
                                // of virtual functions for this (derived) class
    symlist_t Sopoverload;      // overloaded operator funcs (list freeable)
#endif
    symlist_t Scastoverload;    // overloaded cast funcs (list freeable)
    symlist_t Sclassfriends;    // list of classes of which this is a friend
                                // (list is freeable)
    symlist_t Sfriendclass;     // classes which are a friend to this class
                                // (list is freeable)
    symlist_t Sfriendfuncs;     // functions which are a friend to this class
                                // (list is freeable)
    symlist_t Sinlinefuncs;     // list of tokenized functions
    baseclass_t *Sbase;         // list of direct base classes
    baseclass_t *Svirtbase;     // list of all virtual base classes
    baseclass_t *Smptrbase;     // list of all base classes that have
                                // their own vtbl[]
    baseclass_t *Sprimary;      // if not NULL, then points to primary
                                // base class
    Funcsym *Svecctor;          // constructor for use by vec_new()
    Funcsym *Sctor;             // constructor function

    Funcsym *Sdtor;             // basic destructor
#if VBTABLES
    Funcsym *Sprimdtor;         // primary destructor
    Funcsym *Spriminv;          // primary invariant
    Funcsym *Sscaldeldtor;      // scalar deleting destructor
#endif

    Funcsym *Sinvariant;        // basic invariant function

    Symbol *Svptr;              // Symbol of vptr
    Symbol *Svtbl;              // Symbol of vtbl[]
#if VBTABLES
    Symbol *Svbptr;             // Symbol of pointer to vbtbl[]
    Symbol *Svbptr_parent;      // base class for which Svbptr is a member.
                                // NULL if Svbptr is a member of this class
    targ_size_t Svbptr_off;     // offset of Svbptr member
    Symbol *Svbtbl;             // virtual base offset table
    baseclass_t *Svbptrbase;    // list of all base classes in canonical
                                // order that have their own vbtbl[]
#endif
    Funcsym *Sopeq;             // X& X::operator =(X&)
    Funcsym *Sopeq2;            // Sopeq, but no copy of virtual bases
    Funcsym *Scpct;             // copy constructor
    Funcsym *Sveccpct;          // vector copy constructor
    Symbol *Salias;             // pointer to identifier S to use if
                                // struct was defined as:
                                //      typedef struct { ... } S;

    Symbol *Stempsym;           // if this struct is an instantiation
                                // of a template class, this is the
                                // template class Symbol

    /* For:
     *  template<class T> struct A { };
     *  template<class T> struct A<T *> { };
     *
     *  A<int> a;               // primary
     * Gives:
     *  Sarglist = <int>
     *  Spr_arglist = NULL;
     *
     *  A<int*> a;              // specialization
     * Gives:
     *  Sarglist = <int>
     *  Spr_arglist = <int*>;
     */

    param_t *Sarglist;          // if this struct is an instantiation
                                // of a template class, this is the
                                // actual arg list used
    param_t *Spr_arglist;       // if this struct is an instantiation
                                // of a specialized template class, this is the
                                // actual primary arg list used.
                                // It is NULL for the
                                // primary template class (since it would be
                                // identical to Sarglist).
    TARGET_structSTRUCT
} struct_t;

#if TX86
#define struct_calloc() ((struct_t *) mem_fcalloc(sizeof(struct_t)))
#define struct_free(st) ((void)(st))
#else
#define struct_calloc() ((struct_t *) MEM_PH_CALLOC(sizeof(struct_t)))
#define struct_free(st) MEM_PH_FREE(st)
#endif

/**********************************
 * Symbol Table
 */

#define list_symbol(l)          ((Symbol *) list_ptr(l))
#define list_setsymbol(l,s)     list_ptr(l) = (s)
#define list_Classsym(l)        ((Classsym *) list_ptr(l))

#if TARGET_POWERPC
#pragma SC align 4
#endif

struct Symbol
{
#ifdef DEBUG
    unsigned short      id;
#define IDsymbol 0x5678
#define symbol_debug(s) assert((s)->id == IDsymbol)
#define class_debug(s) assert((s)->id == IDsymbol)
#else
#define symbol_debug(s)
#define class_debug(s)
#endif

    Symbol *Sl,*Sr;             // left, right child
#if TX86
    Symbol *Snext;              // next in threaded list
#endif
    dt_t *Sdt;                  // variables: initializer
    type *Stype;                // type of Symbol
    #define ty() Stype->Tty

    union                       // variants for different Symbol types
    {
        enum_t *Senum_;         // SCenum
        #define Senum _SU.Senum_
        struct
        {    func_t *Sfunc_;    // tyfunc
             #define Sfunc _SU._SF.Sfunc_
             list_t Spath1_;    // SCfuncalias member functions: same as Spath
             #define Spath1 _SU._SF.Spath1_
                                // and in same position
                                // SCadl: list of associated functions for ADL lookup
        }_SF;
        struct                  // SClabel
        {   int Slabel_;                // TRUE if label was defined
             #define Slabel _SU._SL.Slabel_
            block *Slabelblk_;  // label block
             #define Slabelblk _SU._SL.Slabelblk_
        }_SL;
        #define Senumlist Senum->SEenumlist

#if TX86
        struct                  // SClinkage
        {
            long Slinkage_;     // tym linkage bits
             #define Slinkage _SU._SLK.Slinkage_
            unsigned Smangle_;
             #define Smangle _SU._SLK.Smangle_
        }_SLK;
#else
        long Slinkage;          // SClinkage, tym linkage bits
#endif

        struct
        {
            char Sbit_;         // SCfield: bit position of start of bit field
             #define Sbit _SU._SB.Sbit_
            char Swidth_;       // SCfield: width in bits of bit field
             #define Swidth _SU._SB.Swidth_
#if TX86
            targ_size_t Smemoff_; // SCmember,SCfield: offset from start of struct
             #define Smemoff _SU._SB.Smemoff_
#endif
        }_SB;

        elem *Svalue_;          /* SFLvalue: value of const
                                   SFLdtorexp: for objects with destructor,
                                   conditional expression to precede dtor call
                                 */
        #define Svalue _SU.Svalue_

        struct_t *Sstruct_;     // SCstruct
        #define Sstruct _SU.Sstruct_
        template_t *Stemplate_; // SCtemplate
        #define Stemplate _SU.Stemplate_
#if SCPP
        struct                  // SCnamespace
        {   Symbol *Snameroot_; // the Symbol table for the namespace
             #define Snameroot _SU._SN.Snameroot_
            list_t Susing_;     // other namespaces from using-directives
             #define Susing _SU._SN.Susing_
        }_SN;
        struct
        {   Symbol *Smemalias_; // SCalias: pointer to Symbol to use instead
                                // (generated by using-declarations and
                                // namespace-alias-definitions)
                                // SCmemalias: pointer to member of base class
                                // to use instead (using-declarations)
             #define Smemalias _SU._SA.Smemalias_
            symlist_t Spath_;   // SCmemalias: path of classes to get to base
                                // class of which Salias is a member
             #define Spath _SU._SA.Spath_
        }_SA;
#endif
#if TX86
        Symbol *Simport_;       // SCextern: if dllimport Symbol, this is the
        #define Simport _SU.Simport_
                                // Symbol it was imported from
#endif
        unsigned char Spreg_;   // SCfastpar: register parameter is passed in
        #define Spreg _SU.Spreg_
    }_SU;

#if SCPP || MARS
    Symbol *Sscope;             // enclosing scope (could be struct tag,
                                // enclosing inline function for statics,
                                // or namespace)
#define isclassmember(s)        ((s)->Sscope && (s)->Sscope->Sclass == SCstruct)
#endif

#if SCPP
    Symbol *Scover;             // if there is a tag name and a regular name
                                // of the same identifier, Scover is the tag
                                // Scover can be SCstruct, SCenum, SCtemplate
                                // or an SCalias to them.
#define isscover(s)             ((s)->Sclass == SCstruct || (s)->Sclass == SCenum || (s)->Sclass == SCtemplate)
    unsigned Ssequence;         // sequence number (used for 2 level lookup)
                                // also used as 'parameter number' for SCTtemparg
#elif MARS
    const char *prettyIdent;    // the symbol identifer as the user sees it
#elif AUTONEST
    unsigned char Spush;        // # of pushes followed by # of
    unsigned char Spop;         // pops of scope level
#endif

#if ELFOBJ || MACHOBJ
    long          obj_si;       // Symbol index of coff or elf symbol
    unsigned long dwarf_off;    // offset into .debug section
    targ_size_t   code_off;     // rel. offset from start of block where var is initialized
    targ_size_t   last_off;     // last offset using var
#endif
#if TARGET_OSX
    targ_size_t Slocalgotoffset;
#endif

    enum_SC Sclass;             // storage class (SCxxxx)
    char Sfl;                   // flavor (FLxxxx)
    SYMFLGS Sflags;             // flag bits (SFLxxxx)
        #define SFLmark         0x08    // temporary marker
        #define SFLvalue        0x01    // Svalue contains const expression
        #define SFLimplem       0x02    // if seen implementation of Symbol
                                        // (function body for functions,
                                        // initializer for variables)
        #define SFLdouble       0x02    // SCregpar or SCparameter, where float
                                        // is really passed as a double
        #define SFLfree         0x04    // if we can symbol_free() a Symbol in
                                        // a Symbol table[]
        #define SFLexit         0x10    // tyfunc: function does not return
                                        // (ex: exit,abort,_assert,longjmp)
        #define SFLtrue         0x200   // value of Symbol != 0
        #define SFLreplace      SFLmark // variable gets replaced in inline expansion
        #define SFLskipinit     0x10000 // SCfield, SCmember: initializer is skipped
        #define SFLnodebug      0x20000 // don't generate debug info
        #define SFLwasstatic    0x800000 // was an uninitialized static
        #define SFLweak         0x1000000 // resolve to NULL if not found

        // CPP
        #define SFLnodtor       0x10    // set if destructor for Symbol is already called
        #define SFLdtorexp      0x80    // Svalue has expression to tack onto dtor
        #define SFLmutable      0x100000        // SCmember or SCfield is mutable
        #define SFLdyninit      0x200000        // symbol has dynamic initializer
        #define SFLtmp          0x400000        // symbol is a generated temporary
#if TARGET_LINUX || TARGET_OSX || TARGET_FREEBSD || TARGET_SOLARIS
        #define SFLthunk        0x40000 // symbol is temporary for thunk
#endif

        // Possible values for protection bits
        #define SFLprivate      0x60
        #define SFLprotected    0x40
        #define SFLpublic       0x20
        #define SFLnone         0x00
        #define SFLpmask        0x60    // mask for the protection bits
#if VEC_VTBL_LIST
        #define SFLvtbl         0x2000  // Symbol is a vtable or vbtable
#endif

        // OPTIMIZER and CODGEN
        #define GTregcand       0x100   // if Symbol is a register candidate
        #define SFLdead         0x800   // this variable is dead
        #define GTunregister    0x2000000       // 'unregister' a previous register assignment

        // OPTIMIZER only
        #define SFLunambig      0x400   // only accessible by unambiguous reference,
                                        // i.e. cannot be addressed via pointer
                                        // (GTregcand is a subset of this)
                                        // P.S. code generator turns off this
                                        // flag if any reads are done from it.
                                        // This is to eliminate stores to it
                                        // that are never read.
        #define SFLlivexit      0x1000  // live on exit from function
        #define SFLnotbasiciv   0x4000  // not a basic induction variable
        #define SFLnord         SFLdouble // SCauto,SCregister,SCtmp: disallow redundant warnings

        // CODGEN only
        #define GTtried         SFLmark // tried to place in register
        #define GTbyte          0x8000  // variable is sometimes accessed as
        #define SFLread         0x40000 // variable is actually read from
                                        // (to eliminate dead stores)
        #define SFLspill        0x80000 // only in register part of the time

    vec_t       Srange;         // live range, if any
    vec_t       Slvreg;         // when symbol is in register
    targ_size_t Ssize;          // tyfunc: size of function
    targ_size_t Soffset;        // variables: offset of Symbol in its storage class
#if TARGET_MAC
#define Smemoff Soffset
#endif

    // CPP || OPTIMIZER
    SYMIDX Ssymnum;             // Symbol number (index into globsym.tab[])
                                // SCauto,SCparameter,SCtmp,SCregpar,SCregister
    // CODGEN
#if TX86
    int Sseg;                   // segment index
#endif
    int Sweight;                // usage count, the higher the number,
                                // the more worthwhile it is to put in
                                // a register
    union
    {
        unsigned Sxtrnnum_;     // SCcomdef,SCextern,SCcomdat: external symbol # (starting from 1)
        #define Sxtrnnum _SXR.Sxtrnnum_
        unsigned long Stypidx_; // SCstruct,SCunion,SCclass,SCenum,SCtypedef: debug info type index
        #define Stypidx _SXR.Stypidx_
        struct
        { unsigned char Sreglsw_;
          #define Sreglsw _SXR._SR.Sreglsw_
          unsigned char Sregmsw_;
          #define Sregmsw _SXR._SR.Sregmsw_
          regm_t Sregm_;        // mask of registers
          #define Sregm _SXR._SR.Sregm_
        }_SR;                   // SCregister,SCregpar,SCpseudo: register number
    }_SXR;
#if TX86
    regm_t      Sregsaved;      // mask of registers not affected by this func
#endif

#if SOURCE_4SYMS
    Srcpos Ssrcpos;             // file position for definition
#endif
    // Target Additions
    TARGET_structSYMBOL
#if TX86
    char Sident[SYM_PREDEF_SZ]; // identifier string (dynamic array)
                                // (the size is for static Symbols)
#else
    long Sident[];      // identifier string (dynamic array) as a str4
#endif

    int needThis();     // !=0 if symbol needs a 'this' pointer
};
#pragma SC align

// Class, struct or union

struct Classsym : Symbol { };

// Namespace Symbol
struct Nspacesym : Symbol { };

// Alias for another Symbol
struct Aliassym : Symbol { };

// Function symbol
//struct Funcsym : Symbol { };

// Determine if this Symbol is stored in a COMDAT
#if MARS
#define symbol_iscomdat(s)      ((s)->Sclass == SCcomdat ||             \
        config.flags2 & CFG2comdat && (s)->Sclass == SCinline ||        \
        config.flags4 & CFG4allcomdat && ((s)->Sclass == SCglobal))
#else
#define symbol_iscomdat(s)      ((s)->Sclass == SCcomdat ||             \
        config.flags2 & CFG2comdat && (s)->Sclass == SCinline ||        \
        config.flags4 & CFG4allcomdat && ((s)->Sclass == SCglobal || (s)->Sclass == SCstatic))
#endif

/* Format the identifier for presentation to the user   */
char *cpp_prettyident (Symbol *s);

inline char *prettyident(Symbol *s) { return CPP ? cpp_prettyident(s) : s->Sident; }

/**********************************
 * Function parameters:
 *      Pident          identifier of parameter
 *      Ptype           type of argument
 *      Pelem           default value for argument
 *      Psym            symbol corresponding to Pident when using the
 *                      parameter list as a symbol table
 * For template-parameter-list:
 *      Pident          identifier of parameter
 *      Ptype           if NULL, this is a type-parameter
 *                      else the type for a parameter-declaration value argument
 *      Pelem           default value for value argument
 *      Pdeftype        default value for type-parameter
 *      Pptpl           template-parameter-list for template-template-parameter
 *      Psym            default value for template-template-parameter
 * For template-arg-list: (actual arguments)
 *      Pident          NULL
 *      Ptype           type-name
 *      Pelem           expression (either Ptype or Pelem is NULL)
 *      Psym            SCtemplate for template-template-argument
 */

struct PARAM
{
#ifdef DEBUG
    unsigned short      id;
#define IDparam 0x7050
#define param_debug(s) assert((s)->id == IDparam)
#else
#define param_debug(s)
#endif

    char *Pident;               // identifier
    type *Ptype;                // type of parameter (NULL if not known yet)
    elem *Pelem;                // default value
    token_t *PelemToken;        // tokens making up default elem
    type *Pdeftype;             // Ptype==NULL: default type for type-argument
    param_t *Pptpl;             // template-parameter-list for template-template-parameter
    Symbol *Psym;
    PARAM *Pnext;               // next in list
    unsigned Pflags;
    #define PFexplicit  1       // this template argument was explicit, i.e. in < >
#if SOURCE_4PARAMS
    Srcpos Psrcpos;             // parameter source definition
#endif
    TARGET_structPARAM

    PARAM *createTal(PARAM *);  // create template-argument-list blank from
                                // template-parameter-list
    PARAM *search(char *id);    // look for Pident matching id
    int searchn(char *id);      // look for Pident matching id, return index
    unsigned length();          // number of parameters in list
    void print();               // print this param_t
    void print_list();          // print this list of param_t's
};

/**************************************
 * Element types.
 * These should be combined with storage classes.
 */

enum FL
{
        FLunde,
        FLconst,        // numerical constant
        FLoper,         // operator node
        FLfunc,         // function symbol
        FLdata,         // ref to data segment variable
        FLreg,          // ref to register variable
        FLpseudo,       // pseuodo register variable
        FLauto,         // ref to automatic variable
        FLpara,         // ref to function parameter variable
        FLextern,       // ref to external variable
        FLtmp,          // ref to a stack temporary, int contains temp number
        FLcode,         // offset to code
        FLblock,        // offset to block
        FLudata,        // ref to udata segment variable
        FLcs,           // ref to common subexpression number
        FLswitch,       // ref to offset of switch data block
        FLfltreg,       // ref to floating reg on stack, int contains offset
        FLoffset,       // offset (a variation on constant, needed so we
                        // can add offsets (different meaning for FLconst))
        FLdatseg,       // ref to data segment offset
        FLctor,         // constructed object
        FLdtor,         // destructed object
        FLregsave,      // ref to saved register on stack, int contains offset
#if TX86
        FLndp,          // saved 8087 register
        FLfardata,      // ref to far data segment
        FLlocalsize,    // replaced with # of locals in the stack frame
        FLcsdata,       // ref to code segment variable
        FLtlsdata,      // thread local storage
        FLbprel,        // ref to variable at fixed offset from frame pointer
        FLframehandler, // ref to C++ frame handler for NT EH
        FLasm,          // (code) an ASM code
        FLblockoff,     // address of block
        FLallocatmp,    // temp for built-in alloca()
        FLstack,        // offset from ESP rather than EBP
        FLdsymbol,      // it's a Dsymbol
#if TARGET_LINUX || TARGET_OSX || TARGET_FREEBSD || TARGET_SOLARIS
        // Change this, update debug.c too
        FLgot,          // global offset table entry outside this object file
        FLgotoff,       // global offset table entry inside this object file
        //FLoncedata,   // link once data
        //FLoncecode,   // link once code
#endif
#else
        TARGET_enumFL
#endif
        FLMAX
};

#if TX86
////////// Srcfiles

// Collect information about a source file.
typedef struct Sfile
{
#ifdef DEBUG
    unsigned short      id;
#define IDsfile (('f' << 8) | 's')
#define sfile_debug(sf) assert((sf)->id == IDsfile)
#else
#define sfile_debug(sf)
#endif

    char     *SFname;           // name of file
    unsigned  SFflags;
        #define SFonce    0x01      // file is to be #include'd only once
        #define SFhx      0x02      // file is in an HX file and has not been loaded
        #define SFtop     0x04      // file is a top level source file
        #define SFloaded  0x08      // read from PH file
    list_t    SFfillist;        // file pointers of Sfile's that this Sfile is
                                //     dependent on (i.e. they were #include'd).
                                //     Does not include nested #include's
    macro_t  *SFmacdefs;        // threaded list of macros #defined by this file
    macro_t **SFpmacdefs;       // end of macdefs list
    Symbol   *SFsymdefs;        // threaded list of global symbols declared by this file
    symlist_t SFcomdefs;        // comdefs defined in PH
    symlist_t SFtemp_ft;        // template_ftlist
    symlist_t SFtemp_class;     // template_class_list
    Symbol   *SFtagsymdefs;     // list of tag names (C only)
    unsigned SFhashval;         // hash of file name
} Sfile;

// Source files are referred to by a pointer into pfiles[]. This is so that
// when PH files are hydrated, only pfiles[] needs updating. Of course, this
// means that pfiles[] cannot be reallocated to larger numbers, its size is
// fixed at SRCFILES_MAX.

typedef struct Srcfiles
{
//  Sfile *arr;         // array of Sfiles
    Sfile **pfiles;     // parallel array of pointers into arr[]
    #define SRCFILES_MAX (2*512)
    unsigned dim;       // dimension of array
    unsigned idx;       // # used in array
} Srcfiles;

#define sfile(fi)               (*srcfiles.pfiles[fi])
#define srcfiles_name(fi)       (sfile(fi).SFname)

/**************************************************
 * This is to support compiling expressions within the context of a function.
 */

struct EEcontext
{
    unsigned EElinnum;          // line number to insert expression
    char *EEexpr;               // expression
    char *EEtypedef;            // typedef identifier
    char EEpending;             // !=0 means we haven't compiled it yet
    char EEimminent;            // we've installed it in the source text
    char EEcompile;             // we're compiling for the EE expression
    char EEin;                  // we are parsing an EE expression
    elem *EEelem;               // compiled version of EEexpr
    Symbol *EEfunc;             // function expression is in
    code *EEcode;               // generated code
};

extern EEcontext eecontext;
#endif

#if !TX86
////////// Filenames

typedef struct Filename
{
    char **arr;                         // array of filenames
    unsigned dim;                       // dimension of array
    unsigned idx;                       // # used in array
} Filename;

//
// NOTE: In order to save the full settings of all of the options,
// the following will need to be saved:
//
// config
// PCrel_option
// tysize[TYldouble]
// war_to_msg_enable[]  - Array of warnings that are enabled/disabled 0 = enabled, 1 = disabled

struct SAVED_OPTIONS
{
        struct Config config;
#if TARGET_68K
        short PCrel_option;
#endif
        mftype mfoptim;
        signed char tysizeTYldouble;
        unsigned char war_to_msg_enable[40];    // Assumes that the max warning number is 40
        struct SAVED_OPTIONS *psoNext;
};
#endif

#include "rtlsym.h"

#undef SYMBOL_Z
#define SYMBOL_Z(e,fl,saved,n,flags,ty)         RTLSYM_##e,

enum
{
    RTLSYMS

    RTLSYM_MAX
};

extern Symbol *rtlsym[RTLSYM_MAX];

// Different goals for el_optimize()
#define GOALnone        0       // evaluate for side effects only
#define GOALvalue       1       // evaluate for value
#define GOALflags       2       // evaluate for flags
#define GOALagain       4
#define GOALstruct      8
#define GOALhandle      0x10    // don't replace handle'd objects

/* Globals returned by declar() */
struct Declar
{
    Classsym *class_sym;
    Nspacesym *namespace_sym;
    int oper;
    bool constructor;
    bool destructor;
    bool invariant;
    param_t *ptal;
    bool explicitSpecialization;
    int hasExcSpec;             // has exception specification
};

extern Declar gdeclar;

#endif
