%
+% (c) The University of Glasgow 2006
% (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
%
-\section[HsImpExp]{Abstract syntax: imports, exports, interfaces}
+
+HsImpExp: Abstract syntax: imports, exports, interfaces
\begin{code}
+{-# LANGUAGE DeriveDataTypeable #-}
+
module HsImpExp where
-#include "HsVersions.h"
+import Module ( ModuleName )
+import HsDoc ( HsDocString )
-import Module ( Module )
import Outputable
import FastString
import SrcLoc ( Located(..) )
-import Char ( isAlpha )
+
+import Data.Data
\end{code}
%************************************************************************
\begin{code}
type LImportDecl name = Located (ImportDecl name)
+-- | A single Haskell @import@ declaration.
data ImportDecl name
- = ImportDecl (Located Module) -- module name
- Bool -- True <=> {-# SOURCE #-} import
- Bool -- True => qualified
- (Maybe Module) -- as Module
- (Maybe (Bool, [LIE name])) -- (True => hiding, names)
+ = ImportDecl {
+ ideclName :: Located ModuleName, -- ^ Module name.
+ ideclPkgQual :: Maybe FastString, -- ^ Package qualifier.
+ ideclSource :: Bool, -- ^ True <=> {-# SOURCE #-} import
+ ideclQualified :: Bool, -- ^ True => qualified
+ ideclAs :: Maybe ModuleName, -- ^ as Module
+ ideclHiding :: Maybe (Bool, [LIE name]) -- ^ (True => hiding, names)
+ } deriving (Data, Typeable)
\end{code}
\begin{code}
instance (Outputable name) => Outputable (ImportDecl name) where
- ppr (ImportDecl mod from qual as spec)
- = hang (hsep [ptext SLIT("import"), ppr_imp from,
- pp_qual qual, ppr mod, pp_as as])
+ ppr (ImportDecl mod pkg from qual as spec)
+ = hang (hsep [ptext (sLit "import"), ppr_imp from,
+ pp_qual qual, pp_pkg pkg, ppr mod, pp_as as])
4 (pp_spec spec)
where
+ pp_pkg Nothing = empty
+ pp_pkg (Just p) = doubleQuotes (ftext p)
+
pp_qual False = empty
- pp_qual True = ptext SLIT("qualified")
+ pp_qual True = ptext (sLit "qualified")
pp_as Nothing = empty
- pp_as (Just a) = ptext SLIT("as ") <+> ppr a
+ pp_as (Just a) = ptext (sLit "as") <+> ppr a
- ppr_imp True = ptext SLIT("{-# SOURCE #-}")
+ ppr_imp True = ptext (sLit "{-# SOURCE #-}")
ppr_imp False = empty
- pp_spec Nothing = empty
- pp_spec (Just (False, spec))
- = parens (interpp'SP spec)
- pp_spec (Just (True, spec))
- = ptext SLIT("hiding") <+> parens (interpp'SP spec)
+ pp_spec Nothing = empty
+ pp_spec (Just (False, ies)) = ppr_ies ies
+ pp_spec (Just (True, ies)) = ptext (sLit "hiding") <+> ppr_ies ies
-ideclName (ImportDecl mod_nm _ _ _ _) = mod_nm
+ ppr_ies [] = ptext (sLit "()")
+ ppr_ies ies = char '(' <+> interpp'SP ies <+> char ')'
\end{code}
%************************************************************************
\begin{code}
type LIE name = Located (IE name)
+-- | Imported or exported entity.
data IE name
- = IEVar name
- | IEThingAbs name -- Class/Type (can't tell)
- | IEThingAll name -- Class/Type plus all methods/constructors
- | IEThingWith name [name] -- Class/Type plus some methods/constructors
- | IEModuleContents Module -- (Export Only)
+ = IEVar name
+ | IEThingAbs name -- ^ Class/Type (can't tell)
+ | IEThingAll name -- ^ Class/Type plus all methods/constructors
+ | IEThingWith name [name] -- ^ Class/Type plus some methods/constructors
+ | IEModuleContents ModuleName -- ^ (Export Only)
+ | IEGroup Int HsDocString -- ^ Doc section heading
+ | IEDoc HsDocString -- ^ Some documentation
+ | IEDocNamed String -- ^ Reference to named doc
+ deriving (Data, Typeable)
\end{code}
\begin{code}
ieName (IEThingAbs n) = n
ieName (IEThingWith n _) = n
ieName (IEThingAll n) = n
+ieName _ = panic "ieName failed pattern match!"
ieNames :: IE a -> [a]
ieNames (IEVar n ) = [n]
ieNames (IEThingAll n ) = [n]
ieNames (IEThingWith n ns) = n:ns
ieNames (IEModuleContents _ ) = []
+ieNames (IEGroup _ _ ) = []
+ieNames (IEDoc _ ) = []
+ieNames (IEDocNamed _ ) = []
\end{code}
\begin{code}
ppr (IEThingAll thing) = hcat [ppr thing, text "(..)"]
ppr (IEThingWith thing withs)
= ppr thing <> parens (fsep (punctuate comma (map pprHsVar withs)))
- ppr (IEModuleContents mod)
- = ptext SLIT("module") <+> ppr mod
+ ppr (IEModuleContents mod')
+ = ptext (sLit "module") <+> ppr mod'
+ ppr (IEGroup n _) = text ("<IEGroup: " ++ (show n) ++ ">")
+ ppr (IEDoc doc) = ppr doc
+ ppr (IEDocNamed string) = text ("<IEDocNamed: " ++ string ++ ">")
\end{code}
-\begin{code}
-pprHsVar :: Outputable name => name -> SDoc
-pprHsVar v | isOperator ppr_v = parens ppr_v
- | otherwise = ppr_v
- where
- ppr_v = ppr v
-
-isOperator :: SDoc -> Bool
-isOperator ppr_v
- = case showSDocUnqual ppr_v of
- ('(':s) -> False -- (), (,) etc
- ('[':s) -> False -- []
- ('$':c:s) -> not (isAlpha c) -- Don't treat $d as an operator
- (':':c:s) -> not (isAlpha c) -- Don't treat :T as an operator
- ('_':s) -> False -- Not an operator
- (c:s) -> not (isAlpha c) -- Starts with non-alpha
- other -> False
- -- We use (showSDoc (ppr v)), rather than isSymOcc (getOccName v) simply so
- -- that we don't need NamedThing in the context of all these functions.
- -- Gruesome, but simple.
-\end{code}
projects / ghc-hetmet.git / blobdiff