ghc/interpreter/connect.h

   1 /* --------------------------------------------------------------------------
   2  * Connections between components of the Hugs system
   3  *
   4  * Hugs 98 is Copyright (c) Mark P Jones, Alastair Reid and the Yale
   5  * Haskell Group 1994-99, and is distributed as Open Source software
   6  * under the Artistic License; see the file "Artistic" that is included
   7  * in the distribution for details.
   8  *
   9  * $RCSfile: connect.h,v $
  10  * $Revision: 1.8 $
  11  * $Date: 1999/10/15 11:02:09 $
  12  * ------------------------------------------------------------------------*/
  13
  14 /* --------------------------------------------------------------------------
  15  * Standard data:
  16  * ------------------------------------------------------------------------*/
  17
  18 extern Bool   haskell98;                /* TRUE => Haskell 98 compatibility*/
  19 extern Module modulePrelude;
  20
  21 /* --------------------------------------------------------------------------
  22  * Primitive constructor functions
  23  * ------------------------------------------------------------------------*/
  24
  25 extern Name  nameFalse, nameTrue;
  26 extern Name  nameNil,   nameCons;
  27 extern Name  nameJust,  nameNothing;
  28 extern Name  nameLeft,  nameRight;
  29 extern Name  nameUnit;
  30
  31 extern Name  nameLT,      nameEQ;
  32 extern Name  nameGT;
  33 extern Name  nameFst,     nameSnd;      /* standard combinators            */
  34 extern Name  nameId,      nameOtherwise;
  35 extern Name  nameNegate,  nameFlip;     /* primitives reqd for parsing     */
  36 extern Name  nameFrom,    nameFromThen;
  37 extern Name  nameFromTo,  nameFromThenTo;
  38 extern Name  nameFatbar,  nameFail;     /* primitives reqd for translation */
  39 extern Name  nameIf,      nameSel;
  40 extern Name  nameCompAux;
  41 extern Name  namePmInt,   namePmFlt;    /* primitives for pattern matching */
  42 extern Name  namePmInteger;
  43 #if NPLUSK
  44 extern Name  namePmNpk,   namePmSub;    /* primitives for (n+k) patterns   */
  45 #endif
  46 extern Name  nameError;                 /* For runtime error messages      */
  47 extern Name  nameUndefined;             /* A generic undefined value       */
  48 extern Name  nameBlackHole;             /* For GC-detected black hole      */
  49 extern Name  nameInd;                   /* For dict indirection            */
  50 extern Name  nameAnd,     nameOr;       /* For optimisation of && and ||   */
  51 extern Name  nameFromInt, nameFromDouble;/*coercion of numerics            */
  52 extern Name  nameFromInteger;
  53 extern Name  nameEq,      nameCompare;  /* names used for deriving         */
  54 extern Name  nameMinBnd,  nameMaxBnd;
  55 extern Name  nameIndex,   nameInRange;
  56 extern Name  nameRange;
  57 extern Name  nameLe,      nameGt;
  58 extern Name  nameShowsPrec, nameReadsPrec;
  59 extern Name  nameMult,    namePlus;
  60 extern Name  nameConCmp,  nameEnRange;
  61 extern Name  nameEnIndex, nameEnInRng;
  62 extern Name  nameEnToEn,  nameEnFrEn;
  63 extern Name  nameEnFrom,  nameEnFrTh;
  64 extern Name  nameEnFrTo;
  65 extern Name  nameComp,    nameApp;      /* composition and append          */
  66 extern Name  nameShowField;             /* display single field            */
  67 extern Name  nameShowParen;             /* wrap with parens                */
  68 extern Name  nameReadField;             /* read single field               */
  69 extern Name  nameReadParen;             /* unwrap from parens              */
  70 extern Name  nameLex;                   /* lexer                           */
  71 extern Name  nameRangeSize;             /* calculate size of index range   */
  72 extern Class classMonad;                /* Monads                          */
  73 extern Name  nameReturn,  nameBind;     /* for translating monad comps     */
  74 extern Name  nameMFail;
  75 extern Name  nameListMonad;             /* builder function for List Monad */
  76 extern Name  namePrint;                 /* printing primitive              */
  77 extern Name  nameCreateAdjThunk;        /* f-x-dyn: create adjustor thunk  */
  78 extern Text  textPrelude;
  79 extern Text  textNum;                   /* used to process default decls   */
  80 #if    NPLUSK
  81 extern Text  textPlus;                  /* Used to recognise n+k patterns  */
  82 #endif
  83 #if TREX
  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         */
  97 #endif
  98
  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  */
 103
 104 extern Type  typeArrow;                 /* Builtin type constructors       */
 105 extern Type  typeList;
 106 extern Type  typeUnit;
 107
 108 #define fn(from,to)  ap(ap(typeArrow,from),to)  /* make type: from -> to   */
 109
 110 extern List  stdDefaults;               /* List of standard default types  */
 111
 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;
 119
 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;
 127
 128 extern Cell  *CStackBase;               /* pointer to base of C stack      */
 129
 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 Addr  inputCode;                 /* Code for compiled input expr    */
 144
 145 extern Int   whnfArgs;                  /* number of args of term in whnf  */
 146 extern Cell  whnfHead;                  /* head of term in whnf            */
 147 extern Int   whnfInt;                   /* integer value of term in whnf   */
 148 extern Float whnfFloat;                 /* float value of term in whnf     */
 149 extern Long  numCells;                  /* number of cells allocated       */
 150 extern Int   numGcs;                    /* number of garbage collections   */
 151 extern Bool  broken;                    /* indicates interrupt received    */
 152 extern Bool  preludeLoaded;             /* TRUE => prelude has been loaded */
 153
 154 extern Bool  gcMessages;                /* TRUE => print GC messages       */
 155 extern Bool  literateScripts;           /* TRUE => default lit scripts     */
 156 extern Bool  literateErrors;            /* TRUE => report errs in lit scrs */
 157 extern Bool  optimise;                  /* TRUE => simplify STG            */
 158
 159 extern Int   cutoff;                    /* Constraint Cutoff depth         */
 160
 161 #if USE_PREPROCESSOR
 162 extern String preprocessor;             /* preprocessor command            */
 163 #endif
 164
 165 #if DEBUG_CODE
 166 extern Bool  debugCode;                 /* TRUE => print G-code to screen  */
 167 #endif
 168 extern Bool  kindExpert;                /* TRUE => display kind errors in  */
 169                                         /*         full detail             */
 170 extern Bool  allowOverlap;              /* TRUE => allow overlapping insts */
 171
 172 /* --------------------------------------------------------------------------
 173  * Function prototypes etc...
 174  * ------------------------------------------------------------------------*/
 175
 176 extern Void everybody Args((Int));
 177
 178 #define RESET   1               /* reset subsystem                         */
 179 #define MARK    2               /* mark parts of graph in use by subsystem */
 180 #define INSTALL 3               /* install subsystem (executed once only)  */
 181 #define EXIT    4               /* Take action immediately before exit()   */
 182 #define BREAK   5               /* Take action after program break         */
 183 #define GCDONE  6               /* Restore subsystem invariantss after GC  */
 184
 185 typedef long   Target;
 186 extern  Void   setGoal          Args((String, Target));
 187 extern  Void   soFar            Args((Target));
 188 extern  Void   done             Args((Void));
 189 extern  String fromEnv          Args((String,String));
 190 extern  Bool   chase            Args((List));
 191
 192 extern  Void   storage          Args((Int));
 193
 194 extern  Void   input            Args((Int));
 195 extern  Void   consoleInput     Args((String));
 196 extern  Void   projInput        Args((String));
 197 extern  Void   stringInput      Args((String));
 198 extern  Void   parseScript      Args((String,Long));
 199 extern  Void   parseExp         Args((Void));
 200 extern  String readFilename     Args((Void));
 201 extern  String readLine         Args((Void));
 202 extern  Syntax defaultSyntax    Args((Text));
 203 extern  Syntax syntaxOf         Args((Name));
 204 extern  String unlexChar        Args((Char,Char));
 205 extern  Void   printString      Args((String));
 206
 207 extern  Void   substitution     Args((Int));
 208 extern  Void   optimiser        Args((Int));
 209
 210 extern  Void   staticAnalysis   Args((Int));
 211 extern  Void   startModule      Args((Cell));
 212 extern  Void   setExportList    Args((List));
 213 extern  Void   setExports       Args((List));
 214 extern  Void   addQualImport    Args((Text,Text));
 215 extern  Void   addUnqualImport  Args((Text,List));
 216
 217 extern  Void   tyconDefn        Args((Int,Cell,Cell,Cell));
 218 extern  Void   setTypeIns       Args((List));
 219 extern  Void   clearTypeIns     Args((Void));
 220 extern  Type   fullExpand       Args((Type));
 221 extern  Bool   isAmbiguous      Args((Type));
 222 extern  Void   ambigError       Args((Int,String,Cell,Type));
 223 extern  Void   classDefn        Args((Int,Cell,Cell));
 224 extern  Void   instDefn         Args((Int,Cell,Cell));
 225 extern  Void   addTupInst       Args((Class,Int));
 226 #if TREX
 227 extern  Inst   addRecShowInst   Args((Class,Ext));
 228 extern  Inst   addRecEqInst     Args((Class,Ext));
 229 #endif
 230 extern  Void   primDefn         Args((Cell,List,Cell));
 231 extern  Void   defaultDefn      Args((Int,List));
 232 extern  Void   checkExp         Args((Void));
 233 extern  Void   checkDefns       Args((Void));
 234 extern  Bool   h98Pred          Args((Bool,Cell));
 235 extern  Cell   h98Context       Args((Bool,List));
 236 extern  Void   h98CheckCtxt     Args((Int,String,Bool,List,Inst));
 237 extern  Void   h98CheckType     Args((Int,String,Cell,Type));
 238 extern  Void   h98DoesntSupport Args((Int,String));
 239
 240 extern  Void   typeChecker      Args((Int));
 241 extern  Type   typeCheckExp     Args((Bool));
 242 extern  Void   typeCheckDefns   Args((Void));
 243 extern  Cell   provePred        Args((Kinds,List,Cell));
 244 extern  List   simpleContext    Args((List,Int));
 245 extern  Cell   rhsExpr          Args((Cell));
 246 extern  Int    rhsLine          Args((Cell));
 247 extern  Bool   isProgType       Args((List,Type));
 248 extern  Cell   superEvid        Args((Cell,Class,Class));
 249 extern  Void   linkPreludeTC    Args((Void));
 250 extern  Void   linkPreludeCM    Args((Void));
 251
 252 extern  Void   compiler         Args((Int));
 253 extern  Void   compileDefns     Args((Void));
 254 extern  Void   compileExp       Args((Void));
 255 extern  Bool   failFree         Args((Cell));
 256 extern  Int    discrArity       Args((Cell));
 257
 258 extern  Addr   codeGen          Args((Name,Int,Cell));
 259 extern  Void   implementCfun    Args((Name,List));
 260 #if TREX
 261 extern  Name   implementRecShw  Args((Text,Cell));
 262 extern  Name   implementRecEq   Args((Text,Cell));
 263 #endif
 264 extern  Void   addCfunTable     Args((Tycon));
 265 extern  Name   succCfun         Args((Name));
 266 extern  Name   nextCfun         Args((Name,Name));
 267 extern  Name   cfunByNum        Args((Name,Int));
 268 extern  Void   unwind           Args((Cell));
 269 extern  Void   run              Args((Addr,StackPtr));
 270
 271 extern  Void   eval             Args((Cell));
 272 extern  Cell   evalWithNoError  Args((Cell));
 273 extern  Void   evalFails        Args((StackPtr));
 274
 275 extern  Void   abandon          Args((String,Cell));
 276 extern  Void   outputString     Args((FILE *));
 277 extern  Void   dialogue         Args((Cell));
 278 #define consChar(c) ap(nameCons,mkChar(c))
 279
 280 extern  Int    shellEsc         Args((String));
 281 extern  Int    getTerminalWidth Args((Void));
 282 extern  Void   normalTerminal   Args((Void));
 283 extern  Void   noechoTerminal   Args((Void));
 284 extern  Int    readTerminalChar Args((Void));
 285 extern  Void   gcStarted        Args((Void));
 286 extern  Void   gcScanning       Args((Void));
 287 extern  Void   gcRecovered      Args((Int));
 288 extern  Void   gcCStack         Args((Void));
 289 extern  Void   needPrims        Args((Int));
 290
 291 extern Type primType( Int /*AsmMonad*/ monad, String a_kinds, String r_kinds );
 292 #define aVar            mkOffset(0)     /* Simple skeleton for type var    */
 293
 294 /*-------------------------------------------------------------------------*/
 295
 296 /*---------------------------------------------------------------------------
 297  * Interrupting execution (signals, allowBreak):
 298  *-------------------------------------------------------------------------*/
 299
 300 extern Bool breakOn      Args((Bool));
 301
 302 extern Bool  broken;                    /* indicates interrupt received    */
 303
 304 #ifndef SIGBREAK /* Sigh, not defined in cygwin32 beta release 16 */
 305 # define SIGBREAK 21
 306 #endif
 307
 308 /* allowBreak: call to allow user to interrupt computation
 309  * ctrlbrk:    set control break handler
 310  */
 311
 312 #if HUGS_FOR_WINDOWS
 313 #  define ctrlbrk(bh)
 314 #  define allowBreak()  kbhit()
 315 #else /* !HUGS_FOR_WINDOWS */
 316 #  define ctrlbrk(bh)   signal(SIGINT,bh); signal(SIGBREAK,bh)
 317 #  define allowBreak()  if (broken) { broken=FALSE; sigRaise(breakHandler); }
 318 #endif /* !HUGS_FOR_WINDOWS */
 319
 320 /*---------------------------------------------------------------------------
 321  * Environment variables and the registry
 322  *-------------------------------------------------------------------------*/
 323
 324 /* On Win32 we can use the registry to supplement info in environment
 325  * variables.
 326  */
 327 #define USE_REGISTRY (HAVE_WINDOWS_H && !__MSDOS__)
 328
 329 #ifdef USE_REGISTRY
 330 Bool    writeRegString Args((String var, String val));
 331 String  readRegString  Args((String var, String def));
 332 Int     readRegInt     Args((String var, Int def));
 333 Bool    writeRegInt    Args((String var, Int val));
 334 #endif
 335
 336 /*---------------------------------------------------------------------------
 337  * File operations:
 338  *-------------------------------------------------------------------------*/
 339
 340 #if HAVE_UNISTD_H
 341 # include <sys/types.h>
 342 # include <unistd.h>
 343 #elif !HUGS_FOR_WINDOWS
 344 extern int      chdir      Args((const char*));
 345 #endif
 346
 347 #if HAVE_STDLIB_H
 348 # include <stdlib.h>
 349 #else
 350 extern int      system     Args((const char *));
 351 extern double   atof       Args((const char *));
 352 extern void     exit       Args((int));
 353 #endif
 354
 355 #ifndef FILENAME_MAX       /* should already be defined in an ANSI compiler*/
 356 #define FILENAME_MAX 256
 357 #else
 358 #if     FILENAME_MAX < 256
 359 #undef  FILENAME_MAX
 360 #define FILENAME_MAX 256
 361 #endif
 362 #endif
 363
 364 /* Hack, hack: if you have dos.h, you probably have a DOS filesystem */
 365 #define DOS_FILENAMES              HAVE_DOS_H
 366 /* ToDo: can we replace this with a feature test? */
 367 #define MAC_FILENAMES              SYMANTEC_C
 368
 369 #define CASE_INSENSITIVE_FILENAMES (DOS_FILENAMES | RISCOS)
 370
 371 #if CASE_INSENSITIVE_FILENAMES
 372 # if HAVE_STRCASECMP
 373 #  define filenamecmp(s1,s2) strcasecmp(s1,s2)
 374 # elif HAVE__STRICMP
 375 #  define filenamecmp(s1,s2) _stricmp(s1,s2)
 376 # elif HAVE_STRICMP
 377 #  define filenamecmp(s1,s2) stricmp(s1,s2)
 378 # elif HAVE_STRCMPI
 379 #  define filenamecmp(s1,s2) strcmpi(s1,s2)
 380 # endif
 381 #else
 382 # define filenamecmp(s1,s2) strcmp(s1,s2)
 383 #endif
 384
 385 /*---------------------------------------------------------------------------
 386  * Pipe-related operations:
 387  *
 388  * On Windows, many standard Unix names acquire a leading underscore.
 389  * Irritating, but easy to work around.
 390  *-------------------------------------------------------------------------*/
 391
 392 #if !defined(HAVE_POPEN) && defined(HAVE__POPEN)
 393 #define popen(x,y) _popen(x,y)
 394 #endif
 395 #if !defined(HAVE_PCLOSE) && defined(HAVE__PCLOSE)
 396 #define pclose(x) _pclose(x)
 397 #endif
 398
 399 /*---------------------------------------------------------------------------
 400  * Bit manipulation:
 401  *-------------------------------------------------------------------------*/
 402
 403 #define bitArraySize(n)    ((n)/bitsPerWord + 1)
 404 #define placeInSet(n)      ((-(n)-1)>>wordShift)
 405 #define maskInSet(n)       (1<<((-(n)-1)&wordMask))
 406
 407 /*---------------------------------------------------------------------------
 408  * Function prototypes for code in machdep.c
 409  *-------------------------------------------------------------------------*/
 410
 411 extern  String findMPathname    Args((String,String,String));
 412 extern  String findPathname     Args((String,String));
 413
 414 extern  Int    shellEsc         Args((String));
 415 extern  Int    getTerminalWidth Args((Void));
 416 extern  Void   normalTerminal   Args((Void));
 417 extern  Void   noechoTerminal   Args((Void));
 418 extern  Int    readTerminalChar Args((Void));
 419 extern  Void   gcStarted        Args((Void));
 420 extern  Void   gcScanning       Args((Void));
 421 extern  Void   gcRecovered      Args((Int));
 422 extern  Void   gcCStack         Args((Void));
 423
 424 /*-------------------------------------------------------------------------*/
 425
 426 extern Type typeInt64;
 427 extern Type typeWord;
 428 extern Type typeFloat;
 429 extern Type typePrimArray;
 430 extern Type typePrimByteArray;
 431 extern Type typeRef;
 432 extern Type typePrimMutableArray;
 433 extern Type typePrimMutableByteArray;
 434 extern Type typeStable;
 435 extern Type typeWeak;
 436 extern Type typeIO;
 437 extern Type typeForeign;
 438 extern Type typeMVar;
 439 extern Type typeThreadId;
 440 extern Type typeException;
 441 extern Type typeIO;
 442 extern Type typeST;
 443
 444 extern  Void   foreignImport    Args((Cell,Pair,Cell,Cell));
 445 extern List  foreignImports;            /* foreign import declarations     */
 446 extern  Void   implementForeignImport Args((Name));
 447 extern  Void   foreignExport   Args((Cell,Cell,Cell,Cell));
 448 extern List  foreignExports;            /* foreign export declarations     */
 449 extern  Void   implementForeignExport Args((Name));
 450
 451 extern List diVars;
 452 extern Int  diNum;
 453
 454 Int     userArity           Args((Name));
 455
 456
 457 extern List    deriveEq            Args((Tycon));
 458 extern List    deriveOrd           Args((Tycon));
 459 extern List    deriveEnum          Args((Tycon));
 460 extern List    deriveIx            Args((Tycon));
 461 extern List    deriveShow          Args((Tycon));
 462 extern List    deriveRead          Args((Cell));
 463 extern List    deriveBounded       Args((Tycon));
 464 extern List    checkPrimDefn       Args((Triple));
 465
 466 extern Bool  typeMatches        Args((Type,Type));
 467 extern  Void   evalExp           Args((Void));
 468 extern  Void   linkControl      Args((Int));
 469 extern  Void   deriveControl    Args((Int));
 470 extern  Void   translateControl Args((Int));
 471 extern  Void   codegen          Args((Int));
 472 extern  Void   machdep          Args((Int));
 473
 474 extern Void linkPreludeNames(void);
 475
 476 extern  Kind  starToStar;                /* Type -> Type                    */
 477 extern Type  boundPair;                 /* (mkOffset(0),mkOffset(0))       */
 478 extern        Type typeOrdering;
 479
 480 extern  Type   conToTagType     Args((Tycon));
 481 extern  Type   tagToConType     Args((Tycon));
 482
 483 #define BOGUS(k) (-9000000-(k))
 484
 485 extern Void putChr  Args((Int));
 486 extern Void putStr  Args((String));
 487 extern Void putInt  Args((Int));
 488 extern Void putPtr  Args((Ptr));
 489
 490 extern Void unlexCharConst Args((Cell));
 491 extern FILE *outputStream;             /* current output stream            */
 492 extern Int  outColumn;                 /* current output column number     */
 493
 494 extern Void unlexStrConst  Args((Text));
 495 extern Void unlexVar       Args((Text));
 496 extern List offsetTyvarsIn          Args((Type,List));
 497
 498 extern Void optimiseTopBinds  Args((List));
 499 extern List cfunSfuns;                  /* List of (Cfun,[SelectorVar])    */
 500
 501 extern Void  interface        Args((Int));
 502
 503 extern List typeVarsIn        Args((Cell,List,List));
 504
 505 extern Void getFileSize       Args((String, Long *));
 506
 507 extern Void loadInterface     Args((String,Long));
 508
 509 extern Void openGHCIface      Args((Text));
 510 extern Void loadSharedLib     Args((String));
 511 extern Void addGHCImports     Args((Int,Text,List));
 512 extern Void addGHCExports     Args((Cell,List));
 513 extern Void addGHCVar         Args((Int,Text,Type));
 514 extern Void addGHCSynonym     Args((Int,Cell,List,Type));
 515 extern Void addGHCDataDecl    Args((Int,List,Cell,List,List));
 516 extern Void addGHCNewType     Args((Int,List,Cell,List,Cell));
 517 extern Void addGHCClass       Args((Int,List,Cell,List,List));
 518 extern Void addGHCInstance    Args((Int,List,Pair,Text));
 519 extern Void finishInterfaces  Args((Void));
 520
 521 extern Void hi_o_namesFromSrcName Args((String,String*,String* oName));
 522 extern Void parseInterface        Args((String,Long));
 523
 524
 525 #define SMALL_INLINE_SIZE 9
 526
 527
 528 // nasty hack, but seems an easy to convey the object name
 529 // and size to openGHCIface
 530 char nameObj[FILENAME_MAX+1];
 531 int  sizeObj;
 532