ghc/compiler/hsSyn/HsPat.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   3 %
   4 \section[PatSyntax]{Abstract Haskell syntax---patterns}
   5
   6 \begin{code}
   7 module HsPat (
   8         Pat(..), InPat, OutPat, LPat,
   9
  10         HsConDetails(..), hsConArgs,
  11
  12         mkPrefixConPat, mkCharLitPat, mkNilPat,
  13
  14         isWildPat,
  15         patsAreAllCons, isConPat, isSigPat,
  16         patsAreAllLits, isLitPat
  17     ) where
  18
  19 #include "HsVersions.h"
  20
  21
  22 import {-# SOURCE #-} HsExpr            ( HsExpr )
  23
  24 -- friends:
  25 import HsBinds          ( DictBinds, emptyLHsBinds, pprLHsBinds )
  26 import HsLit            ( HsLit(HsCharPrim), HsOverLit )
  27 import HsTypes          ( LHsType, SyntaxName, PostTcType )
  28 import BasicTypes       ( Boxity, tupleParens )
  29 -- others:
  30 import PprCore          ( {- instance OutputableBndr TyVar -} )
  31 import TysWiredIn       ( nilDataCon, charDataCon, charTy )
  32 import Var              ( TyVar )
  33 import DataCon          ( DataCon )
  34 import Outputable
  35 import Type             ( Type )
  36 import SrcLoc           ( Located(..), unLoc, noLoc )
  37 \end{code}
  38
  39
  40 \begin{code}
  41 type InPat id  = LPat id        -- No 'Out' constructors
  42 type OutPat id = LPat id        -- No 'In' constructors
  43
  44 type LPat id = Located (Pat id)
  45
  46 data Pat id
  47   =     ------------ Simple patterns ---------------
  48     WildPat     PostTcType              -- Wild card
  49   | VarPat      id                      -- Variable
  50   | VarPatOut   id (DictBinds id)       -- Used only for overloaded Ids; the
  51                                         -- bindings give its overloaded instances
  52   | LazyPat     (LPat id)               -- Lazy pattern
  53   | AsPat       (Located id) (LPat id)  -- As pattern
  54   | ParPat      (LPat id)               -- Parenthesised pattern
  55
  56         ------------ Lists, tuples, arrays ---------------
  57   | ListPat     [LPat id]               -- Syntactic list
  58                 PostTcType              -- The type of the elements
  59
  60   | TuplePat    [LPat id]               -- Tuple
  61                 Boxity                  -- UnitPat is TuplePat []
  62
  63   | PArrPat     [LPat id]               -- Syntactic parallel array
  64                 PostTcType              -- The type of the elements
  65
  66         ------------ Constructor patterns ---------------
  67   | ConPatIn    (Located id)
  68                 (HsConDetails id (LPat id))
  69
  70   | ConPatOut   DataCon
  71                 [TyVar]                 -- Existentially bound type variables
  72                 [id]                    -- Ditto dictionaries
  73                 (DictBinds id)          -- Bindings involving those dictionaries
  74                 (HsConDetails id (LPat id))
  75                 Type                    -- The type of the pattern
  76
  77         ------------ Literal and n+k patterns ---------------
  78   | LitPat          HsLit               -- Used for *non-overloaded* literal patterns:
  79                                         -- Int#, Char#, Int, Char, String, etc.
  80
  81   | NPatIn          HsOverLit           -- Always positive
  82                     (Maybe SyntaxName)  -- Just (Name of 'negate') for negative
  83                                         -- patterns, Nothing otherwise
  84
  85   | NPatOut         HsLit               -- Used for literal patterns where there's an equality function to call
  86                                         -- The literal is retained so that the desugarer can readily identify
  87                                         -- equations with identical literal-patterns
  88                                         -- Always HsInteger, HsRat or HsString.
  89                                         -- *Unlike* NPatIn, for negative literals, the
  90                                         --      literal is acutally negative!
  91                     Type                -- Type of pattern, t
  92                     (HsExpr id)         -- Of type t -> Bool; detects match
  93
  94   | NPlusKPatIn     (Located id)        -- n+k pattern
  95                     HsOverLit           -- It'll always be an HsIntegral
  96                     SyntaxName          -- Name of '-' (see RnEnv.lookupSyntaxName)
  97
  98   | NPlusKPatOut    (Located id)
  99                     Integer
 100                     (HsExpr id)         -- Of type t -> Bool; detects match
 101                     (HsExpr id)         -- Of type t -> t; subtracts k
 102
 103
 104         ------------ Generics ---------------
 105   | TypePat         (LHsType id)        -- Type pattern for generic definitions
 106                                         -- e.g  f{| a+b |} = ...
 107                                         -- These show up only in class declarations,
 108                                         -- and should be a top-level pattern
 109
 110         ------------ Pattern type signatures ---------------
 111   | SigPatIn        (LPat id)           -- Pattern with a type signature
 112                     (LHsType id)
 113
 114   | SigPatOut       (LPat id)           -- Pattern with a type signature
 115                     Type
 116
 117         ------------ Dictionary patterns (translation only) ---------------
 118   | DictPat         -- Used when destructing Dictionaries with an explicit case
 119                     [id]                        -- superclass dicts
 120                     [id]                        -- methods
 121 \end{code}
 122
 123 HsConDetails is use both for patterns and for data type declarations
 124
 125 \begin{code}
 126 data HsConDetails id arg
 127   = PrefixCon [arg]                     -- C p1 p2 p3
 128   | RecCon    [(Located id, arg)]       -- C { x = p1, y = p2 }
 129   | InfixCon  arg arg                   -- p1 `C` p2
 130
 131 hsConArgs :: HsConDetails id arg -> [arg]
 132 hsConArgs (PrefixCon ps)   = ps
 133 hsConArgs (RecCon fs)      = map snd fs
 134 hsConArgs (InfixCon p1 p2) = [p1,p2]
 135 \end{code}
 136
 137
 138 %************************************************************************
 139 %*                                                                      *
 140 %*              Printing patterns
 141 %*                                                                      *
 142 %************************************************************************
 143
 144 \begin{code}
 145 instance (OutputableBndr name) => Outputable (Pat name) where
 146     ppr = pprPat
 147
 148 pprPatBndr :: OutputableBndr name => name -> SDoc
 149 pprPatBndr var                  -- Print with type info if -dppr-debug is on
 150   = getPprStyle $ \ sty ->
 151     if debugStyle sty then
 152         parens (pprBndr LambdaBind var)         -- Could pass the site to pprPat
 153                                                 -- but is it worth it?
 154     else
 155         ppr var
 156
 157 pprPat :: (OutputableBndr name) => Pat name -> SDoc
 158
 159 pprPat (VarPat var)       = pprPatBndr var
 160 pprPat (VarPatOut var bs) = parens (pprPatBndr var <+> braces (ppr bs))
 161 pprPat (WildPat _)        = char '_'
 162 pprPat (LazyPat pat)      = char '~' <> ppr pat
 163 pprPat (AsPat name pat)   = parens (hcat [ppr name, char '@', ppr pat])
 164 pprPat (ParPat pat)       = parens (ppr pat)
 165
 166 pprPat (ListPat pats _)   = brackets (interpp'SP pats)
 167 pprPat (PArrPat pats _)   = pabrackets (interpp'SP pats)
 168 pprPat (TuplePat pats bx) = tupleParens bx (interpp'SP pats)
 169
 170 pprPat (ConPatIn con details) = pprUserCon con details
 171 pprPat (ConPatOut con tvs dicts binds details _)
 172   = getPprStyle $ \ sty ->      -- Tiresome; in TcBinds.tcRhs we print out a
 173     if debugStyle sty then      -- typechecked Pat in an error message,
 174                                 -- and we want to make sure it prints nicely
 175         ppr con <+> sep [ hsep (map pprPatBndr tvs) <+> hsep (map pprPatBndr dicts),
 176                           pprLHsBinds binds, pprConArgs details]
 177     else pprUserCon con details
 178
 179 pprPat (LitPat s)             = ppr s
 180 pprPat (NPatIn l _)           = ppr l
 181 pprPat (NPatOut l _ _)        = ppr l
 182 pprPat (NPlusKPatIn n k _)    = hcat [ppr n, char '+', ppr k]
 183 pprPat (NPlusKPatOut n k _ _) = hcat [ppr n, char '+', integer k]
 184 pprPat (TypePat ty)           = ptext SLIT("{|") <> ppr ty <> ptext SLIT("|}")
 185 pprPat (SigPatIn pat ty)      = ppr pat <+> dcolon <+> ppr ty
 186 pprPat (SigPatOut pat ty)     = ppr pat <+> dcolon <+> ppr ty
 187 pprPat (DictPat ds ms)        = parens (sep [ptext SLIT("{-dict-}"),
 188                                              brackets (interpp'SP ds),
 189                                              brackets (interpp'SP ms)])
 190
 191 pprUserCon c (InfixCon p1 p2) = ppr p1 <+> ppr c <+> ppr p2
 192 pprUserCon c details          = ppr c <+> pprConArgs details
 193
 194 pprConArgs (PrefixCon pats) = interppSP pats
 195 pprConArgs (InfixCon p1 p2) = interppSP [p1,p2]
 196 pprConArgs (RecCon rpats)   = braces (hsep (punctuate comma (map (pp_rpat) rpats)))
 197                             where
 198                               pp_rpat (v, p) = hsep [ppr v, char '=', ppr p]
 199
 200
 201 -- add parallel array brackets around a document
 202 --
 203 pabrackets   :: SDoc -> SDoc
 204 pabrackets p  = ptext SLIT("[:") <> p <> ptext SLIT(":]")
 205 \end{code}
 206
 207
 208 %************************************************************************
 209 %*                                                                      *
 210 %*              Building patterns
 211 %*                                                                      *
 212 %************************************************************************
 213
 214 \begin{code}
 215 mkPrefixConPat :: DataCon -> [OutPat id] -> Type -> OutPat id
 216 -- Make a vanilla Prefix constructor pattern
 217 mkPrefixConPat dc pats ty = noLoc $ ConPatOut dc [] [] emptyLHsBinds (PrefixCon pats) ty
 218
 219 mkNilPat :: Type -> OutPat id
 220 mkNilPat ty = mkPrefixConPat nilDataCon [] ty
 221
 222 mkCharLitPat :: Char -> OutPat id
 223 mkCharLitPat c = mkPrefixConPat charDataCon [noLoc $ LitPat (HsCharPrim c)] charTy
 224 \end{code}
 225
 226
 227 %************************************************************************
 228 %*                                                                      *
 229 %* Predicates for checking things about pattern-lists in EquationInfo   *
 230 %*                                                                      *
 231 %************************************************************************
 232
 233 \subsection[Pat-list-predicates]{Look for interesting things in patterns}
 234
 235 Unlike in the Wadler chapter, where patterns are either ``variables''
 236 or ``constructors,'' here we distinguish between:
 237 \begin{description}
 238 \item[unfailable:]
 239 Patterns that cannot fail to match: variables, wildcards, and lazy
 240 patterns.
 241
 242 These are the irrefutable patterns; the two other categories
 243 are refutable patterns.
 244
 245 \item[constructor:]
 246 A non-literal constructor pattern (see next category).
 247
 248 \item[literal patterns:]
 249 At least the numeric ones may be overloaded.
 250 \end{description}
 251
 252 A pattern is in {\em exactly one} of the above three categories; `as'
 253 patterns are treated specially, of course.
 254
 255 The 1.3 report defines what ``irrefutable'' and ``failure-free'' patterns are.
 256 \begin{code}
 257 isWildPat (WildPat _) = True
 258 isWildPat other       = False
 259
 260 patsAreAllCons :: [Pat id] -> Bool
 261 patsAreAllCons pat_list = all isConPat pat_list
 262
 263 isConPat (AsPat _ pat)           = isConPat (unLoc pat)
 264 isConPat (ConPatIn _ _)          = True
 265 isConPat (ConPatOut _ _ _ _ _ _) = True
 266 isConPat (ListPat _ _)           = True
 267 isConPat (PArrPat _ _)           = True
 268 isConPat (TuplePat _ _)          = True
 269 isConPat (DictPat ds ms)         = (length ds + length ms) > 1
 270 isConPat other                   = False
 271
 272 isSigPat (SigPatIn _ _)  = True
 273 isSigPat (SigPatOut _ _) = True
 274 isSigPat other           = False
 275
 276 patsAreAllLits :: [Pat id] -> Bool
 277 patsAreAllLits pat_list = all isLitPat pat_list
 278
 279 isLitPat (AsPat _ pat)          = isLitPat (unLoc pat)
 280 isLitPat (LitPat _)             = True
 281 isLitPat (NPatIn _ _)           = True
 282 isLitPat (NPatOut   _ _ _)      = True
 283 isLitPat (NPlusKPatIn _ _ _)    = True
 284 isLitPat (NPlusKPatOut _ _ _ _) = True
 285 isLitPat other                  = False
 286 \end{code}
 287