ghc/compiler/prelude/PrelInfo.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   3 %
   4 \section[PrelInfo]{The @PrelInfo@ interface to the compiler's prelude knowledge}
   5
   6 \begin{code}
   7 module PrelInfo (
   8         module PrelNames,
   9         module MkId,
  10
  11         wiredInNames,   -- Names of wired in things
  12         wiredInThings,
  13
  14
  15         -- Primop RdrNames
  16         eqH_Char_RDR,   ltH_Char_RDR,   eqH_Word_RDR,  ltH_Word_RDR,
  17         eqH_Addr_RDR,   ltH_Addr_RDR,   eqH_Float_RDR, ltH_Float_RDR,
  18         eqH_Double_RDR, ltH_Double_RDR, eqH_Int_RDR,   ltH_Int_RDR,
  19         geH_RDR, leH_RDR, minusH_RDR, tagToEnumH_RDR,
  20
  21         -- Random other things
  22         maybeCharLikeCon, maybeIntLikeCon,
  23
  24         -- Class categories
  25         isCcallishClass, isCreturnableClass, isNoDictClass,
  26         isNumericClass, isStandardClass
  27
  28     ) where
  29
  30 #include "HsVersions.h"
  31
  32 -- friends:
  33 import PrelNames        -- Prelude module names
  34
  35 import PrimOp           ( PrimOp(..), allThePrimOps, primOpRdrName )
  36 import DataCon          ( DataCon, dataConId, dataConWrapId )
  37 import MkId             ( mkPrimOpId, wiredInIds )
  38 import MkId             -- All of it, for re-export
  39 import TysPrim          ( primTyCons )
  40 import TysWiredIn       ( wiredInTyCons )
  41 import HscTypes         ( TyThing(..) )
  42
  43 -- others:
  44 import RdrName          ( RdrName )
  45 import Name             ( Name, getName )
  46 import TyCon            ( tyConDataConsIfAvailable, TyCon )
  47 import Class            ( Class, classKey )
  48 import Type             ( funTyCon )
  49 import Bag
  50 import BasicTypes       ( Boxity(..) )
  51 import Util             ( isIn )
  52 \end{code}
  53
  54 %************************************************************************
  55 %*                                                                      *
  56 \subsection[builtinNameInfo]{Lookup built-in names}
  57 %*                                                                      *
  58 %************************************************************************
  59
  60 We have two ``builtin name funs,'' one to look up @TyCons@ and
  61 @Classes@, the other to look up values.
  62
  63 \begin{code}
  64 wiredInThings :: [TyThing]
  65 wiredInThings
  66   = concat
  67     [           -- Wired in TyCons
  68           map ATyCon ([funTyCon] ++ primTyCons ++ wiredInTyCons)
  69
  70                 -- Wired in Ids
  71         , map AnId wiredInIds
  72
  73                 -- PrimOps
  74         , map (AnId . mkPrimOpId) allThePrimOps
  75     ]
  76
  77 wiredInNames :: [Name]
  78 wiredInNames = [n | thing <- wiredInThings, n <- tyThingNames]
  79
  80 tyThingNames :: TyCon -> [Name]
  81 tyThingNames (AnClass cl) = pprPanic "tyThingNames" (ppr cl)    -- Not used
  82 tyThingNames (AnId    id) = [getName id]
  83 tyThingNames (ATyCon  tc) = getName tycon : [ getName n | dc <- tyConDataConsIfAvailable tycon,
  84                                                           n  <- [dataConId dc, dataConWrapId dc] ]
  85                                                 -- Synonyms return empty list of constructors
  86 \end{code}
  87
  88 We let a lot of "non-standard" values be visible, so that we can make
  89 sense of them in interface pragmas. It's cool, though they all have
  90 "non-standard" names, so they won't get past the parser in user code.
  91
  92
  93 %************************************************************************
  94 %*                                                                      *
  95 \subsection{RdrNames for the primops}
  96 %*                                                                      *
  97 %************************************************************************
  98
  99 These can't be in PrelNames, because we get the RdrName from the PrimOp,
 100 which is above PrelNames in the module hierarchy.
 101
 102 \begin{code}
 103 eqH_Char_RDR    = primOpRdrName CharEqOp
 104 ltH_Char_RDR    = primOpRdrName CharLtOp
 105 eqH_Word_RDR    = primOpRdrName WordEqOp
 106 ltH_Word_RDR    = primOpRdrName WordLtOp
 107 eqH_Addr_RDR    = primOpRdrName AddrEqOp
 108 ltH_Addr_RDR    = primOpRdrName AddrLtOp
 109 eqH_Float_RDR   = primOpRdrName FloatEqOp
 110 ltH_Float_RDR   = primOpRdrName FloatLtOp
 111 eqH_Double_RDR  = primOpRdrName DoubleEqOp
 112 ltH_Double_RDR  = primOpRdrName DoubleLtOp
 113 eqH_Int_RDR     = primOpRdrName IntEqOp
 114 ltH_Int_RDR     = primOpRdrName IntLtOp
 115 geH_RDR         = primOpRdrName IntGeOp
 116 leH_RDR         = primOpRdrName IntLeOp
 117 minusH_RDR      = primOpRdrName IntSubOp
 118
 119 tagToEnumH_RDR  = primOpRdrName TagToEnumOp
 120 \end{code}
 121
 122
 123 %************************************************************************
 124 %*                                                                      *
 125 \subsection{Built-in keys}
 126 %*                                                                      *
 127 %************************************************************************
 128
 129 ToDo: make it do the ``like'' part properly (as in 0.26 and before).
 130
 131 \begin{code}
 132 maybeCharLikeCon, maybeIntLikeCon :: DataCon -> Bool
 133 maybeCharLikeCon con = con `hasKey` charDataConKey
 134 maybeIntLikeCon  con = con `hasKey` intDataConKey
 135 \end{code}
 136
 137
 138 %************************************************************************
 139 %*                                                                      *
 140 \subsection{Class predicates}
 141 %*                                                                      *
 142 %************************************************************************
 143
 144 \begin{code}
 145 isCcallishClass, isCreturnableClass, isNoDictClass,
 146   isNumericClass, isStandardClass :: Class -> Bool
 147
 148 isNumericClass     clas = classKey clas `is_elem` numericClassKeys
 149 isStandardClass    clas = classKey clas `is_elem` standardClassKeys
 150 isCcallishClass    clas = classKey clas `is_elem` cCallishClassKeys
 151 isCreturnableClass clas = classKey clas == cReturnableClassKey
 152 isNoDictClass      clas = classKey clas `is_elem` noDictClassKeys
 153 is_elem = isIn "is_X_Class"
 154 \end{code}