Syntax.hs 48.1 KB
Newer Older
1
{-# LANGUAGE CPP, DeriveDataTypeable, PolymorphicComponents,
2
             RoleAnnotations, DeriveGeneric, FlexibleInstances #-}
3

4 5 6 7 8
-----------------------------------------------------------------------------
-- |
-- 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
9
--
10 11 12 13 14 15 16 17
-- Maintainer  :  libraries@haskell.org
-- Stability   :  experimental
-- Portability :  portable
--
-- Abstract syntax definitions for Template Haskell.
--
-----------------------------------------------------------------------------

18
module Language.Haskell.TH.Syntax where
19

20
import Data.Data (Data(..), Typeable )
21
#if __GLASGOW_HASKELL__ < 709
22
import Control.Applicative( Applicative(..) )
23
#endif
24
import Data.IORef
25
import System.IO.Unsafe ( unsafePerformIO )
26
import Control.Monad (liftM)
27
import System.IO        ( hPutStrLn, stderr )
28
import Data.Char        ( isAlpha, isAlphaNum, isUpper )
29 30 31
import Data.Int
import Data.Word
import Data.Ratio
32
import GHC.Generics     ( Generic )
33 34 35

-----------------------------------------------------
--
36
--              The Quasi class
37 38 39
--
-----------------------------------------------------

40
class Monad m => Quasi m where
41
  qNewName :: String -> m Name
42
        -- ^ Fresh names
43

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

51
        -- Inspect the type-checker's environment
52 53 54 55 56
  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
57
       -- Returns list of matching instance Decs
58 59
       --    (with empty sub-Decs)
       -- Works for classes and type functions
Austin Seipp's avatar
Austin Seipp committed
60 61
  qReifyRoles       :: Name -> m [Role]
  qReifyAnnotations :: Data a => AnnLookup -> m [a]
62
  qReifyModule      :: Module -> m ModuleInfo
63

64
  qLocation :: m Loc
65 66

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

GregWeber's avatar
GregWeber committed
69
  qAddDependentFile :: FilePath -> m ()
70

71 72
  qAddTopDecls :: [Dec] -> m ()

73 74
  qAddModFinalizer :: Q () -> m ()

gmainland's avatar
gmainland committed
75 76 77 78
  qGetQ :: Typeable a => m (Maybe a)

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

79
-----------------------------------------------------
80
--      The IO instance of Quasi
Jan Stolarek's avatar
Jan Stolarek committed
81
--
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
--  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)

98
  qLookupName _ _     = badIO "lookupName"
99
  qReify _            = badIO "reify"
100
  qReifyInstances _ _ = badIO "reifyInstances"
101
  qReifyRoles _       = badIO "reifyRoles"
Austin Seipp's avatar
Austin Seipp committed
102
  qReifyAnnotations _ = badIO "reifyAnnotations"
103
  qReifyModule _      = badIO "reifyModule"
104 105
  qLocation           = badIO "currentLocation"
  qRecover _ _        = badIO "recover" -- Maybe we could fix this?
GregWeber's avatar
GregWeber committed
106
  qAddDependentFile _ = badIO "addDependentFile"
107
  qAddTopDecls _      = badIO "addTopDecls"
108
  qAddModFinalizer _  = badIO "addModFinalizer"
gmainland's avatar
gmainland committed
109 110
  qGetQ               = badIO "getQ"
  qPutQ _             = badIO "putQ"
111 112

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

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

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


-----------------------------------------------------
--
126
--              The Q monad
127 128 129 130 131
--
-----------------------------------------------------

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

132 133 134 135 136
-- \"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
137
-- splices by running them in 'IO'.
138 139 140 141 142
--
-- 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'.
143 144 145 146 147 148 149
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)
150
  fail s     = report True s >> Q (fail "Q monad failure")
151

152 153 154
instance Functor Q where
  fmap f (Q x) = Q (fmap f x)

Jan Stolarek's avatar
Jan Stolarek committed
155 156 157
instance Applicative Q where
  pure x = Q (pure x)
  Q f <*> Q x = Q (f <*> x)
158

gmainland's avatar
gmainland committed
159 160
-----------------------------------------------------
--
161
--              The TExp type
gmainland's avatar
gmainland committed
162 163 164
--
-----------------------------------------------------

165
type role TExp nominal   -- See Note [Role of TExp]
166 167 168 169 170 171 172 173 174
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
175

176 177 178 179 180 181 182 183 184 185 186 187 188
{- Note [Role of TExp]
~~~~~~~~~~~~~~~~~~~~~~
TExp's argument must have a nominal role, not phantom as would
be inferred (Trac #8459).  Consider

  e :: TExp Age
  e = MkAge 3

  foo = $(coerce e) + 4::Int

The splice will evaluate to (MkAge 3) and you can't add that to
4::Int. So you can't coerce a (TExp Age) to a (TExp Int). -}

189 190
----------------------------------------------------
-- Packaged versions for the programmer, hiding the Quasi-ness
191

Jan Stolarek's avatar
Jan Stolarek committed
192 193
{- |
Generate a fresh name, which cannot be captured.
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225

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@.
-}
226 227 228
newName :: String -> Q Name
newName s = Q (qNewName s)

Jan Stolarek's avatar
Jan Stolarek committed
229
-- | Report an error (True) or warning (False),
230
-- but carry on; use 'fail' to stop.
231 232
report  :: Bool -> String -> Q ()
report b s = Q (qReport b s)
233
{-# DEPRECATED report "Use reportError or reportWarning instead" #-} -- deprecated in 7.6
234 235 236 237 238 239 240 241

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

243 244 245
-- | 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
246
        -> Q a
247 248
recover (Q r) (Q m) = Q (qRecover r m)

249 250 251 252 253
-- 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)

254 255
-- | 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)
256
lookupTypeName  s = Q (qLookupName True s)
257 258 259

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

262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
{-
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
278
The returned name cannot be \"captured\".
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
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
294
> g = $( [| let f = "local" in
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
>            $(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'.
-}
331 332 333
reify :: Name -> Q Info
reify v = Q (qReify v)

Jan Stolarek's avatar
Jan Stolarek committed
334
{- | @reifyInstances nm tys@ returns a list of visible instances of @nm tys@. That is,
335 336 337 338 339
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]
340
reifyInstances cls tys = Q (qReifyInstances cls tys)
341

342 343 344 345 346 347 348
{- | @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
349 350 351 352 353 354 355
-- | @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)

356 357 358 359 360 361
-- | @reifyModule mod@ looks up information about module @mod@.  To
-- look up the current module, call this function with the return
-- value of @thisModule@.
reifyModule :: Module -> Q ModuleInfo
reifyModule m = Q (qReifyModule m)

362
-- | Is the list of instances returned by 'reifyInstances' nonempty?
363 364 365
isInstance :: Name -> [Type] -> Q Bool
isInstance nm tys = do { decs <- reifyInstances nm tys
                       ; return (not (null decs)) }
366

367
-- | The location at which this computation is spliced.
368 369
location :: Q Loc
location = Q qLocation
370

dons's avatar
dons committed
371
-- |The 'runIO' function lets you run an I\/O computation in the 'Q' monad.
Jan Stolarek's avatar
Jan Stolarek committed
372 373
-- 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.
374
--
Jan Stolarek's avatar
Jan Stolarek committed
375
-- Note: for various murky reasons, stdout and stderr handles are not
Gabor Greif's avatar
Gabor Greif committed
376
-- necessarily flushed when the compiler finishes running, so you should
377
-- flush them yourself.
378 379 380
runIO :: IO a -> Q a
runIO m = Q (qRunIO m)

GregWeber's avatar
GregWeber committed
381
-- | Record external files that runIO is using (dependent upon).
382 383 384
-- The compiler can then recognize that it should re-compile the Haskell file
-- when an external file changes.
--
GregWeber's avatar
GregWeber committed
385
-- Expects an absolute file path.
386 387 388 389 390 391
--
-- Notes:
--
--   * ghc -M does not know about these dependencies - it does not execute TH.
--
--   * The dependency is based on file content, not a modification time
GregWeber's avatar
GregWeber committed
392 393 394
addDependentFile :: FilePath -> Q ()
addDependentFile fp = Q (qAddDependentFile fp)

395 396 397 398 399
-- | 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)

400 401 402 403 404
-- | 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
405 406 407 408 409 410 411 412
-- | 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)

413
instance Quasi Q where
414 415 416 417
  qNewName          = newName
  qReport           = report
  qRecover          = recover
  qReify            = reify
GregWeber's avatar
GregWeber committed
418
  qReifyInstances   = reifyInstances
419
  qReifyRoles       = reifyRoles
Austin Seipp's avatar
Austin Seipp committed
420
  qReifyAnnotations = reifyAnnotations
421
  qReifyModule      = reifyModule
GregWeber's avatar
GregWeber committed
422
  qLookupName       = lookupName
423 424
  qLocation         = location
  qRunIO            = runIO
GregWeber's avatar
GregWeber committed
425
  qAddDependentFile = addDependentFile
426
  qAddTopDecls      = addTopDecls
427
  qAddModFinalizer  = addModFinalizer
gmainland's avatar
gmainland committed
428 429
  qGetQ             = getQ
  qPutQ             = putQ
430 431 432 433


----------------------------------------------------
-- The following operations are used solely in DsMeta when desugaring brackets
434
-- They are not necessary for the user, who can use ordinary return and (>>=) etc
435 436 437 438 439 440 441 442 443 444 445 446 447

returnQ :: a -> Q a
returnQ = return

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

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


-----------------------------------------------------
--
448
--              The Lift class
449 450 451 452 453
--
-----------------------------------------------------

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

455 456 457 458
instance Lift Integer where
  lift x = return (LitE (IntegerL x))

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

461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
instance Lift Int8 where
  lift x = return (LitE (IntegerL (fromIntegral x)))

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

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

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

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

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

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

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

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

instance Integral a => Lift (Ratio a) where
  lift x = return (LitE (RationalL (toRational x)))

instance Lift Float where
  lift x = return (LitE (RationalL (toRational x)))

instance Lift Double where
  lift x = return (LitE (RationalL (toRational x)))
496 497 498 499 500 501 502 503

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

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

504 505 506 507 508 509 510 511
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)

512 513 514
instance Lift a => Lift [a] where
  lift xs = do { xs' <- mapM lift xs; return (ListE xs') }

515 516 517 518
liftString :: String -> Q Exp
-- Used in TcExpr to short-circuit the lifting for strings
liftString s = return (LitE (StringL s))

519 520 521
instance Lift () where
  lift () = return (ConE (tupleDataName 0))

522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
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]

549 550 551 552
-- 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
553
--     which happens to be the way the type checker
554 555 556 557 558
--     creates it.
{-# RULES "TH:liftString" lift = \s -> return (LitE (StringL s)) #-}


trueName, falseName :: Name
Ian Lynagh's avatar
Ian Lynagh committed
559 560
trueName  = mkNameG DataName "ghc-prim" "GHC.Types" "True"
falseName = mkNameG DataName "ghc-prim" "GHC.Types" "False"
561

562
nothingName, justName :: Name
563 564
nothingName = mkNameG DataName "base" "GHC.Base" "Nothing"
justName    = mkNameG DataName "base" "GHC.Base" "Just"
565 566 567 568 569

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

570 571

-----------------------------------------------------
572
--              Names and uniques
573 574
-----------------------------------------------------

575
newtype ModName = ModName String        -- Module name
576
 deriving (Show,Eq,Ord,Typeable,Data,Generic)
577

578
newtype PkgName = PkgName String        -- package name
579
 deriving (Show,Eq,Ord,Typeable,Data,Generic)
580

581 582
-- | Obtained from 'reifyModule' and 'thisModule'.
data Module = Module PkgName ModName -- package qualified module name
583
 deriving (Show,Eq,Ord,Typeable,Data,Generic)
584

585
newtype OccName = OccName String
586
 deriving (Show,Eq,Ord,Typeable,Data,Generic)
587

588
mkModName :: String -> ModName
589
mkModName s = ModName s
590 591

modString :: ModName -> String
592
modString (ModName m) = m
593

594 595

mkPkgName :: String -> PkgName
596
mkPkgName s = PkgName s
597 598

pkgString :: PkgName -> String
599
pkgString (PkgName m) = m
600 601


602
-----------------------------------------------------
603
--              OccName
604 605 606
-----------------------------------------------------

mkOccName :: String -> OccName
607
mkOccName s = OccName s
608 609

occString :: OccName -> String
610
occString (OccName occ) = occ
611 612 613


-----------------------------------------------------
614
--               Names
615
-----------------------------------------------------
Jan Stolarek's avatar
Jan Stolarek committed
616
--
aavogt's avatar
aavogt committed
617
-- For "global" names ('NameG') we need a totally unique name,
618 619
-- so we must include the name-space of the thing
--
aavogt's avatar
aavogt committed
620
-- For unique-numbered things ('NameU'), we've got a unique reference
621 622
-- anyway, so no need for name space
--
aavogt's avatar
aavogt committed
623
-- For dynamically bound thing ('NameS') we probably want them to
624 625
-- in a context-dependent way, so again we don't want the name
-- space.  For example:
aavogt's avatar
aavogt committed
626 627 628
--
-- > let v = mkName "T" in [| data $v = $v |]
--
629
-- Here we use the same Name for both type constructor and data constructor
aavogt's avatar
aavogt committed
630 631 632 633 634 635 636 637 638 639
--
--
-- 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
640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664

{- $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
665
which avoids name capture as desired.
666 667 668 669 670 671 672 673 674 675 676 677

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
678 679
  * 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@
680 681
    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
682 683

  * 'lookupValueName' and 'lookupTypeName' are similar to @'f@ and
684 685 686 687 688 689
     @''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
690

691 692 693 694 695 696
  * '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.
-}
697
data Name = Name OccName NameFlavour deriving (Typeable, Data, Eq, Generic)
698 699 700 701 702

instance Ord Name where
    -- check if unique is different before looking at strings
  (Name o1 f1) `compare` (Name o2 f2) = (f1 `compare` f2)   `thenCmp`
                                        (o1 `compare` o2)
703 704

data NameFlavour
aavogt's avatar
aavogt committed
705 706
  = NameS           -- ^ An unqualified name; dynamically bound
  | NameQ ModName   -- ^ A qualified name; dynamically bound
707 708
  | NameU !Int      -- ^ A unique local name
  | NameL !Int      -- ^ Local name bound outside of the TH AST
aavogt's avatar
aavogt committed
709 710
  | NameG NameSpace PkgName ModName -- ^ Global name bound outside of the TH AST:
                -- An original name (occurrences only, not binders)
711 712
                -- Need the namespace too to be sure which
                -- thing we are naming
713
  deriving ( Typeable, Data, Eq, Ord, Generic )
714

715 716 717 718
data NameSpace = VarName        -- ^ Variables
               | DataName       -- ^ Data constructors
               | TcClsName      -- ^ Type constructors and classes; Haskell has them
                                -- in the same name space for now.
719
               deriving( Eq, Ord, Data, Typeable, Generic )
720 721 722

type Uniq = Int

723
-- | The name without its module prefix
724 725 726
nameBase :: Name -> String
nameBase (Name occ _) = occString occ

727
-- | Module prefix of a name, if it exists
728
nameModule :: Name -> Maybe String
Ian Lynagh's avatar
Ian Lynagh committed
729
nameModule (Name _ (NameQ m))     = Just (modString m)
730
nameModule (Name _ (NameG _ _ m)) = Just (modString m)
Ian Lynagh's avatar
Ian Lynagh committed
731
nameModule _                      = Nothing
732

Jan Stolarek's avatar
Jan Stolarek committed
733
{- |
734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756
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") |]
-}
757
mkName :: String -> Name
758
-- The string can have a '.', thus "Foo.baz",
759 760 761 762 763
-- 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
764
-- It's a bit tricky because we need to parse
aavogt's avatar
aavogt committed
765 766 767
--
-- > Foo.Baz.x   as    Qual Foo.Baz x
--
768 769 770 771 772
-- So we parse it from back to front
mkName str
  = split [] (reverse str)
  where
    split occ []        = Name (mkOccName occ) NameS
773 774 775 776 777 778 779 780 781 782
    split occ ('.':rev) | not (null occ)
                        , is_rev_mod_name rev
                        = Name (mkOccName occ) (NameQ (mkModName (reverse rev)))
        -- The 'not (null occ)' guard ensures that
        --      mkName "&." = Name "&." NameS
        -- The 'is_rev_mod' guards ensure that
        --      mkName ".&" = Name ".&" NameS
        --      mkName "^.." = Name "^.." NameS      -- Trac #8633
        --      mkName "Data.Bits..&" = Name ".&" (NameQ "Data.Bits")
        -- This rather bizarre case actually happened; (.&.) is in Data.Bits
783
    split occ (c:rev)   = split (c:occ) rev
784

785 786
    -- Recognises a reversed module name xA.yB.C,
    -- with at least one component,
787 788 789 790 791 792 793 794 795 796 797 798 799
    -- and each component looks like a module name
    --   (i.e. non-empty, starts with capital, all alpha)
    is_rev_mod_name rev_mod_str
      | (compt, rest) <- break (== '.') rev_mod_str
      , not (null compt), isUpper (last compt), all is_mod_char compt
      = case rest of
          []             -> True
          (_dot : rest') -> is_rev_mod_name rest'
      | otherwise
      = False

    is_mod_char c = isAlphaNum c || c == '_' || c == '\''

aavogt's avatar
aavogt committed
800 801
-- | Only used internally
mkNameU :: String -> Uniq -> Name
802
mkNameU s u = Name (mkOccName s) (NameU u)
803

aavogt's avatar
aavogt committed
804 805
-- | Only used internally
mkNameL :: String -> Uniq -> Name
806
mkNameL s u = Name (mkOccName s) (NameL u)
807

aavogt's avatar
aavogt committed
808 809 810
-- | 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
811
  = Name (mkOccName occ) (NameG ns (mkPkgName pkg) (mkModName modu))
812

813
mkNameG_v, mkNameG_tc, mkNameG_d :: String -> String -> String -> Name
814 815 816 817
mkNameG_v  = mkNameG VarName
mkNameG_tc = mkNameG TcClsName
mkNameG_d  = mkNameG DataName

Ian Lynagh's avatar
Ian Lynagh committed
818 819 820 821 822 823 824 825 826 827 828 829 830 831 832
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
833
    where
834 835 836 837 838 839
        -- 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.
        -- Ditto NameU and NameL
840
        nms = case nm of
Ian Lynagh's avatar
Ian Lynagh committed
841 842 843
                    Name occ NameS         -> occString occ
                    Name occ (NameQ m)     -> modString m ++ "." ++ occString occ
                    Name occ (NameG _ _ m) -> modString m ++ "." ++ occString occ
844 845
                    Name occ (NameU u)     -> occString occ ++ "_" ++ show u
                    Name occ (NameL u)     -> occString occ ++ "_" ++ show u
846 847 848

        pnam = classify nms

Ian Lynagh's avatar
Ian Lynagh committed
849 850
        -- True if we are function style, e.g. f, [], (,)
        -- False if we are operator style, e.g. +, :+
851
        classify "" = False -- shouldn't happen; . operator is handled below
Ian Lynagh's avatar
Ian Lynagh committed
852
        classify (x:xs) | isAlpha x || (x `elem` "_[]()") =
853 854 855 856
                            case dropWhile (/='.') xs of
                                  (_:xs') -> classify xs'
                                  []      -> True
                        | otherwise = False
857

858
instance Show Name where
Ian Lynagh's avatar
Ian Lynagh committed
859
  show = showName
860

861
-- Tuple data and type constructors
862 863 864 865
-- | Tuple data constructor
tupleDataName :: Int -> Name
-- | Tuple type constructor
tupleTypeName :: Int -> Name
866

867
tupleDataName 0 = mk_tup_name 0 DataName
868
tupleDataName 1 = error "tupleDataName 1"
869
tupleDataName n = mk_tup_name (n-1) DataName
870

871
tupleTypeName 0 = mk_tup_name 0 TcClsName
872
tupleTypeName 1 = error "tupleTypeName 1"
873
tupleTypeName n = mk_tup_name (n-1) TcClsName
874

Ian Lynagh's avatar
Ian Lynagh committed
875
mk_tup_name :: Int -> NameSpace -> Name
876
mk_tup_name n_commas space
Ian Lynagh's avatar
Ian Lynagh committed
877
  = Name occ (NameG space (mkPkgName "ghc-prim") tup_mod)
878 879
  where
    occ = mkOccName ('(' : replicate n_commas ',' ++ ")")
Ian Lynagh's avatar
Ian Lynagh committed
880
    tup_mod = mkModName "GHC.Tuple"
881

882
-- Unboxed tuple data and type constructors
883 884 885 886
-- | Unboxed tuple data constructor
unboxedTupleDataName :: Int -> Name
-- | Unboxed tuple type constructor
unboxedTupleTypeName :: Int -> Name
887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902

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"

903

904

905
-----------------------------------------------------
906
--              Locations
907 908 909 910
-----------------------------------------------------

data Loc
  = Loc { loc_filename :: String
911 912 913 914
        , loc_package  :: String
        , loc_module   :: String
        , loc_start    :: CharPos
        , loc_end      :: CharPos }
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
915
   deriving( Show, Eq, Ord, Data, Typeable, Generic )
916

917
type CharPos = (Int, Int)       -- ^ Line and character position
918

919

920 921
-----------------------------------------------------
--
922
--      The Info returned by reification
923 924 925
--
-----------------------------------------------------

aavogt's avatar
aavogt committed
926 927
-- | Obtained from 'reify' in the 'Q' Monad.
data Info
Jan Stolarek's avatar
Jan Stolarek committed
928
  =
929
  -- | A class, with a list of its visible instances
Jan Stolarek's avatar
Jan Stolarek committed
930
  ClassI
931 932
      Dec
      [InstanceDec]
Jan Stolarek's avatar
Jan Stolarek committed
933

934
  -- | A class method
935
  | ClassOpI
936 937 938 939
       Name
       Type
       ParentName
       Fixity
Jan Stolarek's avatar
Jan Stolarek committed
940

941
  -- | A \"plain\" type constructor. \"Fancier\" type constructors are returned using 'PrimTyConI' or 'FamilyI' as appropriate
Jan Stolarek's avatar
Jan Stolarek committed
942
  | TyConI
943 944
        Dec

945 946
  -- | 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
947
  | FamilyI
948 949
        Dec
        [InstanceDec]
Jan Stolarek's avatar
Jan Stolarek committed
950

951
  -- | A \"primitive\" type constructor, which can't be expressed with a 'Dec'. Examples: @(->)@, @Int#@.
Jan Stolarek's avatar
Jan Stolarek committed
952
  | PrimTyConI
953 954 955
       Name
       Arity
       Unlifted
Jan Stolarek's avatar
Jan Stolarek committed
956

957
  -- | A data constructor
Jan Stolarek's avatar
Jan Stolarek committed
958
  | DataConI
959 960 961 962
       Name
       Type
       ParentName
       Fixity
963

Jan Stolarek's avatar
Jan Stolarek committed
964
  {- |
965
  A \"value\" variable (as opposed to a type variable, see 'TyVarI').
Jan Stolarek's avatar
Jan Stolarek committed
966 967 968

  The @Maybe Dec@ field contains @Just@ the declaration which
  defined the variable -- including the RHS of the declaration --
969 970 971 972 973
  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
974
  | VarI
975 976 977 978
       Name
       Type
       (Maybe Dec)
       Fixity
979

Jan Stolarek's avatar
Jan Stolarek committed
980
  {- |
981
  A type variable.
Jan Stolarek's avatar
Jan Stolarek committed
982

983 984 985 986
  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.
  -}
987 988 989
  | TyVarI      -- Scoped type variable
        Name
        Type    -- What it is bound to
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
990
  deriving( Show, Eq, Ord, Data, Typeable, Generic )
991

992 993 994 995
-- | Obtained from 'reifyModule' in the 'Q' Monad.
data ModuleInfo =
  -- | Contains the import list of the module.
  ModuleInfo [Module]
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
996
  deriving( Show, Eq, Ord, Data, Typeable, Generic )
997

Jan Stolarek's avatar
Jan Stolarek committed
998
{- |
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
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.
1010
-- It is just a 'Dec', but guaranteed to be one of the following:
1011 1012 1013 1014 1015 1016
--
--   * 'InstanceD' (with empty @['Dec']@)
--
--   * 'DataInstD' or 'NewtypeInstD' (with empty derived @['Name']@)
--
--   * 'TySynInstD'
1017
type InstanceDec = Dec
1018

1019
data Fixity          = Fixity Int FixityDirection
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed