%
-% (c) The GRASP/AQUA Project, Glasgow University, 1992-1996
+% (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
%
\section[PatSyntax]{Abstract Haskell syntax---patterns}
\begin{code}
module HsPat (
- InPat(..),
- OutPat(..),
+ Pat(..), InPat, OutPat,
+
+ HsConDetails(..), hsConArgs,
- irrefutablePat, irrefutablePats,
- failureFreePat,
- patsAreAllCons, isConPat,
+ mkPrefixConPat, mkCharLitPat, mkNilPat,
+
+ isWildPat,
+ patsAreAllCons, isConPat, isSigPat,
patsAreAllLits, isLitPat,
- collectPatBinders
+ collectPatBinders, collectPatsBinders,
+ collectSigTysFromPat, collectSigTysFromPats
) where
#include "HsVersions.h"
--- friends:
-import HsBasic ( HsLit )
-import HsExpr ( HsExpr )
-import BasicTypes ( Fixity )
+import {-# SOURCE #-} HsExpr ( HsExpr )
+
+-- friends:
+import HsLit ( HsLit(HsCharPrim), HsOverLit )
+import HsTypes ( HsType, SyntaxName, PostTcType )
+import BasicTypes ( Boxity, tupleParens )
-- others:
-import Id ( Id, dataConTyCon, GenId )
+import TysWiredIn ( nilDataCon, charDataCon, charTy )
+import Var ( TyVar )
+import DataCon ( DataCon, dataConTyCon )
import Maybes ( maybeToBool )
import Outputable
import TyCon ( maybeTyConSingleCon )
-import PprType ( GenType )
-import Name ( NamedThing )
+import Type ( Type )
\end{code}
-Patterns come in distinct before- and after-typechecking flavo(u)rs.
-\begin{code}
-data InPat name
- = WildPatIn -- wild card
- | VarPatIn name -- variable
- | LitPatIn HsLit -- literal
- | LazyPatIn (InPat name) -- lazy pattern
- | AsPatIn name -- as pattern
- (InPat name)
- | ConPatIn name -- constructed type
- [InPat name]
- | ConOpPatIn (InPat name)
- name
- Fixity -- c.f. OpApp in HsExpr
- (InPat name)
-
- | NPlusKPatIn name -- n+k pattern
- HsLit
-
- -- We preserve prefix negation and parenthesis for the precedence parser.
-
- | NegPatIn (InPat name) -- negated pattern
- | ParPatIn (InPat name) -- parenthesised pattern
-
- | ListPatIn [InPat name] -- syntactic list
- -- must have >= 1 elements
- | TuplePatIn [InPat name] -- tuple
-
- | RecPatIn name -- record
- [(name, InPat name, Bool)] -- True <=> source used punning
-
-data OutPat flexi id
- = WildPat (GenType flexi) -- wild card
-
- | VarPat id -- variable (type is in the Id)
-
- | LazyPat (OutPat flexi id) -- lazy pattern
-
- | AsPat id -- as pattern
- (OutPat flexi id)
-
- | ConPat Id -- Constructor is always an Id
- (GenType flexi) -- the type of the pattern
- [OutPat flexi id]
-
- | ConOpPat (OutPat flexi id) -- just a special case...
- Id
- (OutPat flexi id)
- (GenType flexi)
- | ListPat -- syntactic list
- (GenType flexi) -- the type of the elements
- [OutPat flexi id]
-
- | TuplePat [OutPat flexi id] -- tuple
- -- UnitPat is TuplePat []
-
- | RecPat Id -- record constructor
- (GenType flexi) -- the type of the pattern
- [(Id, OutPat flexi id, Bool)] -- True <=> source used punning
-
- | LitPat -- Used for *non-overloaded* literal patterns:
- -- Int#, Char#, Int, Char, String, etc.
- HsLit
- (GenType flexi) -- type of pattern
-
- | NPat -- Used for *overloaded* literal patterns
- HsLit -- the literal is retained so that
- -- the desugarer can readily identify
- -- equations with identical literal-patterns
- (GenType flexi) -- type of pattern, t
- (HsExpr flexi id (OutPat flexi id))
- -- of type t -> Bool; detects match
-
- | NPlusKPat id
- HsLit -- Same reason as for LitPat
- -- (This could be an Integer, but then
- -- it's harder to partitionEqnsByLit
- -- in the desugarer.)
- (GenType flexi) -- Type of pattern, t
- (HsExpr flexi id (OutPat flexi id)) -- Of type t -> Bool; detects match
- (HsExpr flexi id (OutPat flexi id)) -- Of type t -> t; subtracts k
+\begin{code}
+type InPat id = Pat id -- No 'Out' constructors
+type OutPat id = Pat id -- No 'In' constructors
+
+data Pat id
+ = ------------ Simple patterns ---------------
+ WildPat PostTcType -- Wild card
+ | VarPat id -- Variable
+ | LazyPat (Pat id) -- Lazy pattern
+ | AsPat id (Pat id) -- As pattern
+ | ParPat (Pat id) -- Parenthesised pattern
+
+ ------------ Lists, tuples, arrays ---------------
+ | ListPat [Pat id] -- Syntactic list
+ PostTcType -- The type of the elements
+
+ | TuplePat [Pat id] -- Tuple
+ Boxity -- UnitPat is TuplePat []
+
+ | PArrPat [Pat id] -- Syntactic parallel array
+ PostTcType -- The type of the elements
+
+ ------------ Constructor patterns ---------------
+ | ConPatIn id
+ (HsConDetails id (Pat id))
+
+ | ConPatOut DataCon
+ (HsConDetails id (Pat id))
+ Type -- The type of the pattern
+ [TyVar] -- Existentially bound type variables
+ [id] -- Ditto dictionaries
+
+ ------------ Literal and n+k patterns ---------------
+ | LitPat HsLit -- Used for *non-overloaded* literal patterns:
+ -- Int#, Char#, Int, Char, String, etc.
+
+ | NPatIn HsOverLit -- Always positive
+ (Maybe SyntaxName) -- Just (Name of 'negate') for negative
+ -- patterns, Nothing otherwise
+
+ | NPatOut HsLit -- Used for literal patterns where there's an equality function to call
+ -- The literal is retained so that the desugarer can readily identify
+ -- equations with identical literal-patterns
+ -- Always HsInteger, HsRat or HsString.
+ -- Always HsInteger, HsRat or HsString.
+ -- *Unlike* NPatIn, for negative literals, the
+ -- literal is acutally negative!
+ Type -- Type of pattern, t
+ (HsExpr id) -- Of type t -> Bool; detects match
+
+ | NPlusKPatIn id -- n+k pattern
+ HsOverLit -- It'll always be an HsIntegral
+ SyntaxName -- Name of '-' (see RnEnv.lookupSyntaxName)
+
+ | NPlusKPatOut id
+ Integer
+ (HsExpr id) -- Of type t -> Bool; detects match
+ (HsExpr id) -- Of type t -> t; subtracts k
+
+
+ ------------ Generics ---------------
+ | TypePat (HsType id) -- Type pattern for generic definitions
+ -- e.g f{| a+b |} = ...
+ -- These show up only in class declarations,
+ -- and should be a top-level pattern
+
+ ------------ Pattern type signatures ---------------
+ | SigPatIn (Pat id) -- Pattern with a type signature
+ (HsType id)
+
+ | SigPatOut (Pat id) -- Pattern p
+ Type -- Type, t, of the whole pattern
+ (HsExpr id) -- Coercion function,
+ -- of type t -> typeof(p)
+
+ ------------ Dictionary patterns (translation only) ---------------
| DictPat -- Used when destructing Dictionaries with an explicit case
[id] -- superclass dicts
[id] -- methods
\end{code}
-Now name in Inpat is not need to be in NAmedThing to be Outputable.
-Needed by ../deSugar/Check.lhs
-
-JJQC-2-12-97
+HsConDetails is use both for patterns and for data type declarations
\begin{code}
-instance (Outputable name) => Outputable (InPat name) where
- ppr = pprInPat
+data HsConDetails id arg
+ = PrefixCon [arg] -- C p1 p2 p3
+ | RecCon [(id, arg)] -- C { x = p1, y = p2 }
+ | InfixCon arg arg -- p1 `C` p2
+
+hsConArgs :: HsConDetails id arg -> [arg]
+hsConArgs (PrefixCon ps) = ps
+hsConArgs (RecCon fs) = map snd fs
+hsConArgs (InfixCon p1 p2) = [p1,p2]
+\end{code}
-pprInPat :: (Outputable name) => InPat name -> SDoc
-pprInPat (WildPatIn) = char '_'
-pprInPat (VarPatIn var) = ppr var
-pprInPat (LitPatIn s) = ppr s
-pprInPat (LazyPatIn pat) = char '~' <> ppr pat
-pprInPat (AsPatIn name pat) = parens (hcat [ppr name, char '@', ppr pat])
+%************************************************************************
+%* *
+%* Printing patterns
+%* *
+%************************************************************************
-pprInPat (ConPatIn c pats)
- | null pats = ppr c
- | otherwise = hsep [ppr c, interppSP pats] -- ParPats put in the parens
+\begin{code}
+instance (OutputableBndr name) => Outputable (Pat name) where
+ ppr = pprPat
-pprInPat (ConOpPatIn pat1 op fixity pat2)
- = hsep [ppr pat1, ppr op, ppr pat2] -- ParPats put in parens
+pprPat :: (OutputableBndr name) => Pat name -> SDoc
- -- ToDo: use pprSym to print op (but this involves fiddling various
- -- contexts & I'm lazy...); *PatIns are *rarely* printed anyway... (WDP)
+pprPat (VarPat var) -- Print with type info if -dppr-debug is on
+ = getPprStyle $ \ sty ->
+ if debugStyle sty then
+ parens (pprBndr LambdaBind var) -- Could pass the site to pprPat
+ -- but is it worth it?
+ else
+ ppr var
-pprInPat (NegPatIn pat)
- = let
- pp_pat = pprInPat pat
- in
- char '-' <> (
- case pat of
- LitPatIn _ -> pp_pat
- _ -> parens pp_pat
- )
-
-pprInPat (ParPatIn pat)
- = parens (pprInPat pat)
-
-pprInPat (ListPatIn pats)
- = brackets (interpp'SP pats)
-pprInPat (TuplePatIn pats)
- = parens (interpp'SP pats)
-pprInPat (NPlusKPatIn n k)
- = parens (hcat [ppr n, char '+', ppr k])
-
-pprInPat (RecPatIn con rpats)
- = hsep [ppr con, braces (hsep (punctuate comma (map (pp_rpat) rpats)))]
- where
- pp_rpat (v, _, True) = ppr v
- pp_rpat (v, p, _) = hsep [ppr v, char '=', ppr p]
-\end{code}
+pprPat (WildPat _) = char '_'
+pprPat (LazyPat pat) = char '~' <> ppr pat
+pprPat (AsPat name pat) = parens (hcat [ppr name, char '@', ppr pat])
+pprPat (ParPat pat) = parens (pprPat pat)
-\begin{code}
-instance (Outputable id) => Outputable (OutPat flexi id) where
- ppr = pprOutPat
-\end{code}
+pprPat (ListPat pats _) = brackets (interpp'SP pats)
+pprPat (PArrPat pats _) = pabrackets (interpp'SP pats)
+pprPat (TuplePat pats bx) = tupleParens bx (interpp'SP pats)
-\begin{code}
-pprOutPat (WildPat ty) = char '_'
-pprOutPat (VarPat var) = ppr var
-pprOutPat (LazyPat pat) = hcat [char '~', ppr pat]
-pprOutPat (AsPat name pat)
- = parens (hcat [ppr name, char '@', ppr pat])
+pprPat (ConPatIn c details) = pprConPat c details
+pprPat (ConPatOut c details _ _ _) = pprConPat c details
-pprOutPat (ConPat name ty [])
- = ppr name
+pprPat (LitPat s) = ppr s
+pprPat (NPatIn l _) = ppr l
+pprPat (NPatOut l _ _) = ppr l
+pprPat (NPlusKPatIn n k _) = hcat [ppr n, char '+', ppr k]
+pprPat (NPlusKPatOut n k _ _) = hcat [ppr n, char '+', integer k]
-pprOutPat (ConPat name ty pats)
- = hcat [parens (hcat [ppr name, space, interppSP pats])]
+pprPat (TypePat ty) = ptext SLIT("{|") <> ppr ty <> ptext SLIT("|}")
+
+pprPat (SigPatIn pat ty) = ppr pat <+> dcolon <+> ppr ty
+pprPat (SigPatOut pat ty _) = ppr pat <+> dcolon <+> ppr ty
+
+pprPat (DictPat dicts methods)
+ = parens (sep [ptext SLIT("{-dict-}"),
+ brackets (interpp'SP dicts),
+ brackets (interpp'SP methods)])
-pprOutPat (ConOpPat pat1 op pat2 ty)
- = parens (hcat [ppr pat1, space, ppr op, space, ppr pat2])
-pprOutPat (ListPat ty pats)
- = brackets (interpp'SP pats)
-pprOutPat (TuplePat pats)
- = parens (interpp'SP pats)
-pprOutPat (RecPat con ty rpats)
- = hcat [ppr con, braces (hsep (punctuate comma (map (pp_rpat) rpats)))]
+pprConPat con (PrefixCon pats) = ppr con <+> interppSP pats -- inner ParPats supply the necessary parens.
+pprConPat con (InfixCon pat1 pat2) = hsep [ppr pat1, ppr con, ppr pat2] -- ParPats put in parens
+ -- ToDo: use pprSym to print op (but this involves fiddling various
+ -- contexts & I'm lazy...); *PatIns are *rarely* printed anyway... (WDP)
+pprConPat con (RecCon rpats)
+ = ppr con <+> braces (hsep (punctuate comma (map (pp_rpat) rpats)))
where
- pp_rpat (v, _, True) = ppr v
- pp_rpat (v, p, _) = hsep [ppr v, char '=', ppr p]
+ pp_rpat (v, p) = hsep [ppr v, char '=', ppr p]
-pprOutPat (LitPat l ty) = ppr l -- ToDo: print more
-pprOutPat (NPat l ty e) = ppr l -- ToDo: print more
-pprOutPat (NPlusKPat n k ty e1 e2) -- ToDo: print more
- = parens (hcat [ppr n, char '+', ppr k])
-pprOutPat (DictPat dicts methods)
- = parens (sep [ptext SLIT("{-dict-}"),
- brackets (interpp'SP dicts),
- brackets (interpp'SP methods)])
+-- add parallel array brackets around a document
+--
+pabrackets :: SDoc -> SDoc
+pabrackets p = ptext SLIT("[:") <> p <> ptext SLIT(":]")
+\end{code}
+
+%************************************************************************
+%* *
+%* Building patterns
+%* *
+%************************************************************************
+
+\begin{code}
+mkPrefixConPat :: DataCon -> [OutPat id] -> Type -> OutPat id
+-- Make a vanilla Prefix constructor pattern
+mkPrefixConPat dc pats ty = ConPatOut dc (PrefixCon pats) ty [] []
+
+mkNilPat :: Type -> OutPat id
+mkNilPat ty = mkPrefixConPat nilDataCon [] ty
+
+mkCharLitPat :: Int -> OutPat id
+mkCharLitPat c = mkPrefixConPat charDataCon [LitPat (HsCharPrim c)] charTy
\end{code}
+
%************************************************************************
%* *
-%* predicates for checking things about pattern-lists in EquationInfo *
+%* Predicates for checking things about pattern-lists in EquationInfo *
%* *
%************************************************************************
+
\subsection[Pat-list-predicates]{Look for interesting things in patterns}
Unlike in the Wadler chapter, where patterns are either ``variables''
The 1.3 report defines what ``irrefutable'' and ``failure-free'' patterns are.
\begin{code}
-irrefutablePats :: [OutPat a b] -> Bool
-irrefutablePats pat_list = all irrefutablePat pat_list
-
-irrefutablePat (AsPat _ pat) = irrefutablePat pat
-irrefutablePat (WildPat _) = True
-irrefutablePat (VarPat _) = True
-irrefutablePat (LazyPat _) = True
-irrefutablePat (DictPat ds ms) = (length ds + length ms) <= 1
-irrefutablePat other = False
-
-failureFreePat :: OutPat a b -> Bool
-
-failureFreePat (WildPat _) = True
-failureFreePat (VarPat _) = True
-failureFreePat (LazyPat _) = True
-failureFreePat (AsPat _ pat) = failureFreePat pat
-failureFreePat (ConPat con tys pats) = only_con con && all failureFreePat pats
-failureFreePat (ConOpPat pat1 con pat2 _) = only_con con && failureFreePat pat1 && failureFreePat pat1
-failureFreePat (RecPat con _ fields) = only_con con && and [ failureFreePat pat | (_,pat,_) <- fields ]
-failureFreePat (ListPat _ _) = False
-failureFreePat (TuplePat pats) = all failureFreePat pats
-failureFreePat (DictPat _ _) = True
-failureFreePat other_pat = False -- Literals, NPat
-
-only_con con = maybeToBool (maybeTyConSingleCon (dataConTyCon con))
-\end{code}
+isWildPat (WildPat _) = True
+isWildPat other = False
-\begin{code}
-patsAreAllCons :: [OutPat a b] -> Bool
+patsAreAllCons :: [Pat id] -> Bool
patsAreAllCons pat_list = all isConPat pat_list
isConPat (AsPat _ pat) = isConPat pat
-isConPat (ConPat _ _ _) = True
-isConPat (ConOpPat _ _ _ _) = True
+isConPat (ConPatIn _ _) = True
+isConPat (ConPatOut _ _ _ _ _) = True
isConPat (ListPat _ _) = True
-isConPat (TuplePat _) = True
-isConPat (RecPat _ _ _) = True
+isConPat (PArrPat _ _) = True
+isConPat (TuplePat _ _) = True
isConPat (DictPat ds ms) = (length ds + length ms) > 1
isConPat other = False
-patsAreAllLits :: [OutPat a b] -> Bool
+isSigPat (SigPatIn _ _) = True
+isSigPat (SigPatOut _ _ _) = True
+isSigPat other = False
+
+patsAreAllLits :: [Pat id] -> Bool
patsAreAllLits pat_list = all isLitPat pat_list
-isLitPat (AsPat _ pat) = isLitPat pat
-isLitPat (LitPat _ _) = True
-isLitPat (NPat _ _ _) = True
-isLitPat (NPlusKPat _ _ _ _ _) = True
-isLitPat other = False
+isLitPat (AsPat _ pat) = isLitPat pat
+isLitPat (LitPat _) = True
+isLitPat (NPatIn _ _) = True
+isLitPat (NPatOut _ _ _) = True
+isLitPat (NPlusKPatIn _ _ _) = True
+isLitPat (NPlusKPatOut _ _ _ _) = True
+isLitPat other = False
\end{code}
+%************************************************************************
+%* *
+%* Gathering stuff out of patterns
+%* *
+%************************************************************************
+
This function @collectPatBinders@ works with the ``collectBinders''
functions for @HsBinds@, etc. The order in which the binders are
collected is important; see @HsBinds.lhs@.
+
+It collects the bounds *value* variables in renamed patterns; type variables
+are *not* collected.
+
\begin{code}
-collectPatBinders :: InPat a -> [a]
-
-collectPatBinders WildPatIn = []
-collectPatBinders (VarPatIn var) = [var]
-collectPatBinders (LitPatIn _) = []
-collectPatBinders (LazyPatIn pat) = collectPatBinders pat
-collectPatBinders (AsPatIn a pat) = a : collectPatBinders pat
-collectPatBinders (NPlusKPatIn n _) = [n]
-collectPatBinders (ConPatIn c pats) = concat (map collectPatBinders pats)
-collectPatBinders (ConOpPatIn p1 c f p2) = collectPatBinders p1 ++ collectPatBinders p2
-collectPatBinders (NegPatIn pat) = collectPatBinders pat
-collectPatBinders (ParPatIn pat) = collectPatBinders pat
-collectPatBinders (ListPatIn pats) = concat (map collectPatBinders pats)
-collectPatBinders (TuplePatIn pats) = concat (map collectPatBinders pats)
-collectPatBinders (RecPatIn c fields) = concat (map (\ (f,pat,_) -> collectPatBinders pat) fields)
+collectPatBinders :: Pat a -> [a]
+collectPatBinders pat = collect pat []
+
+collectPatsBinders :: [Pat a] -> [a]
+collectPatsBinders pats = foldr collect [] pats
+
+collect (WildPat _) bndrs = bndrs
+collect (VarPat var) bndrs = var : bndrs
+collect (LazyPat pat) bndrs = collect pat bndrs
+collect (AsPat a pat) bndrs = a : collect pat bndrs
+collect (ParPat pat) bndrs = collect pat bndrs
+
+collect (ListPat pats _) bndrs = foldr collect bndrs pats
+collect (PArrPat pats _) bndrs = foldr collect bndrs pats
+collect (TuplePat pats _) bndrs = foldr collect bndrs pats
+
+collect (ConPatIn c ps) bndrs = foldr collect bndrs (hsConArgs ps)
+collect (ConPatOut c ps _ _ ds) bndrs = ds ++ foldr collect bndrs (hsConArgs ps)
+
+collect (LitPat _) bndrs = bndrs
+collect (NPatIn _ _) bndrs = bndrs
+collect (NPatOut _ _ _) bndrs = bndrs
+
+collect (NPlusKPatIn n _ _) bndrs = n : bndrs
+collect (NPlusKPatOut n _ _ _) bndrs = n : bndrs
+
+collect (SigPatIn pat _) bndrs = collect pat bndrs
+collect (SigPatOut pat _ _) bndrs = collect pat bndrs
+collect (TypePat ty) bndrs = bndrs
+collect (DictPat ids1 ids2) bndrs = ids1 ++ ids2 ++ bndrs
\end{code}
+
+\begin{code}
+collectSigTysFromPats :: [InPat name] -> [HsType name]
+collectSigTysFromPats pats = foldr collect_pat [] pats
+
+collectSigTysFromPat :: InPat name -> [HsType name]
+collectSigTysFromPat pat = collect_pat pat []
+
+collect_pat (SigPatIn pat ty) acc = collect_pat pat (ty:acc)
+collect_pat (TypePat ty) acc = ty:acc
+
+collect_pat (LazyPat pat) acc = collect_pat pat acc
+collect_pat (AsPat a pat) acc = collect_pat pat acc
+collect_pat (ParPat pat) acc = collect_pat pat acc
+collect_pat (ListPat pats _) acc = foldr collect_pat acc pats
+collect_pat (PArrPat pats _) acc = foldr collect_pat acc pats
+collect_pat (TuplePat pats _) acc = foldr collect_pat acc pats
+collect_pat (ConPatIn c ps) acc = foldr collect_pat acc (hsConArgs ps)
+collect_pat other acc = acc -- Literals, vars, wildcard
+\end{code}
+