ghc/compiler/basicTypes/PprEnv.lhs

   1 %
   2 % (c) The AQUA Project, Glasgow University, 1996
   3 %
   4 \section[PprEnv]{The @PprEnv@ type}
   5
   6 \begin{code}
   7 #include "HsVersions.h"
   8
   9 module PprEnv (
  10         PprEnv{-abstract-},
  11
  12         initPprEnv,
  13
  14         pCon, pLit, pMajBndr, pMinBndr, pOcc, pPrim, pSCC, pStyle,
  15         pTy, pTyVar, pUVar, pUse,
  16
  17         NmbrEnv(..),
  18         NmbrM(..), initNmbr,
  19         returnNmbr, thenNmbr,
  20         mapNmbr, mapAndUnzipNmbr
  21 --      nmbr1, nmbr2, nmbr3
  22 --      rnumValVar,   rnumTyVar,   rnumUVar,
  23 --      lookupValVar, lookupTyVar, lookupUVar
  24     ) where
  25
  26 IMP_Ubiq(){-uitous-}
  27
  28 import Pretty           ( Pretty(..) )
  29 import Unique           ( initRenumberingUniques )
  30 import UniqFM           ( emptyUFM )
  31 import Util             ( panic )
  32 \end{code}
  33
  34 For tyvars and uvars, we {\em do} normally use these homogenized
  35 names; for values, we {\em don't}.  In printing interfaces, though,
  36 we use homogenized value names, so that interfaces don't wobble
  37 uncontrollably from changing Unique-based names.
  38
  39 \begin{code}
  40 data PprEnv tyvar uvar bndr occ
  41   = PE  PprStyle                -- stored for safe keeping
  42
  43         (Literal    -> Pretty)  -- Doing these this way saves
  44         (Id    -> Pretty)       -- carrying around a PprStyle
  45         (PrimOp     -> Pretty)
  46         (CostCentre -> Pretty)
  47
  48         (tyvar -> Pretty)       -- to print tyvars
  49         (uvar -> Pretty)        -- to print usage vars
  50
  51         (bndr -> Pretty)        -- to print "major" val_bdrs
  52         (bndr -> Pretty)        -- to print "minor" val_bdrs
  53         (occ  -> Pretty)        -- to print bindees
  54
  55         (GenType tyvar uvar -> Pretty)
  56         (GenUsage uvar -> Pretty)
  57 \end{code}
  58
  59 \begin{code}
  60 initPprEnv
  61         :: PprStyle
  62         -> Maybe (Literal -> Pretty)
  63         -> Maybe (Id -> Pretty)
  64         -> Maybe (PrimOp  -> Pretty)
  65         -> Maybe (CostCentre -> Pretty)
  66         -> Maybe (tyvar -> Pretty)
  67         -> Maybe (uvar -> Pretty)
  68         -> Maybe (bndr -> Pretty)
  69         -> Maybe (bndr -> Pretty)
  70         -> Maybe (occ -> Pretty)
  71         -> Maybe (GenType tyvar uvar -> Pretty)
  72         -> Maybe (GenUsage uvar -> Pretty)
  73         -> PprEnv tyvar uvar bndr occ
  74
  75 -- you can specify all the printers individually; if
  76 -- you don't specify one, you get bottom
  77
  78 initPprEnv sty l d p c tv uv maj_bndr min_bndr occ ty use
  79   = PE sty
  80        (demaybe l)
  81        (demaybe d)
  82        (demaybe p)
  83        (demaybe c)
  84        (demaybe tv)
  85        (demaybe uv)
  86        (demaybe maj_bndr)
  87        (demaybe min_bndr)
  88        (demaybe occ)
  89        (demaybe ty)
  90        (demaybe use)
  91   where
  92     demaybe Nothing  = bottom
  93     demaybe (Just x) = x
  94
  95     bottom = panic "PprEnv.initPprEnv: unspecified printing function"
  96
  97 {-
  98 initPprEnv sty pmaj pmin pocc
  99   = PE  (ppr sty)   -- for a Literal
 100         (ppr sty)   -- for a DataCon
 101         (ppr sty)   -- for a PrimOp
 102         (\ cc -> ppStr (showCostCentre sty True cc)) -- CostCentre
 103
 104         (ppr sty)   -- for a tyvar
 105         (ppr sty)   -- for a usage var
 106
 107         pmaj pmin pocc -- for GenIds in various guises
 108
 109         (ppr sty)   -- for a Type
 110         (ppr sty)   -- for a Usage
 111 -}
 112 \end{code}
 113
 114 \begin{code}
 115 pStyle   (PE s  _  _  _  _  _  _  _  _  _  _  _) = s
 116 pLit     (PE _ pp  _  _  _  _  _  _  _  _  _  _) = pp
 117 pCon     (PE _  _ pp  _  _  _  _  _  _  _  _  _) = pp
 118 pPrim    (PE _  _  _ pp  _  _  _  _  _  _  _  _) = pp
 119 pSCC     (PE _  _  _  _ pp  _  _  _  _  _  _  _) = pp
 120
 121 pTyVar   (PE _  _  _  _  _ pp  _  _  _  _  _  _) = pp
 122 pUVar    (PE _  _  _  _  _  _ pp  _  _  _  _  _) = pp
 123
 124 pMajBndr (PE _  _  _  _  _  _  _ pp  _  _  _  _) = pp
 125 pMinBndr (PE _  _  _  _  _  _  _  _ pp  _  _  _) = pp
 126 pOcc     (PE _  _  _  _  _  _  _  _  _ pp  _  _) = pp
 127
 128 pTy      (PE _  _  _  _  _  _  _  _  _  _ pp  _) = pp
 129 pUse     (PE _  _  _  _  _  _  _  _  _  _  _ pp) = pp
 130 \end{code}
 131
 132 We tend to {\em renumber} everything before printing, so that
 133 we get consistent Uniques on everything from run to run.
 134 \begin{code}
 135 data NmbrEnv
 136   = NmbrEnv     Unique  -- next "Unique" to give out for a value
 137                 Unique  -- ... for a tyvar
 138                 Unique  -- ... for a usage var
 139                 (UniqFM Id)     -- mapping for value vars we know about
 140                 (UniqFM TyVar)  -- ... for tyvars
 141                 (UniqFM Unique{-UVar-}) -- ... for usage vars
 142
 143 type NmbrM a = NmbrEnv -> (NmbrEnv, a)
 144
 145 initNmbr :: NmbrM a -> a
 146 initNmbr m
 147   = let
 148         (v1,t1,u1)    = initRenumberingUniques
 149         init_nmbr_env = NmbrEnv v1 t1 u1 emptyUFM emptyUFM emptyUFM
 150     in
 151     snd (m init_nmbr_env)
 152
 153 returnNmbr x nenv = (nenv, x)
 154
 155 thenNmbr m k nenv
 156   = let
 157         (nenv2, res) = m nenv
 158     in
 159     k res nenv2
 160
 161 mapNmbr f []     = returnNmbr []
 162 mapNmbr f (x:xs)
 163   = f x             `thenNmbr` \ r  ->
 164     mapNmbr f xs    `thenNmbr` \ rs ->
 165     returnNmbr (r:rs)
 166
 167 mapAndUnzipNmbr f [] = returnNmbr ([],[])
 168 mapAndUnzipNmbr f (x:xs)
 169   = f x                     `thenNmbr` \ (r1,  r2)  ->
 170     mapAndUnzipNmbr f xs    `thenNmbr` \ (rs1, rs2) ->
 171     returnNmbr (r1:rs1, r2:rs2)
 172
 173 {-
 174 nmbr1 nenv thing x1
 175   = let
 176         (nenv1, new_x1) = x1 nenv
 177     in
 178     (nenv1, thing new_x1)
 179
 180 nmbr2 nenv thing x1 x2
 181   = let
 182         (nenv1, new_x1) = x1 nenv
 183         (nenv2, new_x2) = x2 nenv1
 184     in
 185     (nenv2, thing new_x1 new_x2)
 186
 187 nmbr3 nenv thing x1 x2 x3
 188   = let
 189         (nenv1, new_x1) = x1 nenv
 190         (nenv2, new_x2) = x2 nenv1
 191         (nenv3, new_x3) = x3 nenv2
 192     in
 193     (nenv3, thing new_x1 new_x2 new_x3)
 194 -}
 195
 196 rnumValVar = panic "rnumValVar"
 197 rnumTyVar = panic "rnumTyVar"
 198 rnumUVar = panic "rnumUVar"
 199 lookupValVar = panic "lookupValVar"
 200 lookupTyVar = panic "lookupTyVar"
 201 lookupUVar = panic "lookupUVar"
 202 \end{code}