Syntax.hs 45 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
56
  qReifyRoles     :: Name -> m [Role]
57

58
  qLocation :: m Loc
59 60

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

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

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

67 68
-----------------------------------------------------
--	The IO instance of Quasi
Jan Stolarek's avatar
Jan Stolarek committed
69
--
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
--  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)

86
  qLookupName _ _     = badIO "lookupName"
87
  qReify _            = badIO "reify"
88
  qReifyInstances _ _ = badIO "classInstances"
89
  qReifyRoles _       = badIO "reifyRoles"
90 91
  qLocation    	      = badIO "currentLocation"
  qRecover _ _ 	      = badIO "recover" -- Maybe we could fix this?
GregWeber's avatar
GregWeber committed
92
  qAddDependentFile _ = badIO "addDependentFile"
93
  qAddTopDecls _      = badIO "addTopDecls"
94 95

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

97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
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 }

115 116 117 118 119
-- \"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
120
-- splices by running them in 'IO'.
121 122 123 124 125
--
-- 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'.
126 127 128 129 130 131 132
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)
133
  fail s     = report True s >> Q (fail "Q monad failure")
134

135 136 137
instance Functor Q where
  fmap f (Q x) = Q (fmap f x)

Jan Stolarek's avatar
Jan Stolarek committed
138 139 140
instance Applicative Q where
  pure x = Q (pure x)
  Q f <*> Q x = Q (f <*> x)
141

gmainland's avatar
gmainland committed
142 143 144 145 146 147 148 149
-----------------------------------------------------
--
--		The TExp type
--
-----------------------------------------------------

newtype TExp a = TExp { unType :: Q Exp }

150 151
----------------------------------------------------
-- Packaged versions for the programmer, hiding the Quasi-ness
152

Jan Stolarek's avatar
Jan Stolarek committed
153 154
{- |
Generate a fresh name, which cannot be captured.
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186

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@.
-}
187 188 189
newName :: String -> Q Name
newName s = Q (qNewName s)

Jan Stolarek's avatar
Jan Stolarek committed
190
-- | Report an error (True) or warning (False),
191
-- but carry on; use 'fail' to stop.
192 193
report  :: Bool -> String -> Q ()
report b s = Q (qReport b s)
194
{-# DEPRECATED report "Use reportError or reportWarning instead" #-} -- deprecated in 7.6
195 196 197 198 199 200 201 202

-- | 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
203

204 205 206
-- | 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
207
        -> Q a
208 209
recover (Q r) (Q m) = Q (qRecover r m)

210 211 212 213 214
-- 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)

215 216
-- | 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)
217
lookupTypeName  s = Q (qLookupName True s)
218 219 220

-- | 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)
221 222
lookupValueName s = Q (qLookupName False s)

223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
{-
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
239
The returned name cannot be \"captured\".
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
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
255
> g = $( [| let f = "local" in
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
>            $(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'.
-}
292 293 294
reify :: Name -> Q Info
reify v = Q (qReify v)

Jan Stolarek's avatar
Jan Stolarek committed
295
{- | @reifyInstances nm tys@ returns a list of visible instances of @nm tys@. That is,
296 297 298 299 300
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]
301
reifyInstances cls tys = Q (qReifyInstances cls tys)
302

303 304 305 306 307 308 309
{- | @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)

310
-- | Is the list of instances returned by 'reifyInstances' nonempty?
311 312 313
isInstance :: Name -> [Type] -> Q Bool
isInstance nm tys = do { decs <- reifyInstances nm tys
                       ; return (not (null decs)) }
314

315
-- | The location at which this computation is spliced.
316 317
location :: Q Loc
location = Q qLocation
318

dons's avatar
dons committed
319
-- |The 'runIO' function lets you run an I\/O computation in the 'Q' monad.
Jan Stolarek's avatar
Jan Stolarek committed
320 321
-- 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.
322
--
Jan Stolarek's avatar
Jan Stolarek committed
323
-- Note: for various murky reasons, stdout and stderr handles are not
324 325
-- necesarily flushed when the  compiler finishes running, so you should
-- flush them yourself.
326 327 328
runIO :: IO a -> Q a
runIO m = Q (qRunIO m)

GregWeber's avatar
GregWeber committed
329 330 331 332 333 334 335
-- | 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)

336 337 338 339 340
-- | 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)

341
instance Quasi Q where
GregWeber's avatar
GregWeber committed
342 343
  qNewName  	    = newName
  qReport   	    = report
Jan Stolarek's avatar
Jan Stolarek committed
344
  qRecover  	    = recover
GregWeber's avatar
GregWeber committed
345 346
  qReify    	    = reify
  qReifyInstances   = reifyInstances
347
  qReifyRoles       = reifyRoles
GregWeber's avatar
GregWeber committed
348 349 350 351
  qLookupName       = lookupName
  qLocation 	    = location
  qRunIO    	    = runIO
  qAddDependentFile = addDependentFile
352
  qAddTopDecls      = addTopDecls
353 354 355 356


----------------------------------------------------
-- The following operations are used solely in DsMeta when desugaring brackets
357
-- They are not necessary for the user, who can use ordinary return and (>>=) etc
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376

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
377

378 379 380 381 382 383 384 385 386 387 388 389 390
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)

391 392 393 394 395 396 397 398
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)

399 400 401
instance Lift a => Lift [a] where
  lift xs = do { xs' <- mapM lift xs; return (ListE xs') }

402 403 404 405
liftString :: String -> Q Exp
-- Used in TcExpr to short-circuit the lifting for strings
liftString s = return (LitE (StringL s))

406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
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]

433 434 435 436
-- 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
437
--     which happens to be the way the type checker
438 439 440 441 442
--     creates it.
{-# RULES "TH:liftString" lift = \s -> return (LitE (StringL s)) #-}


trueName, falseName :: Name
Ian Lynagh's avatar
Ian Lynagh committed
443 444
trueName  = mkNameG DataName "ghc-prim" "GHC.Types" "True"
falseName = mkNameG DataName "ghc-prim" "GHC.Types" "False"
445

446 447 448 449 450 451 452 453
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"

454 455

-----------------------------------------------------
Jan Stolarek's avatar
Jan Stolarek committed
456
--		Names and uniques
457 458
-----------------------------------------------------

459 460 461 462 463 464 465 466 467
newtype ModName = ModName String	-- Module name
 deriving (Eq,Ord,Typeable,Data)

newtype PkgName = PkgName String	-- package name
 deriving (Eq,Ord,Typeable,Data)

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

468
mkModName :: String -> ModName
469
mkModName s = ModName s
470 471

modString :: ModName -> String
472
modString (ModName m) = m
473

474 475

mkPkgName :: String -> PkgName
476
mkPkgName s = PkgName s
477 478

pkgString :: PkgName -> String
479
pkgString (PkgName m) = m
480 481


482 483 484 485 486
-----------------------------------------------------
--		OccName
-----------------------------------------------------

mkOccName :: String -> OccName
487
mkOccName s = OccName s
488 489

occString :: OccName -> String
490
occString (OccName occ) = occ
491 492 493 494 495


-----------------------------------------------------
--		 Names
-----------------------------------------------------
Jan Stolarek's avatar
Jan Stolarek committed
496
--
aavogt's avatar
aavogt committed
497
-- For "global" names ('NameG') we need a totally unique name,
498 499
-- so we must include the name-space of the thing
--
aavogt's avatar
aavogt committed
500
-- For unique-numbered things ('NameU'), we've got a unique reference
501 502
-- anyway, so no need for name space
--
aavogt's avatar
aavogt committed
503
-- For dynamically bound thing ('NameS') we probably want them to
504 505
-- in a context-dependent way, so again we don't want the name
-- space.  For example:
aavogt's avatar
aavogt committed
506 507 508
--
-- > let v = mkName "T" in [| data $v = $v |]
--
509
-- Here we use the same Name for both type constructor and data constructor
aavogt's avatar
aavogt committed
510 511 512 513 514 515 516 517 518 519
--
--
-- 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
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544

{- $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
545
which avoids name capture as desired.
546 547 548 549 550 551 552 553 554 555 556 557

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
558 559
  * 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@
560 561
    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
562 563

  * 'lookupValueName' and 'lookupTypeName' are similar to @'f@ and
564 565 566 567 568 569
     @''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
570

571 572 573 574 575 576
  * '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.
-}
577
data Name = Name OccName NameFlavour deriving (Typeable, Data)
578 579

data NameFlavour
aavogt's avatar
aavogt committed
580 581 582 583 584 585
  = 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
586
		-- Need the namespace too to be sure which
587
		-- thing we are naming
588 589
  deriving ( Typeable )

aavogt's avatar
aavogt committed
590
-- |
591 592 593 594 595 596 597
-- 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
598
-- boot libraries cannot be upgraded separately from GHC itself.
599 600
--
-- This instance cannot be derived automatically due to bug #2701
601
instance Data NameFlavour where
602 603 604 605 606 607 608 609 610 611 612 613
     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"
614 615 616 617 618 619 620
     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
621 622 623 624 625 626
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
627

Ross Paterson's avatar
Ross Paterson committed
628
ty_NameFlavour :: Data.DataType
629 630 631
ty_NameFlavour = mkDataType "Language.Haskell.TH.Syntax.NameFlavour"
                            [con_NameS, con_NameQ, con_NameU,
                             con_NameL, con_NameG]
632

aavogt's avatar
aavogt committed
633
data NameSpace = VarName	-- ^ Variables
Jan Stolarek's avatar
Jan Stolarek committed
634
	       | DataName	-- ^ Data constructors
aavogt's avatar
aavogt committed
635
	       | TcClsName	-- ^ Type constructors and classes; Haskell has them
636
				-- in the same name space for now.
637
	       deriving( Eq, Ord, Data, Typeable )
638 639 640

type Uniq = Int

641
-- | The name without its module prefix
642 643 644
nameBase :: Name -> String
nameBase (Name occ _) = occString occ

645
-- | Module prefix of a name, if it exists
646
nameModule :: Name -> Maybe String
Ian Lynagh's avatar
Ian Lynagh committed
647
nameModule (Name _ (NameQ m))     = Just (modString m)
648
nameModule (Name _ (NameG _ _ m)) = Just (modString m)
Ian Lynagh's avatar
Ian Lynagh committed
649
nameModule _                      = Nothing
650

Jan Stolarek's avatar
Jan Stolarek committed
651
{- |
652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674
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") |]
-}
675
mkName :: String -> Name
676
-- The string can have a '.', thus "Foo.baz",
677 678 679 680 681
-- 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
682
-- It's a bit tricky because we need to parse
aavogt's avatar
aavogt committed
683 684 685
--
-- > Foo.Baz.x   as    Qual Foo.Baz x
--
686 687 688 689 690
-- 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
691
    split occ ('.':rev)	| not (null occ),
692 693 694 695 696 697 698 699
			  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
700
    split occ (c:rev)   = split (c:occ) rev
701

aavogt's avatar
aavogt committed
702 703
-- | Only used internally
mkNameU :: String -> Uniq -> Name
704 705
mkNameU s (I# u) = Name (mkOccName s) (NameU u)

aavogt's avatar
aavogt committed
706 707
-- | Only used internally
mkNameL :: String -> Uniq -> Name
708 709
mkNameL s (I# u) = Name (mkOccName s) (NameL u)

aavogt's avatar
aavogt committed
710 711 712
-- | 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
713
  = Name (mkOccName occ) (NameG ns (mkPkgName pkg) (mkModName modu))
714

715
mkNameG_v, mkNameG_tc, mkNameG_d :: String -> String -> String -> Name
716 717 718 719 720 721 722 723 724 725 726 727 728 729 730
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
731
	-- NameS < NameQ < NameU < NameL < NameG
732
  NameS `compare` NameS = EQ
Ian Lynagh's avatar
Ian Lynagh committed
733
  NameS `compare` _     = LT
734

735 736
  (NameQ _)  `compare` NameS      = GT
  (NameQ m1) `compare` (NameQ m2) = m1 `compare` m2
Ian Lynagh's avatar
Ian Lynagh committed
737
  (NameQ _)  `compare` _          = LT
738 739 740

  (NameU _)  `compare` NameS      = GT
  (NameU _)  `compare` (NameQ _)  = GT
741 742 743
  (NameU u1) `compare` (NameU u2) | isTrue# (u1  <# u2) = LT
				  | isTrue# (u1 ==# u2) = EQ
				  | otherwise           = GT
Ian Lynagh's avatar
Ian Lynagh committed
744
  (NameU _)  `compare` _     = LT
745

746 747 748
  (NameL _)  `compare` NameS      = GT
  (NameL _)  `compare` (NameQ _)  = GT
  (NameL _)  `compare` (NameU _)  = GT
749 750 751
  (NameL u1) `compare` (NameL u2) | isTrue# (u1  <# u2) = LT
				  | isTrue# (u1 ==# u2) = EQ
				  | otherwise           = GT
Ian Lynagh's avatar
Ian Lynagh committed
752
  (NameL _)  `compare` _          = LT
753

754 755
  (NameG ns1 p1 m1) `compare` (NameG ns2 p2 m2) = (ns1 `compare` ns2) `thenCmp`
                                            (p1 `compare` p2) `thenCmp`
756
					    (m1 `compare` m2)
Ian Lynagh's avatar
Ian Lynagh committed
757
  (NameG _ _ _)    `compare` _ = GT
758

Ian Lynagh's avatar
Ian Lynagh committed
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773
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
774
    where
775 776 777 778 779
	-- 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.
780 781
	-- Ditto NameU and NameL
        nms = case nm of
Ian Lynagh's avatar
Ian Lynagh committed
782 783 784 785 786
                    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)
787 788 789

        pnam = classify nms

Ian Lynagh's avatar
Ian Lynagh committed
790 791
        -- True if we are function style, e.g. f, [], (,)
        -- False if we are operator style, e.g. +, :+
792
        classify "" = False -- shouldn't happen; . operator is handled below
Ian Lynagh's avatar
Ian Lynagh committed
793
        classify (x:xs) | isAlpha x || (x `elem` "_[]()") =
794 795 796 797
                            case dropWhile (/='.') xs of
                                  (_:xs') -> classify xs'
                                  []      -> True
                        | otherwise = False
798

799
instance Show Name where
Ian Lynagh's avatar
Ian Lynagh committed
800
  show = showName
801

802
-- Tuple data and type constructors
803 804 805 806
-- | Tuple data constructor
tupleDataName :: Int -> Name
-- | Tuple type constructor
tupleTypeName :: Int -> Name
807

808
tupleDataName 0 = mk_tup_name 0 DataName
809
tupleDataName 1 = error "tupleDataName 1"
810
tupleDataName n = mk_tup_name (n-1) DataName
811

812
tupleTypeName 0 = mk_tup_name 0 TcClsName
813
tupleTypeName 1 = error "tupleTypeName 1"
814
tupleTypeName n = mk_tup_name (n-1) TcClsName
815

Ian Lynagh's avatar
Ian Lynagh committed
816
mk_tup_name :: Int -> NameSpace -> Name
817
mk_tup_name n_commas space
Ian Lynagh's avatar
Ian Lynagh committed
818
  = Name occ (NameG space (mkPkgName "ghc-prim") tup_mod)
819 820
  where
    occ = mkOccName ('(' : replicate n_commas ',' ++ ")")
Ian Lynagh's avatar
Ian Lynagh committed
821
    tup_mod = mkModName "GHC.Tuple"
822

823
-- Unboxed tuple data and type constructors
824 825 826 827
-- | Unboxed tuple data constructor
unboxedTupleDataName :: Int -> Name
-- | Unboxed tuple type constructor
unboxedTupleTypeName :: Int -> Name
828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843

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"

844

845

846 847 848 849 850 851 852 853 854 855 856
-----------------------------------------------------
--		Locations
-----------------------------------------------------

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

857
type CharPos = (Int, Int)	-- ^ Line and character position
858

859

860 861 862 863 864 865
-----------------------------------------------------
--
--	The Info returned by reification
--
-----------------------------------------------------

aavogt's avatar
aavogt committed
866 867
-- | Obtained from 'reify' in the 'Q' Monad.
data Info
Jan Stolarek's avatar
Jan Stolarek committed
868
  =
869
  -- | A class, with a list of its visible instances
Jan Stolarek's avatar
Jan Stolarek committed
870
  ClassI
871 872
      Dec
      [InstanceDec]
Jan Stolarek's avatar
Jan Stolarek committed
873

874
  -- | A class method
875
  | ClassOpI
876 877 878 879
       Name
       Type
       ParentName
       Fixity
Jan Stolarek's avatar
Jan Stolarek committed
880

881
  -- | A \"plain\" type constructor. \"Fancier\" type constructors are returned using 'PrimTyConI' or 'FamilyI' as appropriate
Jan Stolarek's avatar
Jan Stolarek committed
882
  | TyConI
883 884
        Dec

885 886
  -- | 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
887
  | FamilyI
888 889
        Dec
        [InstanceDec]
Jan Stolarek's avatar
Jan Stolarek committed
890

891
  -- | A \"primitive\" type constructor, which can't be expressed with a 'Dec'. Examples: @(->)@, @Int#@.
Jan Stolarek's avatar
Jan Stolarek committed
892
  | PrimTyConI
893 894 895
       Name
       Arity
       Unlifted
Jan Stolarek's avatar
Jan Stolarek committed
896

897
  -- | A data constructor
Jan Stolarek's avatar
Jan Stolarek committed
898
  | DataConI
899 900 901 902
       Name
       Type
       ParentName
       Fixity
903

Jan Stolarek's avatar
Jan Stolarek committed
904
  {- |
905
  A \"value\" variable (as opposed to a type variable, see 'TyVarI').
Jan Stolarek's avatar
Jan Stolarek committed
906 907 908

  The @Maybe Dec@ field contains @Just@ the declaration which
  defined the variable -- including the RHS of the declaration --
909 910 911 912 913
  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
914
  | VarI
915 916 917 918
       Name
       Type
       (Maybe Dec)
       Fixity
919

Jan Stolarek's avatar
Jan Stolarek committed
920
  {- |
921
  A type variable.
Jan Stolarek's avatar
Jan Stolarek committed
922

923 924 925 926
  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.
  -}
927 928 929
  | TyVarI 	-- Scoped type variable
	Name
	Type	-- What it is bound to
930
  deriving( Show, Data, Typeable )
931

Jan Stolarek's avatar
Jan Stolarek committed
932
{- |
933 934 935 936 937 938 939 940 941 942 943
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.
944
-- It is just a 'Dec', but guaranteed to be one of the following:
945 946 947 948 949 950
--
--   * 'InstanceD' (with empty @['Dec']@)
--
--   * 'DataInstD' or 'NewtypeInstD' (with empty derived @['Name']@)
--
--   * 'TySynInstD'
951
type InstanceDec = Dec
952

953 954 955 956
data Fixity          = Fixity Int FixityDirection
    deriving( Eq, Show, Data, Typeable )
data FixityDirection = InfixL | InfixR | InfixN
    deriving( Eq, Show, Data, Typeable )
957

958
-- | Highest allowed operator precedence for 'Fixity' constructor (answer: 9)
959
maxPrecedence :: Int
960
maxPrecedence = (9::Int)
961

962
-- | Default fixity: @infixl 9@
963
defaultFixity :: Fixity
964 965 966
defaultFixity = Fixity maxPrecedence InfixL


967
{-
968 969
Note [Unresolved infix]
~~~~~~~~~~~~~~~~~~~~~~~
970 971
-}
{- $infix #infix#
972 973 974
When implementing antiquotation for quasiquoters, one often wants
to parse strings into expressions:

975
> parse :: String -> Maybe Exp
976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029

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 the relevant operators and
reassociate the tree as necessary.

  * trees will not be reassociated across 'ParensE' or 'ParensP',
    which are of use for parsing expressions like

    > (a + b * c) + d * e

  * 'InfixE' and 'InfixP' expressions are never reassociated.

  * The 'UInfixE' constructor doesn't support sections. Sections
    such as @(a *)@ have no ambiguity, so 'InfixE' suffices. For longer
    sections such as @(a + b * c -)@, use an 'InfixE' constructor for the
    outer-most section, and use 'UInfixE' constructors for all
    other operators:

    > InfixE
    >   Just (UInfixE ...a + b * c...)
    >   op
    >   Nothing

    Sections such as @(a + b +)@ and @((a + b) +)@ should be rendered
    into 'Exp's differently:

    > (+ a + b)   ---> InfixE Nothing + (Just $ UInfixE a + b)
    >                    -- will result in a fixity error if (+) is left-infix
    > (+ (a + b)) ---> InfixE Nothing + (Just $ ParensE $ UInfixE a + b)
    >                    -- no fixity errors

  * Quoted expressions such as

    > [| a * b + c |] :: Q Exp
    > [p| a : b : c |] :: Q Pat

    will never contain 'UInfixE', 'UInfixP', 'ParensE', or 'ParensP'
    constructors.

-}

1030 1031 1032 1033 1034 1035
-----------------------------------------------------
--
--	The main syntax data types
--
-----------------------------------------------------

Jan Stolarek's avatar
Jan Stolarek committed
1036 1037
data Lit = CharL Char
         | StringL String
aavogt's avatar
aavogt committed
1038
         | IntegerL Integer     -- ^ Used for overloaded and non-overloaded
1039 1040 1041 1042 1043
                                -- literals. We don't have a good way to
                                -- represent non-overloaded literals at
                                -- the moment. Maybe that doesn't matter?
         | RationalL Rational   -- Ditto
         | IntPrimL Integer
1044
         | WordPrimL Integer
1045 1046
         | FloatPrimL Rational
         | DoublePrimL Rational
reinerp's avatar
reinerp committed
1047
         | StringPrimL [Word8]	-- ^ A primitive C-style string, type Addr#
1048
    deriving( Show, Eq, Data, Typeable )
1049

Jan Stolarek's avatar
Jan Stolarek committed
1050
    -- We could add Int, Float, Double etc, as we do in HsLit,
1051 1052 1053
    -- but that could complicate the
    -- suppposedly-simple TH.Syntax literal type

aavogt's avatar
aavogt committed
1054
-- | Pattern in Haskell given in @{}@
Jan Stolarek's avatar
Jan Stolarek committed
1055
data Pat
aavogt's avatar
aavogt committed
1056 1057 1058
  = LitP Lit                      -- ^ @{ 5 or 'c' }@
  | VarP Name                     -- ^ @{ x }@
  | TupP [Pat]                    -- ^ @{ (p1,p2) }@
1059
  | UnboxedTupP [Pat]             -- ^ @{ (# p1,p2 #) }@
aavogt's avatar
aavogt committed
1060 1061
  | ConP Name [Pat]               -- ^ @data T1 = C1 t1 t2; {C1 p1 p1} = e@
  | InfixP Pat Name Pat           -- ^ @foo ({x :+ y}) = e@
1062 1063
  | UInfixP Pat Name Pat          -- ^ @foo ({x :+ y}) = e@
                                  --
1064
                                  -- See "Language.Haskell.TH.Syntax#infix"