2 /* --------------------------------------------------------------------------
3 * Defines storage datatypes: Text, Name, Module, Tycon, Cell, List, Pair,
6 * The Hugs 98 system is Copyright (c) Mark P Jones, Alastair Reid, the
7 * Yale Haskell Group, and the Oregon Graduate Institute of Science and
8 * Technology, 1994-1999, All rights reserved. It is distributed as
9 * free software under the license in the file "License", which is
10 * included in the distribution.
12 * $RCSfile: storage.h,v $
14 * $Date: 1999/12/06 16:25:27 $
15 * ------------------------------------------------------------------------*/
17 /* --------------------------------------------------------------------------
18 * Typedefs for main data types:
19 * Many of these type names are used to indicate the intended us of a data
20 * item, rather than for type checking purposes. Sadly (although sometimes,
21 * fortunately), the C compiler cannot distinguish between the use of two
22 * different names defined to be synonyms for the same types.
23 * ------------------------------------------------------------------------*/
25 typedef Int Text; /* text string */
26 typedef Unsigned Syntax; /* syntax (assoc,preced) */
27 typedef Int Cell; /* general cell value */
28 typedef Cell far *Heap; /* storage of heap */
29 typedef Cell Pair; /* pair cell */
30 typedef Int StackPtr; /* stack pointer */
31 typedef Cell Offset; /* offset/generic variable*/
32 typedef Int Script; /* script file number */
33 typedef Int Module; /* module */
34 typedef Cell Tycon; /* type constructor */
35 typedef Cell Type; /* type expression */
36 typedef Cell Kind; /* kind expression */
37 typedef Cell Kinds; /* list of kinds */
38 typedef Cell Constr; /* constructor expression */
39 typedef Cell Name; /* named value */
40 typedef Cell Class; /* type class */
41 typedef Cell Inst; /* instance of type class */
42 typedef Cell Triple; /* triple of cell values */
43 typedef Cell List; /* list of cells */
44 typedef Cell Bignum; /* bignum integer */
45 typedef Cell Float; /* floating pt literal */
47 typedef Cell Ext; /* extension label */
50 /* --------------------------------------------------------------------------
52 * provides storage for the characters making up identifier and symbol
53 * names, string literals, character constants etc...
54 * ------------------------------------------------------------------------*/
56 extern String textToStr Args((Text));
57 extern Text findText Args((String));
58 extern Text inventText Args((Void));
59 extern Text inventDictText Args((Void));
60 extern Bool inventedText Args((Text));
61 extern Text enZcodeThenFindText Args((String));
62 extern Text unZcodeThenFindText Args((String));
64 /* Variants of textToStr and syntaxOf which work for idents, ops whether
65 * qualified or unqualified.
67 extern String identToStr Args((Cell));
68 extern Text fixLitText Args((Text));
69 extern Syntax identSyntax Args((Cell));
70 extern Syntax defaultSyntax Args((Text));
72 /* --------------------------------------------------------------------------
73 * Specification of syntax (i.e. default written form of application)
74 * ------------------------------------------------------------------------*/
76 #define MIN_PREC 0 /* weakest binding operator */
77 #define MAX_PREC 9 /* strongest binding operator */
78 #define FUN_PREC (MAX_PREC+2) /* binding of function symbols */
79 #define DEF_PREC MAX_PREC
80 #define APPLIC 0 /* written applicatively */
81 #define LEFT_ASS 1 /* left associative infix */
82 #define RIGHT_ASS 2 /* right associative infix */
83 #define NON_ASS 3 /* non associative infix */
84 #define DEF_ASS LEFT_ASS
86 #define UMINUS_PREC 6 /* Change these settings at your */
87 #define UMINUS_ASSOC LEFT_ASS /* own risk; they may not work! */
89 #define assocOf(x) ((x)&NON_ASS)
90 #define precOf(x) ((x)>>2)
91 #define mkSyntax(a,p) ((a)|((p)<<2))
92 #define DEF_OPSYNTAX mkSyntax(DEF_ASS,DEF_PREC)
93 #define NO_SYNTAX (-1)
95 extern Void addSyntax Args((Int,Text,Syntax));
96 extern Syntax syntaxOf Args((Text));
98 /* --------------------------------------------------------------------------
100 * Provides a garbage collectable heap for storage of expressions etc.
101 * ------------------------------------------------------------------------*/
103 #define heapAlloc(s) (Heap)(farCalloc(s,sizeof(Cell)))
104 #define heapBuilt() (heapFst)
106 extern Heap heapFst, heapSnd;
107 extern Heap heapTopFst;
108 extern Heap heapTopSnd;
109 extern Bool consGC; /* Set to FALSE to turn off gc from*/
110 /* C stack; use with extreme care! */
111 extern Int cellsRecovered; /* cells recovered by last gc */
113 #define fst(c) heapTopFst[c]
114 #define snd(c) heapTopSnd[c]
116 extern Pair pair Args((Cell,Cell));
117 extern Void garbageCollect Args((Void));
119 extern Void overwrite Args((Pair,Pair));
120 extern Void overwrite2 Args((Pair,Cell,Cell));
121 extern Cell markExpr Args((Cell));
122 extern Void markWithoutMove Args((Cell));
124 #define mark(v) v=markExpr(v)
126 #define isPair(c) ((c)<0)
127 #define isGenPair(c) ((c)<0 && -heapSize<=(c))
129 extern Cell whatIs Args((Cell));
131 /* --------------------------------------------------------------------------
132 * Box cell tags are used as the fst element of a pair to indicate that
133 * the snd element of the pair is to be treated in some special way, other
134 * than as a Cell. Examples include holding integer values, variable name
135 * and string text etc.
136 * ------------------------------------------------------------------------*/
138 #define TAGMIN 1 /* Box and constructor cell tag values */
139 #define BCSTAG 30 /* Box=TAGMIN..BCSTAG-1 */
140 #define isTag(c) (TAGMIN<=(c) && (c)<SPECMIN) /* Tag cell values */
141 #define isBoxTag(c) (TAGMIN<=(c) && (c)<BCSTAG) /* Box cell tag values */
142 #define isConTag(c) (BCSTAG<=(c) && (c)<SPECMIN) /* Constr cell tag values*/
144 #define FREECELL 3 /* Free list cell: snd :: Cell */
145 #define VARIDCELL 4 /* Identifier variable: snd :: Text */
146 #define VAROPCELL 5 /* Operator variable: snd :: Text */
147 #define DICTVAR 6 /* Dictionary variable: snd :: Text */
148 #define CONIDCELL 7 /* Identifier constructor: snd :: Text */
149 #define CONOPCELL 8 /* Operator constructor: snd :: Text */
150 #define STRCELL 9 /* String literal: snd :: Text */
151 #define INTCELL 10 /* Int literal: snd :: Int */
152 #define ADDPAT 11 /* (_+k) pattern discr: snd :: Int */
153 #define FLOATCELL 15 /* Floating Pt literal: snd :: Text */
154 #define BIGCELL 16 /* Integer literal: snd :: Text */
156 #define PTRCELL 17 /* C Heap Pointer snd :: Ptr */
158 #define IPCELL 19 /* Imp Param Cell: snd :: Text */
159 #define IPVAR 20 /* ?x: snd :: Text */
161 #define CPTRCELL 21 /* Native code pointer snd :: Ptr */
164 #define EXTCOPY 22 /* Copy of an Ext: snd :: Text */
167 #define qmodOf(c) (textOf(fst(snd(c)))) /* c :: QUALIDENT */
168 #define qtextOf(c) (textOf(snd(snd(c)))) /* c :: QUALIDENT */
169 #define mkVar(t) ap(VARIDCELL,t)
170 #define mkVarop(t) ap(VAROPCELL,t)
171 #define mkCon(t) ap(CONIDCELL,t)
172 #define mkConop(t) ap(CONOPCELL,t)
173 #define mkQVar(m,t) ap(QUALIDENT,pair(mkCon(m),mkVar(t)))
174 #define mkQCon(m,t) ap(QUALIDENT,pair(mkCon(m),mkCon(t)))
175 #define mkQVarOp(m,t) ap(QUALIDENT,pair(mkCon(m),mkVarop(t)))
176 #define mkQConOp(m,t) ap(QUALIDENT,pair(mkCon(m),mkConop(t)))
177 #define intValOf(c) (snd(c))
178 #define inventVar() mkVar(inventText())
179 #define mkDictVar(t) ap(DICTVAR,t)
180 #define inventDictVar() mkDictVar(inventDictText())
181 #define mkStr(t) ap(STRCELL,t)
183 #define mkIParam(c) ap(IPCELL,snd(c))
184 #define isIP(p) (whatIs(p) == IPCELL)
185 #define ipMatch(pi, t) (isIP(fun(pi)) && textOf(fun(pi)) == t)
186 #define ipVar(pi) textOf(fun(pi))
188 #define isIP(p) FALSE
191 extern Bool isVar Args((Cell));
192 extern Bool isCon Args((Cell));
193 extern Bool isQVar Args((Cell));
194 extern Bool isQCon Args((Cell));
195 extern Bool isQualIdent Args((Cell));
196 extern Bool isIdent Args((Cell));
197 extern String stringNegate Args((String));
198 extern Text textOf Args((Cell));
200 #define isFloat(c) (isPair(c) && fst(c)==FLOATCELL)
201 #define stringToFloat(s) pair(FLOATCELL,findText(s))
202 #define floatToString(f) textToStr(snd(f))
203 #define floatOf(f) atof(floatToString(f))
204 #define mkFloat(f) (f) /* ToDo: is this right? */
205 #define floatNegate(f) stringToFloat(stringNegate(floatToString(f)))
207 #define stringToBignum(s) pair(BIGCELL,findText(s))
208 #define bignumToString(b) textToStr(snd(b))
211 #define isPtr(c) (isPair(c) && fst(c)==PTRCELL)
212 extern Cell mkPtr Args((Ptr));
213 extern Ptr ptrOf Args((Cell));
214 #define isCPtr(c) (isPair(c) && fst(c)==CPTRCELL)
215 extern Cell mkCPtr Args((Ptr));
216 extern Ptr cptrOf Args((Cell));
219 /* --------------------------------------------------------------------------
220 * Constructor cell tags are used as the fst element of a pair to indicate
221 * a particular syntactic construct described by the snd element of the
223 * Note that a cell c will not be treated as an application (AP/isAp) node
224 * if its first element is a constructor cell tag, whereas a cell whose fst
225 * element is a special cell will be treated as an application node.
226 * ------------------------------------------------------------------------*/
228 #define LETREC 30 /* LETREC snd :: ([Decl],Exp) */
229 #define COND 31 /* COND snd :: (Exp,Exp,Exp) */
230 #define LAMBDA 32 /* LAMBDA snd :: Alt */
231 #define FINLIST 33 /* FINLIST snd :: [Exp] */
232 #define DOCOMP 34 /* DOCOMP snd :: (Exp,[Qual]) */
233 #define BANG 35 /* BANG snd :: Type */
234 #define COMP 36 /* COMP snd :: (Exp,[Qual]) */
235 #define ASPAT 37 /* ASPAT snd :: (Var,Exp) */
236 #define ESIGN 38 /* ESIGN snd :: (Exp,Type) */
237 #define RSIGN 39 /* RSIGN snd :: (Rhs,Type) */
238 #define CASE 40 /* CASE snd :: (Exp,[Alt]) */
239 #define NUMCASE 41 /* NUMCASE snd :: (Exp,Disc,Rhs) */
240 #define FATBAR 42 /* FATBAR snd :: (Exp,Exp) */
241 #define LAZYPAT 43 /* LAZYPAT snd :: Exp */
242 #define DERIVE 45 /* DERIVE snd :: Cell */
244 #define FLOATCELL 46 /* FLOATCELL snd :: (Int,Int) */
247 #define BOOLQUAL 49 /* BOOLQUAL snd :: Exp */
248 #define QWHERE 50 /* QWHERE snd :: [Decl] */
249 #define FROMQUAL 51 /* FROMQUAL snd :: (Exp,Exp) */
250 #define DOQUAL 52 /* DOQUAL snd :: Exp */
251 #define MONADCOMP 53 /* MONADCOMP snd :: ((m,m0),(Exp,[Qual])*/
253 #define GUARDED 54 /* GUARDED snd :: [guarded exprs] */
255 #define ARRAY 55 /* Array snd :: (Bounds,[Values]) */
256 #define MUTVAR 56 /* Mutvar snd :: Cell */
258 #define HUGSOBJECT 57 /* HUGSOBJECT snd :: Cell */
262 #define WITHEXP 58 /* WITHEXP snd :: [(Var,Exp)] */
266 #define POLYTYPE 60 /* POLYTYPE snd :: (Kind,Type) */
267 #define QUAL 61 /* QUAL snd :: ([Classes],Type) */
268 #define RANK2 62 /* RANK2 snd :: (Int,Type) */
269 #define EXIST 63 /* EXIST snd :: (Int,Type) */
270 #define POLYREC 64 /* POLYREC snd :: (Int,Type) */
271 #define BIGLAM 65 /* BIGLAM snd :: (vars,patterns) */
272 #define CDICTS 66 /* CDICTS snd :: ([Pred],Type) */
274 #define LABC 67 /* LABC snd :: (con,[(Vars,Type)]) */
275 #define CONFLDS 68 /* CONFLDS snd :: (con,[Field]) */
276 #define UPDFLDS 69 /* UPDFLDS snd :: (Exp,[con],[Field]) */
278 #define RECORD 70 /* RECORD snd :: [Val] */
279 #define EXTCASE 71 /* EXTCASE snd :: (Exp,Disc,Rhs) */
280 #define RECSEL 72 /* RECSEL snd :: Ext */
282 #define IMPDEPS 73 /* IMPDEPS snd :: [Binding] */
284 #define QUALIDENT 74 /* Qualified identifier snd :: (Id,Id) */
285 #define HIDDEN 75 /* hiding import list snd :: [Entity] */
286 #define MODULEENT 76 /* module in export list snd :: con */
288 #define INFIX 77 /* INFIX snd :: (see tidyInfix) */
289 #define ONLY 78 /* ONLY snd :: Exp */
290 #define NEG 79 /* NEG snd :: Exp */
292 /* Used when parsing GHC interface files */
293 #define DICTAP 80 /* DICTAP snd :: (QClassId,[Type]) */
294 #define UNBOXEDTUP 81 /* UNBOXEDTUP snd :: [Type] */
296 #if SIZEOF_INTP != SIZEOF_INT
297 #define PTRCELL 82 /* C Heap Pointer snd :: (Int,Int) */
300 #define STGVAR 92 /* STGVAR snd :: (StgRhs,info) */
301 #define STGAPP 93 /* STGAPP snd :: (StgVar,[Arg]) */
302 #define STGPRIM 94 /* STGPRIM snd :: (PrimOp,[Arg]) */
303 #define STGCON 95 /* STGCON snd :: (StgCon,[Arg]) */
304 #define PRIMCASE 96 /* PRIMCASE snd :: (Expr,[PrimAlt]) */
305 #define DEEFALT 97 /* DEEFALT snd :: (Var,Expr) */
306 #define CASEALT 98 /* CASEALT snd :: (Con,[Var],Expr) */
307 #define PRIMALT 99 /* PRIMALT snd :: ([Var],Expr) */
308 /* Last constructor tag must be less than SPECMIN */
310 /* --------------------------------------------------------------------------
311 * Special cell values:
312 * ------------------------------------------------------------------------*/
315 #define isSpec(c) (SPECMIN<=(c) && (c)<TUPMIN)/* Special cell values */
317 #define NONE 101 /* Dummy stub */
318 #define STAR 102 /* Representing the kind of types */
320 #define ROW 103 /* Representing the kind of rows */
322 #define WILDCARD 104 /* Wildcard pattern */
323 #define SKOLEM 105 /* Skolem constant */
325 #define DOTDOT 106 /* ".." in import/export list */
327 #define NAME 110 /* whatIs code for isName */
328 #define TYCON 111 /* whatIs code for isTycon */
329 #define CLASS 112 /* whatIs code for isClass */
330 #define MODULE 113 /* whatIs code for isModule */
331 #define INSTANCE 114 /* whatIs code for isInst */
332 #define TUPLE 115 /* whatIs code for tuple constructor */
333 #define OFFSET 116 /* whatis code for offset */
334 #define AP 117 /* whatIs code for application node */
335 #define CHARCELL 118 /* whatIs code for isChar */
337 #define EXT 119 /* whatIs code for isExt */
340 #define SIGDECL 120 /* Signature declaration */
341 #define FIXDECL 121 /* Fixity declaration */
342 #define FUNBIND 122 /* Function binding */
343 #define PATBIND 123 /* Pattern binding */
345 #define DATATYPE 130 /* Datatype type constructor */
346 #define NEWTYPE 131 /* Newtype type constructor */
347 #define SYNONYM 132 /* Synonym type constructor */
348 #define RESTRICTSYN 133 /* Synonym with restricted scope */
350 #define NODEPENDS 135 /* Stop calculation of deps in type check*/
351 #define PREDEFINED 136 /* Predefined name, not yet filled */
353 /* --------------------------------------------------------------------------
354 * Tuple data/type constructors:
355 * ------------------------------------------------------------------------*/
362 #define isTuple(c) (TUPMIN<=(c) && (c)<EXTMIN)
364 #define isTuple(c) (TUPMIN<=(c) && (c)<OFFMIN)
366 #define mkTuple(n) (TUPMIN+(n))
367 #define tupleOf(n) ((Int)((n)-TUPMIN))
370 extern Text ghcTupleText Args((Tycon));
375 #define EXTMIN (TUPMIN+NUM_TUPLES)
376 #define isExt(c) (EXTMIN<=(c) && (c)<OFFMIN)
377 #define extText(e) tabExt[(e)-EXTMIN]
378 #define extField(c) arg(fun(c))
379 #define extRow(c) arg(c)
381 extern Text DECTABLE(tabExt);
382 extern Ext mkExt Args((Text));
387 /* --------------------------------------------------------------------------
388 * Offsets: (generic types/stack offsets)
389 * ------------------------------------------------------------------------*/
392 #define OFFMIN (EXTMIN+NUM_EXT)
394 #define OFFMIN (TUPMIN+NUM_TUPLES)
396 #define isOffset(c) (OFFMIN<=(c) && (c)<MODMIN)
397 #define offsetOf(c) ((c)-OFFMIN)
398 #define mkOffset(o) (OFFMIN+(o))
400 /* --------------------------------------------------------------------------
402 * ------------------------------------------------------------------------*/
404 /* An entry in a very crude object symbol table */
405 typedef struct { char* nm; void* ad; }
408 /* Indication of section kinds for loaded objects. Needed by
409 the GC for deciding whether or not a pointer on the stack
412 typedef enum { HUGS_DL_SECTION_CODE_OR_RODATA,
413 HUGS_DL_SECTION_RWDATA,
414 HUGS_DL_SECTION_OTHER }
417 typedef struct { void* start; void* end; DLSect sect; }
420 /* --------------------------------------------------------------------------
422 * ------------------------------------------------------------------------*/
424 #define MODMIN (OFFMIN+NUM_OFFSETS)
426 #define isModule(c) (MODMIN<=(c) && (c)<TYCMIN)
427 #define mkModule(n) (MODMIN+(n))
428 #define module(n) tabModule[(n)-MODMIN]
430 /* Under Haskell 1.3, the list of qualified imports is always a subset
431 * of the list of unqualified imports. For simplicity and flexibility,
432 * we do not attempt to exploit this fact - when a module is imported
433 * unqualified, it is added to both the qualified and unqualified
435 * Similarily, Haskell 1.3 does not allow a constructor to be imported
436 * or exported without exporting the type it belongs to but the export
437 * list is just a flat list of Texts (before static analysis) or
438 * Tycons, Names and Classes (after static analysis).
442 /* Lists of top level objects (local defns + imports) */
446 List exports; /* [ Entity | (Entity, NIL|DOTDOT) ] */
447 /* List of qualified imports. Used both during compilation and when
448 * evaluating an expression in the context of the current module.
452 /* ptr to malloc'd lump of memory holding the obj file */
455 /* ptr to object symbol table; lives in mallocville.
456 Dynamically expands. */
461 /* The section-kind entries for this object module. Dynamically expands. */
467 extern Module currentModule; /* Module currently being processed */
468 extern struct Module DECTABLE(tabModule);
470 extern Bool isValidModule Args((Module));
471 extern Module newModule Args((Text));
472 extern Module findModule Args((Text));
473 extern Module findModid Args((Cell));
474 extern Void setCurrModule Args((Module));
476 extern void addOTabName Args((Module,char*,void*));
477 extern void* lookupOTabName Args((Module,char*));
478 extern char* nameFromOPtr Args((void*));
480 extern void addDLSect Args((Module,void*,void*,DLSect));
481 extern DLSect lookupDLSect Args((void*));
484 #define isPrelude(m) (m==modulePrelude)
486 /* --------------------------------------------------------------------------
487 * Type constructor names:
488 * ------------------------------------------------------------------------*/
490 #define TYCMIN (MODMIN+NUM_MODULE)
491 #define isTycon(c) (TYCMIN<=(c) && (c)<NAMEMIN && tabTycon[(c)-TYCMIN].tuple==-1)
492 #define tycon(n) tabTycon[(n)-TYCMIN]
494 #define isTuple(c) (TYCMIN<=(c) && (c)<NAMEMIN && tabTycon[(c)-TYCMIN].tuple>=0)
495 #define tupleOf(n) (tabTycon[(n)-TYCMIN].tuple)
496 extern Tycon mkTuple ( Int );
497 extern Void allocTupleTycon ( Int );
503 Module mod; /* module that defines it */
504 Int tuple; /* tuple number, or -1 if not tuple */
506 Kind kind; /* kind (includes arity) of Tycon */
507 Cell what; /* DATATYPE/SYNONYM/RESTRICTSYN... */
509 Name conToTag; /* used in derived code */
514 extern struct strTycon DECTABLE(tabTycon);
516 extern Tycon newTycon Args((Text));
517 extern Tycon findTycon Args((Text));
518 extern Tycon addTycon Args((Tycon));
519 extern Tycon findQualTycon Args((Cell));
520 extern Tycon addPrimTycon Args((Text,Kind,Int,Cell,Cell));
522 #define isSynonym(h) (isTycon(h) && tycon(h).what==SYNONYM)
523 #define isQualType(t) (isPair(t) && fst(t)==QUAL)
524 #define mkPolyType(n,t) pair(POLYTYPE,pair(n,t))
525 #define isPolyType(t) (isPair(t) && fst(t)==POLYTYPE)
526 #define isPolyOrQualType(t) (isPair(t) && (fst(t)==POLYTYPE || fst(t)==QUAL))
527 #define polySigOf(t) fst(snd(t))
528 #define monotypeOf(t) snd(snd(t))
530 #define bang(t) ap(BANG,t)
532 /* --------------------------------------------------------------------------
533 * Globally defined name values:
534 * ------------------------------------------------------------------------*/
536 #define NAMEMIN (TYCMIN+NUM_TYCON)
537 #define isName(c) (NAMEMIN<=(c) && (c)<INSTMIN)
538 #define mkName(n) (NAMEMIN+(n))
539 #define name(n) tabName[(n)-NAMEMIN]
544 Module mod; /* module that defines it */
551 Cell stgVar; /* really StgVar */
552 Text callconv; /* for foreign import/export */
553 void* primop; /* really StgPrim* */
557 extern int numNames Args(( Void ));
559 extern struct strName DECTABLE(tabName);
561 /* The number field in a name is used to distinguish various kinds of name:
562 * mfunNo(i) = code for member function, offset i
563 * members that are sole elements of dict use mfunNo(0)
564 * members of dicts with more than one elem use mfunNo(n), n>=1
565 * EXECNAME = code for executable name (bytecodes or primitive)
566 * SELNAME = code for selector function
567 * DFUNNAME = code for dictionary builder or selector
568 * cfunNo(i) = code for data constructor
569 * datatypes with only one constructor uses cfunNo(0)
570 * datatypes with multiple constructors use cfunNo(n), n>=1
578 #define isSfun(n) (name(n).number==SELNAME)
579 #define isDfun(n) (name(n).number==DFUNNAME)
581 #define isCfun(n) (name(n).number>=CFUNNAME)
582 #define cfunOf(n) (name(n).number-CFUNNAME)
583 #define cfunNo(i) ((i)+CFUNNAME)
584 #define hasCfun(cs) (nonNull(cs) && isCfun(hd(cs)))
586 #define isMfun(n) (name(n).number<0)
587 #define mfunOf(n) ((-1)-name(n).number)
588 #define mfunNo(i) ((-1)-(i))
590 extern Name newName Args((Text,Cell));
591 extern Name findName Args((Text));
592 extern Name addName Args((Name));
593 extern Name findQualName Args((Cell));
594 extern Name addPrimCfun Args((Text,Int,Int,Cell));
595 extern Name addPrimCfunREP Args((Text,Int,Int,Int));
596 extern Int sfunPos Args((Name,Name));
597 extern Name nameFromStgVar Args((Cell));
598 extern Name jrsFindQualName Args((Text,Text));
600 /* --------------------------------------------------------------------------
602 * ------------------------------------------------------------------------*/
604 #define INSTMIN (NAMEMIN+NUM_NAME) /* instances */
605 #define isInst(c) (INSTMIN<=(c) && (c)<CLASSMIN)
606 #define mkInst(n) (INSTMIN+(n))
607 #define instOf(c) ((Int)((c)-INSTMIN))
608 #define inst(in) tabInst[(in)-INSTMIN]
611 Class c; /* class C */
613 Module mod; /* module that defines it */
614 Kinds kinds; /* Kinds of variables in head */
615 Cell head; /* :: Pred */
616 List specifics; /* :: [Pred] */
617 Int numSpecifics; /* length(specifics) */
619 Name builder; /* Dictionary constructor function */
622 /* a predicate (an element :: Pred) is an application of a Class to one or
623 * more type expressions
626 #define CLASSMIN (INSTMIN+NUM_INSTS)
627 #define isClass(c) (CLASSMIN<=(c) && (c)<CHARMIN)
628 #define mkClass(n) (CLASSMIN+(n))
629 #define cclass(n) tabClass[(n)-CLASSMIN]
632 Text text; /* Name of class */
633 Int line; /* Line where declaration begins */
634 Module mod; /* module that declares it */
635 Int level; /* Level in class hierarchy */
636 Int arity; /* Number of arguments */
637 Kinds kinds; /* Kinds of constructors in class */
638 List fds; /* Functional Dependencies */
639 List xfds; /* Xpanded Functional Dependencies */
640 Cell head; /* Head of class */
641 Name dcon; /* Dictionary constructor function */
642 List supers; /* :: [Pred] */
643 Int numSupers; /* length(supers) */
644 List dsels; /* Superclass dictionary selectors */
645 List members; /* :: [Name] */
646 Int numMembers; /* length(members) */
647 List defaults; /* :: [Name] */
648 List instances; /* :: [Inst] */
651 extern struct strClass DECTABLE(tabClass);
652 extern struct strInst far *tabInst;
654 extern Class newClass Args((Text));
655 extern Class classMax Args((Void));
656 extern Class findClass Args((Text));
657 extern Class addClass Args((Class));
658 extern Class findQualClass Args((Cell));
659 extern Inst newInst Args((Void));
660 extern Inst findFirstInst Args((Tycon));
661 extern Inst findNextInst Args((Tycon,Inst));
663 /* --------------------------------------------------------------------------
665 * ------------------------------------------------------------------------*/
667 #define CHARMIN (CLASSMIN+NUM_CLASSES)
668 #define MAXCHARVAL (NUM_CHARS-1)
669 #define isChar(c) (CHARMIN<=(c) && (c)<INTMIN)
670 #define charOf(c) ((Char)(c-CHARMIN))
671 #define mkChar(c) ((Cell)(CHARMIN+(((unsigned)(c))%NUM_CHARS)))
673 /* --------------------------------------------------------------------------
674 * Small Integer values:
675 * ------------------------------------------------------------------------*/
677 #define INTMIN (CHARMIN+NUM_CHARS)
678 #define INTMAX (MAXPOSINT)
679 #define isSmall(c) (INTMIN<=(c))
680 #define INTZERO (INTMIN/2 + INTMAX/2)
681 #define MINSMALLINT (INTMIN - INTZERO)
682 #define MAXSMALLINT (INTMAX - INTZERO)
683 #define mkDigit(c) ((Cell)((c)+INTMIN))
684 #define digitOf(c) ((Int)((c)-INTMIN))
686 extern Bool isInt Args((Cell));
687 extern Int intOf Args((Cell));
688 extern Cell mkInt Args((Int));
690 /* --------------------------------------------------------------------------
691 * Implementation of triples:
692 * ------------------------------------------------------------------------*/
694 #define triple(x,y,z) pair(x,pair(y,z))
695 #define fst3(c) fst(c)
696 #define snd3(c) fst(snd(c))
697 #define thd3(c) snd(snd(c))
699 /* --------------------------------------------------------------------------
700 * Implementation of lists:
701 * ------------------------------------------------------------------------*/
704 #define isNull(c) ((c)==NIL)
705 #define nonNull(c) (c)
706 #define cons(x,xs) pair(x,xs)
707 #define singleton(x) cons(x,NIL)
708 #define doubleton(x,y) cons(x,cons(y,NIL))
709 #define tripleton(x,y,z) cons(x,cons(y,cons(z,NIL)))
713 extern Int length Args((List));
714 extern List appendOnto Args((List,List)); /* destructive */
715 extern List dupOnto Args((List,List));
716 extern List dupList Args((List));
717 extern List revOnto Args((List, List)); /* destructive */
718 #define rev(xs) revOnto((xs),NIL) /* destructive */
719 #define reverse(xs) revOnto(dupList(xs),NIL) /* non-destructive */
720 extern Cell cellIsMember Args((Cell,List));
721 extern Cell cellAssoc Args((Cell,List));
722 extern Cell cellRevAssoc Args((Cell,List));
723 extern Bool eqList Args((List,List));
724 extern Cell varIsMember Args((Text,List));
725 extern Name nameIsMember Args((Text,List));
726 extern Cell intIsMember Args((Int,List));
727 extern List replicate Args((Int,Cell));
728 extern List diffList Args((List,List)); /* destructive */
729 extern List deleteCell Args((List,Cell)); /* non-destructive */
730 extern List take Args((Int,List)); /* destructive */
731 extern List splitAt Args((Int,List)); /* non-destructive */
732 extern Cell nth Args((Int,List));
733 extern List removeCell Args((Cell,List)); /* destructive */
734 extern List dupListOnto Args((List,List)); /* non-destructive */
735 extern List nubList Args((List)); /* non-destructive */
737 /* The following macros provide `inline expansion' of some common ways of
738 * traversing, using and modifying lists:
740 * N.B. We use the names _f, _a, _xs, Zs, in an attempt to avoid clashes
741 * with identifiers used elsewhere.
744 #define mapBasic(_init,_step) {List Zs=(_init);\
745 for(;nonNull(Zs);Zs=tl(Zs)) \
747 #define mapModify(_init,_step) mapBasic(_init,hd(Zs)=_step)
749 #define mapProc(_f,_xs) mapBasic(_xs,_f(hd(Zs)))
750 #define map1Proc(_f,_a,_xs) mapBasic(_xs,_f(_a,hd(Zs)))
751 #define map2Proc(_f,_a,_b,_xs) mapBasic(_xs,_f(_a,_b,hd(Zs)))
752 #define map3Proc(_f,_a,_b,_c,_xs) mapBasic(_xs,_f(_a,_b,_c,hd(Zs)))
753 #define map4Proc(_f,_a,_b,_c,_d,_xs) mapBasic(_xs,_f(_a,_b,_c,_d,hd(Zs)))
755 #define mapOver(_f,_xs) mapModify(_xs,_f(hd(Zs)))
756 #define map1Over(_f,_a,_xs) mapModify(_xs,_f(_a,hd(Zs)))
757 #define map2Over(_f,_a,_b,_xs) mapModify(_xs,_f(_a,_b,hd(Zs)))
758 #define map3Over(_f,_a,_b,_c,_xs) mapModify(_xs,_f(_a,_b,_c,hd(Zs)))
759 #define map4Over(_f,_a,_b,_c,_d,_xs) mapModify(_xs,_f(_a,_b,_c,_d,hd(Zs)))
761 /* This is just what you want for functions with accumulating parameters */
762 #define mapAccum(_f,_acc,_xs) mapBasic(_xs,_acc=_f(_acc,hd(Zs)))
763 #define map1Accum(_f,_acc,_a,_xs) mapBasic(_xs,_acc=_f(_acc,_a,hd(Zs)))
764 #define map2Accum(_f,_acc,_a,_b,_xs) mapBasic(_xs,_acc=_f(_acc,_a,_b,hd(Zs)))
765 #define map3Accum(_f,_acc,_a,_b,_c,_xs) mapBasic(_xs,_acc=_f(_acc,_a,_b,_c,hd(Zs)))
767 /* --------------------------------------------------------------------------
768 * Implementation of function application nodes:
769 * ------------------------------------------------------------------------*/
771 #define ap(f,x) pair(f,x)
772 #define ap1(f,x) ap(f,x)
773 #define ap2(f,x,y) ap(ap(f,x),y)
774 #define ap3(f,x,y,z) ap(ap(ap(f,x),y),z)
775 #define fun(c) fst(c)
776 #define arg(c) snd(c)
777 #define isAp(c) (isPair(c) && !isTag(fst(c)))
778 extern Cell getHead Args((Cell));
779 extern List getArgs Args((Cell));
781 extern Cell nthArg Args((Int,Cell));
782 extern Int numArgs Args((Cell));
783 extern Cell applyToArgs Args((Cell,List));
785 /* --------------------------------------------------------------------------
786 * Stack implementation:
788 * NB: Use of macros makes order of evaluation hard to predict.
789 * For example, "push(1+pop());" doesn't increment TOS.
790 * ------------------------------------------------------------------------*/
792 extern Cell DECTABLE(cellStack);
795 #define clearStack() sp=(-1)
796 #define stackEmpty() (sp==(-1))
797 #define stack(p) cellStack[p]
798 #define chkStack(n) if (sp>=NUM_STACK-(n)) hugsStackOverflow()
804 #define onto(c) stack(++sp)=(c);
805 #define pop() stack(sp--)
807 #define top() stack(sp)
808 #define pushed(n) stack(sp-(n))
809 #define topfun(f) top()=ap((f),top())
810 #define toparg(x) top()=ap(top(),(x))
812 extern Void hugsStackOverflow Args((Void));
816 #define STACK_HEADROOM 16384
817 #define STACK_CHECK if (StackSpace() <= STACK_HEADROOM) \
818 internal("Macintosh function parameter stack overflow.");
823 /* --------------------------------------------------------------------------
824 * Script file control:
825 * The implementation of script file storage is hidden.
826 * ------------------------------------------------------------------------*/
828 extern Script startNewScript Args((String));
829 extern Bool moduleThisScript Args((Module));
830 extern Module moduleOfScript Args((Script));
831 extern Bool isPreludeScript Args((Void));
832 extern Module lastModule Args((Void));
833 extern Script scriptThisFile Args((Text));
834 extern Script scriptThisName Args((Name));
835 extern Script scriptThisTycon Args((Tycon));
836 extern Script scriptThisInst Args((Inst));
837 extern Script scriptThisClass Args((Class));
838 extern String fileOfModule Args((Module));
839 extern Void dropScriptsFrom Args((Script));
842 /* --------------------------------------------------------------------------
844 * ------------------------------------------------------------------------*/
847 /* This is an exact copy of the declaration found in GreenCard.h */
849 typedef int HugsStackPtr;
850 typedef int HugsStablePtr;
851 typedef Pointer HugsForeign;
855 /* evaluate next argument */
856 int (*getInt ) Args(());
857 unsigned int (*getWord ) Args(());
858 void* (*getAddr ) Args(());
859 float (*getFloat ) Args(());
860 double (*getDouble) Args(());
861 char (*getChar ) Args(());
862 HugsForeign (*getForeign) Args(());
863 HugsStablePtr (*getStablePtr) Args(());
865 /* push part of result */
866 void (*putInt ) Args((int));
867 void (*putWord ) Args((unsigned int));
868 void (*putAddr ) Args((void*));
869 void (*putFloat ) Args((double));
870 void (*putDouble) Args((double));
871 void (*putChar ) Args((char));
872 void (*putForeign) Args((HugsForeign, void (*)(HugsForeign)));
873 void (*putStablePtr) Args((HugsStablePtr));
875 /* return n values in IO monad or Id monad */
876 void (*returnIO) Args((HugsStackPtr, int));
877 void (*returnId) Args((HugsStackPtr, int));
878 int (*runIO) Args((int));
880 /* free a stable pointer */
881 void (*freeStablePtr) Args((HugsStablePtr));
883 /* register the prim table */
884 void (*registerPrims) Args((struct primInfo*));
886 /* garbage collect */
887 void (*garbageCollect) Args(());
891 extern HugsAPI2* hugsAPI2 Args((Void));
892 typedef Void (*InitModuleFun2) Args((HugsAPI2*));
895 Name nameTrue, nameFalse;
896 Name nameNil, nameCons;
897 Name nameJust, nameNothing;
898 Name nameLeft, nameRight;
902 Cell (*makeInt) Args((Int));
904 Cell (*makeChar) Args((Char));
905 Char (*CharOf) Args((Cell));
907 Cell (*makeFloat) Args((FloatPro));
908 Cell (*makeTuple) Args((Int));
909 Pair (*pair) Args((Cell,Cell));
911 Cell (*mkMallocPtr) Args((Void *, Void (*)(Void *)));
912 Void *(*derefMallocPtr) Args((Cell));
914 Int (*mkStablePtr) Args((Cell));
915 Cell (*derefStablePtr) Args((Int));
916 Void (*freeStablePtr) Args((Int));
918 Void (*eval) Args((Cell));
919 Cell (*evalWithNoError) Args((Cell));
920 Void (*evalFails) Args((StackPtr));
926 Void (*garbageCollect) Args(());
927 Void (*stackOverflow) Args(());
928 Void (*internal) Args((String)) HUGS_noreturn;
930 Void (*registerPrims) Args((struct primInfo*));
931 Name (*addPrimCfun) Args((Text,Int,Int,Cell));
932 Text (*inventText) Args(());
934 Cell *(*Fst) Args((Cell));
935 Cell *(*Snd) Args((Cell));
941 extern HugsAPI1* hugsAPI1 Args((Void));
942 typedef Void (*InitModuleFun1) Args((HugsAPI1*));
946 /* --------------------------------------------------------------------------
948 * ------------------------------------------------------------------------*/
950 extern Void setLastExpr Args((Cell));
951 extern Cell getLastExpr Args((Void));
952 extern List addTyconsMatching Args((String,List));
953 extern List addNamesMatching Args((String,List));
955 /*-------------------------------------------------------------------------*/