Parser.y 163 KB
Newer Older
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
1
--                                                              -*-haskell-*-
2 3 4 5 6 7 8 9 10
-- ---------------------------------------------------------------------------
-- (c) The University of Glasgow 1997-2003
---
-- The GHC grammar.
--
-- Author(s): Simon Marlow, Sven Panne 1997, 1998, 1999
-- ---------------------------------------------------------------------------

{
11
{-# LANGUAGE BangPatterns #-} -- required for versions of Happy before 1.18.6
12
{-# OPTIONS -Wwarn -w #-}
13
-- The above warning suppression flag is a temporary kludge.
14 15
-- While working on this module you are encouraged to remove it and fix
-- any warnings in the module. See
16
--     http://ghc.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Warnings
17 18
-- for details

19 20 21 22 23 24 25 26 27 28 29 30
-- | This module provides the generated Happy parser for Haskell. It exports
-- a number of parsers which may be used in any library that uses the GHC API.
-- A common usage pattern is to initialize the parser state with a given string
-- and then parse that string:
--
-- @
--     runParser :: DynFlags -> String -> P a -> ParseResult a
--     runParser flags str parser = unP parser parseState
--     where
--       filename = "\<interactive\>"
--       location = mkRealSrcLoc (mkFastString filename) 1 1
--       buffer = stringToStringBuffer str
31
--       parseState = mkPState flags buffer location
32 33
-- @
module Parser (parseModule, parseImport, parseStatement,
34 35
               parseDeclaration, parseExpression, parsePattern,
               parseTypeSignature,
36 37 38
               parseFullStmt, parseStmt, parseIdentifier,
               parseType, parseHeader) where

rodlogic's avatar
rodlogic committed
39 40 41 42 43
-- base
import Control.Monad    ( unless, liftM )
import GHC.Exts
import Data.Char
import Control.Monad    ( mplus )
44

rodlogic's avatar
rodlogic committed
45
-- compiler/hsSyn
46
import HsSyn
rodlogic's avatar
rodlogic committed
47 48

-- compiler/main
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
49
import HscTypes         ( IsBootInterface, WarningTxt(..) )
rodlogic's avatar
rodlogic committed
50 51 52 53
import DynFlags

-- compiler/utils
import OrdList
54
import BooleanFormula   ( BooleanFormula(..), mkTrue )
rodlogic's avatar
rodlogic committed
55 56 57 58 59
import FastString
import Maybes           ( orElse )
import Outputable

-- compiler/basicTypes
60
import RdrName
thomasw's avatar
thomasw committed
61
import OccName          ( varName, dataName, tcClsName, tvName, startsWithUnderscore )
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
62
import DataCon          ( DataCon, dataConName )
Ian Lynagh's avatar
Ian Lynagh committed
63
import SrcLoc
64
import Module
rodlogic's avatar
rodlogic committed
65 66 67 68
import BasicTypes

-- compiler/types
import Type             ( funTyCon )
dreixel's avatar
dreixel committed
69
import Kind             ( Kind, liftedTypeKind, unliftedTypeKind, mkArrowKind )
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
70
import Class            ( FunDep )
rodlogic's avatar
rodlogic committed
71 72 73 74

-- compiler/parser
import RdrHsSyn
import Lexer
75
import HaddockUtils
Alan Zimmerman's avatar
Alan Zimmerman committed
76
import ApiAnnotation
77

rodlogic's avatar
rodlogic committed
78 79
-- compiler/typecheck
import TcEvidence       ( emptyTcEvBinds )
80

rodlogic's avatar
rodlogic committed
81 82 83
-- compiler/prelude
import ForeignCall
import TysPrim          ( liftedTypeKindTyConName, eqPrimTyCon )
84
import TysWiredIn       ( unitTyCon, unitDataCon, tupleTyCon, tupleDataCon, nilDataCon,
rodlogic's avatar
rodlogic committed
85 86
                          unboxedUnitTyCon, unboxedUnitDataCon,
                          listTyCon_RDR, parrTyCon_RDR, consDataCon_RDR, eqTyCon_RDR )
Alan Zimmerman's avatar
Alan Zimmerman committed
87

88 89 90
-- compiler/utils
import Util             ( looksLikePackageName )

91 92
}

93
{- Last updated: 21 Jun 2015
94

95 96
Conflicts: 49 shift/reduce
           6  reduce/reduce
97

98 99
If you modify this parser and add a conflict, please update this comment.
You can learn more about the conflicts by passing 'happy' the -i flag:
100

101
    happy -agc --strict compiler/parser/Parser.y -idetailed-info
102

103 104 105 106 107 108
How is this section formatted? Look up the state the conflict is
reported at, and copy the list of applicable rules (at the top).  Mark
*** for the rule that is the conflicting reduction (that is, the
interpretation which is NOT taken).  NB: Happy doesn't print a rule in a
state if it is empty, but you should include it in the list (you can
look these up in the Grammar section of the info file).
109

110 111 112 113 114
Obviously the state numbers are not stable across modifications to the parser,
the idea is to reproduce enough information on each conflict so you can figure
out what happened if the states were renumbered.  Try not to gratuitously move
productions around in this file.  It's probably less important to keep
the rule annotations up-to-date.
115

116
-------------------------------------------------------------------------------
Gabor Greif's avatar
Gabor Greif committed
117

118
state 0 contains 1 shift/reduce conflicts.
Gabor Greif's avatar
Gabor Greif committed
119

120
    Conflicts: DOCNEXT (empty missing_module_keyword reduces)
121

122 123 124
Ambiguity when the source file starts with "-- | doc". We need another
token of lookahead to determine if a top declaration or the 'module' keyword
follows. Shift parses as if the 'module' keyword follows.
125

126
-------------------------------------------------------------------------------
127

128
state 49 contains 11 shift/reduce conflicts.
129

130 131 132 133 134 135 136 137 138 139
        context -> btype . '~' btype                        (rule 279)
        context -> btype .                                  (rule 280)
    *** type -> btype .                                     (rule 281)
        type -> btype . qtyconop type                       (rule 282)
        type -> btype . tyvarop type                        (rule 283)
        type -> btype . '->' ctype                          (rule 284)
        type -> btype . '~' btype                           (rule 285)
        type -> btype . SIMPLEQUOTE qconop type             (rule 286)
        type -> btype . SIMPLEQUOTE varop type              (rule 287)
        btype -> btype . atype                              (rule 299)
140

141
    Conflicts: ':' '->' '-' '!' '*' '.' '`' VARSYM CONSYM QVARSYM QCONSYM
142

143 144 145
Example of ambiguity: 'e :: a `b` c';  does this mean
    (e::a) `b` c, or
    (e :: (a `b` c))
146

147 148 149 150 151 152 153 154
The case for '->' involves view patterns rather than type operators:
    'case v of { x :: T -> T ... } '
    Which of these two is intended?
          case v of
            (x::T) -> T         -- Rhs is T
    or
          case v of
            (x::T -> T) -> ..   -- Rhs is ...
155

156
-------------------------------------------------------------------------------
157

158
state 120 contains 15 shift/reduce conflicts.
159

160 161 162 163 164 165 166
        exp -> infixexp . '::' sigtype                      (rule 414)
        exp -> infixexp . '-<' exp                          (rule 415)
        exp -> infixexp . '>-' exp                          (rule 416)
        exp -> infixexp . '-<<' exp                         (rule 417)
        exp -> infixexp . '>>-' exp                         (rule 418)
    *** exp -> infixexp .                                   (rule 419)
        infixexp -> infixexp . qop exp10                    (rule 421)
167

168 169
    Conflicts: ':' '::' '-' '!' '*' '-<' '>-' '-<<' '>>-'
               '.' '`' VARSYM CONSYM QVARSYM QCONSYM
170

171 172 173 174
Examples of ambiguity:
    'if x then y else z -< e'
    'if x then y else z :: T'
    'if x then y else z + 1' (NB: '+' is in VARSYM)
175

176 177 178 179
Shift parses as (per longest-parse rule):
    'if x then y else (z -< T)'
    'if x then y else (z :: T)'
    'if x then y else (z + 1)'
180

181
-------------------------------------------------------------------------------
182

183
state 281 contains 1 shift/reduce conflicts.
184

185
        rule -> STRING . rule_activation rule_forall infixexp '=' exp    (rule 214)
186

187
    Conflict: '[' (empty rule_activation reduces)
188

189 190 191
We don't know whether the '[' starts the activation or not: it
might be the start of the declaration with the activation being
empty.  --SDM 1/4/2002
192

193 194
Example ambiguity:
    '{-# RULE [0] f = ... #-}'
195

196 197
We parse this as having a [0] rule activation for rewriting 'f', rather
a rule instructing how to rewrite the expression '[0] f'.
198

199
-------------------------------------------------------------------------------
ross's avatar
ross committed
200

201
state 290 contains 11 shift/reduce conflicts.
202

203 204 205 206 207 208 209 210
    *** type -> btype .                                     (rule 281)
        type -> btype . qtyconop type                       (rule 282)
        type -> btype . tyvarop type                        (rule 283)
        type -> btype . '->' ctype                          (rule 284)
        type -> btype . '~' btype                           (rule 285)
        type -> btype . SIMPLEQUOTE qconop type             (rule 286)
        type -> btype . SIMPLEQUOTE varop type              (rule 287)
        btype -> btype . atype                              (rule 299)
211

212
    Conflicts: ':' '->' '-' '!' '*' '.' '`' VARSYM CONSYM QVARSYM QCONSYM
213

214
Same as State 49, but minus the context productions.
215

216
-------------------------------------------------------------------------------
217

218
state 326 contains 1 shift/reduce conflicts.
219

220 221
        tup_exprs -> commas . tup_tail                      (rule 502)
        sysdcon -> '(' commas . ')'                         (rule 610)
222
        commas -> commas . ','                              (rule 725)
223

224
    Conflict: ')' (empty tup_tail reduces)
225

226 227 228 229
A tuple section with NO free variables '(,,)' is indistinguishable
from the Haskell98 data constructor for a tuple.  Shift resolves in
favor of sysdcon, which is good because a tuple section will get rejected
if -XTupleSections is not specified.
230

231
-------------------------------------------------------------------------------
232

233
state 378 contains 1 shift/reduce conflicts.
234 235 236 237 238 239 240 241 242 243 244

        tup_exprs -> commas . tup_tail                      (rule 502)
        sysdcon -> '(#' commas . '#)'                       (rule 612)
        commas -> commas . ','                              (rule 724)

    Conflict: '#)' (empty tup_tail reduces)

Same as State 320 for unboxed tuples.

-------------------------------------------------------------------------------

245
state 406 contains 1 shift/reduce conflicts.
246 247 248 249 250 251 252 253 254 255 256 257 258

        exp10 -> 'let' binds . 'in' exp                     (rule 423)
        exp10 -> 'let' binds . 'in' error                   (rule 438)
        exp10 -> 'let' binds . error                        (rule 439)
    *** qual -> 'let' binds .                               (rule 576)

    Conflict: error

TODO: Why?

-------------------------------------------------------------------------------


259
state 470 contains 1 shift/reduce conflicts.
260 261 262 263 264 265 266 267 268 269

    *** strict_mark -> '{-# NOUNPACK' '#-}' .               (rule 268)
        strict_mark -> '{-# NOUNPACK' '#-}' . '!'           (rule 270)

    Conflict: '!'

TODO: Why?

-------------------------------------------------------------------------------

270
state 471 contains 1 shift/reduce conflicts.
271 272 273 274 275 276 277 278 279 280

    *** strict_mark -> '{-# UNPACK' '#-}' .                 (rule 267)
        strict_mark -> '{-# UNPACK' '#-}' . '!'             (rule 269)

    Conflict: '!'

Same as State 462

-------------------------------------------------------------------------------

281
state 502 contains 1 shift/reduce conflicts.
282 283 284 285 286 287 288 289 290 291 292

        context -> btype '~' btype .                        (rule 279)
    *** type -> btype '~' btype .                           (rule 285)
        btype -> btype . atype                              (rule 299)

    Conflict: '!'

TODO: Why?

-------------------------------------------------------------------------------

293
state 637 contains 1 shift/reduce conflicts.
294 295 296 297 298 299 300 301 302 303 304 305 306 307

    *** aexp2 -> ipvar .                                    (rule 462)
        dbind -> ipvar . '=' exp                            (rule 587)

    Conflict: '='

Example ambiguity: 'let ?x ...'

The parser can't tell whether the ?x is the lhs of a normal binding or
an implicit binding.  Fortunately, resolving as shift gives it the only
sensible meaning, namely the lhs of an implicit binding.

-------------------------------------------------------------------------------

308
state 704 contains 1 shift/reduce conflicts.
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324

        rule -> STRING rule_activation . rule_forall infixexp '=' exp    (rule 214)

    Conflict: 'forall' (empty rule_forall reduces)

Example ambiguity: '{-# RULES "name" forall = ... #-}'

'forall' is a valid variable name---we don't know whether
to treat a forall on the input as the beginning of a quantifier
or the beginning of the rule itself.  Resolving to shift means
it's always treated as a quantifier, hence the above is disallowed.
This saves explicitly defining a grammar for the rule lhs that
doesn't include 'forall'.

-------------------------------------------------------------------------------

325
state 775 contains 1 shift/reduce conflicts.
326 327 328 329 330 331 332 333 334 335

    *** type -> btype '~' btype .                           (rule 285)
        btype -> btype . atype                              (rule 299)

    Conflict: '!'

TODO: Why?

-------------------------------------------------------------------------------

336
state 958 contains 1 shift/reduce conflicts.
337 338 339

        transformqual -> 'then' 'group' . 'using' exp       (rule 525)
        transformqual -> 'then' 'group' . 'by' exp 'using' exp    (rule 526)
340
    *** special_id -> 'group' .                             (rule 701)
341 342 343 344 345 346 347

    Conflict: 'by'

TODO: Why?

-------------------------------------------------------------------------------

348
state 1237 contains 1 reduce/reduce conflicts.
349 350 351 352 353 354 355 356 357 358

    *** tyconsym -> ':' .                                   (rule 642)
        consym -> ':' .                                     (rule 712)

    Conflict: ')'

TODO: Same as State 1230

-------------------------------------------------------------------------------

359
state 1238 contains 1 reduce/reduce conflicts.
360 361

    *** tyconsym -> CONSYM .                                (rule 640)
362
        consym -> CONSYM .                                  (rule 711)
363 364 365 366 367 368

    Conflict: ')'

TODO: Why?  (NB: This one has been around for a while; it's quite puzzling
    because we really shouldn't get confused between tyconsym and consym.
    Trace the state machine, maybe?)
369

370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
-------------------------------------------------------------------------------
state 1259 contains 1 reduce/reduce conflicts.

        *** tyconsym -> '-' .                                   (rule 651)
        varsym -> '-' .                                         (rule 694)

        Conflict : ')'

Introduced in "Refactor tuple constraints"
      (ffc21506894c7887d3620423aaf86bc6113a1071)
-------------------------------------------------------------------------------
state 1260 contains 1 reduce/reduce conflicts.

        *** tyconsym -> '-' .                                   (rule 651)
        varsym -> '-' .                                         (rule 694)

        Conflict: ')'

Same as 1259

-------------------------------------------------------------------------------
state 1261 contains 1 reduce/reduce conflicts.

        *** tyconsym -> VARSYM .                                (rule 648)
        varsym_no_minus -> VARSYM .                             (rule 695)

  Conflict: ')'

Same as 1260

-------------------------------------------------------------------------------
state 1262 contains 1 reduce/reduce conflicts.

        *** qtyconsym -> QVARSYM .                              (rule 645)
        qvarsym1 -> QVARSYM .                                   (rule 692)

        Conflict: ')'

Same as 1260

410 411
-- -----------------------------------------------------------------------------
-- API Annotations
412
--
413 414 415 416 417 418 419 420 421 422 423

A lot of the productions are now cluttered with calls to
aa,am,ams,amms etc.

These are helper functions to make sure that the locations of the
various keywords such as do / let / in are captured for use by tools
that want to do source to source conversions, such as refactorers or
structured editors.

The helper functions are defined at the bottom of this file.

424 425 426 427
See
  https://ghc.haskell.org/trac/ghc/wiki/ApiAnnotations and
  https://ghc.haskell.org/trac/ghc/wiki/GhcAstAnnotations
for some background.
428

429 430 431 432 433
-- -----------------------------------------------------------------------------

-}

%token
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
434 435
 '_'            { L _ ITunderscore }            -- Haskell keywords
 'as'           { L _ ITas }
436 437 438
 'case'         { L _ ITcase }
 'class'        { L _ ITclass }
 'data'         { L _ ITdata }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462
 'default'      { L _ ITdefault }
 'deriving'     { L _ ITderiving }
 'do'           { L _ ITdo }
 'else'         { L _ ITelse }
 'hiding'       { L _ IThiding }
 'if'           { L _ ITif }
 'import'       { L _ ITimport }
 'in'           { L _ ITin }
 'infix'        { L _ ITinfix }
 'infixl'       { L _ ITinfixl }
 'infixr'       { L _ ITinfixr }
 'instance'     { L _ ITinstance }
 'let'          { L _ ITlet }
 'module'       { L _ ITmodule }
 'newtype'      { L _ ITnewtype }
 'of'           { L _ ITof }
 'qualified'    { L _ ITqualified }
 'then'         { L _ ITthen }
 'type'         { L _ ITtype }
 'where'        { L _ ITwhere }

 'forall'       { L _ ITforall }                -- GHC extension keywords
 'foreign'      { L _ ITforeign }
 'export'       { L _ ITexport }
463
 'label'        { L _ ITlabel }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
464 465
 'dynamic'      { L _ ITdynamic }
 'safe'         { L _ ITsafe }
466
 'interruptible' { L _ ITinterruptible }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
467 468 469
 'unsafe'       { L _ ITunsafe }
 'mdo'          { L _ ITmdo }
 'family'       { L _ ITfamily }
470
 'role'         { L _ ITrole }
471 472
 'stdcall'      { L _ ITstdcallconv }
 'ccall'        { L _ ITccallconv }
473
 'capi'         { L _ ITcapiconv }
474
 'prim'         { L _ ITprimcallconv }
thoughtpolice's avatar
thoughtpolice committed
475
 'javascript'   { L _ ITjavascriptcallconv }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
476 477
 'proc'         { L _ ITproc }          -- for arrow notation extension
 'rec'          { L _ ITrec }           -- for arrow notation extension
478 479 480
 'group'    { L _ ITgroup }     -- for list transform extension
 'by'       { L _ ITby }        -- for list transform extension
 'using'    { L _ ITusing }     -- for list transform extension
cactus's avatar
cactus committed
481
 'pattern'      { L _ ITpattern } -- for pattern synonyms
Facundo Domínguez's avatar
Facundo Domínguez committed
482
 'static'       { L _ ITstatic }  -- for static pointers extension
483

Alan Zimmerman's avatar
Alan Zimmerman committed
484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
 '{-# INLINE'             { L _ (ITinline_prag _ _ _) }
 '{-# SPECIALISE'         { L _ (ITspec_prag _) }
 '{-# SPECIALISE_INLINE'  { L _ (ITspec_inline_prag _ _) }
 '{-# SOURCE'             { L _ (ITsource_prag _) }
 '{-# RULES'              { L _ (ITrules_prag _) }
 '{-# CORE'               { L _ (ITcore_prag _) }      -- hdaume: annotated core
 '{-# SCC'                { L _ (ITscc_prag _)}
 '{-# GENERATED'          { L _ (ITgenerated_prag _) }
 '{-# DEPRECATED'         { L _ (ITdeprecated_prag _) }
 '{-# WARNING'            { L _ (ITwarning_prag _) }
 '{-# UNPACK'             { L _ (ITunpack_prag _) }
 '{-# NOUNPACK'           { L _ (ITnounpack_prag _) }
 '{-# ANN'                { L _ (ITann_prag _) }
 '{-# VECTORISE'          { L _ (ITvect_prag _) }
 '{-# VECTORISE_SCALAR'   { L _ (ITvect_scalar_prag _) }
 '{-# NOVECTORISE'        { L _ (ITnovect_prag _) }
 '{-# MINIMAL'            { L _ (ITminimal_prag _) }
 '{-# CTYPE'              { L _ (ITctype _) }
 '{-# OVERLAPPING'        { L _ (IToverlapping_prag _) }
 '{-# OVERLAPPABLE'       { L _ (IToverlappable_prag _) }
 '{-# OVERLAPS'           { L _ (IToverlaps_prag _) }
 '{-# INCOHERENT'         { L _ (ITincoherent_prag _) }
 '#-}'                    { L _ ITclose_prag }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
507 508 509 510 511 512

 '..'           { L _ ITdotdot }                        -- reserved symbols
 ':'            { L _ ITcolon }
 '::'           { L _ ITdcolon }
 '='            { L _ ITequal }
 '\\'           { L _ ITlam }
513
 'lcase'        { L _ ITlcase }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
514 515 516 517 518 519 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 545 546
 '|'            { L _ ITvbar }
 '<-'           { L _ ITlarrow }
 '->'           { L _ ITrarrow }
 '@'            { L _ ITat }
 '~'            { L _ ITtilde }
 '~#'           { L _ ITtildehsh }
 '=>'           { L _ ITdarrow }
 '-'            { L _ ITminus }
 '!'            { L _ ITbang }
 '*'            { L _ ITstar }
 '-<'           { L _ ITlarrowtail }            -- for arrow notation
 '>-'           { L _ ITrarrowtail }            -- for arrow notation
 '-<<'          { L _ ITLarrowtail }            -- for arrow notation
 '>>-'          { L _ ITRarrowtail }            -- for arrow notation
 '.'            { L _ ITdot }

 '{'            { L _ ITocurly }                        -- special symbols
 '}'            { L _ ITccurly }
 vocurly        { L _ ITvocurly } -- virtual open curly (from layout)
 vccurly        { L _ ITvccurly } -- virtual close curly (from layout)
 '['            { L _ ITobrack }
 ']'            { L _ ITcbrack }
 '[:'           { L _ ITopabrack }
 ':]'           { L _ ITcpabrack }
 '('            { L _ IToparen }
 ')'            { L _ ITcparen }
 '(#'           { L _ IToubxparen }
 '#)'           { L _ ITcubxparen }
 '(|'           { L _ IToparenbar }
 '|)'           { L _ ITcparenbar }
 ';'            { L _ ITsemi }
 ','            { L _ ITcomma }
 '`'            { L _ ITbackquote }
dreixel's avatar
dreixel committed
547
 SIMPLEQUOTE    { L _ ITsimpleQuote      }     -- 'x
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
548 549 550 551 552 553 554 555 556

 VARID          { L _ (ITvarid    _) }          -- identifiers
 CONID          { L _ (ITconid    _) }
 VARSYM         { L _ (ITvarsym   _) }
 CONSYM         { L _ (ITconsym   _) }
 QVARID         { L _ (ITqvarid   _) }
 QCONID         { L _ (ITqconid   _) }
 QVARSYM        { L _ (ITqvarsym  _) }
 QCONSYM        { L _ (ITqconsym  _) }
557 558
 PREFIXQVARSYM  { L _ (ITprefixqvarsym  _) }
 PREFIXQCONSYM  { L _ (ITprefixqconsym  _) }
559

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
560 561
 IPDUPVARID     { L _ (ITdupipvarid   _) }              -- GHC extension

562 563 564
 CHAR           { L _ (ITchar   _ _) }
 STRING         { L _ (ITstring _ _) }
 INTEGER        { L _ (ITinteger _ _) }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
565
 RATIONAL       { L _ (ITrational _) }
566

567 568 569 570
 PRIMCHAR       { L _ (ITprimchar   _ _) }
 PRIMSTRING     { L _ (ITprimstring _ _) }
 PRIMINTEGER    { L _ (ITprimint    _ _) }
 PRIMWORD       { L _ (ITprimword   _ _) }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
571 572 573 574 575 576 577
 PRIMFLOAT      { L _ (ITprimfloat  _) }
 PRIMDOUBLE     { L _ (ITprimdouble _) }

 DOCNEXT        { L _ (ITdocCommentNext _) }
 DOCPREV        { L _ (ITdocCommentPrev _) }
 DOCNAMED       { L _ (ITdocCommentNamed _) }
 DOCSECTION     { L _ (ITdocSection _ _) }
578

579 580 581 582 583
-- Template Haskell
'[|'            { L _ ITopenExpQuote  }
'[p|'           { L _ ITopenPatQuote  }
'[t|'           { L _ ITopenTypQuote  }
'[d|'           { L _ ITopenDecQuote  }
584
'|]'            { L _ ITcloseQuote    }
585 586
'[||'           { L _ ITopenTExpQuote   }
'||]'           { L _ ITcloseTExpQuote  }
587
TH_ID_SPLICE    { L _ (ITidEscape _)  }     -- $x
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
588
'$('            { L _ ITparenEscape   }     -- $( exp )
589 590
TH_ID_TY_SPLICE { L _ (ITidTyEscape _)  }   -- $$x
'$$('           { L _ ITparenTyEscape   }   -- $$( exp )
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
591 592
TH_TY_QUOTE     { L _ ITtyQuote       }      -- ''T
TH_QUASIQUOTE   { L _ (ITquasiQuote _) }
593
TH_QQUASIQUOTE  { L _ (ITqQuasiQuote _) }
594 595

%monad { P } { >>= } { return }
Alan Zimmerman's avatar
Alan Zimmerman committed
596
%lexer { (lexer True) } { L _ ITeof }
597 598 599
%tokentype { (Located Token) }

-- Exported parsers
600
%name parseModule module
601 602 603 604
%name parseImport importdecl
%name parseStatement stmt
%name parseDeclaration topdecl
%name parseExpression exp
605
%name parsePattern pat
606 607
%name parseTypeSignature sigdecl
%name parseFullStmt   stmt
608 609
%name parseStmt   maybe_stmt
%name parseIdentifier  identifier
610
%name parseType ctype
611
%partial parseHeader header
612 613
%%

614 615 616
-----------------------------------------------------------------------------
-- Identifiers; one of the entry points
identifier :: { Located RdrName }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
617 618 619 620
        : qvar                          { $1 }
        | qcon                          { $1 }
        | qvarop                        { $1 }
        | qconop                        { $1 }
Alan Zimmerman's avatar
Alan Zimmerman committed
621 622
    | '(' '->' ')'      {% ams (sLL $1 $> $ getRdrName funTyCon)
                               [mj AnnOpenP $1,mj AnnRarrow $2,mj AnnCloseP $3] }
623

624 625 626 627 628 629 630 631 632 633
-----------------------------------------------------------------------------
-- Module Header

-- The place for module deprecation is really too restrictive, but if it
-- was allowed at its natural place just before 'module', we get an ugly
-- s/r conflict with the second alternative. Another solution would be the
-- introduction of a new pragma DEPRECATED_MODULE, but this is not very nice,
-- either, and DEPRECATED is only expected to be used by people who really
-- know what they are doing. :-)

Alan Zimmerman's avatar
Alan Zimmerman committed
634 635 636 637 638 639 640
module :: { Located (HsModule RdrName) }
       : maybedocheader 'module' modid maybemodwarning maybeexports 'where' body
             {% fileSrcSpan >>= \ loc ->
                ams (L loc (HsModule (Just $3) $5 (fst $ snd $7)
                              (snd $ snd $7) $4 $1)
                    )
                    ([mj AnnModule $2, mj AnnWhere $6] ++ fst $7) }
641
        | body2
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
642
                {% fileSrcSpan >>= \ loc ->
Alan Zimmerman's avatar
Alan Zimmerman committed
643 644 645
                   ams (L loc (HsModule Nothing Nothing
                               (fst $ snd $1) (snd $ snd $1) Nothing Nothing))
                       (fst $1) }
646

647
maybedocheader :: { Maybe LHsDocString }
648
        : moduleheader            { $1 }
649
        | {- empty -}             { Nothing }
650 651

missing_module_keyword :: { () }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
652
        : {- empty -}                           {% pushCurrentContext }
653

654
maybemodwarning :: { Maybe (Located WarningTxt) }
Alan Zimmerman's avatar
Alan Zimmerman committed
655
    : '{-# DEPRECATED' strings '#-}'
Alan Zimmerman's avatar
Alan Zimmerman committed
656 657
                      {% ajs (Just (sLL $1 $> $ DeprecatedTxt (sL1 $1 (getDEPRECATED_PRAGs $1)) (snd $ unLoc $2)))
                             (mo $1:mc $3: (fst $ unLoc $2)) }
Alan Zimmerman's avatar
Alan Zimmerman committed
658
    | '{-# WARNING' strings '#-}'
Alan Zimmerman's avatar
Alan Zimmerman committed
659
                         {% ajs (Just (sLL $1 $> $ WarningTxt (sL1 $1 (getWARNING_PRAGs $1)) (snd $ unLoc $2)))
Alan Zimmerman's avatar
Alan Zimmerman committed
660
                                (mo $1:mc $3 : (fst $ unLoc $2)) }
Ian Lynagh's avatar
Ian Lynagh committed
661
    |  {- empty -}                  { Nothing }
662

Alan Zimmerman's avatar
Alan Zimmerman committed
663 664
body    :: { ([AddAnn]
             ,([LImportDecl RdrName], [LHsDecl RdrName])) }
Alan Zimmerman's avatar
Alan Zimmerman committed
665
        :  '{'            top '}'      { (moc $1:mcc $3:(fst $2)
Alan Zimmerman's avatar
Alan Zimmerman committed
666 667 668 669 670
                                         , snd $2) }
        |      vocurly    top close    { (fst $2, snd $2) }

body2   :: { ([AddAnn]
             ,([LImportDecl RdrName], [LHsDecl RdrName])) }
Alan Zimmerman's avatar
Alan Zimmerman committed
671
        :  '{' top '}'                          { (moc $1:mcc $3
Alan Zimmerman's avatar
Alan Zimmerman committed
672 673 674 675 676
                                                   :(fst $2), snd $2) }
        |  missing_module_keyword top close     { ([],snd $2) }

top     :: { ([AddAnn]
             ,([LImportDecl RdrName], [LHsDecl RdrName])) }
Alan Zimmerman's avatar
Alan Zimmerman committed
677 678 679 680 681 682 683 684 685 686
        : importdecls                   { (fst $1
                                          ,(reverse $ snd $1,[]))}
        | importdecls ';' cvtopdecls    {% if null (snd $1)
                                             then return ((mj AnnSemi $2:(fst $1))
                                                         ,(reverse $ snd $1,$3))
                                             else do
                                              { addAnnotation (gl $ head $ snd $1)
                                                              AnnSemi (gl $2)
                                              ; return (fst $1
                                                       ,(reverse $ snd $1,$3)) }}
Alan Zimmerman's avatar
Alan Zimmerman committed
687
        | cvtopdecls                    { ([],([],$1)) }
688 689

cvtopdecls :: { [LHsDecl RdrName] }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
690
        : topdecls                              { cvTopDecls $1 }
691

692 693 694
-----------------------------------------------------------------------------
-- Module declaration & imports only

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
695 696 697
header  :: { Located (HsModule RdrName) }
        : maybedocheader 'module' modid maybemodwarning maybeexports 'where' header_body
                {% fileSrcSpan >>= \ loc ->
Alan Zimmerman's avatar
Alan Zimmerman committed
698 699
                   ams (L loc (HsModule (Just $3) $5 $7 [] $4 $1
                          )) [mj AnnModule $2,mj AnnWhere $6] }
700
        | header_body2
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
701
                {% fileSrcSpan >>= \ loc ->
702
                   return (L loc (HsModule Nothing Nothing $1 [] Nothing
703
                          Nothing)) }
704 705

header_body :: { [LImportDecl RdrName] }
Alan Zimmerman's avatar
Alan Zimmerman committed
706 707
        :  '{'            importdecls           { snd $2 }
        |      vocurly    importdecls           { snd $2 }
708 709

header_body2 :: { [LImportDecl RdrName] }
Alan Zimmerman's avatar
Alan Zimmerman committed
710 711
        :  '{' importdecls                      { snd $2 }
        |  missing_module_keyword importdecls   { snd $2 }
712

713 714 715
-----------------------------------------------------------------------------
-- The Export List

Alan Zimmerman's avatar
Alan Zimmerman committed
716
maybeexports :: { (Maybe (Located [LIE RdrName])) }
Alan Zimmerman's avatar
Alan Zimmerman committed
717
        :  '(' exportlist ')'       {% ams (sLL $1 $> ()) [mop $1,mcp $3] >>
Alan Zimmerman's avatar
Alan Zimmerman committed
718 719
                                       return (Just (sLL $1 $> (fromOL $2))) }
        |  {- empty -}              { Nothing }
720

721
exportlist :: { OrdList (LIE RdrName) }
Alan Zimmerman's avatar
Alan Zimmerman committed
722 723 724
        : expdoclist ',' expdoclist   {% addAnnotation (oll $1) AnnComma (gl $2)
                                         >> return ($1 `appOL` $3) }
        | exportlist1                 { $1 }
725

726
exportlist1 :: { OrdList (LIE RdrName) }
Alan Zimmerman's avatar
Alan Zimmerman committed
727 728 729 730 731 732
        : expdoclist export expdoclist ',' exportlist1
                          {% (addAnnotation (oll ($1 `appOL` $2 `appOL` $3))
                                            AnnComma (gl $4) ) >>
                              return ($1 `appOL` $2 `appOL` $3 `appOL` $5) }
        | expdoclist export expdoclist             { $1 `appOL` $2 `appOL` $3 }
        | expdoclist                               { $1 }
733

734 735 736
expdoclist :: { OrdList (LIE RdrName) }
        : exp_doc expdoclist                           { $1 `appOL` $2 }
        | {- empty -}                                  { nilOL }
737

738
exp_doc :: { OrdList (LIE RdrName) }
rodlogic's avatar
rodlogic committed
739 740 741
        : docsection    { unitOL (sL1 $1 (case (unLoc $1) of (n, doc) -> IEGroup n doc)) }
        | docnamed      { unitOL (sL1 $1 (IEDocNamed ((fst . unLoc) $1))) }
        | docnext       { unitOL (sL1 $1 (IEDoc (unLoc $1))) }
742 743


744 745
   -- No longer allow things like [] and (,,,) to be exported
   -- They are built in syntax, always available
746
export  :: { OrdList (LIE RdrName) }
Alan Zimmerman's avatar
Alan Zimmerman committed
747
        : qcname_ext export_subspec  {% amsu (sLL $1 $> (mkModuleImpExp $1
748
                                                    (snd $ unLoc $2)))
Alan Zimmerman's avatar
Alan Zimmerman committed
749 750 751 752 753 754 755 756
                                             (fst $ unLoc $2) }
        |  'module' modid            {% amsu (sLL $1 $> (IEModuleContents $2))
                                             [mj AnnModule $1] }
        |  'pattern' qcon            {% amsu (sLL $1 $> (IEVar $2))
                                             [mj AnnPattern $1] }

export_subspec :: { Located ([AddAnn],ImpExpSubSpec) }
        : {- empty -}             { sL0 ([],ImpExpAbs) }
Alan Zimmerman's avatar
Alan Zimmerman committed
757
        | '(' '..' ')'            { sLL $1 $> ([mop $1,mcp $3,mj AnnDotdot $2]
Alan Zimmerman's avatar
Alan Zimmerman committed
758
                                       , ImpExpAll) }
Alan Zimmerman's avatar
Alan Zimmerman committed
759 760
        | '(' ')'                 { sLL $1 $> ([mop $1,mcp $2],ImpExpList []) }
        | '(' qcnames ')'         { sLL $1 $> ([mop $1,mcp $3],ImpExpList (reverse $2)) }
761

762
qcnames :: { [Located RdrName] }     -- A reversed list
Alan Zimmerman's avatar
Alan Zimmerman committed
763 764
        :  qcnames ',' qcname_ext       {% (aa (head $1) (AnnComma, $2)) >>
                                           return ($3  : $1) }
765
        |  qcname_ext                   { [$1]  }
766

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
767 768
qcname_ext :: { Located RdrName }       -- Variable or data constructor
                                        -- or tagged type constructor
Alan Zimmerman's avatar
Alan Zimmerman committed
769
        :  qcname                   { $1 }
770 771
        |  'type' qcname            {% amms (mkTypeImpExp (sLL $1 $> (unLoc $2)))
                                            [mj AnnType $1,mj AnnVal $2] }
772

773
qcname  :: { Located RdrName }  -- Variable or type constructor
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
774
        :  qvar                         { $1 }
775
        |  oqtycon                      { $1 }
776 777 778 779 780 781 782

-----------------------------------------------------------------------------
-- Import Declarations

-- import decls can be *empty*, or even just a string of semicolons
-- whereas topdecls must contain at least one topdecl.

Alan Zimmerman's avatar
Alan Zimmerman committed
783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798
importdecls :: { ([AddAnn],[LImportDecl RdrName]) }
        : importdecls ';' importdecl
                                {% if null (snd $1)
                                     then return (mj AnnSemi $2:fst $1,$3 : snd $1)
                                     else do
                                      { addAnnotation (gl $ head $ snd $1)
                                                      AnnSemi (gl $2)
                                      ; return (fst $1,$3 : snd $1) } }
        | importdecls ';'       {% if null (snd $1)
                                     then return ((mj AnnSemi $2:fst $1),snd $1)
                                     else do
                                       { addAnnotation (gl $ head $ snd $1)
                                                       AnnSemi (gl $2)
                                       ; return $1} }
        | importdecl             { ([],[$1]) }
        | {- empty -}            { ([],[]) }
799 800

importdecl :: { LImportDecl RdrName }
801
        : 'import' maybe_src maybe_safe optqualified maybe_pkg modid maybeas maybeimpspec
Alan Zimmerman's avatar
Alan Zimmerman committed
802
                {% ams (L (comb4 $1 $6 (snd $7) $8) $
Alan Zimmerman's avatar
Alan Zimmerman committed
803 804
                  ImportDecl { ideclSourceSrc = snd $ fst $2
                             , ideclName = $6, ideclPkgQual = snd $5
Alan Zimmerman's avatar
Alan Zimmerman committed
805 806 807 808
                             , ideclSource = snd $2, ideclSafe = snd $3
                             , ideclQualified = snd $4, ideclImplicit = False
                             , ideclAs = unLoc (snd $7)
                             , ideclHiding = unLoc $8 })
Alan Zimmerman's avatar
Alan Zimmerman committed
809
                   ((mj AnnImport $1 : (fst $ fst $2) ++ fst $3 ++ fst $4
810
                                    ++ fst $5 ++ fst $7)) }
Alan Zimmerman's avatar
Alan Zimmerman committed
811

Alan Zimmerman's avatar
Alan Zimmerman committed
812 813 814 815
maybe_src :: { (([AddAnn],Maybe SourceText),IsBootInterface) }
        : '{-# SOURCE' '#-}'        { (([mo $1,mc $2],Just (getSOURCE_PRAGs $1))
                                      ,True) }
        | {- empty -}               { (([],Nothing),False) }
Alan Zimmerman's avatar
Alan Zimmerman committed
816 817 818 819 820

maybe_safe :: { ([AddAnn],Bool) }
        : 'safe'                                { ([mj AnnSafe $1],True) }
        | {- empty -}                           { ([],False) }

821
maybe_pkg :: { ([AddAnn],Maybe (SourceText,FastString)) }
822 823
        : STRING  {% let pkgFS = getSTRING $1 in
                     if looksLikePackageName (unpackFS pkgFS)
824
                        then return ([mj AnnPackageName $1], Just (getSTRINGs $1,pkgFS))
825 826 827 828
                        else parseErrorSDoc (getLoc $1) $ vcat [
                             text "parse error" <> colon <+> quotes (ppr pkgFS),
                             text "Version number or non-alphanumeric" <+>
                             text "character in package name"] }
Alan Zimmerman's avatar
Alan Zimmerman committed
829 830 831 832 833 834 835
        | {- empty -}                           { ([],Nothing) }

optqualified :: { ([AddAnn],Bool) }
        : 'qualified'                           { ([mj AnnQualified $1],True)  }
        | {- empty -}                           { ([],False) }

maybeas :: { ([AddAnn],Located (Maybe ModuleName)) }
836 837 838
        : 'as' modid                           { ([mj AnnAs $1,mj AnnVal $2]
                                                 ,sLL $1 $> (Just (unLoc $2))) }
        | {- empty -}                          { ([],noLoc Nothing) }
839

840
maybeimpspec :: { Located (Maybe (Bool, Located [LIE RdrName])) }
Alan Zimmerman's avatar
Alan Zimmerman committed
841 842
        : impspec                  { L (gl $1) (Just (unLoc $1)) }
        | {- empty -}              { noLoc Nothing }
843

844
impspec :: { Located (Bool, Located [LIE RdrName]) }
Alan Zimmerman's avatar
Alan Zimmerman committed
845 846 847 848 849 850
        :  '(' exportlist ')'               {% ams (sLL $1 $> (False,
                                                      sLL $1 $> $ fromOL $2))
                                                   [mop $1,mcp $3] }
        |  'hiding' '(' exportlist ')'      {% ams (sLL $1 $> (True,
                                                      sLL $1 $> $ fromOL $3))
                                               [mj AnnHiding $1,mop $2,mcp $4] }
851 852 853 854

-----------------------------------------------------------------------------
-- Fixity Declarations

855 856 857 858
prec    :: { Located Int }
        : {- empty -}           { noLoc 9 }
        | INTEGER
                 {% checkPrecP (sL1 $1 (fromInteger (getINTEGER $1))) }
859

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
860
infix   :: { Located FixityDirection }
rodlogic's avatar
rodlogic committed
861 862 863
        : 'infix'                               { sL1 $1 InfixN  }
        | 'infixl'                              { sL1 $1 InfixL  }
        | 'infixr'                              { sL1 $1 InfixR }
864

Alan Zimmerman's avatar
Alan Zimmerman committed
865
ops     :: { Located (OrdList (Located RdrName)) }
Alan Zimmerman's avatar
Alan Zimmerman committed
866 867 868
        : ops ',' op       {% addAnnotation (oll $ unLoc $1) AnnComma (gl $2) >>
                              return (sLL $1 $> ((unLoc $1) `appOL` unitOL $3))}
        | op               { sL1 $1 (unitOL $1) }
869 870 871 872

-----------------------------------------------------------------------------
-- Top-Level Declarations

873
topdecls :: { OrdList (LHsDecl RdrName) }
874
        : topdecls ';' topdecl        {% addAnnotation (oll $1) AnnSemi (gl $2)
875
                                         >> return ($1 `appOL` unitOL $3) }
Alan Zimmerman's avatar
Alan Zimmerman committed
876 877
        | topdecls ';'                {% addAnnotation (oll $1) AnnSemi (gl $2)
                                         >> return $1 }
878 879 880 881 882 883 884 885 886
        | topdecl                     { unitOL $1 }

topdecl :: { LHsDecl RdrName }
        : cl_decl                               { sL1 $1 (TyClD (unLoc $1)) }
        | ty_decl                               { sL1 $1 (TyClD (unLoc $1)) }
        | inst_decl                             { sL1 $1 (InstD (unLoc $1)) }
        | stand_alone_deriving                  { sLL $1 $> (DerivD (unLoc $1)) }
        | role_annot                            { sL1 $1 (RoleAnnotD (unLoc $1)) }
        | 'default' '(' comma_types0 ')'    {% ams (sLL $1 $> (DefD (DefaultDecl $3)))
thomasw's avatar
thomasw committed
887
                                                         [mj AnnDefault $1
thomasw's avatar
thomasw committed
888
                                                         ,mop $2,mcp $4] }
889
        | 'foreign' fdecl          {% ams (sLL $1 $> (snd $ unLoc $2))
Alan Zimmerman's avatar
Alan Zimmerman committed
890
                                           (mj AnnForeign $1:(fst $ unLoc $2)) }
891
        | '{-# DEPRECATED' deprecations '#-}'   {% ams (sLL $1 $> $ WarningD (Warnings (getDEPRECATED_PRAGs $1) (fromOL $2)))
Alan Zimmerman's avatar
Alan Zimmerman committed
892
                                                       [mo $1,mc $3] }
893
        | '{-# WARNING' warnings '#-}'          {% ams (sLL $1 $> $ WarningD (Warnings (getWARNING_PRAGs $1) (fromOL $2)))
Alan Zimmerman's avatar
Alan Zimmerman committed
894
                                                       [mo $1,mc $3] }
895
        | '{-# RULES' rules '#-}'               {% ams (sLL $1 $> $ RuleD (HsRules (getRULES_PRAGs $1) (fromOL $2)))
Alan Zimmerman's avatar
Alan Zimmerman committed
896
                                                       [mo $1,mc $3] }
897
        | '{-# VECTORISE' qvar '=' exp '#-}' {% ams (sLL $1 $> $ VectD (HsVect (getVECT_PRAGs $1) $2 $4))
Alan Zimmerman's avatar
Alan Zimmerman committed
898 899
                                                    [mo $1,mj AnnEqual $3
                                                    ,mc $5] }
900
        | '{-# NOVECTORISE' qvar '#-}'       {% ams (sLL $1 $> $ VectD (HsNoVect (getNOVECT_PRAGs $1) $2))
Alan Zimmerman's avatar
Alan Zimmerman committed
901
                                                     [mo $1,mc $3] }
902
        | '{-# VECTORISE' 'type' gtycon '#-}'
903
                                {% ams (sLL $1 $> $
Alan Zimmerman's avatar
Alan Zimmerman committed
904
                                    VectD (HsVectTypeIn (getVECT_PRAGs $1) False $3 Nothing))
Alan Zimmerman's avatar
Alan Zimmerman committed
905 906
                                    [mo $1,mj AnnType $2,mc $4] }

907
        | '{-# VECTORISE_SCALAR' 'type' gtycon '#-}'
908
                                {% ams (sLL $1 $> $
Alan Zimmerman's avatar
Alan Zimmerman committed
909
                                    VectD (HsVectTypeIn (getVECT_SCALAR_PRAGs $1) True $3 Nothing))
Alan Zimmerman's avatar
Alan Zimmerman committed
910 911
                                    [mo $1,mj AnnType $2,mc $4] }

912
        | '{-# VECTORISE' 'type' gtycon '=' gtycon '#-}'
913
                                {% ams (sLL $1 $> $
Alan Zimmerman's avatar
Alan Zimmerman committed
914
                                    VectD (HsVectTypeIn (getVECT_PRAGs $1) False $3 (Just $5)))
Alan Zimmerman's avatar
Alan Zimmerman committed
915
                                    [mo $1,mj AnnType $2,mj AnnEqual $4,mc $6] }
916
        | '{-# VECTORISE_SCALAR' 'type' gtycon '=' gtycon '#-}'
917
                                {% ams (sLL $1 $> $
Alan Zimmerman's avatar
Alan Zimmerman committed
918
                                    VectD (HsVectTypeIn (getVECT_SCALAR_PRAGs $1) True $3 (Just $5)))
Alan Zimmerman's avatar
Alan Zimmerman committed
919 920 921
                                    [mo $1,mj AnnType $2,mj AnnEqual $4,mc $6] }

        | '{-# VECTORISE' 'class' gtycon '#-}'
922
                                         {% ams (sLL $1 $>  $ VectD (HsVectClassIn (getVECT_PRAGs $1) $3))
Alan Zimmerman's avatar
Alan Zimmerman committed
923
                                                 [mo $1,mj AnnClass $2,mc $4] }
924 925
        | annotation { $1 }
        | decl_no_th                            { $1 }
926 927 928

        -- Template Haskell Extension
        -- The $(..) form is one possible form of infixexp
929
        -- but we treat an arbitrary expression just as if
930
        -- it had a $(..) wrapped around it
931
        | infixexp                              { sLL $1 $> $ mkSpliceDecl $1 }
932

933 934 935
-- Type classes
--
cl_decl :: { LTyClDecl RdrName }
936
        : 'class' tycl_hdr fds where_cls
Alan Zimmerman's avatar
Alan Zimmerman committed
937
                {% amms (mkClassDecl (comb4 $1 $2 $3 $4) $2 $3 (snd $ unLoc $4))
Alan Zimmerman's avatar
Alan Zimmerman committed
938
                        (mj AnnClass $1:(fst $ unLoc $3)++(fst $ unLoc $4)) }
939

940
-- Type declarations (toplevel)
941 942
--
ty_decl :: { LTyClDecl RdrName }
943
           -- ordinary type synonyms
944
        : 'type' type '=' ctypedoc
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
945 946 947 948 949 950
                -- Note ctype, not sigtype, on the right of '='
                -- We allow an explicit for-all but we don't insert one
                -- in   type Foo a = (b,b)
                -- Instead we just say b is out of scope
                --
                -- Note the use of type for the head; this allows
951
                -- infix type constructors to be declared
952
                {% amms (mkTySynonym (comb2 $1 $4) $2 $4)
Alan Zimmerman's avatar
Alan Zimmerman committed
953
                        [mj AnnType $1,mj AnnEqual $3] }
954 955

           -- type family declarations
956
        | 'type' 'family' type opt_kind_sig where_type_family
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
957 958
                -- Note the use of type for the head; this allows
                -- infix type constructors to be declared
Alan Zimmerman's avatar
Alan Zimmerman committed
959
                {% amms (mkFamDecl (comb4 $1 $3 $4 $5) (snd $ unLoc $5) $3
960 961
                                   (snd $ unLoc $4))
                        (mj AnnType $1:mj AnnFamily $2:(fst $ unLoc $4)++(fst $ unLoc $5)) }
962

963
          -- ordinary data type or newtype declaration
964
        | data_or_newtype capi_ctype tycl_hdr constrs deriving
Alan Zimmerman's avatar
Alan Zimmerman committed
965 966 967
                {% amms (mkTyData (comb4 $1 $3 $4 $5) (snd $ unLoc $1) $2 $3
                           Nothing (reverse (snd $ unLoc $4))
                                   (unLoc $5))
968
                                   -- We need the location on tycl_hdr in case
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
969
                                   -- constrs and deriving are both empty
Alan Zimmerman's avatar
Alan Zimmerman committed
970
                        ((fst $ unLoc $1):(fst $ unLoc $4)) }
971

972
          -- ordinary GADT declaration
973
        | data_or_newtype capi_ctype tycl_hdr opt_kind_sig
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
974 975
                 gadt_constrlist
                 deriving
Alan Zimmerman's avatar
Alan Zimmerman committed
976
            {% amms (mkTyData (comb4 $1 $3 $5 $6) (snd $ unLoc $1) $2 $3
977
                            (snd $ unLoc $4) (snd $ unLoc $5) (unLoc $6) )
978
                                   -- We need the location on tycl_hdr in case
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
979
                                   -- constrs and deriving are both empty
980
                    ((fst $ unLoc $1):(fst $ unLoc $4)++(fst $ unLoc $5)) }
981

982
          -- data/newtype family
983
        | 'data' 'family' type opt_kind_sig
984 985
                {% amms (mkFamDecl (comb3 $1 $2 $4) DataFamily $3 (snd $ unLoc $4))
                        (mj AnnData $1:mj AnnFamily $2:(fst $ unLoc $4)) }
986

987
inst_decl :: { LInstDecl RdrName }
988
        : 'instance' overlap_pragma inst_type where_inst
Alan Zimmerman's avatar
Alan Zimmerman committed
989 990 991 992 993 994 995
       {% do { (binds, sigs, _, ats, adts, _) <- cvBindsAndSigs (snd $ unLoc $4)
             ; let cid = ClsInstDecl { cid_poly_ty = $3, cid_binds = binds
                                     , cid_sigs = sigs, cid_tyfam_insts = ats
                                     , cid_overlap_mode = $2
                                     , cid_datafam_insts = adts }
             ; ams (L (comb3 $1 $3 $4) (ClsInstD { cid_inst = cid }))
                   (mj AnnInstance $1 : (fst $ unLoc $4)) } }
996 997

           -- type instance declarations
998
        | 'type' 'instance' ty_fam_inst_eqn
999 1000 1001
                {% ams $3 (fst $ unLoc $3)
                >> amms (mkTyFamInst (comb2 $1 $3) (snd $ unLoc $3))
                    (mj AnnType $1:mj AnnInstance $2:(fst $ unLoc $3)) }