[project @ 1998-01-08 18:03:08 by simonm]
[ghc-hetmet.git] / ghc / compiler / hsSyn / HsDecls.lhs
index 1e1cc3e..f466d59 100644 (file)
@@ -7,11 +7,9 @@ Definitions for: @FixityDecl@, @TyDecl@ and @ConDecl@, @ClassDecl@,
 @InstDecl@, @DefaultDecl@.
 
 \begin{code}
-#include "HsVersions.h"
-
 module HsDecls where
 
-IMP_Ubiq()
+#include "HsVersions.h"
 
 -- friends:
 import HsBinds         ( HsBinds, MonoBinds, Sig, nullMonoBinds )
@@ -19,18 +17,16 @@ import HsPragmas    ( DataPragmas, ClassPragmas,
                          InstancePragmas, ClassOpPragmas
                        )
 import HsTypes
-import IdInfo
-import SpecEnv         ( SpecEnv )
 import HsCore          ( UfExpr )
+import BasicTypes      ( Fixity, NewOrData(..) )
+import IdInfo          ( ArgUsageInfo, FBTypeInfo, ArityInfo, UpdateInfo )
+import Demand          ( Demand )
 
 -- others:
-import Name            ( pprSym, pprNonSym, getOccName, OccName )
-import Outputable      ( interppSP, interpp'SP,
-                         Outputable(..){-instance * []-}
-                       )
-import Pretty
+import Name            ( getOccName, OccName, NamedThing(..) )
+import Outputable      
 import SrcLoc          ( SrcLoc )
-import PprStyle                ( PprStyle(..) )
+import Util
 \end{code}
 
 
@@ -41,35 +37,58 @@ import PprStyle             ( PprStyle(..) )
 %************************************************************************
 
 \begin{code}
-data HsDecl tyvar uvar name pat
+data HsDecl flexi name pat
   = TyD                (TyDecl name)
-  | ClD                (ClassDecl tyvar uvar name pat)
-  | InstD      (InstDecl  tyvar uvar name pat)
+  | ClD                (ClassDecl flexi name pat)
+  | InstD      (InstDecl  flexi name pat)
   | DefD       (DefaultDecl name)
-  | ValD       (HsBinds tyvar uvar name pat)
+  | ValD       (HsBinds flexi 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
+#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
 -- 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 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 (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
+
+#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}
 
 
@@ -83,27 +102,7 @@ instance (NamedThing name, Outputable name, Outputable pat,
 data FixityDecl name  = FixityDecl name Fixity SrcLoc
 
 instance Outputable name => Outputable (FixityDecl name) where
-  ppr sty (FixityDecl name fixity loc) = ppSep [ppr sty fixity, ppr sty name]
-\end{code}
-
-It's convenient to keep the source location in the @Fixity@; it makes error reporting
-in the renamer easier.
-
-\begin{code}
-data Fixity = Fixity Int FixityDirection
-data FixityDirection = InfixL | InfixR | InfixN 
-                    deriving(Eq)
-
-instance Outputable Fixity where
-    ppr sty (Fixity prec dir) = ppBesides [ppr sty dir, ppSP, ppInt prec]
-
-instance Outputable FixityDirection where
-    ppr sty InfixL = ppStr "infixl"
-    ppr sty InfixR = ppStr "infixr"
-    ppr sty InfixN = ppStr "infix"
-
-instance Eq Fixity where               -- Used to determine if two fixities conflict
-  (Fixity p1 dir1) == (Fixity p2 dir2) = p1==p2 && dir1 == dir2
+  ppr (FixityDecl name fixity loc) = sep [ppr fixity, ppr name]
 \end{code}
 
 
@@ -115,7 +114,8 @@ instance Eq Fixity where            -- Used to determine if two fixities conflict
 
 \begin{code}
 data TyDecl name
-  = TyData     (Context name)  -- context
+  = TyData     NewOrData
+               (Context name)  -- context
                name            -- type constructor
                [HsTyVar name]  -- type variables
                [ConDecl name]  -- data constructors (empty if abstract)
@@ -126,14 +126,6 @@ data TyDecl name
                (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
@@ -145,42 +137,39 @@ data TyDecl name
 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 (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") (pp_context_and_arrow 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") (pp_context_and_arrow sty context) tycon tyvars)
-                 (ppr 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 (getOccName tycon), 
-          interppSP sty tyvars, ppPStr SLIT("=")]
+pp_decl_head str pp_context tycon tyvars
+  = hsep [ptext str, pp_context, ppr tycon,
+          interppSP tyvars, ptext SLIT("=")]
 
-pp_condecls sty [] = ppNil             -- Curious!
-pp_condecls sty (c:cs)
-  = ppSep (ppr sty c : map (\ c -> ppBeside (ppStr "| ") (ppr sty c)) 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, 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("=>")]
+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.
@@ -196,8 +185,8 @@ data SpecDataSig name
 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}
 
 %************************************************************************
@@ -208,22 +197,24 @@ instance (NamedThing name, Outputable name)
 
 \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
+  | NewCon                     -- newtype con decl
                (HsType name)
-               SrcLoc
 
 data BangType name
   = Banged   (HsType name)     -- HsType: to allow Haskell extensions
@@ -232,27 +223,27 @@ data BangType name
 
 \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 [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 (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_bang sty (Banged   ty) = ppBeside (ppChar '!') (pprParendHsType sty ty)
-ppr_bang sty (Unbanged ty) = pprParendHsType sty ty
+ppr_con_details con (NewCon ty)
+  = ppr con <+> pprParendHsType 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}
 
 %************************************************************************
@@ -262,39 +253,35 @@ ppr_bang sty (Unbanged ty) = pprParendHsType sty ty
 %************************************************************************
 
 \begin{code}
-data ClassDecl tyvar uvar name pat
+data ClassDecl flexi name pat
   = ClassDecl  (Context name)                  -- context...
                name                            -- name of the class
-               (HsTyVar 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
+instance (NamedThing name, Outputable name, Outputable pat)
+               => Outputable (ClassDecl flexi name pat) where
 
-    ppr sty (ClassDecl context clas tyvar sigs methods pragmas src_loc)
+    ppr (ClassDecl context clas tyvars sigs methods pragmas _ _ src_loc)
       | null sigs      -- No "where" part
       = top_matter
 
-      | iface_style    -- All on one line (for now at least)
-      = ppCat [top_matter, ppStr "where", 
-              ppCurlies (ppInterleave (ppPStr SLIT("; ")) pp_sigs)]
-
       | otherwise      -- Laid out
-      = ppSep [ppCat [top_matter, ppStr "where {"],
-              ppNest 4 ((ppIntersperse ppSemi pp_sigs `ppAbove` pp_methods)
-                        `ppBeside` ppStr "}")]
+      = sep [hsep [top_matter, ptext SLIT("where {")],
+              nest 4 (vcat [sep (map ppr_sig sigs),
+                                  ppr methods,
+                                  char '}'])]
       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}
+        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}
 
 %************************************************************************
@@ -304,12 +291,12 @@ instance (NamedThing name, Outputable name, Outputable pat,
 %************************************************************************
 
 \begin{code}
-data InstDecl tyvar uvar name pat
+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)
 
                [Sig name]              -- User-supplied pragmatic info
 
@@ -319,19 +306,17 @@ data InstDecl tyvar uvar name pat
 \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) ]
+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
+          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;
@@ -346,8 +331,8 @@ data SpecInstSig name
 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 (SpecInstSig clas ty _)
+      = hsep [text "{-# SPECIALIZE instance", ppr clas, ppr ty, text "#-}"]
 \end{code}
 
 %************************************************************************
@@ -368,8 +353,8 @@ data DefaultDecl name
 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}
 
 %************************************************************************
@@ -386,17 +371,22 @@ data IfaceSig 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)
+    ppr (IfaceSig var ty _ _)
+      = hang (hsep [ppr var, ptext SLIT("::")])
+            4 (ppr ty)
 
 data HsIdInfo name
   = HsArity            ArityInfo
-  | HsStrictness       (StrictnessInfo name)
-  | HsUnfold           (UfExpr name)
+  | 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
 \end{code}