Name.lhs 18.1 KB
Newer Older
1
%
Simon Marlow's avatar
Simon Marlow committed
2
% (c) The University of Glasgow 2006
3
% (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
4 5 6 7
%
\section[Name]{@Name@: to transmit name info from renamer to typechecker}

\begin{code}
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
-- |
-- #name_types#
-- GHC uses several kinds of name internally:
--
-- * 'OccName.OccName': see "OccName#name_types"
--
-- * 'RdrName.RdrName': see "RdrName#name_types"
--
-- *  'Name.Name' is the type of names that have had their scoping and binding resolved. They
--   have an 'OccName.OccName' but also a 'Unique.Unique' that disambiguates Names that have
--   the same 'OccName.OccName' and indeed is used for all 'Name.Name' comparison. Names
--   also contain information about where they originated from, see "Name#name_sorts"
--
-- * 'Id.Id': see "Id#name_types"
--
-- * 'Var.Var': see "Var#name_types"
--
-- #name_sorts#
-- Names are one of:
--
--  * External, if they name things declared in other modules. Some external
--    Names are wired in, i.e. they name primitives defined in the compiler itself
--
--  * Internal, if they name things in the module being compiled. Some internal
--    Names are system names, if they are names manufactured by the compiler
33

34 35
module Name (
	-- * The main types
36
	Name,					-- Abstract
37 38 39
	BuiltInSyntax(..),

	-- ** Creating 'Name's
40
	mkInternalName, mkSystemName, mkDerivedInternalName, 
41
	mkSystemVarName, mkSysTvName, 
42
	mkFCallName, mkIPName,
43
        mkTickBoxOpName,
44
	mkExternalName, mkWiredInName,
45

46
	-- ** Manipulating and deconstructing 'Name's
47
	nameUnique, setNameUnique,
48
	nameOccName, nameModule, nameModule_maybe,
49
	tidyNameOcc, 
50
	hashName, localiseName,
sof's avatar
sof committed
51

52
	nameSrcLoc, nameSrcSpan, pprNameLoc,
53

54
	-- ** Predicates on 'Name's
55
	isSystemName, isInternalName, isExternalName,
56 57 58
	isTyVarName, isTyConName, isDataConName, 
	isValName, isVarName,
	isWiredInName, isBuiltInSyntax,
59
	wiredInNameTyThing_maybe, 
60
	nameIsLocalOrFrom,
61 62

	-- * Class 'NamedThing' and overloaded friends
63
	NamedThing(..),
64
	getSrcLoc, getSrcSpan, getOccString,
65

66
 	pprInfixName, pprPrefixName, pprModulePrefix,
67 68 69

	-- Re-export the OccName stuff
	module OccName
70
    ) where
71

72 73
#include "Typeable.h"

74 75
import {-# SOURCE #-} TypeRep( TyThing )

Simon Marlow's avatar
Simon Marlow committed
76 77 78 79
import OccName
import Module
import SrcLoc
import Unique
80
import Util
Simon Marlow's avatar
Simon Marlow committed
81
import Maybes
82
import Binary
83
import StaticFlags
84
import FastTypes
Simon Marlow's avatar
Simon Marlow committed
85
import FastString
86
import Outputable
87

Simon Marlow's avatar
Simon Marlow committed
88
import Data.Array
89
import Data.Data
90
import Data.Word        ( Word32 )
91 92
\end{code}

93 94
%************************************************************************
%*									*
95
\subsection[Name-datatype]{The @Name@ datatype, and name construction}
96 97
%*									*
%************************************************************************
98
 
99
\begin{code}
100 101
-- | A unique, unambigious name for something, containing information about where
-- that thing originated.
102 103
data Name = Name {
		n_sort :: NameSort,	-- What sort of name it is
104
		n_occ  :: !OccName,	-- Its occurrence name
105 106
		n_uniq :: FastInt,      -- UNPACK doesn't work, recursive type
--(note later when changing Int# -> FastInt: is that still true about UNPACK?)
107
		n_loc  :: !SrcSpan	-- Definition site
108 109
	    }

110 111 112 113
-- NOTE: we make the n_loc field strict to eliminate some potential
-- (and real!) space leaks, due to the fact that we don't look at
-- the SrcLoc in a Name all that often.

114
data NameSort
115
  = External Module
116
 
117
  | WiredIn Module TyThing BuiltInSyntax
118
	-- A variant of External, for wired-in things
119

120
  | Internal		-- A user-defined Id or TyVar
121 122 123 124
			-- defined in the module being compiled

  | System		-- A system-defined Id or TyVar.  Typically the
			-- OccName is very uninformative (like 's')
125

126 127
-- | BuiltInSyntax is for things like @(:)@, @[]@ and tuples, 
-- which have special syntactic forms.  They aren't in scope
128
-- as such.
129
data BuiltInSyntax = BuiltInSyntax | UserSyntax
130 131
\end{code}

132 133
Notes about the NameSorts:

134 135
1.  Initially, top-level Ids (including locally-defined ones) get External names, 
    and all other local Ids get Internal names
136

137
2.  Things with a External name are given C static labels, so they finally
138 139
    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
140
    must be made @External@ first.
141

142 143
3.  In the tidy-core phase, a External that is not visible to an importer
    is changed to Internal, and a Internal that is visible is changed to External
144 145

4.  A System Name differs in the following ways:
146 147 148 149 150 151 152 153 154
	a) has unique attached when printing dumps
	b) unifier eliminates sys tyvars in favour of user provs where possible

    Before anything gets printed in interface files or output code, it's
    fed through a 'tidy' processor, which zaps the OccNames to have
    unique names; and converts all sys-locals to user locals
    If any desugarer sys-locals have survived that far, they get changed to
    "ds1", "ds2", etc.

155 156 157 158 159 160 161 162
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.

163 164 165 166 167
\begin{code}
nameUnique		:: Name -> Unique
nameOccName		:: Name -> OccName 
nameModule		:: Name -> Module
nameSrcLoc		:: Name -> SrcLoc
168
nameSrcSpan		:: Name -> SrcSpan
169

170
nameUnique  name = mkUniqueGrimily (iBox (n_uniq name))
171
nameOccName name = n_occ  name
172 173
nameSrcLoc  name = srcSpanStart (n_loc name)
nameSrcSpan name = n_loc  name
174 175
\end{code}

176 177 178 179 180 181
%************************************************************************
%*									*
\subsection{Predicates on names}
%*									*
%************************************************************************

182
\begin{code}
183 184 185 186
nameIsLocalOrFrom :: Module -> Name -> Bool
isInternalName	  :: Name -> Bool
isExternalName	  :: Name -> Bool
isSystemName	  :: Name -> Bool
187 188
isWiredInName	  :: Name -> Bool

189
isWiredInName (Name {n_sort = WiredIn _ _ _}) = True
twanvl's avatar
twanvl committed
190
isWiredInName _                               = False
191

192
wiredInNameTyThing_maybe :: Name -> Maybe TyThing
193
wiredInNameTyThing_maybe (Name {n_sort = WiredIn _ thing _}) = Just thing
twanvl's avatar
twanvl committed
194
wiredInNameTyThing_maybe _                                   = Nothing
195

twanvl's avatar
twanvl committed
196
isBuiltInSyntax :: Name -> Bool
197
isBuiltInSyntax (Name {n_sort = WiredIn _ _ BuiltInSyntax}) = True
twanvl's avatar
twanvl committed
198
isBuiltInSyntax _                                           = False
199

200 201
isExternalName (Name {n_sort = External _})    = True
isExternalName (Name {n_sort = WiredIn _ _ _}) = True
twanvl's avatar
twanvl committed
202
isExternalName _                               = False
203

204
isInternalName name = not (isExternalName name)
205

206
nameModule name = nameModule_maybe name `orElse` pprPanic "nameModule" (ppr name)
twanvl's avatar
twanvl committed
207
nameModule_maybe :: Name -> Maybe Module
208 209
nameModule_maybe (Name { n_sort = External mod})    = Just mod
nameModule_maybe (Name { n_sort = WiredIn mod _ _}) = Just mod
twanvl's avatar
twanvl committed
210
nameModule_maybe _                                  = Nothing
211

212 213 214 215
nameIsLocalOrFrom from name
  | isExternalName name = from == nameModule name
  | otherwise		= True

216 217
isTyVarName :: Name -> Bool
isTyVarName name = isTvOcc (nameOccName name)
218

219 220 221
isTyConName :: Name -> Bool
isTyConName name = isTcOcc (nameOccName name)

222 223 224 225 226 227 228 229 230
isDataConName :: Name -> Bool
isDataConName name = isDataOcc (nameOccName name)

isValName :: Name -> Bool
isValName name = isValOcc (nameOccName name)

isVarName :: Name -> Bool
isVarName = isVarOcc . nameOccName

231
isSystemName (Name {n_sort = System}) = True
twanvl's avatar
twanvl committed
232
isSystemName _                        = False
233 234 235 236 237 238 239 240
\end{code}


%************************************************************************
%*									*
\subsection{Making names}
%*									*
%************************************************************************
241

242
\begin{code}
243 244
-- | Create a name which is (for now at least) local to the current module and hence
-- does not need a 'Module' to disambiguate it from other 'Name's
245
mkInternalName :: Unique -> OccName -> SrcSpan -> Name
246
mkInternalName uniq occ loc = Name { n_uniq = getKeyFastInt uniq, n_sort = Internal, n_occ = occ, n_loc = loc }
247 248 249 250 251 252 253 254
	-- NB: You might worry that after lots of huffing and
	-- puffing we might end up with two local names with distinct
	-- uniques, but the same OccName.  Indeed we can, but that's ok
	--	* the insides of the compiler don't care: they use the Unique
	--	* when printing for -ddump-xxx you can switch on -dppr-debug to get the
	--	  uniques if you get confused
	--	* for interface files we tidyCore first, which puts the uniques
	--	  into the print name (see setNameVisibility below)
255

256 257 258 259 260
mkDerivedInternalName :: (OccName -> OccName) -> Unique -> Name -> Name
mkDerivedInternalName derive_occ uniq (Name { n_occ = occ, n_loc = loc })
  = Name { n_uniq = getKeyFastInt uniq, n_sort = Internal
         , n_occ = derive_occ occ, n_loc = loc }

261
-- | Create a name which definitely originates in the given module
262
mkExternalName :: Unique -> Module -> OccName -> SrcSpan -> Name
263
mkExternalName uniq mod occ loc 
264
  = Name { n_uniq = getKeyFastInt uniq, n_sort = External mod,
265
           n_occ = occ, n_loc = loc }
266

267 268
-- | Create a name which is actually defined by the compiler itself
mkWiredInName :: Module -> OccName -> Unique -> TyThing -> BuiltInSyntax -> Name
269
mkWiredInName mod occ uniq thing built_in
270
  = Name { n_uniq = getKeyFastInt uniq,
271
	   n_sort = WiredIn mod thing built_in,
272
	   n_occ = occ, n_loc = wiredInSrcSpan }
273

274
-- | Create a name brought into being by the compiler
275
mkSystemName :: Unique -> OccName -> Name
276
mkSystemName uniq occ = Name { n_uniq = getKeyFastInt uniq, n_sort = System, 
277
			       n_occ = occ, n_loc = noSrcSpan }
278

279 280
mkSystemVarName :: Unique -> FastString -> Name
mkSystemVarName uniq fs = mkSystemName uniq (mkVarOccFS fs)
281

282
mkSysTvName :: Unique -> FastString -> Name
283
mkSysTvName uniq fs = mkSystemName uniq (mkOccNameFS tvName fs)
284

285
-- | Make a name for a foreign call
286
mkFCallName :: Unique -> String -> Name
287
	-- The encoded string completely describes the ccall
288
mkFCallName uniq str =  Name { n_uniq = getKeyFastInt uniq, n_sort = Internal, 
289
			       n_occ = mkVarOcc str, n_loc = noSrcSpan }
290

291

292 293
mkTickBoxOpName :: Unique -> String -> Name
mkTickBoxOpName uniq str 
294
   = Name { n_uniq = getKeyFastInt uniq, n_sort = Internal, 
295
	    n_occ = mkVarOcc str, n_loc = noSrcSpan }
296

297
-- | Make the name of an implicit parameter
298 299
mkIPName :: Unique -> OccName -> Name
mkIPName uniq occ
300
  = Name { n_uniq = getKeyFastInt uniq,
301
	   n_sort = Internal,
302
	   n_occ  = occ,
303
	   n_loc = noSrcSpan }
304 305 306
\end{code}

\begin{code}
307 308 309
-- 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.
310
setNameUnique :: Name -> Unique -> Name
311
setNameUnique name uniq = name {n_uniq = getKeyFastInt uniq}
312

313 314 315 316 317 318
tidyNameOcc :: Name -> OccName -> Name
-- We set the OccName of a Name when tidying
-- In doing so, we change System --> Internal, so that when we print
-- it we don't get the unique by default.  It's tidy now!
tidyNameOcc name@(Name { n_sort = System }) occ = name { n_occ = occ, n_sort = Internal}
tidyNameOcc name 			    occ = name { n_occ = occ }
319

320
-- | Make the 'Name' into an internal name, regardless of what it was to begin with
321
localiseName :: Name -> Name
322
localiseName n = n { n_sort = Internal }
sof's avatar
sof committed
323 324
\end{code}

325 326
%************************************************************************
%*									*
327
\subsection{Hashing and comparison}
328 329 330 331
%*									*
%************************************************************************

\begin{code}
332 333 334 335 336
hashName :: Name -> Int		-- ToDo: should really be Word
hashName name = getKey (nameUnique name) + 1
	-- The +1 avoids keys with lots of zeros in the ls bits, which 
	-- interacts badly with the cheap and cheerful multiplication in
	-- hashExpr
337

338 339 340
cmpName :: Name -> Name -> Ordering
cmpName n1 n2 = iBox (n_uniq n1) `compare` iBox (n_uniq n2)
\end{code}
341

342 343 344 345 346 347 348 349
%************************************************************************
%*									*
\subsection[Name-instances]{Instance declarations}
%*									*
%************************************************************************

\begin{code}
instance Eq Name where
350 351
    a == b = case (a `compare` b) of { EQ -> True;  _ -> False }
    a /= b = case (a `compare` b) of { EQ -> False; _ -> True }
352 353

instance Ord Name where
354 355
    a <= b = case (a `compare` b) of { LT -> True;  EQ -> True;  GT -> False }
    a <	 b = case (a `compare` b) of { LT -> True;  EQ -> False; GT -> False }
356 357 358
    a >= b = case (a `compare` b) of { LT -> False; EQ -> True;  GT -> True  }
    a >	 b = case (a `compare` b) of { LT -> False; EQ -> False; GT -> True  }
    compare a b = cmpName a b
359

360
instance Uniquable Name where
361
    getUnique = nameUnique
362

363
instance NamedThing Name where
364
    getName n = n
365 366 367 368 369 370 371 372

INSTANCE_TYPEABLE0(Name,nameTc,"Name")

instance Data Name where
  -- don't traverse?
  toConstr _   = abstractConstr "Name"
  gunfold _ _  = error "gunfold"
  dataTypeOf _ = mkNoRepType "Name"
373 374
\end{code}

375 376 377 378 379 380 381 382
%************************************************************************
%*									*
\subsection{Binary}
%*									*
%************************************************************************

\begin{code}
instance Binary Name where
383 384 385
   put_ bh name =
      case getUserData bh of 
        UserData{ ud_put_name = put_name } -> put_name bh name
386 387 388

   get bh = do
        i <- get bh
389
        return $! (ud_symtab (getUserData bh) ! fromIntegral (i::Word32))
390
\end{code}
391

392 393 394 395 396
%************************************************************************
%*									*
\subsection{Pretty printing}
%*									*
%************************************************************************
397 398 399

\begin{code}
instance Outputable Name where
400 401
    ppr name = pprName name

402 403 404
instance OutputableBndr Name where
    pprBndr _ name = pprName name

twanvl's avatar
twanvl committed
405 406
pprName :: Name -> SDoc
pprName (Name {n_sort = sort, n_uniq = u, n_occ = occ})
407
  = getPprStyle $ \ sty ->
408
    case sort of
409 410
      WiredIn mod _ builtin   -> pprExternal sty uniq mod occ True  builtin
      External mod  	      -> pprExternal sty uniq mod occ False UserSyntax
411 412
      System   		      -> pprSystem sty uniq occ
      Internal    	      -> pprInternal sty uniq occ
413
  where uniq = mkUniqueGrimily (iBox u)
414

twanvl's avatar
twanvl committed
415
pprExternal :: PprStyle -> Unique -> Module -> OccName -> Bool -> BuiltInSyntax -> SDoc
416
pprExternal sty uniq mod occ is_wired is_builtin
417
  | codeStyle sty = ppr mod <> char '_' <> ppr_z_occ_name occ
418 419 420
	-- In code style, always qualify
	-- ToDo: maybe we could print all wired-in things unqualified
	-- 	 in code style, to reduce symbol table bloat?
421 422 423 424 425 426
  | debugStyle sty = ppr mod <> dot <> ppr_occ_name occ
		     <> braces (hsep [if is_wired then ptext (sLit "(w)") else empty,
				      pprNameSpaceBrief (occNameSpace occ), 
		 		      pprUnique uniq])
  | BuiltInSyntax <- is_builtin = ppr_occ_name occ  -- Never qualify builtin syntax
  | otherwise		        = pprModulePrefix sty mod occ <> ppr_occ_name occ
427

twanvl's avatar
twanvl committed
428
pprInternal :: PprStyle -> Unique -> OccName -> SDoc
429
pprInternal sty uniq occ
430
  | codeStyle sty  = pprUnique uniq
431
  | debugStyle sty = ppr_occ_name occ <> braces (hsep [pprNameSpaceBrief (occNameSpace occ), 
432
				 		       pprUnique uniq])
433
  | dumpStyle sty  = ppr_occ_name occ <> ppr_underscore_unique uniq
434 435
			-- For debug dumps, we're not necessarily dumping
			-- tidied code, so we need to print the uniques.
436
  | otherwise      = ppr_occ_name occ	-- User style
437

438
-- Like Internal, except that we only omit the unique in Iface style
twanvl's avatar
twanvl committed
439
pprSystem :: PprStyle -> Unique -> OccName -> SDoc
440
pprSystem sty uniq occ
441
  | codeStyle sty  = pprUnique uniq
442
  | debugStyle sty = ppr_occ_name occ <> ppr_underscore_unique uniq
443
		     <> braces (pprNameSpaceBrief (occNameSpace occ))
444
  | otherwise	   = ppr_occ_name occ <> ppr_underscore_unique uniq
445 446 447
				-- If the tidy phase hasn't run, the OccName
				-- is unlikely to be informative (like 's'),
				-- so print the unique
448

449 450 451 452 453

pprModulePrefix :: PprStyle -> Module -> OccName -> SDoc
-- Print the "M." part of a name, based on whether it's in scope or not
-- See Note [Printing original names] in HscTypes
pprModulePrefix sty mod occ
454 455 456
  | opt_SuppressModulePrefixes = empty
  
  | otherwise
457 458 459 460 461 462 463
  = case qualName sty mod occ of	           -- See Outputable.QualifyName:
      NameQual modname -> ppr modname <> dot       -- Name is in scope       
      NameNotInScope1  -> ppr mod <> dot           -- Not in scope
      NameNotInScope2  -> ppr (modulePackageId mod) <> colon     -- Module not in
                          <> ppr (moduleName mod) <> dot         -- scope eithber
      _otherwise       -> empty

464 465 466 467 468 469 470
ppr_underscore_unique :: Unique -> SDoc
-- Print an underscore separating the name from its unique
-- But suppress it if we aren't printing the uniques anyway
ppr_underscore_unique uniq
  | opt_SuppressUniques = empty
  | otherwise		= char '_' <> pprUnique uniq

twanvl's avatar
twanvl committed
471
ppr_occ_name :: OccName -> SDoc
472
ppr_occ_name occ = ftext (occNameFS occ)
473 474
	-- Don't use pprOccName; instead, just print the string of the OccName; 
	-- we print the namespace in the debug stuff above
475 476 477

-- In code style, we Z-encode the strings.  The results of Z-encoding each FastString are
-- cached behind the scenes in the FastString implementation.
twanvl's avatar
twanvl committed
478
ppr_z_occ_name :: OccName -> SDoc
479
ppr_z_occ_name occ = ftext (zEncodeFS (occNameFS occ))
480

481 482
-- Prints (if mod information is available) "Defined at <loc>" or 
--  "Defined in <mod>" information for a Name.
483 484 485
pprNameLoc :: Name -> SDoc
pprNameLoc name
  | isGoodSrcSpan loc = pprDefnLoc loc
486
  | isInternalName name || isSystemName name 
Ian Lynagh's avatar
Ian Lynagh committed
487 488
                      = ptext (sLit "<no location info>")
  | otherwise         = ptext (sLit "Defined in ") <> ppr (nameModule name)
489
  where loc = nameSrcSpan name
490
\end{code}
491

492 493 494 495 496 497 498
%************************************************************************
%*									*
\subsection{Overloaded functions related to Names}
%*									*
%************************************************************************

\begin{code}
499
-- | A class allowing convenient access to the 'Name' of various datatypes
500
class NamedThing a where
501
    getOccName :: a -> OccName
502 503 504
    getName    :: a -> Name

    getOccName n = nameOccName (getName n)	-- Default method
505 506 507 508
\end{code}

\begin{code}
getSrcLoc	    :: NamedThing a => a -> SrcLoc
509
getSrcSpan	    :: NamedThing a => a -> SrcSpan
510
getOccString	    :: NamedThing a => a -> String
511

512
getSrcLoc	    = nameSrcLoc	   . getName
513
getSrcSpan	    = nameSrcSpan	   . getName
514
getOccString 	    = occNameString	   . getOccName
515 516 517 518 519 520

pprInfixName, pprPrefixName :: (Outputable a, NamedThing a) => a -> SDoc
-- See Outputable.pprPrefixVar, pprInfixVar; 
-- add parens or back-quotes as appropriate
pprInfixName  n = pprInfixVar  (isSymOcc (getOccName n)) (ppr n)
pprPrefixName n = pprPrefixVar (isSymOcc (getOccName n)) (ppr n)
521 522
\end{code}