ghc/interpreter/storage.h

   1
   2 /* --------------------------------------------------------------------------
   3  * Defines storage datatypes: Text, Name, Module, Tycon, Cell, List, Pair,
   4  * Triple, ...
   5  *
   6  * The Hugs 98 system is Copyright (c) Mark P Jones, Alastair Reid, the
   7  * Yale Haskell Group, and the Oregon Graduate Institute of Science and
   8  * Technology, 1994-1999, All rights reserved.  It is distributed as
   9  * free software under the license in the file "License", which is
  10  * included in the distribution.
  11  *
  12  * $RCSfile: storage.h,v $
  13  * $Revision: 1.42 $
  14  * $Date: 2000/04/07 16:25:20 $
  15  * ------------------------------------------------------------------------*/
  16
  17 #define DEBUG_STORAGE               /* a moderate level of sanity checking */
  18 #define DEBUG_STORAGE_EXTRA         /* max paranoia in sanity checks       */
  19
  20 /* --------------------------------------------------------------------------
  21  * Typedefs for main data types:
  22  * Many of these type names are used to indicate the intended us of a data
  23  * item, rather than for type checking purposes.  Sadly (although sometimes,
  24  * fortunately), the C compiler cannot distinguish between the use of two
  25  * different names defined to be synonyms for the same types.
  26  * ------------------------------------------------------------------------*/
  27
  28 typedef Int          Text;                       /* text string            */
  29 typedef Unsigned     Syntax;                     /* syntax (assoc,preced)  */
  30 typedef Int          Cell;                       /* general cell value     */
  31 typedef Cell far     *Heap;                      /* storage of heap        */
  32 typedef Cell         Pair;                       /* pair cell              */
  33 typedef Int          StackPtr;                   /* stack pointer          */
  34 typedef Cell         Offset;                     /* offset/generic variable*/
  35 typedef Int          Module;                     /* module                 */
  36 typedef Cell         Tycon;                      /* type constructor       */
  37 typedef Cell         Type;                       /* type expression        */
  38 typedef Cell         Kind;                       /* kind expression        */
  39 typedef Cell         Kinds;                      /* list of kinds          */
  40 typedef Cell         Constr;                     /* constructor expression */
  41 typedef Cell         Name;                       /* named value            */
  42 typedef Cell         Class;                      /* type class             */
  43 typedef Cell         Inst;                       /* instance of type class */
  44 typedef Cell         Triple;                     /* triple of cell values  */
  45 typedef Cell         List;                       /* list of cells          */
  46 typedef Cell         Bignum;                     /* bignum integer         */
  47 typedef Cell         Float;                      /* floating pt literal    */
  48 #if TREX
  49 typedef Cell         Ext;                        /* extension label        */
  50 #endif
  51
  52 typedef Cell         ConId;
  53 typedef Cell         VarId;
  54 typedef Cell         QualId;
  55 typedef Cell         ConVarId;
  56
  57 /* --------------------------------------------------------------------------
  58  * Address ranges.
  59  *
  60  * -heapSize .. -1                                    cells in the heap
  61  * 0                                                  NIL
  62  *
  63  * TAG_NONPTR_MIN(100) .. TAG_NONPTR_MAX(115)         non pointer tags
  64  * TAG_PTR_MIN(200)    .. TAG_PTR_MAX(298)            pointer tags
  65  * TAG_SPEC_MIN(400)   .. TAG_SPEC_MAX(431)           special tags
  66  * OFF_MIN(1,000)      .. OFF_MAX(1,999)              offsets
  67  * CHARR_MIN(3,000)    .. CHARR_MAX(3,255)            chars
  68  *
  69  * SMALL_INT_MIN(100,000) .. SMALL_INT_MAX(499,999)   smallish ints
  70  *              (300,000 denotes 0)
  71  *
  72  * NAME_BASE_ADDR   (1,000,000 .. 1,899,999)          names
  73  * TYCON_BASE_ADDR  (2,000,000 .. 2,899,999)          tycons
  74  * CCLASS_BASE_ADDR (3,000,000 .. 3,899,999)          classes
  75  * INST_BASE_ADDR   (4,000,000 .. 4,899,999)          instances
  76  * MODULE_BASE_ADDR (5,000,000 .. 5,899,999)          modules
  77  * INVAR_BASE_ADDR  (6,000,000 .. 6,899,999)          invented var names
  78  * INDVAR_BASE_ADDR (7,000,000 .. 7,899,999)          invented dict var names
  79  * TEXT_BASE_ADDR   (8,000,000 .. 8M +TEXT_SIZE-1)    text
  80  * ------------------------------------------------------------------------*/
  81
  82 /* --------------------------------------------------------------------------
  83  * Text storage:
  84  * provides storage for the characters making up identifier and symbol
  85  * names, string literals, character constants etc...
  86  * ------------------------------------------------------------------------*/
  87
  88 extern  String       textToStr            ( Text );
  89 extern  Text         findText             ( String );
  90 extern  Text         inventText           ( Void );
  91 extern  Text         inventDictText       ( Void );
  92 extern  Bool         inventedText         ( Text );
  93 extern  Text         enZcodeThenFindText  ( String );
  94 extern  Text         unZcodeThenFindText  ( String );
  95
  96 /* Variants of textToStr and syntaxOf which work for idents, ops whether
  97  * qualified or unqualified.
  98  */
  99 extern  String       identToStr         ( Cell );
 100 extern  Text         fixLitText         ( Text );
 101 extern  Syntax       identSyntax        ( Cell );
 102 extern  Syntax       defaultSyntax      ( Text );
 103
 104 #define INVAR_BASE_ADDR  6000000
 105 #define INVAR_MAX_AVAIL  900000
 106 #define isInventedVar(c) (INVAR_BASE_ADDR<=(c) \
 107                           && (c)<INVAR_BASE_ADDR+INVAR_MAX_AVAIL)
 108
 109 #define INDVAR_BASE_ADDR 7000000
 110 #define INDVAR_MAX_AVAIL 900000
 111 #define isInventedDictVar(c) (INDVAR_BASE_ADDR<=(c) \
 112                               && (c)<INDVAR_BASE_ADDR+INDVAR_MAX_AVAIL)
 113
 114 #define TEXT_BASE_ADDR   8000000
 115 #define isText(c) (TEXT_BASE_ADDR<=(c) \
 116                   && (c)<TEXT_BASE_ADDR+TEXT_SIZE)
 117
 118 /* --------------------------------------------------------------------------
 119  * Specification of syntax (i.e. default written form of application)
 120  * ------------------------------------------------------------------------*/
 121
 122 #define MIN_PREC  0                    /* weakest binding operator         */
 123 #define MAX_PREC  9                    /* strongest binding operator       */
 124 #define FUN_PREC  (MAX_PREC+2)         /* binding of function symbols      */
 125 #define DEF_PREC  MAX_PREC
 126 #define APPLIC    0                    /* written applicatively            */
 127 #define LEFT_ASS  1                    /* left associative infix           */
 128 #define RIGHT_ASS 2                    /* right associative infix          */
 129 #define NON_ASS   3                    /* non associative infix            */
 130 #define DEF_ASS   LEFT_ASS
 131
 132 #define UMINUS_PREC  6                  /* Change these settings at your   */
 133 #define UMINUS_ASSOC LEFT_ASS           /* own risk; they may not work!    */
 134
 135 #define assocOf(x)      ((x)&NON_ASS)
 136 #define precOf(x)       ((x)>>2)
 137 #define mkSyntax(a,p)   ((a)|((p)<<2))
 138 #define DEF_OPSYNTAX    mkSyntax(DEF_ASS,DEF_PREC)
 139 #define NO_SYNTAX       (-1)
 140
 141 extern  Void   addSyntax  ( Int,Text,Syntax );
 142 extern  Syntax syntaxOf   ( Text );
 143
 144 /* --------------------------------------------------------------------------
 145  * Heap storage:
 146  * Provides a garbage collectable heap for storage of expressions etc.
 147  * ------------------------------------------------------------------------*/
 148
 149 #define heapAlloc(s) (Heap)(farCalloc(s,sizeof(Cell)))
 150 extern  Int          heapSize;
 151 extern  Heap         heapFst, heapSnd;
 152 extern  Heap         heapTopFst;
 153 extern  Heap         heapTopSnd;
 154 extern  Bool         consGC;            /* Set to FALSE to turn off gc from*/
 155                                         /* C stack; use with extreme care! */
 156 extern  Int          cellsRecovered;    /* cells recovered by last gc      */
 157
 158 #define fst(c)       heapTopFst[c]
 159 #define snd(c)       heapTopSnd[c]
 160
 161 extern  Pair         pair            ( Cell,Cell );
 162 extern  Void         garbageCollect  ( Void );
 163 extern  Void         mark            ( Cell );
 164
 165 #define isPair(c)    ((c)<0)
 166 #define isGenPair(c) ((c)<0 && -heapSize<=(c))
 167
 168 extern  Cell         whatIs    ( Cell );
 169
 170 /* --------------------------------------------------------------------------
 171  * Pairs in the heap fall into three categories.
 172  *
 173  * pair(TAG_NONPTR,y)
 174  *    used to denote that the second element of the pair is to be treated
 175  *    in some special way (eg is a integer or Text), and specifically is not
 176  *    a heap pointer
 177  *
 178  * pair(TAG_PTR,y)
 179  *    to indicate that the second element of the pair is a normal
 180  *    heap pointer, which should be followed at GC time
 181  *
 182  * pair(x,y)
 183  *    is a genuine pair, where both components are heap pointers.
 184  * ------------------------------------------------------------------------*/
 185
 186 #if !defined(SIZEOF_VOID_P) || !defined(SIZEOF_INT)
 187 #error SIZEOF_VOID_P or SIZEOF_INT is not defined
 188 #endif
 189
 190 #define isTagNonPtr(c) (TAG_NONPTR_MIN<=(c) && (c)<=TAG_NONPTR_MAX)
 191 #define isTagPtr(c)    (TAG_PTR_MIN<=(c) && (c)<=TAG_PTR_MAX)
 192 #define isTag(c)       (isTagNonPtr(c) || isTagPtr(c))
 193
 194 /* --------------------------------------------------------------------------
 195  * Tags for non-pointer cells.
 196  * ------------------------------------------------------------------------*/
 197
 198 #define TAG_NONPTR_MIN 100
 199 #define TAG_NONPTR_MAX 115
 200
 201 #define FREECELL     100          /* Free list cell:          snd :: Cell  */
 202 #define VARIDCELL    101          /* Identifier variable:     snd :: Text  */
 203 #define VAROPCELL    102          /* Operator variable:       snd :: Text  */
 204 #define DICTVAR      103          /* Dictionary variable:     snd :: Text  */
 205 #define CONIDCELL    104          /* Identifier constructor:  snd :: Text  */
 206 #define CONOPCELL    105          /* Operator constructor:    snd :: Text  */
 207 #define STRCELL      106          /* String literal:          snd :: Text  */
 208 #define INTCELL      107          /* Int literal:             snd :: Int   */
 209 #define ADDPAT       108          /* (_+k) pattern discr:     snd :: Int   */
 210 #define FLOATCELL    109          /* Floating Pt literal:     snd :: Text  */
 211 #define BIGCELL      110          /* Integer literal:         snd :: Text  */
 212 #define PTRCELL      111          /* C Heap Pointer           snd :: Ptr   */
 213 #define CPTRCELL     112          /* Native code pointer      snd :: Ptr   */
 214
 215 #if IPARAM
 216 #define IPCELL       113          /* Imp Param Cell:          snd :: Text  */
 217 #define IPVAR        114          /* ?x:                      snd :: Text  */
 218 #endif
 219
 220 #if TREX
 221 #define EXTCOPY      115          /* Copy of an Ext:          snd :: Text  */
 222 #endif
 223
 224 #define qmodOf(c)       (textOf(fst(snd(c))))    /* c ::  QUALIDENT        */
 225 #define qtextOf(c)      (textOf(snd(snd(c))))    /* c ::  QUALIDENT        */
 226 #define mkVar(t)        ap(VARIDCELL,t)
 227 #define mkVarop(t)      ap(VAROPCELL,t)
 228 #define mkCon(t)        ap(CONIDCELL,t)
 229 #define mkConop(t)      ap(CONOPCELL,t)
 230 #define mkQVar(m,t)     ap(QUALIDENT,pair(mkCon(m),mkVar(t)))
 231 #define mkQCon(m,t)     ap(QUALIDENT,pair(mkCon(m),mkCon(t)))
 232 #define mkQVarOp(m,t)   ap(QUALIDENT,pair(mkCon(m),mkVarop(t)))
 233 #define mkQConOp(m,t)   ap(QUALIDENT,pair(mkCon(m),mkConop(t)))
 234 #define mkQualId(m,t)   ap(QUALIDENT,pair(m,t))
 235 #define intValOf(c)     (snd(c))
 236 #define inventVar()     mkVar(inventText())
 237 #define mkDictVar(t)    ap(DICTVAR,t)
 238 #define inventDictVar() mkDictVar(inventDictText())
 239 #define mkStr(t)        ap(STRCELL,t)
 240 #if IPARAM
 241 #define mkIParam(c)     ap(IPCELL,snd(c))
 242 #define isIP(p)         (whatIs(p) == IPCELL)
 243 #define ipMatch(pi, t)  (isIP(fun(pi)) && textOf(fun(pi)) == t)
 244 #define ipVar(pi)       textOf(fun(pi))
 245 #else
 246 #define isIP(p)         FALSE
 247 #endif
 248
 249 extern  Bool            isVar        ( Cell );
 250 extern  Bool            isCon        ( Cell );
 251 extern  Bool            isQVar       ( Cell );
 252 extern  Bool            isQCon       ( Cell );
 253 extern  Bool            isQualIdent  ( Cell );
 254 extern  Bool            eqQualIdent  ( QualId c1, QualId c2 );
 255 extern  Bool            isIdent      ( Cell );
 256 extern  String          stringNegate ( String );
 257 extern  Text            textOf       ( Cell );
 258
 259 #define isFloat(c)       (isPair(c) && fst(c)==FLOATCELL)
 260 #define stringToFloat(s) pair(FLOATCELL,findText(s))
 261 #define floatToString(f) textToStr(snd(f))
 262 #define floatOf(f)       atof(floatToString(f))
 263 #define mkFloat(f)       (f)  /* ToDo: is this right? */
 264 #define floatNegate(f)   stringToFloat(stringNegate(floatToString(f)))
 265
 266 #define stringToBignum(s) pair(BIGCELL,findText(s))
 267 #define bignumToString(b) textToStr(snd(b))
 268
 269 #define isPtr(c)        (isPair(c) && fst(c)==PTRCELL)
 270 extern  Cell            mkPtr           ( Ptr );
 271 extern  Ptr             ptrOf           ( Cell );
 272 #define isCPtr(c)       (isPair(c) && fst(c)==CPTRCELL)
 273 extern  Cell            mkCPtr          ( Ptr );
 274 extern  Ptr             cptrOf          ( Cell );
 275
 276 /* --------------------------------------------------------------------------
 277  * Tags for pointer cells.
 278  * ------------------------------------------------------------------------*/
 279
 280 #define TAG_PTR_MIN 200
 281 #define TAG_PTR_MAX 298
 282
 283 #define LETREC       200          /* LETREC     snd :: ([Decl],Exp)        */
 284 #define COND         201          /* COND       snd :: (Exp,Exp,Exp)       */
 285 #define LAMBDA       202          /* LAMBDA     snd :: Alt                 */
 286 #define FINLIST      203          /* FINLIST    snd :: [Exp]               */
 287 #define DOCOMP       204          /* DOCOMP     snd :: (Exp,[Qual])        */
 288 #define BANG         205          /* BANG       snd :: Type                */
 289 #define COMP         206          /* COMP       snd :: (Exp,[Qual])        */
 290 #define ASPAT        207          /* ASPAT      snd :: (Var,Exp)           */
 291 #define ESIGN        208          /* ESIGN      snd :: (Exp,Type)          */
 292 #define RSIGN        209          /* RSIGN      snd :: (Rhs,Type)          */
 293 #define CASE         210          /* CASE       snd :: (Exp,[Alt])         */
 294 #define NUMCASE      211          /* NUMCASE    snd :: (Exp,Disc,Rhs)      */
 295 #define FATBAR       212          /* FATBAR     snd :: (Exp,Exp)           */
 296 #define LAZYPAT      213          /* LAZYPAT    snd :: Exp                 */
 297 #define DERIVE       214          /* DERIVE     snd :: Cell                */
 298 #define BOOLQUAL     215          /* BOOLQUAL   snd :: Exp                 */
 299 #define QWHERE       216          /* QWHERE     snd :: [Decl]              */
 300 #define FROMQUAL     217          /* FROMQUAL   snd :: (Exp,Exp)           */
 301 #define DOQUAL       218          /* DOQUAL     snd :: Exp                 */
 302 #define MONADCOMP    219          /* MONADCOMP  snd :: ((m,m0),(Exp,[Qual])*/
 303 #define GUARDED      220          /* GUARDED    snd :: [guarded exprs]     */
 304 #define ARRAY        221          /* Array      snd :: (Bounds,[Values])   */
 305 #define MUTVAR       222          /* Mutvar     snd :: Cell                */
 306 #define HUGSOBJECT   223          /* HUGSOBJECT snd :: Cell                */
 307
 308 #if IPARAM
 309 #define WITHEXP      224          /* WITHEXP    snd :: [(Var,Exp)]         */
 310 #endif
 311
 312 #define POLYTYPE     225          /* POLYTYPE   snd :: (Kind,Type)         */
 313 #define QUAL         226          /* QUAL       snd :: ([Classes],Type)    */
 314 #define RANK2        227          /* RANK2      snd :: (Int,Type)          */
 315 #define EXIST        228          /* EXIST      snd :: (Int,Type)          */
 316 #define POLYREC      229          /* POLYREC    snd :: (Int,Type)          */
 317 #define BIGLAM       230          /* BIGLAM     snd :: (vars,patterns)     */
 318 #define CDICTS       231          /* CDICTS     snd :: ([Pred],Type)       */
 319
 320 #define LABC         232          /* LABC       snd :: (con,[(Vars,Type)]) */
 321 #define CONFLDS      233          /* CONFLDS    snd :: (con,[Field])       */
 322 #define UPDFLDS      234          /* UPDFLDS    snd :: (Exp,[con],[Field]) */
 323 #if TREX
 324 #define RECORD       235          /* RECORD     snd :: [Val]               */
 325 #define EXTCASE      236          /* EXTCASE    snd :: (Exp,Disc,Rhs)      */
 326 #define RECSEL       237          /* RECSEL     snd :: Ext                 */
 327 #endif
 328 #define IMPDEPS      238          /* IMPDEPS    snd :: [Binding]           */
 329
 330 #define QUALIDENT    239          /* Qualified identifier  snd :: (Id,Id)  */
 331 #define HIDDEN       240          /* hiding import list    snd :: [Entity] */
 332 #define MODULEENT    241          /* module in export list snd :: con      */
 333
 334 #define INFIX        242          /* INFIX      snd :: (see tidyInfix)     */
 335 #define ONLY         243          /* ONLY       snd :: Exp                 */
 336 #define NEG          244          /* NEG        snd :: Exp                 */
 337
 338 /* Used when parsing GHC interface files */
 339 #define DICTAP       245          /* DICTAP     snd :: (QClassId,[Type])   */
 340 #define UNBOXEDTUP   246          /* UNBOXEDTUP snd :: [Type]              */
 341
 342 #if SIZEOF_VOID_P != SIZEOF_INT
 343 #define PTRCELL      247          /* C Heap Pointer snd :: (Int,Int)       */
 344 #endif
 345
 346 /* STG syntax */
 347 #define STGVAR       248          /* STGVAR     snd :: (StgRhs,info)       */
 348 #define STGAPP       249          /* STGAPP     snd :: (StgVar,[Arg])      */
 349 #define STGPRIM      250          /* STGPRIM    snd :: (PrimOp,[Arg])      */
 350 #define STGCON       251          /* STGCON     snd :: (StgCon,[Arg])      */
 351 #define PRIMCASE     252          /* PRIMCASE   snd :: (Expr,[PrimAlt])    */
 352 #define DEEFALT      253          /* DEEFALT    snd :: (Var,Expr)          */
 353 #define CASEALT      254          /* CASEALT    snd :: (Con,[Var],Expr)    */
 354 #define PRIMALT      255          /* PRIMALT    snd :: ([Var],Expr)        */
 355
 356 /* Module groups */
 357 #define GRP_REC      256          /* GRP_REC    snd :: [CONID]             */
 358 #define GRP_NONREC   257          /* GRP_NONREC snd :: CONID               */
 359
 360
 361 /*
 362    Top-level interface entities
 363    type Line             = Int  -- a line number
 364    type ConVarId         = CONIDCELL | VARIDCELL
 365    type ExportListEntry  = ConVarId | (ConId, [ConVarId])
 366    type Associativity    = mkInt of LEFT_ASS | RIGHT_ASS | NON_ASS
 367    type Constr           = ((ConId, [((Type,VarId,Int))]))
 368                ((constr name, [((type, field name if any, strictness))]))
 369                strictness: 0 => none, 1 => !, 2 => !! (unpacked)
 370    All 2/3/4/5 tuples in the interface abstract syntax are done with
 371    z-tuples.
 372 */
 373
 374 #define I_INTERFACE  260  /* snd :: ((ConId, [I_IMPORT..I_VALUE]))
 375                                     interface name, list of iface entities */
 376
 377 #define I_IMPORT     261  /* snd :: ((ConId, [ConVarId]))
 378                                     module name, list of entities          */
 379
 380 #define I_INSTIMPORT 262  /* snd :: NIL    -- not used at present          */
 381
 382 #define I_EXPORT     263  /* snd :: ((ConId, [ExportListEntry]))
 383                                     this module name?, entities to export  */
 384
 385 #define I_FIXDECL    264  /* snd :: ((NIL|Int, Associativity, ConVarId))
 386                                     fixity, associativity, name            */
 387
 388 #define I_INSTANCE   265 /* snd :: ((Line,
 389                                      [((VarId,Kind))],
 390                                      Type, VarId, Inst))
 391                    lineno,
 392                    forall-y bit (eg __forall [a b] =>),
 393                    other bit, eg { C a1 } -> { C2 a2 } -> ... -> { Cn an },
 394                    name of dictionary builder,
 395                    (after startGHCInstance) the instance table location    */
 396
 397 #define I_TYPE       266 /* snd :: ((Line, ConId, [((VarId,Kind))], Type))
 398                             lineno, tycon, kinded tyvars, the type expr    */
 399
 400 #define I_DATA       267 /* snd :: ((Line, [((QConId,VarId))], ConId,
 401                                           [((VarId,Kind))], [Constr])
 402                             lineno, context, tycon, kinded tyvars, constrs
 403                            An empty constr list means exported abstractly. */
 404
 405 #define I_NEWTYPE    268 /* snd :: ((Line, [((QConId,VarId))], ConId,
 406                                     [((VarId,Kind))], ((ConId,Type)) ))
 407                              lineno, context, tycon, kinded tyvars, constr
 408                                     constr==NIL means exported abstractly. */
 409
 410 #define I_CLASS      269 /* snd :: ((Line, [((QConId,VarId))], ConId,
 411                                     [((VarId,Kind))], [((VarId,Type))]))
 412                             lineno, context, classname,
 413                                       kinded tyvars, method sigs           */
 414
 415 #define I_VALUE      270 /* snd :: ((Line, VarId, Type))                   */
 416
 417 /*
 418    Top-level module entities.
 419
 420    type Export = ?
 421 */
 422 #define M_MODULE     280 /* snd :: ((ConId, [Export],
 423                                      M_IMPORT_Q .. M_VALUE]))
 424                             module name, export spec, top level entities   */
 425
 426 #define M_IMPORT_Q   281 /* snd :: ((?,?)) */
 427 #define M_IMPORT_UNQ 282 /* snd :: ((?,?)) */
 428 #define M_TYCON      283 /* snd :: ((Line,?,?,?)) */
 429 #define M_CLASS      284 /* snd :: ((Line,?,?,?)) */
 430 #define M_INST       285 /* snd :: ((Line,?,?)) */
 431 #define M_DEFAULT    286 /* snd :: ((Line,?)) */
 432 #define M_FOREIGN_EX 289 /* snd :: ((Line,?,?,?,?)) */
 433 #define M_FOREIGN_IM 290 /* snd :: ((Line,?,?,?,?)) */
 434 #define M_VALUE      291 /* snd :: ? */
 435
 436
 437
 438
 439 /*
 440    Tagged tuples.
 441 */
 442 #define ZTUP2        295          /* snd :: (Cell,Cell)                    */
 443 #define ZTUP3        296          /* snd :: (Cell,(Cell,Cell))             */
 444 #define ZTUP4        297          /* snd :: (Cell,(Cell,(Cell,Cell)))      */
 445 #define ZTUP5        298       /* snd :: (Cell,(Cell,(Cell,(Cell,Cell))))  */
 446
 447
 448
 449 /* --------------------------------------------------------------------------
 450  * Special cell values.
 451  * ------------------------------------------------------------------------*/
 452
 453 #define TAG_SPEC_MIN 400
 454 #define TAG_SPEC_MAX 431
 455
 456 #define isSpec(c) (TAG_SPEC_MIN<=(c) && (c)<=TAG_SPEC_MAX)
 457
 458 #define NONE         400          /* Dummy stub                            */
 459 #define STAR         401          /* Representing the kind of types        */
 460 #if TREX
 461 #define ROW          402          /* Representing the kind of rows         */
 462 #endif
 463 #define WILDCARD     403          /* Wildcard pattern                      */
 464 #define SKOLEM       404          /* Skolem constant                       */
 465
 466 #define DOTDOT       405          /* ".." in import/export list            */
 467
 468 #define NAME         406          /* whatIs code for isName                */
 469 #define TYCON        407          /* whatIs code for isTycon               */
 470 #define CLASS        408          /* whatIs code for isClass               */
 471 #define MODULE       409          /* whatIs code for isModule              */
 472 #define INSTANCE     410          /* whatIs code for isInst                */
 473 #define TUPLE        411          /* whatIs code for tuple constructor     */
 474 #define OFFSET       412          /* whatis code for offset                */
 475 #define AP           413          /* whatIs code for application node      */
 476 #define CHARCELL     414          /* whatIs code for isChar                */
 477 #if TREX
 478 #define EXT          415          /* whatIs code for isExt                 */
 479 #endif
 480
 481 #define SIGDECL      416          /* Signature declaration                 */
 482 #define FIXDECL      417          /* Fixity declaration                    */
 483 #define FUNBIND      418          /* Function binding                      */
 484 #define PATBIND      419          /* Pattern binding                       */
 485
 486 #define DATATYPE     420          /* Datatype type constructor             */
 487 #define NEWTYPE      421          /* Newtype type constructor              */
 488 #define SYNONYM      422          /* Synonym type constructor              */
 489 #define RESTRICTSYN  423          /* Synonym with restricted scope         */
 490
 491 #define NODEPENDS    424          /* Stop calculation of deps in type check*/
 492 #define PREDEFINED   425          /* Predefined name, not yet filled       */
 493 #define TEXTCELL     426          /* whatIs code for isText                */
 494 #define INVAR        427          /* whatIs code for isInventedVar         */
 495 #define INDVAR       428          /* whatIs code for isInventedDictVar     */
 496
 497 #define FM_SOURCE    429          /* denotes source module (FileMode)      */
 498 #define FM_OBJECT    430          /* denotes object module                 */
 499 #define FM_EITHER    431          /* no restriction; either is allowed     */
 500
 501
 502 /* --------------------------------------------------------------------------
 503  * Tuple data/type constructors:
 504  * ------------------------------------------------------------------------*/
 505
 506 extern Text ghcTupleText    ( Tycon );
 507 extern Text ghcTupleText_n  ( Int );
 508
 509
 510
 511 #if TREX
 512 #error TREX not supported
 513 #define EXTMIN       301
 514 #define isExt(c)     (EXTMIN<=(c) && (c)<OFFMIN)
 515 #define extText(e)   tabExt[(e)-EXTMIN]
 516 #define extField(c)  arg(fun(c))
 517 #define extRow(c)    arg(c)
 518
 519 extern Text          DECTABLE(tabExt);
 520 extern Ext           mkExt ( Text );
 521 #else
 522 #define mkExt(t) NIL
 523 #endif
 524
 525 extern Module        findFakeModule ( Text t );
 526 extern Tycon         addTupleTycon ( Int n );
 527 extern Name          addWiredInBoxingTycon
 528                         ( String modNm, String typeNm, String constrNm,
 529                           Int rep, Kind kind );
 530 extern Tycon         addWiredInEnumTycon
 531                         ( String modNm, String typeNm,
 532                           List /*of Text*/ constrs );
 533
 534 /* --------------------------------------------------------------------------
 535  * Offsets: (generic types/stack offsets)
 536  * ------------------------------------------------------------------------*/
 537
 538 #define OFF_MIN 1000
 539 #define OFF_MAX 1999
 540
 541 #define isOffset(c)  (OFF_MIN<=(c) && (c)<=OFF_MAX)
 542 #define offsetOf(c)  ((c)-OFF_MIN)
 543 #define mkOffset(o)  (OFF_MIN+(o))
 544
 545
 546 /* --------------------------------------------------------------------------
 547  * Modules:
 548  * ------------------------------------------------------------------------*/
 549
 550 #define MODULE_BASE_ADDR     5000000
 551 #define MODULE_MAX_SIZE      900000
 552 #define MODULE_INIT_SIZE     4
 553
 554 #ifdef DEBUG_STORAGE
 555 extern struct strModule* generate_module_ref ( Cell );
 556 #define module(mod)  (*generate_module_ref(mod))
 557 #else
 558 #define module(mod)   tabModule[(mod)-MODULE_BASE_ADDR]
 559 #endif
 560
 561 #define mkModule(n)   (MODULE_BASE_ADDR+(n))
 562 #define isModule(c)   (MODULE_BASE_ADDR<=(c)                  \
 563                        && (c)<MODULE_BASE_ADDR+tabModuleSz    \
 564                        && tabModule[(c)-MODULE_BASE_ADDR].inUse)
 565
 566
 567 /* Import defns for the ObjectCode struct in Module. */
 568 #include "object.h"
 569
 570 /* Import a machine-dependent definition of Time, for module timestamps. */
 571 #include "machdep_time.h"
 572
 573 /* Under Haskell 1.3, the list of qualified imports is always a subset
 574  * of the list of unqualified imports.  For simplicity and flexibility,
 575  * we do not attempt to exploit this fact - when a module is imported
 576  * unqualified, it is added to both the qualified and unqualified
 577  * import lists.
 578  * Similarily, Haskell 1.3 does not allow a constructor to be imported
 579  * or exported without exporting the type it belongs to but the export
 580  * list is just a flat list of Texts (before static analysis) or
 581  * Tycons, Names and Classes (after static analysis).
 582  */
 583 struct strModule {
 584    Bool   inUse;
 585    Name   nextFree;
 586
 587    Text   text;        /* Name of this module                              */
 588
 589    List   tycons;      /* Lists of top level objects ...                   */
 590    List   names;       /* (local defns + imports)                          */
 591    List   classes;
 592    List   exports;     /* [ Entity | (Entity, NIL|DOTDOT) ]                */
 593
 594    List   qualImports; /* Qualified imports.                               */
 595
 596    Bool   fake;        /* TRUE if module exists only via GHC primop        */
 597                        /* defn; usually FALSE                              */
 598
 599    Cell   tree;        /* Parse tree for mod or iface                      */
 600    Bool   completed;   /* Fully loaded or just parsed?                     */
 601    Time   lastStamp;   /* Time of last parse                               */
 602
 603    Cell   mode;        /* FM_SOURCE or FM_OBJECT                           */
 604    Text   srcExt;      /* if mode==FM_SOURCE ".lhs", ".hs", etc            */
 605    List   uses;        /* :: [CONID] -- names of mods imported by this one */
 606
 607    Text   objName;     /* Name of the primary object code file.            */
 608    Int    objSize;     /* Size of the primary object code file.            */
 609
 610    ObjectCode* object;        /* Primary object code for this module.      */
 611    ObjectCode* objectExtras;  /* And any extras it might need.             */
 612    List   objectExtraNames;   /* :: [Text] -- names of extras              */
 613 };
 614
 615 extern struct strModule* tabModule;
 616 extern Int               tabModuleSz;
 617
 618 extern Module currentModule;           /* Module currently being processed */
 619 extern List   moduleGraph;             /* :: [GRP_REC | GRP_NONREC]        */
 620 extern List   prelModules;             /* :: [CONID]                       */
 621 extern List   targetModules;           /* :: [CONID]                       */
 622
 623
 624 extern Bool         isValidModule   ( Module );
 625 extern Module       newModule       ( Text );
 626 extern Void         nukeModule      ( Module );
 627 extern Module       findModule      ( Text );
 628 extern Module       findModid       ( Cell );
 629 extern Void         setCurrModule   ( Module );
 630
 631 extern void         addOTabName     ( Module,char*,void* );
 632 extern void*        lookupOTabName  ( Module,char* );
 633 extern char*        nameFromOPtr    ( void* );
 634
 635 extern void         addSection      ( Module,void*,void*,OSectionKind );
 636 extern OSectionKind lookupSection   ( void* );
 637 extern void*    lookupOExtraTabName                ( char* sym );
 638 extern void*    lookupOTabNameAbsolutelyEverywhere ( char* sym );
 639
 640 #define isPrelude(m) (m==modulePrelude)
 641
 642 #define N_PRELUDE_SCRIPTS (combined ? 32 : 1)
 643
 644 /* --------------------------------------------------------------------------
 645  * Type constructor names:
 646  * ------------------------------------------------------------------------*/
 647
 648 #define TYCON_BASE_ADDR   2000000
 649 #define TYCON_MAX_SIZE    900000
 650 #define TYCON_INIT_SIZE   4
 651
 652 #ifdef DEBUG_STORAGE
 653 extern struct strTycon* generate_tycon_ref ( Cell );
 654 #define tycon(tc)    (*generate_tycon_ref(tc))
 655 #else
 656 #define tycon(tc)    tabTycon[(tc)-TYCON_BASE_ADDR]
 657 #endif
 658
 659 #define isTycon(c)   (TYCON_BASE_ADDR<=(c)                        \
 660                       && (c)<TYCON_BASE_ADDR+tabTyconSz           \
 661                       && tabTycon[(c)-TYCON_BASE_ADDR].inUse      \
 662                       && tabTycon[(c)-TYCON_BASE_ADDR].tuple==-1)
 663 #define isTuple(c)   (TYCON_BASE_ADDR<=(c)                        \
 664                       && (c)<TYCON_BASE_ADDR+tabTyconSz           \
 665                       && tabTycon[(c)-TYCON_BASE_ADDR].inUse      \
 666                       && tabTycon[(c)-TYCON_BASE_ADDR].tuple>=0)
 667 #define tupleOf(n)   (tycon(n).tuple)
 668
 669 extern Tycon mkTuple ( Int );
 670
 671
 672 struct strTycon {
 673     Bool   inUse;
 674     Name   nextFree;
 675     Text   text;
 676     Int    line;
 677     Module mod;                         /* module that defines it          */
 678     Int    tuple;                      /* tuple number, or -1 if not tuple */
 679     Int    arity;
 680     Kind   kind;                        /* kind (includes arity) of Tycon  */
 681     Cell   what;                        /* DATATYPE/SYNONYM/RESTRICTSYN... */
 682     Cell   defn;
 683     Name   conToTag;                    /* used in derived code            */
 684     Name   tagToCon;
 685     void*  itbl;                       /* For tuples, the info tbl pointer */
 686     Tycon  nextTyconHash;
 687 };
 688
 689 extern struct strTycon* tabTycon;
 690 extern Int              tabTyconSz;
 691
 692 extern Tycon newTycon      ( Text );
 693 extern Tycon findTycon     ( Text );
 694 extern Tycon addTycon      ( Tycon );
 695 extern Tycon findQualTycon ( Cell );
 696 extern Tycon addPrimTycon  ( Text,Kind,Int,Cell,Cell );
 697
 698 #define isSynonym(h)    (isTycon(h) && tycon(h).what==SYNONYM)
 699 #define isQualType(t)   (isPair(t) && fst(t)==QUAL)
 700 #define mkPolyType(n,t) pair(POLYTYPE,pair(n,t))
 701 #define isPolyType(t)   (isPair(t) && fst(t)==POLYTYPE)
 702 #define isPolyOrQualType(t) (isPair(t) && (fst(t)==POLYTYPE || fst(t)==QUAL))
 703 #define polySigOf(t)    fst(snd(t))
 704 #define monotypeOf(t)   snd(snd(t))
 705 #define bang(t)         ap(BANG,t)
 706
 707 extern Tycon findQualTyconWithoutConsultingExportList ( QualId q );
 708
 709 extern Int numQualifiers   ( Type );
 710
 711
 712 /* --------------------------------------------------------------------------
 713  * Globally defined name values:
 714  * ------------------------------------------------------------------------*/
 715
 716 #define NAME_BASE_ADDR    1000000
 717 #define NAME_MAX_SIZE     900000
 718 #define NAME_INIT_SIZE    4
 719
 720 #ifdef DEBUG_STORAGE
 721 extern struct strName* generate_name_ref ( Cell );
 722 #define name(nm)    (*generate_name_ref(nm))
 723 #else
 724 #define name(nm)    tabName[(nm)-NAME_BASE_ADDR]
 725 #endif
 726
 727 #define mkName(n)   (NAME_BASE_ADDR+(n))
 728 #define isName(c)   (NAME_BASE_ADDR<=(c)                   \
 729                      && (c)<NAME_BASE_ADDR+tabNameSz       \
 730                      && tabName[(c)-NAME_BASE_ADDR].inUse)
 731
 732 struct strName {
 733     Bool   inUse;
 734     Name   nextFree;
 735     Text   text;
 736     Int    line;
 737     Module mod;                         /* module that defines it          */
 738     Syntax syntax;
 739     Cell   parent;
 740     Int    arity;
 741     Int    number;
 742     Cell   type;
 743     Cell   defn;
 744     Bool   hasStrict;          /* does constructor have strict components? */
 745     Cell   stgVar;                                      /* really StgVar   */
 746     Text   callconv;                          /* for foreign import/export */
 747     void*  primop;                                      /* really StgPrim* */
 748     void*  itbl;                 /* For constructors, the info tbl pointer */
 749     Name   nextNameHash;
 750 };
 751
 752 extern struct strName* tabName;
 753 extern Int             tabNameSz;
 754
 755 extern int numNames (  Void  );
 756
 757 /* The number field in a name is used to distinguish various kinds of name:
 758  *   mfunNo(i) = code for member function, offset i
 759  *               members that are sole elements of dict use mfunNo(0)
 760  *               members of dicts with more than one elem use mfunNo(n), n>=1
 761  *   EXECNAME  = code for executable name (bytecodes or primitive)
 762  *   SELNAME   = code for selector function
 763  *   DFUNNAME  = code for dictionary builder or selector
 764  *   cfunNo(i) = code for data constructor
 765  *               datatypes with only one constructor uses cfunNo(0)
 766  *               datatypes with multiple constructors use cfunNo(n), n>=1
 767  */
 768
 769 #define EXECNAME        0
 770 #define SELNAME         1
 771 #define DFUNNAME        2
 772 #define CFUNNAME        3
 773
 774 #define isSfun(n)       (name(n).number==SELNAME)
 775 #define isDfun(n)       (name(n).number==DFUNNAME)
 776
 777 #define isCfun(n)       (name(n).number>=CFUNNAME)
 778 #define cfunOf(n)       (name(n).number-CFUNNAME)
 779 #define cfunNo(i)       ((i)+CFUNNAME)
 780 #define hasCfun(cs)     (nonNull(cs) && isCfun(hd(cs)))
 781
 782 #define isMfun(n)       (name(n).number<0)
 783 #define mfunOf(n)       ((-1)-name(n).number)
 784 #define mfunNo(i)       ((-1)-(i))
 785
 786 extern Name   newName         ( Text,Cell );
 787 extern Name   findName        ( Text );
 788 extern Name   addName         ( Name );
 789 extern Name   findQualName    ( Cell );
 790 extern Name   addPrimCfun     ( Text,Int,Int,Cell );
 791 extern Name   addPrimCfunREP  ( Text,Int,Int,Int );
 792 extern Int    sfunPos         ( Name,Name );
 793 extern Name   nameFromStgVar  ( Cell );
 794 extern Name   jrsFindQualName ( Text,Text );
 795
 796 extern Name findQualNameWithoutConsultingExportList ( QualId q );
 797
 798 /* --------------------------------------------------------------------------
 799  * Type class values:
 800  * ------------------------------------------------------------------------*/
 801
 802 #define INST_BASE_ADDR     4000000
 803 #define INST_MAX_SIZE      900000
 804 #define INST_INIT_SIZE     4
 805
 806 #ifdef DEBUG_STORAGE
 807 extern struct strInst* generate_inst_ref ( Cell );
 808 #define inst(in)    (*generate_inst_ref(in))
 809 #else
 810 #define inst(in)    tabInst[(in)-INST_BASE_ADDR]
 811 #endif
 812
 813 #define mkInst(n)   (INST_BASE_ADDR+(n))
 814 #define instOf(c)   ((Int)((c)-INST_BASE_ADDR))
 815 #define isInst(c)   (INST_BASE_ADDR<=(c)                   \
 816                      && (c)<INST_BASE_ADDR+tabInstSz       \
 817                      && tabInst[(c)-INST_BASE_ADDR].inUse)
 818
 819 struct strInst {
 820     Bool   inUse;
 821     Name   nextFree;
 822     Class  c;                           /* class C                         */
 823     Int    line;
 824     Module mod;                         /* module that defines it          */
 825     Kinds  kinds;                       /* Kinds of variables in head      */
 826     Cell   head;                        /* :: Pred                         */
 827     List   specifics;                   /* :: [Pred]                       */
 828     Int    numSpecifics;                /* length(specifics)               */
 829     List   implements;
 830     Name   builder;                     /* Dictionary constructor function */
 831 };
 832
 833 extern struct strInst* tabInst;
 834 extern Int             tabInstSz;
 835
 836 /* a predicate (an element :: Pred) is an application of a Class to one or
 837  * more type expressions
 838  */
 839
 840 #define CCLASS_BASE_ADDR   3000000
 841 #define CCLASS_MAX_SIZE    900000
 842 #define CCLASS_INIT_SIZE   4
 843
 844 #ifdef DEBUG_STORAGE
 845 extern struct strClass* generate_cclass_ref ( Cell );
 846 #define cclass(cl)   (*generate_cclass_ref(cl))
 847 #else
 848 #define cclass(cl)   tabClass[(cl)-CCLASS_BASE_ADDR]
 849 #endif
 850
 851 #define mkClass(n)   (CCLASS_BASE_ADDR+(n))
 852 #define isClass(c)   (CCLASS_BASE_ADDR<=(c)                   \
 853                       && (c)<CCLASS_BASE_ADDR+tabClassSz      \
 854                       && tabClass[(c)-CCLASS_BASE_ADDR].inUse)
 855
 856 struct strClass {
 857     Bool   inUse;
 858     Name   nextFree;
 859     Text   text;                        /* Name of class                   */
 860     Int    line;                        /* Line where declaration begins   */
 861     Module mod;                         /* module that declares it         */
 862     Int    level;                       /* Level in class hierarchy        */
 863     Int    arity;                       /* Number of arguments             */
 864     Kinds  kinds;                       /* Kinds of constructors in class  */
 865     List   fds;                         /* Functional Dependencies         */
 866     List   xfds;                        /* Xpanded Functional Dependencies */
 867     Cell   head;                        /* Head of class                   */
 868     Name   dcon;                        /* Dictionary constructor function */
 869     List   supers;                      /* :: [Pred]                       */
 870     Int    numSupers;                   /* length(supers)                  */
 871     List   dsels;                       /* Superclass dictionary selectors */
 872     List   members;                     /* :: [Name]                       */
 873     Int    numMembers;                  /* length(members)                 */
 874     List   defaults;                    /* :: [Name]                       */
 875     List   instances;                   /* :: [Inst]                       */
 876 };
 877
 878 extern struct strClass* tabClass;
 879 extern Int              tabClassSz;
 880
 881 extern Class newClass      ( Text );
 882 extern Class findClass     ( Text );
 883 extern Class addClass      ( Class );
 884 extern Class findQualClass ( Cell );
 885 extern Inst  newInst       ( Void );
 886 extern Inst  findFirstInst ( Tycon );
 887 extern Inst  findNextInst  ( Tycon,Inst );
 888 extern List  getAllKnownTyconsAndClasses ( void );
 889 extern Class findQualClassWithoutConsultingExportList ( QualId q );
 890
 891 /* --------------------------------------------------------------------------
 892  * Character values:
 893  * ------------------------------------------------------------------------*/
 894
 895 /* I think this assumes that NUM_CHARS==256. */
 896 #define CHARR_MIN    3000
 897 #define CHARR_MAX    3255
 898 #define isChar(c)    (CHARR_MIN<=(c) && (c)<=CHARR_MAX)
 899 #define charOf(c)    ((Char)((c)-CHARR_MIN))
 900 #define mkChar(c)    (CHARR_MIN+(((Cell)(c)) & 0xFF))
 901 #define MAXCHARVAL   (NUM_CHARS-1)
 902
 903 /* --------------------------------------------------------------------------
 904  * Small Integer values:
 905  * ------------------------------------------------------------------------*/
 906
 907 #define SMALL_INT_MIN   100000
 908 #define SMALL_INT_MAX   499999
 909 #define SMALL_INT_ZERO  (1 + SMALL_INT_MIN/2 + SMALL_INT_MAX/2)
 910 #define isSmall(c)      (SMALL_INT_MIN<=(c) && (c)<=SMALL_INT_MAX)
 911 extern  Bool isInt      ( Cell );
 912 extern  Int  intOf      ( Cell );
 913 extern  Cell mkInt      ( Int );
 914
 915 /* --------------------------------------------------------------------------
 916  * Implementation of triples:
 917  * ------------------------------------------------------------------------*/
 918
 919 #define triple(x,y,z) pair(x,pair(y,z))
 920 #define fst3(c)      fst(c)
 921 #define snd3(c)      fst(snd(c))
 922 #define thd3(c)      snd(snd(c))
 923
 924 /* --------------------------------------------------------------------------
 925  * Implementation of lists:
 926  * ------------------------------------------------------------------------*/
 927
 928 #define NIL              0
 929 #define isNull(c)        ((c)==NIL)
 930 #define nonNull(c)       (c)
 931 #define cons(x,xs)       pair(x,xs)
 932 #define singleton(x)     cons(x,NIL)
 933 #define doubleton(x,y)   cons(x,cons(y,NIL))
 934 #define tripleton(x,y,z) cons(x,cons(y,cons(z,NIL)))
 935 #define hd(c)            fst(c)
 936 #define tl(c)            snd(c)
 937
 938 extern  Int          length       ( List );
 939 extern  List         appendOnto   ( List,List );    /* destructive     */
 940 extern  List         dupOnto      ( List,List );
 941 extern  List         dupList      ( List );
 942 extern  List         revOnto      ( List, List );   /* destructive     */
 943 #define rev(xs)      revOnto((xs),NIL)              /* destructive     */
 944 #define reverse(xs)  revOnto(dupList(xs),NIL)       /* non-destructive */
 945 extern  Cell         cellIsMember ( Cell,List );
 946 extern  Cell         cellAssoc    ( Cell,List );
 947 extern  Cell         cellRevAssoc ( Cell,List );
 948 extern  Bool         eqList       ( List,List );
 949 extern  Cell         varIsMember  ( Text,List );
 950 extern  Name         nameIsMember ( Text,List );
 951 extern  QualId       qualidIsMember ( QualId, List );
 952 extern  Cell         intIsMember  ( Int,List );
 953 extern  List         replicate    ( Int,Cell );
 954 extern  List         diffList     ( List,List );    /* destructive     */
 955 extern  List         deleteCell   ( List,Cell );    /* non-destructive */
 956 extern  List         take         ( Int,List );     /* destructive     */
 957 extern  List         splitAt      ( Int,List );     /* non-destructive */
 958 extern  Cell         nth          ( Int,List );
 959 extern  List         removeCell   ( Cell,List );    /* destructive     */
 960 extern  List         dupListOnto  ( List,List );    /* non-destructive */
 961 extern  List         nubList      ( List );         /* non-destructive */
 962
 963 /* The following macros provide `inline expansion' of some common ways of
 964  * traversing, using and modifying lists:
 965  *
 966  * N.B. We use the names _f, _a, _xs, Zs, in an attempt to avoid clashes
 967  *      with identifiers used elsewhere.
 968  */
 969
 970 #define mapBasic(_init,_step)           {List Zs=(_init);\
 971                                          for(;nonNull(Zs);Zs=tl(Zs))  \
 972                                          _step;}
 973 #define mapModify(_init,_step)          mapBasic(_init,hd(Zs)=_step)
 974
 975 #define mapProc(_f,_xs)                 mapBasic(_xs,_f(hd(Zs)))
 976 #define map1Proc(_f,_a,_xs)             mapBasic(_xs,_f(_a,hd(Zs)))
 977 #define map2Proc(_f,_a,_b,_xs)          mapBasic(_xs,_f(_a,_b,hd(Zs)))
 978 #define map3Proc(_f,_a,_b,_c,_xs)       mapBasic(_xs,_f(_a,_b,_c,hd(Zs)))
 979 #define map4Proc(_f,_a,_b,_c,_d,_xs)    mapBasic(_xs,_f(_a,_b,_c,_d,hd(Zs)))
 980
 981 #define mapOver(_f,_xs)                 mapModify(_xs,_f(hd(Zs)))
 982 #define map1Over(_f,_a,_xs)             mapModify(_xs,_f(_a,hd(Zs)))
 983 #define map2Over(_f,_a,_b,_xs)          mapModify(_xs,_f(_a,_b,hd(Zs)))
 984 #define map3Over(_f,_a,_b,_c,_xs)       mapModify(_xs,_f(_a,_b,_c,hd(Zs)))
 985 #define map4Over(_f,_a,_b,_c,_d,_xs)    mapModify(_xs,_f(_a,_b,_c,_d,hd(Zs)))
 986
 987 /* This is just what you want for functions with accumulating parameters */
 988 #define mapAccum(_f,_acc,_xs)           mapBasic(_xs,_acc=_f(_acc,hd(Zs)))
 989 #define map1Accum(_f,_acc,_a,_xs)       mapBasic(_xs,_acc=_f(_acc,_a,hd(Zs)))
 990 #define map2Accum(_f,_acc,_a,_b,_xs)    mapBasic(_xs,_acc=_f(_acc,_a,_b,hd(Zs)))
 991 #define map3Accum(_f,_acc,_a,_b,_c,_xs) mapBasic(_xs,_acc=_f(_acc,_a,_b,_c,hd(Zs)))
 992
 993
 994 /* --------------------------------------------------------------------------
 995  * Strongly-typed lists (z-lists) and tuples (experimental)
 996  * ------------------------------------------------------------------------*/
 997
 998 typedef Cell ZPair;
 999 typedef Cell ZTriple;
1000 typedef Cell Z4Ble;
1001 typedef Cell Z5Ble;
1002
1003 #define isZPair(c) (whatIs((c))==ZTUP2)
1004
1005 extern Cell zpair    ( Cell x1, Cell x2 );
1006 extern Cell zfst     ( Cell zpair );
1007 extern Cell zsnd     ( Cell zpair );
1008
1009 extern Cell ztriple  ( Cell x1, Cell x2, Cell x3 );
1010 extern Cell zfst3    ( Cell zpair );
1011 extern Cell zsnd3    ( Cell zpair );
1012 extern Cell zthd3    ( Cell zpair );
1013
1014 extern Cell z4ble    ( Cell x1, Cell x2, Cell x3, Cell x4 );
1015 extern Cell zsel14   ( Cell zpair );
1016 extern Cell zsel24   ( Cell zpair );
1017 extern Cell zsel34   ( Cell zpair );
1018 extern Cell zsel44   ( Cell zpair );
1019
1020 extern Cell z5ble    ( Cell x1, Cell x2, Cell x3, Cell x4, Cell x5 );
1021 extern Cell zsel15   ( Cell zpair );
1022 extern Cell zsel25   ( Cell zpair );
1023 extern Cell zsel35   ( Cell zpair );
1024 extern Cell zsel45   ( Cell zpair );
1025 extern Cell zsel55   ( Cell zpair );
1026
1027 extern Cell unap     ( int tag, Cell c );
1028
1029
1030 /* --------------------------------------------------------------------------
1031  * Implementation of function application nodes:
1032  * ------------------------------------------------------------------------*/
1033
1034 #define ap(f,x)      pair(f,x)
1035 #define ap1(f,x)     ap(f,x)
1036 #define ap2(f,x,y)   ap(ap(f,x),y)
1037 #define ap3(f,x,y,z) ap(ap(ap(f,x),y),z)
1038 #define fun(c)       fst(c)
1039 #define arg(c)       snd(c)
1040 #define isAp(c)      (isPair(c) && !isTag(fst(c)))
1041
1042 extern  Cell         getHead     ( Cell );
1043 extern  List         getArgs     ( Cell );
1044 extern  Cell         nthArg      ( Int,Cell );
1045 extern  Int          numArgs     ( Cell );
1046 extern  Cell         applyToArgs ( Cell,List );
1047 extern  Int          argCount;
1048
1049 /* --------------------------------------------------------------------------
1050  * Stack implementation:
1051  *
1052  * NB: Use of macros makes order of evaluation hard to predict.
1053  *     For example, "push(1+pop());" doesn't increment TOS.
1054  * ------------------------------------------------------------------------*/
1055
1056 extern  Cell cellStack[];
1057 extern  StackPtr sp;
1058
1059 #define clearStack() sp=(-1)
1060 #define stackEmpty() (sp==(-1))
1061 #define stack(p)     cellStack[p]
1062 #define chkStack(n)  if (sp>=NUM_STACK-(n)) hugsStackOverflow()
1063 #define push(c)      do { chkStack(1); onto(c); } while (0)
1064 #define onto(c)      stack(++sp)=(c);
1065 #define pop()        stack(sp--)
1066 #define drop()       sp--
1067 #define top()        stack(sp)
1068 #define pushed(n)    stack(sp-(n))
1069 #define topfun(f)    top()=ap((f),top())
1070 #define toparg(x)    top()=ap(top(),(x))
1071 #define getsp()      sp
1072
1073 extern  Void hugsStackOverflow ( Void );
1074
1075 #if SYMANTEC_C
1076 #include <Memory.h>
1077 #define STACK_HEADROOM 16384
1078 #define STACK_CHECK if (StackSpace() <= STACK_HEADROOM) \
1079                       internal("Macintosh function parameter stack overflow.");
1080 #else
1081 #define STACK_CHECK
1082 #endif
1083
1084 /* --------------------------------------------------------------------------
1085  * Misc:
1086  * ------------------------------------------------------------------------*/
1087
1088 extern  Void   setLastExpr          ( Cell );
1089 extern  Cell   getLastExpr          ( Void );
1090 extern  List   addTyconsMatching    ( String,List );
1091 extern  List   addNamesMatching     ( String,List );
1092
1093 extern  Tycon  findTyconInAnyModule ( Text t );
1094 extern  Class  findClassInAnyModule ( Text t );
1095 extern  Name   findNameInAnyModule  ( Text t );
1096
1097 extern  Void   print                ( Cell, Int );
1098 extern  void   dumpTycon            ( Int t );
1099 extern  void   dumpName             ( Int n );
1100 extern  void   dumpClass            ( Int c );
1101 extern  void   dumpInst             ( Int i );
1102 extern  void   locateSymbolByName   ( Text t );
1103
1104 /*-------------------------------------------------------------------------*/