X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2FhsSyn%2FHsDecls.lhs;h=3a610024a35beb222102eb33d60697775c9a52eb;hb=423d477bfecd490de1449c59325c8776f91d7aac;hp=486a1889beb680a6e46019180eef03fbeb195f11;hpb=fa44695e06cf83d8bcef2c826cb6b39d6ffc49c0;p=ghc-hetmet.git diff --git a/ghc/compiler/hsSyn/HsDecls.lhs b/ghc/compiler/hsSyn/HsDecls.lhs index 486a188..3a61002 100644 --- a/ghc/compiler/hsSyn/HsDecls.lhs +++ b/ghc/compiler/hsSyn/HsDecls.lhs @@ -1,36 +1,54 @@ % -% (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(..), LHsDecl, TyClDecl(..), LTyClDecl, + InstDecl(..), LInstDecl, NewOrData(..), + RuleDecl(..), LRuleDecl, RuleBndr(..), + DefaultDecl(..), LDefaultDecl, HsGroup(..), SpliceDecl(..), + ForeignDecl(..), LForeignDecl, ForeignImport(..), ForeignExport(..), + CImportSpec(..), FoType(..), + ConDecl(..), LConDecl, + LBangType, BangType(..), HsBang(..), + getBangType, getBangStrictness, unbangedType, + DeprecDecl(..), LDeprecDecl, + tcdName, tyClDeclNames, tyClDeclTyVars, + isClassDecl, isSynDecl, isDataDecl, + countTyClDecls, + conDetailsTys, + collectRuleBndrSigTys, + ) 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 ( HsBindGroup, HsBind, LHsBinds, + Sig(..), LSig, LFixitySig, pprLHsBinds ) +import HsPat ( HsConDetails(..), hsConArgs ) +import HsImpExp ( pprHsVar ) import HsTypes -import IdInfo -import SpecEnv ( SpecEnv ) -import HsCore ( UfExpr ) +import HscTypes ( DeprecTxt ) +import CoreSyn ( RuleName ) +import BasicTypes ( Activation(..) ) +import ForeignCall ( CCallTarget(..), DNCallSpec, CCallConv, Safety, + CExportSpec(..), CLabelString ) -- others: -import Name ( pprSym, pprNonSym, getOccName, OccName ) -import Outputable ( interppSP, interpp'SP, - Outputable(..){-instance * []-} - ) -import Pretty -import SrcLoc ( SrcLoc ) -import PprStyle ( PprStyle(..) ) +import FunDeps ( pprFundeps ) +import Class ( FunDep ) +import Outputable +import Util ( count ) +import SrcLoc ( Located(..), unLoc ) +import FastString \end{code} @@ -41,164 +59,391 @@ import PprStyle ( PprStyle(..) ) %************************************************************************ \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) -\end{code} - -\begin{code} -hsDeclName (TyD (TyData _ name _ _ _ _ _)) = name -hsDeclName (TyD (TyNew _ name _ _ _ _ _)) = name -hsDeclName (TyD (TySynonym name _ _ _)) = name -hsDeclName (ClD (ClassDecl _ name _ _ _ _ _)) = name -hsDeclName (SigD (IfaceSig name _ _ _)) = name --- Others don't make sense +type LHsDecl id = Located (HsDecl id) + +data HsDecl id + = TyClD (TyClDecl id) + | InstD (InstDecl id) + | ValD (HsBind id) + | SigD (Sig id) + | DefD (DefaultDecl id) + | ForD (ForeignDecl id) + | DeprecD (DeprecDecl id) + | RuleD (RuleDecl id) + | SpliceD (SpliceDecl id) + +-- 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 :: [HsBindGroup id], + -- Before the renamer, this is a single big HsBindGroup, + -- with all the bindings, and all the signatures. + -- The renamer does dependency analysis, splitting it up + -- into several HsBindGroups. + + hs_tyclds :: [LTyClDecl id], + hs_instds :: [LInstDecl id], + + hs_fixds :: [LFixitySig id], + -- Snaffled out of both top-level fixity signatures, + -- and those in class declarations + + hs_defds :: [LDefaultDecl id], + hs_fords :: [LForeignDecl id], + hs_depds :: [LDeprecDecl id], + hs_ruleds :: [LRuleDecl id] + } \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 +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 (SpliceD dd) = ppr dd + +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 }) + = 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] + where + ppr_ds [] = empty + ppr_ds ds = text "" $$ vcat (map ppr ds) + +data SpliceDecl id = SpliceDecl (Located (HsExpr id)) -- Top level splice + +instance OutputableBndr name => Outputable (SpliceDecl name) where + ppr (SpliceDecl e) = ptext SLIT("$") <> parens (pprExpr (unLoc e)) \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 :: + op2 :: + 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 = :: -- NB the '=' + op2 :: + 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} + +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) = ppSep [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 + +type LTyClDecl name = Located (TyClDecl name) + +data TyClDecl name + = ForeignType { + tcdLName :: Located name, + tcdExtName :: Maybe FastString, + tcdFoType :: FoType + } + + | TyData { tcdND :: NewOrData, + tcdCtxt :: LHsContext name, -- Context + tcdLName :: Located name, -- Type constructor + tcdTyVars :: [LHsTyVarBndr name], -- Type variables + tcdCons :: [LConDecl name], -- Data constructors + tcdDerivs :: Maybe [LHsType name] + -- Derivings; Nothing => not specified + -- Just [] => derive exactly what is asked + -- These "types" must be of form + -- forall ab. C ty1 ty2 + -- Typically the foralls and ty args are empty, but they + -- are non-empty for the newtype-deriving case + } + + | TySynonym { tcdLName :: Located name, -- type constructor + tcdTyVars :: [LHsTyVarBndr name], -- type variables + tcdSynRhs :: LHsType name -- synonym expansion + } + + | ClassDecl { tcdCtxt :: LHsContext name, -- Context... + tcdLName :: Located name, -- Name of the class + tcdTyVars :: [LHsTyVarBndr name], -- Class type variables + tcdFDs :: [Located (FunDep name)], -- Functional deps + tcdSigs :: [LSig name], -- Methods' signatures + tcdMeths :: LHsBinds name -- Default methods + } + +data NewOrData + = NewType -- "newtype Blah ..." + | DataType -- "data Blah ..." + deriving( Eq ) -- Needed because Demand derives Eq \end{code} -It's convenient to keep the source location in the @Fixity@; it makes error reporting -in the renamer easier. +Simple classifiers \begin{code} -data Fixity = Fixity Int FixityDirection -data FixityDirection = InfixL | InfixR | InfixN - deriving(Eq) +isDataDecl, isSynDecl, isClassDecl :: TyClDecl name -> Bool -instance Outputable Fixity where - ppr sty (Fixity prec dir) = ppBesides [ppr sty dir, ppSP, ppInt prec] +isSynDecl (TySynonym {}) = True +isSynDecl other = False -instance Outputable FixityDirection where - ppr sty InfixL = ppStr "infixl" - ppr sty InfixR = ppStr "infixr" - ppr sty InfixN = ppStr "infix" +isDataDecl (TyData {}) = True +isDataDecl other = False -instance Eq Fixity where -- Used to determine if two fixities conflict - (Fixity p1 dir1) == (Fixity p2 dir2) = p1==p2 && dir1 == dir2 +isClassDecl (ClassDecl {}) = True +isClassDecl other = False \end{code} - -%************************************************************************ -%* * -\subsection[TyDecl]{@data@, @newtype@ or @type@ (synonym) type declaration} -%* * -%************************************************************************ +Dealing with names \begin{code} -data TyDecl name - = TyData (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 => as you would - -- expect... - (DataPragmas name) - SrcLoc - - | TyNew (Context name) -- context - name -- type constructor - [HsTyVar name] -- type variables - (ConDecl name) -- data constructor - (Maybe [name]) -- derivings; as above - (DataPragmas name) - SrcLoc - - | TySynonym name -- type constructor - [HsTyVar name] -- type variables - (HsType name) -- synonym expansion - SrcLoc +tcdName :: TyClDecl name -> name +tcdName decl = unLoc (tcdLName decl) + +tyClDeclNames :: Eq name => TyClDecl name -> [Located name] +-- 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 {tcdLName = name}) = [name] +tyClDeclNames (ForeignType {tcdLName = name}) = [name] + +tyClDeclNames (ClassDecl {tcdLName = cls_name, tcdSigs = sigs}) + = cls_name : [n | L _ (Sig n _) <- sigs] + +tyClDeclNames (TyData {tcdLName = tc_name, tcdCons = cons}) + = tc_name : conDeclsNames (map unLoc cons) + +tyClDeclTyVars (TySynonym {tcdTyVars = tvs}) = tvs +tyClDeclTyVars (TyData {tcdTyVars = tvs}) = tvs +tyClDeclTyVars (ClassDecl {tcdTyVars = tvs}) = tvs +tyClDeclTyVars (ForeignType {}) = [] \end{code} \begin{code} -instance (NamedThing name, Outputable name) - => Outputable (TyDecl name) where +countTyClDecls :: [TyClDecl name] -> (Int, Int, Int, Int) + -- class, data, newtype, synonym decls +countTyClDecls decls + = (count isClassDecl decls, + count isSynDecl decls, + count isDataTy decls, + count isNewTy decls) + where + isDataTy TyData{tcdND=DataType} = True + isDataTy _ = False + + isNewTy TyData{tcdND=NewType} = True + isNewTy _ = False +\end{code} - ppr sty (TySynonym tycon tyvars mono_ty src_loc) - = ppHang (pp_decl_head sty SLIT("type") ppNil tycon tyvars) - 4 (ppr sty mono_ty) +\begin{code} +instance OutputableBndr name + => Outputable (TyClDecl name) where - ppr sty (TyData context tycon tyvars condecls derivings pragmas src_loc) - = pp_tydecl sty - (pp_decl_head sty SLIT("data") (pp_context_and_arrow sty context) tycon tyvars) - (pp_condecls sty condecls) - derivings + ppr (ForeignType {tcdLName = ltycon}) + = hsep [ptext SLIT("foreign import type dotnet"), ppr ltycon] + + ppr (TySynonym {tcdLName = ltycon, tcdTyVars = tyvars, tcdSynRhs = mono_ty}) + = hang (ptext SLIT("type") <+> pp_decl_head [] ltycon tyvars <+> equals) + 4 (ppr mono_ty) - ppr sty (TyNew context tycon tyvars condecl derivings pragmas src_loc) - = pp_tydecl sty - (pp_decl_head sty SLIT("newtype") (pp_context_and_arrow sty context) tycon tyvars) - (ppr sty condecl) + ppr (TyData {tcdND = new_or_data, tcdCtxt = context, tcdLName = ltycon, + tcdTyVars = tyvars, tcdCons = condecls, + tcdDerivs = derivings}) + = pp_tydecl (ppr new_or_data <+> pp_decl_head (unLoc context) ltycon tyvars) + (pp_condecls condecls) derivings -pp_decl_head sty str pp_context tycon tyvars - = ppCat [ppPStr str, pp_context, ppr sty (getOccName tycon), - interppSP sty tyvars, ppPStr SLIT("=")] + ppr (ClassDecl {tcdCtxt = context, tcdLName = lclas, tcdTyVars = tyvars, tcdFDs = fds, + tcdSigs = sigs, tcdMeths = methods}) + | null sigs -- No "where" part + = top_matter -pp_condecls sty [] = ppNil -- Curious! -pp_condecls sty (c:cs) - = ppSep (ppr sty c : map (\ c -> ppBeside (ppStr "| ") (ppr sty c)) cs) + | otherwise -- Laid out + = sep [hsep [top_matter, ptext SLIT("where {")], + nest 4 (sep [sep (map ppr_sig sigs), ppr methods, char '}'])] + where + top_matter = ptext SLIT("class") <+> pp_decl_head (unLoc context) lclas tyvars <+> pprFundeps (map unLoc fds) + ppr_sig sig = ppr sig <> semi -pp_tydecl sty pp_head pp_decl_rhs derivings - = ppHang pp_head 4 (ppSep [ +pp_decl_head :: OutputableBndr name + => HsContext name + -> Located name + -> [LHsTyVarBndr name] + -> SDoc +pp_decl_head context thing tyvars + = hsep [pprHsContext context, ppr thing, interppSP tyvars] + +pp_condecls 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,_) -> ppNil - (_,PprInterface) -> ppNil -- No derivings in interfaces - (Just ds,_) -> ppCat [ppPStr SLIT("deriving"), ppParens (interpp'SP sty ds)] + case derivings of + Nothing -> empty + Just ds -> hsep [ptext SLIT("deriving"), parens (interpp'SP ds)] ]) -pp_context_and_arrow :: Outputable name => PprStyle -> Context name -> Pretty -pp_context_and_arrow sty [] = ppNil -pp_context_and_arrow sty theta = ppCat [pprContext sty theta, ppPStr SLIT("=>")] +instance Outputable NewOrData where + ppr NewType = ptext SLIT("newtype") + ppr DataType = ptext SLIT("data") \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 _) - = ppCat [ppStr "{-# SPECIALIZE data", ppr sty ty, ppStr "#-}"] -\end{code} %************************************************************************ %* * @@ -207,148 +452,107 @@ instance (NamedThing name, Outputable name) %************************************************************************ \begin{code} +type LConDecl name = Located (ConDecl name) + data ConDecl name - = ConDecl name -- prefix-style con decl - [BangType name] - SrcLoc - - | ConOpDecl (BangType name) -- infix-style con decl - name - (BangType name) - SrcLoc - - | RecConDecl name - [([name], BangType name)] -- list of "fields" - SrcLoc - - | NewConDecl name -- newtype con decl - (HsType name) - SrcLoc - -data BangType name - = Banged (HsType name) -- HsType: to allow Haskell extensions - | Unbanged (HsType name) -- (MonoType only needed for straight Haskell) -\end{code} + = ConDecl (Located name) -- Constructor name; this is used for the + -- DataCon itself, and for the user-callable wrapper Id -\begin{code} -instance (NamedThing name, Outputable name) => Outputable (ConDecl name) where - - ppr sty (ConDecl con tys _) - = ppCat [ppr sty (getOccName con), ppInterleave ppNil (map (ppr_bang sty) tys)] - - -- We print ConOpDecls in prefix form in interface files - ppr PprInterface (ConOpDecl ty1 op ty2 _) - = ppCat [ppr PprInterface (getOccName op), ppr_bang PprInterface ty1, ppr_bang PprInterface ty2] - ppr sty (ConOpDecl ty1 op ty2 _) - = ppCat [ppr_bang sty ty1, ppr sty (getOccName op), ppr_bang sty ty2] - - ppr sty (NewConDecl con ty _) - = ppCat [ppr sty (getOccName con), pprParendHsType sty ty] - ppr sty (RecConDecl con fields _) - = ppCat [ppr sty (getOccName con), - ppCurlies (ppInterleave pp'SP (map pp_field fields)) - ] - where - pp_field (ns, ty) = ppCat [ppCat (map (ppr sty . getOccName) ns), - ppPStr SLIT("::"), ppr_bang sty ty] + [LHsTyVarBndr name] -- Existentially quantified type variables + (LHsContext name) -- ...and context + -- If both are empty then there are no existentials -ppr_bang sty (Banged ty) = ppBeside (ppChar '!') (pprParendHsType sty ty) -ppr_bang sty (Unbanged ty) = pprParendHsType sty ty + (HsConDetails name (LBangType name)) \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 +conDeclsNames :: Eq name => [ConDecl name] -> [Located name] + -- 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 ([], []) cons) + where + do_one (flds_seen, acc) (ConDecl lname _ _ (RecCon flds)) + = (map unLoc new_flds ++ flds_seen, lname : [f | f <- new_flds] ++ acc) + where + new_flds = [ f | (f,_) <- flds, not (unLoc f `elem` flds_seen) ] + + do_one (flds_seen, acc) (ConDecl lname _ _ _) + = (flds_seen, lname:acc) + +conDetailsTys details = map getBangType (hsConArgs details) \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 +type LBangType name = Located (BangType name) - ppr sty (ClassDecl context clas tyvar sigs methods pragmas src_loc) - | null sigs -- No "where" part - = top_matter +data BangType name = BangType HsBang (LHsType name) - | iface_style -- All on one line (for now at least) - = ppCat [top_matter, ppStr "where", - ppCurlies (ppInterleave (ppPStr SLIT("; ")) pp_sigs)] +data HsBang = HsNoBang + | HsStrict -- ! + | HsUnbox -- {-# UNPACK #-} ! (GHC extension, meaning "unbox") - | otherwise -- Laid out - = ppSep [ppCat [top_matter, ppStr "where {"], - ppNest 4 ((ppIntersperse ppSemi pp_sigs `ppAbove` pp_methods) - `ppBeside` ppStr "}")] - where - top_matter = ppCat [ppStr "class", pp_context_and_arrow sty context, - ppr sty (getOccName clas), ppr sty tyvar] - pp_sigs = map (ppr sty) sigs - pp_methods = ppr sty methods - iface_style = case sty of {PprInterface -> True; other -> False} +getBangType (BangType _ ty) = ty +getBangStrictness (BangType s _) = s + +unbangedType :: LHsType id -> LBangType id +unbangedType ty@(L loc _) = L loc (BangType HsNoBang ty) \end{code} +\begin{code} +instance (OutputableBndr name) => Outputable (ConDecl name) where + ppr (ConDecl con tvs cxt con_details) + = sep [pprHsForAll Explicit tvs cxt, ppr_con_details con con_details] + +ppr_con_details con (InfixCon ty1 ty2) + = hsep [ppr ty1, ppr con, ppr 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 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 ty + +instance OutputableBndr name => Outputable (BangType name) where + ppr (BangType is_strict ty) + = bang <> pprParendHsType (unLoc ty) + where + bang = case is_strict of + HsNoBang -> empty + HsStrict -> char '!' + HsUnbox -> ptext SLIT("!!") +\end{code} + + %************************************************************************ %* * -\subsection[InstDecl]{An instance declaration (also, @SpecInstSig@)} +\subsection[InstDecl]{An instance declaration %* * %************************************************************************ \begin{code} -data InstDecl tyvar uvar name pat - = InstDecl (HsType name) -- Context => Class Instance-type +type LInstDecl name = Located (InstDecl name) + +data InstDecl name + = InstDecl (LHsType name) -- Context => Class Instance-type -- Using a polytype means that the renamer conveniently -- figures out the quantified type variables for us. + (LHsBinds name) + [LSig name] -- User-supplied pragmatic info - (MonoBinds tyvar uvar name pat) +instance (OutputableBndr name) => Outputable (InstDecl name) where - [Sig name] -- User-supplied pragmatic info - - (Maybe name) -- Name for the dictionary function - - 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 - = ppCat [ppStr "instance", ppr sty inst_ty] - - | otherwise - = ppAboves [ppCat [ppStr "instance", ppr sty inst_ty, ppStr "where"], - ppNest 4 (ppr sty uprags), - ppNest 4 (ppr sty 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 - (HsType 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 "#-}"] + ppr (InstDecl inst_ty binds uprags) + = vcat [hsep [ptext SLIT("instance"), ppr inst_ty, ptext SLIT("where")], + nest 4 (ppr uprags), + nest 4 (pprLHsBinds binds) ] \end{code} %************************************************************************ @@ -362,42 +566,179 @@ for the parser to check that; we pass them all through in the abstract syntax, and that restriction must be checked in the front end. \begin{code} +type LDefaultDecl name = Located (DefaultDecl name) + data DefaultDecl name - = DefaultDecl [HsType name] - SrcLoc + = DefaultDecl [LHsType name] -instance (NamedThing name, Outputable name) +instance (OutputableBndr name) => Outputable (DefaultDecl name) where - ppr sty (DefaultDecl tys src_loc) - = ppBeside (ppPStr SLIT("default ")) (ppParens (interpp'SP sty tys)) + ppr (DefaultDecl tys) + = ptext SLIT("default") <+> parens (interpp'SP tys) \end{code} %************************************************************************ %* * -\subsection{Signatures in interface files} +\subsection{Foreign function interface declaration} %* * %************************************************************************ \begin{code} -data IfaceSig name - = IfaceSig name - (HsType name) - [HsIdInfo name] - SrcLoc - -instance (NamedThing name, Outputable name) => Outputable (IfaceSig name) where - ppr sty (IfaceSig var ty _ _) - = ppHang (ppCat [ppr sty (getOccName var), ppPStr SLIT("::")]) - 4 (ppr sty ty) - -data HsIdInfo name - = HsArity ArityInfo - | HsStrictness (StrictnessInfo name) - | HsUnfold (UfExpr name) - | HsUpdate UpdateInfo - | HsDeforest DeforestInfo - | HsArgUsage ArgUsageInfo - | HsFBType FBTypeInfo - -- ToDo: specialisations + +-- 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 +-- +type LForeignDecl name = Located (ForeignDecl name) + +data ForeignDecl name + = ForeignImport (Located name) (LHsType name) ForeignImport Bool -- defines name + | ForeignExport (Located name) (LHsType name) ForeignExport Bool -- uses name + +-- 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 _ _ (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("\"\"") + +instance Outputable FoType where + ppr DNType = ptext SLIT("type dotnet") +\end{code} + + +%************************************************************************ +%* * +\subsection{Transformation rules} +%* * +%************************************************************************ + +\begin{code} +type LRuleDecl name = Located (RuleDecl name) + +data RuleDecl name + = HsRule -- Source rule + RuleName -- Rule name + Activation + [RuleBndr name] -- Forall'd vars; after typechecking this includes tyvars + (Located (HsExpr name)) -- LHS + (Located (HsExpr name)) -- RHS + +data RuleBndr name + = RuleBndr (Located name) + | RuleBndrSig (Located name) (LHsType name) + +collectRuleBndrSigTys :: [RuleBndr name] -> [LHsType name] +collectRuleBndrSigTys bndrs = [ty | RuleBndrSig _ ty <- bndrs] + +instance OutputableBndr name => Outputable (RuleDecl name) where + ppr (HsRule name act ns lhs rhs) + = sep [text "{-# RULES" <+> doubleQuotes (ftext name) <+> ppr act, + nest 4 (pp_forall <+> pprExpr (unLoc lhs)), + nest 4 (equals <+> pprExpr (unLoc rhs) <+> text "#-}") ] + where + pp_forall | null ns = empty + | otherwise = text "forall" <+> fsep (map ppr ns) <> dot + +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} +type LDeprecDecl name = Located (DeprecDecl name) + +data DeprecDecl name = Deprecation name DeprecTxt + +instance OutputableBndr name => Outputable (DeprecDecl name) where + ppr (Deprecation thing txt) + = hsep [text "{-# DEPRECATED", ppr thing, doubleQuotes (ppr txt), text "#-}"] \end{code}