ghc/interpreter/storage.c

   1
   2 /* --------------------------------------------------------------------------
   3  * Primitives for manipulating global data structures
   4  *
   5  * The Hugs 98 system is Copyright (c) Mark P Jones, Alastair Reid, the
   6  * Yale Haskell Group, and the Oregon Graduate Institute of Science and
   7  * Technology, 1994-1999, All rights reserved.  It is distributed as
   8  * free software under the license in the file "License", which is
   9  * included in the distribution.
  10  *
  11  * $RCSfile: storage.c,v $
  12  * $Revision: 1.36 $
  13  * $Date: 2000/01/10 17:19:32 $
  14  * ------------------------------------------------------------------------*/
  15
  16 #include "prelude.h"
  17 #include "storage.h"
  18 #include "backend.h"
  19 #include "connect.h"
  20 #include "errors.h"
  21 #include "object.h"
  22 #include <setjmp.h>
  23
  24 /*#define DEBUG_SHOWUSE*/
  25
  26 /* --------------------------------------------------------------------------
  27  * local function prototypes:
  28  * ------------------------------------------------------------------------*/
  29
  30 static Int  local hash                  Args((String));
  31 static Int  local saveText              Args((Text));
  32 static Module local findQualifier       Args((Text));
  33 static Void local hashTycon             Args((Tycon));
  34 static List local insertTycon           Args((Tycon,List));
  35 static Void local hashName              Args((Name));
  36 static List local insertName            Args((Name,List));
  37 static Void local patternError          Args((String));
  38 static Bool local stringMatch           Args((String,String));
  39 static Bool local typeInvolves          Args((Type,Type));
  40 static Cell local markCell              Args((Cell));
  41 static Void local markSnd               Args((Cell));
  42 static Cell local lowLevelLastIn        Args((Cell));
  43 static Cell local lowLevelLastOut       Args((Cell));
  44        Module local moduleOfScript      Args((Script));
  45        Script local scriptThisFile      Args((Text));
  46
  47 /* --------------------------------------------------------------------------
  48  * Text storage:
  49  *
  50  * provides storage for the characters making up identifier and symbol
  51  * names, string literals, character constants etc...
  52  *
  53  * All character strings are stored in a large character array, with textHw
  54  * pointing to the next free position.  Lookup in the array is improved using
  55  * a hash table.  Internally, text strings are represented by integer offsets
  56  * from the beginning of the array to the string in question.
  57  *
  58  * Where memory permits, the use of multiple hashtables gives a significant
  59  * increase in performance, particularly when large source files are used.
  60  *
  61  * Each string in the array is terminated by a zero byte.  No string is
  62  * stored more than once, so that it is safe to test equality of strings by
  63  * comparing the corresponding offsets.
  64  *
  65  * Special text values (beyond the range of the text array table) are used
  66  * to generate unique `new variable names' as required.
  67  *
  68  * The same text storage is also used to hold text values stored in a saved
  69  * expression.  This grows downwards from the top of the text table (and is
  70  * not included in the hash table).
  71  * ------------------------------------------------------------------------*/
  72
  73 #define TEXTHSZ 512                     /* Size of Text hash table         */
  74 #define NOTEXT  ((Text)(~0))            /* Empty bucket in Text hash table */
  75 static  Text    textHw;                 /* Next unused position            */
  76 static  Text    savedText = NUM_TEXT;   /* Start of saved portion of text  */
  77 static  Text    nextNewText;            /* Next new text value             */
  78 static  Text    nextNewDText;           /* Next new dict text value        */
  79 static  char    DEFTABLE(text,NUM_TEXT);/* Storage of character strings    */
  80 static  Text    textHash[TEXTHSZ][NUM_TEXTH]; /* Hash table storage        */
  81
  82 String textToStr(t)                    /* find string corresp to given Text*/
  83 Text t; {
  84     static char newVar[16];
  85
  86     if (0<=t && t<NUM_TEXT)                     /* standard char string    */
  87         return text + t;
  88     if (t<0)
  89         sprintf(newVar,"d%d",-t);               /* dictionary variable     */
  90     else
  91         sprintf(newVar,"v%d",t-NUM_TEXT);       /* normal variable         */
  92     return newVar;
  93 }
  94
  95 String identToStr(v) /*find string corresp to given ident or qualified name*/
  96 Cell v; {
  97     if (!isPair(v)) {
  98         internal("identToStr");
  99     }
 100     switch (fst(v)) {
 101         case VARIDCELL  :
 102         case VAROPCELL  :
 103         case CONIDCELL  :
 104         case CONOPCELL  : return text+textOf(v);
 105
 106         case QUALIDENT  : {   Text pos = textHw;
 107                               Text t   = qmodOf(v);
 108                               while (pos+1 < savedText && text[t]!=0) {
 109                                   text[pos++] = text[t++];
 110                               }
 111                               if (pos+1 < savedText) {
 112                                   text[pos++] = '.';
 113                               }
 114                               t = qtextOf(v);
 115                               while (pos+1 < savedText && text[t]!=0) {
 116                                   text[pos++] = text[t++];
 117                               }
 118                               text[pos] = '\0';
 119                               return text+textHw;
 120                           }
 121     }
 122     internal("identToStr2");
 123     return 0; /* NOTREACHED */
 124 }
 125
 126 Text inventText()     {                 /* return new unused variable name */
 127     return nextNewText++;
 128 }
 129
 130 Text inventDictText() {                 /* return new unused dictvar name  */
 131     return nextNewDText--;
 132 }
 133
 134 Bool inventedText(t)                    /* Signal TRUE if text has been    */
 135 Text t; {                               /* generated internally            */
 136     return (t<0 || t>=NUM_TEXT);
 137 }
 138
 139 #define MAX_FIXLIT 100
 140 Text fixLitText(t)                /* fix literal text that might include \ */
 141 Text t; {
 142     String   s = textToStr(t);
 143     char     p[MAX_FIXLIT];
 144     Int      i;
 145     for(i = 0;i < MAX_FIXLIT-2 && *s;s++) {
 146       p[i++] = *s;
 147       if (*s == '\\') {
 148         p[i++] = '\\';
 149       }
 150     }
 151     if (i < MAX_FIXLIT-2) {
 152       p[i] = 0;
 153     } else {
 154         ERRMSG(0) "storage space exhausted for internal literal string"
 155         EEND;
 156     }
 157     return (findText(p));
 158 }
 159 #undef MAX_FIXLIT
 160
 161 static Int local hash(s)                /* Simple hash function on strings */
 162 String s; {
 163     int v, j = 3;
 164
 165     for (v=((int)(*s))*8; *s; s++)
 166         v += ((int)(*s))*(j++);
 167     if (v<0)
 168         v = (-v);
 169     return(v%TEXTHSZ);
 170 }
 171
 172 Text findText(s)                       /* Locate string in Text array      */
 173 String s; {
 174     int    h       = hash(s);
 175     int    hashno  = 0;
 176     Text   textPos = textHash[h][hashno];
 177
 178 #define TryMatch        {   Text   originalTextPos = textPos;              \
 179                             String t;                                      \
 180                             for (t=s; *t==text[textPos]; textPos++,t++)    \
 181                                 if (*t=='\0')                              \
 182                                     return originalTextPos;                \
 183                         }
 184 #define Skip            while (text[textPos++]) ;
 185
 186     while (textPos!=NOTEXT) {
 187         TryMatch
 188         if (++hashno<NUM_TEXTH)         /* look in next hashtable entry    */
 189             textPos = textHash[h][hashno];
 190         else {
 191             Skip
 192             while (textPos < textHw) {
 193                 TryMatch
 194                 Skip
 195             }
 196             break;
 197         }
 198     }
 199
 200 #undef TryMatch
 201 #undef Skip
 202
 203     textPos = textHw;                  /* if not found, save in array      */
 204     if (textHw + (Int)strlen(s) + 1 > savedText) {
 205         ERRMSG(0) "Character string storage space exhausted"
 206         EEND;
 207     }
 208     while ((text[textHw++] = *s++) != 0) {
 209     }
 210     if (hashno<NUM_TEXTH) {            /* updating hash table as necessary */
 211         textHash[h][hashno] = textPos;
 212         if (hashno<NUM_TEXTH-1)
 213             textHash[h][hashno+1] = NOTEXT;
 214     }
 215
 216     return textPos;
 217 }
 218
 219 static Int local saveText(t)            /* Save text value in buffer       */
 220 Text t; {                               /* at top of text table            */
 221     String s = textToStr(t);
 222     Int    l = strlen(s);
 223
 224     if (textHw + l + 1 > savedText) {
 225         ERRMSG(0) "Character string storage space exhausted"
 226         EEND;
 227     }
 228     savedText -= l+1;
 229     strcpy(text+savedText,s);
 230     return savedText;
 231 }
 232
 233
 234 static int fromHexDigit ( char c )
 235 {
 236    switch (c) {
 237       case '0': case '1': case '2': case '3': case '4':
 238       case '5': case '6': case '7': case '8': case '9':
 239          return c - '0';
 240       case 'a': case 'A': return 10;
 241       case 'b': case 'B': return 11;
 242       case 'c': case 'C': return 12;
 243       case 'd': case 'D': return 13;
 244       case 'e': case 'E': return 14;
 245       case 'f': case 'F': return 15;
 246       default: return -1;
 247    }
 248 }
 249
 250
 251 /* returns findText (unZencode s) */
 252 Text unZcodeThenFindText ( String s )
 253 {
 254    unsigned char* p;
 255    Int            n, nn, i;
 256    Text           t;
 257
 258    assert(s);
 259    nn = 100 + 10 * strlen(s);
 260    p = malloc ( nn );
 261    if (!p) internal ("unZcodeThenFindText: malloc failed");
 262    n = 0;
 263
 264    while (1) {
 265       if (!(*s)) break;
 266       if (n > nn-90) internal ("unZcodeThenFindText: result is too big");
 267       if (*s != 'z' && *s != 'Z') {
 268          p[n] = *s; n++; s++;
 269          continue;
 270       }
 271       s++;
 272       if (!(*s)) goto parse_error;
 273       switch (*s++) {
 274          case 'Z': p[n++] = 'Z'; break;
 275          case 'C': p[n++] = ':'; break;
 276          case 'L': p[n++] = '('; break;
 277          case 'R': p[n++] = ')'; break;
 278          case 'M': p[n++] = '['; break;
 279          case 'N': p[n++] = ']'; break;
 280          case 'z': p[n++] = 'z'; break;
 281          case 'a': p[n++] = '&'; break;
 282          case 'b': p[n++] = '|'; break;
 283          case 'd': p[n++] = '$'; break;
 284          case 'e': p[n++] = '='; break;
 285          case 'g': p[n++] = '>'; break;
 286          case 'h': p[n++] = '#'; break;
 287          case 'i': p[n++] = '.'; break;
 288          case 'l': p[n++] = '<'; break;
 289          case 'm': p[n++] = '-'; break;
 290          case 'n': p[n++] = '!'; break;
 291          case 'p': p[n++] = '+'; break;
 292          case 'q': p[n++] = '\\'; break;
 293          case 'r': p[n++] = '\''; break;
 294          case 's': p[n++] = '/'; break;
 295          case 't': p[n++] = '*'; break;
 296          case 'u': p[n++] = '^'; break;
 297          case 'v': p[n++] = '%'; break;
 298          case 'x':
 299             if (!s[0] || !s[1]) goto parse_error;
 300             if (fromHexDigit(s[0]) < 0 || fromHexDigit(s[1]) < 0) goto parse_error;
 301             p[n++] = 16 * fromHexDigit(s[0]) + fromHexDigit(s[1]);
 302             p += 2; s += 2;
 303             break;
 304          case '0': case '1': case '2': case '3': case '4':
 305          case '5': case '6': case '7': case '8': case '9':
 306             i = 0;
 307             s--;
 308             while (*s && isdigit((int)(*s))) {
 309                i = 10 * i + (*s - '0');
 310                s++;
 311             }
 312             if (*s != 'T') goto parse_error;
 313             s++;
 314             p[n++] = '(';
 315             while (i > 0) { p[n++] = ','; i--; };
 316             p[n++] = ')';
 317             break;
 318          default:
 319             goto parse_error;
 320       }
 321    }
 322    p[n] = 0;
 323    t = findText(p);
 324    free(p);
 325    return t;
 326
 327   parse_error:
 328    free(p);
 329    fprintf ( stderr, "\nstring = `%s'\n", s );
 330    internal ( "unZcodeThenFindText: parse error on above string");
 331    return NIL; /*notreached*/
 332 }
 333
 334
 335 Text enZcodeThenFindText ( String s )
 336 {
 337    unsigned char* p;
 338    Int            n, nn;
 339    Text           t;
 340    char toHex[16] = "0123456789ABCDEF";
 341
 342    assert(s);
 343    nn = 100 + 10 * strlen(s);
 344    p = malloc ( nn );
 345    if (!p) internal ("enZcodeThenFindText: malloc failed");
 346    n = 0;
 347    while (1) {
 348       if (!(*s)) break;
 349       if (n > nn-90) internal ("enZcodeThenFindText: result is too big");
 350       if (*s != 'z'
 351           && *s != 'Z'
 352           && (isalnum((int)(*s)) || *s == '_')) {
 353          p[n] = *s; n++; s++;
 354          continue;
 355       }
 356       switch (*s++) {
 357          case '(': p[n++] = 'Z'; p[n++] = 'L'; break;
 358          case ')': p[n++] = 'Z'; p[n++] = 'R'; break;
 359          case '[': p[n++] = 'Z'; p[n++] = 'M'; break;
 360          case ']': p[n++] = 'Z'; p[n++] = 'N'; break;
 361          case ':': p[n++] = 'Z'; p[n++] = 'C'; break;
 362          case 'Z': p[n++] = 'Z'; p[n++] = 'Z'; break;
 363          case 'z': p[n++] = 'z'; p[n++] = 'z'; break;
 364          case '&': p[n++] = 'z'; p[n++] = 'a'; break;
 365          case '|': p[n++] = 'z'; p[n++] = 'b'; break;
 366          case '$': p[n++] = 'z'; p[n++] = 'd'; break;
 367          case '=': p[n++] = 'z'; p[n++] = 'e'; break;
 368          case '>': p[n++] = 'z'; p[n++] = 'g'; break;
 369          case '#': p[n++] = 'z'; p[n++] = 'h'; break;
 370          case '.': p[n++] = 'z'; p[n++] = 'i'; break;
 371          case '<': p[n++] = 'z'; p[n++] = 'l'; break;
 372          case '-': p[n++] = 'z'; p[n++] = 'm'; break;
 373          case '!': p[n++] = 'z'; p[n++] = 'n'; break;
 374          case '+': p[n++] = 'z'; p[n++] = 'p'; break;
 375          case '\'': p[n++] = 'z'; p[n++] = 'q'; break;
 376          case '\\': p[n++] = 'z'; p[n++] = 'r'; break;
 377          case '/': p[n++] = 'z'; p[n++] = 's'; break;
 378          case '*': p[n++] = 'z'; p[n++] = 't'; break;
 379          case '^': p[n++] = 'z'; p[n++] = 'u'; break;
 380          case '%': p[n++] = 'z'; p[n++] = 'v'; break;
 381          default: s--; p[n++] = 'z'; p[n++] = 'x';
 382                        p[n++] = toHex[(int)(*s)/16];
 383                        p[n++] = toHex[(int)(*s)%16];
 384                   s++; break;
 385       }
 386    }
 387    p[n] = 0;
 388    t = findText(p);
 389    free(p);
 390    return t;
 391 }
 392
 393
 394 Text textOf ( Cell c )
 395 {
 396    Bool ok =
 397           (whatIs(c)==VARIDCELL
 398            || whatIs(c)==CONIDCELL
 399            || whatIs(c)==VAROPCELL
 400            || whatIs(c)==CONOPCELL
 401            || whatIs(c)==STRCELL
 402            || whatIs(c)==DICTVAR
 403           );
 404    if (!ok) {
 405       fprintf(stderr, "\ntextOf: bad tag %d\n",whatIs(c) );
 406       internal("textOf: bad tag");
 407    }
 408    return snd(c);
 409 }
 410
 411 /* --------------------------------------------------------------------------
 412  * Ext storage:
 413  *
 414  * Currently, the only attributes that we store for each Ext value is the
 415  * corresponding Text label.  At some later stage, we may decide to cache
 416  * types, predicates, etc. here as a space saving gesture.  Given that Text
 417  * comparison is cheap, and that this is an experimental implementation, we
 418  * will use a straightforward linear search to locate Ext values from their
 419  * corresponding Text labels; a hashing scheme can be introduced later if
 420  * this turns out to be a problem.
 421  * ------------------------------------------------------------------------*/
 422
 423 #if TREX
 424 Text  DEFTABLE(tabExt,NUM_EXT);         /* Storage for Ext names           */
 425 Ext   extHw;
 426
 427 Ext mkExt(t)                            /* Allocate or find an Ext value   */
 428 Text t; {
 429     Ext e = EXTMIN;
 430     for (; e<extHw; e++)
 431         if (t==extText(e))
 432             return e;
 433     if (extHw-EXTMIN >= NUM_EXT) {
 434         ERRMSG(0) "Ext storage space exhausted"
 435         EEND;
 436     }
 437     extText(extHw) = t;
 438     return extHw++;
 439 }
 440 #endif
 441
 442 /* --------------------------------------------------------------------------
 443  * Tycon storage:
 444  *
 445  * A Tycon represents a user defined type constructor.  Tycons are indexed
 446  * by Text values ... a very simple hash function is used to improve lookup
 447  * times.  Tycon entries with the same hash code are chained together, with
 448  * the most recent entry at the front of the list.
 449  * ------------------------------------------------------------------------*/
 450
 451 #define TYCONHSZ 256                            /* Size of Tycon hash table*/
 452 #define tHash(x) ((x)%TYCONHSZ)                 /* Tycon hash function     */
 453 static  Tycon    tyconHw;                       /* next unused Tycon       */
 454 static  Tycon    DEFTABLE(tyconHash,TYCONHSZ);  /* Hash table storage      */
 455 struct  strTycon DEFTABLE(tabTycon,NUM_TYCON);  /* Tycon storage           */
 456
 457 Tycon newTycon(t)                       /* add new tycon to tycon table    */
 458 Text t; {
 459     Int h = tHash(t);
 460     if (tyconHw-TYCMIN >= NUM_TYCON) {
 461         ERRMSG(0) "Type constructor storage space exhausted"
 462         EEND;
 463     }
 464     tycon(tyconHw).text          = t;   /* clear new tycon record          */
 465     tycon(tyconHw).kind          = NIL;
 466     tycon(tyconHw).defn          = NIL;
 467     tycon(tyconHw).what          = NIL;
 468     tycon(tyconHw).conToTag      = NIL;
 469     tycon(tyconHw).tagToCon      = NIL;
 470     tycon(tyconHw).tuple         = -1;
 471     tycon(tyconHw).mod           = currentModule;
 472     tycon(tyconHw).itbl          = NULL;
 473     module(currentModule).tycons = cons(tyconHw,module(currentModule).tycons);
 474     tycon(tyconHw).nextTyconHash = tyconHash[h];
 475     tyconHash[h]                 = tyconHw;
 476
 477     return tyconHw++;
 478 }
 479
 480 Tycon findTycon(t)                      /* locate Tycon in tycon table     */
 481 Text t; {
 482     Tycon tc = tyconHash[tHash(t)];
 483
 484     while (nonNull(tc) && tycon(tc).text!=t)
 485         tc = tycon(tc).nextTyconHash;
 486     return tc;
 487 }
 488
 489 Tycon addTycon(tc)  /* Insert Tycon in tycon table - if no clash is caused */
 490 Tycon tc; {
 491     Tycon oldtc;
 492     assert(whatIs(tc)==TYCON || whatIs(tc)==TUPLE);
 493     oldtc = findTycon(tycon(tc).text);
 494     if (isNull(oldtc)) {
 495         hashTycon(tc);
 496         module(currentModule).tycons=cons(tc,module(currentModule).tycons);
 497         return tc;
 498     } else
 499         return oldtc;
 500 }
 501
 502 static Void local hashTycon(tc)         /* Insert Tycon into hash table    */
 503 Tycon tc; {
 504   if (!(isTycon(tc) || isTuple(tc))) {
 505     printf("\nbad stuff: " ); print(tc,10); printf("\n");
 506       assert(isTycon(tc) || isTuple(tc));
 507   }
 508    if (1) {
 509      Text  t = tycon(tc).text;
 510      Int   h = tHash(t);
 511      tycon(tc).nextTyconHash = tyconHash[h];
 512      tyconHash[h]            = tc;
 513    }
 514 }
 515
 516 Tycon findQualTycon(id) /*locate (possibly qualified) Tycon in tycon table */
 517 Cell id; {
 518     if (!isPair(id)) internal("findQualTycon");
 519     switch (fst(id)) {
 520         case CONIDCELL :
 521         case CONOPCELL :
 522             return findTycon(textOf(id));
 523         case QUALIDENT : {
 524             Text   t  = qtextOf(id);
 525             Module m  = findQualifier(qmodOf(id));
 526             List   es = NIL;
 527             if (isNull(m)) return NIL;
 528             for(es=module(m).exports; nonNull(es); es=tl(es)) {
 529                 Cell e = hd(es);
 530                 if (isPair(e) && isTycon(fst(e)) && tycon(fst(e)).text==t)
 531                     return fst(e);
 532             }
 533             return NIL;
 534         }
 535         default : internal("findQualTycon2");
 536     }
 537     return NIL; /* NOTREACHED */
 538 }
 539
 540 Tycon addPrimTycon(t,kind,ar,what,defn) /* add new primitive type constr   */
 541 Text t;
 542 Kind kind;
 543 Int  ar;
 544 Cell what;
 545 Cell defn; {
 546     Tycon tc        = newTycon(t);
 547     tycon(tc).line  = 0;
 548     tycon(tc).kind  = kind;
 549     tycon(tc).what  = what;
 550     tycon(tc).defn  = defn;
 551     tycon(tc).arity = ar;
 552     return tc;
 553 }
 554
 555 static List local insertTycon(tc,ts)    /* insert tycon tc into sorted list*/
 556 Tycon tc;                               /* ts                              */
 557 List  ts; {
 558     Cell   prev = NIL;
 559     Cell   curr = ts;
 560     String s    = textToStr(tycon(tc).text);
 561
 562     while (nonNull(curr) && strCompare(s,textToStr(tycon(hd(curr)).text))>=0) {
 563         if (hd(curr)==tc)               /* just in case we get duplicates! */
 564             return ts;
 565         prev = curr;
 566         curr = tl(curr);
 567     }
 568     if (nonNull(prev)) {
 569         tl(prev) = cons(tc,curr);
 570         return ts;
 571     }
 572     else
 573         return cons(tc,curr);
 574 }
 575
 576 List addTyconsMatching(pat,ts)          /* Add tycons matching pattern pat */
 577 String pat;                             /* to list of Tycons ts            */
 578 List   ts; {                            /* Null pattern matches every tycon*/
 579     Tycon tc;                           /* (Tycons with NIL kind excluded) */
 580     for (tc=TYCMIN; tc<tyconHw; ++tc)
 581         if (!pat || stringMatch(pat,textToStr(tycon(tc).text)))
 582             if (nonNull(tycon(tc).kind))
 583                 ts = insertTycon(tc,ts);
 584     return ts;
 585 }
 586
 587 Text ghcTupleText_n ( Int n )
 588 {
 589     Int  i;
 590     char buf[104];
 591     if (n < 0 || n >= 100) internal("ghcTupleText_n");
 592     buf[0] = '(';
 593     for (i = 1; i <= n; i++) buf[i] = ',';
 594     buf[n+1] = ')';
 595     buf[n+2] = 0;
 596     return findText(buf);
 597 }
 598
 599 Text ghcTupleText(tup)
 600 Tycon tup; {
 601     if (!isTuple(tup)) {
 602        assert(isTuple(tup));
 603     }
 604     return ghcTupleText_n ( tupleOf(tup) );
 605 }
 606
 607
 608 Tycon mkTuple ( Int n )
 609 {
 610    Int i;
 611    if (n >= NUM_TUPLES)
 612       internal("mkTuple: request for tuple of unsupported size");
 613    for (i = TYCMIN; i < tyconHw; i++)
 614       if (tycon(i).tuple == n) return i;
 615    internal("mkTuple: request for non-existent tuple");
 616 }
 617
 618
 619 /* --------------------------------------------------------------------------
 620  * Name storage:
 621  *
 622  * A Name represents a top level binding of a value to an identifier.
 623  * Such values may be a constructor function, a member function in a
 624  * class, a user-defined or primitive value/function.
 625  *
 626  * Names are indexed by Text values ... a very simple hash functions speeds
 627  * access to the table of Names and Name entries with the same hash value
 628  * are chained together, with the most recent entry at the front of the
 629  * list.
 630  * ------------------------------------------------------------------------*/
 631
 632 #define NAMEHSZ  256                            /* Size of Name hash table */
 633 #define nHash(x) ((x)%NAMEHSZ)                  /* hash fn :: Text->Int    */
 634         Name     nameHw;                        /* next unused name        */
 635 static  Name     DEFTABLE(nameHash,NAMEHSZ);    /* Hash table storage      */
 636 struct  strName  DEFTABLE(tabName,NUM_NAME);    /* Name table storage      */
 637
 638 Name newName(t,parent)                  /* Add new name to name table      */
 639 Text t;
 640 Cell parent; {
 641     Int h = nHash(t);
 642     if (nameHw-NAMEMIN >= NUM_NAME) {
 643         ERRMSG(0) "Name storage space exhausted"
 644         EEND;
 645     }
 646     name(nameHw).text         = t;      /* clear new name record           */
 647     name(nameHw).line         = 0;
 648     name(nameHw).syntax       = NO_SYNTAX;
 649     name(nameHw).parent       = parent;
 650     name(nameHw).arity        = 0;
 651     name(nameHw).number       = EXECNAME;
 652     name(nameHw).defn         = NIL;
 653     name(nameHw).stgVar       = NIL;
 654     name(nameHw).callconv     = NIL;
 655     name(nameHw).type         = NIL;
 656     name(nameHw).primop       = 0;
 657     name(nameHw).mod          = currentModule;
 658     name(nameHw).itbl         = NULL;
 659     module(currentModule).names=cons(nameHw,module(currentModule).names);
 660     name(nameHw).nextNameHash = nameHash[h];
 661     nameHash[h]               = nameHw;
 662     return nameHw++;
 663 }
 664
 665 Name findName(t)                        /* Locate name in name table       */
 666 Text t; {
 667     Name n = nameHash[nHash(t)];
 668
 669     while (nonNull(n) && name(n).text!=t)
 670         n = name(n).nextNameHash;
 671     return n;
 672 }
 673
 674 Name addName(nm)                        /* Insert Name in name table - if  */
 675 Name nm; {                              /* no clash is caused              */
 676     Name oldnm;
 677     assert(whatIs(nm)==NAME);
 678     oldnm = findName(name(nm).text);
 679     if (isNull(oldnm)) {
 680         hashName(nm);
 681         module(currentModule).names=cons(nm,module(currentModule).names);
 682         return nm;
 683     } else
 684         return oldnm;
 685 }
 686
 687 static Void local hashName(nm)          /* Insert Name into hash table     */
 688 Name nm; {
 689     Text t;
 690     Int  h;
 691     assert(isName(nm));
 692     t = name(nm).text;
 693     h = nHash(t);
 694     name(nm).nextNameHash = nameHash[h];
 695     nameHash[h]           = nm;
 696 }
 697
 698 Name findQualName(id)              /* Locate (possibly qualified) name*/
 699 Cell id; {                         /* in name table                   */
 700     if (!isPair(id))
 701         internal("findQualName");
 702     switch (fst(id)) {
 703         case VARIDCELL :
 704         case VAROPCELL :
 705         case CONIDCELL :
 706         case CONOPCELL :
 707             return findName(textOf(id));
 708         case QUALIDENT : {
 709             Text   t  = qtextOf(id);
 710             Module m  = findQualifier(qmodOf(id));
 711             List   es = NIL;
 712             if (isNull(m)) return NIL;
 713             for(es=module(m).exports; nonNull(es); es=tl(es)) {
 714                 Cell e = hd(es);
 715                 if (isName(e) && name(e).text==t)
 716                     return e;
 717                 else if (isPair(e) && DOTDOT==snd(e)) {
 718                     List subentities = NIL;
 719                     Cell c = fst(e);
 720                     if (isTycon(c)
 721                         && (tycon(c).what==DATATYPE || tycon(c).what==NEWTYPE))
 722                         subentities = tycon(c).defn;
 723                     else if (isClass(c))
 724                         subentities = cclass(c).members;
 725                     for(; nonNull(subentities); subentities=tl(subentities)) {
 726                        if (!isName(hd(subentities)))
 727                             internal("findQualName3");
 728                         if (name(hd(subentities)).text == t)
 729                             return hd(subentities);
 730                     }
 731                 }
 732             }
 733             return NIL;
 734         }
 735         default : internal("findQualName2");
 736     }
 737     return 0; /* NOTREACHED */
 738 }
 739
 740
 741 Name nameFromStgVar ( StgVar v )
 742 {
 743    Int n;
 744    for (n = NAMEMIN; n < nameHw; n++)
 745       if (name(n).stgVar == v) return n;
 746    return NIL;
 747 }
 748
 749 void* getHugs_AsmObject_for ( char* s )
 750 {
 751    StgVar v;
 752    Text   t = findText(s);
 753    Name   n = NIL;
 754    for (n = NAMEMIN; n < nameHw; n++)
 755       if (name(n).text == t) break;
 756    if (n == nameHw) internal("getHugs_AsmObject_for(1)");
 757    v = name(n).stgVar;
 758    if (!isStgVar(v) || !isPtr(stgVarInfo(v)))
 759       internal("getHugs_AsmObject_for(2)");
 760    return ptrOf(stgVarInfo(v));
 761 }
 762
 763 /* --------------------------------------------------------------------------
 764  * Primitive functions:
 765  * ------------------------------------------------------------------------*/
 766
 767 Module findFakeModule ( Text t )
 768 {
 769    Module m = findModule(t);
 770    if (nonNull(m)) {
 771       if (!module(m).fake) internal("findFakeModule");
 772    } else {
 773       m = newModule(t);
 774       module(m).fake = TRUE;
 775    }
 776    return m;
 777 }
 778
 779
 780 Name addWiredInBoxingTycon
 781         ( String modNm, String typeNm, String constrNm,
 782           Int arity, Int no, Int rep )
 783 {
 784    Name  n;
 785    Tycon t;
 786    Text modT  = findText(modNm);
 787    Text typeT = findText(typeNm);
 788    Text conT  = findText(constrNm);
 789    Module m = findFakeModule(modT);
 790    setCurrModule(m);
 791
 792    n = newName(conT,NIL);
 793    name(n).arity = arity;
 794    name(n).number = cfunNo(no);
 795    name(n).type = NIL;
 796    name(n).primop = (void*)rep;
 797
 798    t = newTycon(typeT);
 799    tycon(t).what = DATATYPE;
 800    return n;
 801 }
 802
 803
 804 Tycon addTupleTycon ( Int n )
 805 {
 806    Int    i;
 807    Kind   k;
 808    Tycon  t;
 809    Module m;
 810    Name   nm;
 811
 812    for (i = TYCMIN; i < tyconHw; i++)
 813       if (tycon(i).tuple == n) return i;
 814
 815    if (combined)
 816       m = findFakeModule(findText(n==0 ? "PrelBase" : "PrelTup")); else
 817       m = findModule(findText("Prelude"));
 818
 819    setCurrModule(m);
 820    k = STAR;
 821    for (i = 0; i < n; i++) k = ap(STAR,k);
 822    t = newTycon(ghcTupleText_n(n));
 823    tycon(t).kind  = k;
 824    tycon(t).tuple = n;
 825    tycon(t).what  = DATATYPE;
 826
 827    if (n == 0) {
 828       /* maybe we want to do this for all n ? */
 829       nm = newName(ghcTupleText_n(n), t);
 830       name(nm).type = t;   /* ummm ... for n > 0 */
 831    }
 832
 833    return t;
 834 }
 835
 836
 837 Tycon addWiredInEnumTycon ( String modNm, String typeNm,
 838                             List /*of Text*/ constrs )
 839 {
 840    Int    i;
 841    Tycon  t;
 842    Text   modT  = findText(modNm);
 843    Text   typeT = findText(typeNm);
 844    Module m     = findFakeModule(modT);
 845    setCurrModule(m);
 846
 847    t             = newTycon(typeT);
 848    tycon(t).kind = STAR;
 849    tycon(t).what = DATATYPE;
 850
 851    constrs = reverse(constrs);
 852    i       = length(constrs);
 853    for (; nonNull(constrs); constrs=tl(constrs),i--) {
 854       Text conT        = hd(constrs);
 855       Name con         = newName(conT,t);
 856       name(con).number = cfunNo(i);
 857       name(con).type   = t;
 858       tycon(t).defn    = cons(con, tycon(t).defn);
 859    }
 860    return t;
 861 }
 862
 863
 864 Name addPrimCfunREP(t,arity,no,rep)     /* add primitive constructor func  */
 865 Text t;                                 /* sets rep, not type              */
 866 Int  arity;
 867 Int  no;
 868 Int  rep; { /* Really AsmRep */
 869     Name n          = newName(t,NIL);
 870     name(n).arity   = arity;
 871     name(n).number  = cfunNo(no);
 872     name(n).type    = NIL;
 873     name(n).primop  = (void*)rep;
 874     return n;
 875 }
 876
 877
 878 Name addPrimCfun(t,arity,no,type)       /* add primitive constructor func  */
 879 Text t;
 880 Int  arity;
 881 Int  no;
 882 Cell type; {
 883     Name n         = newName(t,NIL);
 884     name(n).arity  = arity;
 885     name(n).number = cfunNo(no);
 886     name(n).type   = type;
 887     return n;
 888 }
 889
 890
 891 Int sfunPos(s,c)                        /* Find position of field with     */
 892 Name s;                                 /* selector s in constructor c.    */
 893 Name c; {
 894     List cns;
 895     cns = name(s).defn;
 896     for (; nonNull(cns); cns=tl(cns))
 897         if (fst(hd(cns))==c)
 898             return intOf(snd(hd(cns)));
 899     internal("sfunPos");
 900     return 0;/* NOTREACHED */
 901 }
 902
 903 static List local insertName(nm,ns)     /* insert name nm into sorted list */
 904 Name nm;                                /* ns                              */
 905 List ns; {
 906     Cell   prev = NIL;
 907     Cell   curr = ns;
 908     String s    = textToStr(name(nm).text);
 909
 910     while (nonNull(curr) && strCompare(s,textToStr(name(hd(curr)).text))>=0) {
 911         if (hd(curr)==nm)               /* just in case we get duplicates! */
 912             return ns;
 913         prev = curr;
 914         curr = tl(curr);
 915     }
 916     if (nonNull(prev)) {
 917         tl(prev) = cons(nm,curr);
 918         return ns;
 919     }
 920     else
 921         return cons(nm,curr);
 922 }
 923
 924 List addNamesMatching(pat,ns)           /* Add names matching pattern pat  */
 925 String pat;                             /* to list of names ns             */
 926 List   ns; {                            /* Null pattern matches every name */
 927     Name nm;                            /* (Names with NIL type, or hidden */
 928 #if 1
 929     for (nm=NAMEMIN; nm<nameHw; ++nm)   /* or invented names are excluded) */
 930         if (!inventedText(name(nm).text) && nonNull(name(nm).type)) {
 931             String str = textToStr(name(nm).text);
 932             if (str[0]!='_' && (!pat || stringMatch(pat,str)))
 933                 ns = insertName(nm,ns);
 934         }
 935     return ns;
 936 #else
 937     List mns = module(currentModule).names;
 938     for(; nonNull(mns); mns=tl(mns)) {
 939         Name nm = hd(mns);
 940         if (!inventedText(name(nm).text)) {
 941             String str = textToStr(name(nm).text);
 942             if (str[0]!='_' && (!pat || stringMatch(pat,str)))
 943                 ns = insertName(nm,ns);
 944         }
 945     }
 946     return ns;
 947 #endif
 948 }
 949
 950 /* --------------------------------------------------------------------------
 951  * A simple string matching routine
 952  *     `*'    matches any sequence of zero or more characters
 953  *     `?'    matches any single character exactly
 954  *     `@str' matches the string str exactly (ignoring any special chars)
 955  *     `\c'   matches the character c only (ignoring special chars)
 956  *     c      matches the character c only
 957  * ------------------------------------------------------------------------*/
 958
 959 static Void local patternError(s)       /* report error in pattern         */
 960 String s; {
 961     ERRMSG(0) "%s in pattern", s
 962     EEND;
 963 }
 964
 965 static Bool local stringMatch(pat,str)  /* match string against pattern    */
 966 String pat;
 967 String str; {
 968
 969     for (;;)
 970         switch (*pat) {
 971             case '\0' : return (*str=='\0');
 972
 973             case '*'  : do {
 974                             if (stringMatch(pat+1,str))
 975                                 return TRUE;
 976                         } while (*str++);
 977                         return FALSE;
 978
 979             case '?'  : if (*str++=='\0')
 980                             return FALSE;
 981                         pat++;
 982                         break;
 983
 984             case '['  : {   Bool found = FALSE;
 985                             while (*++pat!='\0' && *pat!=']')
 986                                 if (!found && ( pat[0] == *str  ||
 987                                                (pat[1] == '-'   &&
 988                                                 pat[2] != ']'   &&
 989                                                 pat[2] != '\0'  &&
 990                                                 pat[0] <= *str  &&
 991                                                 pat[2] >= *str)))
 992
 993                                     found = TRUE;
 994                             if (*pat != ']')
 995                                 patternError("missing `]'");
 996                             if (!found)
 997                                 return FALSE;
 998                             pat++;
 999                             str++;
1000                         }
1001                         break;
1002
1003             case '\\' : if (*++pat == '\0')
1004                             patternError("extra trailing `\\'");
1005                         /*fallthru!*/
1006             default   : if (*pat++ != *str++)
1007                             return FALSE;
1008                         break;
1009         }
1010 }
1011
1012 /* --------------------------------------------------------------------------
1013  * Storage of type classes, instances etc...:
1014  * ------------------------------------------------------------------------*/
1015
1016 static Class classHw;                  /* next unused class                */
1017 static List  classes;                  /* list of classes in current scope */
1018 static Inst  instHw;                   /* next unused instance record      */
1019
1020 struct strClass DEFTABLE(tabClass,NUM_CLASSES); /* table of class records  */
1021 struct strInst far *tabInst;           /* (pointer to) table of instances  */
1022
1023 Class newClass(t)                      /* add new class to class table     */
1024 Text t; {
1025     if (classHw-CLASSMIN >= NUM_CLASSES) {
1026         ERRMSG(0) "Class storage space exhausted"
1027         EEND;
1028     }
1029     cclass(classHw).text      = t;
1030     cclass(classHw).arity     = 0;
1031     cclass(classHw).kinds     = NIL;
1032     cclass(classHw).head      = NIL;
1033     cclass(classHw).fds       = NIL;
1034     cclass(classHw).xfds      = NIL;
1035     cclass(classHw).dcon      = NIL;
1036     cclass(classHw).supers    = NIL;
1037     cclass(classHw).dsels     = NIL;
1038     cclass(classHw).members   = NIL;
1039     cclass(classHw).defaults  = NIL;
1040     cclass(classHw).instances = NIL;
1041     classes=cons(classHw,classes);
1042     cclass(classHw).mod       = currentModule;
1043     module(currentModule).classes=cons(classHw,module(currentModule).classes);
1044     return classHw++;
1045 }
1046
1047 Class classMax() {                      /* Return max Class in use ...     */
1048     return classHw;                     /* This is a bit ugly, but it's not*/
1049 }                                       /* worth a lot of effort right now */
1050
1051 Class findClass(t)                     /* look for named class in table    */
1052 Text t; {
1053     Class cl;
1054     List cs;
1055     for (cs=classes; nonNull(cs); cs=tl(cs)) {
1056         cl=hd(cs);
1057         if (cclass(cl).text==t)
1058             return cl;
1059     }
1060     return NIL;
1061 }
1062
1063 Class addClass(c)                       /* Insert Class in class list      */
1064 Class c; {                              /*  - if no clash caused           */
1065     Class oldc;
1066     assert(whatIs(c)==CLASS);
1067     oldc = findClass(cclass(c).text);
1068     if (isNull(oldc)) {
1069         classes=cons(c,classes);
1070         module(currentModule).classes=cons(c,module(currentModule).classes);
1071         return c;
1072     }
1073     else
1074         return oldc;
1075 }
1076
1077 Class findQualClass(c)                  /* Look for (possibly qualified)   */
1078 Cell c; {                               /* class in class list             */
1079     if (!isQualIdent(c)) {
1080         return findClass(textOf(c));
1081     } else {
1082         Text   t  = qtextOf(c);
1083         Module m  = findQualifier(qmodOf(c));
1084         List   es = NIL;
1085         if (isNull(m))
1086             return NIL;
1087         for (es=module(m).exports; nonNull(es); es=tl(es)) {
1088             Cell e = hd(es);
1089             if (isPair(e) && isClass(fst(e)) && cclass(fst(e)).text==t)
1090                 return fst(e);
1091         }
1092     }
1093     return NIL;
1094 }
1095
1096 Inst newInst() {                       /* Add new instance to table        */
1097     if (instHw-INSTMIN >= NUM_INSTS) {
1098         ERRMSG(0) "Instance storage space exhausted"
1099         EEND;
1100     }
1101     inst(instHw).kinds      = NIL;
1102     inst(instHw).head       = NIL;
1103     inst(instHw).specifics  = NIL;
1104     inst(instHw).implements = NIL;
1105     inst(instHw).builder    = NIL;
1106     inst(instHw).mod        = currentModule;
1107
1108     return instHw++;
1109 }
1110
1111 #ifdef DEBUG_DICTS
1112 extern Void printInst Args((Inst));
1113
1114 Void printInst(in)
1115 Inst in; {
1116     Class cl = inst(in).c;
1117     Printf("%s-", textToStr(cclass(cl).text));
1118     printType(stdout,inst(in).t);
1119 }
1120 #endif /* DEBUG_DICTS */
1121
1122 Inst findFirstInst(tc)                  /* look for 1st instance involving */
1123 Tycon tc; {                             /* the type constructor tc         */
1124     return findNextInst(tc,INSTMIN-1);
1125 }
1126
1127 Inst findNextInst(tc,in)                /* look for next instance involving*/
1128 Tycon tc;                               /* the type constructor tc         */
1129 Inst  in; {                             /* starting after instance in      */
1130     while (++in < instHw) {
1131         Cell pi = inst(in).head;
1132         for (; isAp(pi); pi=fun(pi))
1133             if (typeInvolves(arg(pi),tc))
1134                 return in;
1135     }
1136     return NIL;
1137 }
1138
1139 static Bool local typeInvolves(ty,tc)   /* Test to see if type ty involves */
1140 Type ty;                                /* type constructor/tuple tc.      */
1141 Type tc; {
1142     return (ty==tc)
1143         || (isAp(ty) && (typeInvolves(fun(ty),tc)
1144                          || typeInvolves(arg(ty),tc)));
1145 }
1146
1147
1148 /* Needed by finishGHCInstance to find classes, before the
1149    export list has been built -- so we can't use
1150    findQualClass.
1151 */
1152 Class findQualClassWithoutConsultingExportList ( QualId q )
1153 {
1154    Class cl;
1155    Text t_mod;
1156    Text t_class;
1157
1158    assert(isQCon(q));
1159
1160    if (isCon(q)) {
1161       t_mod   = NIL;
1162       t_class = textOf(q);
1163    } else {
1164       t_mod   = qmodOf(q);
1165       t_class = qtextOf(q);
1166    }
1167
1168    for (cl = CLASSMIN; cl < classHw; cl++) {
1169       if (cclass(cl).text == t_class) {
1170          /* Class name is ok, but is this the right module? */
1171          if (isNull(t_mod)   /* no module name specified */
1172              || (nonNull(t_mod)
1173                  && t_mod == module(cclass(cl).mod).text)
1174             )
1175             return cl;
1176       }
1177    }
1178    return NIL;
1179 }
1180
1181
1182 /* Same deal, except for Tycons. */
1183 Tycon findQualTyconWithoutConsultingExportList ( QualId q )
1184 {
1185    Tycon tc;
1186    Text t_mod;
1187    Text t_tycon;
1188
1189    assert(isQCon(q));
1190
1191    if (isCon(q)) {
1192       t_mod   = NIL;
1193       t_tycon = textOf(q);
1194    } else {
1195       t_mod   = qmodOf(q);
1196       t_tycon = qtextOf(q);
1197    }
1198
1199    for (tc = TYCMIN; tc < tyconHw; tc++) {
1200       if (tycon(tc).text == t_tycon) {
1201          /* Tycon name is ok, but is this the right module? */
1202          if (isNull(t_mod)   /* no module name specified */
1203              || (nonNull(t_mod)
1204                  && t_mod == module(tycon(tc).mod).text)
1205             )
1206             return tc;
1207       }
1208    }
1209    return NIL;
1210 }
1211
1212 Tycon findTyconInAnyModule ( Text t )
1213 {
1214    Tycon tc;
1215    for (tc = TYCMIN; tc < tyconHw; tc++)
1216       if (tycon(tc).text == t) return tc;
1217    return NIL;
1218 }
1219
1220 Class findClassInAnyModule ( Text t )
1221 {
1222    Class cc;
1223    for (cc = CLASSMIN; cc < classHw; cc++)
1224       if (cclass(cc).text == t) return cc;
1225    return NIL;
1226 }
1227
1228 Name findNameInAnyModule ( Text t )
1229 {
1230    Name nm;
1231    for (nm = NAMEMIN; nm < nameHw; nm++)
1232       if (name(nm).text == t) return nm;
1233    return NIL;
1234 }
1235
1236 /* Same deal, except for Names. */
1237 Name findQualNameWithoutConsultingExportList ( QualId q )
1238 {
1239    Name nm;
1240    Text t_mod;
1241    Text t_name;
1242
1243    assert(isQVar(q) || isQCon(q));
1244
1245    if (isCon(q) || isVar(q)) {
1246       t_mod  = NIL;
1247       t_name = textOf(q);
1248    } else {
1249       t_mod  = qmodOf(q);
1250       t_name = qtextOf(q);
1251    }
1252
1253    for (nm = NAMEMIN; nm < nameHw; nm++) {
1254       if (name(nm).text == t_name) {
1255          /* Name is ok, but is this the right module? */
1256          if (isNull(t_mod)   /* no module name specified */
1257              || (nonNull(t_mod)
1258                  && t_mod == module(name(nm).mod).text)
1259             )
1260             return nm;
1261       }
1262    }
1263    return NIL;
1264 }
1265
1266
1267 /* returns List of QualId */
1268 List getAllKnownTyconsAndClasses ( void )
1269 {
1270    Tycon tc;
1271    Class nw;
1272    List  xs = NIL;
1273    for (tc = TYCMIN; tc < tyconHw; tc++) {
1274       /* almost certainly undue paranoia about duplicate avoidance, but .. */
1275       QualId q = mkQCon( module(tycon(tc).mod).text, tycon(tc).text );
1276       if (!qualidIsMember(q,xs))
1277          xs = cons ( q, xs );
1278    }
1279    for (nw = CLASSMIN; nw < classHw; nw++) {
1280       QualId q = mkQCon( module(cclass(nw).mod).text, cclass(nw).text );
1281       if (!qualidIsMember(q,xs))
1282          xs = cons ( q, xs );
1283    }
1284    return xs;
1285 }
1286
1287 /* --------------------------------------------------------------------------
1288  * Control stack:
1289  *
1290  * Various parts of the system use a stack of cells.  Most of the stack
1291  * operations are defined as macros, expanded inline.
1292  * ------------------------------------------------------------------------*/
1293
1294 Cell DEFTABLE(cellStack,NUM_STACK); /* Storage for cells on stack          */
1295 StackPtr sp;                        /* stack pointer                       */
1296
1297 #if GIMME_STACK_DUMPS
1298
1299 #define UPPER_DISP  5               /* # display entries on top of stack   */
1300 #define LOWER_DISP  5               /* # display entries on bottom of stack*/
1301
1302 Void hugsStackOverflow() {          /* Report stack overflow               */
1303     extern Int  rootsp;
1304     extern Cell evalRoots[];
1305
1306     ERRMSG(0) "Control stack overflow" ETHEN
1307     if (rootsp>=0) {
1308         Int i;
1309         if (rootsp>=UPPER_DISP+LOWER_DISP) {
1310             for (i=0; i<UPPER_DISP; i++) {
1311                 ERRTEXT "\nwhile evaluating: " ETHEN
1312                 ERREXPR(evalRoots[rootsp-i]);
1313             }
1314             ERRTEXT "\n..." ETHEN
1315             for (i=LOWER_DISP-1; i>=0; i--) {
1316                 ERRTEXT "\nwhile evaluating: " ETHEN
1317                 ERREXPR(evalRoots[i]);
1318             }
1319         }
1320         else {
1321             for (i=rootsp; i>=0; i--) {
1322                 ERRTEXT "\nwhile evaluating: " ETHEN
1323                 ERREXPR(evalRoots[i]);
1324             }
1325         }
1326     }
1327     ERRTEXT "\n"
1328     EEND;
1329 }
1330
1331 #else /* !GIMME_STACK_DUMPS */
1332
1333 Void hugsStackOverflow() {          /* Report stack overflow               */
1334     ERRMSG(0) "Control stack overflow"
1335     EEND;
1336 }
1337
1338 #endif /* !GIMME_STACK_DUMPS */
1339
1340 /* --------------------------------------------------------------------------
1341  * Module storage:
1342  *
1343  * A Module represents a user defined module.
1344  *
1345  * Note: there are now two lookup mechanisms in the system:
1346  *
1347  * 1) The exports from a module are stored in a big list.
1348  *    We resolve qualified names, and import lists by linearly scanning
1349  *    through this list.
1350  *
1351  * 2) Unqualified imports and local definitions for the current module
1352  *    are stored in hash tables (tyconHash and nameHash) or linear lists
1353  *    (classes).
1354  *
1355  * ------------------------------------------------------------------------*/
1356
1357 static  Module   moduleHw;              /* next unused Module              */
1358 struct  Module   DEFTABLE(tabModule,NUM_MODULE); /* Module storage         */
1359 Module  currentModule;                  /* Module currently being processed*/
1360
1361 Bool isValidModule(m)                  /* is m a legitimate module id?     */
1362 Module m; {
1363     return (MODMIN <= m && m < moduleHw);
1364 }
1365
1366 Module newModule(t)                     /* add new module to module table  */
1367 Text t; {
1368     if (moduleHw-MODMIN >= NUM_MODULE) {
1369         ERRMSG(0) "Module storage space exhausted"
1370         EEND;
1371     }
1372     module(moduleHw).text             = t; /* clear new module record      */
1373     module(moduleHw).qualImports      = NIL;
1374     module(moduleHw).fake             = FALSE;
1375     module(moduleHw).exports          = NIL;
1376     module(moduleHw).tycons           = NIL;
1377     module(moduleHw).names            = NIL;
1378     module(moduleHw).classes          = NIL;
1379     module(moduleHw).object           = NULL;
1380     module(moduleHw).objectExtras     = NULL;
1381     module(moduleHw).objectExtraNames = NIL;
1382     return moduleHw++;
1383 }
1384
1385 void ppModules ( void )
1386 {
1387    Int i;
1388    fflush(stderr); fflush(stdout);
1389    printf ( "begin MODULES\n" );
1390    for (i = moduleHw-1; i >= MODMIN; i--)
1391       printf ( " %2d: %16s\n",
1392                i-MODMIN, textToStr(module(i).text)
1393              );
1394    printf ( "end   MODULES\n" );
1395    fflush(stderr); fflush(stdout);
1396 }
1397
1398
1399 Module findModule(t)                    /* locate Module in module table  */
1400 Text t; {
1401     Module m;
1402     for(m=MODMIN; m<moduleHw; ++m) {
1403         if (module(m).text==t)
1404             return m;
1405     }
1406     return NIL;
1407 }
1408
1409 Module findModid(c)                    /* Find module by name or filename  */
1410 Cell c; {
1411     switch (whatIs(c)) {
1412         case STRCELL   : { Script s = scriptThisFile(snd(c));
1413                            return (s==-1) ? NIL : moduleOfScript(s);
1414                          }
1415         case CONIDCELL : return findModule(textOf(c));
1416         default        : internal("findModid");
1417     }
1418     return NIL;/*NOTUSED*/
1419 }
1420
1421 static local Module findQualifier(t)    /* locate Module in import list   */
1422 Text t; {
1423     Module ms;
1424     for (ms=module(currentModule).qualImports; nonNull(ms); ms=tl(ms)) {
1425         if (textOf(fst(hd(ms)))==t)
1426             return snd(hd(ms));
1427     }
1428 #if 1 /* mpj */
1429     if (module(currentModule).text==t)
1430         return currentModule;
1431 #endif
1432     return NIL;
1433 }
1434
1435 Void setCurrModule(m)              /* set lookup tables for current module */
1436 Module m; {
1437     Int i;
1438     assert(isModule(m));
1439     if (m!=currentModule) {
1440         currentModule = m; /* This is the only assignment to currentModule */
1441         for (i=0; i<TYCONHSZ; ++i)
1442             tyconHash[i] = NIL;
1443         mapProc(hashTycon,module(m).tycons);
1444         for (i=0; i<NAMEHSZ; ++i)
1445             nameHash[i] = NIL;
1446         mapProc(hashName,module(m).names);
1447         classes = module(m).classes;
1448     }
1449 }
1450
1451 Name jrsFindQualName ( Text mn, Text sn )
1452 {
1453    Module m;
1454    List   ns;
1455
1456    for (m=MODMIN; m<moduleHw; m++)
1457       if (module(m).text == mn) break;
1458    if (m == moduleHw) return NIL;
1459
1460    for (ns = module(m).names; nonNull(ns); ns=tl(ns))
1461       if (name(hd(ns)).text == sn) return hd(ns);
1462
1463    return NIL;
1464 }
1465
1466
1467 char* nameFromOPtr ( void* p )
1468 {
1469    int i;
1470    Module m;
1471    for (m=MODMIN; m<moduleHw; m++) {
1472       char* nm = ocLookupAddr ( module(m).object, p );
1473       if (nm) return nm;
1474    }
1475    return NULL;
1476 }
1477
1478
1479 void* lookupOTabName ( Module m, char* sym )
1480 {
1481    return ocLookupSym ( module(m).object, sym );
1482 }
1483
1484
1485 void* lookupOExtraTabName ( char* sym )
1486 {
1487    ObjectCode* oc;
1488    Module      m;
1489    for (m = MODMIN; m < moduleHw; m++) {
1490       for (oc = module(m).objectExtras; oc; oc=oc->next) {
1491          void* ad = ocLookupSym ( oc, sym );
1492          if (ad) return ad;
1493       }
1494    }
1495    return NULL;
1496 }
1497
1498
1499 OSectionKind lookupSection ( void* ad )
1500 {
1501    int i;
1502    Module m;
1503    for (m=MODMIN; m<moduleHw; m++) {
1504       OSectionKind sect
1505          = ocLookupSection ( module(m).object, ad );
1506       if (sect != HUGS_SECTIONKIND_NOINFOAVAIL)
1507          return sect;
1508    }
1509    return HUGS_SECTIONKIND_OTHER;
1510 }
1511
1512
1513 /* --------------------------------------------------------------------------
1514  * Script file storage:
1515  *
1516  * script files are read into the system one after another.  The state of
1517  * the stored data structures (except the garbage-collected heap) is recorded
1518  * before reading a new script.  In the event of being unable to read the
1519  * script, or if otherwise requested, the system can be restored to its
1520  * original state immediately before the file was read.
1521  * ------------------------------------------------------------------------*/
1522
1523 typedef struct {                       /* record of storage state prior to */
1524     Text  file;                        /* reading script/module            */
1525     Text  textHw;
1526     Text  nextNewText;
1527     Text  nextNewDText;
1528     Module moduleHw;
1529     Tycon tyconHw;
1530     Name  nameHw;
1531     Class classHw;
1532     Inst  instHw;
1533 #if TREX
1534     Ext   extHw;
1535 #endif
1536 } script;
1537
1538 #ifdef  DEBUG_SHOWUSE
1539 static Void local showUse(msg,val,mx)
1540 String msg;
1541 Int val, mx; {
1542     Printf("%6s : %5d of %5d (%2d%%)\n",msg,val,mx,(100*val)/mx);
1543 }
1544 #endif
1545
1546 static Script scriptHw;                 /* next unused script number       */
1547 static script scripts[NUM_SCRIPTS];     /* storage for script records      */
1548
1549
1550 void ppScripts ( void )
1551 {
1552    Int i;
1553    fflush(stderr); fflush(stdout);
1554    printf ( "begin SCRIPTS\n" );
1555    for (i = scriptHw-1; i >= 0; i--)
1556       printf ( " %2d: %16s  tH=%d  mH=%d  yH=%d  "
1557                "nH=%d  cH=%d  iH=%d  nnS=%d,%d\n",
1558                i, textToStr(scripts[i].file),
1559                scripts[i].textHw, scripts[i].moduleHw,
1560                scripts[i].tyconHw, scripts[i].nameHw,
1561                scripts[i].classHw, scripts[i].instHw,
1562                scripts[i].nextNewText, scripts[i].nextNewDText
1563              );
1564    printf ( "end   SCRIPTS\n" );
1565    fflush(stderr); fflush(stdout);
1566 }
1567
1568 Script startNewScript(f)                /* start new script, keeping record */
1569 String f; {                             /* of status for later restoration  */
1570     if (scriptHw >= NUM_SCRIPTS) {
1571         ERRMSG(0) "Too many script files in use"
1572         EEND;
1573     }
1574 #ifdef DEBUG_SHOWUSE
1575     showUse("Text",   textHw,           NUM_TEXT);
1576     showUse("Module", moduleHw-MODMIN,  NUM_MODULE);
1577     showUse("Tycon",  tyconHw-TYCMIN,   NUM_TYCON);
1578     showUse("Name",   nameHw-NAMEMIN,   NUM_NAME);
1579     showUse("Class",  classHw-CLASSMIN, NUM_CLASSES);
1580     showUse("Inst",   instHw-INSTMIN,   NUM_INSTS);
1581 #if TREX
1582     showUse("Ext",    extHw-EXTMIN,     NUM_EXT);
1583 #endif
1584 #endif
1585     scripts[scriptHw].file         = findText( f ? f : "<nofile>" );
1586     scripts[scriptHw].textHw       = textHw;
1587     scripts[scriptHw].nextNewText  = nextNewText;
1588     scripts[scriptHw].nextNewDText = nextNewDText;
1589     scripts[scriptHw].moduleHw     = moduleHw;
1590     scripts[scriptHw].tyconHw      = tyconHw;
1591     scripts[scriptHw].nameHw       = nameHw;
1592     scripts[scriptHw].classHw      = classHw;
1593     scripts[scriptHw].instHw       = instHw;
1594 #if TREX
1595     scripts[scriptHw].extHw        = extHw;
1596 #endif
1597     return scriptHw++;
1598 }
1599
1600 Bool isPreludeScript() {                /* Test whether this is the Prelude*/
1601     return (scriptHw==0);
1602 }
1603
1604 Bool moduleThisScript(m)                /* Test if given module is defined */
1605 Module m; {                             /* in current script file          */
1606     return scriptHw<1 || m>=scripts[scriptHw-1].moduleHw;
1607 }
1608
1609 Module lastModule() {              /* Return module in current script file */
1610     return (moduleHw>MODMIN ? moduleHw-1 : modulePrelude);
1611 }
1612
1613 #define scriptThis(nm,t,tag)            Script nm(x)                       \
1614                                         t x; {                             \
1615                                             Script s=0;                    \
1616                                             while (s<scriptHw              \
1617                                                    && x>=scripts[s].tag)   \
1618                                                 s++;                       \
1619                                             return s;                      \
1620                                         }
1621 scriptThis(scriptThisName,Name,nameHw)
1622 scriptThis(scriptThisTycon,Tycon,tyconHw)
1623 scriptThis(scriptThisInst,Inst,instHw)
1624 scriptThis(scriptThisClass,Class,classHw)
1625 #undef scriptThis
1626
1627 Module moduleOfScript(s)
1628 Script s; {
1629     return (s==0) ? modulePrelude : scripts[s-1].moduleHw;
1630 }
1631
1632 String fileOfModule(m)
1633 Module m; {
1634     Script s;
1635     if (m == modulePrelude) {
1636         return STD_PRELUDE;
1637     }
1638     for(s=0; s<scriptHw; ++s) {
1639         if (scripts[s].moduleHw == m) {
1640             return textToStr(scripts[s].file);
1641         }
1642     }
1643     return 0;
1644 }
1645
1646 Script scriptThisFile(f)
1647 Text f; {
1648     Script s;
1649     for (s=0; s < scriptHw; ++s) {
1650         if (scripts[s].file == f) {
1651             return s+1;
1652         }
1653     }
1654     if (f == findText(STD_PRELUDE)) {
1655         return 0;
1656     }
1657     return (-1);
1658 }
1659
1660 Void dropScriptsFrom(sno)               /* Restore storage to state prior  */
1661 Script sno; {                           /* to reading script sno           */
1662     if (sno<scriptHw) {                 /* is there anything to restore?   */
1663         int i;
1664         textHw       = scripts[sno].textHw;
1665         nextNewText  = scripts[sno].nextNewText;
1666         nextNewDText = scripts[sno].nextNewDText;
1667         moduleHw     = scripts[sno].moduleHw;
1668         tyconHw      = scripts[sno].tyconHw;
1669         nameHw       = scripts[sno].nameHw;
1670         classHw      = scripts[sno].classHw;
1671         instHw       = scripts[sno].instHw;
1672 #if USE_DICTHW
1673         dictHw       = scripts[sno].dictHw;
1674 #endif
1675 #if TREX
1676         extHw        = scripts[sno].extHw;
1677 #endif
1678
1679 #if 0
1680         for (i=moduleHw; i >= scripts[sno].moduleHw; --i) {
1681             if (module(i).objectFile) {
1682                 printf("[bogus] closing objectFile for module %d\n",i);
1683                 /*dlclose(module(i).objectFile);*/
1684             }
1685         }
1686         moduleHw = scripts[sno].moduleHw;
1687 #endif
1688         for (i=0; i<TEXTHSZ; ++i) {
1689             int j = 0;
1690             while (j<NUM_TEXTH && textHash[i][j]!=NOTEXT
1691                                && textHash[i][j]<textHw)
1692                 ++j;
1693             if (j<NUM_TEXTH)
1694                 textHash[i][j] = NOTEXT;
1695         }
1696
1697         currentModule=NIL;
1698         for (i=0; i<TYCONHSZ; ++i) {
1699             tyconHash[i] = NIL;
1700         }
1701         for (i=0; i<NAMEHSZ; ++i) {
1702             nameHash[i] = NIL;
1703         }
1704
1705         for (i=CLASSMIN; i<classHw; i++) {
1706             List ins = cclass(i).instances;
1707             List is  = NIL;
1708
1709             while (nonNull(ins)) {
1710                 List temp = tl(ins);
1711                 if (hd(ins)<instHw) {
1712                     tl(ins) = is;
1713                     is      = ins;
1714                 }
1715                 ins = temp;
1716             }
1717             cclass(i).instances = rev(is);
1718         }
1719
1720         scriptHw = sno;
1721     }
1722 }
1723
1724 /* --------------------------------------------------------------------------
1725  * Heap storage:
1726  *
1727  * Provides a garbage collectable heap for storage of expressions etc.
1728  *
1729  * Now incorporates a flat resource:  A two-space collected extension of
1730  * the heap that provides storage for contiguous arrays of Cell storage,
1731  * cooperating with the garbage collection mechanisms for the main heap.
1732  * ------------------------------------------------------------------------*/
1733
1734 Int     heapSize = DEFAULTHEAP;         /* number of cells in heap         */
1735 Heap    heapFst;                        /* array of fst component of pairs */
1736 Heap    heapSnd;                        /* array of snd component of pairs */
1737 #ifndef GLOBALfst
1738 Heap    heapTopFst;
1739 #endif
1740 #ifndef GLOBALsnd
1741 Heap    heapTopSnd;
1742 #endif
1743 Bool    consGC = TRUE;                  /* Set to FALSE to turn off gc from*/
1744                                         /* C stack; use with extreme care! */
1745 Long    numCells;
1746 Int     numGcs;                         /* number of garbage collections   */
1747 Int     cellsRecovered;                 /* number of cells recovered       */
1748
1749 static  Cell freeList;                  /* free list of unused cells       */
1750 static  Cell lsave, rsave;              /* save components of pair         */
1751
1752 #if GC_STATISTICS
1753
1754 static Int markCount, stackRoots;
1755
1756 #define initStackRoots() stackRoots = 0
1757 #define recordStackRoot() stackRoots++
1758
1759 #define startGC()       \
1760     if (gcMessages) {   \
1761         Printf("\n");   \
1762         fflush(stdout); \
1763     }
1764 #define endGC()         \
1765     if (gcMessages) {   \
1766         Printf("\n");   \
1767         fflush(stdout); \
1768     }
1769
1770 #define start()      markCount = 0
1771 #define end(thing,rs) \
1772     if (gcMessages) { \
1773         Printf("GC: %-18s: %4d cells, %4d roots.\n", thing, markCount, rs); \
1774         fflush(stdout); \
1775     }
1776 #define recordMark() markCount++
1777
1778 #else /* !GC_STATISTICS */
1779
1780 #define startGC()
1781 #define endGC()
1782
1783 #define initStackRoots()
1784 #define recordStackRoot()
1785
1786 #define start()
1787 #define end(thing,root)
1788 #define recordMark()
1789
1790 #endif /* !GC_STATISTICS */
1791
1792 Cell pair(l,r)                          /* Allocate pair (l, r) from       */
1793 Cell l, r; {                            /* heap, garbage collecting first  */
1794     Cell c = freeList;                  /* if necessary ...                */
1795
1796     if (isNull(c)) {
1797         lsave = l;
1798         rsave = r;
1799         garbageCollect();
1800         l     = lsave;
1801         lsave = NIL;
1802         r     = rsave;
1803         rsave = NIL;
1804         c     = freeList;
1805     }
1806     freeList = snd(freeList);
1807     fst(c)   = l;
1808     snd(c)   = r;
1809     numCells++;
1810     return c;
1811 }
1812
1813 Void overwrite(dst,src)                 /* overwrite dst cell with src cell*/
1814 Cell dst, src; {                        /* both *MUST* be pairs            */
1815     if (isPair(dst) && isPair(src)) {
1816         fst(dst) = fst(src);
1817         snd(dst) = snd(src);
1818     }
1819     else
1820         internal("overwrite");
1821 }
1822
1823 static Int *marks;
1824 static Int marksSize;
1825
1826 Cell markExpr(c)                        /* External interface to markCell  */
1827 Cell c; {
1828     return isGenPair(c) ? markCell(c) : c;
1829 }
1830
1831 static Cell local markCell(c)           /* Traverse part of graph marking  */
1832 Cell c; {                               /* cells reachable from given root */
1833                                         /* markCell(c) is only called if c */
1834                                         /* is a pair                       */
1835     {   register int place = placeInSet(c);
1836         register int mask  = maskInSet(c);
1837         if (marks[place]&mask)
1838             return c;
1839         else {
1840             marks[place] |= mask;
1841             recordMark();
1842         }
1843     }
1844
1845     /* STACK_CHECK: Avoid stack overflows during recursive marking. */
1846     if (isGenPair(fst(c))) {
1847         STACK_CHECK
1848         fst(c) = markCell(fst(c));
1849         markSnd(c);
1850     }
1851     else if (isNull(fst(c)) || fst(c)>=BCSTAG) {
1852         STACK_CHECK
1853         markSnd(c);
1854     }
1855
1856     return c;
1857 }
1858
1859 static Void local markSnd(c)            /* Variant of markCell used to     */
1860 Cell c; {                               /* update snd component of cell    */
1861     Cell t;                             /* using tail recursion            */
1862
1863 ma: t = c;                              /* Keep pointer to original pair   */
1864     c = snd(c);
1865     if (!isPair(c))
1866         return;
1867
1868     {   register int place = placeInSet(c);
1869         register int mask  = maskInSet(c);
1870         if (marks[place]&mask)
1871             return;
1872         else {
1873             marks[place] |= mask;
1874             recordMark();
1875         }
1876     }
1877
1878     if (isGenPair(fst(c))) {
1879         fst(c) = markCell(fst(c));
1880         goto ma;
1881     }
1882     else if (isNull(fst(c)) || fst(c)>=BCSTAG)
1883         goto ma;
1884     return;
1885 }
1886
1887 Void markWithoutMove(n)                 /* Garbage collect cell at n, as if*/
1888 Cell n; {                               /* it was a cell ref, but don't    */
1889                                         /* move cell so we don't have      */
1890                                         /* to modify the stored value of n */
1891     if (isGenPair(n)) {
1892         recordStackRoot();
1893         markCell(n);
1894     }
1895 }
1896
1897 Void garbageCollect()     {             /* Run garbage collector ...       */
1898     Bool breakStat = breakOn(FALSE);    /* disable break checking          */
1899     Int i,j;
1900     register Int mask;
1901     register Int place;
1902     Int      recovered;
1903
1904     jmp_buf  regs;                      /* save registers on stack         */
1905     setjmp(regs);
1906
1907     gcStarted();
1908     for (i=0; i<marksSize; ++i)         /* initialise mark set to empty    */
1909         marks[i] = 0;
1910
1911     everybody(MARK);                    /* Mark all components of system   */
1912
1913     gcScanning();                       /* scan mark set                   */
1914     mask      = 1;
1915     place     = 0;
1916     recovered = 0;
1917     j         = 0;
1918
1919     freeList = NIL;
1920     for (i=1; i<=heapSize; i++) {
1921         if ((marks[place] & mask) == 0) {
1922             snd(-i)  = freeList;
1923             fst(-i)  = FREECELL;
1924             freeList = -i;
1925             recovered++;
1926         }
1927         mask <<= 1;
1928         if (++j == bitsPerWord) {
1929             place++;
1930             mask = 1;
1931             j    = 0;
1932         }
1933     }
1934
1935     gcRecovered(recovered);
1936     breakOn(breakStat);                 /* restore break trapping if nec.  */
1937
1938     everybody(GCDONE);
1939
1940     /* can only return if freeList is nonempty on return. */
1941     if (recovered<minRecovery || isNull(freeList)) {
1942         ERRMSG(0) "Garbage collection fails to reclaim sufficient space"
1943         EEND;
1944     }
1945     cellsRecovered = recovered;
1946 }
1947
1948 /* --------------------------------------------------------------------------
1949  * Code for saving last expression entered:
1950  *
1951  * This is a little tricky because some text values (e.g. strings or variable
1952  * names) may not be defined or have the same value when the expression is
1953  * recalled.  These text values are therefore saved in the top portion of
1954  * the text table.
1955  * ------------------------------------------------------------------------*/
1956
1957 static Cell lastExprSaved;              /* last expression to be saved     */
1958
1959 Void setLastExpr(e)                     /* save expression for later recall*/
1960 Cell e; {
1961     lastExprSaved = NIL;                /* in case attempt to save fails   */
1962     savedText     = NUM_TEXT;
1963     lastExprSaved = lowLevelLastIn(e);
1964 }
1965
1966 static Cell local lowLevelLastIn(c)     /* Duplicate expression tree (i.e. */
1967 Cell c; {                               /* acyclic graph) for later recall */
1968     if (isPair(c)) {                    /* Duplicating any text strings    */
1969         if (isBoxTag(fst(c)))           /* in case these are lost at some  */
1970             switch (fst(c)) {           /* point before the expr is reused */
1971                 case VARIDCELL :
1972                 case VAROPCELL :
1973                 case DICTVAR   :
1974                 case CONIDCELL :
1975                 case CONOPCELL :
1976                 case STRCELL   : return pair(fst(c),saveText(textOf(c)));
1977                 default        : return pair(fst(c),snd(c));
1978             }
1979         else
1980             return pair(lowLevelLastIn(fst(c)),lowLevelLastIn(snd(c)));
1981     }
1982 #if TREX
1983     else if (isExt(c))
1984         return pair(EXTCOPY,saveText(extText(c)));
1985 #endif
1986     else
1987         return c;
1988 }
1989
1990 Cell getLastExpr() {                    /* recover previously saved expr   */
1991     return lowLevelLastOut(lastExprSaved);
1992 }
1993
1994 static Cell local lowLevelLastOut(c)    /* As with lowLevelLastIn() above  */
1995 Cell c; {                               /* except that Cells refering to   */
1996     if (isPair(c)) {                    /* Text values are restored to     */
1997         if (isBoxTag(fst(c)))           /* appropriate values              */
1998             switch (fst(c)) {
1999                 case VARIDCELL :
2000                 case VAROPCELL :
2001                 case DICTVAR   :
2002                 case CONIDCELL :
2003                 case CONOPCELL :
2004                 case STRCELL   : return pair(fst(c),
2005                                              findText(text+intValOf(c)));
2006 #if TREX
2007                 case EXTCOPY   : return mkExt(findText(text+intValOf(c)));
2008 #endif
2009                 default        : return pair(fst(c),snd(c));
2010             }
2011         else
2012             return pair(lowLevelLastOut(fst(c)),lowLevelLastOut(snd(c)));
2013     }
2014     else
2015         return c;
2016 }
2017
2018 /* --------------------------------------------------------------------------
2019  * Miscellaneous operations on heap cells:
2020  * ------------------------------------------------------------------------*/
2021
2022 /* Profiling suggests that the number of calls to whatIs() is typically    */
2023 /* rather high.  The recoded version below attempts to improve the average */
2024 /* performance for whatIs() using a binary search for part of the analysis */
2025
2026 Cell whatIs(c)                         /* identify type of cell            */
2027 register Cell c; {
2028     if (isPair(c)) {
2029         register Cell fstc = fst(c);
2030         return isTag(fstc) ? fstc : AP;
2031     }
2032     if (c<OFFMIN)    return c;
2033 #if TREX
2034     if (isExt(c))    return EXT;
2035 #endif
2036     if (c>=INTMIN)   return INTCELL;
2037
2038     if (c>=NAMEMIN){if (c>=CLASSMIN)   {if (c>=CHARMIN) return CHARCELL;
2039                                         else            return CLASS;}
2040                     else                if (c>=INSTMIN) return INSTANCE;
2041                                         else            return NAME;}
2042     else            if (c>=MODMIN)     {if (c>=TYCMIN)  return isTuple(c) ? TUPLE : TYCON;
2043                                         else            return MODULE;}
2044                     else                if (c>=OFFMIN)  return OFFSET;
2045 #if TREX
2046                                         else            return (c>=EXTMIN) ?
2047                                                                 EXT : TUPLE;
2048 #else
2049                                         else            return TUPLE;
2050 #endif
2051
2052 /*  if (isPair(c)) {
2053         register Cell fstc = fst(c);
2054         return isTag(fstc) ? fstc : AP;
2055     }
2056     if (c>=INTMIN)   return INTCELL;
2057     if (c>=CHARMIN)  return CHARCELL;
2058     if (c>=CLASSMIN) return CLASS;
2059     if (c>=INSTMIN)  return INSTANCE;
2060     if (c>=NAMEMIN)  return NAME;
2061     if (c>=TYCMIN)   return TYCON;
2062     if (c>=MODMIN)   return MODULE;
2063     if (c>=OFFMIN)   return OFFSET;
2064 #if TREX
2065     if (c>=EXTMIN)   return EXT;
2066 #endif
2067     if (c>=TUPMIN)   return TUPLE;
2068     return c;*/
2069 }
2070
2071 #if DEBUG_PRINTER
2072 /* A very, very simple printer.
2073  * Output is uglier than from printExp - but the printer is more
2074  * robust and can be used on any data structure irrespective of
2075  * its type.
2076  */
2077 Void print Args((Cell, Int));
2078 Void print(c, depth)
2079 Cell c;
2080 Int  depth; {
2081     if (0 == depth) {
2082         Printf("...");
2083 #if 0 /* Not in this version of Hugs */
2084     } else if (isPair(c) && !isGenPair(c)) {
2085         extern Void printEvalCell Args((Cell, Int));
2086         printEvalCell(c,depth);
2087 #endif
2088     } else {
2089         Int tag = whatIs(c);
2090         switch (tag) {
2091         case AP:
2092                 Putchar('(');
2093                 print(fst(c), depth-1);
2094                 Putchar(',');
2095                 print(snd(c), depth-1);
2096                 Putchar(')');
2097                 break;
2098         case FREECELL:
2099                 Printf("free(%d)", c);
2100                 break;
2101         case INTCELL:
2102                 Printf("int(%d)", intOf(c));
2103                 break;
2104         case BIGCELL:
2105                 Printf("bignum(%s)", bignumToString(c));
2106                 break;
2107         case CHARCELL:
2108                 Printf("char('%c')", charOf(c));
2109                 break;
2110         case PTRCELL:
2111                 Printf("ptr(%p)",ptrOf(c));
2112                 break;
2113         case CLASS:
2114                 Printf("class(%d)", c-CLASSMIN);
2115                 if (CLASSMIN <= c && c < classHw) {
2116                     Printf("=\"%s\"", textToStr(cclass(c).text));
2117                 }
2118                 break;
2119         case INSTANCE:
2120                 Printf("instance(%d)", c - INSTMIN);
2121                 break;
2122         case NAME:
2123                 Printf("name(%d)", c-NAMEMIN);
2124                 if (NAMEMIN <= c && c < nameHw) {
2125                     Printf("=\"%s\"", textToStr(name(c).text));
2126                 }
2127                 break;
2128         case TYCON:
2129                 Printf("tycon(%d)", c-TYCMIN);
2130                 if (TYCMIN <= c && c < tyconHw)
2131                     Printf("=\"%s\"", textToStr(tycon(c).text));
2132                 break;
2133         case MODULE:
2134                 Printf("module(%d)", c - MODMIN);
2135                 break;
2136         case OFFSET:
2137                 Printf("Offset %d", offsetOf(c));
2138                 break;
2139         case TUPLE:
2140                 Printf("%s", textToStr(ghcTupleText(c)));
2141                 break;
2142         case POLYTYPE:
2143                 Printf("Polytype");
2144                 print(snd(c),depth-1);
2145                 break;
2146         case QUAL:
2147                 Printf("Qualtype");
2148                 print(snd(c),depth-1);
2149                 break;
2150         case RANK2:
2151                 Printf("Rank2(");
2152                 if (isPair(snd(c)) && isInt(fst(snd(c)))) {
2153                     Printf("%d ", intOf(fst(snd(c))));
2154                     print(snd(snd(c)),depth-1);
2155                 } else {
2156                     print(snd(c),depth-1);
2157                 }
2158                 Printf(")");
2159                 break;
2160         case NIL:
2161                 Printf("NIL");
2162                 break;
2163         case WILDCARD:
2164                 Printf("_");
2165                 break;
2166         case STAR:
2167                 Printf("STAR");
2168                 break;
2169         case DOTDOT:
2170                 Printf("DOTDOT");
2171                 break;
2172         case DICTVAR:
2173                 Printf("{dict %d}",textOf(c));
2174                 break;
2175         case VARIDCELL:
2176         case VAROPCELL:
2177         case CONIDCELL:
2178         case CONOPCELL:
2179                 Printf("{id %s}",textToStr(textOf(c)));
2180                 break;
2181 #if IPARAM
2182           case IPCELL :
2183               Printf("{ip %s}",textToStr(textOf(c)));
2184               break;
2185           case IPVAR :
2186               Printf("?%s",textToStr(textOf(c)));
2187               break;
2188 #endif
2189         case QUALIDENT:
2190                 Printf("{qid %s.%s}",textToStr(qmodOf(c)),textToStr(qtextOf(c)));
2191                 break;
2192         case LETREC:
2193                 Printf("LetRec(");
2194                 print(fst(snd(c)),depth-1);
2195                 Putchar(',');
2196                 print(snd(snd(c)),depth-1);
2197                 Putchar(')');
2198                 break;
2199         case LAMBDA:
2200                 Printf("Lambda(");
2201                 print(snd(c),depth-1);
2202                 Putchar(')');
2203                 break;
2204         case FINLIST:
2205                 Printf("FinList(");
2206                 print(snd(c),depth-1);
2207                 Putchar(')');
2208                 break;
2209         case COMP:
2210                 Printf("Comp(");
2211                 print(fst(snd(c)),depth-1);
2212                 Putchar(',');
2213                 print(snd(snd(c)),depth-1);
2214                 Putchar(')');
2215                 break;
2216         case ASPAT:
2217                 Printf("AsPat(");
2218                 print(fst(snd(c)),depth-1);
2219                 Putchar(',');
2220                 print(snd(snd(c)),depth-1);
2221                 Putchar(')');
2222                 break;
2223         case FROMQUAL:
2224                 Printf("FromQual(");
2225                 print(fst(snd(c)),depth-1);
2226                 Putchar(',');
2227                 print(snd(snd(c)),depth-1);
2228                 Putchar(')');
2229                 break;
2230         case STGVAR:
2231                 Printf("StgVar%d=",-c);
2232                 print(snd(c), depth-1);
2233                 break;
2234         case STGAPP:
2235                 Printf("StgApp(");
2236                 print(fst(snd(c)),depth-1);
2237                 Putchar(',');
2238                 print(snd(snd(c)),depth-1);
2239                 Putchar(')');
2240                 break;
2241         case STGPRIM:
2242                 Printf("StgPrim(");
2243                 print(fst(snd(c)),depth-1);
2244                 Putchar(',');
2245                 print(snd(snd(c)),depth-1);
2246                 Putchar(')');
2247                 break;
2248         case STGCON:
2249                 Printf("StgCon(");
2250                 print(fst(snd(c)),depth-1);
2251                 Putchar(',');
2252                 print(snd(snd(c)),depth-1);
2253                 Putchar(')');
2254                 break;
2255         case PRIMCASE:
2256                 Printf("PrimCase(");
2257                 print(fst(snd(c)),depth-1);
2258                 Putchar(',');
2259                 print(snd(snd(c)),depth-1);
2260                 Putchar(')');
2261                 break;
2262         case DICTAP:
2263                 Printf("(DICTAP,");
2264                 print(snd(c),depth-1);
2265                 Putchar(')');
2266                 break;
2267         case UNBOXEDTUP:
2268                 Printf("(UNBOXEDTUP,");
2269                 print(snd(c),depth-1);
2270                 Putchar(')');
2271                 break;
2272         case ZTUP2:
2273                 Printf("<ZPair ");
2274                 print(zfst(c),depth-1);
2275                 Putchar(' ');
2276                 print(zsnd(c),depth-1);
2277                 Putchar('>');
2278                 break;
2279         case ZTUP3:
2280                 Printf("<ZTriple ");
2281                 print(zfst3(c),depth-1);
2282                 Putchar(' ');
2283                 print(zsnd3(c),depth-1);
2284                 Putchar(' ');
2285                 print(zthd3(c),depth-1);
2286                 Putchar('>');
2287                 break;
2288         case BANG:
2289                 Printf("(BANG,");
2290                 print(snd(c),depth-1);
2291                 Putchar(')');
2292                 break;
2293         default:
2294                 if (isBoxTag(tag)) {
2295                     Printf("Tag(%d)=%d", c, tag);
2296                 } else if (isConTag(tag)) {
2297                     Printf("%d@(%d,",c,tag);
2298                     print(snd(c), depth-1);
2299                     Putchar(')');
2300                     break;
2301                 } else if (c == tag) {
2302                     Printf("Tag(%d)", c);
2303                 } else {
2304                     Printf("Tag(%d)=%d", c, tag);
2305                 }
2306                 break;
2307         }
2308     }
2309     FlushStdout();
2310 }
2311 #endif
2312
2313 Bool isVar(c)                           /* is cell a VARIDCELL/VAROPCELL ? */
2314 Cell c; {                               /* also recognises DICTVAR cells   */
2315     return isPair(c) &&
2316                (fst(c)==VARIDCELL || fst(c)==VAROPCELL || fst(c)==DICTVAR);
2317 }
2318
2319 Bool isCon(c)                          /* is cell a CONIDCELL/CONOPCELL ?  */
2320 Cell c; {
2321     return isPair(c) && (fst(c)==CONIDCELL || fst(c)==CONOPCELL);
2322 }
2323
2324 Bool isQVar(c)                        /* is cell a [un]qualified varop/id? */
2325 Cell c; {
2326     if (!isPair(c)) return FALSE;
2327     switch (fst(c)) {
2328         case VARIDCELL  :
2329         case VAROPCELL  : return TRUE;
2330
2331         case QUALIDENT  : return isVar(snd(snd(c)));
2332
2333         default         : return FALSE;
2334     }
2335 }
2336
2337 Bool isQCon(c)                         /*is cell a [un]qualified conop/id? */
2338 Cell c; {
2339     if (!isPair(c)) return FALSE;
2340     switch (fst(c)) {
2341         case CONIDCELL  :
2342         case CONOPCELL  : return TRUE;
2343
2344         case QUALIDENT  : return isCon(snd(snd(c)));
2345
2346         default         : return FALSE;
2347     }
2348 }
2349
2350 Bool isQualIdent(c)                    /* is cell a qualified identifier?  */
2351 Cell c; {
2352     return isPair(c) && (fst(c)==QUALIDENT);
2353 }
2354
2355 Bool eqQualIdent ( QualId c1, QualId c2 )
2356 {
2357    assert(isQualIdent(c1));
2358    if (!isQualIdent(c2)) {
2359    assert(isQualIdent(c2));
2360    }
2361    return qmodOf(c1)==qmodOf(c2) &&
2362           qtextOf(c1)==qtextOf(c2);
2363 }
2364
2365 Bool isIdent(c)                        /* is cell an identifier?           */
2366 Cell c; {
2367     if (!isPair(c)) return FALSE;
2368     switch (fst(c)) {
2369         case VARIDCELL  :
2370         case VAROPCELL  :
2371         case CONIDCELL  :
2372         case CONOPCELL  : return TRUE;
2373
2374         case QUALIDENT  : return TRUE;
2375
2376         default         : return FALSE;
2377     }
2378 }
2379
2380 Bool isInt(c)                          /* cell holds integer value?        */
2381 Cell c; {
2382     return isSmall(c) || (isPair(c) && fst(c)==INTCELL);
2383 }
2384
2385 Int intOf(c)                           /* find integer value of cell?      */
2386 Cell c; {
2387   if (!isInt(c)) {
2388     assert(isInt(c)); }
2389     return isPair(c) ? (Int)(snd(c)) : (Int)(c-INTZERO);
2390 }
2391
2392 Cell mkInt(n)                          /* make cell representing integer   */
2393 Int n; {
2394     return (MINSMALLINT <= n && n <= MAXSMALLINT)
2395            ? INTZERO+n
2396            : pair(INTCELL,n);
2397 }
2398
2399 #if SIZEOF_INTP == SIZEOF_INT
2400 typedef union {Int i; Ptr p;} IntOrPtr;
2401 Cell mkPtr(p)
2402 Ptr p;
2403 {
2404     IntOrPtr x;
2405     x.p = p;
2406     return pair(PTRCELL,x.i);
2407 }
2408
2409 Ptr ptrOf(c)
2410 Cell c;
2411 {
2412     IntOrPtr x;
2413     assert(fst(c) == PTRCELL);
2414     x.i = snd(c);
2415     return x.p;
2416 }
2417 Cell mkCPtr(p)
2418 Ptr p;
2419 {
2420     IntOrPtr x;
2421     x.p = p;
2422     return pair(CPTRCELL,x.i);
2423 }
2424
2425 Ptr cptrOf(c)
2426 Cell c;
2427 {
2428     IntOrPtr x;
2429     assert(fst(c) == CPTRCELL);
2430     x.i = snd(c);
2431     return x.p;
2432 }
2433 #elif SIZEOF_INTP == 2*SIZEOF_INT
2434 typedef union {struct {Int i1; Int i2;} i; Ptr p;} IntOrPtr;
2435 Cell mkPtr(p)
2436 Ptr p;
2437 {
2438     IntOrPtr x;
2439     x.p = p;
2440     return pair(PTRCELL,pair(mkInt(x.i.i1),mkInt(x.i.i2)));
2441 }
2442
2443 Ptr ptrOf(c)
2444 Cell c;
2445 {
2446     IntOrPtr x;
2447     assert(fst(c) == PTRCELL);
2448     x.i.i1 = intOf(fst(snd(c)));
2449     x.i.i2 = intOf(snd(snd(c)));
2450     return x.p;
2451 }
2452 #else
2453 #warning "type Addr not supported on this architecture - don't use it"
2454 Cell mkPtr(p)
2455 Ptr p;
2456 {
2457     ERRMSG(0) "mkPtr: type Addr not supported on this architecture"
2458     EEND;
2459 }
2460
2461 Ptr ptrOf(c)
2462 Cell c;
2463 {
2464     ERRMSG(0) "ptrOf: type Addr not supported on this architecture"
2465     EEND;
2466 }
2467 #endif
2468
2469 String stringNegate( s )
2470 String s;
2471 {
2472     if (s[0] == '-') {
2473         return &s[1];
2474     } else {
2475         static char t[100];
2476         t[0] = '-';
2477         strcpy(&t[1],s);  /* ToDo: use strncpy instead */
2478         return t;
2479     }
2480 }
2481
2482 /* --------------------------------------------------------------------------
2483  * List operations:
2484  * ------------------------------------------------------------------------*/
2485
2486 Int length(xs)                         /* calculate length of list xs      */
2487 List xs; {
2488     Int n = 0;
2489     for (; nonNull(xs); ++n)
2490         xs = tl(xs);
2491     return n;
2492 }
2493
2494 List appendOnto(xs,ys)                 /* Destructively prepend xs onto    */
2495 List xs, ys; {                         /* ys by modifying xs ...           */
2496     if (isNull(xs))
2497         return ys;
2498     else {
2499         List zs = xs;
2500         while (nonNull(tl(zs)))
2501             zs = tl(zs);
2502         tl(zs) = ys;
2503         return xs;
2504     }
2505 }
2506
2507 List dupOnto(xs,ys)      /* non-destructively prepend xs backwards onto ys */
2508 List xs;
2509 List ys; {
2510     for (; nonNull(xs); xs=tl(xs))
2511         ys = cons(hd(xs),ys);
2512     return ys;
2513 }
2514
2515 List dupListOnto(xs,ys)              /* Duplicate spine of list xs onto ys */
2516 List xs;
2517 List ys; {
2518     return revOnto(dupOnto(xs,NIL),ys);
2519 }
2520
2521 List dupList(xs)                       /* Duplicate spine of list xs       */
2522 List xs; {
2523     List ys = NIL;
2524     for (; nonNull(xs); xs=tl(xs))
2525         ys = cons(hd(xs),ys);
2526     return rev(ys);
2527 }
2528
2529 List revOnto(xs,ys)                    /* Destructively reverse elements of*/
2530 List xs, ys; {                         /* list xs onto list ys...          */
2531     Cell zs;
2532
2533     while (nonNull(xs)) {
2534         zs     = tl(xs);
2535         tl(xs) = ys;
2536         ys     = xs;
2537         xs     = zs;
2538     }
2539     return ys;
2540 }
2541
2542 QualId qualidIsMember ( QualId q, List xs )
2543 {
2544    for (; nonNull(xs); xs=tl(xs)) {
2545       if (eqQualIdent(q, hd(xs)))
2546          return hd(xs);
2547    }
2548    return NIL;
2549 }
2550
2551 Cell varIsMember(t,xs)                 /* Test if variable is a member of  */
2552 Text t;                                /* given list of variables          */
2553 List xs; {
2554     for (; nonNull(xs); xs=tl(xs))
2555         if (t==textOf(hd(xs)))
2556             return hd(xs);
2557     return NIL;
2558 }
2559
2560 Name nameIsMember(t,ns)                 /* Test if name with text t is a   */
2561 Text t;                                 /* member of list of names xs      */
2562 List ns; {
2563     for (; nonNull(ns); ns=tl(ns))
2564         if (t==name(hd(ns)).text)
2565             return hd(ns);
2566     return NIL;
2567 }
2568
2569 Cell intIsMember(n,xs)                 /* Test if integer n is member of   */
2570 Int  n;                                /* given list of integers           */
2571 List xs; {
2572     for (; nonNull(xs); xs=tl(xs))
2573         if (n==intOf(hd(xs)))
2574             return hd(xs);
2575     return NIL;
2576 }
2577
2578 Cell cellIsMember(x,xs)                /* Test for membership of specific  */
2579 Cell x;                                /* cell x in list xs                */
2580 List xs; {
2581     for (; nonNull(xs); xs=tl(xs))
2582         if (x==hd(xs))
2583             return hd(xs);
2584     return NIL;
2585 }
2586
2587 Cell cellAssoc(c,xs)                   /* Lookup cell in association list  */
2588 Cell c;
2589 List xs; {
2590     for (; nonNull(xs); xs=tl(xs))
2591         if (c==fst(hd(xs)))
2592             return hd(xs);
2593     return NIL;
2594 }
2595
2596 Cell cellRevAssoc(c,xs)                /* Lookup cell in range of          */
2597 Cell c;                                /* association lists                */
2598 List xs; {
2599     for (; nonNull(xs); xs=tl(xs))
2600         if (c==snd(hd(xs)))
2601             return hd(xs);
2602     return NIL;
2603 }
2604
2605 List replicate(n,x)                     /* create list of n copies of x    */
2606 Int n;
2607 Cell x; {
2608     List xs=NIL;
2609     while (0<n--)
2610         xs = cons(x,xs);
2611     return xs;
2612 }
2613
2614 List diffList(from,take)               /* list difference: from\take       */
2615 List from, take; {                     /* result contains all elements of  */
2616     List result = NIL;                 /* `from' not appearing in `take'   */
2617
2618     while (nonNull(from)) {
2619         List next = tl(from);
2620         if (!cellIsMember(hd(from),take)) {
2621             tl(from) = result;
2622             result   = from;
2623         }
2624         from = next;
2625     }
2626     return rev(result);
2627 }
2628
2629 List deleteCell(xs, y)                  /* copy xs deleting pointers to y  */
2630 List xs;
2631 Cell y; {
2632     List result = NIL;
2633     for(;nonNull(xs);xs=tl(xs)) {
2634         Cell x = hd(xs);
2635         if (x != y) {
2636             result=cons(x,result);
2637         }
2638     }
2639     return rev(result);
2640 }
2641
2642 List take(n,xs)                         /* destructively truncate list to  */
2643 Int  n;                                 /* specified length                */
2644 List xs; {
2645     List ys = xs;
2646
2647     if (n==0)
2648         return NIL;
2649     while (1<n-- && nonNull(xs))
2650         xs = tl(xs);
2651     if (nonNull(xs))
2652         tl(xs) = NIL;
2653     return ys;
2654 }
2655
2656 List splitAt(n,xs)                      /* drop n things from front of list*/
2657 Int  n;
2658 List xs; {
2659     for(; n>0; --n) {
2660         xs = tl(xs);
2661     }
2662     return xs;
2663 }
2664
2665 Cell nth(n,xs)                          /* extract n'th element of list    */
2666 Int  n;
2667 List xs; {
2668     for(; n>0 && nonNull(xs); --n, xs=tl(xs)) {
2669     }
2670     if (isNull(xs))
2671         internal("nth");
2672     return hd(xs);
2673 }
2674
2675 List removeCell(x,xs)                   /* destructively remove cell from  */
2676 Cell x;                                 /* list                            */
2677 List xs; {
2678     if (nonNull(xs)) {
2679         if (hd(xs)==x)
2680             return tl(xs);              /* element at front of list        */
2681         else {
2682             List prev = xs;
2683             List curr = tl(xs);
2684             for (; nonNull(curr); prev=curr, curr=tl(prev))
2685                 if (hd(curr)==x) {
2686                     tl(prev) = tl(curr);
2687                     return xs;          /* element in middle of list       */
2688                 }
2689         }
2690     }
2691     return xs;                          /* here if element not found       */
2692 }
2693
2694 List nubList(xs)                        /* nuke dups in list               */
2695 List xs; {                              /* non destructive                 */
2696    List outs = NIL;
2697    for (; nonNull(xs); xs=tl(xs))
2698       if (isNull(cellIsMember(hd(xs),outs)))
2699          outs = cons(hd(xs),outs);
2700    outs = rev(outs);
2701    return outs;
2702 }
2703
2704
2705 /* --------------------------------------------------------------------------
2706  * Strongly-typed lists (z-lists) and tuples (experimental)
2707  * ------------------------------------------------------------------------*/
2708
2709 static void z_tag_check ( Cell x, int tag, char* caller )
2710 {
2711    char buf[100];
2712    if (isNull(x)) {
2713       sprintf(buf,"z_tag_check(%s): null\n", caller);
2714       internal(buf);
2715    }
2716    if (whatIs(x) != tag) {
2717       sprintf(buf,
2718           "z_tag_check(%s): tag was %d, expected %d\n",
2719           caller, whatIs(x), tag );
2720       internal(buf);
2721    }
2722 }
2723
2724 #if 0
2725 Cell zcons ( Cell x, Cell xs )
2726 {
2727    if (!(isNull(xs) || whatIs(xs)==ZCONS))
2728       internal("zcons: ill typed tail");
2729    return ap(ZCONS,ap(x,xs));
2730 }
2731
2732 Cell zhd ( Cell xs )
2733 {
2734    if (isNull(xs)) internal("zhd: empty list");
2735    z_tag_check(xs,ZCONS,"zhd");
2736    return fst( snd(xs) );
2737 }
2738
2739 Cell ztl ( Cell xs )
2740 {
2741    if (isNull(xs)) internal("ztl: empty list");
2742    z_tag_check(xs,ZCONS,"zhd");
2743    return snd( snd(xs) );
2744 }
2745
2746 Int zlength ( ZList xs )
2747 {
2748    Int n = 0;
2749    while (nonNull(xs)) {
2750       z_tag_check(xs,ZCONS,"zlength");
2751       n++;
2752       xs = snd( snd(xs) );
2753    }
2754    return n;
2755 }
2756
2757 ZList zreverse ( ZList xs )
2758 {
2759    ZList rev = NIL;
2760    while (nonNull(xs)) {
2761       z_tag_check(xs,ZCONS,"zreverse");
2762       rev = zcons(zhd(xs),rev);
2763       xs = ztl(xs);
2764    }
2765    return rev;
2766 }
2767
2768 Cell zsingleton ( Cell x )
2769 {
2770    return zcons (x,NIL);
2771 }
2772
2773 Cell zdoubleton ( Cell x, Cell y )
2774 {
2775    return zcons(x,zcons(y,NIL));
2776 }
2777 #endif
2778
2779 Cell zpair ( Cell x1, Cell x2 )
2780 { return ap(ZTUP2,ap(x1,x2)); }
2781 Cell zfst ( Cell zpair )
2782 { z_tag_check(zpair,ZTUP2,"zfst"); return fst( snd(zpair) ); }
2783 Cell zsnd ( Cell zpair )
2784 { z_tag_check(zpair,ZTUP2,"zsnd"); return snd( snd(zpair) ); }
2785
2786 Cell ztriple ( Cell x1, Cell x2, Cell x3 )
2787 { return ap(ZTUP3,ap(x1,ap(x2,x3))); }
2788 Cell zfst3 ( Cell zpair )
2789 { z_tag_check(zpair,ZTUP3,"zfst3"); return fst( snd(zpair) ); }
2790 Cell zsnd3 ( Cell zpair )
2791 { z_tag_check(zpair,ZTUP3,"zsnd3"); return fst(snd( snd(zpair) )); }
2792 Cell zthd3 ( Cell zpair )
2793 { z_tag_check(zpair,ZTUP3,"zthd3"); return snd(snd( snd(zpair) )); }
2794
2795 Cell z4ble ( Cell x1, Cell x2, Cell x3, Cell x4 )
2796 { return ap(ZTUP4,ap(x1,ap(x2,ap(x3,x4)))); }
2797 Cell zsel14 ( Cell zpair )
2798 { z_tag_check(zpair,ZTUP4,"zsel14"); return fst( snd(zpair) ); }
2799 Cell zsel24 ( Cell zpair )
2800 { z_tag_check(zpair,ZTUP4,"zsel24"); return fst(snd( snd(zpair) )); }
2801 Cell zsel34 ( Cell zpair )
2802 { z_tag_check(zpair,ZTUP4,"zsel34"); return fst(snd(snd( snd(zpair) ))); }
2803 Cell zsel44 ( Cell zpair )
2804 { z_tag_check(zpair,ZTUP4,"zsel44"); return snd(snd(snd( snd(zpair) ))); }
2805
2806 Cell z5ble ( Cell x1, Cell x2, Cell x3, Cell x4, Cell x5 )
2807 { return ap(ZTUP5,ap(x1,ap(x2,ap(x3,ap(x4,x5))))); }
2808 Cell zsel15 ( Cell zpair )
2809 { z_tag_check(zpair,ZTUP5,"zsel15"); return fst( snd(zpair) ); }
2810 Cell zsel25 ( Cell zpair )
2811 { z_tag_check(zpair,ZTUP5,"zsel25"); return fst(snd( snd(zpair) )); }
2812 Cell zsel35 ( Cell zpair )
2813 { z_tag_check(zpair,ZTUP5,"zsel35"); return fst(snd(snd( snd(zpair) ))); }
2814 Cell zsel45 ( Cell zpair )
2815 { z_tag_check(zpair,ZTUP5,"zsel45"); return fst(snd(snd(snd( snd(zpair) )))); }
2816 Cell zsel55 ( Cell zpair )
2817 { z_tag_check(zpair,ZTUP5,"zsel55"); return snd(snd(snd(snd( snd(zpair) )))); }
2818
2819
2820 Cell unap ( int tag, Cell c )
2821 {
2822    char buf[100];
2823    if (whatIs(c) != tag) {
2824       sprintf(buf, "unap: specified %d, actual %d\n",
2825                    tag, whatIs(c) );
2826       internal(buf);
2827    }
2828    return snd(c);
2829 }
2830
2831 /* --------------------------------------------------------------------------
2832  * Operations on applications:
2833  * ------------------------------------------------------------------------*/
2834
2835 Int argCount;                          /* number of args in application    */
2836
2837 Cell getHead(e)                        /* get head cell of application     */
2838 Cell e; {                              /* set number of args in argCount   */
2839     for (argCount=0; isAp(e); e=fun(e))
2840         argCount++;
2841     return e;
2842 }
2843
2844 List getArgs(e)                        /* get list of arguments in function*/
2845 Cell e; {                              /* application:                     */
2846     List as;                           /* getArgs(f e1 .. en) = [e1,..,en] */
2847
2848     for (as=NIL; isAp(e); e=fun(e))
2849         as = cons(arg(e),as);
2850     return as;
2851 }
2852
2853 Cell nthArg(n,e)                       /* return nth arg in application    */
2854 Int  n;                                /* of function to m args (m>=n)     */
2855 Cell e; {                              /* nthArg n (f x0 x1 ... xm) = xn   */
2856     for (n=numArgs(e)-n-1; n>0; n--)
2857         e = fun(e);
2858     return arg(e);
2859 }
2860
2861 Int numArgs(e)                         /* find number of arguments to expr */
2862 Cell e; {
2863     Int n;
2864     for (n=0; isAp(e); e=fun(e))
2865         n++;
2866     return n;
2867 }
2868
2869 Cell applyToArgs(f,args)               /* destructively apply list of args */
2870 Cell f;                                /* to function f                    */
2871 List args; {
2872     while (nonNull(args)) {
2873         Cell temp = tl(args);
2874         tl(args)  = hd(args);
2875         hd(args)  = f;
2876         f         = args;
2877         args      = temp;
2878     }
2879     return f;
2880 }
2881
2882
2883 /* --------------------------------------------------------------------------
2884  * plugin support
2885  * ------------------------------------------------------------------------*/
2886
2887 /*---------------------------------------------------------------------------
2888  * GreenCard entry points
2889  *
2890  * GreenCard generated code accesses Hugs data structures and functions
2891  * (only) via these functions (which are stored in the virtual function
2892  * table hugsAPI1.
2893  *-------------------------------------------------------------------------*/
2894
2895 #if GREENCARD
2896
2897 static Cell  makeTuple      Args((Int));
2898 static Cell  makeInt        Args((Int));
2899 static Cell  makeChar       Args((Char));
2900 static Char  CharOf         Args((Cell));
2901 static Cell  makeFloat      Args((FloatPro));
2902 static Void* derefMallocPtr Args((Cell));
2903 static Cell* Fst            Args((Cell));
2904 static Cell* Snd            Args((Cell));
2905
2906 static Cell  makeTuple(n)      Int      n; { return mkTuple(n); }
2907 static Cell  makeInt(n)        Int      n; { return mkInt(n); }
2908 static Cell  makeChar(n)       Char     n; { return mkChar(n); }
2909 static Char  CharOf(n)         Cell     n; { return charOf(n); }
2910 static Cell  makeFloat(n)      FloatPro n; { return mkFloat(n); }
2911 static Void* derefMallocPtr(n) Cell     n; { return derefMP(n); }
2912 static Cell* Fst(n)            Cell     n; { return (Cell*)&fst(n); }
2913 static Cell* Snd(n)            Cell     n; { return (Cell*)&snd(n); }
2914
2915 HugsAPI1* hugsAPI1() {
2916     static HugsAPI1 api;
2917     static Bool initialised = FALSE;
2918     if (!initialised) {
2919         api.nameTrue        = nameTrue;
2920         api.nameFalse       = nameFalse;
2921         api.nameNil         = nameNil;
2922         api.nameCons        = nameCons;
2923         api.nameJust        = nameJust;
2924         api.nameNothing     = nameNothing;
2925         api.nameLeft        = nameLeft;
2926         api.nameRight       = nameRight;
2927         api.nameUnit        = nameUnit;
2928         api.nameIORun       = nameIORun;
2929         api.makeInt         = makeInt;
2930         api.makeChar        = makeChar;
2931         api.CharOf          = CharOf;
2932         api.makeFloat       = makeFloat;
2933         api.makeTuple       = makeTuple;
2934         api.pair            = pair;
2935         api.mkMallocPtr     = mkMallocPtr;
2936         api.derefMallocPtr  = derefMallocPtr;
2937         api.mkStablePtr     = mkStablePtr;
2938         api.derefStablePtr  = derefStablePtr;
2939         api.freeStablePtr   = freeStablePtr;
2940         api.eval            = eval;
2941         api.evalWithNoError = evalWithNoError;
2942         api.evalFails       = evalFails;
2943         api.whnfArgs        = &whnfArgs;
2944         api.whnfHead        = &whnfHead;
2945         api.whnfInt         = &whnfInt;
2946         api.whnfFloat       = &whnfFloat;
2947         api.garbageCollect  = garbageCollect;
2948         api.stackOverflow   = hugsStackOverflow;
2949         api.internal        = internal;
2950         api.registerPrims   = registerPrims;
2951         api.addPrimCfun     = addPrimCfun;
2952         api.inventText      = inventText;
2953         api.Fst             = Fst;
2954         api.Snd             = Snd;
2955         api.cellStack       = cellStack;
2956         api.sp              = &sp;
2957     }
2958     return &api;
2959 }
2960
2961 #endif /* GREENCARD */
2962
2963
2964 /* --------------------------------------------------------------------------
2965  * storage control:
2966  * ------------------------------------------------------------------------*/
2967
2968 #if DYN_TABLES
2969 static void far* safeFarCalloc Args((Int,Int));
2970 static void far* safeFarCalloc(n,s)     /* allocate table storage and check*/
2971 Int n, s; {                             /* for non-null return             */
2972     void far* tab = farCalloc(n,s);
2973     if (tab==0) {
2974         ERRMSG(0) "Cannot allocate run-time tables"
2975         EEND;
2976     }
2977     return tab;
2978 }
2979 #define TABALLOC(v,t,n)                 v=(t far*)safeFarCalloc(n,sizeof(t));
2980 #else
2981 #define TABALLOC(v,t,n)
2982 #endif
2983
2984 Void storage(what)
2985 Int what; {
2986     Int i;
2987
2988     switch (what) {
2989         case POSTPREL: break;
2990
2991         case RESET   : clearStack();
2992
2993                        /* the next 2 statements are particularly important
2994                         * if you are using GLOBALfst or GLOBALsnd since the
2995                         * corresponding registers may be reset to their
2996                         * uninitialised initial values by a longjump.
2997                         */
2998                        heapTopFst = heapFst + heapSize;
2999                        heapTopSnd = heapSnd + heapSize;
3000                        consGC = TRUE;
3001                        lsave  = NIL;
3002                        rsave  = NIL;
3003                        if (isNull(lastExprSaved))
3004                            savedText = NUM_TEXT;
3005                        break;
3006
3007         case MARK    :
3008                        start();
3009                        for (i=NAMEMIN; i<nameHw; ++i) {
3010                            mark(name(i).parent);
3011                            mark(name(i).defn);
3012                            mark(name(i).stgVar);
3013                            mark(name(i).type);
3014                         }
3015                        end("Names", nameHw-NAMEMIN);
3016
3017                        start();
3018                        for (i=MODMIN; i<moduleHw; ++i) {
3019                            mark(module(i).tycons);
3020                            mark(module(i).names);
3021                            mark(module(i).classes);
3022                            mark(module(i).exports);
3023                            mark(module(i).qualImports);
3024                            mark(module(i).objectExtraNames);
3025                        }
3026                        end("Modules", moduleHw-MODMIN);
3027
3028                        start();
3029                        for (i=TYCMIN; i<tyconHw; ++i) {
3030                            mark(tycon(i).defn);
3031                            mark(tycon(i).kind);
3032                            mark(tycon(i).what);
3033                        }
3034                        end("Type constructors", tyconHw-TYCMIN);
3035
3036                        start();
3037                        for (i=CLASSMIN; i<classHw; ++i) {
3038                            mark(cclass(i).head);
3039                            mark(cclass(i).kinds);
3040                            mark(cclass(i).fds);
3041                            mark(cclass(i).xfds);
3042                            mark(cclass(i).dsels);
3043                            mark(cclass(i).supers);
3044                            mark(cclass(i).members);
3045                            mark(cclass(i).defaults);
3046                            mark(cclass(i).instances);
3047                        }
3048                        mark(classes);
3049                        end("Classes", classHw-CLASSMIN);
3050
3051                        start();
3052                        for (i=INSTMIN; i<instHw; ++i) {
3053                            mark(inst(i).head);
3054                            mark(inst(i).kinds);
3055                            mark(inst(i).specifics);
3056                            mark(inst(i).implements);
3057                        }
3058                        end("Instances", instHw-INSTMIN);
3059
3060                        start();
3061                        for (i=0; i<=sp; ++i)
3062                            mark(stack(i));
3063                        end("Stack", sp+1);
3064
3065                        start();
3066                        mark(lastExprSaved);
3067                        mark(lsave);
3068                        mark(rsave);
3069                        end("Last expression", 3);
3070
3071                        if (consGC) {
3072                            start();
3073                            gcCStack();
3074                            end("C stack", stackRoots);
3075                        }
3076
3077                        break;
3078
3079         case PREPREL : heapFst = heapAlloc(heapSize);
3080                        heapSnd = heapAlloc(heapSize);
3081
3082                        if (heapFst==(Heap)0 || heapSnd==(Heap)0) {
3083                            ERRMSG(0) "Cannot allocate heap storage (%d cells)",
3084                                      heapSize
3085                            EEND;
3086                        }
3087
3088                        heapTopFst = heapFst + heapSize;
3089                        heapTopSnd = heapSnd + heapSize;
3090                        for (i=1; i<heapSize; ++i) {
3091                            fst(-i) = FREECELL;
3092                            snd(-i) = -(i+1);
3093                        }
3094                        snd(-heapSize) = NIL;
3095                        freeList  = -1;
3096                        numGcs    = 0;
3097                        consGC    = TRUE;
3098                        lsave     = NIL;
3099                        rsave     = NIL;
3100
3101                        marksSize  = bitArraySize(heapSize);
3102                        if ((marks=(Int *)calloc(marksSize, sizeof(Int)))==0) {
3103                            ERRMSG(0) "Unable to allocate gc markspace"
3104                            EEND;
3105                        }
3106
3107                        TABALLOC(text,      char,             NUM_TEXT)
3108                        TABALLOC(tyconHash, Tycon,            TYCONHSZ)
3109                        TABALLOC(tabTycon,  struct strTycon,  NUM_TYCON)
3110                        TABALLOC(nameHash,  Name,             NAMEHSZ)
3111                        TABALLOC(tabName,   struct strName,   NUM_NAME)
3112                        TABALLOC(tabClass,  struct strClass,  NUM_CLASSES)
3113                        TABALLOC(cellStack, Cell,             NUM_STACK)
3114                        TABALLOC(tabModule, struct Module,    NUM_SCRIPTS)
3115 #if TREX
3116                        TABALLOC(tabExt,    Text,             NUM_EXT)
3117 #endif
3118                        clearStack();
3119
3120                        textHw        = 0;
3121                        nextNewText   = NUM_TEXT;
3122                        nextNewDText  = (-1);
3123                        lastExprSaved = NIL;
3124                        savedText     = NUM_TEXT;
3125                        for (i=0; i<TEXTHSZ; ++i)
3126                            textHash[i][0] = NOTEXT;
3127
3128
3129                        moduleHw = MODMIN;
3130
3131                        tyconHw  = TYCMIN;
3132                        for (i=0; i<TYCONHSZ; ++i)
3133                            tyconHash[i] = NIL;
3134 #if TREX
3135                        extHw    = EXTMIN;
3136 #endif
3137
3138                        nameHw   = NAMEMIN;
3139                        for (i=0; i<NAMEHSZ; ++i)
3140                            nameHash[i] = NIL;
3141
3142                        classHw  = CLASSMIN;
3143
3144                        instHw   = INSTMIN;
3145
3146 #if USE_DICTHW
3147                        dictHw   = 0;
3148 #endif
3149
3150                        tabInst  = (struct strInst far *)
3151                                     farCalloc(NUM_INSTS,sizeof(struct strInst));
3152
3153                        if (tabInst==0) {
3154                            ERRMSG(0) "Cannot allocate instance tables"
3155                            EEND;
3156                        }
3157
3158                        scriptHw = 0;
3159
3160                        break;
3161     }
3162 }
3163
3164 /*-------------------------------------------------------------------------*/