--- /dev/null
+%
+% (c) The GRASP/AQUA Project, Glasgow University, 1993-1995
+%
+%************************************************************************
+%* *
+\section[HsPragmas]{Pragmas in Haskell interface files}
+%* *
+%************************************************************************
+
+See also: @Sig@ (``signatures'') which is where user-supplied pragmas
+for values show up; ditto @SpecialisedInstanceSig@ (for instances) and
+@DataTypeSig@ (for data types and type synonyms).
+
+\begin{code}
+#include "HsVersions.h"
+
+module HsPragmas where
+
+import HsCore ( UnfoldingCoreExpr, UfCostCentre )
+import HsDecls ( ConDecl )
+import HsTypes ( MonoType, PolyType )
+import IdInfo
+import Maybes ( Maybe(..) )
+import Name ( Name )
+import Outputable -- class for printing, forcing
+import Pretty -- pretty-printing utilities
+import ProtoName ( ProtoName(..) ) -- .. is for pragmas only
+import Util
+\end{code}
+
+Certain pragmas expect to be pinned onto certain constructs.
+
+Pragma types may be parameterised, just as with any other
+abstract-syntax type.
+
+For a @data@ declaration---makes visible the constructors for an
+abstract @data@ type and indicates which specialisations exist.
+\begin{code}
+data DataPragmas name
+ = DataPragmas [ConDecl name] -- hidden data constructors
+ [[Maybe (MonoType name)]] -- types to which speciaised
+
+type ProtoNameDataPragmas = DataPragmas ProtoName
+type RenamedDataPragmas = DataPragmas Name
+\end{code}
+
+For a @type@ declaration---declare that it should be treated as
+``abstract'' (flag any use of its expansion as an error):
+\begin{code}
+data TypePragmas
+ = NoTypePragmas
+ | AbstractTySynonym
+\end{code}
+
+These are {\em general} things you can know about any value:
+\begin{code}
+data GenPragmas name
+ = NoGenPragmas
+ | GenPragmas (Maybe Int) -- arity (maybe)
+ (Maybe UpdateInfo) -- update info (maybe)
+ DeforestInfo -- deforest info
+ (ImpStrictness name) -- strictness, worker-wrapper
+ (ImpUnfolding name) -- unfolding (maybe)
+ [([Maybe (MonoType name)], -- Specialisations: types to which spec'd;
+ Int, -- # dicts to ignore
+ GenPragmas name)] -- Gen info about the spec'd version
+
+type ProtoNameGenPragmas = GenPragmas ProtoName
+type RenamedGenPragmas = GenPragmas Name
+
+data ImpUnfolding name
+ = NoImpUnfolding
+ | ImpMagicUnfolding FAST_STRING -- magic "unfolding"
+ -- known to the compiler by "String"
+ | ImpUnfolding UnfoldingGuidance -- always, if you like, etc.
+ (UnfoldingCoreExpr name)
+
+type ProtoNameUnfoldingCoreExpr = UnfoldingCoreExpr ProtoName
+
+data ImpStrictness name
+ = NoImpStrictness
+ | ImpStrictness Bool -- True <=> bottoming Id
+ [Demand] -- demand info
+ (GenPragmas name) -- about the *worker*
+
+type RenamedImpStrictness = ImpStrictness Name
+\end{code}
+
+For an ordinary imported function: it can have general pragmas (only).
+
+For a class's super-class dictionary selectors:
+\begin{code}
+data ClassPragmas name
+ = NoClassPragmas
+ | SuperDictPragmas [GenPragmas name] -- list mustn't be empty
+
+type ProtoNameClassPragmas = ClassPragmas ProtoName
+type RenamedClassPragmas = ClassPragmas Name
+\end{code}
+
+For a class's method selectors:
+\begin{code}
+data ClassOpPragmas name
+ = NoClassOpPragmas
+ | ClassOpPragmas (GenPragmas name) -- for method selector
+ (GenPragmas name) -- for default method
+
+type ProtoNameClassOpPragmas = ClassOpPragmas ProtoName
+type RenamedClassOpPragmas = ClassOpPragmas Name
+\end{code}
+
+\begin{code}
+data InstancePragmas name
+ = NoInstancePragmas
+
+ | SimpleInstancePragma -- nothing but for the dfun itself...
+ (GenPragmas name)
+
+ | ConstantInstancePragma
+ (GenPragmas name) -- for the "dfun" itself
+ [(name, GenPragmas name)] -- one per class op
+
+ | SpecialisedInstancePragma
+ (GenPragmas name) -- for its "dfun"
+ [([Maybe (MonoType name)], -- specialised instance; type...
+ Int, -- #dicts to ignore
+ InstancePragmas name)] -- (no SpecialisedInstancePragma please!)
+
+type ProtoNameInstancePragmas = InstancePragmas ProtoName
+type RenamedInstancePragmas = InstancePragmas Name
+\end{code}
+
+Some instances for printing (just for debugging, really)
+\begin{code}
+instance Outputable name => Outputable (ClassPragmas name) where
+ ppr sty NoClassPragmas = ppNil
+ ppr sty (SuperDictPragmas sdsel_prags)
+ = ppAbove (ppStr "{-superdict pragmas-}")
+ (ppr sty sdsel_prags)
+
+instance Outputable name => Outputable (ClassOpPragmas name) where
+ ppr sty NoClassOpPragmas = ppNil
+ ppr sty (ClassOpPragmas op_prags defm_prags)
+ = ppAbove (ppCat [ppStr "{-meth-}", ppr sty op_prags])
+ (ppCat [ppStr "{-defm-}", ppr sty defm_prags])
+
+instance Outputable name => Outputable (InstancePragmas name) where
+ ppr sty NoInstancePragmas = ppNil
+ ppr sty (SimpleInstancePragma dfun_pragmas)
+ = ppCat [ppStr "{-dfun-}", ppr sty dfun_pragmas]
+ ppr sty (ConstantInstancePragma dfun_pragmas name_pragma_pairs)
+ = ppAbove (ppCat [ppStr "{-constm-}", ppr sty dfun_pragmas])
+ (ppAboves (map pp_pair name_pragma_pairs))
+ where
+ pp_pair (n, prags)
+ = ppCat [ppr sty n, ppEquals, ppr sty prags]
+
+ ppr sty (SpecialisedInstancePragma dfun_pragmas spec_pragma_info)
+ = ppAbove (ppCat [ppStr "{-spec'd-}", ppr sty dfun_pragmas])
+ (ppAboves (map pp_info spec_pragma_info))
+ where
+ pp_info (ty_maybes, num_dicts, prags)
+ = ppBesides [ppLbrack, ppInterleave ppSP (map pp_ty ty_maybes), ppRbrack,
+ ppLparen, ppInt num_dicts, ppRparen, ppEquals, ppr sty prags]
+ pp_ty Nothing = ppStr "_N_"
+ pp_ty (Just t)= ppr sty t
+
+instance Outputable name => Outputable (GenPragmas name) where
+ ppr sty NoGenPragmas = ppNil
+ ppr sty (GenPragmas arity_maybe upd_maybe def strictness unfolding specs)
+ = ppCat [pp_arity arity_maybe, pp_upd upd_maybe, -- ToDo: print def?
+ pp_str strictness, pp_unf unfolding,
+ pp_specs specs]
+ where
+ pp_arity Nothing = ppNil
+ pp_arity (Just i) = ppBeside (ppStr "ARITY=") (ppInt i)
+
+ pp_upd Nothing = ppNil
+ pp_upd (Just u) = ppInfo sty id u
+
+ pp_str NoImpStrictness = ppNil
+ pp_str (ImpStrictness is_bot demands wrkr_prags)
+ = ppBesides [ppStr "IS_BOT=", ppr sty is_bot,
+ ppStr "STRICTNESS=", ppStr (showList demands ""),
+ ppStr " {", ppr sty wrkr_prags, ppStr "}"]
+
+ pp_unf NoImpUnfolding = ppStr "NO_UNFOLDING"
+ pp_unf (ImpMagicUnfolding m) = ppBeside (ppStr "MAGIC=") (ppPStr m)
+ pp_unf (ImpUnfolding g core) = ppBeside (ppStr "UNFOLD=") (ppr sty core)
+
+ pp_specs [] = ppNil
+ pp_specs specs
+ = ppBesides [ppStr "SPECS=[", ppInterleave ppSP (map pp_spec specs), ppStr "]"]
+ where
+ pp_spec (ty_maybes, num_dicts, gprags)
+ = ppCat [ppLbrack, ppInterleave ppSP (map pp_MaB ty_maybes), ppRbrack, ppInt num_dicts, ppr sty gprags]
+
+ pp_MaB Nothing = ppStr "_N_"
+ pp_MaB (Just x) = ppr sty x
+\end{code}
projects / ghc-hetmet.git / blobdiff