compiler/parser/Parser.y.pp

   1 --                                                              -*-haskell-*-
   2 -- ---------------------------------------------------------------------------
   3 -- (c) The University of Glasgow 1997-2003
   4 ---
   5 -- The GHC grammar.
   6 --
   7 -- Author(s): Simon Marlow, Sven Panne 1997, 1998, 1999
   8 -- ---------------------------------------------------------------------------
   9
  10 {
  11 {-# LANGUAGE BangPatterns #-} -- required for versions of Happy before 1.18.6
  12 {-# OPTIONS -Wwarn -w #-}
  13 -- The above warning supression flag is a temporary kludge.
  14 -- While working on this module you are encouraged to remove it and fix
  15 -- any warnings in the module. See
  16 --     http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Warnings
  17 -- for details
  18
  19 {-# OPTIONS_GHC -O0 -fno-ignore-interface-pragmas #-}
  20 {-
  21 Careful optimisation of the parser: we don't want to throw everything
  22 at it, because that takes too long and doesn't buy much, but we do want
  23 to inline certain key external functions, so we instruct GHC not to
  24 throw away inlinings as it would normally do in -O0 mode.
  25 -}
  26
  27 module Parser ( parseModule, parseStmt, parseIdentifier, parseType,
  28                 parseHeader ) where
  29
  30 import HsSyn
  31 import RdrHsSyn
  32 import HscTypes         ( IsBootInterface, WarningTxt(..) )
  33 import Lexer
  34 import RdrName
  35 import TysWiredIn       ( unitTyCon, unitDataCon, tupleTyCon, tupleCon, nilDataCon,
  36                           unboxedSingletonTyCon, unboxedSingletonDataCon,
  37                           listTyCon_RDR, parrTyCon_RDR, consDataCon_RDR )
  38 import Type             ( funTyCon )
  39 import ForeignCall      ( Safety(..), CExportSpec(..), CLabelString,
  40                           CCallConv(..), CCallTarget(..), defaultCCallConv
  41                         )
  42 import OccName          ( varName, dataName, tcClsName, tvName )
  43 import DataCon          ( DataCon, dataConName )
  44 import SrcLoc           ( Located(..), unLoc, getLoc, noLoc, combineSrcSpans,
  45                           SrcSpan, combineLocs, srcLocFile,
  46                           mkSrcLoc, mkSrcSpan )
  47 import Module
  48 import StaticFlags      ( opt_SccProfilingOn, opt_Hpc )
  49 import Type             ( Kind, liftedTypeKind, unliftedTypeKind )
  50 import Coercion         ( mkArrowKind )
  51 import Class            ( FunDep )
  52 import BasicTypes
  53 import DynFlags
  54 import OrdList
  55 import HaddockUtils
  56
  57 import FastString
  58 import Maybes           ( orElse )
  59 import Outputable
  60
  61 import Control.Monad    ( unless )
  62 import GHC.Exts
  63 import Data.Char
  64 import Control.Monad    ( mplus )
  65 }
  66
  67 {-
  68 -----------------------------------------------------------------------------
  69 24 Februar 2006
  70
  71 Conflicts: 33 shift/reduce
  72            1 reduce/reduce
  73
  74 The reduce/reduce conflict is weird.  It's between tyconsym and consym, and I
  75 would think the two should never occur in the same context.
  76
  77   -=chak
  78
  79 -----------------------------------------------------------------------------
  80 31 December 2006
  81
  82 Conflicts: 34 shift/reduce
  83            1 reduce/reduce
  84
  85 The reduce/reduce conflict is weird.  It's between tyconsym and consym, and I
  86 would think the two should never occur in the same context.
  87
  88   -=chak
  89
  90 -----------------------------------------------------------------------------
  91 6 December 2006
  92
  93 Conflicts: 32 shift/reduce
  94            1 reduce/reduce
  95
  96 The reduce/reduce conflict is weird.  It's between tyconsym and consym, and I
  97 would think the two should never occur in the same context.
  98
  99   -=chak
 100
 101 -----------------------------------------------------------------------------
 102 26 July 2006
 103
 104 Conflicts: 37 shift/reduce
 105            1 reduce/reduce
 106
 107 The reduce/reduce conflict is weird.  It's between tyconsym and consym, and I
 108 would think the two should never occur in the same context.
 109
 110   -=chak
 111
 112 -----------------------------------------------------------------------------
 113 Conflicts: 38 shift/reduce (1.25)
 114
 115 10 for abiguity in 'if x then y else z + 1'             [State 178]
 116         (shift parses as 'if x then y else (z + 1)', as per longest-parse rule)
 117         10 because op might be: : - ! * . `x` VARSYM CONSYM QVARSYM QCONSYM
 118
 119 1 for ambiguity in 'if x then y else z :: T'            [State 178]
 120         (shift parses as 'if x then y else (z :: T)', as per longest-parse rule)
 121
 122 4 for ambiguity in 'if x then y else z -< e'            [State 178]
 123         (shift parses as 'if x then y else (z -< T)', as per longest-parse rule)
 124         There are four such operators: -<, >-, -<<, >>-
 125
 126
 127 2 for ambiguity in 'case v of { x :: T -> T ... } '     [States 11, 253]
 128         Which of these two is intended?
 129           case v of
 130             (x::T) -> T         -- Rhs is T
 131     or
 132           case v of
 133             (x::T -> T) -> ..   -- Rhs is ...
 134
 135 10 for ambiguity in 'e :: a `b` c'.  Does this mean     [States 11, 253]
 136         (e::a) `b` c, or
 137         (e :: (a `b` c))
 138     As well as `b` we can have !, VARSYM, QCONSYM, and CONSYM, hence 5 cases
 139     Same duplication between states 11 and 253 as the previous case
 140
 141 1 for ambiguity in 'let ?x ...'                         [State 329]
 142         the parser can't tell whether the ?x is the lhs of a normal binding or
 143         an implicit binding.  Fortunately resolving as shift gives it the only
 144         sensible meaning, namely the lhs of an implicit binding.
 145
 146 1 for ambiguity in '{-# RULES "name" [ ... #-}          [State 382]
 147         we don't know whether the '[' starts the activation or not: it
 148         might be the start of the declaration with the activation being
 149         empty.  --SDM 1/4/2002
 150
 151 1 for ambiguity in '{-# RULES "name" forall = ... #-}'  [State 474]
 152         since 'forall' is a valid variable name, we don't know whether
 153         to treat a forall on the input as the beginning of a quantifier
 154         or the beginning of the rule itself.  Resolving to shift means
 155         it's always treated as a quantifier, hence the above is disallowed.
 156         This saves explicitly defining a grammar for the rule lhs that
 157         doesn't include 'forall'.
 158
 159 1 for ambiguity when the source file starts with "-- | doc". We need another
 160   token of lookahead to determine if a top declaration or the 'module' keyword
 161   follows. Shift parses as if the 'module' keyword follows.
 162
 163 -- ---------------------------------------------------------------------------
 164 -- Adding location info
 165
 166 This is done in a stylised way using the three macros below, L0, L1
 167 and LL.  Each of these macros can be thought of as having type
 168
 169    L0, L1, LL :: a -> Located a
 170
 171 They each add a SrcSpan to their argument.
 172
 173    L0   adds 'noSrcSpan', used for empty productions
 174      -- This doesn't seem to work anymore -=chak
 175
 176    L1   for a production with a single token on the lhs.  Grabs the SrcSpan
 177         from that token.
 178
 179    LL   for a production with >1 token on the lhs.  Makes up a SrcSpan from
 180         the first and last tokens.
 181
 182 These suffice for the majority of cases.  However, we must be
 183 especially careful with empty productions: LL won't work if the first
 184 or last token on the lhs can represent an empty span.  In these cases,
 185 we have to calculate the span using more of the tokens from the lhs, eg.
 186
 187         | 'newtype' tycl_hdr '=' newconstr deriving
 188                 { L (comb3 $1 $4 $5)
 189                     (mkTyData NewType (unLoc $2) [$4] (unLoc $5)) }
 190
 191 We provide comb3 and comb4 functions which are useful in such cases.
 192
 193 Be careful: there's no checking that you actually got this right, the
 194 only symptom will be that the SrcSpans of your syntax will be
 195 incorrect.
 196
 197 /*
 198  * We must expand these macros *before* running Happy, which is why this file is
 199  * Parser.y.pp rather than just Parser.y - we run the C pre-processor first.
 200  */
 201 #define L0   L noSrcSpan
 202 #define L1   sL (getLoc $1)
 203 #define LL   sL (comb2 $1 $>)
 204
 205 -- -----------------------------------------------------------------------------
 206
 207 -}
 208
 209 %token
 210  '_'            { L _ ITunderscore }            -- Haskell keywords
 211  'as'           { L _ ITas }
 212  'case'         { L _ ITcase }
 213  'class'        { L _ ITclass }
 214  'data'         { L _ ITdata }
 215  'default'      { L _ ITdefault }
 216  'deriving'     { L _ ITderiving }
 217  'do'           { L _ ITdo }
 218  'else'         { L _ ITelse }
 219  'hiding'       { L _ IThiding }
 220  'if'           { L _ ITif }
 221  'import'       { L _ ITimport }
 222  'in'           { L _ ITin }
 223  'infix'        { L _ ITinfix }
 224  'infixl'       { L _ ITinfixl }
 225  'infixr'       { L _ ITinfixr }
 226  'instance'     { L _ ITinstance }
 227  'let'          { L _ ITlet }
 228  'module'       { L _ ITmodule }
 229  'newtype'      { L _ ITnewtype }
 230  'of'           { L _ ITof }
 231  'qualified'    { L _ ITqualified }
 232  'then'         { L _ ITthen }
 233  'type'         { L _ ITtype }
 234  'where'        { L _ ITwhere }
 235  '_scc_'        { L _ ITscc }         -- ToDo: remove
 236
 237  'forall'       { L _ ITforall }                -- GHC extension keywords
 238  'foreign'      { L _ ITforeign }
 239  'export'       { L _ ITexport }
 240  'label'        { L _ ITlabel }
 241  'dynamic'      { L _ ITdynamic }
 242  'safe'         { L _ ITsafe }
 243  'threadsafe'   { L _ ITthreadsafe }  -- ToDo: remove deprecated alias
 244  'interruptible' { L _ ITinterruptible }
 245  'unsafe'       { L _ ITunsafe }
 246  'mdo'          { L _ ITmdo }
 247  'family'       { L _ ITfamily }
 248  'stdcall'      { L _ ITstdcallconv }
 249  'ccall'        { L _ ITccallconv }
 250  'prim'         { L _ ITprimcallconv }
 251  'proc'         { L _ ITproc }          -- for arrow notation extension
 252  'rec'          { L _ ITrec }           -- for arrow notation extension
 253  'group'    { L _ ITgroup }     -- for list transform extension
 254  'by'       { L _ ITby }        -- for list transform extension
 255  'using'    { L _ ITusing }     -- for list transform extension
 256
 257  '{-# INLINE'             { L _ (ITinline_prag _ _) }
 258  '{-# SPECIALISE'         { L _ ITspec_prag }
 259  '{-# SPECIALISE_INLINE'  { L _ (ITspec_inline_prag _) }
 260  '{-# SOURCE'      { L _ ITsource_prag }
 261  '{-# RULES'       { L _ ITrules_prag }
 262  '{-# CORE'        { L _ ITcore_prag }              -- hdaume: annotated core
 263  '{-# SCC'         { L _ ITscc_prag }
 264  '{-# GENERATED'   { L _ ITgenerated_prag }
 265  '{-# DEPRECATED'  { L _ ITdeprecated_prag }
 266  '{-# WARNING'     { L _ ITwarning_prag }
 267  '{-# UNPACK'      { L _ ITunpack_prag }
 268  '{-# ANN'         { L _ ITann_prag }
 269  '{-# VECTORISE'          { L _ ITvect_prag }
 270  '{-# VECTORISE_SCALAR'   { L _ ITvect_scalar_prag }
 271  '#-}'             { L _ ITclose_prag }
 272
 273  '..'           { L _ ITdotdot }                        -- reserved symbols
 274  ':'            { L _ ITcolon }
 275  '::'           { L _ ITdcolon }
 276  '='            { L _ ITequal }
 277  '\\'           { L _ ITlam }
 278  '|'            { L _ ITvbar }
 279  '<-'           { L _ ITlarrow }
 280  '->'           { L _ ITrarrow }
 281  '@'            { L _ ITat }
 282  '~'            { L _ ITtilde }
 283  '=>'           { L _ ITdarrow }
 284  '-'            { L _ ITminus }
 285  '!'            { L _ ITbang }
 286  '*'            { L _ ITstar }
 287  '-<'           { L _ ITlarrowtail }            -- for arrow notation
 288  '>-'           { L _ ITrarrowtail }            -- for arrow notation
 289  '-<<'          { L _ ITLarrowtail }            -- for arrow notation
 290  '>>-'          { L _ ITRarrowtail }            -- for arrow notation
 291  '.'            { L _ ITdot }
 292
 293  '{'            { L _ ITocurly }                        -- special symbols
 294  '}'            { L _ ITccurly }
 295  '{|'           { L _ ITocurlybar }
 296  '|}'           { L _ ITccurlybar }
 297  vocurly        { L _ ITvocurly } -- virtual open curly (from layout)
 298  vccurly        { L _ ITvccurly } -- virtual close curly (from layout)
 299  '['            { L _ ITobrack }
 300  ']'            { L _ ITcbrack }
 301  '[:'           { L _ ITopabrack }
 302  ':]'           { L _ ITcpabrack }
 303  '('            { L _ IToparen }
 304  ')'            { L _ ITcparen }
 305  '(#'           { L _ IToubxparen }
 306  '#)'           { L _ ITcubxparen }
 307  '(|'           { L _ IToparenbar }
 308  '|)'           { L _ ITcparenbar }
 309  ';'            { L _ ITsemi }
 310  ','            { L _ ITcomma }
 311  '`'            { L _ ITbackquote }
 312
 313  VARID          { L _ (ITvarid    _) }          -- identifiers
 314  CONID          { L _ (ITconid    _) }
 315  VARSYM         { L _ (ITvarsym   _) }
 316  CONSYM         { L _ (ITconsym   _) }
 317  QVARID         { L _ (ITqvarid   _) }
 318  QCONID         { L _ (ITqconid   _) }
 319  QVARSYM        { L _ (ITqvarsym  _) }
 320  QCONSYM        { L _ (ITqconsym  _) }
 321  PREFIXQVARSYM  { L _ (ITprefixqvarsym  _) }
 322  PREFIXQCONSYM  { L _ (ITprefixqconsym  _) }
 323
 324  IPDUPVARID     { L _ (ITdupipvarid   _) }              -- GHC extension
 325
 326  CHAR           { L _ (ITchar     _) }
 327  STRING         { L _ (ITstring   _) }
 328  INTEGER        { L _ (ITinteger  _) }
 329  RATIONAL       { L _ (ITrational _) }
 330
 331  PRIMCHAR       { L _ (ITprimchar   _) }
 332  PRIMSTRING     { L _ (ITprimstring _) }
 333  PRIMINTEGER    { L _ (ITprimint    _) }
 334  PRIMWORD       { L _ (ITprimword  _) }
 335  PRIMFLOAT      { L _ (ITprimfloat  _) }
 336  PRIMDOUBLE     { L _ (ITprimdouble _) }
 337
 338  DOCNEXT        { L _ (ITdocCommentNext _) }
 339  DOCPREV        { L _ (ITdocCommentPrev _) }
 340  DOCNAMED       { L _ (ITdocCommentNamed _) }
 341  DOCSECTION     { L _ (ITdocSection _ _) }
 342
 343 -- Template Haskell
 344 '[|'            { L _ ITopenExpQuote  }
 345 '[p|'           { L _ ITopenPatQuote  }
 346 '[t|'           { L _ ITopenTypQuote  }
 347 '[d|'           { L _ ITopenDecQuote  }
 348 '|]'            { L _ ITcloseQuote    }
 349 TH_ID_SPLICE    { L _ (ITidEscape _)  }     -- $x
 350 '$('            { L _ ITparenEscape   }     -- $( exp )
 351 TH_VAR_QUOTE    { L _ ITvarQuote      }     -- 'x
 352 TH_TY_QUOTE     { L _ ITtyQuote       }      -- ''T
 353 TH_QUASIQUOTE   { L _ (ITquasiQuote _) }
 354
 355 %monad { P } { >>= } { return }
 356 %lexer { lexer } { L _ ITeof }
 357 %name parseModule module
 358 %name parseStmt   maybe_stmt
 359 %name parseIdentifier  identifier
 360 %name parseType ctype
 361 %partial parseHeader header
 362 %tokentype { (Located Token) }
 363 %%
 364
 365 -----------------------------------------------------------------------------
 366 -- Identifiers; one of the entry points
 367 identifier :: { Located RdrName }
 368         : qvar                          { $1 }
 369         | qcon                          { $1 }
 370         | qvarop                        { $1 }
 371         | qconop                        { $1 }
 372     | '(' '->' ')'      { LL $ getRdrName funTyCon }
 373
 374 -----------------------------------------------------------------------------
 375 -- Module Header
 376
 377 -- The place for module deprecation is really too restrictive, but if it
 378 -- was allowed at its natural place just before 'module', we get an ugly
 379 -- s/r conflict with the second alternative. Another solution would be the
 380 -- introduction of a new pragma DEPRECATED_MODULE, but this is not very nice,
 381 -- either, and DEPRECATED is only expected to be used by people who really
 382 -- know what they are doing. :-)
 383
 384 module  :: { Located (HsModule RdrName) }
 385         : maybedocheader 'module' modid maybemodwarning maybeexports 'where' body
 386                 {% fileSrcSpan >>= \ loc ->
 387                    return (L loc (HsModule (Just $3) $5 (fst $7) (snd $7) $4 $1
 388                           ) )}
 389         | body2
 390                 {% fileSrcSpan >>= \ loc ->
 391                    return (L loc (HsModule Nothing Nothing
 392                           (fst $1) (snd $1) Nothing Nothing
 393                           )) }
 394
 395 maybedocheader :: { Maybe LHsDocString }
 396         : moduleheader            { $1 }
 397         | {- empty -}             { Nothing }
 398
 399 missing_module_keyword :: { () }
 400         : {- empty -}                           {% pushCurrentContext }
 401
 402 maybemodwarning :: { Maybe WarningTxt }
 403     : '{-# DEPRECATED' strings '#-}' { Just (DeprecatedTxt $ unLoc $2) }
 404     | '{-# WARNING' strings '#-}'    { Just (WarningTxt $ unLoc $2) }
 405     |  {- empty -}                  { Nothing }
 406
 407 body    :: { ([LImportDecl RdrName], [LHsDecl RdrName]) }
 408         :  '{'            top '}'               { $2 }
 409         |      vocurly    top close             { $2 }
 410
 411 body2   :: { ([LImportDecl RdrName], [LHsDecl RdrName]) }
 412         :  '{' top '}'                          { $2 }
 413         |  missing_module_keyword top close     { $2 }
 414
 415 top     :: { ([LImportDecl RdrName], [LHsDecl RdrName]) }
 416         : importdecls                           { (reverse $1,[]) }
 417         | importdecls ';' cvtopdecls            { (reverse $1,$3) }
 418         | cvtopdecls                            { ([],$1) }
 419
 420 cvtopdecls :: { [LHsDecl RdrName] }
 421         : topdecls                              { cvTopDecls $1 }
 422
 423 -----------------------------------------------------------------------------
 424 -- Module declaration & imports only
 425
 426 header  :: { Located (HsModule RdrName) }
 427         : maybedocheader 'module' modid maybemodwarning maybeexports 'where' header_body
 428                 {% fileSrcSpan >>= \ loc ->
 429                    return (L loc (HsModule (Just $3) $5 $7 [] $4 $1
 430                           ))}
 431         | missing_module_keyword importdecls
 432                 {% fileSrcSpan >>= \ loc ->
 433                    return (L loc (HsModule Nothing Nothing $2 [] Nothing
 434                           Nothing)) }
 435
 436 header_body :: { [LImportDecl RdrName] }
 437         :  '{'            importdecls           { $2 }
 438         |      vocurly    importdecls           { $2 }
 439
 440 -----------------------------------------------------------------------------
 441 -- The Export List
 442
 443 maybeexports :: { Maybe [LIE RdrName] }
 444         :  '(' exportlist ')'                   { Just $2 }
 445         |  {- empty -}                          { Nothing }
 446
 447 exportlist :: { [LIE RdrName] }
 448         : expdoclist ',' expdoclist             { $1 ++ $3 }
 449         | exportlist1                           { $1 }
 450
 451 exportlist1 :: { [LIE RdrName] }
 452         : expdoclist export expdoclist ',' exportlist  { $1 ++ ($2 : $3) ++ $5 }
 453         | expdoclist export expdoclist                 { $1 ++ ($2 : $3) }
 454         | expdoclist                                   { $1 }
 455
 456 expdoclist :: { [LIE RdrName] }
 457         : exp_doc expdoclist                           { $1 : $2 }
 458         | {- empty -}                                  { [] }
 459
 460 exp_doc :: { LIE RdrName }
 461         : docsection    { L1 (case (unLoc $1) of (n, doc) -> IEGroup n doc) }
 462         | docnamed      { L1 (IEDocNamed ((fst . unLoc) $1)) }
 463         | docnext       { L1 (IEDoc (unLoc $1)) }
 464
 465    -- No longer allow things like [] and (,,,) to be exported
 466    -- They are built in syntax, always available
 467 export  :: { LIE RdrName }
 468         :  qvar                         { L1 (IEVar (unLoc $1)) }
 469         |  oqtycon                      { L1 (IEThingAbs (unLoc $1)) }
 470         |  oqtycon '(' '..' ')'         { LL (IEThingAll (unLoc $1)) }
 471         |  oqtycon '(' ')'              { LL (IEThingWith (unLoc $1) []) }
 472         |  oqtycon '(' qcnames ')'      { LL (IEThingWith (unLoc $1) (reverse $3)) }
 473         |  'module' modid               { LL (IEModuleContents (unLoc $2)) }
 474
 475 qcnames :: { [RdrName] }
 476         :  qcnames ',' qcname_ext       { unLoc $3 : $1 }
 477         |  qcname_ext                   { [unLoc $1]  }
 478
 479 qcname_ext :: { Located RdrName }       -- Variable or data constructor
 480                                         -- or tagged type constructor
 481         :  qcname                       { $1 }
 482         |  'type' qcon                  { sL (comb2 $1 $2)
 483                                              (setRdrNameSpace (unLoc $2)
 484                                                               tcClsName)  }
 485
 486 -- Cannot pull into qcname_ext, as qcname is also used in expression.
 487 qcname  :: { Located RdrName }  -- Variable or data constructor
 488         :  qvar                         { $1 }
 489         |  qcon                         { $1 }
 490
 491 -----------------------------------------------------------------------------
 492 -- Import Declarations
 493
 494 -- import decls can be *empty*, or even just a string of semicolons
 495 -- whereas topdecls must contain at least one topdecl.
 496
 497 importdecls :: { [LImportDecl RdrName] }
 498         : importdecls ';' importdecl            { $3 : $1 }
 499         | importdecls ';'                       { $1 }
 500         | importdecl                            { [ $1 ] }
 501         | {- empty -}                           { [] }
 502
 503 importdecl :: { LImportDecl RdrName }
 504         : 'import' maybe_src optqualified maybe_pkg modid maybeas maybeimpspec
 505                 { L (comb4 $1 $5 $6 $7) (ImportDecl $5 $4 $2 $3 (unLoc $6) (unLoc $7)) }
 506
 507 maybe_src :: { IsBootInterface }
 508         : '{-# SOURCE' '#-}'                    { True }
 509         | {- empty -}                           { False }
 510
 511 maybe_pkg :: { Maybe FastString }
 512         : STRING                                { Just (getSTRING $1) }
 513         | {- empty -}                           { Nothing }
 514
 515 optqualified :: { Bool }
 516         : 'qualified'                           { True  }
 517         | {- empty -}                           { False }
 518
 519 maybeas :: { Located (Maybe ModuleName) }
 520         : 'as' modid                            { LL (Just (unLoc $2)) }
 521         | {- empty -}                           { noLoc Nothing }
 522
 523 maybeimpspec :: { Located (Maybe (Bool, [LIE RdrName])) }
 524         : impspec                               { L1 (Just (unLoc $1)) }
 525         | {- empty -}                           { noLoc Nothing }
 526
 527 impspec :: { Located (Bool, [LIE RdrName]) }
 528         :  '(' exportlist ')'                   { LL (False, $2) }
 529         |  'hiding' '(' exportlist ')'          { LL (True,  $3) }
 530
 531 -----------------------------------------------------------------------------
 532 -- Fixity Declarations
 533
 534 prec    :: { Int }
 535         : {- empty -}           { 9 }
 536         | INTEGER               {% checkPrecP (L1 (fromInteger (getINTEGER $1))) }
 537
 538 infix   :: { Located FixityDirection }
 539         : 'infix'                               { L1 InfixN  }
 540         | 'infixl'                              { L1 InfixL  }
 541         | 'infixr'                              { L1 InfixR }
 542
 543 ops     :: { Located [Located RdrName] }
 544         : ops ',' op                            { LL ($3 : unLoc $1) }
 545         | op                                    { L1 [$1] }
 546
 547 -----------------------------------------------------------------------------
 548 -- Top-Level Declarations
 549
 550 topdecls :: { OrdList (LHsDecl RdrName) }
 551         : topdecls ';' topdecl                  { $1 `appOL` $3 }
 552         | topdecls ';'                          { $1 }
 553         | topdecl                               { $1 }
 554
 555 topdecl :: { OrdList (LHsDecl RdrName) }
 556         : cl_decl                       { unitOL (L1 (TyClD (unLoc $1))) }
 557         | ty_decl                       { unitOL (L1 (TyClD (unLoc $1))) }
 558         | 'instance' inst_type where_inst
 559             { let (binds, sigs, ats, _) = cvBindsAndSigs (unLoc $3)
 560               in
 561               unitOL (L (comb3 $1 $2 $3) (InstD (InstDecl $2 binds sigs ats)))}
 562         | stand_alone_deriving                  { unitOL (LL (DerivD (unLoc $1))) }
 563         | 'default' '(' comma_types0 ')'        { unitOL (LL $ DefD (DefaultDecl $3)) }
 564         | 'foreign' fdecl                       { unitOL (LL (unLoc $2)) }
 565         | '{-# DEPRECATED' deprecations '#-}'   { $2 }
 566         | '{-# WARNING' warnings '#-}'          { $2 }
 567         | '{-# RULES' rules '#-}'               { $2 }
 568         | '{-# VECTORISE_SCALAR' qvar '#-}'     { unitOL $ LL $ VectD (HsVect $2 Nothing) }
 569         | '{-# VECTORISE' qvar '=' exp '#-}'    { unitOL $ LL $ VectD (HsVect $2 (Just $4)) }
 570         | annotation { unitOL $1 }
 571         | decl                                  { unLoc $1 }
 572
 573         -- Template Haskell Extension
 574         -- The $(..) form is one possible form of infixexp
 575         -- but we treat an arbitrary expression just as if
 576         -- it had a $(..) wrapped around it
 577         | infixexp                              { unitOL (LL $ mkTopSpliceDecl $1) }
 578
 579 -- Type classes
 580 --
 581 cl_decl :: { LTyClDecl RdrName }
 582         : 'class' tycl_hdr fds where_cls        {% mkClassDecl (comb4 $1 $2 $3 $4) $2 $3 $4 }
 583
 584 -- Type declarations (toplevel)
 585 --
 586 ty_decl :: { LTyClDecl RdrName }
 587            -- ordinary type synonyms
 588         : 'type' type '=' ctypedoc
 589                 -- Note ctype, not sigtype, on the right of '='
 590                 -- We allow an explicit for-all but we don't insert one
 591                 -- in   type Foo a = (b,b)
 592                 -- Instead we just say b is out of scope
 593                 --
 594                 -- Note the use of type for the head; this allows
 595                 -- infix type constructors to be declared
 596                 {% mkTySynonym (comb2 $1 $4) False $2 $4 }
 597
 598            -- type family declarations
 599         | 'type' 'family' type opt_kind_sig
 600                 -- Note the use of type for the head; this allows
 601                 -- infix type constructors to be declared
 602                 {% mkTyFamily (comb3 $1 $3 $4) TypeFamily $3 (unLoc $4) }
 603
 604            -- type instance declarations
 605         | 'type' 'instance' type '=' ctype
 606                 -- Note the use of type for the head; this allows
 607                 -- infix type constructors and type patterns
 608                 {% mkTySynonym (comb2 $1 $5) True $3 $5 }
 609
 610           -- ordinary data type or newtype declaration
 611         | data_or_newtype tycl_hdr constrs deriving
 612                 {% mkTyData (comb4 $1 $2 $3 $4) (unLoc $1) False $2
 613                             Nothing (reverse (unLoc $3)) (unLoc $4) }
 614                                    -- We need the location on tycl_hdr in case
 615                                    -- constrs and deriving are both empty
 616
 617           -- ordinary GADT declaration
 618         | data_or_newtype tycl_hdr opt_kind_sig
 619                  gadt_constrlist
 620                  deriving
 621                 {% mkTyData (comb4 $1 $2 $4 $5) (unLoc $1) False $2
 622                             (unLoc $3) (unLoc $4) (unLoc $5) }
 623                                    -- We need the location on tycl_hdr in case
 624                                    -- constrs and deriving are both empty
 625
 626           -- data/newtype family
 627         | 'data' 'family' type opt_kind_sig
 628                 {% mkTyFamily (comb3 $1 $2 $4) DataFamily $3 (unLoc $4) }
 629
 630           -- data/newtype instance declaration
 631         | data_or_newtype 'instance' tycl_hdr constrs deriving
 632                 {% mkTyData (comb4 $1 $3 $4 $5) (unLoc $1) True $3
 633                             Nothing (reverse (unLoc $4)) (unLoc $5) }
 634
 635           -- GADT instance declaration
 636         | data_or_newtype 'instance' tycl_hdr opt_kind_sig
 637                  gadt_constrlist
 638                  deriving
 639                 {% mkTyData (comb4 $1 $3 $5 $6) (unLoc $1) True $3
 640                             (unLoc $4) (unLoc $5) (unLoc $6) }
 641
 642 -- Associated type family declarations
 643 --
 644 -- * They have a different syntax than on the toplevel (no family special
 645 --   identifier).
 646 --
 647 -- * They also need to be separate from instances; otherwise, data family
 648 --   declarations without a kind signature cause parsing conflicts with empty
 649 --   data declarations.
 650 --
 651 at_decl_cls :: { LTyClDecl RdrName }
 652            -- type family declarations
 653         : 'type' type opt_kind_sig
 654                 -- Note the use of type for the head; this allows
 655                 -- infix type constructors to be declared
 656                 {% mkTyFamily (comb3 $1 $2 $3) TypeFamily $2 (unLoc $3) }
 657
 658            -- default type instance
 659         | 'type' type '=' ctype
 660                 -- Note the use of type for the head; this allows
 661                 -- infix type constructors and type patterns
 662                 {% mkTySynonym (comb2 $1 $4) True $2 $4 }
 663
 664           -- data/newtype family declaration
 665         | 'data' type opt_kind_sig
 666                 {% mkTyFamily (comb3 $1 $2 $3) DataFamily $2 (unLoc $3) }
 667
 668 -- Associated type instances
 669 --
 670 at_decl_inst :: { LTyClDecl RdrName }
 671            -- type instance declarations
 672         : 'type' type '=' ctype
 673                 -- Note the use of type for the head; this allows
 674                 -- infix type constructors and type patterns
 675                 {% mkTySynonym (comb2 $1 $4) True $2 $4 }
 676
 677         -- data/newtype instance declaration
 678         | data_or_newtype tycl_hdr constrs deriving
 679                 {% mkTyData (comb4 $1 $2 $3 $4) (unLoc $1) True $2
 680                             Nothing (reverse (unLoc $3)) (unLoc $4) }
 681
 682         -- GADT instance declaration
 683         | data_or_newtype tycl_hdr opt_kind_sig
 684                  gadt_constrlist
 685                  deriving
 686                 {% mkTyData (comb4 $1 $2 $4 $5) (unLoc $1) True $2
 687                             (unLoc $3) (unLoc $4) (unLoc $5) }
 688
 689 data_or_newtype :: { Located NewOrData }
 690         : 'data'        { L1 DataType }
 691         | 'newtype'     { L1 NewType }
 692
 693 opt_kind_sig :: { Located (Maybe Kind) }
 694         :                               { noLoc Nothing }
 695         | '::' kind                     { LL (Just (unLoc $2)) }
 696
 697 -- tycl_hdr parses the header of a class or data type decl,
 698 -- which takes the form
 699 --      T a b
 700 --      Eq a => T a
 701 --      (Eq a, Ord b) => T a b
 702 --      T Int [a]                       -- for associated types
 703 -- Rather a lot of inlining here, else we get reduce/reduce errors
 704 tycl_hdr :: { Located (Maybe (LHsContext RdrName), LHsType RdrName) }
 705         : context '=>' type             { LL (Just $1, $3) }
 706         | type                          { L1 (Nothing, $1) }
 707
 708 -----------------------------------------------------------------------------
 709 -- Stand-alone deriving
 710
 711 -- Glasgow extension: stand-alone deriving declarations
 712 stand_alone_deriving :: { LDerivDecl RdrName }
 713         : 'deriving' 'instance' inst_type { LL (DerivDecl $3) }
 714
 715 -----------------------------------------------------------------------------
 716 -- Nested declarations
 717
 718 -- Declaration in class bodies
 719 --
 720 decl_cls  :: { Located (OrdList (LHsDecl RdrName)) }
 721 decl_cls  : at_decl_cls                 { LL (unitOL (L1 (TyClD (unLoc $1)))) }
 722           | decl                        { $1 }
 723
 724           -- A 'default' signature used with the generic-programming extension
 725           | 'default' infixexp '::' sigtypedoc
 726                     {% do { (TypeSig l ty) <- checkValSig $2 $4
 727                           ; return (LL $ unitOL (LL $ SigD (GenericSig l ty))) } }
 728
 729 decls_cls :: { Located (OrdList (LHsDecl RdrName)) }    -- Reversed
 730           : decls_cls ';' decl_cls      { LL (unLoc $1 `appOL` unLoc $3) }
 731           | decls_cls ';'               { LL (unLoc $1) }
 732           | decl_cls                    { $1 }
 733           | {- empty -}                 { noLoc nilOL }
 734
 735
 736 decllist_cls
 737         :: { Located (OrdList (LHsDecl RdrName)) }      -- Reversed
 738         : '{'         decls_cls '}'     { LL (unLoc $2) }
 739         |     vocurly decls_cls close   { $2 }
 740
 741 -- Class body
 742 --
 743 where_cls :: { Located (OrdList (LHsDecl RdrName)) }    -- Reversed
 744                                 -- No implicit parameters
 745                                 -- May have type declarations
 746         : 'where' decllist_cls          { LL (unLoc $2) }
 747         | {- empty -}                   { noLoc nilOL }
 748
 749 -- Declarations in instance bodies
 750 --
 751 decl_inst  :: { Located (OrdList (LHsDecl RdrName)) }
 752 decl_inst  : at_decl_inst               { LL (unitOL (L1 (TyClD (unLoc $1)))) }
 753            | decl                       { $1 }
 754
 755 decls_inst :: { Located (OrdList (LHsDecl RdrName)) }   -- Reversed
 756            : decls_inst ';' decl_inst   { LL (unLoc $1 `appOL` unLoc $3) }
 757            | decls_inst ';'             { LL (unLoc $1) }
 758            | decl_inst                  { $1 }
 759            | {- empty -}                { noLoc nilOL }
 760
 761 decllist_inst
 762         :: { Located (OrdList (LHsDecl RdrName)) }      -- Reversed
 763         : '{'         decls_inst '}'    { LL (unLoc $2) }
 764         |     vocurly decls_inst close  { $2 }
 765
 766 -- Instance body
 767 --
 768 where_inst :: { Located (OrdList (LHsDecl RdrName)) }   -- Reversed
 769                                 -- No implicit parameters
 770                                 -- May have type declarations
 771         : 'where' decllist_inst         { LL (unLoc $2) }
 772         | {- empty -}                   { noLoc nilOL }
 773
 774 -- Declarations in binding groups other than classes and instances
 775 --
 776 decls   :: { Located (OrdList (LHsDecl RdrName)) }
 777         : decls ';' decl                { let { this = unLoc $3;
 778                                     rest = unLoc $1;
 779                                     these = rest `appOL` this }
 780                               in rest `seq` this `seq` these `seq`
 781                                     LL these }
 782         | decls ';'                     { LL (unLoc $1) }
 783         | decl                          { $1 }
 784         | {- empty -}                   { noLoc nilOL }
 785
 786 decllist :: { Located (OrdList (LHsDecl RdrName)) }
 787         : '{'            decls '}'      { LL (unLoc $2) }
 788         |     vocurly    decls close    { $2 }
 789
 790 -- Binding groups other than those of class and instance declarations
 791 --
 792 binds   ::  { Located (HsLocalBinds RdrName) }          -- May have implicit parameters
 793                                                 -- No type declarations
 794         : decllist                      { L1 (HsValBinds (cvBindGroup (unLoc $1))) }
 795         | '{'            dbinds '}'     { LL (HsIPBinds (IPBinds (unLoc $2) emptyTcEvBinds)) }
 796         |     vocurly    dbinds close   { L (getLoc $2) (HsIPBinds (IPBinds (unLoc $2) emptyTcEvBinds)) }
 797
 798 wherebinds :: { Located (HsLocalBinds RdrName) }        -- May have implicit parameters
 799                                                 -- No type declarations
 800         : 'where' binds                 { LL (unLoc $2) }
 801         | {- empty -}                   { noLoc emptyLocalBinds }
 802
 803
 804 -----------------------------------------------------------------------------
 805 -- Transformation Rules
 806
 807 rules   :: { OrdList (LHsDecl RdrName) }
 808         :  rules ';' rule                       { $1 `snocOL` $3 }
 809         |  rules ';'                            { $1 }
 810         |  rule                                 { unitOL $1 }
 811         |  {- empty -}                          { nilOL }
 812
 813 rule    :: { LHsDecl RdrName }
 814         : STRING activation rule_forall infixexp '=' exp
 815              { LL $ RuleD (HsRule (getSTRING $1)
 816                                   ($2 `orElse` AlwaysActive)
 817                                   $3 $4 placeHolderNames $6 placeHolderNames) }
 818
 819 activation :: { Maybe Activation }
 820         : {- empty -}                           { Nothing }
 821         | explicit_activation                   { Just $1 }
 822
 823 explicit_activation :: { Activation }  -- In brackets
 824         : '[' INTEGER ']'               { ActiveAfter  (fromInteger (getINTEGER $2)) }
 825         | '[' '~' INTEGER ']'           { ActiveBefore (fromInteger (getINTEGER $3)) }
 826
 827 rule_forall :: { [RuleBndr RdrName] }
 828         : 'forall' rule_var_list '.'            { $2 }
 829         | {- empty -}                           { [] }
 830
 831 rule_var_list :: { [RuleBndr RdrName] }
 832         : rule_var                              { [$1] }
 833         | rule_var rule_var_list                { $1 : $2 }
 834
 835 rule_var :: { RuleBndr RdrName }
 836         : varid                                 { RuleBndr $1 }
 837         | '(' varid '::' ctype ')'              { RuleBndrSig $2 $4 }
 838
 839 -----------------------------------------------------------------------------
 840 -- Warnings and deprecations (c.f. rules)
 841
 842 warnings :: { OrdList (LHsDecl RdrName) }
 843         : warnings ';' warning          { $1 `appOL` $3 }
 844         | warnings ';'                  { $1 }
 845         | warning                               { $1 }
 846         | {- empty -}                           { nilOL }
 847
 848 -- SUP: TEMPORARY HACK, not checking for `module Foo'
 849 warning :: { OrdList (LHsDecl RdrName) }
 850         : namelist strings
 851                 { toOL [ LL $ WarningD (Warning n (WarningTxt $ unLoc $2))
 852                        | n <- unLoc $1 ] }
 853
 854 deprecations :: { OrdList (LHsDecl RdrName) }
 855         : deprecations ';' deprecation          { $1 `appOL` $3 }
 856         | deprecations ';'                      { $1 }
 857         | deprecation                           { $1 }
 858         | {- empty -}                           { nilOL }
 859
 860 -- SUP: TEMPORARY HACK, not checking for `module Foo'
 861 deprecation :: { OrdList (LHsDecl RdrName) }
 862         : namelist strings
 863                 { toOL [ LL $ WarningD (Warning n (DeprecatedTxt $ unLoc $2))
 864                        | n <- unLoc $1 ] }
 865
 866 strings :: { Located [FastString] }
 867     : STRING { L1 [getSTRING $1] }
 868     | '[' stringlist ']' { LL $ fromOL (unLoc $2) }
 869
 870 stringlist :: { Located (OrdList FastString) }
 871     : stringlist ',' STRING { LL (unLoc $1 `snocOL` getSTRING $3) }
 872     | STRING                { LL (unitOL (getSTRING $1)) }
 873
 874 -----------------------------------------------------------------------------
 875 -- Annotations
 876 annotation :: { LHsDecl RdrName }
 877     : '{-# ANN' name_var aexp '#-}'      { LL (AnnD $ HsAnnotation (ValueAnnProvenance (unLoc $2)) $3) }
 878     | '{-# ANN' 'type' tycon aexp '#-}'  { LL (AnnD $ HsAnnotation (TypeAnnProvenance (unLoc $3)) $4) }
 879     | '{-# ANN' 'module' aexp '#-}'      { LL (AnnD $ HsAnnotation ModuleAnnProvenance $3) }
 880
 881
 882 -----------------------------------------------------------------------------
 883 -- Foreign import and export declarations
 884
 885 fdecl :: { LHsDecl RdrName }
 886 fdecl : 'import' callconv safety fspec
 887                 {% mkImport $2 $3 (unLoc $4) >>= return.LL }
 888       | 'import' callconv        fspec
 889                 {% do { d <- mkImport $2 (PlaySafe False) (unLoc $3);
 890                         return (LL d) } }
 891       | 'export' callconv fspec
 892                 {% mkExport $2 (unLoc $3) >>= return.LL }
 893
 894 callconv :: { CCallConv }
 895           : 'stdcall'                   { StdCallConv }
 896           | 'ccall'                     { CCallConv   }
 897           | 'prim'                      { PrimCallConv}
 898
 899 safety :: { Safety }
 900         : 'unsafe'                      { PlayRisky }
 901         | 'safe'                        { PlaySafe  False }
 902         | 'interruptible'               { PlayInterruptible }
 903         | 'threadsafe'                  { PlaySafe  True } -- deprecated alias
 904
 905 fspec :: { Located (Located FastString, Located RdrName, LHsType RdrName) }
 906        : STRING var '::' sigtypedoc     { LL (L (getLoc $1) (getSTRING $1), $2, $4) }
 907        |        var '::' sigtypedoc     { LL (noLoc nilFS, $1, $3) }
 908          -- if the entity string is missing, it defaults to the empty string;
 909          -- the meaning of an empty entity string depends on the calling
 910          -- convention
 911
 912 -----------------------------------------------------------------------------
 913 -- Type signatures
 914
 915 opt_sig :: { Maybe (LHsType RdrName) }
 916         : {- empty -}                   { Nothing }
 917         | '::' sigtype                  { Just $2 }
 918
 919 opt_asig :: { Maybe (LHsType RdrName) }
 920         : {- empty -}                   { Nothing }
 921         | '::' atype                    { Just $2 }
 922
 923 sigtype :: { LHsType RdrName }          -- Always a HsForAllTy,
 924                                         -- to tell the renamer where to generalise
 925         : ctype                         { L1 (mkImplicitHsForAllTy (noLoc []) $1) }
 926         -- Wrap an Implicit forall if there isn't one there already
 927
 928 sigtypedoc :: { LHsType RdrName }       -- Always a HsForAllTy
 929         : ctypedoc                      { L1 (mkImplicitHsForAllTy (noLoc []) $1) }
 930         -- Wrap an Implicit forall if there isn't one there already
 931
 932 sig_vars :: { Located [Located RdrName] }
 933          : sig_vars ',' var             { LL ($3 : unLoc $1) }
 934          | var                          { L1 [$1] }
 935
 936 sigtypes1 :: { [LHsType RdrName] }      -- Always HsForAllTys
 937         : sigtype                       { [ $1 ] }
 938         | sigtype ',' sigtypes1         { $1 : $3 }
 939
 940 -----------------------------------------------------------------------------
 941 -- Types
 942
 943 infixtype :: { LHsType RdrName }
 944         : btype qtyconop type         { LL $ HsOpTy $1 $2 $3 }
 945         | btype tyvarop  type    { LL $ HsOpTy $1 $2 $3 }
 946
 947 strict_mark :: { Located HsBang }
 948         : '!'                           { L1 HsStrict }
 949         | '{-# UNPACK' '#-}' '!'        { LL HsUnpack }
 950
 951 -- A ctype is a for-all type
 952 ctype   :: { LHsType RdrName }
 953         : 'forall' tv_bndrs '.' ctype   { LL $ mkExplicitHsForAllTy $2 (noLoc []) $4 }
 954         | context '=>' ctype            { LL $ mkImplicitHsForAllTy   $1 $3 }
 955         -- A type of form (context => type) is an *implicit* HsForAllTy
 956         | ipvar '::' type               { LL (HsPredTy (HsIParam (unLoc $1) $3)) }
 957         | type                          { $1 }
 958
 959 ----------------------
 960 -- Notes for 'ctypedoc'
 961 -- It would have been nice to simplify the grammar by unifying `ctype` and
 962 -- ctypedoc` into one production, allowing comments on types everywhere (and
 963 -- rejecting them after parsing, where necessary).  This is however not possible
 964 -- since it leads to ambiguity. The reason is the support for comments on record
 965 -- fields:
 966 --         data R = R { field :: Int -- ^ comment on the field }
 967 -- If we allow comments on types here, it's not clear if the comment applies
 968 -- to 'field' or to 'Int'. So we must use `ctype` to describe the type.
 969
 970 ctypedoc :: { LHsType RdrName }
 971         : 'forall' tv_bndrs '.' ctypedoc        { LL $ mkExplicitHsForAllTy $2 (noLoc []) $4 }
 972         | context '=>' ctypedoc         { LL $ mkImplicitHsForAllTy   $1 $3 }
 973         -- A type of form (context => type) is an *implicit* HsForAllTy
 974         | ipvar '::' type               { LL (HsPredTy (HsIParam (unLoc $1) $3)) }
 975         | typedoc                       { $1 }
 976
 977 ----------------------
 978 -- Notes for 'context'
 979 -- We parse a context as a btype so that we don't get reduce/reduce
 980 -- errors in ctype.  The basic problem is that
 981 --      (Eq a, Ord a)
 982 -- looks so much like a tuple type.  We can't tell until we find the =>
 983
 984 -- We have the t1 ~ t2 form both in 'context' and in type,
 985 -- to permit an individual equational constraint without parenthesis.
 986 -- Thus for some reason we allow    f :: a~b => blah
 987 -- but not                          f :: ?x::Int => blah
 988 context :: { LHsContext RdrName }
 989         : btype '~'      btype          {% checkContext
 990                                              (LL $ HsPredTy (HsEqualP $1 $3)) }
 991         | btype                         {% checkContext $1 }
 992
 993 type :: { LHsType RdrName }
 994         : btype                         { $1 }
 995         | btype qtyconop type           { LL $ HsOpTy $1 $2 $3 }
 996         | btype tyvarop  type           { LL $ HsOpTy $1 $2 $3 }
 997         | btype '->'     ctype          { LL $ HsFunTy $1 $3 }
 998         | btype '~'      btype          { LL $ HsPredTy (HsEqualP $1 $3) }
 999
1000 typedoc :: { LHsType RdrName }
1001         : btype                          { $1 }
1002         | btype docprev                  { LL $ HsDocTy $1 $2 }
1003         | btype qtyconop type            { LL $ HsOpTy $1 $2 $3 }
1004         | btype qtyconop type docprev    { LL $ HsDocTy (L (comb3 $1 $2 $3) (HsOpTy $1 $2 $3)) $4 }
1005         | btype tyvarop  type            { LL $ HsOpTy $1 $2 $3 }
1006         | btype tyvarop  type docprev    { LL $ HsDocTy (L (comb3 $1 $2 $3) (HsOpTy $1 $2 $3)) $4 }
1007         | btype '->'     ctypedoc        { LL $ HsFunTy $1 $3 }
1008         | btype docprev '->' ctypedoc    { LL $ HsFunTy (L (comb2 $1 $2) (HsDocTy $1 $2)) $4 }
1009         | btype '~'      btype           { LL $ HsPredTy (HsEqualP $1 $3) }
1010
1011 btype :: { LHsType RdrName }
1012         : btype atype                   { LL $ HsAppTy $1 $2 }
1013         | atype                         { $1 }
1014
1015 atype :: { LHsType RdrName }
1016         : gtycon                        { L1 (HsTyVar (unLoc $1)) }
1017         | tyvar                         { L1 (HsTyVar (unLoc $1)) }
1018         | strict_mark atype             { LL (HsBangTy (unLoc $1) $2) }  -- Constructor sigs only
1019         | '{' fielddecls '}'            { LL $ HsRecTy $2 }              -- Constructor sigs only
1020         | '(' ctype ',' comma_types1 ')'  { LL $ HsTupleTy Boxed  ($2:$4) }
1021         | '(#' comma_types1 '#)'        { LL $ HsTupleTy Unboxed $2     }
1022         | '[' ctype ']'                 { LL $ HsListTy  $2 }
1023         | '[:' ctype ':]'               { LL $ HsPArrTy  $2 }
1024         | '(' ctype ')'                 { LL $ HsParTy   $2 }
1025         | '(' ctype '::' kind ')'       { LL $ HsKindSig $2 (unLoc $4) }
1026         | quasiquote                    { L1 (HsQuasiQuoteTy (unLoc $1)) }
1027         | '$(' exp ')'                  { LL $ mkHsSpliceTy $2 }
1028         | TH_ID_SPLICE                  { LL $ mkHsSpliceTy $ L1 $ HsVar $
1029                                           mkUnqual varName (getTH_ID_SPLICE $1) }
1030
1031 -- An inst_type is what occurs in the head of an instance decl
1032 --      e.g.  (Foo a, Gaz b) => Wibble a b
1033 -- It's kept as a single type, with a MonoDictTy at the right
1034 -- hand corner, for convenience.
1035 inst_type :: { LHsType RdrName }
1036         : sigtype                       {% checkInstType $1 }
1037
1038 inst_types1 :: { [LHsType RdrName] }
1039         : inst_type                     { [$1] }
1040         | inst_type ',' inst_types1     { $1 : $3 }
1041
1042 comma_types0  :: { [LHsType RdrName] }
1043         : comma_types1                  { $1 }
1044         | {- empty -}                   { [] }
1045
1046 comma_types1    :: { [LHsType RdrName] }
1047         : ctype                         { [$1] }
1048         | ctype  ',' comma_types1       { $1 : $3 }
1049
1050 tv_bndrs :: { [LHsTyVarBndr RdrName] }
1051          : tv_bndr tv_bndrs             { $1 : $2 }
1052          | {- empty -}                  { [] }
1053
1054 tv_bndr :: { LHsTyVarBndr RdrName }
1055         : tyvar                         { L1 (UserTyVar (unLoc $1) placeHolderKind) }
1056         | '(' tyvar '::' kind ')'       { LL (KindedTyVar (unLoc $2)
1057                                                           (unLoc $4)) }
1058
1059 fds :: { Located [Located (FunDep RdrName)] }
1060         : {- empty -}                   { noLoc [] }
1061         | '|' fds1                      { LL (reverse (unLoc $2)) }
1062
1063 fds1 :: { Located [Located (FunDep RdrName)] }
1064         : fds1 ',' fd                   { LL ($3 : unLoc $1) }
1065         | fd                            { L1 [$1] }
1066
1067 fd :: { Located (FunDep RdrName) }
1068         : varids0 '->' varids0          { L (comb3 $1 $2 $3)
1069                                            (reverse (unLoc $1), reverse (unLoc $3)) }
1070
1071 varids0 :: { Located [RdrName] }
1072         : {- empty -}                   { noLoc [] }
1073         | varids0 tyvar                 { LL (unLoc $2 : unLoc $1) }
1074
1075 -----------------------------------------------------------------------------
1076 -- Kinds
1077
1078 kind    :: { Located Kind }
1079         : akind                 { $1 }
1080         | akind '->' kind       { LL (mkArrowKind (unLoc $1) (unLoc $3)) }
1081
1082 akind   :: { Located Kind }
1083         : '*'                   { L1 liftedTypeKind }
1084         | '!'                   { L1 unliftedTypeKind }
1085         | '(' kind ')'          { LL (unLoc $2) }
1086
1087
1088 -----------------------------------------------------------------------------
1089 -- Datatype declarations
1090
1091 gadt_constrlist :: { Located [LConDecl RdrName] }       -- Returned in order
1092         : 'where' '{'        gadt_constrs '}'      { L (comb2 $1 $3) (unLoc $3) }
1093         | 'where' vocurly    gadt_constrs close    { L (comb2 $1 $3) (unLoc $3) }
1094         | {- empty -}                              { noLoc [] }
1095
1096 gadt_constrs :: { Located [LConDecl RdrName] }
1097         : gadt_constr ';' gadt_constrs  { L (comb2 (head $1) $3) ($1 ++ unLoc $3) }
1098         | gadt_constr                   { L (getLoc (head $1)) $1 }
1099         | {- empty -}                   { noLoc [] }
1100
1101 -- We allow the following forms:
1102 --      C :: Eq a => a -> T a
1103 --      C :: forall a. Eq a => !a -> T a
1104 --      D { x,y :: a } :: T a
1105 --      forall a. Eq a => D { x,y :: a } :: T a
1106
1107 gadt_constr :: { [LConDecl RdrName] }   -- Returns a list because of:   C,D :: ty
1108         : con_list '::' sigtype
1109                 { map (sL (comb2 $1 $3)) (mkGadtDecl (unLoc $1) $3) }
1110
1111                 -- Deprecated syntax for GADT record declarations
1112         | oqtycon '{' fielddecls '}' '::' sigtype
1113                 {% do { cd <- mkDeprecatedGadtRecordDecl (comb2 $1 $6) $1 $3 $6
1114                       ; return [cd] } }
1115
1116 constrs :: { Located [LConDecl RdrName] }
1117         : maybe_docnext '=' constrs1    { L (comb2 $2 $3) (addConDocs (unLoc $3) $1) }
1118
1119 constrs1 :: { Located [LConDecl RdrName] }
1120         : constrs1 maybe_docnext '|' maybe_docprev constr { LL (addConDoc $5 $2 : addConDocFirst (unLoc $1) $4) }
1121         | constr                                          { L1 [$1] }
1122
1123 constr :: { LConDecl RdrName }
1124         : maybe_docnext forall context '=>' constr_stuff maybe_docprev
1125                 { let (con,details) = unLoc $5 in
1126                   addConDoc (L (comb4 $2 $3 $4 $5) (mkSimpleConDecl con (unLoc $2) $3 details))
1127                             ($1 `mplus` $6) }
1128         | maybe_docnext forall constr_stuff maybe_docprev
1129                 { let (con,details) = unLoc $3 in
1130                   addConDoc (L (comb2 $2 $3) (mkSimpleConDecl con (unLoc $2) (noLoc []) details))
1131                             ($1 `mplus` $4) }
1132
1133 forall :: { Located [LHsTyVarBndr RdrName] }
1134         : 'forall' tv_bndrs '.'         { LL $2 }
1135         | {- empty -}                   { noLoc [] }
1136
1137 constr_stuff :: { Located (Located RdrName, HsConDeclDetails RdrName) }
1138 -- We parse the constructor declaration
1139 --      C t1 t2
1140 -- as a btype (treating C as a type constructor) and then convert C to be
1141 -- a data constructor.  Reason: it might continue like this:
1142 --      C t1 t2 %: D Int
1143 -- in which case C really would be a type constructor.  We can't resolve this
1144 -- ambiguity till we come across the constructor oprerator :% (or not, more usually)
1145         : btype                         {% splitCon $1 >>= return.LL }
1146         | btype conop btype             {  LL ($2, InfixCon $1 $3) }
1147
1148 fielddecls :: { [ConDeclField RdrName] }
1149         : {- empty -}     { [] }
1150         | fielddecls1     { $1 }
1151
1152 fielddecls1 :: { [ConDeclField RdrName] }
1153         : fielddecl maybe_docnext ',' maybe_docprev fielddecls1
1154                       { [ addFieldDoc f $4 | f <- $1 ] ++ addFieldDocs $5 $2 }
1155                              -- This adds the doc $4 to each field separately
1156         | fielddecl   { $1 }
1157
1158 fielddecl :: { [ConDeclField RdrName] }    -- A list because of   f,g :: Int
1159         : maybe_docnext sig_vars '::' ctype maybe_docprev      { [ ConDeclField fld $4 ($1 `mplus` $5)
1160                                                                  | fld <- reverse (unLoc $2) ] }
1161
1162 -- We allow the odd-looking 'inst_type' in a deriving clause, so that
1163 -- we can do deriving( forall a. C [a] ) in a newtype (GHC extension).
1164 -- The 'C [a]' part is converted to an HsPredTy by checkInstType
1165 -- We don't allow a context, but that's sorted out by the type checker.
1166 deriving :: { Located (Maybe [LHsType RdrName]) }
1167         : {- empty -}                           { noLoc Nothing }
1168         | 'deriving' qtycon     {% do { let { L loc tv = $2 }
1169                                       ; p <- checkInstType (L loc (HsTyVar tv))
1170                                       ; return (LL (Just [p])) } }
1171         | 'deriving' '(' ')'                    { LL (Just []) }
1172         | 'deriving' '(' inst_types1 ')'        { LL (Just $3) }
1173              -- Glasgow extension: allow partial
1174              -- applications in derivings
1175
1176 -----------------------------------------------------------------------------
1177 -- Value definitions
1178
1179 {- Note [Declaration/signature overlap]
1180 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1181 There's an awkward overlap with a type signature.  Consider
1182         f :: Int -> Int = ...rhs...
1183    Then we can't tell whether it's a type signature or a value
1184    definition with a result signature until we see the '='.
1185    So we have to inline enough to postpone reductions until we know.
1186 -}
1187
1188 {-
1189   ATTENTION: Dirty Hackery Ahead! If the second alternative of vars is var
1190   instead of qvar, we get another shift/reduce-conflict. Consider the
1191   following programs:
1192
1193      { (^^) :: Int->Int ; }          Type signature; only var allowed
1194
1195      { (^^) :: Int->Int = ... ; }    Value defn with result signature;
1196                                      qvar allowed (because of instance decls)
1197
1198   We can't tell whether to reduce var to qvar until after we've read the signatures.
1199 -}
1200
1201 docdecl :: { LHsDecl RdrName }
1202         : docdecld { L1 (DocD (unLoc $1)) }
1203
1204 docdecld :: { LDocDecl }
1205         : docnext                               { L1 (DocCommentNext (unLoc $1)) }
1206         | docprev                               { L1 (DocCommentPrev (unLoc $1)) }
1207         | docnamed                              { L1 (case (unLoc $1) of (n, doc) -> DocCommentNamed n doc) }
1208         | docsection                            { L1 (case (unLoc $1) of (n, doc) -> DocGroup n doc) }
1209
1210 decl    :: { Located (OrdList (LHsDecl RdrName)) }
1211         : sigdecl               { $1 }
1212
1213         | '!' aexp rhs          {% do { let { e = LL (SectionR (LL (HsVar bang_RDR)) $2) };
1214                                         pat <- checkPattern e;
1215                                         return $ LL $ unitOL $ LL $ ValD $
1216                                                PatBind pat (unLoc $3)
1217                                                        placeHolderType placeHolderNames } }
1218                                 -- Turn it all into an expression so that
1219                                 -- checkPattern can check that bangs are enabled
1220
1221         | infixexp opt_sig rhs  {% do { r <- checkValDef $1 $2 $3;
1222                                         let { l = comb2 $1 $> };
1223                                         return $! (sL l (unitOL $! (sL l $ ValD r))) } }
1224         | docdecl               { LL $ unitOL $1 }
1225
1226 rhs     :: { Located (GRHSs RdrName) }
1227         : '=' exp wherebinds    { sL (comb3 $1 $2 $3) $ GRHSs (unguardedRHS $2) (unLoc $3) }
1228         | gdrhs wherebinds      { LL $ GRHSs (reverse (unLoc $1)) (unLoc $2) }
1229
1230 gdrhs :: { Located [LGRHS RdrName] }
1231         : gdrhs gdrh            { LL ($2 : unLoc $1) }
1232         | gdrh                  { L1 [$1] }
1233
1234 gdrh :: { LGRHS RdrName }
1235         : '|' guardquals '=' exp        { sL (comb2 $1 $>) $ GRHS (unLoc $2) $4 }
1236
1237 sigdecl :: { Located (OrdList (LHsDecl RdrName)) }
1238         :
1239         -- See Note [Declaration/signature overlap] for why we need infixexp here
1240           infixexp '::' sigtypedoc
1241                         {% do s <- checkValSig $1 $3
1242                         ; return (LL $ unitOL (LL $ SigD s)) }
1243         | var ',' sig_vars '::' sigtypedoc
1244                                 { LL $ toOL [ LL $ SigD (TypeSig n $5) | n <- $1 : unLoc $3 ] }
1245         | infix prec ops        { LL $ toOL [ LL $ SigD (FixSig (FixitySig n (Fixity $2 (unLoc $1))))
1246                                              | n <- unLoc $3 ] }
1247         | '{-# INLINE'   activation qvar '#-}'
1248                 { LL $ unitOL (LL $ SigD (InlineSig $3 (mkInlinePragma (getINLINE $1) $2))) }
1249         | '{-# SPECIALISE' qvar '::' sigtypes1 '#-}'
1250                 { LL $ toOL [ LL $ SigD (SpecSig $2 t defaultInlinePragma)
1251                                             | t <- $4] }
1252         | '{-# SPECIALISE_INLINE' activation qvar '::' sigtypes1 '#-}'
1253                 { LL $ toOL [ LL $ SigD (SpecSig $3 t (mkInlinePragma (getSPEC_INLINE $1) $2))
1254                                             | t <- $5] }
1255         | '{-# SPECIALISE' 'instance' inst_type '#-}'
1256                 { LL $ unitOL (LL $ SigD (SpecInstSig $3)) }
1257
1258 -----------------------------------------------------------------------------
1259 -- Expressions
1260
1261 quasiquote :: { Located (HsQuasiQuote RdrName) }
1262         : TH_QUASIQUOTE   { let { loc = getLoc $1
1263                                 ; ITquasiQuote (quoter, quote, quoteSpan) = unLoc $1
1264                                 ; quoterId = mkUnqual varName quoter }
1265                             in L1 (mkHsQuasiQuote quoterId quoteSpan quote) }
1266
1267 exp   :: { LHsExpr RdrName }
1268         : infixexp '::' sigtype         { LL $ ExprWithTySig $1 $3 }
1269         | infixexp '-<' exp             { LL $ HsArrApp $1 $3 placeHolderType HsFirstOrderApp True }
1270         | infixexp '>-' exp             { LL $ HsArrApp $3 $1 placeHolderType HsFirstOrderApp False }
1271         | infixexp '-<<' exp            { LL $ HsArrApp $1 $3 placeHolderType HsHigherOrderApp True }
1272         | infixexp '>>-' exp            { LL $ HsArrApp $3 $1 placeHolderType HsHigherOrderApp False}
1273         | infixexp                      { $1 }
1274
1275 infixexp :: { LHsExpr RdrName }
1276         : exp10                         { $1 }
1277         | infixexp qop exp10            { LL (OpApp $1 $2 (panic "fixity") $3) }
1278
1279 exp10 :: { LHsExpr RdrName }
1280         : '\\' apat apats opt_asig '->' exp
1281                         { LL $ HsLam (mkMatchGroup [LL $ Match ($2:$3) $4
1282                                                                 (unguardedGRHSs $6)
1283                                                             ]) }
1284         | 'let' binds 'in' exp                  { LL $ HsLet (unLoc $2) $4 }
1285         | 'if' exp optSemi 'then' exp optSemi 'else' exp
1286                                         {% checkDoAndIfThenElse $2 $3 $5 $6 $8 >>
1287                                            return (LL $ mkHsIf $2 $5 $8) }
1288         | 'case' exp 'of' altslist              { LL $ HsCase $2 (mkMatchGroup (unLoc $4)) }
1289         | '-' fexp                              { LL $ NegApp $2 noSyntaxExpr }
1290
1291         | 'do' stmtlist                 { L (comb2 $1 $2) (mkHsDo DoExpr  (unLoc $2)) }
1292         | 'mdo' stmtlist                { L (comb2 $1 $2) (mkHsDo MDoExpr (unLoc $2)) }
1293
1294         | scc_annot exp                         { LL $ if opt_SccProfilingOn
1295                                                         then HsSCC (unLoc $1) $2
1296                                                         else HsPar $2 }
1297         | hpc_annot exp                         { LL $ if opt_Hpc
1298                                                         then HsTickPragma (unLoc $1) $2
1299                                                         else HsPar $2 }
1300
1301         | 'proc' aexp '->' exp
1302                         {% checkPattern $2 >>= \ p ->
1303                            return (LL $ HsProc p (LL $ HsCmdTop $4 []
1304                                                    placeHolderType undefined)) }
1305                                                 -- TODO: is LL right here?
1306
1307         | '{-# CORE' STRING '#-}' exp           { LL $ HsCoreAnn (getSTRING $2) $4 }
1308                                                     -- hdaume: core annotation
1309         | fexp                                  { $1 }
1310
1311 optSemi :: { Bool }
1312         : ';'         { True }
1313         | {- empty -} { False }
1314
1315 scc_annot :: { Located FastString }
1316         : '_scc_' STRING                        {% (addWarning Opt_WarnWarningsDeprecations (getLoc $1) (text "_scc_ is deprecated; use an SCC pragma instead")) >>= \_ ->
1317                                    ( do scc <- getSCC $2; return $ LL scc ) }
1318         | '{-# SCC' STRING '#-}'                {% do scc <- getSCC $2; return $ LL scc }
1319
1320 hpc_annot :: { Located (FastString,(Int,Int),(Int,Int)) }
1321         : '{-# GENERATED' STRING INTEGER ':' INTEGER '-' INTEGER ':' INTEGER '#-}'
1322                                                 { LL $ (getSTRING $2
1323                                                        ,( fromInteger $ getINTEGER $3
1324                                                         , fromInteger $ getINTEGER $5
1325                                                         )
1326                                                        ,( fromInteger $ getINTEGER $7
1327                                                         , fromInteger $ getINTEGER $9
1328                                                         )
1329                                                        )
1330                                                  }
1331
1332 fexp    :: { LHsExpr RdrName }
1333         : fexp aexp                             { LL $ HsApp $1 $2 }
1334         | aexp                                  { $1 }
1335
1336 aexp    :: { LHsExpr RdrName }
1337         : qvar '@' aexp                 { LL $ EAsPat $1 $3 }
1338         | '~' aexp                      { LL $ ELazyPat $2 }
1339         | aexp1                 { $1 }
1340
1341 aexp1   :: { LHsExpr RdrName }
1342         : aexp1 '{' fbinds '}'  {% do { r <- mkRecConstrOrUpdate $1 (comb2 $2 $4) $3
1343                                       ; return (LL r) }}
1344         | aexp2                 { $1 }
1345
1346 -- Here was the syntax for type applications that I was planning
1347 -- but there are difficulties (e.g. what order for type args)
1348 -- so it's not enabled yet.
1349 -- But this case *is* used for the left hand side of a generic definition,
1350 -- which is parsed as an expression before being munged into a pattern
1351         | qcname '{|' type '|}'         { LL $ HsApp (sL (getLoc $1) (HsVar (unLoc $1)))
1352                                                      (sL (getLoc $3) (HsType $3)) }
1353
1354 aexp2   :: { LHsExpr RdrName }
1355         : ipvar                         { L1 (HsIPVar $! unLoc $1) }
1356         | qcname                        { L1 (HsVar   $! unLoc $1) }
1357         | literal                       { L1 (HsLit   $! unLoc $1) }
1358 -- This will enable overloaded strings permanently.  Normally the renamer turns HsString
1359 -- into HsOverLit when -foverloaded-strings is on.
1360 --      | STRING                        { sL (getLoc $1) (HsOverLit $! mkHsIsString (getSTRING $1) placeHolderType) }
1361         | INTEGER                       { sL (getLoc $1) (HsOverLit $! mkHsIntegral (getINTEGER $1) placeHolderType) }
1362         | RATIONAL                      { sL (getLoc $1) (HsOverLit $! mkHsFractional (getRATIONAL $1) placeHolderType) }
1363
1364         -- N.B.: sections get parsed by these next two productions.
1365         -- This allows you to write, e.g., '(+ 3, 4 -)', which isn't
1366         -- correct Haskell (you'd have to write '((+ 3), (4 -))')
1367         -- but the less cluttered version fell out of having texps.
1368         | '(' texp ')'                  { LL (HsPar $2) }
1369         | '(' tup_exprs ')'             { LL (ExplicitTuple $2 Boxed) }
1370
1371         | '(#' texp '#)'                { LL (ExplicitTuple [Present $2] Unboxed) }
1372         | '(#' tup_exprs '#)'           { LL (ExplicitTuple $2 Unboxed) }
1373
1374         | '[' list ']'                  { LL (unLoc $2) }
1375         | '[:' parr ':]'                { LL (unLoc $2) }
1376         | '_'                           { L1 EWildPat }
1377
1378         -- Template Haskell Extension
1379         | TH_ID_SPLICE          { L1 $ HsSpliceE (mkHsSplice
1380                                         (L1 $ HsVar (mkUnqual varName
1381                                                         (getTH_ID_SPLICE $1)))) }
1382         | '$(' exp ')'          { LL $ HsSpliceE (mkHsSplice $2) }
1383
1384
1385         | TH_VAR_QUOTE qvar     { LL $ HsBracket (VarBr (unLoc $2)) }
1386         | TH_VAR_QUOTE qcon     { LL $ HsBracket (VarBr (unLoc $2)) }
1387         | TH_TY_QUOTE tyvar     { LL $ HsBracket (VarBr (unLoc $2)) }
1388         | TH_TY_QUOTE gtycon    { LL $ HsBracket (VarBr (unLoc $2)) }
1389         | '[|' exp '|]'         { LL $ HsBracket (ExpBr $2) }
1390         | '[t|' ctype '|]'      { LL $ HsBracket (TypBr $2) }
1391         | '[p|' infixexp '|]'   {% checkPattern $2 >>= \p ->
1392                                         return (LL $ HsBracket (PatBr p)) }
1393         | '[d|' cvtopbody '|]'  { LL $ HsBracket (DecBrL $2) }
1394         | quasiquote            { L1 (HsQuasiQuoteE (unLoc $1)) }
1395
1396         -- arrow notation extension
1397         | '(|' aexp2 cmdargs '|)'       { LL $ HsArrForm $2 Nothing (reverse $3) }
1398
1399 cmdargs :: { [LHsCmdTop RdrName] }
1400         : cmdargs acmd                  { $2 : $1 }
1401         | {- empty -}                   { [] }
1402
1403 acmd    :: { LHsCmdTop RdrName }
1404         : aexp2                 { L1 $ HsCmdTop $1 [] placeHolderType undefined }
1405
1406 cvtopbody :: { [LHsDecl RdrName] }
1407         :  '{'            cvtopdecls0 '}'               { $2 }
1408         |      vocurly    cvtopdecls0 close             { $2 }
1409
1410 cvtopdecls0 :: { [LHsDecl RdrName] }
1411         : {- empty -}           { [] }
1412         | cvtopdecls            { $1 }
1413
1414 -----------------------------------------------------------------------------
1415 -- Tuple expressions
1416
1417 -- "texp" is short for tuple expressions:
1418 -- things that can appear unparenthesized as long as they're
1419 -- inside parens or delimitted by commas
1420 texp :: { LHsExpr RdrName }
1421         : exp                           { $1 }
1422
1423         -- Note [Parsing sections]
1424         -- ~~~~~~~~~~~~~~~~~~~~~~~
1425         -- We include left and right sections here, which isn't
1426         -- technically right according to the Haskell standard.
1427         -- For example (3 +, True) isn't legal.
1428         -- However, we want to parse bang patterns like
1429         --      (!x, !y)
1430         -- and it's convenient to do so here as a section
1431         -- Then when converting expr to pattern we unravel it again
1432         -- Meanwhile, the renamer checks that real sections appear
1433         -- inside parens.
1434         | infixexp qop  { LL $ SectionL $1 $2 }
1435         | qopm infixexp       { LL $ SectionR $1 $2 }
1436
1437        -- View patterns get parenthesized above
1438         | exp '->' texp   { LL $ EViewPat $1 $3 }
1439
1440 -- Always at least one comma
1441 tup_exprs :: { [HsTupArg RdrName] }
1442            : texp commas_tup_tail  { Present $1 : $2 }
1443            | commas tup_tail       { replicate $1 missingTupArg ++ $2 }
1444
1445 -- Always starts with commas; always follows an expr
1446 commas_tup_tail :: { [HsTupArg RdrName] }
1447 commas_tup_tail : commas tup_tail  { replicate ($1-1) missingTupArg ++ $2 }
1448
1449 -- Always follows a comma
1450 tup_tail :: { [HsTupArg RdrName] }
1451           : texp commas_tup_tail        { Present $1 : $2 }
1452           | texp                        { [Present $1] }
1453           | {- empty -}                 { [missingTupArg] }
1454
1455 -----------------------------------------------------------------------------
1456 -- List expressions
1457
1458 -- The rules below are little bit contorted to keep lexps left-recursive while
1459 -- avoiding another shift/reduce-conflict.
1460
1461 list :: { LHsExpr RdrName }
1462         : texp                  { L1 $ ExplicitList placeHolderType [$1] }
1463         | lexps                 { L1 $ ExplicitList placeHolderType (reverse (unLoc $1)) }
1464         | texp '..'             { LL $ ArithSeq noPostTcExpr (From $1) }
1465         | texp ',' exp '..'     { LL $ ArithSeq noPostTcExpr (FromThen $1 $3) }
1466         | texp '..' exp         { LL $ ArithSeq noPostTcExpr (FromTo $1 $3) }
1467         | texp ',' exp '..' exp { LL $ ArithSeq noPostTcExpr (FromThenTo $1 $3 $5) }
1468         | texp '|' flattenedpquals
1469              {% checkMonadComp >>= \ ctxt ->
1470                 return (sL (comb2 $1 $>) $
1471                         mkHsComp ctxt (unLoc $3) $1) }
1472
1473 lexps :: { Located [LHsExpr RdrName] }
1474         : lexps ',' texp                { LL (((:) $! $3) $! unLoc $1) }
1475         | texp ',' texp                 { LL [$3,$1] }
1476
1477 -----------------------------------------------------------------------------
1478 -- List Comprehensions
1479
1480 flattenedpquals :: { Located [LStmt RdrName] }
1481     : pquals   { case (unLoc $1) of
1482                     [qs] -> L1 qs
1483                     -- We just had one thing in our "parallel" list so
1484                     -- we simply return that thing directly
1485
1486                     qss -> L1 [L1 $ ParStmt [(qs, undefined) | qs <- qss] noSyntaxExpr noSyntaxExpr noSyntaxExpr]
1487                     -- We actually found some actual parallel lists so
1488                     -- we wrap them into as a ParStmt
1489                 }
1490
1491 pquals :: { Located [[LStmt RdrName]] }
1492     : squals '|' pquals     { L (getLoc $2) (reverse (unLoc $1) : unLoc $3) }
1493     | squals                { L (getLoc $1) [reverse (unLoc $1)] }
1494
1495 squals :: { Located [LStmt RdrName] }   -- In reverse order, because the last
1496                                         -- one can "grab" the earlier ones
1497     : squals ',' transformqual               { LL [L (getLoc $3) ((unLoc $3) (reverse (unLoc $1)))] }
1498     | squals ',' qual                        { LL ($3 : unLoc $1) }
1499     | transformqual                          { LL [L (getLoc $1) ((unLoc $1) [])] }
1500     | qual                                   { L1 [$1] }
1501 --  | transformquals1 ',' '{|' pquals '|}'   { LL ($4 : unLoc $1) }
1502 --  | '{|' pquals '|}'                       { L1 [$2] }
1503
1504
1505 -- It is possible to enable bracketing (associating) qualifier lists by uncommenting the lines with {| |}
1506 -- above. Due to a lack of consensus on the syntax, this feature is not being used until we get user
1507 -- demand.
1508
1509 transformqual :: { Located ([LStmt RdrName] -> Stmt RdrName) }
1510                         -- Function is applied to a list of stmts *in order*
1511     : 'then' exp                { LL $ \leftStmts -> (mkTransformStmt leftStmts $2) }
1512     -- >>>
1513     | 'then' exp 'by' exp       { LL $ \leftStmts -> (mkTransformByStmt leftStmts $2 $4) }
1514     | 'then' 'group' 'by' exp   { LL $ \leftStmts -> (mkGroupByStmt leftStmts $4) }
1515     -- <<<
1516     -- These two productions deliberately have a shift-reduce conflict. I have made 'group' into a special_id,
1517     -- which means you can enable TransformListComp while still using Data.List.group. However, this makes the two
1518     -- productions ambiguous. I've set things up so that Happy chooses to resolve the conflict in that case by
1519     -- choosing the "group by" variant, which is what we want.
1520     --
1521     -- This is rather dubious: the user might be confused as to how to parse this statement. However, it is a good
1522     -- practical choice. NB: Data.List.group :: [a] -> [[a]], so using the first production would not even type check
1523     -- if /that/ is the group function we conflict with.
1524     | 'then' 'group' 'using' exp           { LL $ \leftStmts -> (mkGroupUsingStmt leftStmts $4) }
1525     | 'then' 'group' 'by' exp 'using' exp  { LL $ \leftStmts -> (mkGroupByUsingStmt leftStmts $4 $6) }
1526
1527 -----------------------------------------------------------------------------
1528 -- Parallel array expressions
1529
1530 -- The rules below are little bit contorted; see the list case for details.
1531 -- Note that, in contrast to lists, we only have finite arithmetic sequences.
1532 -- Moreover, we allow explicit arrays with no element (represented by the nil
1533 -- constructor in the list case).
1534
1535 parr :: { LHsExpr RdrName }
1536         :                               { noLoc (ExplicitPArr placeHolderType []) }
1537         | texp                          { L1 $ ExplicitPArr placeHolderType [$1] }
1538         | lexps                         { L1 $ ExplicitPArr placeHolderType
1539                                                        (reverse (unLoc $1)) }
1540         | texp '..' exp                 { LL $ PArrSeq noPostTcExpr (FromTo $1 $3) }
1541         | texp ',' exp '..' exp         { LL $ PArrSeq noPostTcExpr (FromThenTo $1 $3 $5) }
1542         | texp '|' flattenedpquals      { LL $ mkHsComp PArrComp (unLoc $3) $1 }
1543
1544 -- We are reusing `lexps' and `flattenedpquals' from the list case.
1545
1546 -----------------------------------------------------------------------------
1547 -- Guards
1548
1549 guardquals :: { Located [LStmt RdrName] }
1550     : guardquals1           { L (getLoc $1) (reverse (unLoc $1)) }
1551
1552 guardquals1 :: { Located [LStmt RdrName] }
1553     : guardquals1 ',' qual  { LL ($3 : unLoc $1) }
1554     | qual                  { L1 [$1] }
1555
1556 -----------------------------------------------------------------------------
1557 -- Case alternatives
1558
1559 altslist :: { Located [LMatch RdrName] }
1560         : '{'            alts '}'       { LL (reverse (unLoc $2)) }
1561         |     vocurly    alts  close    { L (getLoc $2) (reverse (unLoc $2)) }
1562
1563 alts    :: { Located [LMatch RdrName] }
1564         : alts1                         { L1 (unLoc $1) }
1565         | ';' alts                      { LL (unLoc $2) }
1566
1567 alts1   :: { Located [LMatch RdrName] }
1568         : alts1 ';' alt                 { LL ($3 : unLoc $1) }
1569         | alts1 ';'                     { LL (unLoc $1) }
1570         | alt                           { L1 [$1] }
1571
1572 alt     :: { LMatch RdrName }
1573         : pat opt_sig alt_rhs           { LL (Match [$1] $2 (unLoc $3)) }
1574
1575 alt_rhs :: { Located (GRHSs RdrName) }
1576         : ralt wherebinds               { LL (GRHSs (unLoc $1) (unLoc $2)) }
1577
1578 ralt :: { Located [LGRHS RdrName] }
1579         : '->' exp                      { LL (unguardedRHS $2) }
1580         | gdpats                        { L1 (reverse (unLoc $1)) }
1581
1582 gdpats :: { Located [LGRHS RdrName] }
1583         : gdpats gdpat                  { LL ($2 : unLoc $1) }
1584         | gdpat                         { L1 [$1] }
1585
1586 gdpat   :: { LGRHS RdrName }
1587         : '|' guardquals '->' exp               { sL (comb2 $1 $>) $ GRHS (unLoc $2) $4 }
1588
1589 -- 'pat' recognises a pattern, including one with a bang at the top
1590 --      e.g.  "!x" or "!(x,y)" or "C a b" etc
1591 -- Bangs inside are parsed as infix operator applications, so that
1592 -- we parse them right when bang-patterns are off
1593 pat     :: { LPat RdrName }
1594 pat     :  exp                  {% checkPattern $1 }
1595         | '!' aexp              {% checkPattern (LL (SectionR (L1 (HsVar bang_RDR)) $2)) }
1596
1597 apat   :: { LPat RdrName }
1598 apat    : aexp                  {% checkPattern $1 }
1599         | '!' aexp              {% checkPattern (LL (SectionR (L1 (HsVar bang_RDR)) $2)) }
1600
1601 apats  :: { [LPat RdrName] }
1602         : apat apats            { $1 : $2 }
1603         | {- empty -}           { [] }
1604
1605 -----------------------------------------------------------------------------
1606 -- Statement sequences
1607
1608 stmtlist :: { Located [LStmt RdrName] }
1609         : '{'           stmts '}'       { LL (unLoc $2) }
1610         |     vocurly   stmts close     { $2 }
1611
1612 --      do { ;; s ; s ; ; s ;; }
1613 -- The last Stmt should be an expression, but that's hard to enforce
1614 -- here, because we need too much lookahead if we see do { e ; }
1615 -- So we use ExprStmts throughout, and switch the last one over
1616 -- in ParseUtils.checkDo instead
1617 stmts :: { Located [LStmt RdrName] }
1618         : stmt stmts_help               { LL ($1 : unLoc $2) }
1619         | ';' stmts                     { LL (unLoc $2) }
1620         | {- empty -}                   { noLoc [] }
1621
1622 stmts_help :: { Located [LStmt RdrName] } -- might be empty
1623         : ';' stmts                     { LL (unLoc $2) }
1624         | {- empty -}                   { noLoc [] }
1625
1626 -- For typing stmts at the GHCi prompt, where
1627 -- the input may consist of just comments.
1628 maybe_stmt :: { Maybe (LStmt RdrName) }
1629         : stmt                          { Just $1 }
1630         | {- nothing -}                 { Nothing }
1631
1632 stmt  :: { LStmt RdrName }
1633         : qual                              { $1 }
1634         | 'rec' stmtlist                { LL $ mkRecStmt (unLoc $2) }
1635
1636 qual  :: { LStmt RdrName }
1637     : pat '<-' exp                      { LL $ mkBindStmt $1 $3 }
1638     | exp                                   { L1 $ mkExprStmt $1 }
1639     | 'let' binds                       { LL $ LetStmt (unLoc $2) }
1640
1641 -----------------------------------------------------------------------------
1642 -- Record Field Update/Construction
1643
1644 fbinds  :: { ([HsRecField RdrName (LHsExpr RdrName)], Bool) }
1645         : fbinds1                       { $1 }
1646         | {- empty -}                   { ([], False) }
1647
1648 fbinds1 :: { ([HsRecField RdrName (LHsExpr RdrName)], Bool) }
1649         : fbind ',' fbinds1             { case $3 of (flds, dd) -> ($1 : flds, dd) }
1650         | fbind                         { ([$1], False) }
1651         | '..'                          { ([],   True) }
1652
1653 fbind   :: { HsRecField RdrName (LHsExpr RdrName) }
1654         : qvar '=' exp  { HsRecField $1 $3                False }
1655         | qvar          { HsRecField $1 placeHolderPunRhs True }
1656                         -- In the punning case, use a place-holder
1657                         -- The renamer fills in the final value
1658
1659 -----------------------------------------------------------------------------
1660 -- Implicit Parameter Bindings
1661
1662 dbinds  :: { Located [LIPBind RdrName] }
1663         : dbinds ';' dbind              { let { this = $3; rest = unLoc $1 }
1664                               in rest `seq` this `seq` LL (this : rest) }
1665         | dbinds ';'                    { LL (unLoc $1) }
1666         | dbind                         { let this = $1 in this `seq` L1 [this] }
1667 --      | {- empty -}                   { [] }
1668
1669 dbind   :: { LIPBind RdrName }
1670 dbind   : ipvar '=' exp                 { LL (IPBind (unLoc $1) $3) }
1671
1672 ipvar   :: { Located (IPName RdrName) }
1673         : IPDUPVARID            { L1 (IPName (mkUnqual varName (getIPDUPVARID $1))) }
1674
1675 -----------------------------------------------------------------------------
1676 -- Warnings and deprecations
1677
1678 namelist :: { Located [RdrName] }
1679 namelist : name_var              { L1 [unLoc $1] }
1680          | name_var ',' namelist { LL (unLoc $1 : unLoc $3) }
1681
1682 name_var :: { Located RdrName }
1683 name_var : var { $1 }
1684          | con { $1 }
1685
1686 -----------------------------------------
1687 -- Data constructors
1688 qcon    :: { Located RdrName }
1689         : qconid                { $1 }
1690         | '(' qconsym ')'       { LL (unLoc $2) }
1691         | sysdcon               { L1 $ nameRdrName (dataConName (unLoc $1)) }
1692 -- The case of '[:' ':]' is part of the production `parr'
1693
1694 con     :: { Located RdrName }
1695         : conid                 { $1 }
1696         | '(' consym ')'        { LL (unLoc $2) }
1697         | sysdcon               { L1 $ nameRdrName (dataConName (unLoc $1)) }
1698
1699 con_list :: { Located [Located RdrName] }
1700 con_list : con                  { L1 [$1] }
1701          | con ',' con_list     { LL ($1 : unLoc $3) }
1702
1703 sysdcon :: { Located DataCon }  -- Wired in data constructors
1704         : '(' ')'               { LL unitDataCon }
1705         | '(' commas ')'        { LL $ tupleCon Boxed ($2 + 1) }
1706         | '(#' '#)'             { LL $ unboxedSingletonDataCon }
1707         | '(#' commas '#)'      { LL $ tupleCon Unboxed ($2 + 1) }
1708         | '[' ']'               { LL nilDataCon }
1709
1710 conop :: { Located RdrName }
1711         : consym                { $1 }
1712         | '`' conid '`'         { LL (unLoc $2) }
1713
1714 qconop :: { Located RdrName }
1715         : qconsym               { $1 }
1716         | '`' qconid '`'        { LL (unLoc $2) }
1717
1718 -----------------------------------------------------------------------------
1719 -- Type constructors
1720
1721 gtycon  :: { Located RdrName }  -- A "general" qualified tycon
1722         : oqtycon                       { $1 }
1723         | '(' ')'                       { LL $ getRdrName unitTyCon }
1724         | '(' commas ')'                { LL $ getRdrName (tupleTyCon Boxed ($2 + 1)) }
1725         | '(#' '#)'                     { LL $ getRdrName unboxedSingletonTyCon }
1726         | '(#' commas '#)'              { LL $ getRdrName (tupleTyCon Unboxed ($2 + 1)) }
1727         | '(' '->' ')'                  { LL $ getRdrName funTyCon }
1728         | '[' ']'                       { LL $ listTyCon_RDR }
1729         | '[:' ':]'                     { LL $ parrTyCon_RDR }
1730
1731 oqtycon :: { Located RdrName }  -- An "ordinary" qualified tycon
1732         : qtycon                        { $1 }
1733         | '(' qtyconsym ')'             { LL (unLoc $2) }
1734
1735 qtyconop :: { Located RdrName } -- Qualified or unqualified
1736         : qtyconsym                     { $1 }
1737         | '`' qtycon '`'                { LL (unLoc $2) }
1738
1739 qtycon :: { Located RdrName }   -- Qualified or unqualified
1740         : QCONID                        { L1 $! mkQual tcClsName (getQCONID $1) }
1741         | PREFIXQCONSYM                 { L1 $! mkQual tcClsName (getPREFIXQCONSYM $1) }
1742         | tycon                         { $1 }
1743
1744 tycon   :: { Located RdrName }  -- Unqualified
1745         : CONID                         { L1 $! mkUnqual tcClsName (getCONID $1) }
1746
1747 qtyconsym :: { Located RdrName }
1748         : QCONSYM                       { L1 $! mkQual tcClsName (getQCONSYM $1) }
1749         | tyconsym                      { $1 }
1750
1751 tyconsym :: { Located RdrName }
1752         : CONSYM                        { L1 $! mkUnqual tcClsName (getCONSYM $1) }
1753
1754 -----------------------------------------------------------------------------
1755 -- Operators
1756
1757 op      :: { Located RdrName }   -- used in infix decls
1758         : varop                 { $1 }
1759         | conop                 { $1 }
1760
1761 varop   :: { Located RdrName }
1762         : varsym                { $1 }
1763         | '`' varid '`'         { LL (unLoc $2) }
1764
1765 qop     :: { LHsExpr RdrName }   -- used in sections
1766         : qvarop                { L1 $ HsVar (unLoc $1) }
1767         | qconop                { L1 $ HsVar (unLoc $1) }
1768
1769 qopm    :: { LHsExpr RdrName }   -- used in sections
1770         : qvaropm               { L1 $ HsVar (unLoc $1) }
1771         | qconop                { L1 $ HsVar (unLoc $1) }
1772
1773 qvarop :: { Located RdrName }
1774         : qvarsym               { $1 }
1775         | '`' qvarid '`'        { LL (unLoc $2) }
1776
1777 qvaropm :: { Located RdrName }
1778         : qvarsym_no_minus      { $1 }
1779         | '`' qvarid '`'        { LL (unLoc $2) }
1780
1781 -----------------------------------------------------------------------------
1782 -- Type variables
1783
1784 tyvar   :: { Located RdrName }
1785 tyvar   : tyvarid               { $1 }
1786         | '(' tyvarsym ')'      { LL (unLoc $2) }
1787
1788 tyvarop :: { Located RdrName }
1789 tyvarop : '`' tyvarid '`'       { LL (unLoc $2) }
1790         | tyvarsym              { $1 }
1791         | '.'                   {% parseErrorSDoc (getLoc $1)
1792                                       (vcat [ptext (sLit "Illegal symbol '.' in type"),
1793                                              ptext (sLit "Perhaps you intended -XRankNTypes or similar flag"),
1794                                              ptext (sLit "to enable explicit-forall syntax: forall <tvs>. <type>")])
1795                                 }
1796
1797 tyvarid :: { Located RdrName }
1798         : VARID                 { L1 $! mkUnqual tvName (getVARID $1) }
1799         | special_id            { L1 $! mkUnqual tvName (unLoc $1) }
1800         | 'unsafe'              { L1 $! mkUnqual tvName (fsLit "unsafe") }
1801         | 'safe'                { L1 $! mkUnqual tvName (fsLit "safe") }
1802         | 'interruptible'       { L1 $! mkUnqual tvName (fsLit "interruptible") }
1803         | 'threadsafe'          { L1 $! mkUnqual tvName (fsLit "threadsafe") }
1804
1805 tyvarsym :: { Located RdrName }
1806 -- Does not include "!", because that is used for strictness marks
1807 --               or ".", because that separates the quantified type vars from the rest
1808 --               or "*", because that's used for kinds
1809 tyvarsym : VARSYM               { L1 $! mkUnqual tvName (getVARSYM $1) }
1810
1811 -----------------------------------------------------------------------------
1812 -- Variables
1813
1814 var     :: { Located RdrName }
1815         : varid                 { $1 }
1816         | '(' varsym ')'        { LL (unLoc $2) }
1817
1818 qvar    :: { Located RdrName }
1819         : qvarid                { $1 }
1820         | '(' varsym ')'        { LL (unLoc $2) }
1821         | '(' qvarsym1 ')'      { LL (unLoc $2) }
1822 -- We've inlined qvarsym here so that the decision about
1823 -- whether it's a qvar or a var can be postponed until
1824 -- *after* we see the close paren.
1825
1826 qvarid :: { Located RdrName }
1827         : varid                 { $1 }
1828         | QVARID                { L1 $! mkQual varName (getQVARID $1) }
1829         | PREFIXQVARSYM         { L1 $! mkQual varName (getPREFIXQVARSYM $1) }
1830
1831 varid :: { Located RdrName }
1832         : VARID                 { L1 $! mkUnqual varName (getVARID $1) }
1833         | special_id            { L1 $! mkUnqual varName (unLoc $1) }
1834         | 'unsafe'              { L1 $! mkUnqual varName (fsLit "unsafe") }
1835         | 'safe'                { L1 $! mkUnqual varName (fsLit "safe") }
1836         | 'interruptible'       { L1 $! mkUnqual varName (fsLit "interruptible") }
1837         | 'threadsafe'          { L1 $! mkUnqual varName (fsLit "threadsafe") }
1838         | 'forall'              { L1 $! mkUnqual varName (fsLit "forall") }
1839         | 'family'              { L1 $! mkUnqual varName (fsLit "family") }
1840
1841 qvarsym :: { Located RdrName }
1842         : varsym                { $1 }
1843         | qvarsym1              { $1 }
1844
1845 qvarsym_no_minus :: { Located RdrName }
1846         : varsym_no_minus       { $1 }
1847         | qvarsym1              { $1 }
1848
1849 qvarsym1 :: { Located RdrName }
1850 qvarsym1 : QVARSYM              { L1 $ mkQual varName (getQVARSYM $1) }
1851
1852 varsym :: { Located RdrName }
1853         : varsym_no_minus       { $1 }
1854         | '-'                   { L1 $ mkUnqual varName (fsLit "-") }
1855
1856 varsym_no_minus :: { Located RdrName } -- varsym not including '-'
1857         : VARSYM                { L1 $ mkUnqual varName (getVARSYM $1) }
1858         | special_sym           { L1 $ mkUnqual varName (unLoc $1) }
1859
1860
1861 -- These special_ids are treated as keywords in various places,
1862 -- but as ordinary ids elsewhere.   'special_id' collects all these
1863 -- except 'unsafe', 'interruptible', 'forall', and 'family' whose treatment differs
1864 -- depending on context
1865 special_id :: { Located FastString }
1866 special_id
1867         : 'as'                  { L1 (fsLit "as") }
1868         | 'qualified'           { L1 (fsLit "qualified") }
1869         | 'hiding'              { L1 (fsLit "hiding") }
1870         | 'export'              { L1 (fsLit "export") }
1871         | 'label'               { L1 (fsLit "label")  }
1872         | 'dynamic'             { L1 (fsLit "dynamic") }
1873         | 'stdcall'             { L1 (fsLit "stdcall") }
1874         | 'ccall'               { L1 (fsLit "ccall") }
1875         | 'prim'                { L1 (fsLit "prim") }
1876         | 'group'               { L1 (fsLit "group") }
1877
1878 special_sym :: { Located FastString }
1879 special_sym : '!'       { L1 (fsLit "!") }
1880             | '.'       { L1 (fsLit ".") }
1881             | '*'       { L1 (fsLit "*") }
1882
1883 -----------------------------------------------------------------------------
1884 -- Data constructors
1885
1886 qconid :: { Located RdrName }   -- Qualified or unqualified
1887         : conid                 { $1 }
1888         | QCONID                { L1 $! mkQual dataName (getQCONID $1) }
1889         | PREFIXQCONSYM         { L1 $! mkQual dataName (getPREFIXQCONSYM $1) }
1890
1891 conid   :: { Located RdrName }
1892         : CONID                 { L1 $ mkUnqual dataName (getCONID $1) }
1893
1894 qconsym :: { Located RdrName }  -- Qualified or unqualified
1895         : consym                { $1 }
1896         | QCONSYM               { L1 $ mkQual dataName (getQCONSYM $1) }
1897
1898 consym :: { Located RdrName }
1899         : CONSYM                { L1 $ mkUnqual dataName (getCONSYM $1) }
1900
1901         -- ':' means only list cons
1902         | ':'                   { L1 $ consDataCon_RDR }
1903
1904
1905 -----------------------------------------------------------------------------
1906 -- Literals
1907
1908 literal :: { Located HsLit }
1909         : CHAR                  { L1 $ HsChar       $ getCHAR $1 }
1910         | STRING                { L1 $ HsString     $ getSTRING $1 }
1911         | PRIMINTEGER           { L1 $ HsIntPrim    $ getPRIMINTEGER $1 }
1912         | PRIMWORD              { L1 $ HsWordPrim    $ getPRIMWORD $1 }
1913         | PRIMCHAR              { L1 $ HsCharPrim   $ getPRIMCHAR $1 }
1914         | PRIMSTRING            { L1 $ HsStringPrim $ getPRIMSTRING $1 }
1915         | PRIMFLOAT             { L1 $ HsFloatPrim  $ getPRIMFLOAT $1 }
1916         | PRIMDOUBLE            { L1 $ HsDoublePrim $ getPRIMDOUBLE $1 }
1917
1918 -----------------------------------------------------------------------------
1919 -- Layout
1920
1921 close :: { () }
1922         : vccurly               { () } -- context popped in lexer.
1923         | error                 {% popContext }
1924
1925 -----------------------------------------------------------------------------
1926 -- Miscellaneous (mostly renamings)
1927
1928 modid   :: { Located ModuleName }
1929         : CONID                 { L1 $ mkModuleNameFS (getCONID $1) }
1930         | QCONID                { L1 $ let (mod,c) = getQCONID $1 in
1931                                   mkModuleNameFS
1932                                    (mkFastString
1933                                      (unpackFS mod ++ '.':unpackFS c))
1934                                 }
1935
1936 commas :: { Int }
1937         : commas ','                    { $1 + 1 }
1938         | ','                           { 1 }
1939
1940 -----------------------------------------------------------------------------
1941 -- Documentation comments
1942
1943 docnext :: { LHsDocString }
1944   : DOCNEXT {% return (L1 (HsDocString (mkFastString (getDOCNEXT $1)))) }
1945
1946 docprev :: { LHsDocString }
1947   : DOCPREV {% return (L1 (HsDocString (mkFastString (getDOCPREV $1)))) }
1948
1949 docnamed :: { Located (String, HsDocString) }
1950   : DOCNAMED {%
1951       let string = getDOCNAMED $1
1952           (name, rest) = break isSpace string
1953       in return (L1 (name, HsDocString (mkFastString rest))) }
1954
1955 docsection :: { Located (Int, HsDocString) }
1956   : DOCSECTION {% let (n, doc) = getDOCSECTION $1 in
1957         return (L1 (n, HsDocString (mkFastString doc))) }
1958
1959 moduleheader :: { Maybe LHsDocString }
1960         : DOCNEXT {% let string = getDOCNEXT $1 in
1961                      return (Just (L1 (HsDocString (mkFastString string)))) }
1962
1963 maybe_docprev :: { Maybe LHsDocString }
1964         : docprev                       { Just $1 }
1965         | {- empty -}                   { Nothing }
1966
1967 maybe_docnext :: { Maybe LHsDocString }
1968         : docnext                       { Just $1 }
1969         | {- empty -}                   { Nothing }
1970
1971 {
1972 happyError :: P a
1973 happyError = srcParseFail
1974
1975 getVARID        (L _ (ITvarid    x)) = x
1976 getCONID        (L _ (ITconid    x)) = x
1977 getVARSYM       (L _ (ITvarsym   x)) = x
1978 getCONSYM       (L _ (ITconsym   x)) = x
1979 getQVARID       (L _ (ITqvarid   x)) = x
1980 getQCONID       (L _ (ITqconid   x)) = x
1981 getQVARSYM      (L _ (ITqvarsym  x)) = x
1982 getQCONSYM      (L _ (ITqconsym  x)) = x
1983 getPREFIXQVARSYM (L _ (ITprefixqvarsym  x)) = x
1984 getPREFIXQCONSYM (L _ (ITprefixqconsym  x)) = x
1985 getIPDUPVARID   (L _ (ITdupipvarid   x)) = x
1986 getCHAR         (L _ (ITchar     x)) = x
1987 getSTRING       (L _ (ITstring   x)) = x
1988 getINTEGER      (L _ (ITinteger  x)) = x
1989 getRATIONAL     (L _ (ITrational x)) = x
1990 getPRIMCHAR     (L _ (ITprimchar   x)) = x
1991 getPRIMSTRING   (L _ (ITprimstring x)) = x
1992 getPRIMINTEGER  (L _ (ITprimint    x)) = x
1993 getPRIMWORD     (L _ (ITprimword x)) = x
1994 getPRIMFLOAT    (L _ (ITprimfloat  x)) = x
1995 getPRIMDOUBLE   (L _ (ITprimdouble x)) = x
1996 getTH_ID_SPLICE (L _ (ITidEscape x)) = x
1997 getINLINE       (L _ (ITinline_prag inl conl)) = (inl,conl)
1998 getSPEC_INLINE  (L _ (ITspec_inline_prag True))  = (Inline,  FunLike)
1999 getSPEC_INLINE  (L _ (ITspec_inline_prag False)) = (NoInline,FunLike)
2000
2001 getDOCNEXT (L _ (ITdocCommentNext x)) = x
2002 getDOCPREV (L _ (ITdocCommentPrev x)) = x
2003 getDOCNAMED (L _ (ITdocCommentNamed x)) = x
2004 getDOCSECTION (L _ (ITdocSection n x)) = (n, x)
2005
2006 getSCC :: Located Token -> P FastString
2007 getSCC lt = do let s = getSTRING lt
2008                    err = "Spaces are not allowed in SCCs"
2009                -- We probably actually want to be more restrictive than this
2010                if ' ' `elem` unpackFS s
2011                    then failSpanMsgP (getLoc lt) (text err)
2012                    else return s
2013
2014 -- Utilities for combining source spans
2015 comb2 :: Located a -> Located b -> SrcSpan
2016 comb2 a b = a `seq` b `seq` combineLocs a b
2017
2018 comb3 :: Located a -> Located b -> Located c -> SrcSpan
2019 comb3 a b c = a `seq` b `seq` c `seq`
2020     combineSrcSpans (getLoc a) (combineSrcSpans (getLoc b) (getLoc c))
2021
2022 comb4 :: Located a -> Located b -> Located c -> Located d -> SrcSpan
2023 comb4 a b c d = a `seq` b `seq` c `seq` d `seq`
2024     (combineSrcSpans (getLoc a) $ combineSrcSpans (getLoc b) $
2025                 combineSrcSpans (getLoc c) (getLoc d))
2026
2027 -- strict constructor version:
2028 {-# INLINE sL #-}
2029 sL :: SrcSpan -> a -> Located a
2030 sL span a = span `seq` a `seq` L span a
2031
2032 -- Make a source location for the file.  We're a bit lazy here and just
2033 -- make a point SrcSpan at line 1, column 0.  Strictly speaking we should
2034 -- try to find the span of the whole file (ToDo).
2035 fileSrcSpan :: P SrcSpan
2036 fileSrcSpan = do
2037   l <- getSrcLoc;
2038   let loc = mkSrcLoc (srcLocFile l) 1 1;
2039   return (mkSrcSpan loc loc)
2040 }