fbd55bf1155a525e0e73116621a048645926dd1f
[ghc-hetmet.git] / ghc / compiler / types / PprType.lhs
1 %
2 % (c) The AQUA Project, Glasgow University, 1996-1998
3 %
4 \section[PprType]{Printing Types, TyVars, Classes, TyCons}
5
6 \begin{code}
7 module PprType(
8         pprKind, pprParendKind,
9         pprType, pprParendType,
10         pprConstraint, pprPred, pprTheta,
11         pprTyVarBndr, pprTyVarBndrs,
12
13         -- Junk
14         getTyDescription, showTypeCategory
15  ) where
16
17 #include "HsVersions.h"
18
19 -- friends:
20 -- (PprType can see all the representations it's trying to print)
21 import TypeRep          ( Type(..), TyNote(..), Kind, UsageAnn(..),
22                           boxedTypeKind,
23                         )  -- friend
24 import Type             ( PredType(..), ThetaType,
25                           splitPredTy_maybe,
26                           splitForAllTys, splitSigmaTy, splitRhoTy,
27                           isDictTy, splitTyConApp_maybe, splitFunTy_maybe,
28                           splitUsForAllTys, predRepTy
29                         )
30 import Var              ( TyVar, tyVarKind )
31 import TyCon            ( TyCon, isPrimTyCon, isTupleTyCon, isUnboxedTupleTyCon, 
32                           maybeTyConSingleCon, isEnumerationTyCon, 
33                           tyConArity
34                         )
35 import Class            ( Class )
36
37 -- others:
38 import Maybes           ( maybeToBool )
39 import Name             ( getOccString )
40 import Outputable
41 import PprEnv
42 import Unique           ( Uniquable(..) )
43 import PrelNames                -- quite a few *Keys
44 \end{code}
45
46 %************************************************************************
47 %*                                                                      *
48 \subsection{The external interface}
49 %*                                                                      *
50 %************************************************************************
51
52 @pprType@ is the standard @Type@ printer; the overloaded @ppr@ function is
53 defined to use this.  @pprParendType@ is the same, except it puts
54 parens around the type, except for the atomic cases.  @pprParendType@
55 works just by setting the initial context precedence very high.
56
57 \begin{code}
58 pprType, pprParendType :: Type -> SDoc
59 pprType       ty = ppr_ty pprTyEnv tOP_PREC   ty
60 pprParendType ty = ppr_ty pprTyEnv tYCON_PREC ty
61
62 pprKind, pprParendKind :: Kind -> SDoc
63 pprKind       = pprType
64 pprParendKind = pprParendType
65
66 pprPred :: PredType -> SDoc
67 pprPred (Class clas tys) = pprConstraint clas tys
68 pprPred (IParam n ty)    = hsep [ptext SLIT("?") <> ppr n,
69                                  ptext SLIT("::"), ppr ty]
70
71 pprConstraint :: Class -> [Type] -> SDoc
72 pprConstraint clas tys = ppr clas <+> hsep (map pprParendType tys)
73
74 pprTheta :: ThetaType -> SDoc
75 pprTheta theta = parens (hsep (punctuate comma (map pprPred theta)))
76
77 instance Outputable Type where
78     ppr ty = pprType ty
79
80 instance Outputable PredType where
81     ppr = pprPred
82 \end{code}
83
84
85 %************************************************************************
86 %*                                                                      *
87 \subsection{Pretty printing}
88 %*                                                                      *
89 %************************************************************************
90
91 Precedence
92 ~~~~~~~~~~
93 @ppr_ty@ takes an @Int@ that is the precedence of the context.
94 The precedence levels are:
95 \begin{description}
96 \item[tOP_PREC]   No parens required.
97 \item[fUN_PREC]   Left hand argument of a function arrow.
98 \item[tYCON_PREC] Argument of a type constructor.
99 \end{description}
100
101
102 \begin{code}
103 tOP_PREC    = (0 :: Int)
104 fUN_PREC    = (1 :: Int)
105 tYCON_PREC  = (2 :: Int)
106
107 maybeParen ctxt_prec inner_prec pretty
108   | ctxt_prec < inner_prec = pretty
109   | otherwise              = parens pretty
110 \end{code}
111
112 \begin{code}
113 ppr_ty :: PprEnv TyVar -> Int -> Type -> SDoc
114 ppr_ty env ctxt_prec (TyVarTy tyvar)
115   = pTyVarO env tyvar
116
117 ppr_ty env ctxt_prec ty@(TyConApp tycon tys)
118         -- KIND CASE; it's of the form (Type x)
119   | tycon `hasKey` typeConKey && n_tys == 1
120   =     -- For kinds, print (Type x) as just x if x is a 
121         --      type constructor (must be Boxed, Unboxed, AnyBox)
122         -- Otherwise print as (Type x)
123     case ty1 of
124         TyConApp bx [] -> ppr bx
125         other          -> maybeParen ctxt_prec tYCON_PREC 
126                                      (sep [ppr tycon, nest 4 tys_w_spaces])
127                        
128         
129         -- TUPLE CASE (boxed and unboxed)
130   |  isTupleTyCon tycon
131   && length tys == tyConArity tycon     -- no magic if partially applied
132   = parens tys_w_commas
133
134   |  isUnboxedTupleTyCon tycon
135   && length tys == tyConArity tycon     -- no magic if partially applied
136   = parens (char '#' <+> tys_w_commas <+> char '#')
137
138         -- LIST CASE
139   | tycon `hasKey` listTyConKey && n_tys == 1
140   = brackets (ppr_ty env tOP_PREC ty1)
141
142         -- DICTIONARY CASE, prints {C a}
143         -- This means that instance decls come out looking right in interfaces
144         -- and that in turn means they get "gated" correctly when being slurped in
145   | maybeToBool maybe_pred
146   = braces (ppr_pred env pred)
147
148         -- NO-ARGUMENT CASE (=> no parens)
149   | null tys
150   = ppr tycon
151
152         -- GENERAL CASE
153   | otherwise
154   = maybeParen ctxt_prec tYCON_PREC (sep [ppr tycon, nest 4 tys_w_spaces])
155
156   where
157     n_tys      = length tys
158     (ty1:_)    = tys
159     Just pred  = maybe_pred
160     maybe_pred = splitPredTy_maybe ty   -- Checks class and arity
161     tys_w_commas = sep (punctuate comma (map (ppr_ty env tOP_PREC) tys))
162     tys_w_spaces = sep (map (ppr_ty env tYCON_PREC) tys)
163   
164
165
166 ppr_ty env ctxt_prec ty@(ForAllTy _ _)
167   = getPprStyle $ \ sty -> 
168     maybeParen ctxt_prec fUN_PREC $
169     sep [ ptext SLIT("forall") <+> pp_tyvars <> ptext SLIT("."), 
170           ppr_theta theta,
171           ppr_ty env tOP_PREC tau
172     ]
173  where          
174     (tyvars, rho) = splitForAllTys ty  -- don't treat theta specially any more (KSW 1999-04)
175     (theta, tau)  = splitRhoTy rho
176     
177     pp_tyvars = hsep (map (pBndr env LambdaBind) tyvars)
178     
179     ppr_theta []        = empty
180     ppr_theta theta     = parens (hsep (punctuate comma (map (ppr_pred env) theta))) 
181                           <+> ptext SLIT("=>")
182
183
184 ppr_ty env ctxt_prec (FunTy ty1 ty2)
185   = maybeParen ctxt_prec fUN_PREC (sep (ppr_ty env fUN_PREC ty1 : pp_rest ty2))
186   -- we don't want to lose usage annotations or synonyms,
187   -- so we mustn't use splitFunTys here.
188   where
189     pp_rest (FunTy ty1 ty2) = pp_codom ty1 : pp_rest ty2
190     pp_rest ty              = [pp_codom ty]
191     pp_codom ty             = ptext SLIT("->") <+> ppr_ty env fUN_PREC ty
192
193 ppr_ty env ctxt_prec (AppTy ty1 ty2)
194   = maybeParen ctxt_prec tYCON_PREC $
195     ppr_ty env tOP_PREC ty1 <+> ppr_ty env tYCON_PREC ty2
196
197 ppr_ty env ctxt_prec (NoteTy (SynNote ty) expansion)
198   = ppr_ty env ctxt_prec ty
199 --  = ppr_ty env ctxt_prec expansion -- if we don't want to see syntys
200
201 ppr_ty env ctxt_prec (NoteTy (FTVNote _) ty) = ppr_ty env ctxt_prec ty
202
203 ppr_ty env ctxt_prec ty@(NoteTy (UsgForAll _) _)
204   = maybeParen ctxt_prec fUN_PREC $
205     sep [ ptext SLIT("__fuall") <+> brackets pp_uvars <+> ptext SLIT("=>"),
206           ppr_ty env tOP_PREC sigma
207         ]
208   where
209     (uvars,sigma) = splitUsForAllTys ty
210     pp_uvars      = hsep (map ppr uvars)
211
212 ppr_ty env ctxt_prec (NoteTy (UsgNote u) ty)
213   = maybeParen ctxt_prec tYCON_PREC $
214     ptext SLIT("__u") <+> ppr u <+> ppr_ty env tYCON_PREC ty
215
216 ppr_ty env ctxt_prec (PredTy p) = braces (ppr_pred env p)
217
218 ppr_pred env (Class clas tys) = ppr clas <+>
219                                 hsep (map (ppr_ty env tYCON_PREC) tys)
220 ppr_pred env (IParam n ty)    = hsep [char '?' <> ppr n, text "::",
221                                       ppr_ty env tYCON_PREC ty]
222 \end{code}
223
224 \begin{code}
225 pprTyEnv = initPprEnv b (Just ppr) b (Just (\site -> pprTyVarBndr)) b
226   where
227     b = panic "PprType:init_ppr_env"
228 \end{code}
229
230 \begin{code}
231 instance Outputable UsageAnn where
232   ppr UsOnce     = ptext SLIT("-")
233   ppr UsMany     = ptext SLIT("!")
234   ppr (UsVar uv) = ppr uv
235 \end{code}
236
237
238 %************************************************************************
239 %*                                                                      *
240 \subsection[TyVar]{@TyVar@}
241 %*                                                                      *
242 %************************************************************************
243
244 We print type-variable binders with their kinds in interface files,
245 and when in debug mode.
246
247 \begin{code}
248 pprTyVarBndr tyvar
249   = getPprStyle $ \ sty ->
250     if (ifaceStyle sty  && kind /= boxedTypeKind) || debugStyle sty then
251         hsep [ppr tyvar, dcolon, pprParendKind kind]
252                 -- See comments with ppDcolon in PprCore.lhs
253     else
254         ppr tyvar
255   where
256     kind = tyVarKind tyvar
257
258 pprTyVarBndrs tyvars = hsep (map pprTyVarBndr tyvars)
259 \end{code}
260
261
262 %************************************************************************
263 %*                                                                      *
264 \subsection{Mumbo jumbo}
265 %*                                                                      *
266 %************************************************************************
267
268 Grab a name for the type. This is used to determine the type
269 description for profiling.
270
271 \begin{code}
272 getTyDescription :: Type -> String
273
274 getTyDescription ty
275   = case (splitSigmaTy ty) of { (_, _, tau_ty) ->
276     case tau_ty of
277       TyVarTy _        -> "*"
278       AppTy fun _      -> getTyDescription fun
279       FunTy _ res      -> '-' : '>' : fun_result res
280       TyConApp tycon _ -> getOccString tycon
281       NoteTy (FTVNote _) ty  -> getTyDescription ty
282       NoteTy (SynNote ty1) _ -> getTyDescription ty1
283       NoteTy (UsgNote _) ty  -> getTyDescription ty
284       PredTy p               -> getTyDescription (predRepTy p)
285       ForAllTy _ ty    -> getTyDescription ty
286     }
287   where
288     fun_result (FunTy _ res) = '>' : fun_result res
289     fun_result other         = getTyDescription other
290 \end{code}
291
292
293 \begin{code}
294 showTypeCategory :: Type -> Char
295   {-
296         {C,I,F,D}   char, int, float, double
297         T           tuple
298         S           other single-constructor type
299         {c,i,f,d}   unboxed ditto
300         t           *unpacked* tuple
301         s           *unpacked" single-cons...
302
303         v           void#
304         a           primitive array
305
306         E           enumeration type
307         +           dictionary, unless it's a ...
308         L           List
309         >           function
310         M           other (multi-constructor) data-con type
311         .           other type
312         -           reserved for others to mark as "uninteresting"
313     -}
314 showTypeCategory ty
315   = if isDictTy ty
316     then '+'
317     else
318       case splitTyConApp_maybe ty of
319         Nothing -> if maybeToBool (splitFunTy_maybe ty)
320                    then '>'
321                    else '.'
322
323         Just (tycon, _) ->
324           let utc = getUnique tycon in
325           if      utc == charDataConKey    then 'C'
326           else if utc == intDataConKey     then 'I'
327           else if utc == floatDataConKey   then 'F'
328           else if utc == doubleDataConKey  then 'D'
329           else if utc == smallIntegerDataConKey ||
330                   utc == largeIntegerDataConKey   then 'J'
331           else if utc == charPrimTyConKey  then 'c'
332           else if (utc == intPrimTyConKey || utc == wordPrimTyConKey
333                 || utc == addrPrimTyConKey)                then 'i'
334           else if utc  == floatPrimTyConKey                then 'f'
335           else if utc  == doublePrimTyConKey               then 'd'
336           else if isPrimTyCon tycon {- array, we hope -}   then 'A'
337           else if isEnumerationTyCon tycon                 then 'E'
338           else if isTupleTyCon tycon                       then 'T'
339           else if maybeToBool (maybeTyConSingleCon tycon)  then 'S'
340           else if utc == listTyConKey                      then 'L'
341           else 'M' -- oh, well...
342 \end{code}