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 12 13 14 15 16 17 18 19 20 21 22
-- | 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
23
--       parseState = mkPState flags buffer location
24 25
-- @
module Parser (parseModule, parseImport, parseStatement,
26 27
               parseDeclaration, parseExpression, parsePattern,
               parseTypeSignature,
28
               parseStmt, parseIdentifier,
29 30
               parseType, parseHeader) where

rodlogic's avatar
rodlogic committed
31 32 33 34 35
-- base
import Control.Monad    ( unless, liftM )
import GHC.Exts
import Data.Char
import Control.Monad    ( mplus )
36

rodlogic's avatar
rodlogic committed
37
-- compiler/hsSyn
38
import HsSyn
rodlogic's avatar
rodlogic committed
39 40

-- compiler/main
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
41
import HscTypes         ( IsBootInterface, WarningTxt(..) )
rodlogic's avatar
rodlogic committed
42 43 44 45
import DynFlags

-- compiler/utils
import OrdList
46
import BooleanFormula   ( BooleanFormula(..), mkTrue )
rodlogic's avatar
rodlogic committed
47 48 49 50 51
import FastString
import Maybes           ( orElse )
import Outputable

-- compiler/basicTypes
52
import RdrName
thomasw's avatar
thomasw committed
53
import OccName          ( varName, dataName, tcClsName, tvName, startsWithUnderscore )
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
54
import DataCon          ( DataCon, dataConName )
Ian Lynagh's avatar
Ian Lynagh committed
55
import SrcLoc
56
import Module
rodlogic's avatar
rodlogic committed
57 58 59 60
import BasicTypes

-- compiler/types
import Type             ( funTyCon )
dreixel's avatar
dreixel committed
61
import Kind             ( Kind, liftedTypeKind, unliftedTypeKind, mkArrowKind )
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
62
import Class            ( FunDep )
rodlogic's avatar
rodlogic committed
63 64 65 66

-- compiler/parser
import RdrHsSyn
import Lexer
67
import HaddockUtils
Alan Zimmerman's avatar
Alan Zimmerman committed
68
import ApiAnnotation
69

rodlogic's avatar
rodlogic committed
70 71
-- compiler/typecheck
import TcEvidence       ( emptyTcEvBinds )
72

rodlogic's avatar
rodlogic committed
73 74 75
-- compiler/prelude
import ForeignCall
import TysPrim          ( liftedTypeKindTyConName, eqPrimTyCon )
76
import TysWiredIn       ( unitTyCon, unitDataCon, tupleTyCon, tupleDataCon, nilDataCon,
rodlogic's avatar
rodlogic committed
77 78
                          unboxedUnitTyCon, unboxedUnitDataCon,
                          listTyCon_RDR, parrTyCon_RDR, consDataCon_RDR, eqTyCon_RDR )
Alan Zimmerman's avatar
Alan Zimmerman committed
79

80 81 82
-- compiler/utils
import Util             ( looksLikePackageName )

83 84
}

85
{- Last updated: 21 Jun 2015
86

87 88
Conflicts: 49 shift/reduce
           6  reduce/reduce
89

90 91
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:
92

93
    happy -agc --strict compiler/parser/Parser.y -idetailed-info
94

95 96 97 98 99 100
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).
101

102 103 104 105 106
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.
107

108
-------------------------------------------------------------------------------
Gabor Greif's avatar
Gabor Greif committed
109

110
state 0 contains 1 shift/reduce conflicts.
Gabor Greif's avatar
Gabor Greif committed
111

112
    Conflicts: DOCNEXT (empty missing_module_keyword reduces)
113

114 115 116
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.
117

118
-------------------------------------------------------------------------------
119

120
state 49 contains 11 shift/reduce conflicts.
121

122 123 124 125 126 127 128 129 130 131
        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)
132

133
    Conflicts: ':' '->' '-' '!' '*' '.' '`' VARSYM CONSYM QVARSYM QCONSYM
134

135 136 137
Example of ambiguity: 'e :: a `b` c';  does this mean
    (e::a) `b` c, or
    (e :: (a `b` c))
138

139 140 141 142 143 144 145 146
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 ...
147

148
-------------------------------------------------------------------------------
149

150
state 120 contains 15 shift/reduce conflicts.
151

152 153 154 155 156 157 158
        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)
159

160 161
    Conflicts: ':' '::' '-' '!' '*' '-<' '>-' '-<<' '>>-'
               '.' '`' VARSYM CONSYM QVARSYM QCONSYM
162

163 164 165 166
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)
167

168 169 170 171
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)'
172

173
-------------------------------------------------------------------------------
174

175
state 281 contains 1 shift/reduce conflicts.
176

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

179
    Conflict: '[' (empty rule_activation reduces)
180

181 182 183
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
184

185 186
Example ambiguity:
    '{-# RULE [0] f = ... #-}'
187

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

191
-------------------------------------------------------------------------------
ross's avatar
ross committed
192

193
state 290 contains 11 shift/reduce conflicts.
194

195 196 197 198 199 200 201 202
    *** 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)
203

204
    Conflicts: ':' '->' '-' '!' '*' '.' '`' VARSYM CONSYM QVARSYM QCONSYM
205

206
Same as State 49, but minus the context productions.
207

208
-------------------------------------------------------------------------------
209

210
state 326 contains 1 shift/reduce conflicts.
211

212 213
        tup_exprs -> commas . tup_tail                      (rule 502)
        sysdcon -> '(' commas . ')'                         (rule 610)
214
        commas -> commas . ','                              (rule 725)
215

216
    Conflict: ')' (empty tup_tail reduces)
217

218 219 220 221
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.
222

223
-------------------------------------------------------------------------------
224

225
state 378 contains 1 shift/reduce conflicts.
226 227 228 229 230 231 232 233 234 235 236

        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.

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

237
state 406 contains 1 shift/reduce conflicts.
238 239 240 241 242 243 244 245 246 247 248 249 250

        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?

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


251
state 470 contains 1 shift/reduce conflicts.
252 253 254 255 256 257 258 259 260 261

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

    Conflict: '!'

TODO: Why?

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

262
state 471 contains 1 shift/reduce conflicts.
263 264 265 266 267 268 269 270 271 272

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

    Conflict: '!'

Same as State 462

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

273
state 502 contains 1 shift/reduce conflicts.
274 275 276 277 278 279 280 281 282 283 284

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

    Conflict: '!'

TODO: Why?

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

285
state 637 contains 1 shift/reduce conflicts.
286 287 288 289 290 291 292 293 294 295 296 297 298 299

    *** 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.

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

300
state 704 contains 1 shift/reduce conflicts.
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316

        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'.

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

317
state 775 contains 1 shift/reduce conflicts.
318 319 320 321 322 323 324 325 326 327

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

    Conflict: '!'

TODO: Why?

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

328
state 958 contains 1 shift/reduce conflicts.
329 330 331

        transformqual -> 'then' 'group' . 'using' exp       (rule 525)
        transformqual -> 'then' 'group' . 'by' exp 'using' exp    (rule 526)
332
    *** special_id -> 'group' .                             (rule 701)
333 334 335 336 337 338 339

    Conflict: 'by'

TODO: Why?

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

340
state 1237 contains 1 reduce/reduce conflicts.
341 342 343 344 345 346 347 348 349 350

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

    Conflict: ')'

TODO: Same as State 1230

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

351
state 1238 contains 1 reduce/reduce conflicts.
352 353

    *** tyconsym -> CONSYM .                                (rule 640)
354
        consym -> CONSYM .                                  (rule 711)
355 356 357 358 359 360

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

362 363 364 365 366 367 368 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
-------------------------------------------------------------------------------
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

402 403
-- -----------------------------------------------------------------------------
-- API Annotations
404
--
405 406 407 408 409 410 411 412 413 414 415

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.

416 417 418 419
See
  https://ghc.haskell.org/trac/ghc/wiki/ApiAnnotations and
  https://ghc.haskell.org/trac/ghc/wiki/GhcAstAnnotations
for some background.
420

421 422 423 424 425
-- -----------------------------------------------------------------------------

-}

%token
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
426 427
 '_'            { L _ ITunderscore }            -- Haskell keywords
 'as'           { L _ ITas }
428 429 430
 'case'         { L _ ITcase }
 'class'        { L _ ITclass }
 'data'         { L _ ITdata }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
 '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 }
455
 'label'        { L _ ITlabel }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
456 457
 'dynamic'      { L _ ITdynamic }
 'safe'         { L _ ITsafe }
458
 'interruptible' { L _ ITinterruptible }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
459 460 461
 'unsafe'       { L _ ITunsafe }
 'mdo'          { L _ ITmdo }
 'family'       { L _ ITfamily }
462
 'role'         { L _ ITrole }
463 464
 'stdcall'      { L _ ITstdcallconv }
 'ccall'        { L _ ITccallconv }
465
 'capi'         { L _ ITcapiconv }
466
 'prim'         { L _ ITprimcallconv }
thoughtpolice's avatar
thoughtpolice committed
467
 'javascript'   { L _ ITjavascriptcallconv }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
468 469
 'proc'         { L _ ITproc }          -- for arrow notation extension
 'rec'          { L _ ITrec }           -- for arrow notation extension
470 471 472
 '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
473
 'pattern'      { L _ ITpattern } -- for pattern synonyms
Facundo Domínguez's avatar
Facundo Domínguez committed
474
 'static'       { L _ ITstatic }  -- for static pointers extension
475

Alan Zimmerman's avatar
Alan Zimmerman committed
476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498
 '{-# 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
499 500 501 502 503 504

 '..'           { L _ ITdotdot }                        -- reserved symbols
 ':'            { L _ ITcolon }
 '::'           { L _ ITdcolon }
 '='            { L _ ITequal }
 '\\'           { L _ ITlam }
505
 'lcase'        { L _ ITlcase }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
506 507 508 509 510 511 512 513 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
 '|'            { 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
539
 SIMPLEQUOTE    { L _ ITsimpleQuote      }     -- 'x
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
540 541 542 543 544 545 546 547 548

 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  _) }
549

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

552 553 554
 CHAR           { L _ (ITchar   _ _) }
 STRING         { L _ (ITstring _ _) }
 INTEGER        { L _ (ITinteger _ _) }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
555
 RATIONAL       { L _ (ITrational _) }
556

557 558 559 560
 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
561 562 563 564 565 566 567
 PRIMFLOAT      { L _ (ITprimfloat  _) }
 PRIMDOUBLE     { L _ (ITprimdouble _) }

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

569 570 571 572 573
-- Template Haskell
'[|'            { L _ ITopenExpQuote  }
'[p|'           { L _ ITopenPatQuote  }
'[t|'           { L _ ITopenTypQuote  }
'[d|'           { L _ ITopenDecQuote  }
574
'|]'            { L _ ITcloseQuote    }
575 576
'[||'           { L _ ITopenTExpQuote   }
'||]'           { L _ ITcloseTExpQuote  }
577
TH_ID_SPLICE    { L _ (ITidEscape _)  }     -- $x
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
578
'$('            { L _ ITparenEscape   }     -- $( exp )
579 580
TH_ID_TY_SPLICE { L _ (ITidTyEscape _)  }   -- $$x
'$$('           { L _ ITparenTyEscape   }   -- $$( exp )
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
581 582
TH_TY_QUOTE     { L _ ITtyQuote       }      -- ''T
TH_QUASIQUOTE   { L _ (ITquasiQuote _) }
583
TH_QQUASIQUOTE  { L _ (ITqQuasiQuote _) }
584 585

%monad { P } { >>= } { return }
Alan Zimmerman's avatar
Alan Zimmerman committed
586
%lexer { (lexer True) } { L _ ITeof }
587 588 589
%tokentype { (Located Token) }

-- Exported parsers
590
%name parseModule module
591 592 593 594
%name parseImport importdecl
%name parseStatement stmt
%name parseDeclaration topdecl
%name parseExpression exp
595
%name parsePattern pat
596
%name parseTypeSignature sigdecl
597 598
%name parseStmt   maybe_stmt
%name parseIdentifier  identifier
599
%name parseType ctype
600
%partial parseHeader header
601 602
%%

603 604 605
-----------------------------------------------------------------------------
-- Identifiers; one of the entry points
identifier :: { Located RdrName }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
606 607 608 609
        : qvar                          { $1 }
        | qcon                          { $1 }
        | qvarop                        { $1 }
        | qconop                        { $1 }
Alan Zimmerman's avatar
Alan Zimmerman committed
610 611
    | '(' '->' ')'      {% ams (sLL $1 $> $ getRdrName funTyCon)
                               [mj AnnOpenP $1,mj AnnRarrow $2,mj AnnCloseP $3] }
612

613 614 615 616 617 618 619 620 621 622
-----------------------------------------------------------------------------
-- 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
623 624 625 626 627 628 629
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) }
630
        | body2
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
631
                {% fileSrcSpan >>= \ loc ->
Alan Zimmerman's avatar
Alan Zimmerman committed
632 633 634
                   ams (L loc (HsModule Nothing Nothing
                               (fst $ snd $1) (snd $ snd $1) Nothing Nothing))
                       (fst $1) }
635

636
maybedocheader :: { Maybe LHsDocString }
637
        : moduleheader            { $1 }
638
        | {- empty -}             { Nothing }
639 640

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

643
maybemodwarning :: { Maybe (Located WarningTxt) }
Alan Zimmerman's avatar
Alan Zimmerman committed
644
    : '{-# DEPRECATED' strings '#-}'
Alan Zimmerman's avatar
Alan Zimmerman committed
645 646
                      {% 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
647
    | '{-# WARNING' strings '#-}'
Alan Zimmerman's avatar
Alan Zimmerman committed
648
                         {% ajs (Just (sLL $1 $> $ WarningTxt (sL1 $1 (getWARNING_PRAGs $1)) (snd $ unLoc $2)))
Alan Zimmerman's avatar
Alan Zimmerman committed
649
                                (mo $1:mc $3 : (fst $ unLoc $2)) }
Ian Lynagh's avatar
Ian Lynagh committed
650
    |  {- empty -}                  { Nothing }
651

Alan Zimmerman's avatar
Alan Zimmerman committed
652 653
body    :: { ([AddAnn]
             ,([LImportDecl RdrName], [LHsDecl RdrName])) }
Alan Zimmerman's avatar
Alan Zimmerman committed
654
        :  '{'            top '}'      { (moc $1:mcc $3:(fst $2)
Alan Zimmerman's avatar
Alan Zimmerman committed
655 656 657 658 659
                                         , snd $2) }
        |      vocurly    top close    { (fst $2, snd $2) }

body2   :: { ([AddAnn]
             ,([LImportDecl RdrName], [LHsDecl RdrName])) }
Alan Zimmerman's avatar
Alan Zimmerman committed
660
        :  '{' top '}'                          { (moc $1:mcc $3
Alan Zimmerman's avatar
Alan Zimmerman committed
661 662 663 664 665
                                                   :(fst $2), snd $2) }
        |  missing_module_keyword top close     { ([],snd $2) }

top     :: { ([AddAnn]
             ,([LImportDecl RdrName], [LHsDecl RdrName])) }
Alan Zimmerman's avatar
Alan Zimmerman committed
666 667 668 669 670 671 672 673 674 675
        : 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
676
        | cvtopdecls                    { ([],([],$1)) }
677 678

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

681 682 683
-----------------------------------------------------------------------------
-- Module declaration & imports only

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
684 685 686
header  :: { Located (HsModule RdrName) }
        : maybedocheader 'module' modid maybemodwarning maybeexports 'where' header_body
                {% fileSrcSpan >>= \ loc ->
Alan Zimmerman's avatar
Alan Zimmerman committed
687 688
                   ams (L loc (HsModule (Just $3) $5 $7 [] $4 $1
                          )) [mj AnnModule $2,mj AnnWhere $6] }
689
        | header_body2
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
690
                {% fileSrcSpan >>= \ loc ->
691
                   return (L loc (HsModule Nothing Nothing $1 [] Nothing
692
                          Nothing)) }
693 694

header_body :: { [LImportDecl RdrName] }
Alan Zimmerman's avatar
Alan Zimmerman committed
695 696
        :  '{'            importdecls           { snd $2 }
        |      vocurly    importdecls           { snd $2 }
697 698

header_body2 :: { [LImportDecl RdrName] }
Alan Zimmerman's avatar
Alan Zimmerman committed
699 700
        :  '{' importdecls                      { snd $2 }
        |  missing_module_keyword importdecls   { snd $2 }
701

702 703 704
-----------------------------------------------------------------------------
-- The Export List

Alan Zimmerman's avatar
Alan Zimmerman committed
705
maybeexports :: { (Maybe (Located [LIE RdrName])) }
Alan Zimmerman's avatar
Alan Zimmerman committed
706
        :  '(' exportlist ')'       {% ams (sLL $1 $> ()) [mop $1,mcp $3] >>
Alan Zimmerman's avatar
Alan Zimmerman committed
707 708
                                       return (Just (sLL $1 $> (fromOL $2))) }
        |  {- empty -}              { Nothing }
709

710
exportlist :: { OrdList (LIE RdrName) }
Alan Zimmerman's avatar
Alan Zimmerman committed
711 712 713
        : expdoclist ',' expdoclist   {% addAnnotation (oll $1) AnnComma (gl $2)
                                         >> return ($1 `appOL` $3) }
        | exportlist1                 { $1 }
714

715
exportlist1 :: { OrdList (LIE RdrName) }
Alan Zimmerman's avatar
Alan Zimmerman committed
716 717 718 719 720 721
        : 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 }
722

723 724 725
expdoclist :: { OrdList (LIE RdrName) }
        : exp_doc expdoclist                           { $1 `appOL` $2 }
        | {- empty -}                                  { nilOL }
726

727
exp_doc :: { OrdList (LIE RdrName) }
rodlogic's avatar
rodlogic committed
728 729 730
        : 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))) }
731 732


733 734
   -- No longer allow things like [] and (,,,) to be exported
   -- They are built in syntax, always available
735
export  :: { OrdList (LIE RdrName) }
Alan Zimmerman's avatar
Alan Zimmerman committed
736
        : qcname_ext export_subspec  {% amsu (sLL $1 $> (mkModuleImpExp $1
737
                                                    (snd $ unLoc $2)))
Alan Zimmerman's avatar
Alan Zimmerman committed
738 739 740 741 742 743 744 745
                                             (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
746
        | '(' '..' ')'            { sLL $1 $> ([mop $1,mcp $3,mj AnnDotdot $2]
Alan Zimmerman's avatar
Alan Zimmerman committed
747
                                       , ImpExpAll) }
Alan Zimmerman's avatar
Alan Zimmerman committed
748 749
        | '(' ')'                 { sLL $1 $> ([mop $1,mcp $2],ImpExpList []) }
        | '(' qcnames ')'         { sLL $1 $> ([mop $1,mcp $3],ImpExpList (reverse $2)) }
750

751
qcnames :: { [Located RdrName] }     -- A reversed list
Alan Zimmerman's avatar
Alan Zimmerman committed
752 753
        :  qcnames ',' qcname_ext       {% (aa (head $1) (AnnComma, $2)) >>
                                           return ($3  : $1) }
754
        |  qcname_ext                   { [$1]  }
755

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
756 757
qcname_ext :: { Located RdrName }       -- Variable or data constructor
                                        -- or tagged type constructor
Alan Zimmerman's avatar
Alan Zimmerman committed
758
        :  qcname                   { $1 }
759 760
        |  'type' qcname            {% amms (mkTypeImpExp (sLL $1 $> (unLoc $2)))
                                            [mj AnnType $1,mj AnnVal $2] }
761

762
qcname  :: { Located RdrName }  -- Variable or type constructor
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
763
        :  qvar                         { $1 }
764
        |  oqtycon                      { $1 }
765 766 767 768 769 770 771

-----------------------------------------------------------------------------
-- 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
772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787
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 -}            { ([],[]) }
788 789

importdecl :: { LImportDecl RdrName }
790
        : 'import' maybe_src maybe_safe optqualified maybe_pkg modid maybeas maybeimpspec
Alan Zimmerman's avatar
Alan Zimmerman committed
791
                {% ams (L (comb4 $1 $6 (snd $7) $8) $
Alan Zimmerman's avatar
Alan Zimmerman committed
792 793
                  ImportDecl { ideclSourceSrc = snd $ fst $2
                             , ideclName = $6, ideclPkgQual = snd $5
Alan Zimmerman's avatar
Alan Zimmerman committed
794 795 796 797
                             , 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
798
                   ((mj AnnImport $1 : (fst $ fst $2) ++ fst $3 ++ fst $4
799
                                    ++ fst $5 ++ fst $7)) }
Alan Zimmerman's avatar
Alan Zimmerman committed
800

Alan Zimmerman's avatar
Alan Zimmerman committed
801 802 803 804
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
805 806 807 808 809

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

810
maybe_pkg :: { ([AddAnn],Maybe StringLiteral) }
811 812
        : STRING  {% let pkgFS = getSTRING $1 in
                     if looksLikePackageName (unpackFS pkgFS)
813
                        then return ([mj AnnPackageName $1], Just (StringLiteral (getSTRINGs $1) pkgFS))
814 815 816 817
                        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
818 819 820 821 822 823 824
        | {- empty -}                           { ([],Nothing) }

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

maybeas :: { ([AddAnn],Located (Maybe ModuleName)) }
825 826 827
        : 'as' modid                           { ([mj AnnAs $1,mj AnnVal $2]
                                                 ,sLL $1 $> (Just (unLoc $2))) }
        | {- empty -}                          { ([],noLoc Nothing) }
828

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

833
impspec :: { Located (Bool, Located [LIE RdrName]) }
Alan Zimmerman's avatar
Alan Zimmerman committed
834 835 836 837 838 839
        :  '(' 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] }
840 841 842 843

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

844 845 846 847
prec    :: { Located Int }
        : {- empty -}           { noLoc 9 }
        | INTEGER
                 {% checkPrecP (sL1 $1 (fromInteger (getINTEGER $1))) }
848

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
849
infix   :: { Located FixityDirection }
rodlogic's avatar
rodlogic committed
850 851 852
        : 'infix'                               { sL1 $1 InfixN  }
        | 'infixl'                              { sL1 $1 InfixL  }
        | 'infixr'                              { sL1 $1 InfixR }
853

Alan Zimmerman's avatar
Alan Zimmerman committed
854
ops     :: { Located (OrdList (Located RdrName)) }
Alan Zimmerman's avatar
Alan Zimmerman committed
855 856 857
        : ops ',' op       {% addAnnotation (oll $ unLoc $1) AnnComma (gl $2) >>
                              return (sLL $1 $> ((unLoc $1) `appOL` unitOL $3))}
        | op               { sL1 $1 (unitOL $1) }
858 859 860 861

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

862
topdecls :: { OrdList (LHsDecl RdrName) }
863
        : topdecls ';' topdecl        {% addAnnotation (oll $1) AnnSemi (gl $2)
864
                                         >> return ($1 `appOL` unitOL $3) }
Alan Zimmerman's avatar
Alan Zimmerman committed
865 866
        | topdecls ';'                {% addAnnotation (oll $1) AnnSemi (gl $2)
                                         >> return $1 }
867 868 869 870 871 872 873 874 875
        | 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
876
                                                         [mj AnnDefault $1
thomasw's avatar
thomasw committed
877
                                                         ,mop $2,mcp $4] }
878
        | 'foreign' fdecl          {% ams (sLL $1 $> (snd $ unLoc $2))
Alan Zimmerman's avatar
Alan Zimmerman committed
879
                                           (mj AnnForeign $1:(fst $ unLoc $2)) }
880
        | '{-# DEPRECATED' deprecations '#-}'   {% ams (sLL $1 $> $ WarningD (Warnings (getDEPRECATED_PRAGs $1) (fromOL $2)))
Alan Zimmerman's avatar
Alan Zimmerman committed
881
                                                       [mo $1,mc $3] }
882
        | '{-# WARNING' warnings '#-}'          {% ams (sLL $1 $> $ WarningD (Warnings (getWARNING_PRAGs $1) (fromOL $2)))
Alan Zimmerman's avatar
Alan Zimmerman committed
883
                                                       [mo $1,mc $3] }
884
        | '{-# RULES' rules '#-}'               {% ams (sLL $1 $> $ RuleD (HsRules (getRULES_PRAGs $1) (fromOL $2)))
Alan Zimmerman's avatar
Alan Zimmerman committed
885
                                                       [mo $1,mc $3] }
886
        | '{-# VECTORISE' qvar '=' exp '#-}' {% ams (sLL $1 $> $ VectD (HsVect (getVECT_PRAGs $1) $2 $4))
Alan Zimmerman's avatar
Alan Zimmerman committed
887 888
                                                    [mo $1,mj AnnEqual $3
                                                    ,mc $5] }
889
        | '{-# NOVECTORISE' qvar '#-}'       {% ams (sLL $1 $> $ VectD (HsNoVect (getNOVECT_PRAGs $1) $2))
Alan Zimmerman's avatar
Alan Zimmerman committed
890
                                                     [mo $1,mc $3] }
891
        | '{-# VECTORISE' 'type' gtycon '#-}'
892
                                {% ams (sLL $1 $> $
Alan Zimmerman's avatar
Alan Zimmerman committed
893
                                    VectD (HsVectTypeIn (getVECT_PRAGs $1) False $3 Nothing))
Alan Zimmerman's avatar
Alan Zimmerman committed
894 895
                                    [mo $1,mj AnnType $2,mc $4] }

896
        | '{-# VECTORISE_SCALAR' 'type' gtycon '#-}'
897
                                {% ams (sLL $1 $> $
Alan Zimmerman's avatar
Alan Zimmerman committed
898
                                    VectD (HsVectTypeIn (getVECT_SCALAR_PRAGs $1) True $3 Nothing))
Alan Zimmerman's avatar
Alan Zimmerman committed
899 900
                                    [mo $1,mj AnnType $2,mc $4] }

901
        | '{-# VECTORISE' 'type' gtycon '=' gtycon '#-}'
902
                                {% ams (sLL $1 $> $
Alan Zimmerman's avatar
Alan Zimmerman committed
903
                                    VectD (HsVectTypeIn (getVECT_PRAGs $1) False $3 (Just $5)))
Alan Zimmerman's avatar
Alan Zimmerman committed
904
                                    [mo $1,mj AnnType $2,mj AnnEqual $4,mc $6] }
905
        | '{-# VECTORISE_SCALAR' 'type' gtycon '=' gtycon '#-}'
906
                                {% ams (sLL $1 $> $
Alan Zimmerman's avatar
Alan Zimmerman committed
907
                                    VectD (HsVectTypeIn (getVECT_SCALAR_PRAGs $1) True $3 (Just $5)))
Alan Zimmerman's avatar
Alan Zimmerman committed
908 909 910
                                    [mo $1,mj AnnType $2,mj AnnEqual $4,mc $6] }

        | '{-# VECTORISE' 'class' gtycon '#-}'
911
                                         {% ams (sLL $1 $>  $ VectD (HsVectClassIn (getVECT_PRAGs $1) $3))
Alan Zimmerman's avatar
Alan Zimmerman committed
912
                                                 [mo $1,mj AnnClass $2,mc $4] }
913 914
        | annotation { $1 }
        | decl_no_th                            { $1 }
915 916 917

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

922 923 924
-- Type classes
--
cl_decl :: { LTyClDecl RdrName }
925
        : 'class' tycl_hdr fds where_cls
Alan Zimmerman's avatar
Alan Zimmerman committed
926
                {% amms (mkClassDecl (comb4 $1 $2 $3 $4) $2 $3 (snd $ unLoc $4))
Alan Zimmerman's avatar
Alan Zimmerman committed
927
                        (mj AnnClass $1:(fst $ unLoc $3)++(fst $ unLoc $4)) }
928

929
-- Type declarations (toplevel)
930 931
--
ty_decl :: { LTyClDecl RdrName }
932
           -- ordinary type synonyms
933
        : 'type' type '=' ctypedoc
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
934 935 936 937 938 939
                -- 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
940
                -- infix type constructors to be declared
941
                {% amms (mkTySynonym (comb2 $1 $4) $2 $4)
Alan Zimmerman's avatar
Alan Zimmerman committed
942
                        [mj AnnType $1,mj AnnEqual $3] }
943 944

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

952
          -- ordinary data type or newtype declaration
953
        | data_or_newtype capi_ctype tycl_hdr constrs deriving
Alan Zimmerman's avatar
Alan Zimmerman committed
954 955 956
                {% amms (mkTyData (comb4 $1 $3 $4 $5) (snd $ unLoc $1) $2 $3
                           Nothing (reverse (snd $ unLoc $4))
                                   (unLoc $5))
957
                                   -- We need the location on tycl_hdr in case
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
958
                                   -- constrs and deriving are both empty
Alan Zimmerman's avatar
Alan Zimmerman committed
959
                        ((fst $ unLoc $1):(fst $ unLoc $4)) }
960

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

971
          -- data/newtype family
972
        | 'data' 'family' type opt_kind_sig
973 974
                {% amms (mkFamDecl (comb3 $1 $2 $4) DataFamily $3 (snd $ unLoc $4))
                        (mj AnnData $1:mj AnnFamily $2:(fst $ unLoc $4)) }
975

976
inst_decl :: { LInstDecl RdrName }
977
        : 'instance' overlap_pragma inst_type where_inst
Alan Zimmerman's avatar
Alan Zimmerman committed
978 979 980 981 982 983 984
       {% 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)) } }
985 986

           -- type instance declarations
987
        | 'type' 'instance' ty_fam_inst_eqn
988 989 990
                {% ams $3 (fst $ unLoc $3)
                >> amms (mkTyFamInst (comb2 $1 $3) (snd $ unLoc $3))
                    (mj AnnType $1:mj AnnInstance $2:(fst $ unLoc $3)) }
991

992
          -- data/newtype instance declaration
993
        | data_or_newtype 'instance' capi_ctype tycl_hdr constrs deriving
Alan Zimmerman's avatar
Alan Zimmerman committed
994 995 996 997
            {% amms (mkDataFamInst (comb4 $1 $4 $5 $6) (snd $ unLoc $1) $3 $4
                                      Nothing (reverse (snd  $ unLoc $5))
                                              (unLoc $6))
                    ((fst $ unLoc $1):mj AnnInstance $2:(fst $ unLoc $5)) }
998

999
          -- GADT instance declaration