\section[HsDecls]{Abstract syntax: global declarations}
Definitions for: @FixityDecl@, @TyDecl@ and @ConDecl@, @ClassDecl@,
-@InstDecl@, @DefaultDecl@.
+@InstDecl@, @DefaultDecl@ and @ForeignDecl@.
\begin{code}
-#include "HsVersions.h"
-
module HsDecls where
-import Ubiq{-uitous-}
+#include "HsVersions.h"
-- friends:
-import HsLoop ( nullMonoBinds, MonoBinds, Sig )
-import HsPragmas ( DataPragmas, ClassPragmas,
- InstancePragmas, ClassOpPragmas
- )
+import HsBinds ( HsBinds, MonoBinds, Sig, nullMonoBinds )
+import HsPragmas ( DataPragmas, ClassPragmas )
import HsTypes
+import HsCore ( UfExpr )
+import BasicTypes ( Fixity, NewOrData(..) )
+import IdInfo ( ArgUsageInfo, FBTypeInfo, ArityInfo, UpdateInfo )
+import Demand ( Demand )
+import CallConv ( CallConv, pprCallConv )
-- others:
-import Outputable
-import Pretty
-import ProtoName ( cmpProtoName, ProtoName )
+import Name ( getOccName, OccName, NamedThing(..) )
+import Outputable
import SrcLoc ( SrcLoc )
-import Util ( cmpList, panic#{-ToDo:rm eventually-} )
+import Util
\end{code}
+
%************************************************************************
%* *
-\subsection[FixityDecl]{A fixity declaration}
+\subsection[HsDecl]{Declarations}
%* *
%************************************************************************
-These are only used in generating interfaces at the moment. They are
-not used in pretty-printing.
+\begin{code}
+data HsDecl flexi name pat
+ = TyD (TyDecl name)
+ | ClD (ClassDecl flexi name pat)
+ | InstD (InstDecl flexi name pat)
+ | DefD (DefaultDecl name)
+ | ValD (HsBinds flexi name pat)
+ | SigD (IfaceSig name)
+ | ForD (ForeignDecl name)
+\end{code}
\begin{code}
-data FixityDecl name
- = InfixL name Int
- | InfixR name Int
- | InfixN name Int
+#ifdef DEBUG
+hsDeclName :: (NamedThing name, Outputable name, Outputable pat)
+ => HsDecl flexi name pat -> name
+#endif
+hsDeclName (TyD (TyData _ _ name _ _ _ _ _)) = name
+hsDeclName (TyD (TySynonym name _ _ _)) = name
+hsDeclName (ClD (ClassDecl _ name _ _ _ _ _ _ _)) = name
+hsDeclName (SigD (IfaceSig name _ _ _)) = name
+hsDeclName (InstD (InstDecl _ _ _ (Just name) _)) = name
+hsDeclName (ForD (ForeignDecl name _ _ _ _ _)) = name
+-- Others don't make sense
+#ifdef DEBUG
+hsDeclName x = pprPanic "HsDecls.hsDeclName" (ppr x)
+#endif
\end{code}
\begin{code}
-instance (NamedThing name, Outputable name)
- => Outputable (FixityDecl name) where
- ppr sty (InfixL var prec) = print_it sty "l" prec var
- ppr sty (InfixR var prec) = print_it sty "r" prec var
- ppr sty (InfixN var prec) = print_it sty "" prec var
+instance (NamedThing name, Outputable name, Outputable pat)
+ => Outputable (HsDecl flexi name pat) where
+
+ ppr (TyD td) = ppr td
+ ppr (ClD cd) = ppr cd
+ ppr (SigD sig) = ppr sig
+ ppr (ValD binds) = ppr binds
+ ppr (DefD def) = ppr def
+ ppr (InstD inst) = ppr inst
+ ppr (ForD fd) = ppr fd
+
+#ifdef DEBUG
+-- hsDeclName needs more context when DEBUG is on
+instance (NamedThing name, Outputable name, Outputable pat, Eq name)
+ => Eq (HsDecl flex name pat) where
+ d1 == d2 = hsDeclName d1 == hsDeclName d2
+
+instance (NamedThing name, Outputable name, Outputable pat, Ord name)
+ => Ord (HsDecl flex name pat) where
+ d1 `compare` d2 = hsDeclName d1 `compare` hsDeclName d2
+#else
+instance (Eq name) => Eq (HsDecl flex name pat) where
+ d1 == d2 = hsDeclName d1 == hsDeclName d2
+
+instance (Ord name) => Ord (HsDecl flexi name pat) where
+ d1 `compare` d2 = hsDeclName d1 `compare` hsDeclName d2
+#endif
+\end{code}
+
+
+%************************************************************************
+%* *
+\subsection[FixityDecl]{A fixity declaration}
+%* *
+%************************************************************************
+
+\begin{code}
+data FixityDecl name = FixityDecl name Fixity SrcLoc
-print_it sty suff prec var
- = ppBesides [ppStr "infix", ppStr suff, ppSP, ppInt prec, ppSP, pprOp sty var]
+instance Outputable name => Outputable (FixityDecl name) where
+ ppr (FixityDecl name fixity loc) = sep [ppr fixity, ppr name]
\end{code}
+
%************************************************************************
%* *
\subsection[TyDecl]{@data@, @newtype@ or @type@ (synonym) type declaration}
\begin{code}
data TyDecl name
- = TyData (Context name) -- context
+ = TyData NewOrData
+ (Context name) -- context
name -- type constructor
- [name] -- type variables
+ [HsTyVar name] -- type variables
[ConDecl name] -- data constructors (empty if abstract)
(Maybe [name]) -- derivings; Nothing => not specified
-- (i.e., derive default); Just [] => derive
(DataPragmas name)
SrcLoc
- | TyNew (Context name) -- context
- name -- type constructor
- [name] -- type variables
- [ConDecl name] -- data constructor (empty if abstract)
- (Maybe [name]) -- derivings; as above
- (DataPragmas name)
- SrcLoc
-
| TySynonym name -- type constructor
- [name] -- type variables
- (MonoType name) -- synonym expansion
+ [HsTyVar name] -- type variables
+ (HsType name) -- synonym expansion
SrcLoc
\end{code}
instance (NamedThing name, Outputable name)
=> Outputable (TyDecl name) where
- ppr sty (TySynonym tycon tyvars mono_ty src_loc)
- = ppHang (pp_decl_head sty SLIT("type") ppNil tycon tyvars)
- 4 (ppCat [ppEquals, ppr sty mono_ty])
+ ppr (TySynonym tycon tyvars mono_ty src_loc)
+ = hang (pp_decl_head SLIT("type") empty tycon tyvars)
+ 4 (ppr mono_ty)
- ppr sty (TyData context tycon tyvars condecls derivings pragmas src_loc)
- = pp_tydecl sty
- (pp_decl_head sty SLIT("data") (pprContext sty context) tycon tyvars)
- (pp_condecls sty condecls)
- derivings
-
- ppr sty (TyNew context tycon tyvars condecl derivings pragmas src_loc)
- = pp_tydecl sty
- (pp_decl_head sty SLIT("newtype") (pprContext sty context) tycon tyvars)
- (pp_condecls sty condecl)
+ ppr (TyData new_or_data context tycon tyvars condecls derivings pragmas src_loc)
+ = pp_tydecl
+ (pp_decl_head keyword (pp_context_and_arrow context) tycon tyvars)
+ (pp_condecls condecls)
derivings
+ where
+ keyword = case new_or_data of
+ NewType -> SLIT("newtype")
+ DataType -> SLIT("data")
-pp_decl_head sty str pp_context tycon tyvars
- = ppCat [ppPStr str, pp_context, ppr sty tycon, interppSP sty tyvars]
+pp_decl_head str pp_context tycon tyvars
+ = hsep [ptext str, pp_context, ppr tycon,
+ interppSP tyvars, ptext SLIT("=")]
-pp_condecls sty [] = ppNil -- abstract datatype
-pp_condecls sty (c:cs)
- = ppSep (ppBeside (ppStr "= ") (ppr sty c)
- : map (\ x -> ppBeside (ppStr "| ") (ppr sty x)) cs)
+pp_condecls [] = empty -- Curious!
+pp_condecls (c:cs)
+ = sep (ppr c : map (\ c -> (<>) (ptext SLIT("| ")) (ppr c)) cs)
-pp_tydecl sty pp_head pp_decl_rhs derivings
- = ppHang pp_head 4 (ppSep [
+pp_tydecl pp_head pp_decl_rhs derivings
+ = hang pp_head 4 (sep [
pp_decl_rhs,
case derivings of
- Nothing -> ppNil
- Just ds -> ppBeside (ppPStr SLIT("deriving "))
- (ppParens (ppInterleave ppComma (map (ppr sty) ds)))])
+ Nothing -> empty
+ Just ds -> hsep [ptext SLIT("deriving"), parens (interpp'SP ds)]
+ ])
+
+pp_context_and_arrow :: Outputable name => Context name -> SDoc
+pp_context_and_arrow [] = empty
+pp_context_and_arrow theta = hsep [pprContext theta, ptext SLIT("=>")]
\end{code}
A type for recording what types a datatype should be specialised to.
\begin{code}
data SpecDataSig name
= SpecDataSig name -- tycon to specialise
- (MonoType name)
+ (HsType name)
SrcLoc
instance (NamedThing name, Outputable name)
=> Outputable (SpecDataSig name) where
- ppr sty (SpecDataSig tycon ty _)
- = ppCat [ppStr "{-# SPECIALIZE data", ppr sty ty, ppStr "#-}"]
+ ppr (SpecDataSig tycon ty _)
+ = hsep [text "{-# SPECIALIZE data", ppr ty, text "#-}"]
\end{code}
%************************************************************************
\begin{code}
data ConDecl name
- = ConDecl name -- prefix-style con decl
- [BangType name]
+ = ConDecl name -- Constructor name
+ (Context name) -- Existential context for this constructor
+ (ConDetails name)
SrcLoc
- | ConOpDecl (BangType name) -- infix-style con decl
- name
+data ConDetails name
+ = VanillaCon -- prefix-style con decl
+ [BangType name]
+
+ | InfixCon -- infix-style con decl
+ (BangType name)
(BangType name)
- SrcLoc
- | RecConDecl name
+ | RecCon -- record-style con decl
[([name], BangType name)] -- list of "fields"
- SrcLoc
- | NewConDecl name -- newtype con decl
- (MonoType name)
- SrcLoc
+ | NewCon -- newtype con decl
+ (HsType name)
data BangType name
- = Banged (MonoType name)
- | Unbanged (MonoType name)
-\end{code}
-
-In checking interfaces, we need to ``compare'' @ConDecls@. Use with care!
-\begin{code}
-eqConDecls cons1 cons2
- = case (cmpList cmp cons1 cons2) of { EQ_ -> True; _ -> False }
- where
- cmp (ConDecl n1 tys1 _) (ConDecl n2 tys2 _)
- = case cmpProtoName n1 n2 of
- EQ_ -> cmpList cmp_bang_ty tys1 tys2
- xxx -> xxx
- cmp (ConOpDecl _ _ _ _) _ = panic# "eqConDecls:ConOpDecl"
- cmp (RecConDecl _ _ _) _ = panic# "eqConDecls:RecConDecl"
- cmp (NewConDecl _ _ _) _ = panic# "eqConDecls:NewConDecl"
- -------------
-
- cmp_ty = cmpMonoType cmpProtoName
- -------------
- cmp_bang_ty (Banged ty1) (Banged ty2) = cmp_ty ty1 ty2
- cmp_bang_ty (Unbanged ty1) (Unbanged ty2) = cmp_ty ty1 ty2
- cmp_bang_ty (Banged _) _ = LT_
- cmp_bang_ty _ _ = GT_
+ = Banged (HsType name) -- HsType: to allow Haskell extensions
+ | Unbanged (HsType name) -- (MonoType only needed for straight Haskell)
\end{code}
\begin{code}
instance (NamedThing name, Outputable name) => Outputable (ConDecl name) where
+ ppr (ConDecl con cxt con_details loc)
+ = pp_context_and_arrow cxt <+> ppr_con_details con con_details
- ppr sty (ConDecl con tys _)
- = ppCat [pprNonOp sty con, ppInterleave ppNil (map (ppr_bang sty) tys)]
- ppr sty (ConOpDecl ty1 op ty2 _)
- = ppCat [ppr_bang sty ty1, pprOp sty op, ppr_bang sty ty2]
- ppr sty (NewConDecl con ty _)
- = ppCat [pprNonOp sty con, pprParendMonoType sty ty]
- ppr sty (RecConDecl con fields _)
- = ppCat [pprNonOp sty con, ppChar '{',
- ppInterleave pp'SP (map pp_field fields), ppChar '}']
- where
- pp_field (n, ty) = ppCat [ppr sty n, ppPStr SLIT("::"), ppr_bang sty ty]
+ppr_con_details con (InfixCon ty1 ty2)
+ = hsep [ppr_bang ty1, ppr con, ppr_bang ty2]
+
+ppr_con_details con (VanillaCon tys)
+ = ppr con <+> hsep (map (ppr_bang) tys)
+
+ppr_con_details con (NewCon ty)
+ = ppr con <+> pprParendHsType ty
-ppr_bang sty (Banged ty) = ppBeside (ppChar '!') (pprParendMonoType sty ty)
-ppr_bang sty (Unbanged ty) = pprParendMonoType sty ty
+ppr_con_details con (RecCon fields)
+ = ppr con <+> braces (hsep (punctuate comma (map ppr_field fields)))
+ where
+ ppr_field (ns, ty) = hsep (map (ppr) ns) <+>
+ ptext SLIT("::") <+>
+ ppr_bang ty
+
+ppr_bang (Banged ty) = ptext SLIT("!") <> pprParendHsType ty
+ppr_bang (Unbanged ty) = pprParendHsType ty
\end{code}
%************************************************************************
%************************************************************************
\begin{code}
-data ClassDecl tyvar uvar name pat
+data ClassDecl flexi name pat
= ClassDecl (Context name) -- context...
name -- name of the class
- name -- the class type variable
+ [HsTyVar name] -- the class type variables
[Sig name] -- methods' signatures
- (MonoBinds tyvar uvar name pat) -- default methods
+ (MonoBinds flexi name pat) -- default methods
(ClassPragmas name)
+ name name -- The names of the tycon and datacon for this class
+ -- These are filled in by the renamer
SrcLoc
\end{code}
\begin{code}
-instance (NamedThing name, Outputable name, Outputable pat,
- Eq tyvar, Outputable tyvar, Eq uvar, Outputable uvar)
- => Outputable (ClassDecl tyvar uvar name pat) where
-
- ppr sty (ClassDecl context clas tyvar sigs methods pragmas src_loc)
- = ppAboves [ppCat [ppStr "class", pprContext sty context, ppr sty clas,
- ppr sty tyvar, ppStr "where"],
- -- ToDo: really shouldn't print "where" unless there are sigs
- ppNest 4 (ppAboves (map (ppr sty) sigs)),
- ppNest 4 (ppr sty methods),
- ppNest 4 (ppr sty pragmas)]
+instance (NamedThing name, Outputable name, Outputable pat)
+ => Outputable (ClassDecl flexi name pat) where
+
+ ppr (ClassDecl context clas tyvars sigs methods pragmas _ _ src_loc)
+ | null sigs -- No "where" part
+ = top_matter
+
+ | otherwise -- Laid out
+ = sep [hsep [top_matter, ptext SLIT("where {")],
+ nest 4 (vcat [sep (map ppr_sig sigs),
+ ppr methods,
+ char '}'])]
+ where
+ top_matter = hsep [ptext SLIT("class"), pp_context_and_arrow context,
+ ppr clas, hsep (map (ppr) tyvars)]
+ ppr_sig sig = ppr sig <> semi
\end{code}
%************************************************************************
%* *
-\subsection[InstDecl]{An instance declaration (also, @SpecInstSig@)}
+\subsection[InstDecl]{An instance declaration
%* *
%************************************************************************
\begin{code}
-data InstDecl tyvar uvar name pat
- = InstDecl name -- Class
-
- (PolyType name) -- Context => Instance-type
+data InstDecl flexi name pat
+ = InstDecl (HsType name) -- Context => Class Instance-type
-- Using a polytype means that the renamer conveniently
-- figures out the quantified type variables for us.
- (MonoBinds tyvar uvar name pat)
+ (MonoBinds flexi name pat)
- Bool -- True <=> This instance decl is from the
- -- module being compiled; False <=> It is from
- -- an imported interface.
+ [Sig name] -- User-supplied pragmatic info
- FAST_STRING -- The name of the module where the instance decl
- -- originally came from; easy enough if it's
- -- the module being compiled; otherwise, the
- -- info comes from a pragma.
+ (Maybe name) -- Name for the dictionary function
- [Sig name] -- actually user-supplied pragmatic info
- (InstancePragmas name) -- interface-supplied pragmatic info
SrcLoc
\end{code}
\begin{code}
-instance (NamedThing name, Outputable name, Outputable pat,
- Eq tyvar, Outputable tyvar, Eq uvar, Outputable uvar)
- => Outputable (InstDecl tyvar uvar name pat) where
-
- ppr sty (InstDecl clas ty binds local modname uprags pragmas src_loc)
- = let
- (context, inst_ty)
- = case ty of
- HsPreForAllTy c t -> (c, t)
- HsForAllTy _ c t -> (c, t)
-
- top_matter = ppCat [ppStr "instance", pprContext sty context,
- ppr sty clas, pprParendMonoType sty inst_ty]
- in
- if nullMonoBinds binds && null uprags then
- ppAbove top_matter (ppNest 4 (ppr sty pragmas))
+instance (NamedThing name, Outputable name, Outputable pat)
+ => Outputable (InstDecl flexi name pat) where
+
+ ppr (InstDecl inst_ty binds uprags dfun_name src_loc)
+ = getPprStyle $ \ sty ->
+ if ifaceStyle sty || (nullMonoBinds binds && null uprags) then
+ hsep [ptext SLIT("instance"), ppr inst_ty]
else
- ppAboves [
- ppCat [top_matter, ppStr "where"],
- if null uprags then ppNil else ppNest 4 (ppr sty uprags),
- ppNest 4 (ppr sty binds),
- ppNest 4 (ppr sty pragmas) ]
+ vcat [hsep [ptext SLIT("instance"), ppr inst_ty, ptext SLIT("where")],
+ nest 4 (ppr uprags),
+ nest 4 (ppr binds) ]
\end{code}
-A type for recording what instances the user wants to specialise;
-called a ``Sig'' because it's sort of like a ``type signature'' for an
-instance.
-\begin{code}
-data SpecInstSig name
- = SpecInstSig name -- class
- (MonoType name) -- type to specialise to
- SrcLoc
-
-instance (NamedThing name, Outputable name)
- => Outputable (SpecInstSig name) where
-
- ppr sty (SpecInstSig clas ty _)
- = ppCat [ppStr "{-# SPECIALIZE instance", ppr sty clas, ppr sty ty, ppStr "#-}"]
-\end{code}
%************************************************************************
%* *
\begin{code}
data DefaultDecl name
- = DefaultDecl [MonoType name]
+ = DefaultDecl [HsType name]
SrcLoc
instance (NamedThing name, Outputable name)
=> Outputable (DefaultDecl name) where
- ppr sty (DefaultDecl tys src_loc)
- = ppBeside (ppPStr SLIT("default ")) (ppParens (interpp'SP sty tys))
+ ppr (DefaultDecl tys src_loc)
+ = ptext SLIT("default") <+> parens (interpp'SP tys)
+\end{code}
+
+%************************************************************************
+%* *
+\subsection{Foreign function interface declaration}
+%* *
+%************************************************************************
+
+\begin{code}
+data ForeignDecl name =
+ ForeignDecl
+ name
+ ForKind
+ (HsType name)
+ ExtName
+ CallConv
+ SrcLoc
+
+instance (NamedThing name, Outputable name)
+ => Outputable (ForeignDecl name) where
+
+ ppr (ForeignDecl nm imp_exp ty ext_name cconv src_loc)
+ = ptext SLIT("foreign") <+> ppr_imp_exp <+> pprCallConv cconv <+>
+ ppr ext_name <+> ppr_unsafe <+> ppr nm <+> ptext SLIT("::") <+> ppr ty
+ where
+ (ppr_imp_exp, ppr_unsafe) =
+ case imp_exp of
+ FoLabel -> (ptext SLIT("label"), empty)
+ FoExport -> (ptext SLIT("export"), empty)
+ FoImport us
+ | us -> (ptext SLIT("import"), ptext SLIT("unsafe"))
+ | otherwise -> (ptext SLIT("import"), empty)
+
+data ForKind
+ = FoLabel
+ | FoExport
+ | FoImport Bool -- True => unsafe call.
+
+data ExtName
+ = Dynamic
+ | ExtName FAST_STRING (Maybe FAST_STRING)
+
+isDynamic :: ExtName -> Bool
+isDynamic Dynamic = True
+isDynamic _ = False
+
+
+instance Outputable ExtName where
+ ppr Dynamic = ptext SLIT("dynamic")
+ ppr (ExtName nm mb_mod) =
+ case mb_mod of { Nothing -> empty; Just m -> doubleQuotes (ptext m) } <+>
+ doubleQuotes (ptext nm)
+
+\end{code}
+
+%************************************************************************
+%* *
+\subsection{Signatures in interface files}
+%* *
+%************************************************************************
+
+\begin{code}
+data IfaceSig name
+ = IfaceSig name
+ (HsType name)
+ [HsIdInfo name]
+ SrcLoc
+
+instance (NamedThing name, Outputable name) => Outputable (IfaceSig name) where
+ ppr (IfaceSig var ty _ _)
+ = hang (hsep [ppr var, ptext SLIT("::")])
+ 4 (ppr ty)
+
+data HsIdInfo name
+ = HsArity ArityInfo
+ | HsStrictness (HsStrictnessInfo name)
+ | HsUnfold Bool (UfExpr name) -- True <=> INLINE pragma
+ | HsUpdate UpdateInfo
+ | HsArgUsage ArgUsageInfo
+ | HsFBType FBTypeInfo
+ | HsSpecialise [HsTyVar name] [HsType name] (UfExpr name)
+
+
+data HsStrictnessInfo name
+ = HsStrictnessInfo [Demand]
+ (Maybe (name, [name])) -- Worker, if any
+ -- and needed constructors
+ | HsBottom
\end{code}
projects / ghc-hetmet.git / blobdiff