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: 2000/03/09 02:47:13 $
13 * ------------------------------------------------------------------------*/
15 /* --------------------------------------------------------------------------
17 * ------------------------------------------------------------------------*/
19 extern Bool haskell98; /* TRUE => Haskell 98 compatibility*/
20 extern Bool combined; /* TRUE => combined operation */
21 extern Module modulePrelude;
23 /* --------------------------------------------------------------------------
24 * Primitive constructor functions
25 * ------------------------------------------------------------------------*/
27 extern Name nameFalse, nameTrue;
28 extern Name nameNil, nameCons;
29 extern Name nameJust, nameNothing;
30 extern Name nameLeft, nameRight;
33 extern Name nameLT, nameEQ;
35 extern Name nameFst, nameSnd; /* standard combinators */
36 extern Name nameId, nameOtherwise;
37 extern Name nameNegate, nameFlip; /* primitives reqd for parsing */
38 extern Name nameFrom, nameFromThen;
39 extern Name nameFromTo, nameFromThenTo;
40 extern Name nameFatbar, nameFail; /* primitives reqd for translation */
41 extern Name nameIf, nameSel;
42 extern Name nameCompAux;
43 extern Name namePmInt, namePmFlt; /* primitives for pattern matching */
44 extern Name namePmInteger;
46 extern Name namePmNpk, namePmSub; /* primitives for (n+k) patterns */
48 extern Name nameError; /* For runtime error messages */
49 extern Name nameUndefined; /* A generic undefined value */
50 extern Name nameBlackHole; /* For GC-detected black hole */
51 extern Name nameInd; /* For dict indirection */
52 extern Name nameAnd, nameOr; /* For optimisation of && and || */
53 extern Name nameFromInt, nameFromDouble;/*coercion of numerics */
54 extern Name nameFromInteger;
55 extern Name nameEq, nameCompare; /* names used for deriving */
56 extern Name nameMinBnd, nameMaxBnd;
57 extern Name nameIndex, nameInRange;
58 extern Name nameRange;
59 extern Name nameLe, nameGt;
60 extern Name nameShowsPrec, nameReadsPrec;
61 extern Name nameMult, namePlus;
62 extern Name nameComp, nameApp; /* composition and append */
63 extern Name nameShowField; /* display single field */
64 extern Name nameShowParen; /* wrap with parens */
65 extern Name nameReadField; /* read single field */
66 extern Name nameReadParen; /* unwrap from parens */
67 extern Name nameLex; /* lexer */
68 extern Name nameRangeSize; /* calculate size of index range */
69 extern Class classMonad; /* Monads */
70 extern Name nameReturn, nameBind; /* for translating monad comps */
71 extern Name nameMFail;
72 extern Name nameListMonad; /* builder function for List Monad */
73 extern Name namePrint; /* printing primitive */
74 extern Name nameCreateAdjThunk; /* f-x-dyn: create adjustor thunk */
75 extern Text textPrelude;
76 extern Text textNum; /* used to process default decls */
77 extern Text textCcall; /* used to process foreign import */
78 extern Text textStdcall; /* ... and foreign export */
81 extern Text textPlus; /* Used to recognise n+k patterns */
84 extern Name nameNoRec; /* The empty record */
85 extern Type typeNoRow; /* The empty row */
86 extern Type typeRec; /* Record formation */
87 extern Kind extKind; /* Kind of extension, *->row->row */
88 extern Name nameRecExt; /* Extend a record */
89 extern Name nameRecBrk; /* Break a record */
90 extern Name nameAddEv; /* Addition of evidence values */
91 extern Name nameRecSel; /* Select a record */
92 extern Name nameRecShw; /* Show a record */
93 extern Name nameShowRecRow; /* Used to output rows */
94 extern Name nameRecEq; /* Compare records */
95 extern Name nameEqRecRow; /* Used to compare rows */
96 extern Name nameInsFld; /* Field insertion routine */
99 extern String repeatStr; /* Repeat last command string */
100 extern String hugsEdit; /* String for editor command */
101 extern String hugsPath; /* String for file search path */
102 extern String projectPath; /* String for project search path */
104 extern Type typeProgIO; /* For the IO monad, IO a */
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 showInstRes; /* TRUE => show instance resolution */
161 extern Int cutoff; /* Constraint Cutoff depth */
164 extern String preprocessor; /* preprocessor command */
168 extern Bool debugCode; /* TRUE => print G-code to screen */
170 extern Bool debugSC; /* TRUE => print SC to screen */
171 extern Bool kindExpert; /* TRUE => display kind errors in */
173 extern Bool allowOverlap; /* TRUE => allow overlapping insts */
175 /* --------------------------------------------------------------------------
176 * Function prototypes etc...
177 * ------------------------------------------------------------------------*/
179 extern Void everybody Args((Int));
182 #define RESET 1 /* reset subsystem */
183 #define MARK 2 /* mark parts of graph in use by subsystem */
184 #define PREPREL 3 /* do startup actions before Prelude loading */
185 #define POSTPREL 4 /* do startup actions after Prelude loading */
186 #define EXIT 5 /* Take action immediately before exit() */
187 #define BREAK 6 /* Take action after program break */
188 #define GCDONE 7 /* Restore subsystem invariantss after GC */
190 /* PREPREL was formerly called INSTALL. POSTPREL doesn't have an analogy
196 extern Void setGoal Args((String, Target));
197 extern Void soFar Args((Target));
198 extern Void done Args((Void));
199 extern String fromEnv Args((String,String));
200 extern Bool chase Args((List));
202 extern Void storage Args((Int));
204 extern Void input Args((Int));
205 extern Void consoleInput Args((String));
206 extern Void projInput Args((String));
207 extern Void stringInput Args((String));
208 extern Void parseScript Args((String,Long));
209 extern Void parseExp Args((Void));
210 #if EXPLAIN_INSTANCE_RESOLUTION
211 extern Void parseContext Args((Void));
213 extern String readFilename Args((Void));
214 extern String readLine Args((Void));
215 extern Syntax defaultSyntax Args((Text));
216 extern Syntax syntaxOf Args((Name));
217 extern String unlexChar Args((Char,Char));
218 extern Void printString Args((String));
220 extern Void substitution Args((Int));
221 extern Void optimiser Args((Int));
223 extern Void staticAnalysis Args((Int));
224 extern Void startModule Args((Cell));
225 extern Void setExportList Args((List));
226 extern Void setExports Args((List));
227 extern Void addQualImport Args((Text,Text));
228 extern Void addUnqualImport Args((Text,List));
230 extern Void tyconDefn Args((Int,Cell,Cell,Cell));
231 extern Void setTypeIns Args((List));
232 extern Void clearTypeIns Args((Void));
233 extern Type fullExpand Args((Type));
234 extern Bool isAmbiguous Args((Type));
235 extern Void ambigError Args((Int,String,Cell,Type));
236 extern Void classDefn Args((Int,Cell,List,List));
237 extern Void instDefn Args((Int,Cell,Cell));
238 extern Void addTupInst Args((Class,Int));
240 extern Inst addRecShowInst Args((Class,Ext));
241 extern Inst addRecEqInst Args((Class,Ext));
243 extern List typeVarsIn Args((Cell,List,List,List));
244 extern List oclose Args((List,List));
245 extern List zonkTyvarsIn Args((Type,List));
246 extern Type zonkTyvar Args((Int));
247 extern Type zonkType Args((Type,Int));
248 extern Void primDefn Args((Cell,List,Cell));
249 extern Void defaultDefn Args((Int,List));
250 extern Void checkExp Args((Void));
251 #if EXPLAIN_INSTANCE_RESOLUTION
252 extern Void checkContext Args((Void));
254 extern Void checkDefns Args((Void));
255 extern Bool h98Pred Args((Bool,Cell));
256 extern Cell h98Context Args((Bool,List));
257 extern Void h98CheckCtxt Args((Int,String,Bool,List,Inst));
258 extern Void h98CheckType Args((Int,String,Cell,Type));
259 extern Void h98DoesntSupport Args((Int,String));
261 extern Void typeChecker Args((Int));
262 extern Type typeCheckExp Args((Bool));
263 extern Void typeCheckDefns Args((Void));
264 extern Cell provePred Args((Kinds,List,Cell));
265 extern List simpleContext Args((List,Int));
266 extern Cell rhsExpr Args((Cell));
267 extern Int rhsLine Args((Cell));
268 extern Bool isProgType Args((List,Type));
269 extern Cell superEvid Args((Cell,Class,Class));
270 extern Void linkPreludeTC Args((Void));
271 extern Void linkPreludeCM Args((Void));
273 extern Void compiler Args((Int));
274 extern Void compileDefns Args((Void));
275 extern Void compileExp Args((Void));
276 extern Bool failFree Args((Cell));
277 extern Int discrArity Args((Cell));
279 extern Addr codeGen Args((Name,Int,Cell));
280 extern Void implementCfun Args((Name,List));
282 extern Name implementRecShw Args((Text,Cell));
283 extern Name implementRecEq Args((Text,Cell));
285 extern Void addCfunTable Args((Tycon));
286 extern Name succCfun Args((Name));
287 extern Name nextCfun Args((Name,Name));
288 extern Name cfunByNum Args((Name,Int));
289 extern Void unwind Args((Cell));
290 extern Void run Args((Addr,StackPtr));
292 extern Void eval Args((Cell));
293 extern Cell evalWithNoError Args((Cell));
294 extern Void evalFails Args((StackPtr));
296 extern Void abandon Args((String,Cell));
297 extern Void outputString Args((FILE *));
298 extern Void dialogue Args((Cell));
299 #define consChar(c) ap(nameCons,mkChar(c))
301 extern Int shellEsc Args((String));
302 extern Int getTerminalWidth Args((Void));
303 extern Void normalTerminal Args((Void));
304 extern Void noechoTerminal Args((Void));
305 extern Int readTerminalChar Args((Void));
306 extern Void gcStarted Args((Void));
307 extern Void gcScanning Args((Void));
308 extern Void gcRecovered Args((Int));
309 extern Void gcCStack Args((Void));
310 extern Void needPrims Args((Int));
311 extern List calcFunDepsPreds Args((List));
312 extern Inst findInstFor Args((Cell,Int));
314 extern List findInstsFor Args((Cell,Int));
317 extern Void ppScripts ( Void );
318 extern Void ppModules ( Void );
320 extern Type primType( Int /*AsmMonad*/ monad, String a_kinds, String r_kinds );
321 #define aVar mkOffset(0) /* Simple skeleton for type var */
323 /*-------------------------------------------------------------------------*/
325 /*---------------------------------------------------------------------------
326 * Interrupting execution (signals, allowBreak):
327 *-------------------------------------------------------------------------*/
329 extern Bool breakOn Args((Bool));
331 extern Bool broken; /* indicates interrupt received */
333 #ifndef SIGBREAK /* Sigh, not defined in cygwin32 beta release 16 */
337 /* allowBreak: call to allow user to interrupt computation
338 * ctrlbrk: set control break handler
343 # define allowBreak() kbhit()
344 #else /* !HUGS_FOR_WINDOWS */
345 # if HAVE_SIGPROCMASK
347 # define ctrlbrk(bh) { sigset_t mask; \
349 sigemptyset(&mask); \
350 sigaddset(&mask, SIGINT); \
351 sigprocmask(SIG_UNBLOCK, &mask, NULL); \
354 # define ctrlbrk(bh) signal(SIGINT,bh)
357 extern int time_release;
358 extern int allow_break_count;
359 # define allowBreak() if (time_release !=0 && \
360 (++allow_break_count % time_release) == 0) \
363 # define allowBreak() if (broken) { broken=FALSE; sigRaise(breakHandler); }
365 #endif /* !HUGS_FOR_WINDOWS */
367 /*---------------------------------------------------------------------------
368 * Environment variables and the registry
369 *-------------------------------------------------------------------------*/
371 /* On Win32 we can use the registry to supplement info in environment
374 /* AJG: Commented out for now for development */
375 /* #define USE_REGISTRY (HAVE_WINDOWS_H && !__MSDOS__) */
378 Bool writeRegString Args((String var, String val));
379 String readRegString Args((String var, String def));
380 Int readRegInt Args((String var, Int def));
381 Bool writeRegInt Args((String var, Int val));
384 #define N_INSTALLDIR 200
385 extern char installDir[N_INSTALLDIR];
387 /*---------------------------------------------------------------------------
389 *-------------------------------------------------------------------------*/
392 # include <sys/types.h>
394 #elif !HUGS_FOR_WINDOWS
395 extern int chdir Args((const char*));
401 extern int system Args((const char *));
402 extern double atof Args((const char *));
403 extern void exit Args((int));
406 #ifndef FILENAME_MAX /* should already be defined in an ANSI compiler*/
407 #define FILENAME_MAX 256
409 #if FILENAME_MAX < 256
411 #define FILENAME_MAX 256
415 /* Hack, hack: if you have dos.h, you probably have a DOS filesystem */
416 #define DOS_FILENAMES HAVE_DOS_H
417 /* ToDo: can we replace this with a feature test? */
418 #define MAC_FILENAMES SYMANTEC_C
420 #define CASE_INSENSITIVE_FILENAMES (DOS_FILENAMES | RISCOS)
422 #if CASE_INSENSITIVE_FILENAMES
424 # define filenamecmp(s1,s2) strcasecmp(s1,s2)
426 # define filenamecmp(s1,s2) _stricmp(s1,s2)
428 # define filenamecmp(s1,s2) stricmp(s1,s2)
430 # define filenamecmp(s1,s2) strcmpi(s1,s2)
433 # define filenamecmp(s1,s2) strcmp(s1,s2)
436 /*---------------------------------------------------------------------------
437 * Pipe-related operations:
439 * On Windows, many standard Unix names acquire a leading underscore.
440 * Irritating, but easy to work around.
441 *-------------------------------------------------------------------------*/
443 #if !defined(HAVE_POPEN) && defined(HAVE__POPEN)
444 #define popen(x,y) _popen(x,y)
446 #if !defined(HAVE_PCLOSE) && defined(HAVE__PCLOSE)
447 #define pclose(x) _pclose(x)
450 /*---------------------------------------------------------------------------
452 *-------------------------------------------------------------------------*/
454 #define bitArraySize(n) ((n)/bitsPerWord + 1)
455 #define placeInSet(n) ((-(n)-1)>>wordShift)
456 #define maskInSet(n) (1<<((-(n)-1)&wordMask))
458 /*---------------------------------------------------------------------------
459 * Function prototypes for code in machdep.c
460 *-------------------------------------------------------------------------*/
462 extern String findMPathname Args((String,String,String));
463 extern String findPathname Args((String,String));
465 extern Int shellEsc Args((String));
466 extern Int getTerminalWidth Args((Void));
467 extern Void normalTerminal Args((Void));
468 extern Void noechoTerminal Args((Void));
469 extern Int readTerminalChar Args((Void));
470 extern Void gcStarted Args((Void));
471 extern Void gcScanning Args((Void));
472 extern Void gcRecovered Args((Int));
473 extern Void gcCStack Args((Void));
475 /*-------------------------------------------------------------------------*/
477 extern Type typeInt64;
478 extern Type typeWord;
479 extern Type typeFloat;
480 extern Type typePrimArray;
481 extern Type typePrimByteArray;
483 extern Type typePrimMutableArray;
484 extern Type typePrimMutableByteArray;
485 extern Type typeStable;
486 extern Type typeWeak;
488 extern Type typeForeign;
489 extern Type typeMVar;
490 extern Type typeThreadId;
491 extern Type typeException;
495 extern Void foreignImport Args((Cell,Text,Pair,Cell,Cell));
496 extern List foreignImports; /* foreign import declarations */
497 extern Void implementForeignImport Args((Name));
498 extern Void foreignExport Args((Cell,Text,Cell,Cell,Cell));
499 extern List foreignExports; /* foreign export declarations */
500 extern Void implementForeignExport Args((Name));
505 Int userArity Args((Name));
508 extern List deriveEq Args((Tycon));
509 extern List deriveOrd Args((Tycon));
510 extern List deriveEnum Args((Tycon));
511 extern List deriveIx Args((Tycon));
512 extern List deriveShow Args((Tycon));
513 extern List deriveRead Args((Cell));
514 extern List deriveBounded Args((Tycon));
515 extern List checkPrimDefn Args((Triple));
517 extern Bool typeMatches Args((Type,Type));
518 extern Void evalExp Args((Void));
519 extern Void linkControl Args((Int));
520 extern Void deriveControl Args((Int));
521 extern Void translateControl Args((Int));
522 extern Void codegen Args((Int));
523 extern Void machdep Args((Int));
525 extern Void linkPrimitiveNames(void);
527 extern Kind starToStar; /* Type -> Type */
528 extern Type boundPair; /* (mkOffset(0),mkOffset(0)) */
529 extern Type typeOrdering;
531 extern Type conToTagType Args((Tycon));
532 extern Type tagToConType Args((Tycon));
534 #define BOGUS(k) (-9000000-(k))
536 extern Void putChr Args((Int));
537 extern Void putStr Args((String));
538 extern Void putInt Args((Int));
539 extern Void putPtr Args((Ptr));
541 extern Void unlexCharConst Args((Cell));
542 extern FILE *outputStream; /* current output stream */
543 extern Int outColumn; /* current output column number */
545 extern Void unlexStrConst Args((Text));
546 extern Void unlexVar Args((Text));
547 extern Void unlexVarStr Args((String));
548 extern List offsetTyvarsIn Args((Type,List));
550 extern List cfunSfuns; /* List of (Cfun,[SelectorVar]) */
552 extern Void interface Args((Int));
554 extern Void getFileSize Args((String, Long *));
556 extern ZPair readInterface Args((String,Long));
557 extern Bool processInterfaces Args((Void));
559 extern List /* of ZTriple(I_INTERFACE,
560 Text--name of obj file,
561 Int--size of obj file) */
565 extern Void hi_o_namesFromSrcName Args((String,String*,String* oName));
566 extern Cell parseInterface Args((String,Long));
568 extern String getExtraObjectInfo ( String primaryObjectName,
569 String extraFileName,
570 Int* extraFileSize );