[project @ 2004-08-31 12:28:18 by simonmar]
[ghc-hetmet.git] / ghc / compiler / basicTypes / Name.lhs
index b98a491..b39c402 100644 (file)
@@ -10,9 +10,10 @@ module Name (
 
        -- The Name type
        Name,                                   -- Abstract
+       BuiltInSyntax(..), 
        mkInternalName, mkSystemName, 
-       mkSystemNameEncoded, mkSystemTvNameEncoded, mkFCallName,
-       mkIPName,
+       mkSystemNameEncoded, mkSysTvName, 
+       mkFCallName, mkIPName,
        mkExternalName, mkWiredInName,
 
        nameUnique, setNameUnique,
@@ -23,7 +24,7 @@ module Name (
        nameSrcLoc, nameParent, nameParent_maybe,
 
        isSystemName, isInternalName, isExternalName,
-       isTyVarName, isDllName, isWiredInName,
+       isTyVarName, isDllName, isWiredInName, isBuiltInSyntax,
        wiredInNameTyThing_maybe, 
        nameIsLocalOrFrom, isHomePackageName,
        
@@ -42,7 +43,6 @@ import CmdLineOpts    ( opt_Static )
 import SrcLoc          ( noSrcLoc, wiredInSrcLoc, SrcLoc )
 import Unique          ( Unique, Uniquable(..), getKey, pprUnique )
 import Maybes          ( orElse )
-import FastTypes
 import Outputable
 \end{code}
 
@@ -70,7 +70,7 @@ data NameSort
        -- e.g. data constructor of a data type, method of a class
        -- Nothing => not a subordinate
  
-  | WiredIn Module (Maybe Name) TyThing
+  | WiredIn Module (Maybe Name) TyThing BuiltInSyntax
        -- A variant of External, for wired-in things
 
   | Internal           -- A user-defined Id or TyVar
@@ -78,6 +78,11 @@ data NameSort
 
   | System             -- A system-defined Id or TyVar.  Typically the
                        -- OccName is very uninformative (like 's')
+
+data BuiltInSyntax = BuiltInSyntax | UserSyntax
+-- BuiltInSyntax is for things like (:), [], tuples etc, 
+-- which have special syntactic forms.  They aren't "in scope"
+-- as such.
 \end{code}
 
 Notes about the NameSorts:
@@ -103,6 +108,14 @@ Notes about the NameSorts:
     If any desugarer sys-locals have survived that far, they get changed to
     "ds1", "ds2", etc.
 
+Built-in syntax => It's a syntactic form, not "in scope" (e.g. [])
+
+Wired-in thing  => The thing (Id, TyCon) is fully known to the compiler, 
+                  not read from an interface file. 
+                  E.g. Bool, True, Int, Float, and many others
+
+All built-in syntax is for wired-in things.
+
 \begin{code}
 nameUnique             :: Name -> Unique
 nameOccName            :: Name -> OccName 
@@ -123,23 +136,26 @@ isSystemName        :: Name -> Bool
 isHomePackageName :: Name -> Bool
 isWiredInName    :: Name -> Bool
 
-isWiredInName (Name {n_sort = WiredIn _ _ _}) = True
-isWiredInName other                          = False
+isWiredInName (Name {n_sort = WiredIn _ _ _ _}) = True
+isWiredInName other                            = False
 
 wiredInNameTyThing_maybe :: Name -> Maybe TyThing
-wiredInNameTyThing_maybe (Name {n_sort = WiredIn _ _ thing}) = Just thing
-wiredInNameTyThing_maybe other                              = Nothing
+wiredInNameTyThing_maybe (Name {n_sort = WiredIn _ _ thing _}) = Just thing
+wiredInNameTyThing_maybe other                                = Nothing
+
+isBuiltInSyntax (Name {n_sort = WiredIn _ _ _ BuiltInSyntax}) = True
+isBuiltInSyntax other                                        = False
 
-isExternalName (Name {n_sort = External _ _})  = True
-isExternalName (Name {n_sort = WiredIn _ _ _}) = True
-isExternalName other                          = False
+isExternalName (Name {n_sort = External _ _})    = True
+isExternalName (Name {n_sort = WiredIn _ _ _ _}) = True
+isExternalName other                            = False
 
 isInternalName name = not (isExternalName name)
 
 nameParent_maybe :: Name -> Maybe Name
-nameParent_maybe (Name {n_sort = External _ p})  = p
-nameParent_maybe (Name {n_sort = WiredIn _ p _}) = p
-nameParent_maybe other                          = Nothing
+nameParent_maybe (Name {n_sort = External _ p})    = p
+nameParent_maybe (Name {n_sort = WiredIn _ p _ _}) = p
+nameParent_maybe other                            = Nothing
 
 nameParent :: Name -> Name
 nameParent name = case nameParent_maybe name of
@@ -149,9 +165,9 @@ nameParent name = case nameParent_maybe name of
 nameModule name = nameModule_maybe name `orElse` pprPanic "nameModule" (ppr name)
 nameModuleName name = moduleName (nameModule name)
 
-nameModule_maybe (Name { n_sort = External mod _})  = Just mod
-nameModule_maybe (Name { n_sort = WiredIn mod _ _}) = Just mod
-nameModule_maybe name                              = Nothing
+nameModule_maybe (Name { n_sort = External mod _})    = Just mod
+nameModule_maybe (Name { n_sort = WiredIn mod _ _ _}) = Just mod
+nameModule_maybe name                                = Nothing
 
 nameIsLocalOrFrom from name
   | isExternalName name = from == nameModule name
@@ -195,10 +211,11 @@ mkExternalName uniq mod occ mb_parent loc
   = Name { n_uniq = uniq, n_sort = External mod mb_parent,
            n_occ = occ, n_loc = loc }
 
-mkWiredInName :: Module -> OccName -> Unique -> Maybe Name -> TyThing -> Name
-mkWiredInName mod occ uniq mb_parent thing 
+mkWiredInName :: Module -> OccName -> Unique 
+             -> Maybe Name -> TyThing -> BuiltInSyntax -> Name
+mkWiredInName mod occ uniq mb_parent thing built_in
   = Name { n_uniq = uniq,
-          n_sort = WiredIn mod mb_parent thing,
+          n_sort = WiredIn mod mb_parent thing built_in,
           n_occ = occ, n_loc = wiredInSrcLoc }
 
 mkSystemName :: Unique -> UserFS -> Name
@@ -212,10 +229,10 @@ mkSystemNameEncoded uniq fs = Name { n_uniq = uniq, n_sort = System,
                                     n_occ = mkSysOccFS varName fs, 
                                     n_loc = noSrcLoc }
 
-mkSystemTvNameEncoded :: Unique -> EncodedFS -> Name
-mkSystemTvNameEncoded uniq fs = Name { n_uniq = uniq, n_sort = System, 
-                                      n_occ = mkSysOccFS tvName fs, 
-                                      n_loc = noSrcLoc }
+mkSysTvName :: Unique -> EncodedFS -> Name
+mkSysTvName uniq fs = Name { n_uniq = uniq, n_sort = System, 
+                            n_occ = mkSysOccFS tvName fs, 
+                            n_loc = noSrcLoc }
 
 mkFCallName :: Unique -> EncodedString -> Name
        -- The encoded string completely describes the ccall
@@ -300,17 +317,20 @@ instance Outputable Name where
 instance OutputableBndr Name where
     pprBndr _ name = pprName name
 
-pprName name@(Name {n_sort = sort, n_uniq = uniq, n_occ = occ})
+pprName (Name {n_sort = sort, n_uniq = uniq, n_occ = occ})
   = getPprStyle $ \ sty ->
     case sort of
-      External mod mb_p      -> pprExternal sty name uniq mod occ mb_p False
-      WiredIn mod mb_p thing -> pprExternal sty name uniq mod occ mb_p True
-      System                        -> pprSystem sty uniq occ
-      Internal              -> pprInternal sty uniq occ
-
-pprExternal sty name uniq mod occ mb_p is_wired
-  | codeStyle sty        = ppr (moduleName mod) <> char '_' <> pprOccName occ
-  | debugStyle sty       = sep [ppr (moduleName mod) <> dot <> pprOccName occ,
+      WiredIn mod _ _ builtin -> pprExternal sty uniq mod occ True  builtin
+      External mod _         -> pprExternal sty uniq mod occ False UserSyntax
+      System                         -> pprSystem sty uniq occ
+      Internal               -> pprInternal sty uniq occ
+
+pprExternal sty uniq mod occ is_wired is_builtin
+  | codeStyle sty        = ppr mod_name <> char '_' <> pprOccName occ
+       -- In code style, always qualify
+       -- ToDo: maybe we could print all wired-in things unqualified
+       --       in code style, to reduce symbol table bloat?
+  | debugStyle sty       = sep [ppr mod_name <> dot <> pprOccName occ,
                                hsep [text "{-" 
                                     , if is_wired then ptext SLIT("(w)") else empty
                                     , pprUnique uniq
@@ -318,14 +338,16 @@ pprExternal sty name uniq mod occ mb_p is_wired
 --                                      Nothing -> empty
 --                                      Just n  -> brackets (ppr n)
                                     , text "-}"]]
-  | unqualStyle sty name = pprOccName occ
-  | otherwise           = ppr (moduleName mod) <> dot <> pprOccName occ
+  | BuiltInSyntax <- is_builtin  = pprOccName occ
+       -- never qualify builtin syntax
+  | unqualStyle sty mod_name occ = pprOccName occ
+  | otherwise                   = ppr mod_name <> dot <> pprOccName occ
+  where
+    mod_name = moduleName mod
 
 pprInternal sty uniq occ
   | codeStyle sty  = pprUnique uniq
-  | debugStyle sty = hsep [pprOccName occ, text "{-", 
-                          text (briefOccNameFlavour occ), 
-                          pprUnique uniq, text "-}"]
+  | debugStyle sty = pprOccName occ <> text "{-" <> pprUnique uniq <> text "-}"
   | otherwise      = pprOccName occ    -- User style
 
 -- Like Internal, except that we only omit the unique in Iface style