#include "HsVersions.h"
module Name (
- Module(..),
-
- RdrName(..),
- isUnqual,
- isQual,
- isRdrLexCon,
- appendRdr,
- showRdr,
- cmpRdr,
-
- Name,
- Provenance,
- mkLocalName, isLocalName,
- mkTopLevName, mkImportedName,
- mkImplicitName, isImplicitName,
- mkBuiltinName, mkCompoundName,
-
- mkFunTyConName, mkTupleDataConName, mkTupleTyConName,
- mkTupNameStr,
-
- NamedThing(..), -- class
- ExportFlag(..),
- isExported{-overloaded-}, exportFlagOn{-not-},
-
- nameUnique,
- nameOccName,
- nameOrigName,
- nameExportFlag,
- nameSrcLoc,
- nameImpLocs,
- nameImportFlag,
+ -- Re-export the Module type
+ SYN_IE(Module),
+ pprModule, moduleString,
+
+ -- The OccName type
+ OccName(..),
+ pprOccName, occNameString, occNameFlavour,
+ isTvOcc, isTCOcc, isVarOcc, prefixOccName,
+ quoteInText, parenInCode,
+
+ -- The Name type
+ Name, -- Abstract
+ mkLocalName, mkSysLocalName,
+
+ mkCompoundName, mkGlobalName, mkInstDeclName,
+
+ mkWiredInIdName, mkWiredInTyConName,
+ maybeWiredInIdName, maybeWiredInTyConName,
+ isWiredInName,
+
+ nameUnique, changeUnique, setNameProvenance, getNameProvenance,
+ setNameVisibility,
+ nameOccName, nameString, nameModule,
+
+ isExportedName, nameSrcLoc,
isLocallyDefinedName,
- isPreludeDefinedName,
- origName, moduleOf, nameOf, moduleNamePair,
- getOccName, getExportFlag,
- getSrcLoc, getImpLocs,
- isLocallyDefined, isPreludeDefined,
- getLocalName, ltLexical,
+ isLocalName,
+
+ pprNameProvenance,
- isSymLexeme, pprSym, pprNonSym,
- isLexCon, isLexVar, isLexId, isLexSym, isLexSpecialSym,
- isLexConId, isLexConSym, isLexVarId, isLexVarSym
+ -- Sets of Names
+ SYN_IE(NameSet),
+ emptyNameSet, unitNameSet, mkNameSet, unionNameSets, unionManyNameSets,
+ minusNameSet, elemNameSet, nameSetToList, addOneToNameSet, addListToNameSet, isEmptyNameSet,
+
+ -- Misc
+ DefnInfo(..),
+ Provenance(..), pprProvenance,
+ ExportFlag(..),
+
+ -- Class NamedThing and overloaded friends
+ NamedThing(..),
+ modAndOcc, isExported,
+ getSrcLoc, isLocallyDefined, getOccString
) where
-import Ubiq
+IMP_Ubiq()
+#if defined(__GLASGOW_HASKELL__) && __GLASGOW_HASKELL__ <= 201
+IMPORT_DELOOPER(TyLoop) ( GenId, Id(..), TyCon ) -- Used inside Names
+#else
+import {-# SOURCE #-} Id ( Id )
+import {-# SOURCE #-} TyCon ( TyCon )
+#endif
+
+import CStrings ( identToC, modnameToC, cSEP )
+import CmdLineOpts ( opt_OmitInterfacePragmas, opt_EnsureSplittableC )
+import BasicTypes ( SYN_IE(Module), moduleString, pprModule )
-import CStrings ( identToC, cSEP )
-import Outputable ( Outputable(..) )
-import PprStyle ( PprStyle(..), codeStyle )
-import PrelMods ( pRELUDE, pRELUDE_BUILTIN, fromPrelude )
+import Outputable ( Outputable(..), PprStyle(..), codeStyle, ifaceStyle )
+import PrelMods ( gHC__ )
import Pretty
-import SrcLoc ( mkBuiltinSrcLoc, mkUnknownSrcLoc )
-import Unique ( funTyConKey, mkTupleDataConUnique, mkTupleTyConUnique,
- pprUnique, Unique
- )
-import Util ( thenCmp, _CMP_STRING_, nOfThem, panic, assertPanic )
+import Lex ( isLexSym, isLexConId )
+import SrcLoc ( noSrcLoc, SrcLoc )
+import Usage ( SYN_IE(UVar), SYN_IE(Usage) )
+import Unique ( pprUnique, showUnique, Unique )
+import UniqSet ( UniqSet(..), emptyUniqSet, unitUniqSet, unionUniqSets, uniqSetToList, isEmptyUniqSet,
+ unionManyUniqSets, minusUniqSet, mkUniqSet, elementOfUniqSet, addListToUniqSet, addOneToUniqSet )
+import UniqFM ( UniqFM, SYN_IE(Uniquable) )
+import Util --( cmpPString, panic, assertPanic {-, pprTrace ToDo:rm-} )
+
\end{code}
+
%************************************************************************
%* *
-\subsection[RdrName]{The @RdrName@ datatype; names read from files}
+\subsection[Name-pieces-datatypes]{The @OccName@ datatypes}
%* *
%************************************************************************
\begin{code}
-type Module = FAST_STRING
-
-data RdrName
- = Unqual FAST_STRING
- | Qual Module FAST_STRING
-
-isUnqual (Unqual _) = True
-isUnqual (Qual _ _) = False
-
-isQual (Unqual _) = False
-isQual (Qual _ _) = True
-
-isRdrLexCon (Unqual n) = isLexCon n
-isRdrLexCon (Qual m n) = isLexCon n
-
-appendRdr (Unqual n) str = Unqual (n _APPEND_ str)
-appendRdr (Qual m n) str = ASSERT(not (fromPrelude m))
- Qual m (n _APPEND_ str)
-
-cmpRdr (Unqual n1) (Unqual n2) = _CMP_STRING_ n1 n2
-cmpRdr (Unqual n1) (Qual m2 n2) = LT_
-cmpRdr (Qual m1 n1) (Unqual n2) = GT_
-cmpRdr (Qual m1 n1) (Qual m2 n2) = thenCmp (_CMP_STRING_ m1 m2) (_CMP_STRING_ n1 n2)
-
-instance Eq RdrName where
+data OccName = VarOcc FAST_STRING -- Variables and data constructors
+ | TvOcc FAST_STRING -- Type variables
+ | TCOcc FAST_STRING -- Type constructors and classes
+
+pprOccName :: PprStyle -> OccName -> Doc
+pprOccName sty n = if codeStyle sty
+ then identToC (occNameString n)
+ else ptext (occNameString n)
+
+occNameString :: OccName -> FAST_STRING
+occNameString (VarOcc s) = s
+occNameString (TvOcc s) = s
+occNameString (TCOcc s) = s
+
+prefixOccName :: FAST_STRING -> OccName -> OccName
+prefixOccName prefix (VarOcc s) = VarOcc (prefix _APPEND_ s)
+prefixOccName prefix (TvOcc s) = TvOcc (prefix _APPEND_ s)
+prefixOccName prefix (TCOcc s) = TCOcc (prefix _APPEND_ s)
+
+-- occNameFlavour is used only to generate good error messages, so it doesn't matter
+-- that the VarOcc case isn't mega-efficient. We could have different Occ constructors for
+-- data constructors and values, but that makes everything else a bit more complicated.
+occNameFlavour :: OccName -> String
+occNameFlavour (VarOcc s) | isLexConId s = "Data constructor"
+ | otherwise = "Value"
+occNameFlavour (TvOcc s) = "Type variable"
+occNameFlavour (TCOcc s) = "Type constructor or class"
+
+isVarOcc, isTCOcc, isTvOcc :: OccName -> Bool
+isVarOcc (VarOcc s) = True
+isVarOcc other = False
+
+isTvOcc (TvOcc s) = True
+isTvOcc other = False
+
+isTCOcc (TCOcc s) = True
+isTCOcc other = False
+
+
+instance Eq OccName where
a == b = case (a `cmp` b) of { EQ_ -> True; _ -> False }
a /= b = case (a `cmp` b) of { EQ_ -> False; _ -> True }
-instance Ord RdrName where
+instance Ord OccName where
a <= b = case (a `cmp` b) of { LT_ -> True; EQ_ -> True; GT__ -> False }
a < b = case (a `cmp` b) of { LT_ -> True; EQ_ -> False; GT__ -> False }
a >= b = case (a `cmp` b) of { LT_ -> False; EQ_ -> True; GT__ -> True }
a > b = case (a `cmp` b) of { LT_ -> False; EQ_ -> False; GT__ -> True }
-instance Ord3 RdrName where
- cmp = cmpRdr
+instance Ord3 OccName where
+ cmp = cmpOcc
-instance NamedThing RdrName where
- -- We're sorta faking it here
- getName rdr_name
- = Global u rdr_name prov ex [rdr_name]
- where
- u = panic "NamedThing.RdrName:Unique"
- prov = panic "NamedThing.RdrName:Provenance"
- ex = panic "NamedThing.RdrName:ExportFlag"
+(VarOcc s1) `cmpOcc` (VarOcc s2) = s1 `_CMP_STRING_` s2
+(VarOcc s1) `cmpOcc` other2 = LT_
-instance Outputable RdrName where
- ppr sty (Unqual n) = pp_name sty n
- ppr sty (Qual m n) = ppBeside (pp_mod sty m) (pp_name sty n)
+(TvOcc s1) `cmpOcc` (VarOcc s2) = GT_
+(TvOcc s1) `cmpOcc` (TvOcc s2) = s1 `_CMP_STRING_` s2
+(TvOcc s1) `cmpOcc` other = LT_
-pp_mod PprForC m = ppBesides [identToC m, ppPStr cSEP]
-pp_mod (PprForAsm False _) m = ppBesides [identToC m, ppPStr cSEP]
-pp_mod (PprForAsm True _) m = ppBesides [ppPStr cSEP, identToC m, ppPStr cSEP]
-pp_mod _ m = ppBesides [ppPStr m, ppChar '.']
+(TCOcc s1) `cmpOcc` (TCOcc s2) = s1 `_CMP_STRING_` s2
+(TCOcc s1) `cmpOcc` other = GT_
+
+instance Outputable OccName where
+ ppr = pprOccName
+\end{code}
-pp_name sty n | codeStyle sty = identToC n
- | otherwise = ppPStr n
-showRdr sty rdr = ppShow 100 (ppr sty rdr)
+\begin{code}
+parenInCode, quoteInText :: OccName -> Bool
+parenInCode occ = isLexSym (occNameString occ)
+
+quoteInText occ = not (isLexSym (occNameString occ))
\end{code}
%************************************************************************
%* *
-\subsection[Name-datatype]{The @Name@ datatype}
+\subsection[Name-datatype]{The @Name@ datatype, and name construction}
%* *
%************************************************************************
-
+
\begin{code}
data Name
= Local Unique
- FAST_STRING
+ OccName
SrcLoc
| Global Unique
- RdrName -- original name; Unqual => prelude
- Provenance -- where it came from
- ExportFlag -- is it exported?
- [RdrName] -- ordered occurrence names (usually just one);
- -- first may be *un*qual.
+ Module -- The defining module
+ OccName -- Its name in that module
+ DefnInfo -- How it is defined
+ Provenance -- How it was brought into scope
+\end{code}
+
+Things with a @Global@ name are given C static labels, so they finally
+appear in the .o file's symbol table. They appear in the symbol table
+in the form M.n. If originally-local things have this property they
+must be made @Global@ first.
+
+\begin{code}
+data DefnInfo = VanillaDefn
+ | WiredInTyCon TyCon -- There's a wired-in version
+ | WiredInId Id -- ...ditto...
data Provenance
- = LocalDef SrcLoc -- locally defined; give its source location
+ = LocalDef ExportFlag SrcLoc -- Locally defined
+ | Imported Module SrcLoc -- Directly imported from M; gives locn of import statement
+ | Implicit -- Implicitly imported
+\end{code}
+
+Something is "Exported" if it may be mentioned by another module without
+warning. The crucial thing about Exported things is that they must
+never be dropped as dead code, even if they aren't used in this module.
+Furthermore, being Exported means that we can't see all call sites of the thing.
- | Imported ExportFlag -- how it was imported
- SrcLoc -- *original* source location
- [SrcLoc] -- any import source location(s)
+Exported things include:
+ - explicitly exported Ids, including data constructors, class method selectors
+ - dfuns from instance decls
- | Implicit
- | Builtin
+Being Exported is *not* the same as finally appearing in the .o file's
+symbol table. For example, a local Id may be mentioned in an Exported
+Id's unfolding in the interface file, in which case the local Id goes
+out too.
+
+\begin{code}
+data ExportFlag = Exported | NotExported
\end{code}
\begin{code}
+mkLocalName :: Unique -> OccName -> SrcLoc -> Name
mkLocalName = Local
-mkTopLevName u orig locn exp occs = Global u orig (LocalDef locn) exp occs
-mkImportedName u orig imp locn imp_locs exp occs = Global u orig (Imported imp locn imp_locs) exp occs
+mkGlobalName :: Unique -> Module -> OccName -> DefnInfo -> Provenance -> Name
+mkGlobalName = Global
+
+mkSysLocalName :: Unique -> FAST_STRING -> SrcLoc -> Name
+mkSysLocalName uniq str loc = Local uniq (VarOcc str) loc
+
+mkWiredInIdName :: Unique -> Module -> FAST_STRING -> Id -> Name
+mkWiredInIdName uniq mod occ id
+ = Global uniq mod (VarOcc occ) (WiredInId id) Implicit
+
+mkWiredInTyConName :: Unique -> Module -> FAST_STRING -> TyCon -> Name
+mkWiredInTyConName uniq mod occ tycon
+ = Global uniq mod (TCOcc occ) (WiredInTyCon tycon) Implicit
+
-mkImplicitName :: Unique -> RdrName -> Name
-mkImplicitName u o = Global u o Implicit NotExported []
+mkCompoundName :: (FAST_STRING -> FAST_STRING) -- Occurrence-name modifier
+ -> Unique -- New unique
+ -> Name -- Base name (must be a Global)
+ -> Name -- Result is always a value name
-mkBuiltinName :: Unique -> Module -> FAST_STRING -> Name
-mkBuiltinName u m n = Global u (Unqual n) Builtin NotExported []
+mkCompoundName str_fn uniq (Global _ mod occ defn prov)
+ = Global uniq mod new_occ defn prov
+ where
+ new_occ = VarOcc (str_fn (occNameString occ)) -- Always a VarOcc
-mkCompoundName :: Unique -> [FAST_STRING] -> Name
-mkCompoundName u ns
- = Global u (Unqual{-???-} (_CONCAT_ (dotify ns))) Builtin{--} NotExported []
+mkCompoundName str_fn uniq (Local _ occ loc)
+ = Local uniq (VarOcc (str_fn (occNameString occ))) loc
+
+ -- Rather a wierd one that's used for names generated for instance decls
+mkInstDeclName :: Unique -> Module -> OccName -> SrcLoc -> Bool -> Name
+mkInstDeclName uniq mod occ loc from_here
+ = Global uniq mod occ VanillaDefn prov
where
- dotify [] = []
- dotify [n] = [n]
- dotify (n:ns) = n : (map (_CONS_ '.') ns)
-
-mkFunTyConName
- = mkBuiltinName funTyConKey pRELUDE_BUILTIN SLIT("->")
-mkTupleDataConName arity
- = mkBuiltinName (mkTupleDataConUnique arity) pRELUDE_BUILTIN (mkTupNameStr arity)
-mkTupleTyConName arity
- = mkBuiltinName (mkTupleTyConUnique arity) pRELUDE_BUILTIN (mkTupNameStr arity)
-
-mkTupNameStr 0 = SLIT("()")
-mkTupNameStr 1 = panic "Name.mkTupNameStr: 1 ???"
-mkTupNameStr 2 = SLIT("(,)") -- not strictly necessary
-mkTupNameStr 3 = SLIT("(,,)") -- ditto
-mkTupNameStr 4 = SLIT("(,,,)") -- ditto
-mkTupNameStr n
- = _PK_ ("(" ++ nOfThem (n-1) ',' ++ ")")
-
- -- ToDo: what about module ???
- -- ToDo: exported when compiling builtin ???
+ prov | from_here = LocalDef Exported loc
+ | otherwise = Implicit
-isLocalName (Local _ _ _) = True
-isLocalName _ = False
-isImplicitName (Global _ _ Implicit _ _) = True
-isImplicitName _ = False
+setNameProvenance :: Name -> Provenance -> Name -- Implicit Globals only
+setNameProvenance (Global uniq mod occ def Implicit) prov = Global uniq mod occ def prov
+setNameProvenance other_name prov = other_name
+
+getNameProvenance :: Name -> Provenance
+getNameProvenance (Global uniq mod occ def prov) = prov
+getNameProvenance (Local uniq occ locn) = LocalDef NotExported locn
+
+-- When we renumber/rename things, we need to be
+-- able to change a Name's Unique to match the cached
+-- one in the thing it's the name of. If you know what I mean.
+changeUnique (Local _ n l) u = Local u n l
+changeUnique (Global _ mod occ def prov) u = Global u mod occ def prov
+
+setNameVisibility :: Module -> Name -> Name
+-- setNameVisibility is applied to top-level names in the final program
+-- The "visibility" here concerns whether the .o file's symbol table
+-- mentions the thing; if so, it needs a module name in its symbol,
+-- otherwise we just use its unique. The Global things are "visible"
+-- and the local ones are not
+
+setNameVisibility _ (Global uniq mod occ def (LocalDef NotExported loc))
+ | not all_toplev_ids_visible
+ = Local uniq occ loc
+
+setNameVisibility mod (Local uniq occ loc)
+ | all_toplev_ids_visible
+ = Global uniq mod
+ (VarOcc (showUnique uniq)) -- It's local name must be unique!
+ VanillaDefn (LocalDef NotExported loc)
+
+setNameVisibility mod name = name
+
+all_toplev_ids_visible = not opt_OmitInterfacePragmas || -- Pragmas can make them visible
+ opt_EnsureSplittableC -- Splitting requires visiblilty
-isBuiltinName (Global _ _ Builtin _ _) = True
-isBuiltinName _ = False
\end{code}
+%************************************************************************
+%* *
+\subsection{Predicates and selectors}
+%* *
+%************************************************************************
+
+\begin{code}
+nameUnique :: Name -> Unique
+nameModAndOcc :: Name -> (Module, OccName) -- Globals only
+nameOccName :: Name -> OccName
+nameModule :: Name -> Module
+nameString :: Name -> FAST_STRING -- A.b form
+nameSrcLoc :: Name -> SrcLoc
+isLocallyDefinedName :: Name -> Bool
+isExportedName :: Name -> Bool
+isWiredInName :: Name -> Bool
+isLocalName :: Name -> Bool
+
+
+
+nameUnique (Local u _ _) = u
+nameUnique (Global u _ _ _ _) = u
+
+nameOccName (Local _ occ _) = occ
+nameOccName (Global _ _ occ _ _) = occ
+
+nameModule (Global _ mod occ _ _) = mod
+
+nameModAndOcc (Global _ mod occ _ _) = (mod,occ)
+
+nameString (Local _ occ _) = occNameString occ
+nameString (Global _ mod occ _ _) = mod _APPEND_ SLIT(".") _APPEND_ occNameString occ
+
+isExportedName (Global _ _ _ _ (LocalDef Exported _)) = True
+isExportedName other = False
+
+nameSrcLoc (Local _ _ loc) = loc
+nameSrcLoc (Global _ _ _ _ (LocalDef _ loc)) = loc
+nameSrcLoc (Global _ _ _ _ (Imported _ loc)) = loc
+nameSrcLoc other = noSrcLoc
+
+isLocallyDefinedName (Local _ _ _) = True
+isLocallyDefinedName (Global _ _ _ _ (LocalDef _ _)) = True
+isLocallyDefinedName other = False
+
+-- Things the compiler "knows about" are in some sense
+-- "imported". When we are compiling the module where
+-- the entities are defined, we need to be able to pick
+-- them out, often in combination with isLocallyDefined.
+isWiredInName (Global _ _ _ (WiredInTyCon _) _) = True
+isWiredInName (Global _ _ _ (WiredInId _) _) = True
+isWiredInName _ = False
+
+maybeWiredInIdName :: Name -> Maybe Id
+maybeWiredInIdName (Global _ _ _ (WiredInId id) _) = Just id
+maybeWiredInIdName other = Nothing
+
+maybeWiredInTyConName :: Name -> Maybe TyCon
+maybeWiredInTyConName (Global _ _ _ (WiredInTyCon tc) _) = Just tc
+maybeWiredInTyConName other = Nothing
+
+
+isLocalName (Local _ _ _) = True
+isLocalName _ = False
+\end{code}
%************************************************************************
\begin{code}
cmpName n1 n2 = c n1 n2
where
- c (Local u1 _ _) (Local u2 _ _) = cmp u1 u2
- c (Global u1 _ _ _ _) (Global u2 _ _ _ _) = cmp u1 u2
-
- c other_1 other_2 -- the tags *must* be different
- = let tag1 = tag_Name n1
- tag2 = tag_Name n2
- in
- if tag1 _LT_ tag2 then LT_ else GT_
-
- tag_Name (Local _ _ _) = (ILIT(1) :: FAST_INT)
- tag_Name (Global _ _ _ _ _) = ILIT(2)
+ c (Local u1 _ _) (Local u2 _ _) = cmp u1 u2
+ c (Local _ _ _) _ = LT_
+ c (Global u1 _ _ _ _) (Global u2 _ _ _ _) = cmp u1 u2
+ c (Global _ _ _ _ _) _ = GT_
\end{code}
\begin{code}
getName n = n
\end{code}
-\begin{code}
-nameUnique (Local u _ _) = u
-nameUnique (Global u _ _ _ _) = u
-
-nameOrigName (Local _ n _) = Unqual n
-nameOrigName (Global _ orig _ _ _) = orig
-
-nameModuleNamePair (Local _ n _) = (panic "nameModuleNamePair", n)
-nameModuleNamePair (Global _ (Unqual n) _ _ _) = (pRELUDE, n)
-nameModuleNamePair (Global _ (Qual m n) _ _ _) = (m, n)
-
-nameOccName (Local _ n _) = Unqual n
-nameOccName (Global _ orig _ _ [] ) = orig
-nameOccName (Global _ orig _ _ occs) = head occs
-nameExportFlag (Local _ _ _) = NotExported
-nameExportFlag (Global _ _ _ exp _) = exp
-nameSrcLoc (Local _ _ loc) = loc
-nameSrcLoc (Global _ _ (LocalDef loc) _ _) = loc
-nameSrcLoc (Global _ _ (Imported _ loc _) _ _) = loc
-nameSrcLoc (Global _ _ Implicit _ _) = mkUnknownSrcLoc
-nameSrcLoc (Global _ _ Builtin _ _) = mkBuiltinSrcLoc
-
-nameImpLocs (Global _ _ (Imported _ _ locs) _ _) = locs
-nameImpLocs _ = []
-
-nameImportFlag (Local _ _ _) = NotExported
-nameImportFlag (Global _ _ (LocalDef _) _ _) = ExportAll
-nameImportFlag (Global _ _ (Imported exp _ _) _ _) = exp
-nameImportFlag (Global _ _ Implicit _ _) = ExportAll
-nameImportFlag (Global _ _ Builtin _ _) = ExportAll
-
-isLocallyDefinedName (Local _ _ _) = True
-isLocallyDefinedName (Global _ _ (LocalDef _) _ _) = True
-isLocallyDefinedName (Global _ _ (Imported _ _ _) _ _) = False
-isLocallyDefinedName (Global _ _ Implicit _ _) = False
-isLocallyDefinedName (Global _ _ Builtin _ _) = False
-
-isPreludeDefinedName (Local _ n _) = False
-isPreludeDefinedName (Global _ orig _ _ _) = isUnqual orig
-\end{code}
+%************************************************************************
+%* *
+\subsection{Pretty printing}
+%* *
+%************************************************************************
\begin{code}
instance Outputable Name where
-#ifdef DEBUG
- ppr PprDebug (Local u n _) = pp_debug u (ppPStr n)
- ppr PprDebug (Global u o _ _ _) = pp_debug u (ppr PprDebug o)
-#endif
- ppr sty (Local u n _) = pp_name sty n
- ppr PprForUser (Global u o _ _ [] ) = ppr PprForUser o
- ppr PprForUser (Global u o _ _ occs) = ppr PprForUser (head occs)
- ppr PprShowAll (Global u o prov exp occs) = pp_all o prov exp occs
- ppr sty (Global u o _ _ _) = ppr sty o
-
-pp_debug uniq thing
- = ppBesides [thing, ppStr "{-", pprUnique uniq, ppStr "-}" ]
-
-pp_all orig prov exp occs
- = ppBesides [ppr PprShowAll orig, ppr PprShowAll occs, pp_prov prov, pp_exp exp]
-
-pp_exp NotExported = ppNil
-pp_exp ExportAll = ppPStr SLIT("/EXP(..)")
-pp_exp ExportAbs = ppPStr SLIT("/EXP")
-
-pp_prov Implicit = ppPStr SLIT("/IMPLICIT")
-pp_prov Builtin = ppPStr SLIT("/BUILTIN")
-pp_prov _ = ppNil
+ ppr PprQuote name@(Local _ _ _) = quotes (ppr (PprForUser 1) name)
+ ppr (PprForUser _) (Local _ n _) = ptext (occNameString n)
+
+ ppr sty (Local u n _) | codeStyle sty ||
+ ifaceStyle sty = pprUnique u
+
+ ppr sty (Local u n _) = hcat [ptext (occNameString n), ptext SLIT("_"), pprUnique u]
+
+ ppr PprQuote name@(Global _ _ _ _ _) = quotes (ppr (PprForUser 1) name)
+
+ ppr sty name@(Global u m n _ _)
+ | codeStyle sty
+ = identToC (m _APPEND_ SLIT(".") _APPEND_ occNameString n)
+
+ ppr sty name@(Global u m n _ prov)
+ = hcat [pp_mod, ptext (occNameString n), pp_debug sty name]
+ where
+ pp_mod = case prov of --- Omit home module qualifier
+ LocalDef _ _ -> empty
+ other -> pprModule (PprForUser 1) m <> char '.'
+
+
+pp_debug PprDebug (Global uniq m n _ prov) = hcat [text "{-", pprUnique uniq, char ',',
+ pp_prov prov, text "-}"]
+ where
+ pp_prov (LocalDef Exported _) = char 'x'
+ pp_prov (LocalDef NotExported _) = char 'l'
+ pp_prov (Imported _ _) = char 'i'
+ pp_prov Implicit = char 'p'
+pp_debug other name = empty
+
+-- pprNameProvenance is used in error messages to say where a name came from
+pprNameProvenance :: PprStyle -> Name -> Doc
+pprNameProvenance sty (Local _ _ loc) = pprProvenance sty (LocalDef NotExported loc)
+pprNameProvenance sty (Global _ _ _ _ prov) = pprProvenance sty prov
+
+pprProvenance :: PprStyle -> Provenance -> Doc
+pprProvenance sty (Imported mod loc)
+ = sep [ptext SLIT("Imported from"), pprModule sty mod, ptext SLIT("at"), ppr sty loc]
+pprProvenance sty (LocalDef _ loc)
+ = sep [ptext SLIT("Defined at"), ppr sty loc]
+pprProvenance sty Implicit
+ = panic "pprNameProvenance: Implicit"
\end{code}
+
%************************************************************************
%* *
-\subsection[ExportFlag-datatype]{The @ExportFlag@ datatype}
+\subsection[Sets of names}
%* *
%************************************************************************
-The export flag @ExportAll@ means `export all there is', so there are
-times when it is attached to a class or data type which has no
-ops/constructors (if the class/type was imported abstractly). In
-fact, @ExportAll@ is attached to everything except to classes/types
-which are being {\em exported} abstractly, regardless of how they were
-imported.
-
\begin{code}
-data ExportFlag
- = ExportAll -- export with all constructors/methods
- | ExportAbs -- export abstractly (tycons/classes only)
- | NotExported
+type NameSet = UniqSet Name
+emptyNameSet :: NameSet
+unitNameSet :: Name -> NameSet
+addListToNameSet :: NameSet -> [Name] -> NameSet
+addOneToNameSet :: NameSet -> Name -> NameSet
+mkNameSet :: [Name] -> NameSet
+unionNameSets :: NameSet -> NameSet -> NameSet
+unionManyNameSets :: [NameSet] -> NameSet
+minusNameSet :: NameSet -> NameSet -> NameSet
+elemNameSet :: Name -> NameSet -> Bool
+nameSetToList :: NameSet -> [Name]
+isEmptyNameSet :: NameSet -> Bool
+
+isEmptyNameSet = isEmptyUniqSet
+emptyNameSet = emptyUniqSet
+unitNameSet = unitUniqSet
+mkNameSet = mkUniqSet
+addListToNameSet = addListToUniqSet
+addOneToNameSet = addOneToUniqSet
+unionNameSets = unionUniqSets
+unionManyNameSets = unionManyUniqSets
+minusNameSet = minusUniqSet
+elemNameSet = elementOfUniqSet
+nameSetToList = uniqSetToList
+\end{code}
-exportFlagOn NotExported = False
-exportFlagOn _ = True
-isExported a = exportFlagOn (getExportFlag a)
-
-#ifdef USE_ATTACK_PRAGMAS
-{-# SPECIALIZE isExported :: Class -> Bool #-}
-{-# SPECIALIZE isExported :: Id -> Bool #-}
-{-# SPECIALIZE isExported :: TyCon -> Bool #-}
-#endif
-\end{code}
%************************************************************************
%* *
\begin{code}
class NamedThing a where
- getName :: a -> Name
+ getOccName :: a -> OccName -- Even RdrNames can do this!
+ getName :: a -> Name
+
+ getOccName n = nameOccName (getName n) -- Default method
\end{code}
\begin{code}
-origName :: NamedThing a => a -> RdrName
-moduleOf :: RdrName -> Module
-nameOf :: RdrName -> FAST_STRING
-moduleNamePair :: NamedThing a => a -> (Module, FAST_STRING)
-
-getOccName :: NamedThing a => a -> RdrName
-getLocalName :: NamedThing a => a -> FAST_STRING
-getExportFlag :: NamedThing a => a -> ExportFlag
+modAndOcc :: NamedThing a => a -> (Module, OccName)
+getModule :: NamedThing a => a -> Module
getSrcLoc :: NamedThing a => a -> SrcLoc
-getImpLocs :: NamedThing a => a -> [SrcLoc]
isLocallyDefined :: NamedThing a => a -> Bool
-isPreludeDefined :: NamedThing a => a -> Bool
-
--- ToDo: specialise for RdrNames?
-origName = nameOrigName . getName
-moduleNamePair = nameModuleNamePair . getName
+isExported :: NamedThing a => a -> Bool
+getOccString :: NamedThing a => a -> String
-moduleOf (Unqual n) = pRELUDE
-moduleOf (Qual m n) = m
-
-nameOf (Unqual n) = n
-nameOf (Qual m n) = n
-
-getLocalName = nameOf . origName
-
-getOccName = nameOccName . getName
-getExportFlag = nameExportFlag . getName
+modAndOcc = nameModAndOcc . getName
+getModule = nameModule . getName
+isExported = isExportedName . getName
getSrcLoc = nameSrcLoc . getName
-getImpLocs = nameImpLocs . getName
isLocallyDefined = isLocallyDefinedName . getName
-isPreludeDefined = isPreludeDefinedName . getName
-\end{code}
-
-@ltLexical@ is used for sorting things into lexicographical order, so
-as to canonicalize interfaces. [Regular @(<)@ should be used for fast
-comparison.]
-
-\begin{code}
-a `ltLexical` b = origName a < origName b
-
-#ifdef USE_ATTACK_PRAGMAS
-{-# SPECIALIZE ltLexical :: Class -> Class -> Bool #-}
-{-# SPECIALIZE ltLexical :: Id -> Id -> Bool #-}
-{-# SPECIALIZE ltLexical :: TyCon -> TyCon -> Bool #-}
-#endif
-\end{code}
-
-These functions test strings to see if they fit the lexical categories
-defined in the Haskell report. Normally applied as in e.g. @isCon
-(getLocalName foo)@.
-
-\begin{code}
-isLexCon, isLexVar, isLexId, isLexSym, isLexConId, isLexConSym,
- isLexVarId, isLexVarSym, isLexSpecialSym :: FAST_STRING -> Bool
-
-isLexCon cs = isLexConId cs || isLexConSym cs
-isLexVar cs = isLexVarId cs || isLexVarSym cs
-
-isLexId cs = isLexConId cs || isLexVarId cs
-isLexSym cs = isLexConSym cs || isLexVarSym cs
-
--------------
-
-isLexConId cs
- | _NULL_ cs = False
- | c == '_' = isLexConId (_TAIL_ cs) -- allow for leading _'s
- | otherwise = isUpper c || isUpperISO c
- where
- c = _HEAD_ cs
-
-isLexVarId cs
- | _NULL_ cs = False
- | c == '_' = isLexVarId (_TAIL_ cs) -- allow for leading _'s
- | otherwise = isLower c || isLowerISO c
- where
- c = _HEAD_ cs
-
-isLexConSym cs
- | _NULL_ cs = False
- | otherwise = c == ':'
--- || c == '(' -- (), (,), (,,), ...
- || cs == SLIT("->")
--- || cs == SLIT("[]")
- where
- c = _HEAD_ cs
-
-isLexVarSym cs
- | _NULL_ cs = False
- | otherwise = isSymbolASCII c
- || isSymbolISO c
--- || c == '(' -- (), (,), (,,), ...
--- || cs == SLIT("[]")
- where
- c = _HEAD_ cs
-
-isLexSpecialSym cs
- | _NULL_ cs = False
- | otherwise = c == '(' -- (), (,), (,,), ...
- || cs == SLIT("[]")
- where
- c = _HEAD_ cs
-
--------------
-isSymbolASCII c = c `elem` "!#$%&*+./<=>?@\\^|~-"
-isSymbolISO c = ord c `elem` (0xd7 : 0xf7 : [0xa1 .. 0xbf])
-isUpperISO c = 0xc0 <= oc && oc <= 0xde && oc /= 0xd7 where oc = ord c
-isLowerISO c = 0xdf <= oc && oc <= 0xff && oc /= 0xf7 where oc = ord c
+getOccString x = _UNPK_ (occNameString (getOccName x))
\end{code}
-And one ``higher-level'' interface to those:
-
\begin{code}
-isSymLexeme :: NamedThing a => a -> Bool
-
-isSymLexeme v
- = let str = nameOf (origName v) in isLexSym str
-
--- print `vars`, (op) correctly
-pprSym, pprNonSym :: (NamedThing name, Outputable name) => PprStyle -> name -> Pretty
-
-pprSym sty var
- = let
- str = nameOf (origName var)
- in
- if isLexSym str && not (isLexSpecialSym str)
- then ppr sty var
- else ppBesides [ppChar '`', ppr sty var, ppChar '`']
-
-pprNonSym sty var
- = if isSymLexeme var
- then ppParens (ppr sty var)
- else ppr sty var
-
-#ifdef USE_ATTACK_PRAGMAS
-{-# SPECIALIZE isSymLexeme :: Id -> Bool #-}
-{-# SPECIALIZE pprNonSym :: PprStyle -> Id -> Pretty #-}
-{-# SPECIALIZE pprNonSym :: PprStyle -> TyCon -> Pretty #-}
-{-# SPECIALIZE pprSym :: PprStyle -> Id -> Pretty #-}
-#endif
+{-# SPECIALIZE isLocallyDefined
+ :: Name -> Bool
+ #-}
\end{code}
projects / ghc-hetmet.git / blobdiff