2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1996
4 \section[PrelInfo]{The @PrelInfo@ interface to the compiler's prelude knowledge}
8 -- finite maps for built-in things (for the renamer and typechecker):
9 builtinNames, derivingOccurrences,
12 maybeCharLikeTyCon, maybeIntLikeTyCon,
14 eq_RDR, ne_RDR, le_RDR, lt_RDR, ge_RDR, gt_RDR, max_RDR, min_RDR,
15 compare_RDR, minBound_RDR, maxBound_RDR, enumFrom_RDR, enumFromTo_RDR,
16 enumFromThen_RDR, enumFromThenTo_RDR, fromEnum_RDR, toEnum_RDR,
17 ratioDataCon_RDR, range_RDR, index_RDR, inRange_RDR, readsPrec_RDR,
18 readList_RDR, showsPrec_RDR, showList_RDR, plus_RDR, times_RDR,
19 ltTag_RDR, eqTag_RDR, gtTag_RDR, eqH_Char_RDR, ltH_Char_RDR,
20 eqH_Word_RDR, ltH_Word_RDR, eqH_Addr_RDR, ltH_Addr_RDR, eqH_Float_RDR,
21 ltH_Float_RDR, eqH_Double_RDR, ltH_Double_RDR, eqH_Int_RDR,
22 ltH_Int_RDR, geH_RDR, leH_RDR, minusH_RDR, false_RDR, true_RDR,
23 and_RDR, not_RDR, append_RDR, map_RDR, compose_RDR, mkInt_RDR,
24 error_RDR, assert_RDR,
25 showString_RDR, showParen_RDR, readParen_RDR, lex_RDR,
26 showSpace_RDR, showList___RDR, readList___RDR, negate_RDR,
28 numClass_RDR, fractionalClass_RDR, eqClass_RDR,
29 ccallableClass_RDR, creturnableClass_RDR,
30 monadZeroClass_RDR, enumClass_RDR, evalClass_RDR, ordClass_RDR,
31 ioDataCon_RDR, ioOkDataCon_RDR,
33 main_NAME, allClass_NAME, ioTyCon_NAME,
35 needsDataDeclCtxtClassKeys, cCallishClassKeys, cCallishTyKeys, isNoDictClass,
36 isNumericClass, isStandardClass, isCcallishClass
39 #include "HsVersions.h"
41 import IdUtils ( primOpName )
44 import PrelMods -- Prelude module names
45 import PrelVals -- VALUES
46 import PrimOp ( PrimOp(..), allThePrimOps )
47 import PrimRep ( PrimRep(..) )
48 import TysPrim -- TYPES
52 import RdrHsSyn ( RdrName(..), varQual, tcQual, qual )
53 import BasicTypes ( IfaceFlavour )
54 import Id ( GenId, Id )
55 import Name ( Name, OccName(..), Provenance(..),
56 getName, mkGlobalName, modAndOcc
58 import Class ( Class, classKey )
59 import TyCon ( tyConDataCons, mkFunTyCon, TyCon )
62 import Unique -- *Key stuff
63 import UniqFM ( UniqFM, listToUFM )
67 %************************************************************************
69 \subsection[builtinNameInfo]{Lookup built-in names}
71 %************************************************************************
73 We have two ``builtin name funs,'' one to look up @TyCons@ and
74 @Classes@, the other to look up values.
77 type BuiltinNames = Bag Name
79 builtinNames :: BuiltinNames
82 unionManyBags (map getTyConNames wired_in_tycons) `unionBags`
85 listToBag (map getName wired_in_ids) `unionBags`
88 listToBag (map (getName.primOpName) allThePrimOps) `unionBags`
90 -- Other names with magic keys
91 listToBag knownKeyNames
96 getTyConNames :: TyCon -> Bag Name
98 = getName tycon `consBag` listToBag (map getName (tyConDataCons tycon))
99 -- Synonyms return empty list of constructors
103 We let a lot of "non-standard" values be visible, so that we can make
104 sense of them in interface pragmas. It's cool, though they all have
105 "non-standard" names, so they won't get past the parser in user code.
107 %************************************************************************
109 \subsection{Wired in TyCons}
111 %************************************************************************
115 wired_in_tycons = [mkFunTyCon] ++
128 , foreignObjPrimTyCon
129 , mutableArrayPrimTyCon
130 , mutableByteArrayPrimTyCon
138 tuple_tycons = unitTyCon : [tupleTyCon i | i <- [2..37] ]
153 , returnIntAndGMPTyCon
157 , stateAndAddrPrimTyCon
158 , stateAndArrayPrimTyCon
159 , stateAndByteArrayPrimTyCon
160 , stateAndCharPrimTyCon
161 , stateAndDoublePrimTyCon
162 , stateAndFloatPrimTyCon
163 , stateAndForeignObjPrimTyCon
164 , stateAndIntPrimTyCon
165 , stateAndMutableArrayPrimTyCon
166 , stateAndMutableByteArrayPrimTyCon
167 , stateAndPtrPrimTyCon
168 , stateAndStablePtrPrimTyCon
169 , stateAndSynchVarPrimTyCon
170 , stateAndWordPrimTyCon
176 %************************************************************************
178 \subsection{Wired in Ids}
180 %************************************************************************
183 ToDo: Some of these should be moved to id_keys_infos!
193 , iRREFUT_PAT_ERROR_ID
198 , nON_EXHAUSTIVE_GUARDS_ERROR_ID
199 , nO_METHOD_BINDING_ERROR_ID
208 , unpackCStringAppendId
209 , unpackCStringFoldrId
228 %************************************************************************
230 \subsection{Built-in keys}
232 %************************************************************************
234 Ids, Synonyms, Classes and ClassOps with builtin keys.
237 mkKnownKeyGlobal :: (RdrName, Unique) -> Name
238 mkKnownKeyGlobal (Qual mod occ hif, uniq)
239 = mkGlobalName uniq mod occ NoProvenance
241 allClass_NAME = mkKnownKeyGlobal (allClass_RDR, allClassKey)
242 ioTyCon_NAME = mkKnownKeyGlobal (ioTyCon_RDR, ioTyConKey)
243 main_NAME = mkKnownKeyGlobal (main_RDR, mainKey)
245 knownKeyNames :: [Name]
247 = [main_NAME, allClass_NAME, ioTyCon_NAME]
251 -- Type constructors (synonyms especially)
252 (ioOkDataCon_RDR, ioOkDataConKey)
253 , (orderingTyCon_RDR, orderingTyConKey)
254 , (rationalTyCon_RDR, rationalTyConKey)
255 , (ratioDataCon_RDR, ratioDataConKey)
256 , (ratioTyCon_RDR, ratioTyConKey)
257 , (byteArrayTyCon_RDR, byteArrayTyConKey)
258 , (mutableByteArrayTyCon_RDR, mutableByteArrayTyConKey)
261 -- Classes. *Must* include:
262 -- classes that are grabbed by key (e.g., eqClassKey)
263 -- classes in "Class.standardClassKeys" (quite a few)
264 , (eqClass_RDR, eqClassKey) -- mentioned, derivable
265 , (ordClass_RDR, ordClassKey) -- derivable
266 , (evalClass_RDR, evalClassKey) -- mentioned
267 , (boundedClass_RDR, boundedClassKey) -- derivable
268 , (numClass_RDR, numClassKey) -- mentioned, numeric
269 , (enumClass_RDR, enumClassKey) -- derivable
270 , (monadClass_RDR, monadClassKey)
271 , (monadZeroClass_RDR, monadZeroClassKey)
272 , (monadPlusClass_RDR, monadPlusClassKey)
273 , (functorClass_RDR, functorClassKey)
274 , (showClass_RDR, showClassKey) -- derivable
275 , (realClass_RDR, realClassKey) -- numeric
276 , (integralClass_RDR, integralClassKey) -- numeric
277 , (fractionalClass_RDR, fractionalClassKey) -- numeric
278 , (floatingClass_RDR, floatingClassKey) -- numeric
279 , (realFracClass_RDR, realFracClassKey) -- numeric
280 , (realFloatClass_RDR, realFloatClassKey) -- numeric
281 , (readClass_RDR, readClassKey) -- derivable
282 , (ixClass_RDR, ixClassKey) -- derivable (but it isn't Prelude.Ix; hmmm)
283 , (ccallableClass_RDR, cCallableClassKey) -- mentioned, ccallish
284 , (creturnableClass_RDR, cReturnableClassKey) -- mentioned, ccallish
287 , (fromInt_RDR, fromIntClassOpKey)
288 , (fromInteger_RDR, fromIntegerClassOpKey)
289 , (ge_RDR, geClassOpKey)
290 , (minus_RDR, minusClassOpKey)
291 , (enumFrom_RDR, enumFromClassOpKey)
292 , (enumFromThen_RDR, enumFromThenClassOpKey)
293 , (enumFromTo_RDR, enumFromToClassOpKey)
294 , (enumFromThenTo_RDR, enumFromThenToClassOpKey)
295 , (fromEnum_RDR, fromEnumClassOpKey)
296 , (toEnum_RDR, toEnumClassOpKey)
297 , (eq_RDR, eqClassOpKey)
298 , (thenM_RDR, thenMClassOpKey)
299 , (returnM_RDR, returnMClassOpKey)
300 , (zeroM_RDR, zeroClassOpKey)
301 , (fromRational_RDR, fromRationalClassOpKey)
304 , (otherwiseId_RDR, otherwiseIdKey)
308 ToDo: make it do the ``like'' part properly (as in 0.26 and before).
311 maybeCharLikeTyCon tc = if (uniqueOf tc == charDataConKey) then Just charDataCon else Nothing
312 maybeIntLikeTyCon tc = if (uniqueOf tc == intDataConKey) then Just intDataCon else Nothing
315 %************************************************************************
317 \subsection{Commonly-used RdrNames}
319 %************************************************************************
321 These RdrNames are not really "built in", but some parts of the compiler
322 (notably the deriving mechanism) need to mention their names, and it's convenient
323 to write them all down in one place.
326 prelude_primop op = qual (modAndOcc (primOpName op))
328 intTyCon_RDR = qual (modAndOcc intTyCon)
329 ioTyCon_RDR = tcQual (pREL_IO_BASE, SLIT("IO"))
330 ioDataCon_RDR = varQual (pREL_IO_BASE, SLIT("IO"))
331 ioOkDataCon_RDR = varQual (pREL_IO_BASE, SLIT("IOok"))
332 orderingTyCon_RDR = tcQual (pREL_BASE, SLIT("Ordering"))
333 rationalTyCon_RDR = tcQual (pREL_NUM, SLIT("Rational"))
334 ratioTyCon_RDR = tcQual (pREL_NUM, SLIT("Ratio"))
335 ratioDataCon_RDR = varQual (pREL_NUM, SLIT(":%"))
337 byteArrayTyCon_RDR = tcQual (pREL_ARR, SLIT("ByteArray"))
338 mutableByteArrayTyCon_RDR = tcQual (pREL_ARR, SLIT("MutableByteArray"))
340 allClass_RDR = tcQual (pREL_GHC, SLIT("All"))
341 eqClass_RDR = tcQual (pREL_BASE, SLIT("Eq"))
342 ordClass_RDR = tcQual (pREL_BASE, SLIT("Ord"))
343 evalClass_RDR = tcQual (pREL_BASE, SLIT("Eval"))
344 boundedClass_RDR = tcQual (pREL_BASE, SLIT("Bounded"))
345 numClass_RDR = tcQual (pREL_BASE, SLIT("Num"))
346 enumClass_RDR = tcQual (pREL_BASE, SLIT("Enum"))
347 monadClass_RDR = tcQual (pREL_BASE, SLIT("Monad"))
348 monadZeroClass_RDR = tcQual (pREL_BASE, SLIT("MonadZero"))
349 monadPlusClass_RDR = tcQual (pREL_BASE, SLIT("MonadPlus"))
350 functorClass_RDR = tcQual (pREL_BASE, SLIT("Functor"))
351 showClass_RDR = tcQual (pREL_BASE, SLIT("Show"))
352 realClass_RDR = tcQual (pREL_NUM, SLIT("Real"))
353 integralClass_RDR = tcQual (pREL_NUM, SLIT("Integral"))
354 fractionalClass_RDR = tcQual (pREL_NUM, SLIT("Fractional"))
355 floatingClass_RDR = tcQual (pREL_NUM, SLIT("Floating"))
356 realFracClass_RDR = tcQual (pREL_NUM, SLIT("RealFrac"))
357 realFloatClass_RDR = tcQual (pREL_NUM, SLIT("RealFloat"))
358 readClass_RDR = tcQual (pREL_READ, SLIT("Read"))
359 ixClass_RDR = tcQual (iX, SLIT("Ix"))
360 ccallableClass_RDR = tcQual (pREL_GHC, SLIT("CCallable"))
361 creturnableClass_RDR = tcQual (pREL_GHC, SLIT("CReturnable"))
363 fromInt_RDR = varQual (pREL_BASE, SLIT("fromInt"))
364 fromInteger_RDR = varQual (pREL_BASE, SLIT("fromInteger"))
365 minus_RDR = varQual (pREL_BASE, SLIT("-"))
366 toEnum_RDR = varQual (pREL_BASE, SLIT("toEnum"))
367 fromEnum_RDR = varQual (pREL_BASE, SLIT("fromEnum"))
368 enumFrom_RDR = varQual (pREL_BASE, SLIT("enumFrom"))
369 enumFromTo_RDR = varQual (pREL_BASE, SLIT("enumFromTo"))
370 enumFromThen_RDR = varQual (pREL_BASE, SLIT("enumFromThen"))
371 enumFromThenTo_RDR = varQual (pREL_BASE, SLIT("enumFromThenTo"))
373 thenM_RDR = varQual (pREL_BASE, SLIT(">>="))
374 returnM_RDR = varQual (pREL_BASE, SLIT("return"))
375 zeroM_RDR = varQual (pREL_BASE, SLIT("zero"))
376 fromRational_RDR = varQual (pREL_NUM, SLIT("fromRational"))
378 negate_RDR = varQual (pREL_BASE, SLIT("negate"))
379 eq_RDR = varQual (pREL_BASE, SLIT("=="))
380 ne_RDR = varQual (pREL_BASE, SLIT("/="))
381 le_RDR = varQual (pREL_BASE, SLIT("<="))
382 lt_RDR = varQual (pREL_BASE, SLIT("<"))
383 ge_RDR = varQual (pREL_BASE, SLIT(">="))
384 gt_RDR = varQual (pREL_BASE, SLIT(">"))
385 ltTag_RDR = varQual (pREL_BASE, SLIT("LT"))
386 eqTag_RDR = varQual (pREL_BASE, SLIT("EQ"))
387 gtTag_RDR = varQual (pREL_BASE, SLIT("GT"))
388 max_RDR = varQual (pREL_BASE, SLIT("max"))
389 min_RDR = varQual (pREL_BASE, SLIT("min"))
390 compare_RDR = varQual (pREL_BASE, SLIT("compare"))
391 minBound_RDR = varQual (pREL_BASE, SLIT("minBound"))
392 maxBound_RDR = varQual (pREL_BASE, SLIT("maxBound"))
393 false_RDR = varQual (pREL_BASE, SLIT("False"))
394 true_RDR = varQual (pREL_BASE, SLIT("True"))
395 and_RDR = varQual (pREL_BASE, SLIT("&&"))
396 not_RDR = varQual (pREL_BASE, SLIT("not"))
397 compose_RDR = varQual (pREL_BASE, SLIT("."))
398 append_RDR = varQual (pREL_BASE, SLIT("++"))
399 map_RDR = varQual (pREL_BASE, SLIT("map"))
401 showList___RDR = varQual (pREL_BASE, SLIT("showList__"))
402 showsPrec_RDR = varQual (pREL_BASE, SLIT("showsPrec"))
403 showList_RDR = varQual (pREL_BASE, SLIT("showList"))
404 showSpace_RDR = varQual (pREL_BASE, SLIT("showSpace"))
405 showString_RDR = varQual (pREL_BASE, SLIT("showString"))
406 showParen_RDR = varQual (pREL_BASE, SLIT("showParen"))
408 range_RDR = varQual (iX, SLIT("range"))
409 index_RDR = varQual (iX, SLIT("index"))
410 inRange_RDR = varQual (iX, SLIT("inRange"))
412 readsPrec_RDR = varQual (pREL_READ, SLIT("readsPrec"))
413 readList_RDR = varQual (pREL_READ, SLIT("readList"))
414 readParen_RDR = varQual (pREL_READ, SLIT("readParen"))
415 lex_RDR = varQual (pREL_READ, SLIT("lex"))
416 readList___RDR = varQual (pREL_READ, SLIT("readList__"))
418 plus_RDR = varQual (pREL_BASE, SLIT("+"))
419 times_RDR = varQual (pREL_BASE, SLIT("*"))
420 mkInt_RDR = varQual (pREL_BASE, SLIT("I#"))
422 error_RDR = varQual (pREL_ERR, SLIT("error"))
423 assert_RDR = varQual (pREL_ERR, SLIT("assert__"))
425 eqH_Char_RDR = prelude_primop CharEqOp
426 ltH_Char_RDR = prelude_primop CharLtOp
427 eqH_Word_RDR = prelude_primop WordEqOp
428 ltH_Word_RDR = prelude_primop WordLtOp
429 eqH_Addr_RDR = prelude_primop AddrEqOp
430 ltH_Addr_RDR = prelude_primop AddrLtOp
431 eqH_Float_RDR = prelude_primop FloatEqOp
432 ltH_Float_RDR = prelude_primop FloatLtOp
433 eqH_Double_RDR = prelude_primop DoubleEqOp
434 ltH_Double_RDR = prelude_primop DoubleLtOp
435 eqH_Int_RDR = prelude_primop IntEqOp
436 ltH_Int_RDR = prelude_primop IntLtOp
437 geH_RDR = prelude_primop IntGeOp
438 leH_RDR = prelude_primop IntLeOp
439 minusH_RDR = prelude_primop IntSubOp
441 main_RDR = varQual (mAIN, SLIT("main"))
443 otherwiseId_RDR = varQual (pREL_BASE, SLIT("otherwise"))
446 %************************************************************************
448 \subsection[Class-std-groups]{Standard groups of Prelude classes}
450 %************************************************************************
452 @derivableClassKeys@ is also used in checking \tr{deriving} constructs
455 @derivingOccurrences@ maps a class name to a list of the (qualified) occurrences
456 that will be mentioned by the derived code for the class when it is later generated.
457 We don't need to put in things that are WiredIn (because they are already mapped to their
458 correct name by the @NameSupply@. The class itself, and all its class ops, is
459 already flagged as an occurrence so we don't need to mention that either.
461 @derivingOccurrences@ has an item for every derivable class, even if that item is empty,
462 because we treat lookup failure as indicating that the class is illegal in a deriving clause.
465 derivingOccurrences :: UniqFM [RdrName]
466 derivingOccurrences = listToUFM deriving_occ_info
468 derivableClassKeys = map fst deriving_occ_info
471 = [ (eqClassKey, [intTyCon_RDR, and_RDR, not_RDR])
472 , (ordClassKey, [intTyCon_RDR, compose_RDR, eqTag_RDR])
473 -- EQ (from Ordering) is needed to force in the constructors
474 -- as well as the type constructor.
475 , (enumClassKey, [intTyCon_RDR, map_RDR])
476 , (evalClassKey, [intTyCon_RDR])
477 , (boundedClassKey, [intTyCon_RDR])
478 , (showClassKey, [intTyCon_RDR, numClass_RDR, ordClass_RDR, compose_RDR, showString_RDR,
479 showParen_RDR, showSpace_RDR, showList___RDR])
480 , (readClassKey, [intTyCon_RDR, numClass_RDR, ordClass_RDR, append_RDR,
481 lex_RDR, readParen_RDR, readList___RDR])
482 , (ixClassKey, [intTyCon_RDR, numClass_RDR, and_RDR, map_RDR, enumFromTo_RDR,
483 returnM_RDR, zeroM_RDR])
484 -- the last two are needed to force returnM, thenM and zeroM
485 -- in before typechecking the list(monad) comprehension
486 -- generated for derived Ix instances (range method)
487 -- of single constructor types. -- SOF 8/97
489 -- intTyCon: Practically any deriving needs Int, either for index calculations,
491 -- ordClass: really it's the methods that are actually used.
492 -- numClass: for Int literals
496 NOTE: @Eq@ and @Text@ do need to appear in @standardClasses@
497 even though every numeric class has these two as a superclass,
498 because the list of ambiguous dictionaries hasn't been simplified.
501 isCcallishClass, isNoDictClass, isNumericClass, isStandardClass :: Class -> Bool
503 isNumericClass clas = classKey clas `is_elem` numericClassKeys
504 isStandardClass clas = classKey clas `is_elem` standardClassKeys
505 isCcallishClass clas = classKey clas `is_elem` cCallishClassKeys
506 isNoDictClass clas = classKey clas `is_elem` noDictClassKeys
507 is_elem = isIn "is_X_Class"
519 needsDataDeclCtxtClassKeys -- see comments in TcDeriv
523 cCallishClassKeys = [ cCallableClassKey, cReturnableClassKey ]
525 -- Renamer always imports these data decls replete with constructors
526 -- so that desugarer can always see the constructor. Ugh!
527 cCallishTyKeys = [ addrTyConKey, wordTyConKey, byteArrayTyConKey,
528 mutableByteArrayTyConKey, foreignObjTyConKey ]
531 = derivableClassKeys ++ numericClassKeys ++ cCallishClassKeys
533 -- We have to have "CCallable" and "CReturnable" in the standard
534 -- classes, so that if you go...
536 -- _ccall_ foo ... 93{-numeric literal-} ...
538 -- ... it can do The Right Thing on the 93.
540 noDictClassKeys -- These classes are used only for type annotations;
541 -- they are not implemented by dictionaries, ever.
543 -- I used to think that class Eval belonged in here, but
544 -- we really want functions with type (Eval a => ...) and that
545 -- means that we really want to pass a placeholder for an Eval
546 -- dictionary. The unit tuple is what we'll get if we leave things
547 -- alone, and that'll do for now. Could arrange to drop that parameter