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/12/03 17:56:04 $
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 nameComp, nameApp; /* composition and append */
62 extern Name nameShowField; /* display single field */
63 extern Name nameShowParen; /* wrap with parens */
64 extern Name nameReadField; /* read single field */
65 extern Name nameReadParen; /* unwrap from parens */
66 extern Name nameLex; /* lexer */
67 extern Name nameRangeSize; /* calculate size of index range */
68 extern Class classMonad; /* Monads */
69 extern Name nameReturn, nameBind; /* for translating monad comps */
70 extern Name nameMFail;
71 extern Name nameListMonad; /* builder function for List Monad */
72 extern Name namePrint; /* printing primitive */
73 extern Name nameCreateAdjThunk; /* f-x-dyn: create adjustor thunk */
74 extern Text textPrelude;
75 extern Text textNum; /* used to process default decls */
76 extern Text textCcall; /* used to process foreign import */
77 extern Text textStdcall; /* ... and foreign export */
80 extern Text textPlus; /* Used to recognise n+k patterns */
83 extern Name nameNoRec; /* The empty record */
84 extern Type typeNoRow; /* The empty row */
85 extern Type typeRec; /* Record formation */
86 extern Kind extKind; /* Kind of extension, *->row->row */
87 extern Name nameRecExt; /* Extend a record */
88 extern Name nameRecBrk; /* Break a record */
89 extern Name nameAddEv; /* Addition of evidence values */
90 extern Name nameRecSel; /* Select a record */
91 extern Name nameRecShw; /* Show a record */
92 extern Name nameShowRecRow; /* Used to output rows */
93 extern Name nameRecEq; /* Compare records */
94 extern Name nameEqRecRow; /* Used to compare rows */
95 extern Name nameInsFld; /* Field insertion routine */
98 extern String repeatStr; /* Repeat last command string */
99 extern String hugsEdit; /* String for editor command */
100 extern String hugsPath; /* String for file search path */
101 extern String projectPath; /* String for project search path */
103 extern Type typeProgIO; /* For the IO monad, IO a */
104 extern Type typeArrow; /* Builtin type constructors */
105 extern Type typeList;
106 extern Type typeUnit;
108 #define fn(from,to) ap(ap(typeArrow,from),to) /* make type: from -> to */
110 extern List stdDefaults; /* List of standard default types */
112 extern Class classEq; /* `standard' classes */
113 extern Class classOrd;
114 extern Class classShow;
115 extern Class classRead;
116 extern Class classIx;
117 extern Class classEnum;
118 extern Class classBounded;
120 extern Class classReal; /* `numeric' classes */
121 extern Class classIntegral;
122 extern Class classRealFrac;
123 extern Class classRealFloat;
124 extern Class classFractional;
125 extern Class classFloating;
126 extern Class classNum;
128 extern Cell *CStackBase; /* pointer to base of C stack */
130 extern List tyconDefns; /* list of type constructor defns */
131 extern List typeInDefns; /* list of synonym restrictions */
132 extern List valDefns; /* list of value definitions */
133 extern List classDefns; /* list of class definitions */
134 extern List instDefns; /* list of instance definitions */
135 extern List selDefns; /* list of selector lists */
136 extern List genDefns; /* list of generated defns */
137 extern List primDefns; /* list of primitive definitions */
138 extern List unqualImports; /* unqualified import list */
139 extern List defaultDefns; /* default definitions (if any) */
140 extern Int defaultLine; /* line in which default defs occur*/
141 extern List evalDefaults; /* defaults for evaluator */
142 extern Cell inputExpr; /* evaluator input expression */
143 extern Cell inputContext; /* evaluator input expression */
144 extern Addr inputCode; /* Code for compiled input expr */
146 extern Int whnfArgs; /* number of args of term in whnf */
147 extern Cell whnfHead; /* head of term in whnf */
148 extern Int whnfInt; /* integer value of term in whnf */
149 extern Float whnfFloat; /* float value of term in whnf */
150 extern Long numCells; /* number of cells allocated */
151 extern Int numGcs; /* number of garbage collections */
152 extern Bool broken; /* indicates interrupt received */
153 extern Bool preludeLoaded; /* TRUE => prelude has been loaded */
155 extern Bool gcMessages; /* TRUE => print GC messages */
156 extern Bool literateScripts; /* TRUE => default lit scripts */
157 extern Bool literateErrors; /* TRUE => report errs in lit scrs */
158 extern Bool showInstRes; /* TRUE => show instance resolution */
160 extern Int cutoff; /* Constraint Cutoff depth */
163 extern String preprocessor; /* preprocessor command */
167 extern Bool debugCode; /* TRUE => print G-code to screen */
169 extern Bool debugSC; /* TRUE => print SC to screen */
170 extern Bool kindExpert; /* TRUE => display kind errors in */
172 extern Bool allowOverlap; /* TRUE => allow overlapping insts */
174 /* --------------------------------------------------------------------------
175 * Function prototypes etc...
176 * ------------------------------------------------------------------------*/
178 extern Void everybody Args((Int));
180 #define RESET 1 /* reset subsystem */
181 #define MARK 2 /* mark parts of graph in use by subsystem */
182 #define INSTALL 3 /* install subsystem (executed once only) */
183 #define EXIT 4 /* Take action immediately before exit() */
184 #define BREAK 5 /* Take action after program break */
185 #define GCDONE 6 /* Restore subsystem invariantss after GC */
188 extern Void setGoal Args((String, Target));
189 extern Void soFar Args((Target));
190 extern Void done Args((Void));
191 extern String fromEnv Args((String,String));
192 extern Bool chase Args((List));
194 extern Void storage Args((Int));
196 extern Void input Args((Int));
197 extern Void consoleInput Args((String));
198 extern Void projInput Args((String));
199 extern Void stringInput Args((String));
200 extern Void parseScript Args((String,Long));
201 extern Void parseExp Args((Void));
202 #if EXPLAIN_INSTANCE_RESOLUTION
203 extern Void parseContext Args((Void));
205 extern String readFilename Args((Void));
206 extern String readLine Args((Void));
207 extern Syntax defaultSyntax Args((Text));
208 extern Syntax syntaxOf Args((Name));
209 extern String unlexChar Args((Char,Char));
210 extern Void printString Args((String));
212 extern Void substitution Args((Int));
213 extern Void optimiser Args((Int));
215 extern Void staticAnalysis Args((Int));
216 extern Void startModule Args((Cell));
217 extern Void setExportList Args((List));
218 extern Void setExports Args((List));
219 extern Void addQualImport Args((Text,Text));
220 extern Void addUnqualImport Args((Text,List));
222 extern Void tyconDefn Args((Int,Cell,Cell,Cell));
223 extern Void setTypeIns Args((List));
224 extern Void clearTypeIns Args((Void));
225 extern Type fullExpand Args((Type));
226 extern Bool isAmbiguous Args((Type));
227 extern Void ambigError Args((Int,String,Cell,Type));
228 extern Void classDefn Args((Int,Cell,List,List));
229 extern Void instDefn Args((Int,Cell,Cell));
230 extern Void addTupInst Args((Class,Int));
232 extern Inst addRecShowInst Args((Class,Ext));
233 extern Inst addRecEqInst Args((Class,Ext));
235 extern List typeVarsIn Args((Cell,List,List,List));
236 extern List oclose Args((List,List));
237 extern List zonkTyvarsIn Args((Type,List));
238 extern Type zonkTyvar Args((Int));
239 extern Type zonkType Args((Type,Int));
240 extern Void primDefn Args((Cell,List,Cell));
241 extern Void defaultDefn Args((Int,List));
242 extern Void checkExp Args((Void));
243 #if EXPLAIN_INSTANCE_RESOLUTION
244 extern Void checkContext Args((Void));
246 extern Void checkDefns Args((Void));
247 extern Bool h98Pred Args((Bool,Cell));
248 extern Cell h98Context Args((Bool,List));
249 extern Void h98CheckCtxt Args((Int,String,Bool,List,Inst));
250 extern Void h98CheckType Args((Int,String,Cell,Type));
251 extern Void h98DoesntSupport Args((Int,String));
253 extern Void typeChecker Args((Int));
254 extern Type typeCheckExp Args((Bool));
255 extern Void typeCheckDefns Args((Void));
256 extern Cell provePred Args((Kinds,List,Cell));
257 extern List simpleContext Args((List,Int));
258 extern Cell rhsExpr Args((Cell));
259 extern Int rhsLine Args((Cell));
260 extern Bool isProgType Args((List,Type));
261 extern Cell superEvid Args((Cell,Class,Class));
262 extern Void linkPreludeTC Args((Void));
263 extern Void linkPreludeCM Args((Void));
265 extern Void compiler Args((Int));
266 extern Void compileDefns Args((Void));
267 extern Void compileExp Args((Void));
268 extern Bool failFree Args((Cell));
269 extern Int discrArity Args((Cell));
271 extern Addr codeGen Args((Name,Int,Cell));
272 extern Void implementCfun Args((Name,List));
274 extern Name implementRecShw Args((Text,Cell));
275 extern Name implementRecEq Args((Text,Cell));
277 extern Void addCfunTable Args((Tycon));
278 extern Name succCfun Args((Name));
279 extern Name nextCfun Args((Name,Name));
280 extern Name cfunByNum Args((Name,Int));
281 extern Void unwind Args((Cell));
282 extern Void run Args((Addr,StackPtr));
284 extern Void eval Args((Cell));
285 extern Cell evalWithNoError Args((Cell));
286 extern Void evalFails Args((StackPtr));
288 extern Void abandon Args((String,Cell));
289 extern Void outputString Args((FILE *));
290 extern Void dialogue Args((Cell));
291 #define consChar(c) ap(nameCons,mkChar(c))
293 extern Int shellEsc Args((String));
294 extern Int getTerminalWidth Args((Void));
295 extern Void normalTerminal Args((Void));
296 extern Void noechoTerminal Args((Void));
297 extern Int readTerminalChar Args((Void));
298 extern Void gcStarted Args((Void));
299 extern Void gcScanning Args((Void));
300 extern Void gcRecovered Args((Int));
301 extern Void gcCStack Args((Void));
302 extern Void needPrims Args((Int));
303 extern List calcFunDepsPreds Args((List));
304 extern Inst findInstFor Args((Cell,Int));
306 extern List findInstsFor Args((Cell,Int));
309 extern Void ppScripts ( Void );
310 extern Void ppModules ( Void );
312 extern Type primType( Int /*AsmMonad*/ monad, String a_kinds, String r_kinds );
313 #define aVar mkOffset(0) /* Simple skeleton for type var */
315 /*-------------------------------------------------------------------------*/
317 /*---------------------------------------------------------------------------
318 * Interrupting execution (signals, allowBreak):
319 *-------------------------------------------------------------------------*/
321 extern Bool breakOn Args((Bool));
323 extern Bool broken; /* indicates interrupt received */
325 #ifndef SIGBREAK /* Sigh, not defined in cygwin32 beta release 16 */
329 /* allowBreak: call to allow user to interrupt computation
330 * ctrlbrk: set control break handler
335 # define allowBreak() kbhit()
336 #else /* !HUGS_FOR_WINDOWS */
337 # if HAVE_SIGPROCMASK
339 # define ctrlbrk(bh) { sigset_t mask; \
341 sigemptyset(&mask); \
342 sigaddset(&mask, SIGINT); \
343 sigprocmask(SIG_UNBLOCK, &mask, NULL); \
346 # define ctrlbrk(bh) signal(SIGINT,bh)
349 extern int time_release;
350 extern int allow_break_count;
351 # define allowBreak() if (time_release !=0 && \
352 (++allow_break_count % time_release) == 0) \
355 # define allowBreak() if (broken) { broken=FALSE; sigRaise(breakHandler); }
357 #endif /* !HUGS_FOR_WINDOWS */
359 /*---------------------------------------------------------------------------
360 * Environment variables and the registry
361 *-------------------------------------------------------------------------*/
363 /* On Win32 we can use the registry to supplement info in environment
366 /* AJG: Commented out for now for development */
367 /* #define USE_REGISTRY (HAVE_WINDOWS_H && !__MSDOS__) */
370 Bool writeRegString Args((String var, String val));
371 String readRegString Args((String var, String def));
372 Int readRegInt Args((String var, Int def));
373 Bool writeRegInt Args((String var, Int val));
376 #define N_INSTALLDIR 200
377 extern char installDir[N_INSTALLDIR];
379 /*---------------------------------------------------------------------------
381 *-------------------------------------------------------------------------*/
384 # include <sys/types.h>
386 #elif !HUGS_FOR_WINDOWS
387 extern int chdir Args((const char*));
393 extern int system Args((const char *));
394 extern double atof Args((const char *));
395 extern void exit Args((int));
398 #ifndef FILENAME_MAX /* should already be defined in an ANSI compiler*/
399 #define FILENAME_MAX 256
401 #if FILENAME_MAX < 256
403 #define FILENAME_MAX 256
407 /* Hack, hack: if you have dos.h, you probably have a DOS filesystem */
408 #define DOS_FILENAMES HAVE_DOS_H
409 /* ToDo: can we replace this with a feature test? */
410 #define MAC_FILENAMES SYMANTEC_C
412 #define CASE_INSENSITIVE_FILENAMES (DOS_FILENAMES | RISCOS)
414 #if CASE_INSENSITIVE_FILENAMES
416 # define filenamecmp(s1,s2) strcasecmp(s1,s2)
418 # define filenamecmp(s1,s2) _stricmp(s1,s2)
420 # define filenamecmp(s1,s2) stricmp(s1,s2)
422 # define filenamecmp(s1,s2) strcmpi(s1,s2)
425 # define filenamecmp(s1,s2) strcmp(s1,s2)
428 /*---------------------------------------------------------------------------
429 * Pipe-related operations:
431 * On Windows, many standard Unix names acquire a leading underscore.
432 * Irritating, but easy to work around.
433 *-------------------------------------------------------------------------*/
435 #if !defined(HAVE_POPEN) && defined(HAVE__POPEN)
436 #define popen(x,y) _popen(x,y)
438 #if !defined(HAVE_PCLOSE) && defined(HAVE__PCLOSE)
439 #define pclose(x) _pclose(x)
442 /*---------------------------------------------------------------------------
444 *-------------------------------------------------------------------------*/
446 #define bitArraySize(n) ((n)/bitsPerWord + 1)
447 #define placeInSet(n) ((-(n)-1)>>wordShift)
448 #define maskInSet(n) (1<<((-(n)-1)&wordMask))
450 /*---------------------------------------------------------------------------
451 * Function prototypes for code in machdep.c
452 *-------------------------------------------------------------------------*/
454 extern String findMPathname Args((String,String,String));
455 extern String findPathname Args((String,String));
457 extern Int shellEsc Args((String));
458 extern Int getTerminalWidth Args((Void));
459 extern Void normalTerminal Args((Void));
460 extern Void noechoTerminal Args((Void));
461 extern Int readTerminalChar Args((Void));
462 extern Void gcStarted Args((Void));
463 extern Void gcScanning Args((Void));
464 extern Void gcRecovered Args((Int));
465 extern Void gcCStack Args((Void));
467 /*-------------------------------------------------------------------------*/
469 extern Type typeInt64;
470 extern Type typeWord;
471 extern Type typeFloat;
472 extern Type typePrimArray;
473 extern Type typePrimByteArray;
475 extern Type typePrimMutableArray;
476 extern Type typePrimMutableByteArray;
477 extern Type typeStable;
478 extern Type typeWeak;
480 extern Type typeForeign;
481 extern Type typeMVar;
482 extern Type typeThreadId;
483 extern Type typeException;
487 extern Void foreignImport Args((Cell,Text,Pair,Cell,Cell));
488 extern List foreignImports; /* foreign import declarations */
489 extern Void implementForeignImport Args((Name));
490 extern Void foreignExport Args((Cell,Text,Cell,Cell,Cell));
491 extern List foreignExports; /* foreign export declarations */
492 extern Void implementForeignExport Args((Name));
497 Int userArity Args((Name));
500 extern List deriveEq Args((Tycon));
501 extern List deriveOrd Args((Tycon));
502 extern List deriveEnum Args((Tycon));
503 extern List deriveIx Args((Tycon));
504 extern List deriveShow Args((Tycon));
505 extern List deriveRead Args((Cell));
506 extern List deriveBounded Args((Tycon));
507 extern List checkPrimDefn Args((Triple));
509 extern Bool typeMatches Args((Type,Type));
510 extern Void evalExp Args((Void));
511 extern Void linkControl Args((Int));
512 extern Void deriveControl Args((Int));
513 extern Void translateControl Args((Int));
514 extern Void codegen Args((Int));
515 extern Void machdep Args((Int));
517 extern Void linkPreludeNames(void);
519 extern Kind starToStar; /* Type -> Type */
520 extern Type boundPair; /* (mkOffset(0),mkOffset(0)) */
521 extern Type typeOrdering;
523 extern Type conToTagType Args((Tycon));
524 extern Type tagToConType Args((Tycon));
526 #define BOGUS(k) (-9000000-(k))
528 extern Void putChr Args((Int));
529 extern Void putStr Args((String));
530 extern Void putInt Args((Int));
531 extern Void putPtr Args((Ptr));
533 extern Void unlexCharConst Args((Cell));
534 extern FILE *outputStream; /* current output stream */
535 extern Int outColumn; /* current output column number */
537 extern Void unlexStrConst Args((Text));
538 extern Void unlexVar Args((Text));
539 extern Void unlexVarStr Args((String));
540 extern List offsetTyvarsIn Args((Type,List));
542 extern List cfunSfuns; /* List of (Cfun,[SelectorVar]) */
544 extern Void interface Args((Int));
546 extern Void getFileSize Args((String, Long *));
548 extern Void loadInterface Args((String,Long));
550 extern Void openGHCIface Args((Text));
551 extern Void loadSharedLib Args((String));
552 extern Void addGHCImports Args((Int,Text,List));
553 extern Void addGHCExports Args((Cell,List));
554 extern Void addGHCVar Args((Int,Text,Type));
555 extern Void addGHCSynonym Args((Int,Cell,List,Type));
556 extern Void addGHCDataDecl Args((Int,List,Cell,List,List));
557 extern Void addGHCNewType Args((Int,List,Cell,List,Cell));
558 extern Void addGHCClass Args((Int,List,Cell,List,List));
559 extern Void addGHCInstance Args((Int,List,Pair,Text));
560 extern Void finishInterfaces Args((Void));
562 extern Void hi_o_namesFromSrcName Args((String,String*,String* oName));
563 extern Void parseInterface Args((String,Long));
566 #define SMALL_INLINE_SIZE 9
569 // nasty hack, but seems an easy to convey the object name
570 // and size to openGHCIface
571 char nameObj[FILENAME_MAX+1];