%
-% (c) The GRASP/AQUA Project, Glasgow University, 1992-1996
+% (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
%
\section[HsDecls]{Abstract syntax: global declarations}
-Definitions for: @FixityDecl@, @TyDecl@ and @ConDecl@, @ClassDecl@,
-@InstDecl@, @DefaultDecl@.
+Definitions for: @TyDecl@ and @oCnDecl@, @ClassDecl@,
+@InstDecl@, @DefaultDecl@ and @ForeignDecl@.
\begin{code}
-#include "HsVersions.h"
-
-module HsDecls where
+module HsDecls (
+ HsDecl(..), TyClDecl(..), InstDecl(..), RuleDecl(..), RuleBndr(..),
+ DefaultDecl(..), HsGroup(..),
+ ForeignDecl(..), ForeignImport(..), ForeignExport(..),
+ CImportSpec(..), FoType(..),
+ ConDecl(..), CoreDecl(..),
+ BangType(..), getBangType, getBangStrictness, unbangedType,
+ DeprecDecl(..), DeprecTxt,
+ tyClDeclName, tyClDeclNames, tyClDeclTyVars,
+ isClassDecl, isSynDecl, isDataDecl, isIfaceSigDecl,
+ isTypeOrClassDecl, countTyClDecls,
+ isSourceInstDecl, ifaceRuleDeclName,
+ conDetailsTys,
+ collectRuleBndrSigTys, isSrcRule
+ ) where
-IMP_Ubiq()
+#include "HsVersions.h"
-- friends:
-import HsBinds ( HsBinds, MonoBinds, Sig, nullMonoBinds )
-import HsPragmas ( DataPragmas, ClassPragmas,
- InstancePragmas, ClassOpPragmas
- )
+import {-# SOURCE #-} HsExpr( HsExpr, pprExpr )
+ -- Because Expr imports Decls via HsBracket
+
+import HsBinds ( HsBinds, MonoBinds, Sig(..) )
+import HsPat ( HsConDetails(..), hsConArgs )
+import HsImpExp ( pprHsVar )
import HsTypes
-import IdInfo
-import SpecEnv ( SpecEnv )
-import HsCore ( UfExpr )
-import BasicTypes ( Fixity, NewOrData(..) )
+import PprCore ( pprCoreRule )
+import HsCore ( UfExpr, UfBinder, HsIdInfo, pprHsIdInfo,
+ eq_ufBinders, eq_ufExpr, pprUfExpr
+ )
+import CoreSyn ( CoreRule(..), RuleName )
+import BasicTypes ( NewOrData(..), StrictnessMark(..), Activation(..), FixitySig(..) )
+import ForeignCall ( CCallTarget(..), DNCallSpec, CCallConv, Safety,
+ CExportSpec(..))
-- others:
-import Name ( getOccName, OccName, NamedThing(..) )
-import Outputable ( interppSP, interpp'SP,
- PprStyle(..), Outputable(..){-instance * []-}
- )
-import Pretty
+import Name ( NamedThing )
+import FunDeps ( pprFundeps )
+import TyCon ( DataConDetails(..), visibleDataCons )
+import Class ( FunDep, DefMeth(..) )
+import CStrings ( CLabelString )
+import Outputable
+import Util ( eqListBy, count )
import SrcLoc ( SrcLoc )
-import Util
+import FastString
+
+import Maybe ( isNothing, fromJust )
\end{code}
%************************************************************************
\begin{code}
-data HsDecl tyvar uvar name pat
- = TyD (TyDecl name)
- | ClD (ClassDecl tyvar uvar name pat)
- | InstD (InstDecl tyvar uvar name pat)
- | DefD (DefaultDecl name)
- | ValD (HsBinds tyvar uvar name pat)
- | SigD (IfaceSig name)
+data HsDecl id
+ = TyClD (TyClDecl id)
+ | InstD (InstDecl id)
+ | ValD (MonoBinds id)
+ | SigD (Sig id)
+ | DefD (DefaultDecl id)
+ | ForD (ForeignDecl id)
+ | DeprecD (DeprecDecl id)
+ | RuleD (RuleDecl id)
+ | CoreD (CoreDecl id)
+ | SpliceD (HsExpr id) -- Top level splice
+
+-- NB: all top-level fixity decls are contained EITHER
+-- EITHER SigDs
+-- OR in the ClassDecls in TyClDs
+--
+-- The former covers
+-- a) data constructors
+-- b) class methods (but they can be also done in the
+-- signatures of class decls)
+-- c) imported functions (that have an IfacSig)
+-- d) top level decls
+--
+-- The latter is for class methods only
+
+-- A [HsDecl] is categorised into a HsGroup before being
+-- fed to the renamer.
+data HsGroup id
+ = HsGroup {
+ hs_valds :: HsBinds id,
+ -- Before the renamer, this is a single big MonoBinds,
+ -- with all the bindings, and all the signatures.
+ -- The renamer does dependency analysis, using ThenBinds
+ -- to give the structure
+
+ hs_tyclds :: [TyClDecl id],
+ hs_instds :: [InstDecl id],
+
+ hs_fixds :: [FixitySig id],
+ -- Snaffled out of both top-level fixity signatures,
+ -- and those in class declarations
+
+ hs_defds :: [DefaultDecl id],
+ hs_fords :: [ForeignDecl id],
+ hs_depds :: [DeprecDecl id],
+ hs_ruleds :: [RuleDecl id],
+ hs_coreds :: [CoreDecl id]
+ }
\end{code}
\begin{code}
-#ifdef DEBUG
-hsDeclName :: (NamedThing name, Outputable name, Outputable pat,
- Eq tyvar, Outputable tyvar, Eq uvar, Outputable uvar)
- => HsDecl tyvar uvar 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
--- Others don't make sense
-#ifdef DEBUG
-hsDeclName x = pprPanic "HsDecls.hsDeclName" (ppr PprDebug x)
-#endif
-\end{code}
-
-\begin{code}
-instance (NamedThing name, Outputable name, Outputable pat,
- Eq tyvar, Outputable tyvar, Eq uvar, Outputable uvar)
- => Outputable (HsDecl tyvar uvar name pat) where
-
- ppr sty (TyD td) = ppr sty td
- ppr sty (ClD cd) = ppr sty cd
- ppr sty (SigD sig) = ppr sty sig
- ppr sty (ValD binds) = ppr sty binds
- ppr sty (DefD def) = ppr sty def
- ppr sty (InstD inst) = ppr sty inst
-
-#ifdef DEBUG
-instance (Ord3 name, Eq tyvar, Outputable tyvar, Eq uvar, Outputable uvar,
- NamedThing name, Outputable name, Outputable pat) =>
- Ord3 (HsDecl tyvar uvar name pat) where
-#else
-instance (Ord3 name) => Ord3 (HsDecl tyvar uvar name pat) where
-#endif
- d1 `cmp` d2 = hsDeclName d1 `cmp` hsDeclName d2
+instance OutputableBndr name => Outputable (HsDecl name) where
+ ppr (TyClD dcl) = ppr dcl
+ ppr (ValD binds) = ppr binds
+ ppr (DefD def) = ppr def
+ ppr (InstD inst) = ppr inst
+ ppr (ForD fd) = ppr fd
+ ppr (SigD sd) = ppr sd
+ ppr (RuleD rd) = ppr rd
+ ppr (DeprecD dd) = ppr dd
+ ppr (CoreD dd) = ppr dd
+ ppr (SpliceD e) = ptext SLIT("splice") <> parens (pprExpr e)
+
+instance OutputableBndr name => Outputable (HsGroup name) where
+ ppr (HsGroup { hs_valds = val_decls,
+ hs_tyclds = tycl_decls,
+ hs_instds = inst_decls,
+ hs_fixds = fix_decls,
+ hs_depds = deprec_decls,
+ hs_fords = foreign_decls,
+ hs_defds = default_decls,
+ hs_ruleds = rule_decls,
+ hs_coreds = core_decls })
+ = vcat [ppr_ds fix_decls, ppr_ds default_decls,
+ ppr_ds deprec_decls, ppr_ds rule_decls,
+ ppr val_decls,
+ ppr_ds tycl_decls, ppr_ds inst_decls,
+ ppr_ds foreign_decls, ppr_ds core_decls]
+ where
+ ppr_ds [] = empty
+ ppr_ds ds = text "" $$ vcat (map ppr ds)
\end{code}
%************************************************************************
%* *
-\subsection[FixityDecl]{A fixity declaration}
+\subsection[TyDecl]{@data@, @newtype@ or @type@ (synonym) type declaration}
%* *
%************************************************************************
-\begin{code}
-data FixityDecl name = FixityDecl name Fixity SrcLoc
+ --------------------------------
+ THE NAMING STORY
+ --------------------------------
+
+Here is the story about the implicit names that go with type, class, and instance
+decls. It's a bit tricky, so pay attention!
+
+"Implicit" (or "system") binders
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ Each data type decl defines
+ a worker name for each constructor
+ to-T and from-T convertors
+ Each class decl defines
+ a tycon for the class
+ a data constructor for that tycon
+ the worker for that constructor
+ a selector for each superclass
+
+All have occurrence names that are derived uniquely from their parent declaration.
+
+None of these get separate definitions in an interface file; they are
+fully defined by the data or class decl. But they may *occur* in
+interface files, of course. Any such occurrence must haul in the
+relevant type or class decl.
+
+Plan of attack:
+ - Ensure they "point to" the parent data/class decl
+ when loading that decl from an interface file
+ (See RnHiFiles.getSysBinders)
+
+ - When typechecking the decl, we build the implicit TyCons and Ids.
+ When doing so we look them up in the name cache (RnEnv.lookupSysName),
+ to ensure correct module and provenance is set
+
+These are the two places that we have to conjure up the magic derived
+names. (The actual magic is in OccName.mkWorkerOcc, etc.)
+
+Default methods
+~~~~~~~~~~~~~~~
+ - Occurrence name is derived uniquely from the method name
+ E.g. $dmmax
+
+ - If there is a default method name at all, it's recorded in
+ the ClassOpSig (in HsBinds), in the DefMeth field.
+ (DefMeth is defined in Class.lhs)
+
+Source-code class decls and interface-code class decls are treated subtly
+differently, which has given me a great deal of confusion over the years.
+Here's the deal. (We distinguish the two cases because source-code decls
+have (Just binds) in the tcdMeths field, whereas interface decls have Nothing.
+
+In *source-code* class declarations:
+ - When parsing, every ClassOpSig gets a DefMeth with a suitable RdrName
+ This is done by RdrHsSyn.mkClassOpSigDM
+
+ - The renamer renames it to a Name
+
+ - During typechecking, we generate a binding for each $dm for
+ which there's a programmer-supplied default method:
+ class Foo a where
+ op1 :: <type>
+ op2 :: <type>
+ op1 = ...
+ We generate a binding for $dmop1 but not for $dmop2.
+ The Class for Foo has a NoDefMeth for op2 and a DefMeth for op1.
+ The Name for $dmop2 is simply discarded.
+
+In *interface-file* class declarations:
+ - When parsing, we see if there's an explicit programmer-supplied default method
+ because there's an '=' sign to indicate it:
+ class Foo a where
+ op1 = :: <type> -- NB the '='
+ op2 :: <type>
+ We use this info to generate a DefMeth with a suitable RdrName for op1,
+ and a NoDefMeth for op2
+ - The interface file has a separate definition for $dmop1, with unfolding etc.
+ - The renamer renames it to a Name.
+ - The renamer treats $dmop1 as a free variable of the declaration, so that
+ the binding for $dmop1 will be sucked in. (See RnHsSyn.tyClDeclFVs)
+ This doesn't happen for source code class decls, because they *bind* the default method.
+
+Dictionary functions
+~~~~~~~~~~~~~~~~~~~~
+Each instance declaration gives rise to one dictionary function binding.
+
+The type checker makes up new source-code instance declarations
+(e.g. from 'deriving' or generic default methods --- see
+TcInstDcls.tcInstDecls1). So we can't generate the names for
+dictionary functions in advance (we don't know how many we need).
+
+On the other hand for interface-file instance declarations, the decl
+specifies the name of the dictionary function, and it has a binding elsewhere
+in the interface file:
+ instance {Eq Int} = dEqInt
+ dEqInt :: {Eq Int} <pragma info>
+
+So again we treat source code and interface file code slightly differently.
+
+Source code:
+ - Source code instance decls have a Nothing in the (Maybe name) field
+ (see data InstDecl below)
+
+ - The typechecker makes up a Local name for the dict fun for any source-code
+ instance decl, whether it comes from a source-code instance decl, or whether
+ the instance decl is derived from some other construct (e.g. 'deriving').
+
+ - The occurrence name it chooses is derived from the instance decl (just for
+ documentation really) --- e.g. dNumInt. Two dict funs may share a common
+ occurrence name, but will have different uniques. E.g.
+ instance Foo [Int] where ...
+ instance Foo [Bool] where ...
+ These might both be dFooList
+
+ - The CoreTidy phase externalises the name, and ensures the occurrence name is
+ unique (this isn't special to dict funs). So we'd get dFooList and dFooList1.
+
+ - We can take this relaxed approach (changing the occurrence name later)
+ because dict fun Ids are not captured in a TyCon or Class (unlike default
+ methods, say). Instead, they are kept separately in the InstEnv. This
+ makes it easy to adjust them after compiling a module. (Once we've finished
+ compiling that module, they don't change any more.)
+
+
+Interface file code:
+ - The instance decl gives the dict fun name, so the InstDecl has a (Just name)
+ in the (Maybe name) field.
+
+ - RnHsSyn.instDeclFVs treats the dict fun name as free in the decl, so that we
+ suck in the dfun binding
+
-instance Outputable name => Outputable (FixityDecl name) where
- ppr sty (FixityDecl name fixity loc) = sep [ppr sty fixity, ppr sty name]
+\begin{code}
+-- TyClDecls are precisely the kind of declarations that can
+-- appear in interface files; or (internally) in GHC's interface
+-- for a module. That's why (despite the misnomer) IfaceSig and ForeignType
+-- are both in TyClDecl
+
+data TyClDecl name
+ = IfaceSig { tcdName :: name, -- It may seem odd to classify an interface-file signature
+ tcdType :: HsType name, -- as a 'TyClDecl', but it's very convenient.
+ tcdIdInfo :: [HsIdInfo name],
+ tcdLoc :: SrcLoc
+ }
+
+ | ForeignType { tcdName :: name, -- See remarks about IfaceSig above
+ tcdExtName :: Maybe FastString,
+ tcdFoType :: FoType,
+ tcdLoc :: SrcLoc }
+
+ | TyData { tcdND :: NewOrData,
+ tcdCtxt :: HsContext name, -- Context
+ tcdName :: name, -- Type constructor
+ tcdTyVars :: [HsTyVarBndr name], -- Type variables
+ tcdCons :: DataConDetails (ConDecl name), -- Data constructors
+ tcdDerivs :: Maybe (HsContext name), -- Derivings; Nothing => not specified
+ -- Just [] => derive exactly what is asked
+ tcdGeneric :: Maybe Bool, -- Nothing <=> source decl
+ -- Just x <=> interface-file decl;
+ -- x=True <=> generic converter functions available
+ -- We need this for imported data decls, since the
+ -- imported modules may have been compiled with
+ -- different flags to the current compilation unit
+ tcdLoc :: SrcLoc
+ }
+
+ | TySynonym { tcdName :: name, -- type constructor
+ tcdTyVars :: [HsTyVarBndr name], -- type variables
+ tcdSynRhs :: HsType name, -- synonym expansion
+ tcdLoc :: SrcLoc
+ }
+
+ | ClassDecl { tcdCtxt :: HsContext name, -- Context...
+ tcdName :: name, -- Name of the class
+ tcdTyVars :: [HsTyVarBndr name], -- The class type variables
+ tcdFDs :: [FunDep name], -- Functional dependencies
+ tcdSigs :: [Sig name], -- Methods' signatures
+ tcdMeths :: Maybe (MonoBinds name), -- Default methods
+ -- Nothing for imported class decls
+ -- Just bs for source class decls
+ tcdLoc :: SrcLoc
+ }
\end{code}
+Simple classifiers
-%************************************************************************
-%* *
-\subsection[TyDecl]{@data@, @newtype@ or @type@ (synonym) type declaration}
-%* *
-%************************************************************************
+\begin{code}
+isIfaceSigDecl, isDataDecl, isSynDecl, isClassDecl :: TyClDecl name -> Bool
+
+isIfaceSigDecl (IfaceSig {}) = True
+isIfaceSigDecl other = False
+
+isSynDecl (TySynonym {}) = True
+isSynDecl other = False
+
+isDataDecl (TyData {}) = True
+isDataDecl other = False
+
+isClassDecl (ClassDecl {}) = True
+isClassDecl other = False
+
+isTypeOrClassDecl (ClassDecl {}) = True
+isTypeOrClassDecl (TyData {}) = True
+isTypeOrClassDecl (TySynonym {}) = True
+isTypeOrClassDecl (ForeignType {}) = True
+isTypeOrClassDecl other = False
+\end{code}
+
+Dealing with names
\begin{code}
-data TyDecl name
- = TyData NewOrData
- (Context name) -- context
- name -- type constructor
- [HsTyVar name] -- type variables
- [ConDecl name] -- data constructors (empty if abstract)
- (Maybe [name]) -- derivings; Nothing => not specified
- -- (i.e., derive default); Just [] => derive
- -- *nothing*; Just <list> => as you would
- -- expect...
- (DataPragmas name)
- SrcLoc
+--------------------------------
+tyClDeclName :: TyClDecl name -> name
+tyClDeclName tycl_decl = tcdName tycl_decl
- | TySynonym name -- type constructor
- [HsTyVar name] -- type variables
- (HsType name) -- synonym expansion
- SrcLoc
+--------------------------------
+tyClDeclNames :: Eq name => TyClDecl name -> [(name, SrcLoc)]
+-- Returns all the *binding* names of the decl, along with their SrcLocs
+-- The first one is guaranteed to be the name of the decl
+-- For record fields, the first one counts as the SrcLoc
+-- We use the equality to filter out duplicate field names
+
+tyClDeclNames (TySynonym {tcdName = name, tcdLoc = loc}) = [(name,loc)]
+tyClDeclNames (IfaceSig {tcdName = name, tcdLoc = loc}) = [(name,loc)]
+tyClDeclNames (ForeignType {tcdName = name, tcdLoc = loc}) = [(name,loc)]
+
+tyClDeclNames (ClassDecl {tcdName = cls_name, tcdSigs = sigs, tcdLoc = loc})
+ = (cls_name,loc) : [(n,loc) | ClassOpSig n _ _ loc <- sigs]
+tyClDeclNames (TyData {tcdName = tc_name, tcdCons = cons, tcdLoc = loc})
+ = (tc_name,loc) : conDeclsNames cons
+
+
+tyClDeclTyVars (TySynonym {tcdTyVars = tvs}) = tvs
+tyClDeclTyVars (TyData {tcdTyVars = tvs}) = tvs
+tyClDeclTyVars (ClassDecl {tcdTyVars = tvs}) = tvs
+tyClDeclTyVars (ForeignType {}) = []
+tyClDeclTyVars (IfaceSig {}) = []
+\end{code}
+
+\begin{code}
+instance (NamedThing name, Ord name) => Eq (TyClDecl name) where
+ -- Used only when building interface files
+ (==) d1@(IfaceSig {}) d2@(IfaceSig {})
+ = tcdName d1 == tcdName d2 &&
+ tcdType d1 == tcdType d2 &&
+ tcdIdInfo d1 == tcdIdInfo d2
+
+ (==) d1@(ForeignType {}) d2@(ForeignType {})
+ = tcdName d1 == tcdName d2 &&
+ tcdFoType d1 == tcdFoType d2
+
+ (==) d1@(TyData {}) d2@(TyData {})
+ = tcdName d1 == tcdName d2 &&
+ tcdND d1 == tcdND d2 &&
+ eqWithHsTyVars (tcdTyVars d1) (tcdTyVars d2) (\ env ->
+ eq_hsContext env (tcdCtxt d1) (tcdCtxt d2) &&
+ eq_hsCD env (tcdCons d1) (tcdCons d2)
+ )
+
+ (==) d1@(TySynonym {}) d2@(TySynonym {})
+ = tcdName d1 == tcdName d2 &&
+ eqWithHsTyVars (tcdTyVars d1) (tcdTyVars d2) (\ env ->
+ eq_hsType env (tcdSynRhs d1) (tcdSynRhs d2)
+ )
+
+ (==) d1@(ClassDecl {}) d2@(ClassDecl {})
+ = tcdName d1 == tcdName d2 &&
+ eqWithHsTyVars (tcdTyVars d1) (tcdTyVars d2) (\ env ->
+ eq_hsContext env (tcdCtxt d1) (tcdCtxt d2) &&
+ eqListBy (eq_hsFD env) (tcdFDs d1) (tcdFDs d2) &&
+ eqListBy (eq_cls_sig env) (tcdSigs d1) (tcdSigs d2)
+ )
+
+ (==) _ _ = False -- default case
+
+eq_hsCD env (DataCons c1) (DataCons c2) = eqListBy (eq_ConDecl env) c1 c2
+eq_hsCD env Unknown Unknown = True
+eq_hsCD env (HasCons n1) (HasCons n2) = n1 == n2
+eq_hsCD env d1 d2 = False
+
+eq_hsFD env (ns1,ms1) (ns2,ms2)
+ = eqListBy (eq_hsVar env) ns1 ns2 && eqListBy (eq_hsVar env) ms1 ms2
+
+eq_cls_sig env (ClassOpSig n1 dm1 ty1 _) (ClassOpSig n2 dm2 ty2 _)
+ = n1==n2 && dm1 `eq_dm` dm2 && eq_hsType env ty1 ty2
+ where
+ -- Ignore the name of the default method for (DefMeth id)
+ -- This is used for comparing declarations before putting
+ -- them into interface files, and the name of the default
+ -- method isn't relevant
+ NoDefMeth `eq_dm` NoDefMeth = True
+ GenDefMeth `eq_dm` GenDefMeth = True
+ DefMeth _ `eq_dm` DefMeth _ = True
+ dm1 `eq_dm` dm2 = False
+\end{code}
+
+\begin{code}
+countTyClDecls :: [TyClDecl name] -> (Int, Int, Int, Int, Int)
+ -- class, data, newtype, synonym decls
+countTyClDecls decls
+ = (count isClassDecl decls,
+ count isSynDecl decls,
+ count isIfaceSigDecl decls,
+ count isDataTy decls,
+ count isNewTy decls)
+ where
+ isDataTy TyData{tcdND=DataType} = True
+ isDataTy _ = False
+
+ isNewTy TyData{tcdND=NewType} = True
+ isNewTy _ = False
\end{code}
\begin{code}
-instance (NamedThing name, Outputable name)
- => Outputable (TyDecl name) where
+instance OutputableBndr name
+ => Outputable (TyClDecl name) where
+
+ ppr (IfaceSig {tcdName = var, tcdType = ty, tcdIdInfo = info})
+ = getPprStyle $ \ sty ->
+ hsep [ pprHsVar var, dcolon, ppr ty, pprHsIdInfo info ]
- ppr sty (TySynonym tycon tyvars mono_ty src_loc)
- = hang (pp_decl_head sty SLIT("type") empty tycon tyvars)
- 4 (ppr sty mono_ty)
+ ppr (ForeignType {tcdName = tycon})
+ = hsep [ptext SLIT("foreign import type dotnet"), ppr tycon]
- ppr sty (TyData new_or_data context tycon tyvars condecls derivings pragmas src_loc)
- = pp_tydecl sty
- (pp_decl_head sty keyword (pp_context_and_arrow sty context) tycon tyvars)
- (pp_condecls sty condecls)
+ ppr (TySynonym {tcdName = tycon, tcdTyVars = tyvars, tcdSynRhs = mono_ty})
+ = hang (ptext SLIT("type") <+> pp_decl_head [] tycon tyvars <+> equals)
+ 4 (ppr mono_ty)
+
+ ppr (TyData {tcdND = new_or_data, tcdCtxt = context, tcdName = tycon,
+ tcdTyVars = tyvars, tcdCons = condecls,
+ tcdDerivs = derivings})
+ = pp_tydecl (ptext keyword <+> pp_decl_head 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
- = hsep [ptext str, pp_context, ppr sty tycon,
- interppSP sty tyvars, ptext SLIT("=")]
+ ppr (ClassDecl {tcdCtxt = context, tcdName = clas, tcdTyVars = tyvars, tcdFDs = fds,
+ tcdSigs = sigs, tcdMeths = methods})
+ | null sigs -- No "where" part
+ = top_matter
-pp_condecls sty [] = empty -- Curious!
-pp_condecls sty (c:cs)
- = sep (ppr sty c : map (\ c -> (<>) (ptext SLIT("| ")) (ppr sty c)) cs)
+ | otherwise -- Laid out
+ = sep [hsep [top_matter, ptext SLIT("where {")],
+ nest 4 (sep [sep (map ppr_sig sigs), pp_methods, char '}'])]
+ where
+ top_matter = ptext SLIT("class") <+> pp_decl_head context clas tyvars <+> pprFundeps fds
+ ppr_sig sig = ppr sig <> semi
-pp_tydecl sty pp_head pp_decl_rhs derivings
+ pp_methods = if isNothing methods
+ then empty
+ else ppr (fromJust methods)
+
+pp_decl_head :: OutputableBndr name => HsContext name -> name -> [HsTyVarBndr name] -> SDoc
+pp_decl_head context thing tyvars = hsep [pprHsContext context, ppr thing, interppSP tyvars]
+
+pp_condecls Unknown = ptext SLIT("{- abstract -}")
+pp_condecls (HasCons n) = ptext SLIT("{- abstract with") <+> int n <+> ptext SLIT("constructors -}")
+pp_condecls (DataCons cs) = equals <+> sep (punctuate (ptext SLIT(" |")) (map ppr cs))
+
+pp_tydecl pp_head pp_decl_rhs derivings
= hang pp_head 4 (sep [
pp_decl_rhs,
- case (derivings, sty) of
- (Nothing,_) -> empty
- (_,PprInterface) -> empty -- No derivings in interfaces
- (Just ds,_) -> hsep [ptext SLIT("deriving"), parens (interpp'SP sty ds)]
+ case derivings of
+ Nothing -> empty
+ Just ds -> hsep [ptext SLIT("deriving"), ppr_hs_context ds]
])
-
-pp_context_and_arrow :: Outputable name => PprStyle -> Context name -> Doc
-pp_context_and_arrow sty [] = empty
-pp_context_and_arrow sty theta = hsep [pprContext sty theta, ptext SLIT("=>")]
\end{code}
-A type for recording what types a datatype should be specialised to.
-It's called a ``Sig'' because it's sort of like a ``type signature''
-for an datatype declaration.
-
-\begin{code}
-data SpecDataSig name
- = SpecDataSig name -- tycon to specialise
- (HsType name)
- SrcLoc
-
-instance (NamedThing name, Outputable name)
- => Outputable (SpecDataSig name) where
-
- ppr sty (SpecDataSig tycon ty _)
- = hsep [text "{-# SPECIALIZE data", ppr sty ty, text "#-}"]
-\end{code}
%************************************************************************
%* *
\begin{code}
data ConDecl name
- = ConDecl name -- Constructor name
- (Context name) -- Existential context for this constructor
- (ConDetails name)
- SrcLoc
+ = ConDecl name -- Constructor name; this is used for the
+ -- DataCon itself, and for the user-callable wrapper Id
-data ConDetails name
- = VanillaCon -- prefix-style con decl
- [BangType name]
+ [HsTyVarBndr name] -- Existentially quantified type variables
+ (HsContext name) -- ...and context
+ -- If both are empty then there are no existentials
- | InfixCon -- infix-style con decl
- (BangType name)
- (BangType name)
-
- | RecCon -- record-style con decl
- [([name], BangType name)] -- list of "fields"
-
- | NewCon -- newtype con decl
- (HsType name)
-
-data BangType name
- = Banged (HsType name) -- HsType: to allow Haskell extensions
- | Unbanged (HsType name) -- (MonoType only needed for straight Haskell)
+ (HsConDetails name (BangType name))
+ SrcLoc
\end{code}
\begin{code}
-instance (NamedThing name, Outputable name) => Outputable (ConDecl name) where
- ppr sty (ConDecl con cxt con_details loc)
- = pp_context_and_arrow sty cxt <+> ppr_con_details sty con con_details
-
-ppr_con_details sty con (InfixCon ty1 ty2)
- = hsep [ppr_bang sty ty1, ppr sty con, ppr_bang sty ty2]
-
-ppr_con_details sty con (VanillaCon tys)
- = ppr sty con <+> hsep (map (ppr_bang sty) tys)
-
-ppr_con_details sty con (NewCon ty)
- = ppr sty con <+> pprParendHsType sty ty
-
-ppr_con_details sty con (RecCon fields)
- = ppr sty con <+> braces (hsep (punctuate comma (map ppr_field fields)))
+conDeclsNames :: Eq name => DataConDetails (ConDecl name) -> [(name,SrcLoc)]
+ -- See tyClDeclNames for what this does
+ -- The function is boringly complicated because of the records
+ -- And since we only have equality, we have to be a little careful
+conDeclsNames cons
+ = snd (foldl do_one ([], []) (visibleDataCons cons))
where
- ppr_field (ns, ty) = hsep (map (ppr sty) ns) <+>
- ptext SLIT("::") <+>
- ppr_bang sty ty
+ do_one (flds_seen, acc) (ConDecl name _ _ (RecCon flds) loc)
+ = (new_flds ++ flds_seen, (name,loc) : [(f,loc) | f <- new_flds] ++ acc)
+ where
+ new_flds = [ f | (f,_) <- flds, not (f `elem` flds_seen) ]
-ppr_bang sty (Banged ty) = ptext SLIT("!") <> pprParendHsType sty ty
-ppr_bang sty (Unbanged ty) = pprParendHsType sty ty
+ do_one (flds_seen, acc) (ConDecl name _ _ _ loc)
+ = (flds_seen, (name,loc):acc)
\end{code}
-%************************************************************************
-%* *
-\subsection[ClassDecl]{A class declaration}
-%* *
-%************************************************************************
-
\begin{code}
-data ClassDecl tyvar uvar name pat
- = ClassDecl (Context name) -- context...
- name -- name of the class
- (HsTyVar name) -- the class type variable
- [Sig name] -- methods' signatures
- (MonoBinds tyvar uvar name pat) -- default methods
- (ClassPragmas name)
- SrcLoc
+conDetailsTys details = map getBangType (hsConArgs details)
+
+eq_ConDecl env (ConDecl n1 tvs1 cxt1 cds1 _)
+ (ConDecl n2 tvs2 cxt2 cds2 _)
+ = n1 == n2 &&
+ (eq_hsTyVars env tvs1 tvs2 $ \ env ->
+ eq_hsContext env cxt1 cxt2 &&
+ eq_ConDetails env cds1 cds2)
+
+eq_ConDetails env (PrefixCon bts1) (PrefixCon bts2)
+ = eqListBy (eq_btype env) bts1 bts2
+eq_ConDetails env (InfixCon bta1 btb1) (InfixCon bta2 btb2)
+ = eq_btype env bta1 bta2 && eq_btype env btb1 btb2
+eq_ConDetails env (RecCon fs1) (RecCon fs2)
+ = eqListBy (eq_fld env) fs1 fs2
+eq_ConDetails env _ _ = False
+
+eq_fld env (ns1,bt1) (ns2, bt2) = ns1==ns2 && eq_btype env bt1 bt2
+\end{code}
+
+\begin{code}
+data BangType name = BangType StrictnessMark (HsType name)
+
+getBangType (BangType _ ty) = ty
+getBangStrictness (BangType s _) = s
+
+unbangedType ty = BangType NotMarkedStrict ty
+
+eq_btype env (BangType s1 t1) (BangType s2 t2) = s1==s2 && eq_hsType env t1 t2
\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
+instance (OutputableBndr name) => Outputable (ConDecl name) where
+ ppr (ConDecl con tvs cxt con_details loc)
+ = sep [pprHsForAll tvs cxt, ppr_con_details con con_details]
+
+ppr_con_details con (InfixCon ty1 ty2)
+ = hsep [ppr_bang ty1, ppr con, ppr_bang ty2]
+
+-- ConDecls generated by MkIface.ifaceTyThing always have a PrefixCon, even
+-- if the constructor is an infix one. This is because in an interface file
+-- we don't distinguish between the two. Hence when printing these for the
+-- user, we need to parenthesise infix constructor names.
+ppr_con_details con (PrefixCon tys)
+ = hsep (pprHsVar con : map ppr_bang tys)
+
+ppr_con_details con (RecCon fields)
+ = ppr con <+> braces (sep (punctuate comma (map ppr_field fields)))
+ where
+ ppr_field (n, ty) = ppr n <+> dcolon <+> ppr_bang ty
- ppr sty (ClassDecl context clas tyvar sigs methods pragmas src_loc)
- | null sigs -- No "where" part
- = top_matter
+instance OutputableBndr name => Outputable (BangType name) where
+ ppr = ppr_bang
- | otherwise -- Laid out
- = sep [hsep [top_matter, ptext SLIT("where {")],
- nest 4 (vcat [sep (map ppr_sig sigs),
- ppr sty methods,
- char '}'])]
- where
- top_matter = hsep [ptext SLIT("class"), pp_context_and_arrow sty context,
- ppr sty clas, ppr sty tyvar]
- ppr_sig sig = ppr sty sig <> semi
+ppr_bang (BangType s ty) = ppr s <> pprParendHsType ty
\end{code}
+
%************************************************************************
%* *
-\subsection[InstDecl]{An instance declaration (also, @SpecInstSig@)}
+\subsection[InstDecl]{An instance declaration
%* *
%************************************************************************
\begin{code}
-data InstDecl tyvar uvar name pat
+data InstDecl name
= 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 name)
[Sig name] -- User-supplied pragmatic info
(Maybe name) -- Name for the dictionary function
+ -- Nothing for source-file instance decls
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 inst_ty binds uprags dfun_name src_loc)
- | case sty of { PprInterface -> True; other -> False} ||
- nullMonoBinds binds && null uprags
- = hsep [ptext SLIT("instance"), ppr sty inst_ty]
-
- | otherwise
- = vcat [hsep [ptext SLIT("instance"), ppr sty inst_ty, ptext SLIT("where")],
- nest 4 (ppr sty uprags),
- nest 4 (ppr sty binds) ]
+isSourceInstDecl :: InstDecl name -> Bool
+isSourceInstDecl (InstDecl _ _ _ maybe_dfun _) = isNothing maybe_dfun
\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
- (HsType name) -- type to specialise to
- SrcLoc
+instance (OutputableBndr name) => Outputable (InstDecl name) where
-instance (NamedThing name, Outputable name)
- => Outputable (SpecInstSig name) where
+ ppr (InstDecl inst_ty binds uprags maybe_dfun_name src_loc)
+ = vcat [hsep [ptext SLIT("instance"), ppr inst_ty, ptext SLIT("where")],
+ nest 4 (ppr uprags),
+ nest 4 (ppr binds) ]
+ where
+ pp_dfun = case maybe_dfun_name of
+ Just df -> ppr df
+ Nothing -> empty
+\end{code}
- ppr sty (SpecInstSig clas ty _)
- = hsep [text "{-# SPECIALIZE instance", ppr sty clas, ppr sty ty, text "#-}"]
+\begin{code}
+instance Ord name => Eq (InstDecl name) where
+ -- Used for interface comparison only, so don't compare bindings
+ (==) (InstDecl inst_ty1 _ _ dfun1 _) (InstDecl inst_ty2 _ _ dfun2 _)
+ = inst_ty1 == inst_ty2 && dfun1 == dfun2
\end{code}
+
%************************************************************************
%* *
\subsection[DefaultDecl]{A @default@ declaration}
= DefaultDecl [HsType name]
SrcLoc
-instance (NamedThing name, Outputable name)
+instance (OutputableBndr name)
=> Outputable (DefaultDecl name) where
- ppr sty (DefaultDecl tys src_loc)
- = (<>) (ptext SLIT("default ")) (parens (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}
+
+-- foreign declarations are distinguished as to whether they define or use a
+-- Haskell name
+--
+-- * the Boolean value indicates whether the pre-standard deprecated syntax
+-- has been used
+--
+data ForeignDecl name
+ = ForeignImport name (HsType name) ForeignImport Bool SrcLoc -- defines name
+ | ForeignExport name (HsType name) ForeignExport Bool SrcLoc -- uses name
+
+-- yield the Haskell name defined or used in a foreign declaration
+--
+foreignDeclName :: ForeignDecl name -> name
+foreignDeclName (ForeignImport n _ _ _ _) = n
+foreignDeclName (ForeignExport n _ _ _ _) = n
+
+-- specification of an imported external entity in dependence on the calling
+-- convention
+--
+data ForeignImport = -- import of a C entity
+ --
+ -- * the two strings specifying a header file or library
+ -- may be empty, which indicates the absence of a
+ -- header or object specification (both are not used
+ -- in the case of `CWrapper' and when `CFunction'
+ -- has a dynamic target)
+ --
+ -- * the calling convention is irrelevant for code
+ -- generation in the case of `CLabel', but is needed
+ -- for pretty printing
+ --
+ -- * `Safety' is irrelevant for `CLabel' and `CWrapper'
+ --
+ CImport CCallConv -- ccall or stdcall
+ Safety -- safe or unsafe
+ FastString -- name of C header
+ FastString -- name of library object
+ CImportSpec -- details of the C entity
+
+ -- import of a .NET function
+ --
+ | DNImport DNCallSpec
+
+-- details of an external C entity
+--
+data CImportSpec = CLabel CLabelString -- import address of a C label
+ | CFunction CCallTarget -- static or dynamic function
+ | CWrapper -- wrapper to expose closures
+ -- (former f.e.d.)
+
+-- specification of an externally exported entity in dependence on the calling
+-- convention
+--
+data ForeignExport = CExport CExportSpec -- contains the calling convention
+ | DNExport -- presently unused
+
+-- abstract type imported from .NET
+--
+data FoType = DNType -- In due course we'll add subtype stuff
+ deriving (Eq) -- Used for equality instance for TyClDecl
+
+
+-- pretty printing of foreign declarations
+--
+
+instance OutputableBndr name => Outputable (ForeignDecl name) where
+ ppr (ForeignImport n ty fimport _ _) =
+ ptext SLIT("foreign import") <+> ppr fimport <+>
+ ppr n <+> dcolon <+> ppr ty
+ ppr (ForeignExport n ty fexport _ _) =
+ ptext SLIT("foreign export") <+> ppr fexport <+>
+ ppr n <+> dcolon <+> ppr ty
+
+instance Outputable ForeignImport where
+ ppr (DNImport spec) =
+ ptext SLIT("dotnet") <+> ppr spec
+ ppr (CImport cconv safety header lib spec) =
+ ppr cconv <+> ppr safety <+>
+ char '"' <> pprCEntity header lib spec <> char '"'
+ where
+ pprCEntity header lib (CLabel lbl) =
+ ptext SLIT("static") <+> ftext header <+> char '&' <>
+ pprLib lib <> ppr lbl
+ pprCEntity header lib (CFunction (StaticTarget lbl)) =
+ ptext SLIT("static") <+> ftext header <+> char '&' <>
+ pprLib lib <> ppr lbl
+ pprCEntity header lib (CFunction (DynamicTarget)) =
+ ptext SLIT("dynamic")
+ pprCEntity header lib (CFunction (CasmTarget _)) =
+ panic "HsDecls.pprCEntity: malformed C function target"
+ pprCEntity _ _ (CWrapper) = ptext SLIT("wrapper")
+ --
+ pprLib lib | nullFastString lib = empty
+ | otherwise = char '[' <> ppr lib <> char ']'
+
+instance Outputable ForeignExport where
+ ppr (CExport (CExportStatic lbl cconv)) =
+ ppr cconv <+> char '"' <> ppr lbl <> char '"'
+ ppr (DNExport ) =
+ ptext SLIT("dotnet") <+> ptext SLIT("\"<unused>\"")
+
+instance Outputable FoType where
+ ppr DNType = ptext SLIT("type dotnet")
\end{code}
+
%************************************************************************
%* *
-\subsection{Signatures in interface files}
+\subsection{Transformation rules}
%* *
%************************************************************************
\begin{code}
-data IfaceSig name
- = IfaceSig name
+data RuleDecl name
+ = HsRule -- Source rule
+ RuleName -- Rule name
+ Activation
+ [RuleBndr name] -- Forall'd vars; after typechecking this includes tyvars
+ (HsExpr name) -- LHS
+ (HsExpr name) -- RHS
+ SrcLoc
+
+ | IfaceRule -- One that's come in from an interface file; pre-typecheck
+ RuleName
+ Activation
+ [UfBinder name] -- Tyvars and term vars
+ name -- Head of lhs
+ [UfExpr name] -- Args of LHS
+ (UfExpr name) -- Pre typecheck
+ SrcLoc
+
+ | IfaceRuleOut -- Post typecheck
+ name -- Head of LHS
+ CoreRule
+
+isSrcRule (HsRule _ _ _ _ _ _) = True
+isSrcRule other = False
+
+ifaceRuleDeclName :: RuleDecl name -> name
+ifaceRuleDeclName (IfaceRule _ _ _ n _ _ _) = n
+ifaceRuleDeclName (IfaceRuleOut n r) = n
+ifaceRuleDeclName (HsRule fs _ _ _ _ _) = pprPanic "ifaceRuleDeclName" (ppr fs)
+
+data RuleBndr name
+ = RuleBndr name
+ | RuleBndrSig name (HsType name)
+
+collectRuleBndrSigTys :: [RuleBndr name] -> [HsType name]
+collectRuleBndrSigTys bndrs = [ty | RuleBndrSig _ ty <- bndrs]
+
+instance (NamedThing name, Ord name) => Eq (RuleDecl name) where
+ -- Works for IfaceRules only; used when comparing interface file versions
+ (IfaceRule n1 a1 bs1 f1 es1 rhs1 _) == (IfaceRule n2 a2 bs2 f2 es2 rhs2 _)
+ = n1==n2 && f1 == f2 && a1==a2 &&
+ eq_ufBinders emptyEqHsEnv bs1 bs2 (\env ->
+ eqListBy (eq_ufExpr env) (rhs1:es1) (rhs2:es2))
+
+instance OutputableBndr name => Outputable (RuleDecl name) where
+ ppr (HsRule name act ns lhs rhs loc)
+ = sep [text "{-# RULES" <+> doubleQuotes (ftext name) <+> ppr act,
+ pp_forall, pprExpr lhs, equals <+> pprExpr rhs,
+ text "#-}" ]
+ where
+ pp_forall | null ns = empty
+ | otherwise = text "forall" <+> fsep (map ppr ns) <> dot
+
+ ppr (IfaceRule name act tpl_vars fn tpl_args rhs loc)
+ = hsep [ doubleQuotes (ftext name), ppr act,
+ ptext SLIT("__forall") <+> braces (interppSP tpl_vars),
+ ppr fn <+> sep (map (pprUfExpr parens) tpl_args),
+ ptext SLIT("=") <+> ppr rhs
+ ] <+> semi
+
+ ppr (IfaceRuleOut fn rule) = pprCoreRule (ppr fn) rule
+
+instance OutputableBndr name => Outputable (RuleBndr name) where
+ ppr (RuleBndr name) = ppr name
+ ppr (RuleBndrSig name ty) = ppr name <> dcolon <> ppr ty
+\end{code}
+
+
+%************************************************************************
+%* *
+\subsection[DeprecDecl]{Deprecations}
+%* *
+%************************************************************************
+
+We use exported entities for things to deprecate.
+
+\begin{code}
+data DeprecDecl name = Deprecation name DeprecTxt SrcLoc
+
+type DeprecTxt = FastString -- reason/explanation for deprecation
+
+instance OutputableBndr name => Outputable (DeprecDecl name) where
+ ppr (Deprecation thing txt _)
+ = hsep [text "{-# DEPRECATED", ppr thing, doubleQuotes (ppr txt), text "#-}"]
+\end{code}
+
+
+%************************************************************************
+%* *
+ External-core declarations
+%* *
+%************************************************************************
+
+\begin{code}
+data CoreDecl name -- a Core value binding (from 'external Core' input)
+ = CoreDecl name
(HsType name)
- [HsIdInfo name]
+ (UfExpr name)
SrcLoc
-
-instance (NamedThing name, Outputable name) => Outputable (IfaceSig name) where
- ppr sty (IfaceSig var ty _ _)
- = hang (hsep [ppr sty var, ptext SLIT("::")])
- 4 (ppr sty ty)
-
-data HsIdInfo name
- = HsArity ArityInfo
- | HsStrictness (HsStrictnessInfo name)
- | HsUnfold Bool (UfExpr name) -- True <=> INLINE pragma
- | HsUpdate UpdateInfo
- | HsDeforest DeforestInfo
- | HsArgUsage ArgUsageInfo
- | HsFBType FBTypeInfo
- -- ToDo: specialisations
-
-data HsStrictnessInfo name
- = HsStrictnessInfo [Demand]
- (Maybe (name, [name])) -- Worker, if any
- -- and needed constructors
- | HsBottom
+
+instance OutputableBndr name => Outputable (CoreDecl name) where
+ ppr (CoreDecl var ty rhs loc)
+ = getPprStyle $ \ sty ->
+ hsep [ pprHsVar var, dcolon, ppr ty, ppr rhs ]
\end{code}
projects / ghc-hetmet.git / blobdiff