Syntax.hs 36.5 KB
Newer Older
1
{-# LANGUAGE UnboxedTuples #-}
Ian Lynagh's avatar
Ian Lynagh committed
2
{-# OPTIONS_GHC -fno-warn-warnings-deprecations #-}
3
-- The -fno-warn-warnings-deprecations flag is a temporary kludge.
Ian Lynagh's avatar
Ian Lynagh committed
4 5 6 7
-- While working on this module you are encouraged to remove it and fix
-- any warnings in the module. See
--     http://hackage.haskell.org/trac/ghc/wiki/WorkingConventions#Warnings
-- for details
8

9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
-----------------------------------------------------------------------------
-- |
-- Module      :  Language.Haskell.Syntax
-- Copyright   :  (c) The University of Glasgow 2003
-- License     :  BSD-style (see the file libraries/base/LICENSE)
-- 
-- Maintainer  :  libraries@haskell.org
-- Stability   :  experimental
-- Portability :  portable
--
-- Abstract syntax definitions for Template Haskell.
--
-----------------------------------------------------------------------------

module Language.Haskell.TH.Syntax(
24
	Quasi(..), Lift(..), liftString,
25 26

	Q, runQ, 
27 28
	report,	recover, reify, 
        lookupTypeName, lookupValueName,
29
	location, runIO, addDependentFile,
30
        isInstance, reifyInstances,
31

aavogt's avatar
aavogt committed
32
	-- * Names
Ian Lynagh's avatar
Ian Lynagh committed
33
	Name(..), mkName, newName, nameBase, nameModule,
34
        showName, showName', NameIs(..),
35

aavogt's avatar
aavogt committed
36
	-- * The algebraic data types
37
	-- $infix
38
	Dec(..), Exp(..), Con(..), Type(..), TyVarBndr(..), Kind, Cxt,
Iavor S. Diatchki's avatar
Iavor S. Diatchki committed
39
        TyLit(..),
40
	Pred(..), Match(..),  Clause(..), Body(..), Guard(..), Stmt(..),
41
	Range(..), Lit(..), Pat(..), FieldExp, FieldPat, 
42
	Strict(..), Foreign(..), Callconv(..), Safety(..), Pragma(..),
43 44
	Inline(..), InlineSpec(..), StrictType, VarStrictType, FunDep(..),
	FamFlavour(..), Info(..), Loc(..), CharPos,
45 46
	Fixity(..), FixityDirection(..), defaultFixity, maxPrecedence,

aavogt's avatar
aavogt committed
47
	-- * Internal functions
48 49
	returnQ, bindQ, sequenceQ,
	NameFlavour(..), NameSpace (..), 
50
	mkNameG_v, mkNameG_d, mkNameG_tc, Uniq, mkNameL, mkNameU,
51
 	tupleTypeName, tupleDataName,
52
	unboxedTupleTypeName, unboxedTupleDataName,
53
	OccName, mkOccName, occString,
54 55
	ModName, mkModName, modString,
	PkgName, mkPkgName, pkgString
56 57 58 59
    ) where

import GHC.Base		( Int(..), Int#, (<#), (==#) )

60
import Language.Haskell.TH.Syntax.Internals
61
import Data.Data (Data(..), Typeable, mkConstr, mkDataType, constrIndex)
Ross Paterson's avatar
Ross Paterson committed
62
import qualified Data.Data as Data
63
import Control.Applicative( Applicative(..) )
64
import Data.IORef
65
import System.IO.Unsafe	( unsafePerformIO )
66
import Control.Monad (liftM)
67
import System.IO	( hPutStrLn, stderr )
68
import Data.Char        ( isAlpha )
reinerp's avatar
reinerp committed
69
import Data.Word        ( Word8 )
70 71 72 73 74 75 76

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

77
class (Monad m, Applicative m) => Quasi m where
78
  qNewName :: String -> m Name
aavogt's avatar
aavogt committed
79
	-- ^ Fresh names
80 81

	-- Error reporting and recovery
aavogt's avatar
aavogt committed
82
  qReport  :: Bool -> String -> m ()	-- ^ Report an error (True) or warning (False)
83
					-- ...but carry on; use 'fail' to stop
aavogt's avatar
aavogt committed
84 85 86
  qRecover :: m a -- ^ the error handler
           -> m a -- ^ action which may fail
           -> m a		-- ^ Recover from the monadic 'fail'
87 88
 
	-- Inspect the type-checker's environment
89 90 91 92 93 94 95 96
  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?
       -- Returns list of matching instance Decs 
       --    (with empty sub-Decs)
       -- Works for classes and type functions
97

98
  qLocation :: m Loc
99 100

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

GregWeber's avatar
GregWeber committed
103
  qAddDependentFile :: FilePath -> m ()
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123

-----------------------------------------------------
--	The IO instance of Quasi
-- 
--  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)

124
  qLookupName _ _     = badIO "lookupName"
125
  qReify _            = badIO "reify"
126
  qReifyInstances _ _ = badIO "classInstances"
127 128
  qLocation    	      = badIO "currentLocation"
  qRecover _ _ 	      = badIO "recover" -- Maybe we could fix this?
GregWeber's avatar
GregWeber committed
129
  qAddDependentFile _ = badIO "addDependentFile"
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157

  qRunIO m = m
  
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 }

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)
158
  fail s     = report True s >> Q (fail "Q monad failure")
159

160 161 162
instance Functor Q where
  fmap f (Q x) = Q (fmap f x)

163 164 165 166
instance Applicative Q where 
  pure x = Q (pure x) 
  Q f <*> Q x = Q (f <*> x) 

167 168 169 170 171 172 173 174
----------------------------------------------------
-- Packaged versions for the programmer, hiding the Quasi-ness
newName :: String -> Q Name
newName s = Q (qNewName s)

report  :: Bool -> String -> Q ()
report b s = Q (qReport b s)

aavogt's avatar
aavogt committed
175 176 177
recover :: Q a -- ^ recover with this one
        -> Q a -- ^ failing action
        -> Q a
178 179
recover (Q r) (Q m) = Q (qRecover r m)

180 181 182 183 184 185 186 187 188
-- 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)

lookupTypeName, lookupValueName :: String -> Q (Maybe Name)
lookupTypeName  s = Q (qLookupName True s)
lookupValueName s = Q (qLookupName False s)

189
-- | 'reify' looks up information about the 'Name'
190 191 192
reify :: Name -> Q Info
reify v = Q (qReify v)

193
-- | 'classInstances' looks up instaces of a class
194 195
reifyInstances :: Name -> [Type] -> Q [Dec]
reifyInstances cls tys = Q (qReifyInstances cls tys)
196

197 198 199
isInstance :: Name -> [Type] -> Q Bool
isInstance nm tys = do { decs <- reifyInstances nm tys
                       ; return (not (null decs)) }
200

201
-- | 'location' gives you the 'Location' at which this
202
-- computation is spliced.
203 204
location :: Q Loc
location = Q qLocation
205

dons's avatar
dons committed
206
-- |The 'runIO' function lets you run an I\/O computation in the 'Q' monad.
207 208 209 210 211 212
-- 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.  
--
-- Note: for various murky reasons, stdout and stderr handles are not 
-- necesarily flushed when the  compiler finishes running, so you should
-- flush them yourself.
213 214 215
runIO :: IO a -> Q a
runIO m = Q (qRunIO m)

GregWeber's avatar
GregWeber committed
216 217 218 219 220 221 222
-- | 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)

223
instance Quasi Q where
GregWeber's avatar
GregWeber committed
224 225 226 227 228 229 230 231 232
  qNewName  	    = newName
  qReport   	    = report
  qRecover  	    = recover 
  qReify    	    = reify
  qReifyInstances   = reifyInstances
  qLookupName       = lookupName
  qLocation 	    = location
  qRunIO    	    = runIO
  qAddDependentFile = addDependentFile
233 234 235 236


----------------------------------------------------
-- The following operations are used solely in DsMeta when desugaring brackets
237
-- They are not necessary for the user, who can use ordinary return and (>>=) etc
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270

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

271 272 273 274 275 276 277 278
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)

279 280 281
instance Lift a => Lift [a] where
  lift xs = do { xs' <- mapM lift xs; return (ListE xs') }

282 283 284 285
liftString :: String -> Q Exp
-- Used in TcExpr to short-circuit the lifting for strings
liftString s = return (LitE (StringL s))

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 311 312
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]

313 314 315 316 317 318 319 320 321 322
-- 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
--     which happens to be the way the type checker 
--     creates it.
{-# RULES "TH:liftString" lift = \s -> return (LitE (StringL s)) #-}


trueName, falseName :: Name
Ian Lynagh's avatar
Ian Lynagh committed
323 324
trueName  = mkNameG DataName "ghc-prim" "GHC.Types" "True"
falseName = mkNameG DataName "ghc-prim" "GHC.Types" "False"
325

326 327 328 329 330 331 332 333
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"

334 335 336 337 338 339

-----------------------------------------------------
--		Names and uniques 
-----------------------------------------------------

mkModName :: String -> ModName
340
mkModName s = ModName s
341 342

modString :: ModName -> String
343
modString (ModName m) = m
344

345 346

mkPkgName :: String -> PkgName
347
mkPkgName s = PkgName s
348 349

pkgString :: PkgName -> String
350
pkgString (PkgName m) = m
351 352


353 354 355 356 357
-----------------------------------------------------
--		OccName
-----------------------------------------------------

mkOccName :: String -> OccName
358
mkOccName s = OccName s
359 360

occString :: OccName -> String
361
occString (OccName occ) = occ
362 363 364 365 366 367


-----------------------------------------------------
--		 Names
-----------------------------------------------------

aavogt's avatar
aavogt committed
368 369
-- |
-- For "global" names ('NameG') we need a totally unique name,
370 371
-- so we must include the name-space of the thing
--
aavogt's avatar
aavogt committed
372
-- For unique-numbered things ('NameU'), we've got a unique reference
373 374
-- anyway, so no need for name space
--
aavogt's avatar
aavogt committed
375
-- For dynamically bound thing ('NameS') we probably want them to
376 377
-- in a context-dependent way, so again we don't want the name
-- space.  For example:
aavogt's avatar
aavogt committed
378 379 380
--
-- > let v = mkName "T" in [| data $v = $v |]
--
381
-- Here we use the same Name for both type constructor and data constructor
aavogt's avatar
aavogt committed
382 383 384 385 386 387 388 389 390 391
--
--
-- 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
392
data Name = Name OccName NameFlavour deriving (Typeable, Data)
393 394

data NameFlavour
aavogt's avatar
aavogt committed
395 396 397 398 399 400
  = 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)
401 402
		-- Need the namespace too to be sure which 
		-- thing we are naming
403 404
  deriving ( Typeable )

aavogt's avatar
aavogt committed
405
-- |
406 407 408 409 410 411 412 413 414 415
-- 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
-- boot libraries cannot be upgraded seperately from GHC itself.
--
-- This instance cannot be derived automatically due to bug #2701
416
instance Data NameFlavour where
417 418 419 420 421 422 423 424 425 426 427 428
     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"
429 430 431 432 433 434 435
     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
436 437 438 439 440 441
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
442

Ross Paterson's avatar
Ross Paterson committed
443
ty_NameFlavour :: Data.DataType
444 445 446
ty_NameFlavour = mkDataType "Language.Haskell.TH.Syntax.NameFlavour"
                            [con_NameS, con_NameQ, con_NameU,
                             con_NameL, con_NameG]
447

aavogt's avatar
aavogt committed
448 449 450
data NameSpace = VarName	-- ^ Variables
	       | DataName	-- ^ Data constructors 
	       | TcClsName	-- ^ Type constructors and classes; Haskell has them
451
				-- in the same name space for now.
452
	       deriving( Eq, Ord, Data, Typeable )
453 454 455

type Uniq = Int

aavogt's avatar
aavogt committed
456
-- | Base, unqualified name.
457 458 459
nameBase :: Name -> String
nameBase (Name occ _) = occString occ

460
nameModule :: Name -> Maybe String
Ian Lynagh's avatar
Ian Lynagh committed
461
nameModule (Name _ (NameQ m))     = Just (modString m)
462
nameModule (Name _ (NameG _ _ m)) = Just (modString m)
Ian Lynagh's avatar
Ian Lynagh committed
463
nameModule _                      = Nothing
464

465
mkName :: String -> Name
aavogt's avatar
aavogt committed
466
-- ^ The string can have a '.', thus "Foo.baz",
467 468 469 470 471 472
-- 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
-- It's a bit tricky because we need to parse 
aavogt's avatar
aavogt committed
473 474 475
--
-- > Foo.Baz.x   as    Qual Foo.Baz x
--
476 477 478 479 480
-- So we parse it from back to front
mkName str
  = split [] (reverse str)
  where
    split occ []        = Name (mkOccName occ) NameS
481 482 483 484 485 486 487 488 489
    split occ ('.':rev)	| not (null occ), 
			  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
490
    split occ (c:rev)   = split (c:occ) rev
491

aavogt's avatar
aavogt committed
492 493
-- | Only used internally
mkNameU :: String -> Uniq -> Name
494 495
mkNameU s (I# u) = Name (mkOccName s) (NameU u)

aavogt's avatar
aavogt committed
496 497
-- | Only used internally
mkNameL :: String -> Uniq -> Name
498 499
mkNameL s (I# u) = Name (mkOccName s) (NameL u)

aavogt's avatar
aavogt committed
500 501 502
-- | 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
503
  = Name (mkOccName occ) (NameG ns (mkPkgName pkg) (mkModName modu))
504

505
mkNameG_v, mkNameG_tc, mkNameG_d :: String -> String -> String -> Name
506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
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
521
	-- NameS < NameQ < NameU < NameL < NameG
522
  NameS `compare` NameS = EQ
Ian Lynagh's avatar
Ian Lynagh committed
523
  NameS `compare` _     = LT
524

525 526
  (NameQ _)  `compare` NameS      = GT
  (NameQ m1) `compare` (NameQ m2) = m1 `compare` m2
Ian Lynagh's avatar
Ian Lynagh committed
527
  (NameQ _)  `compare` _          = LT
528 529 530

  (NameU _)  `compare` NameS      = GT
  (NameU _)  `compare` (NameQ _)  = GT
531 532 533
  (NameU u1) `compare` (NameU u2) | u1  <# u2 = LT
				  | u1 ==# u2 = EQ
				  | otherwise = GT
Ian Lynagh's avatar
Ian Lynagh committed
534
  (NameU _)  `compare` _     = LT
535

536 537 538 539 540 541
  (NameL _)  `compare` NameS      = GT
  (NameL _)  `compare` (NameQ _)  = GT
  (NameL _)  `compare` (NameU _)  = GT
  (NameL u1) `compare` (NameL u2) | u1  <# u2 = LT
				  | u1 ==# u2 = EQ
				  | otherwise = GT
Ian Lynagh's avatar
Ian Lynagh committed
542
  (NameL _)  `compare` _          = LT
543

544 545 546
  (NameG ns1 p1 m1) `compare` (NameG ns2 p2 m2) = (ns1 `compare` ns2) `thenCmp`
                                            (p1 `compare` p2) `thenCmp`
					    (m1 `compare` m2) 
Ian Lynagh's avatar
Ian Lynagh committed
547
  (NameG _ _ _)    `compare` _ = GT
548

Ian Lynagh's avatar
Ian Lynagh committed
549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
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
564
    where
565 566 567 568 569
	-- 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.
570 571
	-- Ditto NameU and NameL
        nms = case nm of
Ian Lynagh's avatar
Ian Lynagh committed
572 573 574 575 576
                    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)
577 578 579

        pnam = classify nms

Ian Lynagh's avatar
Ian Lynagh committed
580 581
        -- True if we are function style, e.g. f, [], (,)
        -- False if we are operator style, e.g. +, :+
582
        classify "" = False -- shouldn't happen; . operator is handled below
Ian Lynagh's avatar
Ian Lynagh committed
583
        classify (x:xs) | isAlpha x || (x `elem` "_[]()") =
584 585 586 587
                            case dropWhile (/='.') xs of
                                  (_:xs') -> classify xs'
                                  []      -> True
                        | otherwise = False
588

589
instance Show Name where
Ian Lynagh's avatar
Ian Lynagh committed
590
  show = showName
591

592
-- Tuple data and type constructors
aavogt's avatar
aavogt committed
593 594
tupleDataName :: Int -> Name    -- ^ Data constructor
tupleTypeName :: Int -> Name    -- ^ Type constructor
595

596
tupleDataName 0 = mk_tup_name 0 DataName
597
tupleDataName 1 = error "tupleDataName 1"
598
tupleDataName n = mk_tup_name (n-1) DataName
599

600
tupleTypeName 0 = mk_tup_name 0 TcClsName
601
tupleTypeName 1 = error "tupleTypeName 1"
602
tupleTypeName n = mk_tup_name (n-1) TcClsName
603

Ian Lynagh's avatar
Ian Lynagh committed
604
mk_tup_name :: Int -> NameSpace -> Name
605
mk_tup_name n_commas space
Ian Lynagh's avatar
Ian Lynagh committed
606
  = Name occ (NameG space (mkPkgName "ghc-prim") tup_mod)
607 608
  where
    occ = mkOccName ('(' : replicate n_commas ',' ++ ")")
Ian Lynagh's avatar
Ian Lynagh committed
609
    tup_mod = mkModName "GHC.Tuple"
610

611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
-- Unboxed tuple data and type constructors
unboxedTupleDataName :: Int -> Name    -- ^ Data constructor
unboxedTupleTypeName :: Int -> Name    -- ^ Type constructor

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"

630

631

632 633 634 635 636 637 638 639 640 641 642 643 644
-----------------------------------------------------
--		Locations
-----------------------------------------------------

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

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

645

646 647 648 649 650 651
-----------------------------------------------------
--
--	The Info returned by reification
--
-----------------------------------------------------

aavogt's avatar
aavogt committed
652 653
-- | Obtained from 'reify' in the 'Q' Monad.
data Info
654 655 656 657
  = -- | A class is reified to its declaration 
    --   and a list of its instances
    ClassI 
        Dec             -- Declaration of the class
658
        [InstanceDec]	-- The instances of that class
659

660 661 662 663 664 665
  | ClassOpI
	Name	-- The class op itself
	Type 	-- Type of the class-op (fully polymoprhic)
	Name 	-- Name of the parent class
	Fixity

666 667 668 669 670 671
  | TyConI 
        Dec

  | FamilyI	-- Type/data families
        Dec
        [InstanceDec]
672 673 674 675 676 677 678

  | PrimTyConI 	-- Ones that can't be expressed with a data type 
		-- decl, such as (->), Int#
	Name 
	Int	-- Arity
	Bool	-- False => lifted type; True => unlifted

679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695
  | DataConI 
	Name	-- The data con itself
	Type 	-- Type of the constructor (fully polymorphic)
	Name 	-- Name of the parent TyCon
	Fixity

  | VarI 
	Name	-- The variable itself
	Type 
	(Maybe Dec)	-- Nothing for lambda-bound variables, and 
			-- for anything else TH can't figure out
			-- E.g. [| let x = 1 in $(do { d <- reify 'x; .. }) |]
	Fixity

  | TyVarI 	-- Scoped type variable
	Name
	Type	-- What it is bound to
696
  deriving( Show, Data, Typeable )
697

698 699 700 701 702 703
-- | 'InstanceDec' desribes a single instance of a class or type function
-- It is just a 'Dec', but guaranteed to be one of the following:
--   InstanceD (with empty [Dec])
--   DataInstD or NewtypeInstD (with empty derived [Name])
--   TySynInstD
type InstanceDec = Dec
704

705 706 707 708
data Fixity          = Fixity Int FixityDirection
    deriving( Eq, Show, Data, Typeable )
data FixityDirection = InfixL | InfixR | InfixN
    deriving( Eq, Show, Data, Typeable )
709

710
maxPrecedence :: Int
711
maxPrecedence = (9::Int)
712 713

defaultFixity :: Fixity
714 715 716 717 718 719 720 721 722
defaultFixity = Fixity maxPrecedence InfixL


-----------------------------------------------------
--
--	The main syntax data types
--
-----------------------------------------------------

723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784
{- $infix #infix#
Note [Unresolved infix]
~~~~~~~~~~~~~~~~~~~~~~~

When implementing antiquotation for quasiquoters, one often wants
to parse strings into expressions:

> parse :: String -> Maybe 'Exp'

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.

-}

785 786
data Lit = CharL Char 
         | StringL String 
aavogt's avatar
aavogt committed
787
         | IntegerL Integer     -- ^ Used for overloaded and non-overloaded
788 789 790 791 792
                                -- 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
793
         | WordPrimL Integer
794 795
         | FloatPrimL Rational
         | DoublePrimL Rational
reinerp's avatar
reinerp committed
796
         | StringPrimL [Word8]	-- ^ A primitive C-style string, type Addr#
797
    deriving( Show, Eq, Data, Typeable )
798 799 800 801 802

    -- We could add Int, Float, Double etc, as we do in HsLit, 
    -- but that could complicate the
    -- suppposedly-simple TH.Syntax literal type

aavogt's avatar
aavogt committed
803
-- | Pattern in Haskell given in @{}@
804
data Pat 
aavogt's avatar
aavogt committed
805 806 807
  = LitP Lit                      -- ^ @{ 5 or 'c' }@
  | VarP Name                     -- ^ @{ x }@
  | TupP [Pat]                    -- ^ @{ (p1,p2) }@
808
  | UnboxedTupP [Pat]             -- ^ @{ (# p1,p2 #) }@
aavogt's avatar
aavogt committed
809 810
  | ConP Name [Pat]               -- ^ @data T1 = C1 t1 t2; {C1 p1 p1} = e@
  | InfixP Pat Name Pat           -- ^ @foo ({x :+ y}) = e@
811 812 813 814 815 816
  | UInfixP Pat Name Pat          -- ^ @foo ({x :+ y}) = e@
                                  --
                                  -- See Note [Unresolved infix] at "Language.Haskell.TH.Syntax#infix"
  | ParensP Pat                   -- ^ @{(p)}@
                                  --
                                  -- See Note [Unresolved infix] at "Language.Haskell.TH.Syntax#infix"
aavogt's avatar
aavogt committed
817 818 819 820 821 822 823
  | TildeP Pat                    -- ^ @{ ~p }@
  | BangP Pat                     -- ^ @{ !p }@
  | AsP Name Pat                  -- ^ @{ x \@ p }@
  | WildP                         -- ^ @{ _ }@
  | RecP Name [FieldPat]          -- ^ @f (Pt { pointx = x }) = g x@
  | ListP [ Pat ]                 -- ^ @{ [1,2,3] }@
  | SigP Pat Type                 -- ^ @{ p :: t }@
reinerp's avatar
reinerp committed
824
  | ViewP Exp Pat                 -- ^ @{ e -> p }@
825
  deriving( Show, Eq, Data, Typeable )
826 827 828

type FieldPat = (Name,Pat)

aavogt's avatar
aavogt committed
829
data Match = Match Pat Body [Dec] -- ^ @case e of { pat -> body where decs }@
830
    deriving( Show, Eq, Data, Typeable )
831
data Clause = Clause [Pat] Body [Dec]
aavogt's avatar
aavogt committed
832
                                  -- ^ @f { p1 p2 = body where decs }@
833
    deriving( Show, Eq, Data, Typeable )
834
 
835 836 837
-- | The 'CompE' constructor represents a list comprehension, and 
-- takes a ['Stmt'].  The result expression of the comprehension is
-- the *last* of these, and should be a 'NoBindS'.
aavogt's avatar
aavogt committed
838 839 840 841 842 843
--
-- E.g. translation:
--
-- > [ f x | x <- xs ]
--
-- > CompE [BindS (VarP x) (VarE xs), NoBindS (AppE (VarE f) (VarE x))]
844
data Exp 
aavogt's avatar
aavogt committed
845 846 847 848
  = VarE Name                          -- ^ @{ x }@
  | ConE Name                          -- ^ @data T1 = C1 t1 t2; p = {C1} e1 e2  @
  | LitE Lit                           -- ^ @{ 5 or 'c'}@
  | AppE Exp Exp                       -- ^ @{ f x }@
849

aavogt's avatar
aavogt committed
850 851
  | InfixE (Maybe Exp) Exp (Maybe Exp) -- ^ @{x + y} or {(x+)} or {(+ x)} or {(+)}@
    --
852 853 854 855 856 857
    -- It's a bit gruesome to use an Exp as the
    -- operator, but how else can we distinguish
    -- constructors from non-constructors?
    -- Maybe there should be a var-or-con type?
    -- Or maybe we should leave it to the String itself?

858 859 860 861 862 863
  | UInfixE Exp Exp Exp                -- ^ @{x + y}@
                                       --
                                       -- See Note [Unresolved infix] at "Language.Haskell.TH.Syntax#infix"
  | ParensE Exp                        -- ^ @{ (e) }@
                                       --
                                       -- See Note [Unresolved infix] at "Language.Haskell.TH.Syntax#infix"
aavogt's avatar
aavogt committed
864
  | LamE [Pat] Exp                     -- ^ @{ \ p1 p2 -> e }@
865
  | LamCaseE [Match]                   -- ^ @{ \case m1; m2 }@
aavogt's avatar
aavogt committed
866
  | TupE [Exp]                         -- ^ @{ (e1,e2) }  @
867
  | UnboxedTupE [Exp]                  -- ^ @{ (# e1,e2 #) }  @
aavogt's avatar
aavogt committed
868
  | CondE Exp Exp Exp                  -- ^ @{ if e1 then e2 else e3 }@
869
  | MultiIfE [(Guard, Exp)]            -- ^ @{ if | g1 -> e1 | g2 -> e2 }@
aavogt's avatar
aavogt committed
870 871 872 873 874 875 876 877 878
  | LetE [Dec] Exp                     -- ^ @{ let x=e1;   y=e2 in e3 }@
  | CaseE Exp [Match]                  -- ^ @{ case e of m1; m2 }@
  | DoE [Stmt]                         -- ^ @{ do { p <- e1; e2 }  }@
  | CompE [Stmt]                       -- ^ @{ [ (x,y) | x <- xs, y <- ys ] }@
  | ArithSeqE Range                    -- ^ @{ [ 1 ,2 .. 10 ] }@
  | ListE [ Exp ]                      -- ^ @{ [1,2,3] }@
  | SigE Exp Type                      -- ^ @{ e :: t }@
  | RecConE Name [FieldExp]            -- ^ @{ T { x = y, z = w } }@
  | RecUpdE Exp [FieldExp]             -- ^ @{ (f x) { z = w } }@
879
  deriving( Show, Eq, Data, Typeable )
880 881 882 883 884 885

type FieldExp = (Name,Exp)

-- Omitted: implicit parameters

data Body
aavogt's avatar
aavogt committed
886 887
  = GuardedB [(Guard,Exp)]   -- ^ @f p { | e1 = e2 | e3 = e4 } where ds@
  | NormalB Exp              -- ^ @f p { = e } where ds@
888
  deriving( Show, Eq, Data, Typeable )
889

890 891 892
data Guard
  = NormalG Exp
  | PatG [Stmt]
893
  deriving( Show, Eq, Data, Typeable )
894

895 896 897 898 899
data Stmt
  = BindS Pat Exp
  | LetS [ Dec ]
  | NoBindS Exp
  | ParS [[Stmt]]
900
  deriving( Show, Eq, Data, Typeable )
901 902 903

data Range = FromR Exp | FromThenR Exp Exp
           | FromToR Exp Exp | FromThenToR Exp Exp Exp
904
          deriving( Show, Eq, Data, Typeable )
905 906
  
data Dec 
aavogt's avatar
aavogt committed
907 908
  = FunD Name [Clause]            -- ^ @{ f p1 p2 = b where decs }@
  | ValD Pat Body [Dec]           -- ^ @{ p = b where decs }@
909
  | DataD Cxt Name [TyVarBndr] 
aavogt's avatar
aavogt committed
910 911
         [Con] [Name]             -- ^ @{ data Cxt x => T x = A x | B (T x)
                                  --       deriving (Z,W)}@
912
  | NewtypeD Cxt Name [TyVarBndr] 
aavogt's avatar
aavogt committed
913 914 915
         Con [Name]               -- ^ @{ newtype Cxt x => T x = A (B x)
                                  --       deriving (Z,W)}@
  | TySynD Name [TyVarBndr] Type  -- ^ @{ type T x = (x,x) }@
916
  | ClassD Cxt Name [TyVarBndr] 
aavogt's avatar
aavogt committed
917 918 919 920
         [FunDep] [Dec]           -- ^ @{ class Eq a => Ord a where ds }@
  | InstanceD Cxt Type [Dec]      -- ^ @{ instance Show w => Show [w]
                                  --       where ds }@
  | SigD Name Type                -- ^ @{ length :: [a] -> Int }@
921
  | ForeignD Foreign
aavogt's avatar
aavogt committed
922

923 924
  | InfixD Fixity Name            -- ^ @{ infix 3 foo }@

aavogt's avatar
aavogt committed
925 926 927 928
  -- | pragmas
  | PragmaD Pragma                -- ^ @{ {-# INLINE [1] foo #-} }@

  -- | type families (may also appear in [Dec] of 'ClassD' and 'InstanceD')
929
  | FamilyD FamFlavour Name 
aavogt's avatar
aavogt committed
930
         [TyVarBndr] (Maybe Kind) -- ^ @{ type family T a b c :: * }@
931
                                 
932
  | DataInstD Cxt Name [Type]
aavogt's avatar
aavogt committed
933
         [Con] [Name]             -- ^ @{ data instance Cxt x => T [x] = A x 
934
                                  --                                | B (T x)
aavogt's avatar
aavogt committed
935
                                  --       deriving (Z,W)}@
936
  | NewtypeInstD Cxt Name [Type]
aavogt's avatar
aavogt committed
937 938 939
         Con [Name]               -- ^ @{ newtype instance Cxt x => T [x] = A (B x)
                                  --       deriving (Z,W)}@
  | TySynInstD Name [Type] Type   -- ^ @{ type instance T (Maybe x) = (x,x) }@
940
  deriving( Show, Eq, Data, Typeable )
941

942
data FunDep = FunDep [Name] [Name]
943
  deriving( Show, Eq, Data, Typeable )
944

945 946 947
data FamFlavour = TypeFam | DataFam
  deriving( Show, Eq, Data, Typeable )

948 949
data Foreign = ImportF Callconv Safety String Name Type
             | ExportF Callconv        String Name Type
950
         deriving( Show, Eq, Data, Typeable )
951 952

data Callconv = CCall | StdCall
953
          deriving( Show, Eq, Data, Typeable )
954

955
data Safety = Unsafe | Safe | Interruptible
956
        deriving( Show, Eq, Data, Typeable )
957

958 959 960 961
data Pragma = InlineP     Name InlineSpec
            | SpecialiseP Name Type (Maybe InlineSpec)
        deriving( Show, Eq, Data, Typeable )

962 963 964 965 966
data Inline = NoInline
            | Inline
            | Inlinable
            deriving (Show, Eq, Data, Typeable)

967
data InlineSpec 
968
  = InlineSpec Inline
969 970 971 972
               Bool                 -- False: fun-like; True: constructor-like
               (Maybe (Bool, Int))  -- False: before phase; True: from phase
  deriving( Show, Eq, Data, Typeable )

aavogt's avatar
aavogt committed
973
type Cxt = [Pred]                 -- ^ @(Eq a, Ord b)@
974

aavogt's avatar
aavogt committed
975 976
data Pred = ClassP Name [Type]    -- ^ @Eq (Int, a)@
          | EqualP Type Type      -- ^ @F a ~ Bool@
977
          deriving( Show, Eq, Data, Typeable )
978

979
data Strict = IsStrict | NotStrict | Unpacked
980
         deriving( Show, Eq, Data, Typeable )
981

aavogt's avatar
aavogt committed
982 983 984 985
data Con = NormalC Name [StrictType]          -- ^ @C Int a@
         | RecC Name [VarStrictType]          -- ^ @C { v :: Int, w :: a }@
         | InfixC StrictType Name StrictType  -- ^ @Int :+ a@
         | ForallC [TyVarBndr] Cxt Con        -- ^ @forall a. Eq a => C [a]@
986
         deriving( Show, Eq, Data, Typeable )
987 988 989 990

type StrictType = (Strict, Type)
type VarStrictType = (Name, Strict, Type)

aavogt's avatar
aavogt committed
991
data Type = ForallT [TyVarBndr] Cxt Type  -- ^ @forall <vars>. <ctxt> -> <type>@
992 993
          | AppT Type Type                -- ^ @T a b@
          | SigT Type Kind                -- ^ @t :: k@
aavogt's avatar
aavogt committed
994 995
          | VarT Name                     -- ^ @a@
          | ConT Name                     -- ^ @T@
996 997 998
          | PromotedT Name                -- ^ @'T@

          -- See Note [Representing concrete syntax in types]
aavogt's avatar
aavogt committed
999
          | TupleT Int                    -- ^ @(,), (,,), etc.@
1000
          | UnboxedTupleT Int             -- ^ @(#,#), (#,,#), etc.@
aavogt's avatar
aavogt committed
1001 1002
          | ArrowT                        -- ^ @->@
          | ListT                         -- ^ @[]@
1003 1004 1005 1006 1007
          | PromotedTupleT Int            -- ^ @'(), '(,), '(,,), etc.@
          | PromotedNilT                  -- ^ @'[]@
          | PromotedConsT                 -- ^ @(':)@
          | StarT                         -- ^ @*@
          | ConstraintT                   -- ^ @Constraint@
1008
          | LitT TyLit                    -- ^ @0,1,2, etc.@
1009 1010
      deriving( Show, Eq, Data, Typeable )

aavogt's avatar
aavogt committed
1011 1012
data TyVarBndr = PlainTV  Name            -- ^ @a@
               | KindedTV Name Kind       -- ^ @(a :: k)@
1013 1014
      deriving( Show, Eq, Data, Typeable )

1015 1016
data TyLit = NumTyLit Integer             -- ^ @2@
           | StrTyLit String              -- ^ @"Hello"@
Iavor S. Diatchki's avatar
Iavor S. Diatchki committed
1017 1018
  deriving ( Show, Eq, Data, Typeable )

1019 1020 1021