1 /* --------------------------------------------------------------------------
2 * Connections between components of the Hugs system
4 * The Hugs 98 system is Copyright (c) Mark P Jones, Alastair Reid, the
5 * Yale Haskell Group, and the Oregon Graduate Institute of Science and
6 * Technology, 1994-1999, All rights reserved. It is distributed as
7 * free software under the license in the file "License", which is
8 * included in the distribution.
10 * $RCSfile: connect.h,v $
12 * $Date: 1999/10/16 02:17:30 $
13 * ------------------------------------------------------------------------*/
15 /* --------------------------------------------------------------------------
17 * ------------------------------------------------------------------------*/
19 extern Bool haskell98; /* TRUE => Haskell 98 compatibility*/
20 extern Module modulePrelude;
22 /* --------------------------------------------------------------------------
23 * Primitive constructor functions
24 * ------------------------------------------------------------------------*/
26 extern Name nameFalse, nameTrue;
27 extern Name nameNil, nameCons;
28 extern Name nameJust, nameNothing;
29 extern Name nameLeft, nameRight;
32 extern Name nameLT, nameEQ;
34 extern Name nameFst, nameSnd; /* standard combinators */
35 extern Name nameId, nameOtherwise;
36 extern Name nameNegate, nameFlip; /* primitives reqd for parsing */
37 extern Name nameFrom, nameFromThen;
38 extern Name nameFromTo, nameFromThenTo;
39 extern Name nameFatbar, nameFail; /* primitives reqd for translation */
40 extern Name nameIf, nameSel;
41 extern Name nameCompAux;
42 extern Name namePmInt, namePmFlt; /* primitives for pattern matching */
43 extern Name namePmInteger;
45 extern Name namePmNpk, namePmSub; /* primitives for (n+k) patterns */
47 extern Name nameError; /* For runtime error messages */
48 extern Name nameUndefined; /* A generic undefined value */
49 extern Name nameBlackHole; /* For GC-detected black hole */
50 extern Name nameInd; /* For dict indirection */
51 extern Name nameAnd, nameOr; /* For optimisation of && and || */
52 extern Name nameFromInt, nameFromDouble;/*coercion of numerics */
53 extern Name nameFromInteger;
54 extern Name nameEq, nameCompare; /* names used for deriving */
55 extern Name nameMinBnd, nameMaxBnd;
56 extern Name nameIndex, nameInRange;
57 extern Name nameRange;
58 extern Name nameLe, nameGt;
59 extern Name nameShowsPrec, nameReadsPrec;
60 extern Name nameMult, namePlus;
61 extern Name nameConCmp, nameEnRange;
62 extern Name nameEnIndex, nameEnInRng;
63 extern Name nameEnToEn, nameEnFrEn;
64 extern Name nameEnFrom, nameEnFrTh;
65 extern Name nameEnFrTo;
66 extern Name nameComp, nameApp; /* composition and append */
67 extern Name nameShowField; /* display single field */
68 extern Name nameShowParen; /* wrap with parens */
69 extern Name nameReadField; /* read single field */
70 extern Name nameReadParen; /* unwrap from parens */
71 extern Name nameLex; /* lexer */
72 extern Name nameRangeSize; /* calculate size of index range */
73 extern Class classMonad; /* Monads */
74 extern Name nameReturn, nameBind; /* for translating monad comps */
75 extern Name nameMFail;
76 extern Name nameListMonad; /* builder function for List Monad */
77 extern Name namePrint; /* printing primitive */
78 extern Name nameCreateAdjThunk; /* f-x-dyn: create adjustor thunk */
79 extern Text textPrelude;
80 extern Text textNum; /* used to process default decls */
82 extern Text textPlus; /* Used to recognise n+k patterns */
85 extern Name nameNoRec; /* The empty record */
86 extern Type typeNoRow; /* The empty row */
87 extern Type typeRec; /* Record formation */
88 extern Kind extKind; /* Kind of extension, *->row->row */
89 extern Name nameRecExt; /* Extend a record */
90 extern Name nameRecBrk; /* Break a record */
91 extern Name nameAddEv; /* Addition of evidence values */
92 extern Name nameRecSel; /* Select a record */
93 extern Name nameRecShw; /* Show a record */
94 extern Name nameShowRecRow; /* Used to output rows */
95 extern Name nameRecEq; /* Compare records */
96 extern Name nameEqRecRow; /* Used to compare rows */
97 extern Name nameInsFld; /* Field insertion routine */
100 extern String repeatStr; /* Repeat last command string */
101 extern String hugsEdit; /* String for editor command */
102 extern String hugsPath; /* String for file search path */
103 extern String projectPath; /* String for project search path */
105 extern Type typeArrow; /* Builtin type constructors */
106 extern Type typeList;
107 extern Type typeUnit;
109 #define fn(from,to) ap(ap(typeArrow,from),to) /* make type: from -> to */
111 extern List stdDefaults; /* List of standard default types */
113 extern Class classEq; /* `standard' classes */
114 extern Class classOrd;
115 extern Class classShow;
116 extern Class classRead;
117 extern Class classIx;
118 extern Class classEnum;
119 extern Class classBounded;
121 extern Class classReal; /* `numeric' classes */
122 extern Class classIntegral;
123 extern Class classRealFrac;
124 extern Class classRealFloat;
125 extern Class classFractional;
126 extern Class classFloating;
127 extern Class classNum;
129 extern Cell *CStackBase; /* pointer to base of C stack */
131 extern List tyconDefns; /* list of type constructor defns */
132 extern List typeInDefns; /* list of synonym restrictions */
133 extern List valDefns; /* list of value definitions */
134 extern List classDefns; /* list of class definitions */
135 extern List instDefns; /* list of instance definitions */
136 extern List selDefns; /* list of selector lists */
137 extern List genDefns; /* list of generated defns */
138 extern List primDefns; /* list of primitive definitions */
139 extern List unqualImports; /* unqualified import list */
140 extern List defaultDefns; /* default definitions (if any) */
141 extern Int defaultLine; /* line in which default defs occur*/
142 extern List evalDefaults; /* defaults for evaluator */
143 extern Cell inputExpr; /* evaluator input expression */
144 extern Cell inputContext; /* evaluator input expression */
145 extern Addr inputCode; /* Code for compiled input expr */
147 extern Int whnfArgs; /* number of args of term in whnf */
148 extern Cell whnfHead; /* head of term in whnf */
149 extern Int whnfInt; /* integer value of term in whnf */
150 extern Float whnfFloat; /* float value of term in whnf */
151 extern Long numCells; /* number of cells allocated */
152 extern Int numGcs; /* number of garbage collections */
153 extern Bool broken; /* indicates interrupt received */
154 extern Bool preludeLoaded; /* TRUE => prelude has been loaded */
156 extern Bool gcMessages; /* TRUE => print GC messages */
157 extern Bool literateScripts; /* TRUE => default lit scripts */
158 extern Bool literateErrors; /* TRUE => report errs in lit scrs */
159 extern Bool optimise; /* TRUE => simplify STG */
161 extern Int cutoff; /* Constraint Cutoff depth */
164 extern String preprocessor; /* preprocessor command */
168 extern Bool debugCode; /* TRUE => print G-code to screen */
171 extern Bool debugSC; /* TRUE => print SC to screen */
172 extern Void printSc Args((FILE*, Text, Int, Cell));
174 extern Bool kindExpert; /* TRUE => display kind errors in */
176 extern Bool allowOverlap; /* TRUE => allow overlapping insts */
178 /* --------------------------------------------------------------------------
179 * Function prototypes etc...
180 * ------------------------------------------------------------------------*/
182 extern Void everybody Args((Int));
184 #define RESET 1 /* reset subsystem */
185 #define MARK 2 /* mark parts of graph in use by subsystem */
186 #define INSTALL 3 /* install subsystem (executed once only) */
187 #define EXIT 4 /* Take action immediately before exit() */
188 #define BREAK 5 /* Take action after program break */
189 #define GCDONE 6 /* Restore subsystem invariantss after GC */
192 extern Void setGoal Args((String, Target));
193 extern Void soFar Args((Target));
194 extern Void done Args((Void));
195 extern String fromEnv Args((String,String));
196 extern Bool chase Args((List));
198 extern Void storage Args((Int));
200 extern Void input Args((Int));
201 extern Void consoleInput Args((String));
202 extern Void projInput Args((String));
203 extern Void stringInput Args((String));
204 extern Void parseScript Args((String,Long));
205 extern Void parseExp Args((Void));
206 extern Void parseContext Args((Void));
207 extern String readFilename Args((Void));
208 extern String readLine Args((Void));
209 extern Syntax defaultSyntax Args((Text));
210 extern Syntax syntaxOf Args((Name));
211 extern String unlexChar Args((Char,Char));
212 extern Void printString Args((String));
214 extern Void substitution Args((Int));
215 extern Void optimiser Args((Int));
217 extern Void staticAnalysis Args((Int));
218 extern Void startModule Args((Cell));
219 extern Void setExportList Args((List));
220 extern Void setExports Args((List));
221 extern Void addQualImport Args((Text,Text));
222 extern Void addUnqualImport Args((Text,List));
224 extern Void tyconDefn Args((Int,Cell,Cell,Cell));
225 extern Void setTypeIns Args((List));
226 extern Void clearTypeIns Args((Void));
227 extern Type fullExpand Args((Type));
228 extern Bool isAmbiguous Args((Type));
229 extern Void ambigError Args((Int,String,Cell,Type));
230 extern Void classDefn Args((Int,Cell,List,List));
231 extern Void instDefn Args((Int,Cell,Cell));
232 extern Void addTupInst Args((Class,Int));
234 extern Inst addRecShowInst Args((Class,Ext));
235 extern Inst addRecEqInst Args((Class,Ext));
237 extern List oclose Args((List,List));
238 extern List zonkTyvarsIn Args((Type,List));
239 extern Type zonkTyvar Args((Int));
240 extern Type zonkType Args((Type,Int));
241 extern Void primDefn Args((Cell,List,Cell));
242 extern Void defaultDefn Args((Int,List));
243 extern Void checkExp Args((Void));
244 extern Void checkDefns Args((Void));
245 extern Bool h98Pred Args((Bool,Cell));
246 extern Cell h98Context Args((Bool,List));
247 extern Void h98CheckCtxt Args((Int,String,Bool,List,Inst));
248 extern Void h98CheckType Args((Int,String,Cell,Type));
249 extern Void h98DoesntSupport Args((Int,String));
251 extern Void typeChecker Args((Int));
252 extern Type typeCheckExp Args((Bool));
253 extern Void typeCheckDefns Args((Void));
254 extern Cell provePred Args((Kinds,List,Cell));
255 extern List simpleContext Args((List,Int));
256 extern Cell rhsExpr Args((Cell));
257 extern Int rhsLine Args((Cell));
258 extern Bool isProgType Args((List,Type));
259 extern Cell superEvid Args((Cell,Class,Class));
260 extern Void linkPreludeTC Args((Void));
261 extern Void linkPreludeCM Args((Void));
263 extern Void compiler Args((Int));
264 extern Void compileDefns Args((Void));
265 extern Void compileExp Args((Void));
266 extern Bool failFree Args((Cell));
267 extern Int discrArity Args((Cell));
269 extern Addr codeGen Args((Name,Int,Cell));
270 extern Void implementCfun Args((Name,List));
272 extern Name implementRecShw Args((Text,Cell));
273 extern Name implementRecEq Args((Text,Cell));
275 extern Void addCfunTable Args((Tycon));
276 extern Name succCfun Args((Name));
277 extern Name nextCfun Args((Name,Name));
278 extern Name cfunByNum Args((Name,Int));
279 extern Void unwind Args((Cell));
280 extern Void run Args((Addr,StackPtr));
282 extern Void eval Args((Cell));
283 extern Cell evalWithNoError Args((Cell));
284 extern Void evalFails Args((StackPtr));
286 extern Void abandon Args((String,Cell));
287 extern Void outputString Args((FILE *));
288 extern Void dialogue Args((Cell));
289 #define consChar(c) ap(nameCons,mkChar(c))
291 extern Int shellEsc Args((String));
292 extern Int getTerminalWidth Args((Void));
293 extern Void normalTerminal Args((Void));
294 extern Void noechoTerminal Args((Void));
295 extern Int readTerminalChar Args((Void));
296 extern Void gcStarted Args((Void));
297 extern Void gcScanning Args((Void));
298 extern Void gcRecovered Args((Int));
299 extern Void gcCStack Args((Void));
300 extern Void needPrims Args((Int));
301 extern List calcFunDepsPreds Args((List));
302 extern Inst findInstFor Args((Cell,Int));
304 extern Type primType( Int /*AsmMonad*/ monad, String a_kinds, String r_kinds );
305 #define aVar mkOffset(0) /* Simple skeleton for type var */
307 /*-------------------------------------------------------------------------*/
309 /*---------------------------------------------------------------------------
310 * Interrupting execution (signals, allowBreak):
311 *-------------------------------------------------------------------------*/
313 extern Bool breakOn Args((Bool));
315 extern Bool broken; /* indicates interrupt received */
317 #ifndef SIGBREAK /* Sigh, not defined in cygwin32 beta release 16 */
321 /* allowBreak: call to allow user to interrupt computation
322 * ctrlbrk: set control break handler
327 # define allowBreak() kbhit()
328 #else /* !HUGS_FOR_WINDOWS */
329 # define ctrlbrk(bh) signal(SIGINT,bh); signal(SIGBREAK,bh)
330 # define allowBreak() if (broken) { broken=FALSE; sigRaise(breakHandler); }
331 #endif /* !HUGS_FOR_WINDOWS */
333 /*---------------------------------------------------------------------------
334 * Environment variables and the registry
335 *-------------------------------------------------------------------------*/
337 /* On Win32 we can use the registry to supplement info in environment
340 /* AJG: Commented out for now for development */
341 /* #define USE_REGISTRY (HAVE_WINDOWS_H && !__MSDOS__) */
344 Bool writeRegString Args((String var, String val));
345 String readRegString Args((String var, String def));
346 Int readRegInt Args((String var, Int def));
347 Bool writeRegInt Args((String var, Int val));
350 /*---------------------------------------------------------------------------
352 *-------------------------------------------------------------------------*/
355 # include <sys/types.h>
357 #elif !HUGS_FOR_WINDOWS
358 extern int chdir Args((const char*));
364 extern int system Args((const char *));
365 extern double atof Args((const char *));
366 extern void exit Args((int));
369 #ifndef FILENAME_MAX /* should already be defined in an ANSI compiler*/
370 #define FILENAME_MAX 256
372 #if FILENAME_MAX < 256
374 #define FILENAME_MAX 256
378 /* Hack, hack: if you have dos.h, you probably have a DOS filesystem */
379 #define DOS_FILENAMES HAVE_DOS_H
380 /* ToDo: can we replace this with a feature test? */
381 #define MAC_FILENAMES SYMANTEC_C
383 #define CASE_INSENSITIVE_FILENAMES (DOS_FILENAMES | RISCOS)
385 #if CASE_INSENSITIVE_FILENAMES
387 # define filenamecmp(s1,s2) strcasecmp(s1,s2)
389 # define filenamecmp(s1,s2) _stricmp(s1,s2)
391 # define filenamecmp(s1,s2) stricmp(s1,s2)
393 # define filenamecmp(s1,s2) strcmpi(s1,s2)
396 # define filenamecmp(s1,s2) strcmp(s1,s2)
399 /*---------------------------------------------------------------------------
400 * Pipe-related operations:
402 * On Windows, many standard Unix names acquire a leading underscore.
403 * Irritating, but easy to work around.
404 *-------------------------------------------------------------------------*/
406 #if !defined(HAVE_POPEN) && defined(HAVE__POPEN)
407 #define popen(x,y) _popen(x,y)
409 #if !defined(HAVE_PCLOSE) && defined(HAVE__PCLOSE)
410 #define pclose(x) _pclose(x)
413 /*---------------------------------------------------------------------------
415 *-------------------------------------------------------------------------*/
417 #define bitArraySize(n) ((n)/bitsPerWord + 1)
418 #define placeInSet(n) ((-(n)-1)>>wordShift)
419 #define maskInSet(n) (1<<((-(n)-1)&wordMask))
421 /*---------------------------------------------------------------------------
422 * Function prototypes for code in machdep.c
423 *-------------------------------------------------------------------------*/
425 extern String findMPathname Args((String,String,String));
426 extern String findPathname Args((String,String));
428 extern Int shellEsc Args((String));
429 extern Int getTerminalWidth Args((Void));
430 extern Void normalTerminal Args((Void));
431 extern Void noechoTerminal Args((Void));
432 extern Int readTerminalChar Args((Void));
433 extern Void gcStarted Args((Void));
434 extern Void gcScanning Args((Void));
435 extern Void gcRecovered Args((Int));
436 extern Void gcCStack Args((Void));
438 /*-------------------------------------------------------------------------*/
440 extern Type typeInt64;
441 extern Type typeWord;
442 extern Type typeFloat;
443 extern Type typePrimArray;
444 extern Type typePrimByteArray;
446 extern Type typePrimMutableArray;
447 extern Type typePrimMutableByteArray;
448 extern Type typeStable;
449 extern Type typeWeak;
451 extern Type typeForeign;
452 extern Type typeMVar;
453 extern Type typeThreadId;
454 extern Type typeException;
458 extern Void foreignImport Args((Cell,Pair,Cell,Cell));
459 extern List foreignImports; /* foreign import declarations */
460 extern Void implementForeignImport Args((Name));
461 extern Void foreignExport Args((Cell,Cell,Cell,Cell));
462 extern List foreignExports; /* foreign export declarations */
463 extern Void implementForeignExport Args((Name));
468 Int userArity Args((Name));
471 extern List deriveEq Args((Tycon));
472 extern List deriveOrd Args((Tycon));
473 extern List deriveEnum Args((Tycon));
474 extern List deriveIx Args((Tycon));
475 extern List deriveShow Args((Tycon));
476 extern List deriveRead Args((Cell));
477 extern List deriveBounded Args((Tycon));
478 extern List checkPrimDefn Args((Triple));
480 extern Bool typeMatches Args((Type,Type));
481 extern Void evalExp Args((Void));
482 extern Void linkControl Args((Int));
483 extern Void deriveControl Args((Int));
484 extern Void translateControl Args((Int));
485 extern Void codegen Args((Int));
486 extern Void machdep Args((Int));
488 extern Void linkPreludeNames(void);
490 extern Kind starToStar; /* Type -> Type */
491 extern Type boundPair; /* (mkOffset(0),mkOffset(0)) */
492 extern Type typeOrdering;
494 extern Type conToTagType Args((Tycon));
495 extern Type tagToConType Args((Tycon));
497 #define BOGUS(k) (-9000000-(k))
499 extern Void putChr Args((Int));
500 extern Void putStr Args((String));
501 extern Void putInt Args((Int));
502 extern Void putPtr Args((Ptr));
504 extern Void unlexCharConst Args((Cell));
505 extern FILE *outputStream; /* current output stream */
506 extern Int outColumn; /* current output column number */
508 extern Void unlexStrConst Args((Text));
509 extern Void unlexVar Args((Text));
510 extern List offsetTyvarsIn Args((Type,List));
512 extern Void optimiseTopBinds Args((List));
513 extern List cfunSfuns; /* List of (Cfun,[SelectorVar]) */
515 extern Void interface Args((Int));
517 extern Void getFileSize Args((String, Long *));
519 extern Void loadInterface Args((String,Long));
521 extern Void openGHCIface Args((Text));
522 extern Void loadSharedLib Args((String));
523 extern Void addGHCImports Args((Int,Text,List));
524 extern Void addGHCExports Args((Cell,List));
525 extern Void addGHCVar Args((Int,Text,Type));
526 extern Void addGHCSynonym Args((Int,Cell,List,Type));
527 extern Void addGHCDataDecl Args((Int,List,Cell,List,List));
528 extern Void addGHCNewType Args((Int,List,Cell,List,Cell));
529 extern Void addGHCClass Args((Int,List,Cell,List,List));
530 extern Void addGHCInstance Args((Int,List,Pair,Text));
531 extern Void finishInterfaces Args((Void));
533 extern Void hi_o_namesFromSrcName Args((String,String*,String* oName));
534 extern Void parseInterface Args((String,Long));
537 #define SMALL_INLINE_SIZE 9
540 // nasty hack, but seems an easy to convey the object name
541 // and size to openGHCIface
542 char nameObj[FILENAME_MAX+1];