Syntax.hs 46.6 KB
Newer Older
1
{-# LANGUAGE UnboxedTuples #-}
2

3 4 5 6 7
-----------------------------------------------------------------------------
-- |
-- Module      :  Language.Haskell.Syntax
-- Copyright   :  (c) The University of Glasgow 2003
-- License     :  BSD-style (see the file libraries/base/LICENSE)
Jan Stolarek's avatar
Jan Stolarek committed
8
--
9 10 11 12 13 14 15 16
-- Maintainer  :  libraries@haskell.org
-- Stability   :  experimental
-- Portability :  portable
--
-- Abstract syntax definitions for Template Haskell.
--
-----------------------------------------------------------------------------

17
module Language.Haskell.TH.Syntax where
18

19
import GHC.Exts
20
import Data.Data (Data(..), Typeable, mkConstr, mkDataType, constrIndex)
Ross Paterson's avatar
Ross Paterson committed
21
import qualified Data.Data as Data
22
import Control.Applicative( Applicative(..) )
23
import Data.IORef
24
import System.IO.Unsafe	( unsafePerformIO )
25
import Control.Monad (liftM)
26
import System.IO	( hPutStrLn, stderr )
27
import Data.Char        ( isAlpha )
reinerp's avatar
reinerp committed
28
import Data.Word        ( Word8 )
29 30 31 32 33 34 35

-----------------------------------------------------
--
--		The Quasi class
--
-----------------------------------------------------

36
class (Monad m, Applicative m) => Quasi m where
37
  qNewName :: String -> m Name
aavogt's avatar
aavogt committed
38
	-- ^ Fresh names
39 40

	-- Error reporting and recovery
aavogt's avatar
aavogt committed
41
  qReport  :: Bool -> String -> m ()	-- ^ Report an error (True) or warning (False)
42
					-- ...but carry on; use 'fail' to stop
aavogt's avatar
aavogt committed
43 44 45
  qRecover :: m a -- ^ the error handler
           -> m a -- ^ action which may fail
           -> m a		-- ^ Recover from the monadic 'fail'
Jan Stolarek's avatar
Jan Stolarek committed
46

47
	-- Inspect the type-checker's environment
48 49 50 51 52
  qLookupName :: Bool -> String -> m (Maybe Name)
       -- True <=> type namespace, False <=> value namespace
  qReify          :: Name -> m Info
  qReifyInstances :: Name -> [Type] -> m [Dec]
       -- Is (n tys) an instance?
Jan Stolarek's avatar
Jan Stolarek committed
53
       -- Returns list of matching instance Decs
54 55
       --    (with empty sub-Decs)
       -- Works for classes and type functions
Austin Seipp's avatar
Austin Seipp committed
56 57
  qReifyRoles       :: Name -> m [Role]
  qReifyAnnotations :: Data a => AnnLookup -> m [a]
58

59
  qLocation :: m Loc
60 61

  qRunIO :: IO a -> m a
aavogt's avatar
aavogt committed
62
  -- ^ Input/output (dangerous)
63

GregWeber's avatar
GregWeber committed
64
  qAddDependentFile :: FilePath -> m ()
65

66 67
  qAddTopDecls :: [Dec] -> m ()

68 69
  qAddModFinalizer :: Q () -> m ()

gmainland's avatar
gmainland committed
70 71 72 73
  qGetQ :: Typeable a => m (Maybe a)

  qPutQ :: Typeable a => a -> m ()

74 75
-----------------------------------------------------
--	The IO instance of Quasi
Jan Stolarek's avatar
Jan Stolarek committed
76
--
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
--  This instance is used only when running a Q
--  computation in the IO monad, usually just to
--  print the result.  There is no interesting
--  type environment, so reification isn't going to
--  work.
--
-----------------------------------------------------

instance Quasi IO where
  qNewName s = do { n <- readIORef counter
                 ; writeIORef counter (n+1)
                 ; return (mkNameU s n) }

  qReport True  msg = hPutStrLn stderr ("Template Haskell error: " ++ msg)
  qReport False msg = hPutStrLn stderr ("Template Haskell error: " ++ msg)

93
  qLookupName _ _     = badIO "lookupName"
94
  qReify _            = badIO "reify"
95
  qReifyInstances _ _ = badIO "classInstances"
96
  qReifyRoles _       = badIO "reifyRoles"
Austin Seipp's avatar
Austin Seipp committed
97
  qReifyAnnotations _ = badIO "reifyAnnotations"
98 99
  qLocation    	      = badIO "currentLocation"
  qRecover _ _ 	      = badIO "recover" -- Maybe we could fix this?
GregWeber's avatar
GregWeber committed
100
  qAddDependentFile _ = badIO "addDependentFile"
101
  qAddTopDecls _      = badIO "addTopDecls"
102
  qAddModFinalizer _  = badIO "addModFinalizer"
gmainland's avatar
gmainland committed
103 104
  qGetQ               = badIO "getQ"
  qPutQ _             = badIO "putQ"
105 106

  qRunIO m = m
Jan Stolarek's avatar
Jan Stolarek committed
107

108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
badIO :: String -> IO a
badIO op = do	{ qReport True ("Can't do `" ++ op ++ "' in the IO monad")
		; fail "Template Haskell failure" }

-- Global variable to generate unique symbols
counter :: IORef Int
{-# NOINLINE counter #-}
counter = unsafePerformIO (newIORef 0)


-----------------------------------------------------
--
--		The Q monad
--
-----------------------------------------------------

newtype Q a = Q { unQ :: forall m. Quasi m => m a }

126 127 128 129 130
-- \"Runs\" the 'Q' monad. Normal users of Template Haskell
-- should not need this function, as the splice brackets @$( ... )@
-- are the usual way of running a 'Q' computation.
--
-- This function is primarily used in GHC internals, and for debugging
Jan Stolarek's avatar
Jan Stolarek committed
131
-- splices by running them in 'IO'.
132 133 134 135 136
--
-- Note that many functions in 'Q', such as 'reify' and other compiler
-- queries, are not supported when running 'Q' in 'IO'; these operations
-- simply fail at runtime. Indeed, the only operations guaranteed to succeed
-- are 'newName', 'runIO', 'reportError' and 'reportWarning'.
137 138 139 140 141 142 143
runQ :: Quasi m => Q a -> m a
runQ (Q m) = m

instance Monad Q where
  return x   = Q (return x)
  Q m >>= k  = Q (m >>= \x -> unQ (k x))
  Q m >> Q n = Q (m >> n)
144
  fail s     = report True s >> Q (fail "Q monad failure")
145

146 147 148
instance Functor Q where
  fmap f (Q x) = Q (fmap f x)

Jan Stolarek's avatar
Jan Stolarek committed
149 150 151
instance Applicative Q where
  pure x = Q (pure x)
  Q f <*> Q x = Q (f <*> x)
152

gmainland's avatar
gmainland committed
153 154 155 156 157 158
-----------------------------------------------------
--
--		The TExp type
--
-----------------------------------------------------

159 160 161 162 163 164 165 166 167
newtype TExp a = TExp { unType :: Exp }

unTypeQ :: Q (TExp a) -> Q Exp
unTypeQ m = do { TExp e <- m
               ; return e }

unsafeTExpCoerce :: Q Exp -> Q (TExp a)
unsafeTExpCoerce m = do { e <- m
                        ; return (TExp e) }
gmainland's avatar
gmainland committed
168

169 170
----------------------------------------------------
-- Packaged versions for the programmer, hiding the Quasi-ness
171

Jan Stolarek's avatar
Jan Stolarek committed
172 173
{- |
Generate a fresh name, which cannot be captured.
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205

For example, this:

@f = $(do
  nm1 <- newName \"x\"
  let nm2 = 'mkName' \"x\"
  return ('LamE' ['VarP' nm1] (LamE [VarP nm2] ('VarE' nm1)))
 )@

will produce the splice

>f = \x0 -> \x -> x0

In particular, the occurrence @VarE nm1@ refers to the binding @VarP nm1@,
and is not captured by the binding @VarP nm2@.

Although names generated by @newName@ cannot /be captured/, they can
/capture/ other names. For example, this:

>g = $(do
>  nm1 <- newName "x"
>  let nm2 = mkName "x"
>  return (LamE [VarP nm2] (LamE [VarP nm1] (VarE nm2)))
> )

will produce the splice

>g = \x -> \x0 -> x0

since the occurrence @VarE nm2@ is captured by the innermost binding
of @x@, namely @VarP nm1@.
-}
206 207 208
newName :: String -> Q Name
newName s = Q (qNewName s)

Jan Stolarek's avatar
Jan Stolarek committed
209
-- | Report an error (True) or warning (False),
210
-- but carry on; use 'fail' to stop.
211 212
report  :: Bool -> String -> Q ()
report b s = Q (qReport b s)
213
{-# DEPRECATED report "Use reportError or reportWarning instead" #-} -- deprecated in 7.6
214 215 216 217 218 219 220 221

-- | Report an error to the user, but allow the current splice's computation to carry on. To abort the computation, use 'fail'.
reportError :: String -> Q ()
reportError = report True

-- | Report a warning to the user, and carry on.
reportWarning :: String -> Q ()
reportWarning = report False
222

223 224 225
-- | Recover from errors raised by 'reportError' or 'fail'.
recover :: Q a -- ^ handler to invoke on failure
        -> Q a -- ^ computation to run
aavogt's avatar
aavogt committed
226
        -> Q a
227 228
recover (Q r) (Q m) = Q (qRecover r m)

229 230 231 232 233
-- We don't export lookupName; the Bool isn't a great API
-- Instead we export lookupTypeName, lookupValueName
lookupName :: Bool -> String -> Q (Maybe Name)
lookupName ns s = Q (qLookupName ns s)

234 235
-- | Look up the given name in the (type namespace of the) current splice's scope. See "Language.Haskell.TH.Syntax#namelookup" for more details.
lookupTypeName :: String -> Q (Maybe Name)
236
lookupTypeName  s = Q (qLookupName True s)
237 238 239

-- | Look up the given name in the (value namespace of the) current splice's scope. See "Language.Haskell.TH.Syntax#namelookup" for more details.
lookupValueName :: String -> Q (Maybe Name)
240 241
lookupValueName s = Q (qLookupName False s)

242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
{-
Note [Name lookup]
~~~~~~~~~~~~~~~~~~
-}
{- $namelookup #namelookup#
The functions 'lookupTypeName' and 'lookupValueName' provide
a way to query the current splice's context for what names
are in scope. The function 'lookupTypeName' queries the type
namespace, whereas 'lookupValueName' queries the value namespace,
but the functions are otherwise identical.

A call @lookupValueName s@ will check if there is a value
with name @s@ in scope at the current splice's location. If
there is, the @Name@ of this value is returned;
if not, then @Nothing@ is returned.

Jan Stolarek's avatar
Jan Stolarek committed
258
The returned name cannot be \"captured\".
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
For example:

> f = "global"
> g = $( do
>          Just nm <- lookupValueName "f"
>          [| let f = "local" in $( varE nm ) |]

In this case, @g = \"global\"@; the call to @lookupValueName@
returned the global @f@, and this name was /not/ captured by
the local definition of @f@.

The lookup is performed in the context of the /top-level/ splice
being run. For example:

> f = "global"
Jan Stolarek's avatar
Jan Stolarek committed
274
> g = $( [| let f = "local" in
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
>            $(do
>                Just nm <- lookupValueName "f"
>                varE nm
>             ) |] )

Again in this example, @g = \"global\"@, because the call to
@lookupValueName@ queries the context of the outer-most @$(...)@.

Operators should be queried without any surrounding parentheses, like so:

> lookupValueName "+"

Qualified names are also supported, like so:

> lookupValueName "Prelude.+"
> lookupValueName "Prelude.map"

-}


{- | 'reify' looks up information about the 'Name'.

It is sometimes useful to construct the argument name using 'lookupTypeName' or 'lookupValueName'
to ensure that we are reifying from the right namespace. For instance, in this context:

> data D = D

which @D@ does @reify (mkName \"D\")@ return information about? (Answer: @D@-the-type, but don't rely on it.)
To ensure we get information about @D@-the-value, use 'lookupValueName':

> do
>   Just nm <- lookupValueName "D"
>   reify nm

and to get information about @D@-the-type, use 'lookupTypeName'.
-}
311 312 313
reify :: Name -> Q Info
reify v = Q (qReify v)

Jan Stolarek's avatar
Jan Stolarek committed
314
{- | @reifyInstances nm tys@ returns a list of visible instances of @nm tys@. That is,
315 316 317 318 319
if @nm@ is the name of a type class, then all instances of this class at the types @tys@
are returned. Alternatively, if @nm@ is the name of a data family or type family,
all instances of this family at the types @tys@ are returned.
-}
reifyInstances :: Name -> [Type] -> Q [InstanceDec]
320
reifyInstances cls tys = Q (qReifyInstances cls tys)
321

322 323 324 325 326 327 328
{- | @reifyRoles nm@ returns the list of roles associated with the parameters of
the tycon @nm@. Fails if @nm@ cannot be found or is not a tycon.
The returned list should never contain 'InferR'.
-}
reifyRoles :: Name -> Q [Role]
reifyRoles nm = Q (qReifyRoles nm)

Austin Seipp's avatar
Austin Seipp committed
329 330 331 332 333 334 335
-- | @reifyAnnotations target@ returns the list of annotations
-- associated with @target@.  Only the annotations that are
-- appropriately typed is returned.  So if you have @Int@ and @String@
-- annotations for the same target, you have to call this function twice.
reifyAnnotations :: Data a => AnnLookup -> Q [a]
reifyAnnotations an = Q (qReifyAnnotations an)

336
-- | Is the list of instances returned by 'reifyInstances' nonempty?
337 338 339
isInstance :: Name -> [Type] -> Q Bool
isInstance nm tys = do { decs <- reifyInstances nm tys
                       ; return (not (null decs)) }
340

341
-- | The location at which this computation is spliced.
342 343
location :: Q Loc
location = Q qLocation
344

dons's avatar
dons committed
345
-- |The 'runIO' function lets you run an I\/O computation in the 'Q' monad.
Jan Stolarek's avatar
Jan Stolarek committed
346 347
-- Take care: you are guaranteed the ordering of calls to 'runIO' within
-- a single 'Q' computation, but not about the order in which splices are run.
348
--
Jan Stolarek's avatar
Jan Stolarek committed
349
-- Note: for various murky reasons, stdout and stderr handles are not
350 351
-- necesarily flushed when the  compiler finishes running, so you should
-- flush them yourself.
352 353 354
runIO :: IO a -> Q a
runIO m = Q (qRunIO m)

GregWeber's avatar
GregWeber committed
355 356 357 358 359 360 361
-- | Record external files that runIO is using (dependent upon).
-- The compiler can then recognize that it should re-compile the file using this TH when the external file changes.
-- Note that ghc -M will still not know about these dependencies - it does not execute TH.
-- Expects an absolute file path.
addDependentFile :: FilePath -> Q ()
addDependentFile fp = Q (qAddDependentFile fp)

362 363 364 365 366
-- | Add additional top-level declarations. The added declarations will be type
-- checked along with the current declaration group.
addTopDecls :: [Dec] -> Q ()
addTopDecls ds = Q (qAddTopDecls ds)

367 368 369 370 371
-- | Add a finalizer that will run in the Q monad after the current module has
-- been type checked. This only makes sense when run within a top-level splice.
addModFinalizer :: Q () -> Q ()
addModFinalizer act = Q (qAddModFinalizer (unQ act))

gmainland's avatar
gmainland committed
372 373 374 375 376 377 378 379
-- | Get state from the Q monad.
getQ :: Typeable a => Q (Maybe a)
getQ = Q qGetQ

-- | Replace the state in the Q monad.
putQ :: Typeable a => a -> Q ()
putQ x = Q (qPutQ x)

380
instance Quasi Q where
GregWeber's avatar
GregWeber committed
381 382
  qNewName  	    = newName
  qReport   	    = report
Jan Stolarek's avatar
Jan Stolarek committed
383
  qRecover  	    = recover
GregWeber's avatar
GregWeber committed
384 385
  qReify    	    = reify
  qReifyInstances   = reifyInstances
386
  qReifyRoles       = reifyRoles
Austin Seipp's avatar
Austin Seipp committed
387
  qReifyAnnotations = reifyAnnotations
GregWeber's avatar
GregWeber committed
388 389 390 391
  qLookupName       = lookupName
  qLocation 	    = location
  qRunIO    	    = runIO
  qAddDependentFile = addDependentFile
392
  qAddTopDecls      = addTopDecls
393
  qAddModFinalizer  = addModFinalizer
gmainland's avatar
gmainland committed
394 395
  qGetQ             = getQ
  qPutQ             = putQ
396 397 398 399


----------------------------------------------------
-- The following operations are used solely in DsMeta when desugaring brackets
400
-- They are not necessary for the user, who can use ordinary return and (>>=) etc
401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419

returnQ :: a -> Q a
returnQ = return

bindQ :: Q a -> (a -> Q b) -> Q b
bindQ = (>>=)

sequenceQ :: [Q a] -> Q [a]
sequenceQ = sequence


-----------------------------------------------------
--
--		The Lift class
--
-----------------------------------------------------

class Lift t where
  lift :: t -> Q Exp
Jan Stolarek's avatar
Jan Stolarek committed
420

421 422 423 424 425 426 427 428 429 430 431 432 433
instance Lift Integer where
  lift x = return (LitE (IntegerL x))

instance Lift Int where
  lift x= return (LitE (IntegerL (fromIntegral x)))

instance Lift Char where
  lift x = return (LitE (CharL x))

instance Lift Bool where
  lift True  = return (ConE trueName)
  lift False = return (ConE falseName)

434 435 436 437 438 439 440 441
instance Lift a => Lift (Maybe a) where
  lift Nothing  = return (ConE nothingName)
  lift (Just x) = liftM (ConE justName `AppE`) (lift x)

instance (Lift a, Lift b) => Lift (Either a b) where
  lift (Left x)  = liftM (ConE leftName  `AppE`) (lift x)
  lift (Right y) = liftM (ConE rightName `AppE`) (lift y)

442 443 444
instance Lift a => Lift [a] where
  lift xs = do { xs' <- mapM lift xs; return (ListE xs') }

445 446 447 448
liftString :: String -> Q Exp
-- Used in TcExpr to short-circuit the lifting for strings
liftString s = return (LitE (StringL s))

449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
instance (Lift a, Lift b) => Lift (a, b) where
  lift (a, b)
    = liftM TupE $ sequence [lift a, lift b]

instance (Lift a, Lift b, Lift c) => Lift (a, b, c) where
  lift (a, b, c)
    = liftM TupE $ sequence [lift a, lift b, lift c]

instance (Lift a, Lift b, Lift c, Lift d) => Lift (a, b, c, d) where
  lift (a, b, c, d)
    = liftM TupE $ sequence [lift a, lift b, lift c, lift d]

instance (Lift a, Lift b, Lift c, Lift d, Lift e)
      => Lift (a, b, c, d, e) where
  lift (a, b, c, d, e)
    = liftM TupE $ sequence [lift a, lift b, lift c, lift d, lift e]

instance (Lift a, Lift b, Lift c, Lift d, Lift e, Lift f)
      => Lift (a, b, c, d, e, f) where
  lift (a, b, c, d, e, f)
    = liftM TupE $ sequence [lift a, lift b, lift c, lift d, lift e, lift f]

instance (Lift a, Lift b, Lift c, Lift d, Lift e, Lift f, Lift g)
      => Lift (a, b, c, d, e, f, g) where
  lift (a, b, c, d, e, f, g)
    = liftM TupE $ sequence [lift a, lift b, lift c, lift d, lift e, lift f, lift g]

476 477 478 479
-- TH has a special form for literal strings,
-- which we should take advantage of.
-- NB: the lhs of the rule has no args, so that
--     the rule will apply to a 'lift' all on its own
Jan Stolarek's avatar
Jan Stolarek committed
480
--     which happens to be the way the type checker
481 482 483 484 485
--     creates it.
{-# RULES "TH:liftString" lift = \s -> return (LitE (StringL s)) #-}


trueName, falseName :: Name
Ian Lynagh's avatar
Ian Lynagh committed
486 487
trueName  = mkNameG DataName "ghc-prim" "GHC.Types" "True"
falseName = mkNameG DataName "ghc-prim" "GHC.Types" "False"
488

489 490 491 492 493 494 495 496
nothingName, justName :: Name
nothingName = mkNameG DataName "base" "Data.Maybe" "Nothing"
justName    = mkNameG DataName "base" "Data.Maybe" "Just"

leftName, rightName :: Name
leftName  = mkNameG DataName "base" "Data.Either" "Left"
rightName = mkNameG DataName "base" "Data.Either" "Right"

497 498

-----------------------------------------------------
Jan Stolarek's avatar
Jan Stolarek committed
499
--		Names and uniques
500 501
-----------------------------------------------------

502
newtype ModName = ModName String	-- Module name
Austin Seipp's avatar
Austin Seipp committed
503
 deriving (Show,Eq,Ord,Typeable,Data)
504 505

newtype PkgName = PkgName String	-- package name
Austin Seipp's avatar
Austin Seipp committed
506
 deriving (Show,Eq,Ord,Typeable,Data)
507 508 509 510

newtype OccName = OccName String
 deriving (Eq,Ord,Typeable,Data)

511
mkModName :: String -> ModName
512
mkModName s = ModName s
513 514

modString :: ModName -> String
515
modString (ModName m) = m
516

517 518

mkPkgName :: String -> PkgName
519
mkPkgName s = PkgName s
520 521

pkgString :: PkgName -> String
522
pkgString (PkgName m) = m
523 524


525 526 527 528 529
-----------------------------------------------------
--		OccName
-----------------------------------------------------

mkOccName :: String -> OccName
530
mkOccName s = OccName s
531 532

occString :: OccName -> String
533
occString (OccName occ) = occ
534 535 536 537 538


-----------------------------------------------------
--		 Names
-----------------------------------------------------
Jan Stolarek's avatar
Jan Stolarek committed
539
--
aavogt's avatar
aavogt committed
540
-- For "global" names ('NameG') we need a totally unique name,
541 542
-- so we must include the name-space of the thing
--
aavogt's avatar
aavogt committed
543
-- For unique-numbered things ('NameU'), we've got a unique reference
544 545
-- anyway, so no need for name space
--
aavogt's avatar
aavogt committed
546
-- For dynamically bound thing ('NameS') we probably want them to
547 548
-- in a context-dependent way, so again we don't want the name
-- space.  For example:
aavogt's avatar
aavogt committed
549 550 551
--
-- > let v = mkName "T" in [| data $v = $v |]
--
552
-- Here we use the same Name for both type constructor and data constructor
aavogt's avatar
aavogt committed
553 554 555 556 557 558 559 560 561 562
--
--
-- NameL and NameG are bound *outside* the TH syntax tree
-- either globally (NameG) or locally (NameL). Ex:
--
-- > f x = $(h [| (map, x) |])
--
-- The 'map' will be a NameG, and 'x' wil be a NameL
--
-- These Names should never appear in a binding position in a TH syntax tree
563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587

{- $namecapture #namecapture#
Much of 'Name' API is concerned with the problem of /name capture/, which
can be seen in the following example.

> f expr = [| let x = 0 in $expr |]
> ...
> g x = $( f [| x |] )
> h y = $( f [| y |] )

A naive desugaring of this would yield:

> g x = let x = 0 in x
> h y = let x = 0 in y

All of a sudden, @g@ and @h@ have different meanings! In this case,
we say that the @x@ in the RHS of @g@ has been /captured/
by the binding of @x@ in @f@.

What we actually want is for the @x@ in @f@ to be distinct from the
@x@ in @g@, so we get the following desugaring:

> g x = let x' = 0 in x
> h y = let x' = 0 in y

Jan Stolarek's avatar
Jan Stolarek committed
588
which avoids name capture as desired.
589 590 591 592 593 594 595 596 597 598 599 600

In the general case, we say that a @Name@ can be captured if
the thing it refers to can be changed by adding new declarations.
-}

{- |
An abstract type representing names in the syntax tree.

'Name's can be constructed in several ways, which come with different
name-capture guarantees (see "Language.Haskell.TH.Syntax#namecapture" for
an explanation of name capture):

Jan Stolarek's avatar
Jan Stolarek committed
601 602
  * the built-in syntax @'f@ and @''T@ can be used to construct names,
    The expression @'f@ gives a @Name@ which refers to the value @f@
603 604
    currently in scope, and @''T@ gives a @Name@ which refers to the
    type @T@ currently in scope. These names can never be captured.
Jan Stolarek's avatar
Jan Stolarek committed
605 606

  * 'lookupValueName' and 'lookupTypeName' are similar to @'f@ and
607 608 609 610 611 612
     @''T@ respectively, but the @Name@s are looked up at the point
     where the current splice is being run. These names can never be
     captured.

  * 'newName' monadically generates a new name, which can never
     be captured.
Jan Stolarek's avatar
Jan Stolarek committed
613

614 615 616 617 618 619
  * 'mkName' generates a capturable name.

Names constructed using @newName@ and @mkName@ may be used in bindings
(such as @let x = ...@ or @\x -> ...@), but names constructed using
@lookupValueName@, @lookupTypeName@, @'f@, @''T@ may not.
-}
620
data Name = Name OccName NameFlavour deriving (Typeable, Data)
621 622

data NameFlavour
aavogt's avatar
aavogt committed
623 624 625 626 627 628
  = NameS           -- ^ An unqualified name; dynamically bound
  | NameQ ModName   -- ^ A qualified name; dynamically bound
  | NameU Int#      -- ^ A unique local name
  | NameL Int#      -- ^ Local name bound outside of the TH AST
  | NameG NameSpace PkgName ModName -- ^ Global name bound outside of the TH AST:
                -- An original name (occurrences only, not binders)
Jan Stolarek's avatar
Jan Stolarek committed
629
		-- Need the namespace too to be sure which
630
		-- thing we are naming
631 632
  deriving ( Typeable )

aavogt's avatar
aavogt committed
633
-- |
634 635 636 637 638 639 640
-- Although the NameFlavour type is abstract, the Data instance is not. The reason for this
-- is that currently we use Data to serialize values in annotations, and in order for that to
-- work for Template Haskell names introduced via the 'x syntax we need gunfold on NameFlavour
-- to work. Bleh!
--
-- The long term solution to this is to use the binary package for annotation serialization and
-- then remove this instance. However, to do _that_ we need to wait on binary to become stable, since
Gabor Greif's avatar
Gabor Greif committed
641
-- boot libraries cannot be upgraded separately from GHC itself.
642 643
--
-- This instance cannot be derived automatically due to bug #2701
644
instance Data NameFlavour where
645 646 647 648 649 650 651 652 653 654 655 656
     gfoldl _ z NameS          = z NameS
     gfoldl k z (NameQ mn)     = z NameQ `k` mn
     gfoldl k z (NameU i)      = z (\(I# i') -> NameU i') `k` (I# i)
     gfoldl k z (NameL i)      = z (\(I# i') -> NameL i') `k` (I# i)
     gfoldl k z (NameG ns p m) = z NameG `k` ns `k` p `k` m
     gunfold k z c = case constrIndex c of
         1 -> z NameS
         2 -> k $ z NameQ
         3 -> k $ z (\(I# i) -> NameU i)
         4 -> k $ z (\(I# i) -> NameL i)
         5 -> k $ k $ k $ z NameG
         _ -> error "gunfold: NameFlavour"
657 658 659 660 661 662 663
     toConstr NameS = con_NameS
     toConstr (NameQ _) = con_NameQ
     toConstr (NameU _) = con_NameU
     toConstr (NameL _) = con_NameL
     toConstr (NameG _ _ _) = con_NameG
     dataTypeOf _ = ty_NameFlavour

Ross Paterson's avatar
Ross Paterson committed
664 665 666 667 668 669
con_NameS, con_NameQ, con_NameU, con_NameL, con_NameG :: Data.Constr
con_NameS = mkConstr ty_NameFlavour "NameS" [] Data.Prefix
con_NameQ = mkConstr ty_NameFlavour "NameQ" [] Data.Prefix
con_NameU = mkConstr ty_NameFlavour "NameU" [] Data.Prefix
con_NameL = mkConstr ty_NameFlavour "NameL" [] Data.Prefix
con_NameG = mkConstr ty_NameFlavour "NameG" [] Data.Prefix
Ian Lynagh's avatar
Ian Lynagh committed
670

Ross Paterson's avatar
Ross Paterson committed
671
ty_NameFlavour :: Data.DataType
672 673 674
ty_NameFlavour = mkDataType "Language.Haskell.TH.Syntax.NameFlavour"
                            [con_NameS, con_NameQ, con_NameU,
                             con_NameL, con_NameG]
675

aavogt's avatar
aavogt committed
676
data NameSpace = VarName	-- ^ Variables
Jan Stolarek's avatar
Jan Stolarek committed
677
	       | DataName	-- ^ Data constructors
aavogt's avatar
aavogt committed
678
	       | TcClsName	-- ^ Type constructors and classes; Haskell has them
679
				-- in the same name space for now.
680
	       deriving( Eq, Ord, Data, Typeable )
681 682 683

type Uniq = Int

684
-- | The name without its module prefix
685 686 687
nameBase :: Name -> String
nameBase (Name occ _) = occString occ

688
-- | Module prefix of a name, if it exists
689
nameModule :: Name -> Maybe String
Ian Lynagh's avatar
Ian Lynagh committed
690
nameModule (Name _ (NameQ m))     = Just (modString m)
691
nameModule (Name _ (NameG _ _ m)) = Just (modString m)
Ian Lynagh's avatar
Ian Lynagh committed
692
nameModule _                      = Nothing
693

Jan Stolarek's avatar
Jan Stolarek committed
694
{- |
695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717
Generate a capturable name. Occurrences of such names will be
resolved according to the Haskell scoping rules at the occurrence
site.

For example:

> f = [| pi + $(varE (mkName "pi")) |]
> ...
> g = let pi = 3 in $f

In this case, @g@ is desugared to

> g = Prelude.pi + 3

Note that @mkName@ may be used with qualified names:

> mkName "Prelude.pi"

See also 'Language.Haskell.TH.Lib.dyn' for a useful combinator. The above example could
be rewritten using 'dyn' as

> f = [| pi + $(dyn "pi") |]
-}
718
mkName :: String -> Name
719
-- The string can have a '.', thus "Foo.baz",
720 721 722 723 724
-- giving a dynamically-bound qualified name,
-- in which case we want to generate a NameQ
--
-- Parse the string to see if it has a "." in it
-- so we know whether to generate a qualified or unqualified name
Jan Stolarek's avatar
Jan Stolarek committed
725
-- It's a bit tricky because we need to parse
aavogt's avatar
aavogt committed
726 727 728
--
-- > Foo.Baz.x   as    Qual Foo.Baz x
--
729 730 731 732 733
-- So we parse it from back to front
mkName str
  = split [] (reverse str)
  where
    split occ []        = Name (mkOccName occ) NameS
Jan Stolarek's avatar
Jan Stolarek committed
734
    split occ ('.':rev)	| not (null occ),
735 736 737 738 739 740 741 742
			  not (null rev), head rev /= '.'
			= Name (mkOccName occ) (NameQ (mkModName (reverse rev)))
	-- The 'not (null occ)' guard ensures that
	-- 	mkName "&." = Name "&." NameS
	-- The 'rev' guards ensure that
	--	mkName ".&" = Name ".&" NameS
	--	mkName "Data.Bits..&" = Name ".&" (NameQ "Data.Bits")
	-- This rather bizarre case actually happened; (.&.) is in Data.Bits
743
    split occ (c:rev)   = split (c:occ) rev
744

aavogt's avatar
aavogt committed
745 746
-- | Only used internally
mkNameU :: String -> Uniq -> Name
747 748
mkNameU s (I# u) = Name (mkOccName s) (NameU u)

aavogt's avatar
aavogt committed
749 750
-- | Only used internally
mkNameL :: String -> Uniq -> Name
751 752
mkNameL s (I# u) = Name (mkOccName s) (NameL u)

aavogt's avatar
aavogt committed
753 754 755
-- | Used for 'x etc, but not available to the programmer
mkNameG :: NameSpace -> String -> String -> String -> Name
mkNameG ns pkg modu occ
Ian Lynagh's avatar
Ian Lynagh committed
756
  = Name (mkOccName occ) (NameG ns (mkPkgName pkg) (mkModName modu))
757

758
mkNameG_v, mkNameG_tc, mkNameG_d :: String -> String -> String -> Name
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773
mkNameG_v  = mkNameG VarName
mkNameG_tc = mkNameG TcClsName
mkNameG_d  = mkNameG DataName

instance Eq Name where
  v1 == v2 = cmpEq (v1 `compare` v2)

instance Ord Name where
  (Name o1 f1) `compare` (Name o2 f2) = (f1 `compare` f2)   `thenCmp`
				        (o1 `compare` o2)

instance Eq NameFlavour where
  f1 == f2 = cmpEq (f1 `compare` f2)

instance Ord NameFlavour where
774
	-- NameS < NameQ < NameU < NameL < NameG
775
  NameS `compare` NameS = EQ
Ian Lynagh's avatar
Ian Lynagh committed
776
  NameS `compare` _     = LT
777

778 779
  (NameQ _)  `compare` NameS      = GT
  (NameQ m1) `compare` (NameQ m2) = m1 `compare` m2
Ian Lynagh's avatar
Ian Lynagh committed
780
  (NameQ _)  `compare` _          = LT
781 782 783

  (NameU _)  `compare` NameS      = GT
  (NameU _)  `compare` (NameQ _)  = GT
784 785 786
  (NameU u1) `compare` (NameU u2) | isTrue# (u1  <# u2) = LT
				  | isTrue# (u1 ==# u2) = EQ
				  | otherwise           = GT
Ian Lynagh's avatar
Ian Lynagh committed
787
  (NameU _)  `compare` _     = LT
788

789 790 791
  (NameL _)  `compare` NameS      = GT
  (NameL _)  `compare` (NameQ _)  = GT
  (NameL _)  `compare` (NameU _)  = GT
792 793 794
  (NameL u1) `compare` (NameL u2) | isTrue# (u1  <# u2) = LT
				  | isTrue# (u1 ==# u2) = EQ
				  | otherwise           = GT
Ian Lynagh's avatar
Ian Lynagh committed
795
  (NameL _)  `compare` _          = LT
796

797 798
  (NameG ns1 p1 m1) `compare` (NameG ns2 p2 m2) = (ns1 `compare` ns2) `thenCmp`
                                            (p1 `compare` p2) `thenCmp`
799
					    (m1 `compare` m2)
Ian Lynagh's avatar
Ian Lynagh committed
800
  (NameG _ _ _)    `compare` _ = GT
801

Ian Lynagh's avatar
Ian Lynagh committed
802 803 804 805 806 807 808 809 810 811 812 813 814 815 816
data NameIs = Alone | Applied | Infix

showName :: Name -> String
showName = showName' Alone

showName' :: NameIs -> Name -> String
showName' ni nm
 = case ni of
       Alone        -> nms
       Applied
        | pnam      -> nms
        | otherwise -> "(" ++ nms ++ ")"
       Infix
        | pnam      -> "`" ++ nms ++ "`"
        | otherwise -> nms
817
    where
818 819 820 821 822
	-- For now, we make the NameQ and NameG print the same, even though
	-- NameQ is a qualified name (so what it means depends on what the
	-- current scope is), and NameG is an original name (so its meaning
	-- should be independent of what's in scope.
	-- We may well want to distinguish them in the end.
823 824
	-- Ditto NameU and NameL
        nms = case nm of
Ian Lynagh's avatar
Ian Lynagh committed
825 826 827 828 829
                    Name occ NameS         -> occString occ
                    Name occ (NameQ m)     -> modString m ++ "." ++ occString occ
                    Name occ (NameG _ _ m) -> modString m ++ "." ++ occString occ
                    Name occ (NameU u)     -> occString occ ++ "_" ++ show (I# u)
                    Name occ (NameL u)     -> occString occ ++ "_" ++ show (I# u)
830 831 832

        pnam = classify nms

Ian Lynagh's avatar
Ian Lynagh committed
833 834
        -- True if we are function style, e.g. f, [], (,)
        -- False if we are operator style, e.g. +, :+
835
        classify "" = False -- shouldn't happen; . operator is handled below
Ian Lynagh's avatar
Ian Lynagh committed
836
        classify (x:xs) | isAlpha x || (x `elem` "_[]()") =
837 838 839 840
                            case dropWhile (/='.') xs of
                                  (_:xs') -> classify xs'
                                  []      -> True
                        | otherwise = False
841

842
instance Show Name where
Ian Lynagh's avatar
Ian Lynagh committed
843
  show = showName
844

845
-- Tuple data and type constructors
846 847 848 849
-- | Tuple data constructor
tupleDataName :: Int -> Name
-- | Tuple type constructor
tupleTypeName :: Int -> Name
850

851
tupleDataName 0 = mk_tup_name 0 DataName
852
tupleDataName 1 = error "tupleDataName 1"
853
tupleDataName n = mk_tup_name (n-1) DataName
854

855
tupleTypeName 0 = mk_tup_name 0 TcClsName
856
tupleTypeName 1 = error "tupleTypeName 1"
857
tupleTypeName n = mk_tup_name (n-1) TcClsName
858

Ian Lynagh's avatar
Ian Lynagh committed
859
mk_tup_name :: Int -> NameSpace -> Name
860
mk_tup_name n_commas space
Ian Lynagh's avatar
Ian Lynagh committed
861
  = Name occ (NameG space (mkPkgName "ghc-prim") tup_mod)
862 863
  where
    occ = mkOccName ('(' : replicate n_commas ',' ++ ")")
Ian Lynagh's avatar
Ian Lynagh committed
864
    tup_mod = mkModName "GHC.Tuple"
865

866
-- Unboxed tuple data and type constructors
867 868 869 870
-- | Unboxed tuple data constructor
unboxedTupleDataName :: Int -> Name
-- | Unboxed tuple type constructor
unboxedTupleTypeName :: Int -> Name
871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886

unboxedTupleDataName 0 = error "unboxedTupleDataName 0"
unboxedTupleDataName 1 = error "unboxedTupleDataName 1"
unboxedTupleDataName n = mk_unboxed_tup_name (n-1) DataName

unboxedTupleTypeName 0 = error "unboxedTupleTypeName 0"
unboxedTupleTypeName 1 = error "unboxedTupleTypeName 1"
unboxedTupleTypeName n = mk_unboxed_tup_name (n-1) TcClsName

mk_unboxed_tup_name :: Int -> NameSpace -> Name
mk_unboxed_tup_name n_commas space
  = Name occ (NameG space (mkPkgName "ghc-prim") tup_mod)
  where
    occ = mkOccName ("(#" ++ replicate n_commas ',' ++ "#)")
    tup_mod = mkModName "GHC.Tuple"

887

888

889 890 891 892 893 894 895 896 897 898 899
-----------------------------------------------------
--		Locations
-----------------------------------------------------

data Loc
  = Loc { loc_filename :: String
	, loc_package  :: String
	, loc_module   :: String
	, loc_start    :: CharPos
	, loc_end      :: CharPos }

900
type CharPos = (Int, Int)	-- ^ Line and character position
901

902

903 904 905 906 907 908
-----------------------------------------------------
--
--	The Info returned by reification
--
-----------------------------------------------------

aavogt's avatar
aavogt committed
909 910
-- | Obtained from 'reify' in the 'Q' Monad.
data Info
Jan Stolarek's avatar
Jan Stolarek committed
911
  =
912
  -- | A class, with a list of its visible instances
Jan Stolarek's avatar
Jan Stolarek committed
913
  ClassI
914 915
      Dec
      [InstanceDec]
Jan Stolarek's avatar
Jan Stolarek committed
916

917
  -- | A class method
918
  | ClassOpI
919 920 921 922
       Name
       Type
       ParentName
       Fixity
Jan Stolarek's avatar
Jan Stolarek committed
923

924
  -- | A \"plain\" type constructor. \"Fancier\" type constructors are returned using 'PrimTyConI' or 'FamilyI' as appropriate
Jan Stolarek's avatar
Jan Stolarek committed
925
  | TyConI
926 927
        Dec

928 929
  -- | A type or data family, with a list of its visible instances. A closed
  -- type family is returned with 0 instances.
Jan Stolarek's avatar
Jan Stolarek committed
930
  | FamilyI
931 932
        Dec
        [InstanceDec]
Jan Stolarek's avatar
Jan Stolarek committed
933

934
  -- | A \"primitive\" type constructor, which can't be expressed with a 'Dec'. Examples: @(->)@, @Int#@.
Jan Stolarek's avatar
Jan Stolarek committed
935
  | PrimTyConI
936 937 938
       Name
       Arity
       Unlifted
Jan Stolarek's avatar
Jan Stolarek committed
939

940
  -- | A data constructor
Jan Stolarek's avatar
Jan Stolarek committed
941
  | DataConI
942 943 944 945
       Name
       Type
       ParentName
       Fixity
946

Jan Stolarek's avatar
Jan Stolarek committed
947
  {- |
948
  A \"value\" variable (as opposed to a type variable, see 'TyVarI').
Jan Stolarek's avatar
Jan Stolarek committed
949 950 951

  The @Maybe Dec@ field contains @Just@ the declaration which
  defined the variable -- including the RHS of the declaration --
952 953 954 955 956
  or else @Nothing@, in the case where the RHS is unavailable to
  the compiler. At present, this value is _always_ @Nothing@:
  returning the RHS has not yet been implemented because of
  lack of interest.
  -}
Jan Stolarek's avatar
Jan Stolarek committed
957
  | VarI
958 959 960 961
       Name
       Type
       (Maybe Dec)
       Fixity
962

Jan Stolarek's avatar
Jan Stolarek committed
963
  {- |
964
  A type variable.
Jan Stolarek's avatar
Jan Stolarek committed
965

966 967 968 969
  The @Type@ field contains the type which underlies the variable.
  At present, this is always @'VarT' theName@, but future changes
  may permit refinement of this.
  -}
970 971 972
  | TyVarI 	-- Scoped type variable
	Name
	Type	-- What it is bound to
973
  deriving( Show, Data, Typeable )
974

Jan Stolarek's avatar
Jan Stolarek committed
975
{- |
976 977 978 979 980 981 982 983 984 985 986
In 'ClassOpI' and 'DataConI', name of the parent class or type
-}
type ParentName = Name

-- | In 'PrimTyConI', arity of the type constructor
type Arity = Int

-- | In 'PrimTyConI', is the type constructor unlifted?
type Unlifted = Bool

-- | 'InstanceDec' desribes a single instance of a class or type function.
987
-- It is just a 'Dec', but guaranteed to be one of the following:
988 989 990 991 992 993
--
--   * 'InstanceD' (with empty @['Dec']@)
--
--   * 'DataInstD' or 'NewtypeInstD' (with empty derived @['Name']@)
--
--   * 'TySynInstD'
994
type InstanceDec = Dec
995

996 997 998 999
data Fixity          = Fixity Int FixityDirection
    deriving( Eq, Show, Data, Typeable )
data FixityDirection = InfixL | InfixR | InfixN
    deriving( Eq, Show, Data, Typeable )
1000

1001
-- | Highest allowed operator precedence for 'Fixity' constructor (answer: 9)
1002
maxPrecedence :: Int
1003
maxPrecedence = (9::Int)
1004

1005
-- | Default fixity: @infixl 9@
1006
defaultFixity :: Fixity
1007 1008 1009
defaultFixity = Fixity maxPrecedence InfixL


1010
{-
1011 1012
Note [Unresolved infix]
~~~~~~~~~~~~~~~~~~~~~~~
1013 1014
-}
{- $infix #infix#
1015 1016 1017
When implementing antiquotation for quasiquoters, one often wants
to parse strings into expressions:

1018
> parse :: String -> Maybe Exp
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072

But how should we parse @a + b * c@? If we don't know the fixities of
@+@ and @*@, we don't know whether to parse it as @a + (b * c)@ or @(a
+ b) * c@.

In cases like this, use 'UInfixE' or 'UInfixP', which stand for
\"unresolved infix expression\" and \"unresolved infix pattern\". When
the compiler is given a splice containing a tree of @UInfixE@
applications such as

> UInfixE
>   (UInfixE e1 op1 e2)
>   op2
>   (UInfixE e3 op3 e4)

it will look up and the fixities of th