ApiAnnotations tweaks
[ghc.git] / compiler / parser / Parser.y
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 suppression 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://ghc.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Warnings
17 -- for details
18
19 -- | This module provides the generated Happy parser for Haskell. It exports
20 -- a number of parsers which may be used in any library that uses the GHC API.
21 -- A common usage pattern is to initialize the parser state with a given string
22 -- and then parse that string:
23 --
24 -- @
25 --     runParser :: DynFlags -> String -> P a -> ParseResult a
26 --     runParser flags str parser = unP parser parseState
27 --     where
28 --       filename = "\<interactive\>"
29 --       location = mkRealSrcLoc (mkFastString filename) 1 1
30 --       buffer = stringToStringBuffer str
31 --       parseState = mkPState flags buffer location
32 -- @
33 module Parser (parseModule, parseImport, parseStatement,
34                parseDeclaration, parseExpression, parseTypeSignature,
35                parseFullStmt, parseStmt, parseIdentifier,
36                parseType, parseHeader) where
37
38 -- base
39 import Control.Monad    ( unless, liftM )
40 import GHC.Exts
41 import Data.Char
42 import Control.Monad    ( mplus )
43
44 -- compiler/hsSyn
45 import HsSyn
46
47 -- compiler/main
48 import HscTypes         ( IsBootInterface, WarningTxt(..) )
49 import DynFlags
50
51 -- compiler/utils
52 import OrdList
53 import BooleanFormula   ( BooleanFormula(..), mkTrue )
54 import FastString
55 import Maybes           ( orElse )
56 import Outputable
57
58 -- compiler/basicTypes
59 import RdrName
60 import OccName          ( varName, dataName, tcClsName, tvName, startsWithUnderscore )
61 import DataCon          ( DataCon, dataConName )
62 import SrcLoc
63 import Module
64 import BasicTypes
65
66 -- compiler/types
67 import Type             ( funTyCon )
68 import Kind             ( Kind, liftedTypeKind, unliftedTypeKind, mkArrowKind )
69 import Class            ( FunDep )
70
71 -- compiler/parser
72 import RdrHsSyn
73 import Lexer
74 import HaddockUtils
75 import ApiAnnotation
76
77 -- compiler/typecheck
78 import TcEvidence       ( emptyTcEvBinds )
79
80 -- compiler/prelude
81 import ForeignCall
82 import TysPrim          ( liftedTypeKindTyConName, eqPrimTyCon )
83 import TysWiredIn       ( unitTyCon, unitDataCon, tupleTyCon, tupleDataCon, nilDataCon,
84                           unboxedUnitTyCon, unboxedUnitDataCon,
85                           listTyCon_RDR, parrTyCon_RDR, consDataCon_RDR, eqTyCon_RDR )
86
87 -- compiler/utils
88 import Util             ( looksLikePackageName )
89
90 }
91
92 {- Last updated: 30 Mar 2015
93
94 Conflicts: 50 shift/reduce
95            2  reduce/reduce
96
97 If you modify this parser and add a conflict, please update this comment.
98 You can learn more about the conflicts by passing 'happy' the -i flag:
99
100     happy -agc --strict compiler/parser/Parser.y -idetailed-info
101
102 How is this section formatted? Look up the state the conflict is
103 reported at, and copy the list of applicable rules (at the top).  Mark
104 *** for the rule that is the conflicting reduction (that is, the
105 interpretation which is NOT taken).  NB: Happy doesn't print a rule in a
106 state if it is empty, but you should include it in the list (you can
107 look these up in the Grammar section of the info file).
108
109 Obviously the state numbers are not stable across modifications to the parser,
110 the idea is to reproduce enough information on each conflict so you can figure
111 out what happened if the states were renumbered.  Try not to gratuitously move
112 productions around in this file.  It's probably less important to keep
113 the rule annotations up-to-date.
114
115 -------------------------------------------------------------------------------
116
117 state 0 contains 1 shift/reduce conflicts.
118
119     Conflicts: DOCNEXT (empty missing_module_keyword reduces)
120
121 Ambiguity when the source file starts with "-- | doc". We need another
122 token of lookahead to determine if a top declaration or the 'module' keyword
123 follows. Shift parses as if the 'module' keyword follows.
124
125 -------------------------------------------------------------------------------
126
127 state 49 contains 11 shift/reduce conflicts.
128
129         context -> btype . '~' btype                        (rule 279)
130         context -> btype .                                  (rule 280)
131     *** type -> btype .                                     (rule 281)
132         type -> btype . qtyconop type                       (rule 282)
133         type -> btype . tyvarop type                        (rule 283)
134         type -> btype . '->' ctype                          (rule 284)
135         type -> btype . '~' btype                           (rule 285)
136         type -> btype . SIMPLEQUOTE qconop type             (rule 286)
137         type -> btype . SIMPLEQUOTE varop type              (rule 287)
138         btype -> btype . atype                              (rule 299)
139
140     Conflicts: ':' '->' '-' '!' '*' '.' '`' VARSYM CONSYM QVARSYM QCONSYM
141
142 Example of ambiguity: 'e :: a `b` c';  does this mean
143     (e::a) `b` c, or
144     (e :: (a `b` c))
145
146 The case for '->' involves view patterns rather than type operators:
147     'case v of { x :: T -> T ... } '
148     Which of these two is intended?
149           case v of
150             (x::T) -> T         -- Rhs is T
151     or
152           case v of
153             (x::T -> T) -> ..   -- Rhs is ...
154
155 -------------------------------------------------------------------------------
156
157 state 118 contains 15 shift/reduce conflicts.
158
159         exp -> infixexp . '::' sigtype                      (rule 414)
160         exp -> infixexp . '-<' exp                          (rule 415)
161         exp -> infixexp . '>-' exp                          (rule 416)
162         exp -> infixexp . '-<<' exp                         (rule 417)
163         exp -> infixexp . '>>-' exp                         (rule 418)
164     *** exp -> infixexp .                                   (rule 419)
165         infixexp -> infixexp . qop exp10                    (rule 421)
166
167     Conflicts: ':' '::' '-' '!' '*' '-<' '>-' '-<<' '>>-'
168                '.' '`' VARSYM CONSYM QVARSYM QCONSYM
169
170 Examples of ambiguity:
171     'if x then y else z -< e'
172     'if x then y else z :: T'
173     'if x then y else z + 1' (NB: '+' is in VARSYM)
174
175 Shift parses as (per longest-parse rule):
176     'if x then y else (z -< T)'
177     'if x then y else (z :: T)'
178     'if x then y else (z + 1)'
179
180 -------------------------------------------------------------------------------
181
182 state 276 contains 1 shift/reduce conflicts.
183
184         rule -> STRING . rule_activation rule_forall infixexp '=' exp    (rule 214)
185
186     Conflict: '[' (empty rule_activation reduces)
187
188 We don't know whether the '[' starts the activation or not: it
189 might be the start of the declaration with the activation being
190 empty.  --SDM 1/4/2002
191
192 Example ambiguity:
193     '{-# RULE [0] f = ... #-}'
194
195 We parse this as having a [0] rule activation for rewriting 'f', rather
196 a rule instructing how to rewrite the expression '[0] f'.
197
198 -------------------------------------------------------------------------------
199
200 state 285 contains 11 shift/reduce conflicts.
201
202     *** type -> btype .                                     (rule 281)
203         type -> btype . qtyconop type                       (rule 282)
204         type -> btype . tyvarop type                        (rule 283)
205         type -> btype . '->' ctype                          (rule 284)
206         type -> btype . '~' btype                           (rule 285)
207         type -> btype . SIMPLEQUOTE qconop type             (rule 286)
208         type -> btype . SIMPLEQUOTE varop type              (rule 287)
209         btype -> btype . atype                              (rule 299)
210
211     Conflicts: ':' '->' '-' '!' '*' '.' '`' VARSYM CONSYM QVARSYM QCONSYM
212
213 Same as State 49, but minus the context productions.
214
215 -------------------------------------------------------------------------------
216
217 state 320 contains 1 shift/reduce conflicts.
218
219         tup_exprs -> commas . tup_tail                      (rule 502)
220         sysdcon -> '(' commas . ')'                         (rule 610)
221         commas -> commas . ','                              (rule 725)
222
223     Conflict: ')' (empty tup_tail reduces)
224
225 A tuple section with NO free variables '(,,)' is indistinguishable
226 from the Haskell98 data constructor for a tuple.  Shift resolves in
227 favor of sysdcon, which is good because a tuple section will get rejected
228 if -XTupleSections is not specified.
229
230 -------------------------------------------------------------------------------
231
232 state 372 contains 1 shift/reduce conflicts.
233
234         tup_exprs -> commas . tup_tail                      (rule 502)
235         sysdcon -> '(#' commas . '#)'                       (rule 612)
236         commas -> commas . ','                              (rule 724)
237
238     Conflict: '#)' (empty tup_tail reduces)
239
240 Same as State 320 for unboxed tuples.
241
242 -------------------------------------------------------------------------------
243
244 state 400 contains 1 shift/reduce conflicts.
245
246         exp10 -> 'let' binds . 'in' exp                     (rule 423)
247         exp10 -> 'let' binds . 'in' error                   (rule 438)
248         exp10 -> 'let' binds . error                        (rule 439)
249     *** qual -> 'let' binds .                               (rule 576)
250
251     Conflict: error
252
253 TODO: Why?
254
255 -------------------------------------------------------------------------------
256
257
258 state 462 contains 1 shift/reduce conflicts.
259
260     *** strict_mark -> '{-# NOUNPACK' '#-}' .               (rule 268)
261         strict_mark -> '{-# NOUNPACK' '#-}' . '!'           (rule 270)
262
263     Conflict: '!'
264
265 TODO: Why?
266
267 -------------------------------------------------------------------------------
268
269 state 463 contains 1 shift/reduce conflicts.
270
271     *** strict_mark -> '{-# UNPACK' '#-}' .                 (rule 267)
272         strict_mark -> '{-# UNPACK' '#-}' . '!'             (rule 269)
273
274     Conflict: '!'
275
276 Same as State 462
277
278 -------------------------------------------------------------------------------
279
280 state 494 contains 1 shift/reduce conflicts.
281
282         context -> btype '~' btype .                        (rule 279)
283     *** type -> btype '~' btype .                           (rule 285)
284         btype -> btype . atype                              (rule 299)
285
286     Conflict: '!'
287
288 TODO: Why?
289
290 -------------------------------------------------------------------------------
291
292 state 629 contains 1 shift/reduce conflicts.
293
294     *** aexp2 -> ipvar .                                    (rule 462)
295         dbind -> ipvar . '=' exp                            (rule 587)
296
297     Conflict: '='
298
299 Example ambiguity: 'let ?x ...'
300
301 The parser can't tell whether the ?x is the lhs of a normal binding or
302 an implicit binding.  Fortunately, resolving as shift gives it the only
303 sensible meaning, namely the lhs of an implicit binding.
304
305 -------------------------------------------------------------------------------
306
307 state 696 contains 1 shift/reduce conflicts.
308
309         rule -> STRING rule_activation . rule_forall infixexp '=' exp    (rule 214)
310
311     Conflict: 'forall' (empty rule_forall reduces)
312
313 Example ambiguity: '{-# RULES "name" forall = ... #-}'
314
315 'forall' is a valid variable name---we don't know whether
316 to treat a forall on the input as the beginning of a quantifier
317 or the beginning of the rule itself.  Resolving to shift means
318 it's always treated as a quantifier, hence the above is disallowed.
319 This saves explicitly defining a grammar for the rule lhs that
320 doesn't include 'forall'.
321
322 -------------------------------------------------------------------------------
323
324 state 769 contains 1 shift/reduce conflicts.
325
326     *** type -> btype '~' btype .                           (rule 285)
327         btype -> btype . atype                              (rule 299)
328
329     Conflict: '!'
330
331 TODO: Why?
332
333 -------------------------------------------------------------------------------
334
335 state 952 contains 1 shift/reduce conflicts.
336
337         transformqual -> 'then' 'group' . 'using' exp       (rule 525)
338         transformqual -> 'then' 'group' . 'by' exp 'using' exp    (rule 526)
339     *** special_id -> 'group' .                             (rule 701)
340
341     Conflict: 'by'
342
343 TODO: Why?
344
345 -------------------------------------------------------------------------------
346
347 state 1229 contains 1 reduce/reduce conflicts.
348
349     *** tyconsym -> ':' .                                   (rule 642)
350         consym -> ':' .                                     (rule 712)
351
352     Conflict: ')'
353
354 TODO: Same as State 1230
355
356 -------------------------------------------------------------------------------
357
358 state 1230 contains 1 reduce/reduce conflicts.
359
360     *** tyconsym -> CONSYM .                                (rule 640)
361         consym -> CONSYM .                                  (rule 711)
362
363     Conflict: ')'
364
365 TODO: Why?  (NB: This one has been around for a while; it's quite puzzling
366     because we really shouldn't get confused between tyconsym and consym.
367     Trace the state machine, maybe?)
368
369 -- -----------------------------------------------------------------------------
370 -- API Annotations
371 --
372
373 A lot of the productions are now cluttered with calls to
374 aa,am,ams,amms etc.
375
376 These are helper functions to make sure that the locations of the
377 various keywords such as do / let / in are captured for use by tools
378 that want to do source to source conversions, such as refactorers or
379 structured editors.
380
381 The helper functions are defined at the bottom of this file.
382
383 See
384   https://ghc.haskell.org/trac/ghc/wiki/ApiAnnotations and
385   https://ghc.haskell.org/trac/ghc/wiki/GhcAstAnnotations
386 for some background.
387
388 -- -----------------------------------------------------------------------------
389
390 -}
391
392 %token
393  '_'            { L _ ITunderscore }            -- Haskell keywords
394  'as'           { L _ ITas }
395  'case'         { L _ ITcase }
396  'class'        { L _ ITclass }
397  'data'         { L _ ITdata }
398  'default'      { L _ ITdefault }
399  'deriving'     { L _ ITderiving }
400  'do'           { L _ ITdo }
401  'else'         { L _ ITelse }
402  'hiding'       { L _ IThiding }
403  'if'           { L _ ITif }
404  'import'       { L _ ITimport }
405  'in'           { L _ ITin }
406  'infix'        { L _ ITinfix }
407  'infixl'       { L _ ITinfixl }
408  'infixr'       { L _ ITinfixr }
409  'instance'     { L _ ITinstance }
410  'let'          { L _ ITlet }
411  'module'       { L _ ITmodule }
412  'newtype'      { L _ ITnewtype }
413  'of'           { L _ ITof }
414  'qualified'    { L _ ITqualified }
415  'then'         { L _ ITthen }
416  'type'         { L _ ITtype }
417  'where'        { L _ ITwhere }
418
419  'forall'       { L _ ITforall }                -- GHC extension keywords
420  'foreign'      { L _ ITforeign }
421  'export'       { L _ ITexport }
422  'label'        { L _ ITlabel }
423  'dynamic'      { L _ ITdynamic }
424  'safe'         { L _ ITsafe }
425  'interruptible' { L _ ITinterruptible }
426  'unsafe'       { L _ ITunsafe }
427  'mdo'          { L _ ITmdo }
428  'family'       { L _ ITfamily }
429  'role'         { L _ ITrole }
430  'stdcall'      { L _ ITstdcallconv }
431  'ccall'        { L _ ITccallconv }
432  'capi'         { L _ ITcapiconv }
433  'prim'         { L _ ITprimcallconv }
434  'javascript'   { L _ ITjavascriptcallconv }
435  'proc'         { L _ ITproc }          -- for arrow notation extension
436  'rec'          { L _ ITrec }           -- for arrow notation extension
437  'group'    { L _ ITgroup }     -- for list transform extension
438  'by'       { L _ ITby }        -- for list transform extension
439  'using'    { L _ ITusing }     -- for list transform extension
440  'pattern'      { L _ ITpattern } -- for pattern synonyms
441  'static'       { L _ ITstatic }  -- for static pointers extension
442
443  '{-# INLINE'             { L _ (ITinline_prag _ _ _) }
444  '{-# SPECIALISE'         { L _ (ITspec_prag _) }
445  '{-# SPECIALISE_INLINE'  { L _ (ITspec_inline_prag _ _) }
446  '{-# SOURCE'             { L _ (ITsource_prag _) }
447  '{-# RULES'              { L _ (ITrules_prag _) }
448  '{-# CORE'               { L _ (ITcore_prag _) }      -- hdaume: annotated core
449  '{-# SCC'                { L _ (ITscc_prag _)}
450  '{-# GENERATED'          { L _ (ITgenerated_prag _) }
451  '{-# DEPRECATED'         { L _ (ITdeprecated_prag _) }
452  '{-# WARNING'            { L _ (ITwarning_prag _) }
453  '{-# UNPACK'             { L _ (ITunpack_prag _) }
454  '{-# NOUNPACK'           { L _ (ITnounpack_prag _) }
455  '{-# ANN'                { L _ (ITann_prag _) }
456  '{-# VECTORISE'          { L _ (ITvect_prag _) }
457  '{-# VECTORISE_SCALAR'   { L _ (ITvect_scalar_prag _) }
458  '{-# NOVECTORISE'        { L _ (ITnovect_prag _) }
459  '{-# MINIMAL'            { L _ (ITminimal_prag _) }
460  '{-# CTYPE'              { L _ (ITctype _) }
461  '{-# OVERLAPPING'        { L _ (IToverlapping_prag _) }
462  '{-# OVERLAPPABLE'       { L _ (IToverlappable_prag _) }
463  '{-# OVERLAPS'           { L _ (IToverlaps_prag _) }
464  '{-# INCOHERENT'         { L _ (ITincoherent_prag _) }
465  '#-}'                    { L _ ITclose_prag }
466
467  '..'           { L _ ITdotdot }                        -- reserved symbols
468  ':'            { L _ ITcolon }
469  '::'           { L _ ITdcolon }
470  '='            { L _ ITequal }
471  '\\'           { L _ ITlam }
472  'lcase'        { L _ ITlcase }
473  '|'            { L _ ITvbar }
474  '<-'           { L _ ITlarrow }
475  '->'           { L _ ITrarrow }
476  '@'            { L _ ITat }
477  '~'            { L _ ITtilde }
478  '~#'           { L _ ITtildehsh }
479  '=>'           { L _ ITdarrow }
480  '-'            { L _ ITminus }
481  '!'            { L _ ITbang }
482  '*'            { L _ ITstar }
483  '-<'           { L _ ITlarrowtail }            -- for arrow notation
484  '>-'           { L _ ITrarrowtail }            -- for arrow notation
485  '-<<'          { L _ ITLarrowtail }            -- for arrow notation
486  '>>-'          { L _ ITRarrowtail }            -- for arrow notation
487  '.'            { L _ ITdot }
488
489  '{'            { L _ ITocurly }                        -- special symbols
490  '}'            { L _ ITccurly }
491  vocurly        { L _ ITvocurly } -- virtual open curly (from layout)
492  vccurly        { L _ ITvccurly } -- virtual close curly (from layout)
493  '['            { L _ ITobrack }
494  ']'            { L _ ITcbrack }
495  '[:'           { L _ ITopabrack }
496  ':]'           { L _ ITcpabrack }
497  '('            { L _ IToparen }
498  ')'            { L _ ITcparen }
499  '(#'           { L _ IToubxparen }
500  '#)'           { L _ ITcubxparen }
501  '(|'           { L _ IToparenbar }
502  '|)'           { L _ ITcparenbar }
503  ';'            { L _ ITsemi }
504  ','            { L _ ITcomma }
505  '`'            { L _ ITbackquote }
506  SIMPLEQUOTE    { L _ ITsimpleQuote      }     -- 'x
507
508  VARID          { L _ (ITvarid    _) }          -- identifiers
509  CONID          { L _ (ITconid    _) }
510  VARSYM         { L _ (ITvarsym   _) }
511  CONSYM         { L _ (ITconsym   _) }
512  QVARID         { L _ (ITqvarid   _) }
513  QCONID         { L _ (ITqconid   _) }
514  QVARSYM        { L _ (ITqvarsym  _) }
515  QCONSYM        { L _ (ITqconsym  _) }
516  PREFIXQVARSYM  { L _ (ITprefixqvarsym  _) }
517  PREFIXQCONSYM  { L _ (ITprefixqconsym  _) }
518
519  IPDUPVARID     { L _ (ITdupipvarid   _) }              -- GHC extension
520
521  CHAR           { L _ (ITchar   _ _) }
522  STRING         { L _ (ITstring _ _) }
523  INTEGER        { L _ (ITinteger _ _) }
524  RATIONAL       { L _ (ITrational _) }
525
526  PRIMCHAR       { L _ (ITprimchar   _ _) }
527  PRIMSTRING     { L _ (ITprimstring _ _) }
528  PRIMINTEGER    { L _ (ITprimint    _ _) }
529  PRIMWORD       { L _ (ITprimword   _ _) }
530  PRIMFLOAT      { L _ (ITprimfloat  _) }
531  PRIMDOUBLE     { L _ (ITprimdouble _) }
532
533  DOCNEXT        { L _ (ITdocCommentNext _) }
534  DOCPREV        { L _ (ITdocCommentPrev _) }
535  DOCNAMED       { L _ (ITdocCommentNamed _) }
536  DOCSECTION     { L _ (ITdocSection _ _) }
537
538 -- Template Haskell
539 '[|'            { L _ ITopenExpQuote  }
540 '[p|'           { L _ ITopenPatQuote  }
541 '[t|'           { L _ ITopenTypQuote  }
542 '[d|'           { L _ ITopenDecQuote  }
543 '|]'            { L _ ITcloseQuote    }
544 '[||'           { L _ ITopenTExpQuote   }
545 '||]'           { L _ ITcloseTExpQuote  }
546 TH_ID_SPLICE    { L _ (ITidEscape _)  }     -- $x
547 '$('            { L _ ITparenEscape   }     -- $( exp )
548 TH_ID_TY_SPLICE { L _ (ITidTyEscape _)  }   -- $$x
549 '$$('           { L _ ITparenTyEscape   }   -- $$( exp )
550 TH_TY_QUOTE     { L _ ITtyQuote       }      -- ''T
551 TH_QUASIQUOTE   { L _ (ITquasiQuote _) }
552 TH_QQUASIQUOTE  { L _ (ITqQuasiQuote _) }
553
554 %monad { P } { >>= } { return }
555 %lexer { (lexer True) } { L _ ITeof }
556 %tokentype { (Located Token) }
557
558 -- Exported parsers
559 %name parseModule module
560 %name parseImport importdecl
561 %name parseStatement stmt
562 %name parseDeclaration topdecl
563 %name parseExpression exp
564 %name parseTypeSignature sigdecl
565 %name parseFullStmt   stmt
566 %name parseStmt   maybe_stmt
567 %name parseIdentifier  identifier
568 %name parseType ctype
569 %partial parseHeader header
570 %%
571
572 -----------------------------------------------------------------------------
573 -- Identifiers; one of the entry points
574 identifier :: { Located RdrName }
575         : qvar                          { $1 }
576         | qcon                          { $1 }
577         | qvarop                        { $1 }
578         | qconop                        { $1 }
579     | '(' '->' ')'      {% ams (sLL $1 $> $ getRdrName funTyCon)
580                                [mj AnnOpenP $1,mj AnnRarrow $2,mj AnnCloseP $3] }
581
582 -----------------------------------------------------------------------------
583 -- Module Header
584
585 -- The place for module deprecation is really too restrictive, but if it
586 -- was allowed at its natural place just before 'module', we get an ugly
587 -- s/r conflict with the second alternative. Another solution would be the
588 -- introduction of a new pragma DEPRECATED_MODULE, but this is not very nice,
589 -- either, and DEPRECATED is only expected to be used by people who really
590 -- know what they are doing. :-)
591
592 module :: { Located (HsModule RdrName) }
593        : maybedocheader 'module' modid maybemodwarning maybeexports 'where' body
594              {% fileSrcSpan >>= \ loc ->
595                 ams (L loc (HsModule (Just $3) $5 (fst $ snd $7)
596                               (snd $ snd $7) $4 $1)
597                     )
598                     ([mj AnnModule $2, mj AnnWhere $6] ++ fst $7) }
599         | body2
600                 {% fileSrcSpan >>= \ loc ->
601                    ams (L loc (HsModule Nothing Nothing
602                                (fst $ snd $1) (snd $ snd $1) Nothing Nothing))
603                        (fst $1) }
604
605 maybedocheader :: { Maybe LHsDocString }
606         : moduleheader            { $1 }
607         | {- empty -}             { Nothing }
608
609 missing_module_keyword :: { () }
610         : {- empty -}                           {% pushCurrentContext }
611
612 maybemodwarning :: { Maybe (Located WarningTxt) }
613     : '{-# DEPRECATED' strings '#-}'
614                       {% ajs (Just (sLL $1 $> $ DeprecatedTxt (sL1 $1 (getDEPRECATED_PRAGs $1)) (snd $ unLoc $2)))
615                              (mo $1:mc $3: (fst $ unLoc $2)) }
616     | '{-# WARNING' strings '#-}'
617                          {% ajs (Just (sLL $1 $> $ WarningTxt (sL1 $1 (getWARNING_PRAGs $1)) (snd $ unLoc $2)))
618                                 (mo $1:mc $3 : (fst $ unLoc $2)) }
619     |  {- empty -}                  { Nothing }
620
621 body    :: { ([AddAnn]
622              ,([LImportDecl RdrName], [LHsDecl RdrName])) }
623         :  '{'            top '}'      { (moc $1:mcc $3:(fst $2)
624                                          , snd $2) }
625         |      vocurly    top close    { (fst $2, snd $2) }
626
627 body2   :: { ([AddAnn]
628              ,([LImportDecl RdrName], [LHsDecl RdrName])) }
629         :  '{' top '}'                          { (moc $1:mcc $3
630                                                    :(fst $2), snd $2) }
631         |  missing_module_keyword top close     { ([],snd $2) }
632
633 top     :: { ([AddAnn]
634              ,([LImportDecl RdrName], [LHsDecl RdrName])) }
635         : importdecls                   { (fst $1
636                                           ,(reverse $ snd $1,[]))}
637         | importdecls ';' cvtopdecls    {% if null (snd $1)
638                                              then return ((mj AnnSemi $2:(fst $1))
639                                                          ,(reverse $ snd $1,$3))
640                                              else do
641                                               { addAnnotation (gl $ head $ snd $1)
642                                                               AnnSemi (gl $2)
643                                               ; return (fst $1
644                                                        ,(reverse $ snd $1,$3)) }}
645         | cvtopdecls                    { ([],([],$1)) }
646
647 cvtopdecls :: { [LHsDecl RdrName] }
648         : topdecls                              { cvTopDecls $1 }
649
650 -----------------------------------------------------------------------------
651 -- Module declaration & imports only
652
653 header  :: { Located (HsModule RdrName) }
654         : maybedocheader 'module' modid maybemodwarning maybeexports 'where' header_body
655                 {% fileSrcSpan >>= \ loc ->
656                    ams (L loc (HsModule (Just $3) $5 $7 [] $4 $1
657                           )) [mj AnnModule $2,mj AnnWhere $6] }
658         | header_body2
659                 {% fileSrcSpan >>= \ loc ->
660                    return (L loc (HsModule Nothing Nothing $1 [] Nothing
661                           Nothing)) }
662
663 header_body :: { [LImportDecl RdrName] }
664         :  '{'            importdecls           { snd $2 }
665         |      vocurly    importdecls           { snd $2 }
666
667 header_body2 :: { [LImportDecl RdrName] }
668         :  '{' importdecls                      { snd $2 }
669         |  missing_module_keyword importdecls   { snd $2 }
670
671 -----------------------------------------------------------------------------
672 -- The Export List
673
674 maybeexports :: { (Maybe (Located [LIE RdrName])) }
675         :  '(' exportlist ')'       {% ams (sLL $1 $> ()) [mop $1,mcp $3] >>
676                                        return (Just (sLL $1 $> (fromOL $2))) }
677         |  {- empty -}              { Nothing }
678
679 exportlist :: { OrdList (LIE RdrName) }
680         : expdoclist ',' expdoclist   {% addAnnotation (oll $1) AnnComma (gl $2)
681                                          >> return ($1 `appOL` $3) }
682         | exportlist1                 { $1 }
683
684 exportlist1 :: { OrdList (LIE RdrName) }
685         : expdoclist export expdoclist ',' exportlist1
686                           {% (addAnnotation (oll ($1 `appOL` $2 `appOL` $3))
687                                             AnnComma (gl $4) ) >>
688                               return ($1 `appOL` $2 `appOL` $3 `appOL` $5) }
689         | expdoclist export expdoclist             { $1 `appOL` $2 `appOL` $3 }
690         | expdoclist                               { $1 }
691
692 expdoclist :: { OrdList (LIE RdrName) }
693         : exp_doc expdoclist                           { $1 `appOL` $2 }
694         | {- empty -}                                  { nilOL }
695
696 exp_doc :: { OrdList (LIE RdrName) }
697         : docsection    { unitOL (sL1 $1 (case (unLoc $1) of (n, doc) -> IEGroup n doc)) }
698         | docnamed      { unitOL (sL1 $1 (IEDocNamed ((fst . unLoc) $1))) }
699         | docnext       { unitOL (sL1 $1 (IEDoc (unLoc $1))) }
700
701
702    -- No longer allow things like [] and (,,,) to be exported
703    -- They are built in syntax, always available
704 export  :: { OrdList (LIE RdrName) }
705         : qcname_ext export_subspec  {% amsu (sLL $1 $> (mkModuleImpExp $1
706                                                     (snd $ unLoc $2)))
707                                              (fst $ unLoc $2) }
708         |  'module' modid            {% amsu (sLL $1 $> (IEModuleContents $2))
709                                              [mj AnnModule $1] }
710         |  'pattern' qcon            {% amsu (sLL $1 $> (IEVar $2))
711                                              [mj AnnPattern $1] }
712
713 export_subspec :: { Located ([AddAnn],ImpExpSubSpec) }
714         : {- empty -}             { sL0 ([],ImpExpAbs) }
715         | '(' '..' ')'            { sLL $1 $> ([mop $1,mcp $3,mj AnnDotdot $2]
716                                        , ImpExpAll) }
717         | '(' ')'                 { sLL $1 $> ([mop $1,mcp $2],ImpExpList []) }
718         | '(' qcnames ')'         { sLL $1 $> ([mop $1,mcp $3],ImpExpList (reverse $2)) }
719
720 qcnames :: { [Located RdrName] }     -- A reversed list
721         :  qcnames ',' qcname_ext       {% (aa (head $1) (AnnComma, $2)) >>
722                                            return ($3  : $1) }
723         |  qcname_ext                   { [$1]  }
724
725 qcname_ext :: { Located RdrName }       -- Variable or data constructor
726                                         -- or tagged type constructor
727         :  qcname                   { $1 }
728         |  'type' qcname            {% amms (mkTypeImpExp (sLL $1 $> (unLoc $2)))
729                                             [mj AnnType $1,mj AnnVal $2] }
730
731 qcname  :: { Located RdrName }  -- Variable or type constructor
732         :  qvar                         { $1 }
733         |  oqtycon                      { $1 }
734
735 -----------------------------------------------------------------------------
736 -- Import Declarations
737
738 -- import decls can be *empty*, or even just a string of semicolons
739 -- whereas topdecls must contain at least one topdecl.
740
741 importdecls :: { ([AddAnn],[LImportDecl RdrName]) }
742         : importdecls ';' importdecl
743                                 {% if null (snd $1)
744                                      then return (mj AnnSemi $2:fst $1,$3 : snd $1)
745                                      else do
746                                       { addAnnotation (gl $ head $ snd $1)
747                                                       AnnSemi (gl $2)
748                                       ; return (fst $1,$3 : snd $1) } }
749         | importdecls ';'       {% if null (snd $1)
750                                      then return ((mj AnnSemi $2:fst $1),snd $1)
751                                      else do
752                                        { addAnnotation (gl $ head $ snd $1)
753                                                        AnnSemi (gl $2)
754                                        ; return $1} }
755         | importdecl             { ([],[$1]) }
756         | {- empty -}            { ([],[]) }
757
758 importdecl :: { LImportDecl RdrName }
759         : 'import' maybe_src maybe_safe optqualified maybe_pkg modid maybeas maybeimpspec
760                 {% ams (L (comb4 $1 $6 (snd $7) $8) $
761                   ImportDecl { ideclSourceSrc = snd $ fst $2
762                              , ideclName = $6, ideclPkgQual = snd $5
763                              , ideclSource = snd $2, ideclSafe = snd $3
764                              , ideclQualified = snd $4, ideclImplicit = False
765                              , ideclAs = unLoc (snd $7)
766                              , ideclHiding = unLoc $8 })
767                    ((mj AnnImport $1 : (fst $ fst $2) ++ fst $3 ++ fst $4
768                                     ++ fst $5 ++ fst $7)) }
769
770 maybe_src :: { (([AddAnn],Maybe SourceText),IsBootInterface) }
771         : '{-# SOURCE' '#-}'        { (([mo $1,mc $2],Just (getSOURCE_PRAGs $1))
772                                       ,True) }
773         | {- empty -}               { (([],Nothing),False) }
774
775 maybe_safe :: { ([AddAnn],Bool) }
776         : 'safe'                                { ([mj AnnSafe $1],True) }
777         | {- empty -}                           { ([],False) }
778
779 maybe_pkg :: { ([AddAnn],Maybe FastString) }
780         : STRING  {% let pkgFS = getSTRING $1 in
781                      if looksLikePackageName (unpackFS pkgFS)
782                         then return ([mj AnnPackageName $1], Just pkgFS)
783                         else parseErrorSDoc (getLoc $1) $ vcat [
784                              text "parse error" <> colon <+> quotes (ppr pkgFS),
785                              text "Version number or non-alphanumeric" <+>
786                              text "character in package name"] }
787         | {- empty -}                           { ([],Nothing) }
788
789 optqualified :: { ([AddAnn],Bool) }
790         : 'qualified'                           { ([mj AnnQualified $1],True)  }
791         | {- empty -}                           { ([],False) }
792
793 maybeas :: { ([AddAnn],Located (Maybe ModuleName)) }
794         : 'as' modid                           { ([mj AnnAs $1,mj AnnVal $2]
795                                                  ,sLL $1 $> (Just (unLoc $2))) }
796         | {- empty -}                          { ([],noLoc Nothing) }
797
798 maybeimpspec :: { Located (Maybe (Bool, Located [LIE RdrName])) }
799         : impspec                  { L (gl $1) (Just (unLoc $1)) }
800         | {- empty -}              { noLoc Nothing }
801
802 impspec :: { Located (Bool, Located [LIE RdrName]) }
803         :  '(' exportlist ')'               {% ams (sLL $1 $> (False,
804                                                       sLL $1 $> $ fromOL $2))
805                                                    [mop $1,mcp $3] }
806         |  'hiding' '(' exportlist ')'      {% ams (sLL $1 $> (True,
807                                                       sLL $1 $> $ fromOL $3))
808                                                [mj AnnHiding $1,mop $2,mcp $4] }
809
810 -----------------------------------------------------------------------------
811 -- Fixity Declarations
812
813 prec    :: { Located Int }
814         : {- empty -}           { noLoc 9 }
815         | INTEGER
816                  {% checkPrecP (sL1 $1 (fromInteger (getINTEGER $1))) }
817
818 infix   :: { Located FixityDirection }
819         : 'infix'                               { sL1 $1 InfixN  }
820         | 'infixl'                              { sL1 $1 InfixL  }
821         | 'infixr'                              { sL1 $1 InfixR }
822
823 ops     :: { Located (OrdList (Located RdrName)) }
824         : ops ',' op       {% addAnnotation (oll $ unLoc $1) AnnComma (gl $2) >>
825                               return (sLL $1 $> ((unLoc $1) `appOL` unitOL $3))}
826         | op               { sL1 $1 (unitOL $1) }
827
828 -----------------------------------------------------------------------------
829 -- Top-Level Declarations
830
831 topdecls :: { OrdList (LHsDecl RdrName) }
832         : topdecls ';' topdecl        {% addAnnotation (oll $1) AnnSemi (gl $2)
833                                          >> return ($1 `appOL` $3) }
834         | topdecls ';'                {% addAnnotation (oll $1) AnnSemi (gl $2)
835                                          >> return $1 }
836         | topdecl                     { $1 }
837
838 topdecl :: { OrdList (LHsDecl RdrName) }
839         : cl_decl                               { unitOL (sL1 $1 (TyClD (unLoc $1))) }
840         | ty_decl                               { unitOL (sL1 $1 (TyClD (unLoc $1))) }
841         | inst_decl                             { unitOL (sL1 $1 (InstD (unLoc $1))) }
842         | stand_alone_deriving                  { unitOL (sLL $1 $> (DerivD (unLoc $1))) }
843         | role_annot                            { unitOL (sL1 $1 (RoleAnnotD (unLoc $1))) }
844         | 'default' '(' comma_types0 ')'    {% do { def <- checkValidDefaults $3
845                                                   ; amsu (sLL $1 $> (DefD def))
846                                                          [mj AnnDefault $1
847                                                          ,mop $2,mcp $4] }}
848         | 'foreign' fdecl          {% amsu (sLL $1 $> (snd $ unLoc $2))
849                                            (mj AnnForeign $1:(fst $ unLoc $2)) }
850         | '{-# DEPRECATED' deprecations '#-}'   {% amsu (sLL $1 $> $ WarningD (Warnings (getDEPRECATED_PRAGs $1) (fromOL $2)))
851                                                        [mo $1,mc $3] }
852         | '{-# WARNING' warnings '#-}'          {% amsu (sLL $1 $> $ WarningD (Warnings (getWARNING_PRAGs $1) (fromOL $2)))
853                                                        [mo $1,mc $3] }
854         | '{-# RULES' rules '#-}'               {% amsu (sLL $1 $> $ RuleD (HsRules (getRULES_PRAGs $1) (fromOL $2)))
855                                                        [mo $1,mc $3] }
856         | '{-# VECTORISE' qvar '=' exp '#-}' {% amsu (sLL $1 $> $ VectD (HsVect (getVECT_PRAGs $1) $2 $4))
857                                                     [mo $1,mj AnnEqual $3
858                                                     ,mc $5] }
859         | '{-# NOVECTORISE' qvar '#-}'       {% amsu (sLL $1 $> $ VectD (HsNoVect (getNOVECT_PRAGs $1) $2))
860                                                      [mo $1,mc $3] }
861         | '{-# VECTORISE' 'type' gtycon '#-}'
862                                 {% amsu (sLL $1 $> $
863                                     VectD (HsVectTypeIn (getVECT_PRAGs $1) False $3 Nothing))
864                                     [mo $1,mj AnnType $2,mc $4] }
865
866         | '{-# VECTORISE_SCALAR' 'type' gtycon '#-}'
867                                 {% amsu (sLL $1 $> $
868                                     VectD (HsVectTypeIn (getVECT_SCALAR_PRAGs $1) True $3 Nothing))
869                                     [mo $1,mj AnnType $2,mc $4] }
870
871         | '{-# VECTORISE' 'type' gtycon '=' gtycon '#-}'
872                                 {% amsu (sLL $1 $> $
873                                     VectD (HsVectTypeIn (getVECT_PRAGs $1) False $3 (Just $5)))
874                                     [mo $1,mj AnnType $2,mj AnnEqual $4,mc $6] }
875         | '{-# VECTORISE_SCALAR' 'type' gtycon '=' gtycon '#-}'
876                                 {% amsu (sLL $1 $> $
877                                     VectD (HsVectTypeIn (getVECT_SCALAR_PRAGs $1) True $3 (Just $5)))
878                                     [mo $1,mj AnnType $2,mj AnnEqual $4,mc $6] }
879
880         | '{-# VECTORISE' 'class' gtycon '#-}'
881                                          {% amsu (sLL $1 $>  $ VectD (HsVectClassIn (getVECT_PRAGs $1) $3))
882                                                  [mo $1,mj AnnClass $2,mc $4] }
883         | annotation { unitOL $1 }
884         | decl_no_th                            { unLoc $1 }
885
886         -- Template Haskell Extension
887         -- The $(..) form is one possible form of infixexp
888         -- but we treat an arbitrary expression just as if
889         -- it had a $(..) wrapped around it
890         | infixexp                              { unitOL (sLL $1 $> $ mkSpliceDecl $1) }
891
892 -- Type classes
893 --
894 cl_decl :: { LTyClDecl RdrName }
895         : 'class' tycl_hdr fds where_cls
896                 {% amms (mkClassDecl (comb4 $1 $2 $3 $4) $2 $3 (snd $ unLoc $4))
897                         (mj AnnClass $1:(fst $ unLoc $3)++(fst $ unLoc $4)) }
898
899 -- Type declarations (toplevel)
900 --
901 ty_decl :: { LTyClDecl RdrName }
902            -- ordinary type synonyms
903         : 'type' type '=' ctypedoc
904                 -- Note ctype, not sigtype, on the right of '='
905                 -- We allow an explicit for-all but we don't insert one
906                 -- in   type Foo a = (b,b)
907                 -- Instead we just say b is out of scope
908                 --
909                 -- Note the use of type for the head; this allows
910                 -- infix type constructors to be declared
911                 {% amms (mkTySynonym (comb2 $1 $4) $2 $4)
912                         [mj AnnType $1,mj AnnEqual $3] }
913
914            -- type family declarations
915         | 'type' 'family' type opt_kind_sig where_type_family
916                 -- Note the use of type for the head; this allows
917                 -- infix type constructors to be declared
918                 {% amms (mkFamDecl (comb4 $1 $3 $4 $5) (snd $ unLoc $5) $3
919                                    (snd $ unLoc $4))
920                         (mj AnnType $1:mj AnnFamily $2:(fst $ unLoc $4)++(fst $ unLoc $5)) }
921
922           -- ordinary data type or newtype declaration
923         | data_or_newtype capi_ctype tycl_hdr constrs deriving
924                 {% amms (mkTyData (comb4 $1 $3 $4 $5) (snd $ unLoc $1) $2 $3
925                            Nothing (reverse (snd $ unLoc $4))
926                                    (unLoc $5))
927                                    -- We need the location on tycl_hdr in case
928                                    -- constrs and deriving are both empty
929                         ((fst $ unLoc $1):(fst $ unLoc $4)) }
930
931           -- ordinary GADT declaration
932         | data_or_newtype capi_ctype tycl_hdr opt_kind_sig
933                  gadt_constrlist
934                  deriving
935             {% amms (mkTyData (comb4 $1 $3 $5 $6) (snd $ unLoc $1) $2 $3
936                             (snd $ unLoc $4) (snd $ unLoc $5) (unLoc $6) )
937                                    -- We need the location on tycl_hdr in case
938                                    -- constrs and deriving are both empty
939                     ((fst $ unLoc $1):(fst $ unLoc $4)++(fst $ unLoc $5)) }
940
941           -- data/newtype family
942         | 'data' 'family' type opt_kind_sig
943                 {% amms (mkFamDecl (comb3 $1 $2 $4) DataFamily $3 (snd $ unLoc $4))
944                         (mj AnnData $1:mj AnnFamily $2:(fst $ unLoc $4)) }
945
946 inst_decl :: { LInstDecl RdrName }
947         : 'instance' overlap_pragma inst_type where_inst
948        {% do { (binds, sigs, _, ats, adts, _) <- cvBindsAndSigs (snd $ unLoc $4)
949              ; let cid = ClsInstDecl { cid_poly_ty = $3, cid_binds = binds
950                                      , cid_sigs = sigs, cid_tyfam_insts = ats
951                                      , cid_overlap_mode = $2
952                                      , cid_datafam_insts = adts }
953              ; let err = text "In instance head:" <+> ppr $3
954              ; checkNoPartialType err $3
955              ; sequence_ [ checkNoPartialType err ty
956                          | sig@(L _ (TypeSig _ ty _ )) <- sigs
957                          , let err = text "in instance signature" <> colon
958                                      <+> quotes (ppr sig) ]
959              ; ams (L (comb3 $1 $3 $4) (ClsInstD { cid_inst = cid }))
960                    (mj AnnInstance $1 : (fst $ unLoc $4)) } }
961
962            -- type instance declarations
963         | 'type' 'instance' ty_fam_inst_eqn
964                 {% ams $3 (fst $ unLoc $3)
965                 >> amms (mkTyFamInst (comb2 $1 $3) (snd $ unLoc $3))
966                     (mj AnnType $1:mj AnnInstance $2:(fst $ unLoc $3)) }
967
968           -- data/newtype instance declaration
969         | data_or_newtype 'instance' capi_ctype tycl_hdr constrs deriving
970             {% amms (mkDataFamInst (comb4 $1 $4 $5 $6) (snd $ unLoc $1) $3 $4
971                                       Nothing (reverse (snd  $ unLoc $5))
972                                               (unLoc $6))
973                     ((fst $ unLoc $1):mj AnnInstance $2:(fst $ unLoc $5)) }
974
975           -- GADT instance declaration
976         | data_or_newtype 'instance' capi_ctype tycl_hdr opt_kind_sig
977                  gadt_constrlist
978                  deriving
979             {% amms (mkDataFamInst (comb4 $1 $4 $6 $7) (snd $ unLoc $1) $3 $4
980                                    (snd $ unLoc $5) (snd $ unLoc $6) (unLoc $7))
981                     ((fst $ unLoc $1):mj AnnInstance $2
982                        :(fst $ unLoc $5)++(fst $ unLoc $6)) }
983
984 overlap_pragma :: { Maybe (Located OverlapMode) }
985   : '{-# OVERLAPPABLE'    '#-}' {% ajs (Just (sLL $1 $> (Overlappable (getOVERLAPPABLE_PRAGs $1))))
986                                        [mo $1,mc $2] }
987   | '{-# OVERLAPPING'     '#-}' {% ajs (Just (sLL $1 $> (Overlapping (getOVERLAPPING_PRAGs $1))))
988                                        [mo $1,mc $2] }
989   | '{-# OVERLAPS'        '#-}' {% ajs (Just (sLL $1 $> (Overlaps (getOVERLAPS_PRAGs $1))))
990                                        [mo $1,mc $2] }
991   | '{-# INCOHERENT'      '#-}' {% ajs (Just (sLL $1 $> (Incoherent (getINCOHERENT_PRAGs $1))))
992                                        [mo $1,mc $2] }
993   | {- empty -}                 { Nothing }
994
995
996 -- Closed type families
997
998 where_type_family :: { Located ([AddAnn],FamilyInfo RdrName) }
999         : {- empty -}                      { noLoc ([],OpenTypeFamily) }
1000         | 'where' ty_fam_inst_eqn_list
1001                { sLL $1 $> (mj AnnWhere $1:(fst $ unLoc $2)
1002                     ,ClosedTypeFamily (fmap reverse $ snd $ unLoc $2)) }
1003
1004 ty_fam_inst_eqn_list :: { Located ([AddAnn],Maybe [LTyFamInstEqn RdrName]) }
1005         :     '{' ty_fam_inst_eqns '}'     { sLL $1 $> ([moc $1,mcc $3]
1006                                                 ,Just (unLoc $2)) }
1007         | vocurly ty_fam_inst_eqns close   { let L loc _ = $2 in
1008                                              L loc ([],Just (unLoc $2)) }
1009         |     '{' '..' '}'                 { sLL $1 $> ([moc $1,mj AnnDotdot $2
1010                                                  ,mcc $3],Nothing) }
1011         | vocurly '..' close               { let L loc _ = $2 in
1012                                              L loc ([mj AnnDotdot $2],Nothing) }
1013
1014 ty_fam_inst_eqns :: { Located [LTyFamInstEqn RdrName] }
1015         : ty_fam_inst_eqns ';' ty_fam_inst_eqn
1016                                       {% asl (unLoc $1) $2 (snd $ unLoc $3)
1017                                          >> ams $3 (fst $ unLoc $3)
1018                                          >> return (sLL $1 $> ((snd $ unLoc $3) : unLoc $1)) }
1019         | ty_fam_inst_eqns ';'        {% addAnnotation (gl $1) AnnSemi (gl $2)
1020                                          >> return (sLL $1 $>  (unLoc $1)) }
1021         | ty_fam_inst_eqn             {% ams $1 (fst $ unLoc $1)
1022                                          >> return (sLL $1 $> [snd $ unLoc $1]) }
1023         | {- empty -}                 { noLoc [] }
1024
1025 ty_fam_inst_eqn :: { Located ([AddAnn],LTyFamInstEqn RdrName) }
1026         : type '=' ctype
1027                 -- Note the use of type for the head; this allows
1028                 -- infix type constructors and type patterns
1029               {% do { (eqn,ann) <- mkTyFamInstEqn $1 $3
1030                     ; return (sLL $1 $> (mj AnnEqual $2:ann, sLL $1 $> eqn))  } }
1031
1032 -- Associated type family declarations
1033 --
1034 -- * They have a different syntax than on the toplevel (no family special
1035 --   identifier).
1036 --
1037 -- * They also need to be separate from instances; otherwise, data family
1038 --   declarations without a kind signature cause parsing conflicts with empty
1039 --   data declarations.
1040 --
1041 at_decl_cls :: { LHsDecl RdrName }
1042         :  -- data family declarations, with optional 'family' keyword
1043           'data' opt_family type opt_kind_sig
1044                 {% amms (liftM mkTyClD (mkFamDecl (comb3 $1 $3 $4) DataFamily $3
1045                                                   (snd $ unLoc $4)))
1046                         (mj AnnData $1:$2++(fst $ unLoc $4)) }
1047
1048            -- type family declarations, with optional 'family' keyword
1049            -- (can't use opt_instance because you get shift/reduce errors
1050         | 'type' type opt_kind_sig
1051                {% amms (liftM mkTyClD (mkFamDecl (comb3 $1 $2 $3)
1052                                                   OpenTypeFamily $2 (snd $ unLoc $3)))
1053                        (mj AnnType $1:(fst $ unLoc $3)) }
1054         | 'type' 'family' type opt_kind_sig
1055                {% amms (liftM mkTyClD (mkFamDecl (comb3 $1 $3 $4)
1056                                                   OpenTypeFamily $3 (snd $ unLoc $4)))
1057                        (mj AnnType $1:mj AnnFamily $2:(fst $ unLoc $4)) }
1058
1059            -- default type instances, with optional 'instance' keyword
1060         | 'type' ty_fam_inst_eqn
1061                 {% ams $2 (fst $ unLoc $2) >>
1062                    amms (liftM mkInstD (mkTyFamInst (comb2 $1 $2) (snd $ unLoc $2)))
1063                         (mj AnnType $1:(fst $ unLoc $2)) }
1064         | 'type' 'instance' ty_fam_inst_eqn
1065                 {% ams $3 (fst $ unLoc $3) >>
1066                    amms (liftM mkInstD (mkTyFamInst (comb2 $1 $3) (snd $ unLoc $3)))
1067                         (mj AnnType $1:mj AnnInstance $2:(fst $ unLoc $3)) }
1068
1069 opt_family   :: { [AddAnn] }
1070               : {- empty -}   { [] }
1071               | 'family'      { [mj AnnFamily $1] }
1072
1073 -- Associated type instances
1074 --
1075 at_decl_inst :: { LInstDecl RdrName }
1076            -- type instance declarations
1077         : 'type' ty_fam_inst_eqn
1078                 -- Note the use of type for the head; this allows
1079                 -- infix type constructors and type patterns
1080                 {% ams $2 (fst $ unLoc $2) >>
1081                    amms (mkTyFamInst (comb2 $1 $2) (snd $ unLoc $2))
1082                         (mj AnnType $1:(fst $ unLoc $2)) }
1083
1084         -- data/newtype instance declaration
1085         | data_or_newtype capi_ctype tycl_hdr constrs deriving
1086                {% amms (mkDataFamInst (comb4 $1 $3 $4 $5) (snd $ unLoc $1) $2 $3
1087                                     Nothing (reverse (snd $ unLoc $4))
1088                                             (unLoc $5))
1089                        ((fst $ unLoc $1):(fst $ unLoc $4)) }
1090
1091         -- GADT instance declaration
1092         | data_or_newtype capi_ctype tycl_hdr opt_kind_sig
1093                  gadt_constrlist
1094                  deriving
1095                 {% amms (mkDataFamInst (comb4 $1 $3 $5 $6) (snd $ unLoc $1) $2
1096                                 $3 (snd $ unLoc $4) (snd $ unLoc $5) (unLoc $6))
1097                         ((fst $ unLoc $1):(fst $ unLoc $4)++(fst $ unLoc $5)) }
1098
1099 data_or_newtype :: { Located (AddAnn,NewOrData) }
1100         : 'data'        { sL1 $1 (mj AnnData    $1,DataType) }
1101         | 'newtype'     { sL1 $1 (mj AnnNewtype $1,NewType) }
1102
1103 opt_kind_sig :: { Located ([AddAnn],Maybe (LHsKind RdrName)) }
1104         :                             { noLoc ([],Nothing) }
1105         | '::' kind                   { sLL $1 $> ([mj AnnDcolon $1],Just ($2)) }
1106
1107 -- tycl_hdr parses the header of a class or data type decl,
1108 -- which takes the form
1109 --      T a b
1110 --      Eq a => T a
1111 --      (Eq a, Ord b) => T a b
1112 --      T Int [a]                       -- for associated types
1113 -- Rather a lot of inlining here, else we get reduce/reduce errors
1114 tycl_hdr :: { Located (Maybe (LHsContext RdrName), LHsType RdrName) }
1115         : context '=>' type         {% addAnnotation (gl $1) AnnDarrow (gl $2)
1116                                        >> (return (sLL $1 $> (Just $1, $3)))
1117                                     }
1118         | type                      { sL1 $1 (Nothing, $1) }
1119
1120 capi_ctype :: { Maybe (Located CType) }
1121 capi_ctype : '{-# CTYPE' STRING STRING '#-}'
1122                        {% ajs (Just (sLL $1 $> (CType (getCTYPEs $1) (Just (Header (getSTRING $2)))
1123                                         (getSTRING $3))))
1124                               [mo $1,mj AnnHeader $2,mj AnnVal $3,mc $4] }
1125
1126            | '{-# CTYPE'        STRING '#-}'
1127                        {% ajs (Just (sLL $1 $> (CType (getCTYPEs $1) Nothing  (getSTRING $2))))
1128                               [mo $1,mj AnnVal $2,mc $3] }
1129
1130            |           { Nothing }
1131
1132 -----------------------------------------------------------------------------
1133 -- Stand-alone deriving
1134
1135 -- Glasgow extension: stand-alone deriving declarations
1136 stand_alone_deriving :: { LDerivDecl RdrName }
1137   : 'deriving' 'instance' overlap_pragma inst_type
1138                          {% do {
1139                                  let err = text "in the stand-alone deriving instance"
1140                                             <> colon <+> quotes (ppr $4)
1141                                ; checkNoPartialType err $4
1142                                ; ams (sLL $1 $> (DerivDecl $4 $3))
1143                                      [mj AnnDeriving $1,mj AnnInstance $2] }}
1144
1145 -----------------------------------------------------------------------------
1146 -- Role annotations
1147
1148 role_annot :: { LRoleAnnotDecl RdrName }
1149 role_annot : 'type' 'role' oqtycon maybe_roles
1150           {% amms (mkRoleAnnotDecl (comb3 $1 $3 $4) $3 (reverse (unLoc $4)))
1151                   [mj AnnType $1,mj AnnRole $2] }
1152
1153 -- Reversed!
1154 maybe_roles :: { Located [Located (Maybe FastString)] }
1155 maybe_roles : {- empty -}    { noLoc [] }
1156             | roles          { $1 }
1157
1158 roles :: { Located [Located (Maybe FastString)] }
1159 roles : role             { sLL $1 $> [$1] }
1160       | roles role       { sLL $1 $> $ $2 : unLoc $1 }
1161
1162 -- read it in as a varid for better error messages
1163 role :: { Located (Maybe FastString) }
1164 role : VARID             { sL1 $1 $ Just $ getVARID $1 }
1165      | '_'               { sL1 $1 Nothing }
1166
1167 -- Pattern synonyms
1168
1169 -- Glasgow extension: pattern synonyms
1170 pattern_synonym_decl :: { LHsDecl RdrName }
1171         : 'pattern' pattern_synonym_lhs '=' pat
1172          {%ams ( let (name, args) = $2
1173                  in sLL $1 $> . ValD $ mkPatSynBind name args $4
1174                                                     ImplicitBidirectional)
1175                [mj AnnPattern $1,mj AnnEqual $3]
1176          }
1177         | 'pattern' pattern_synonym_lhs '<-' pat
1178          {%ams (let (name, args) = $2
1179                 in sLL $1 $> . ValD $ mkPatSynBind name args $4 Unidirectional)
1180                [mj AnnPattern $1,mj AnnLarrow $3] }
1181         | 'pattern' pattern_synonym_lhs '<-' pat where_decls
1182             {% do { let (name, args) = $2
1183                   ; mg <- mkPatSynMatchGroup name (snd $ unLoc $5)
1184                   ; ams (sLL $1 $> . ValD $
1185                            mkPatSynBind name args $4 (ExplicitBidirectional mg))
1186                         (mj AnnPattern $1:mj AnnLarrow $3:(fst $ unLoc $5))
1187                    }}
1188
1189 pattern_synonym_lhs :: { (Located RdrName, HsPatSynDetails (Located RdrName)) }
1190         : con vars0 { ($1, PrefixPatSyn $2) }
1191         | varid consym varid { ($2, InfixPatSyn $1 $3) }
1192
1193 vars0 :: { [Located RdrName] }
1194         : {- empty -}                 { [] }
1195         | varid vars0                 { $1 : $2 }
1196
1197 where_decls :: { Located ([AddAnn]
1198                          , Located (OrdList (LHsDecl RdrName))) }
1199         : 'where' '{' decls '}'       { sLL $1 $> ((mj AnnWhere $1:moc $2
1200                                            :mcc $4:(fst $ unLoc $3)),sL1 $3 (snd $ unLoc $3)) }
1201         | 'where' vocurly decls close { L (comb2 $1 $3) ((mj AnnWhere $1:(fst $ unLoc $3))
1202                                           ,sL1 $3 (snd $ unLoc $3)) }
1203 pattern_synonym_sig :: { LSig RdrName }
1204         : 'pattern' con '::' ptype
1205             {% do { let (flag, qtvs, prov, req, ty) = snd $ unLoc $4
1206                   ; let sig = PatSynSig $2 (flag, mkHsQTvs qtvs) prov req ty
1207                   ; checkValidPatSynSig sig
1208                   ; ams (sLL $1 $> $ sig)
1209                         (mj AnnPattern $1:mj AnnDcolon $3:(fst $ unLoc $4)) } }
1210
1211 ptype :: { Located ([AddAnn]
1212                   ,( HsExplicitFlag, [LHsTyVarBndr RdrName], LHsContext RdrName
1213                    , LHsContext RdrName, LHsType RdrName)) }
1214         : 'forall' tv_bndrs '.' ptype
1215             {% do { hintExplicitForall (getLoc $1)
1216                   ; let (_, qtvs', prov, req, ty) = snd $ unLoc $4
1217                   ; return $ sLL $1 $>
1218                                 ((mj AnnForall $1:mj AnnDot $3:(fst $ unLoc $4))
1219                                 ,(Explicit, $2 ++ qtvs', prov, req ,ty)) }}
1220         | context '=>' context '=>' type
1221             { sLL $1 $> ([mj AnnDarrow $2,mj AnnDarrow $4]
1222                         ,(Implicit, [], $1, $3, $5)) }
1223         | context '=>' type
1224             { sLL $1 $> ([mj AnnDarrow $2],(Implicit, [], $1, noLoc [], $3)) }
1225         | type
1226             { sL1 $1 ([],(Implicit, [], noLoc [], noLoc [], $1)) }
1227
1228 -----------------------------------------------------------------------------
1229 -- Nested declarations
1230
1231 -- Declaration in class bodies
1232 --
1233 decl_cls  :: { Located (OrdList (LHsDecl RdrName)) }
1234 decl_cls  : at_decl_cls                 { sLL $1 $> (unitOL $1) }
1235           | decl                        { $1 }
1236
1237           -- A 'default' signature used with the generic-programming extension
1238           | 'default' infixexp '::' sigtypedoc
1239                     {% do { (TypeSig l ty _) <- checkValSig $2 $4
1240                           ; let err = text "in default signature" <> colon <+>
1241                                       quotes (ppr ty)
1242                           ; checkNoPartialType err ty
1243                           ; ams (sLL $1 $> $ unitOL (sLL $1 $> $ SigD (GenericSig l ty)))
1244                                 [mj AnnDefault $1,mj AnnDcolon $3] } }
1245
1246 decls_cls :: { Located ([AddAnn],OrdList (LHsDecl RdrName)) }  -- Reversed
1247           : decls_cls ';' decl_cls      {% if isNilOL (snd $ unLoc $1)
1248                                              then return (sLL $1 $> (mj AnnSemi $2:(fst $ unLoc $1)
1249                                                                     , unLoc $3))
1250                                              else ams (lastOL (snd $ unLoc $1)) [mj AnnSemi $2]
1251                                            >> return (sLL $1 $> (fst $ unLoc $1
1252                                                                 ,(snd $ unLoc $1) `appOL` unLoc $3)) }
1253           | decls_cls ';'               {% if isNilOL (snd $ unLoc $1)
1254                                              then return (sLL $1 $> (mj AnnSemi $2:(fst $ unLoc $1)
1255                                                                                    ,snd $ unLoc $1))
1256                                              else ams (lastOL (snd $ unLoc $1)) [mj AnnSemi $2]
1257                                            >> return (sLL $1 $>  (unLoc $1)) }
1258           | decl_cls                    { sL1 $1 ([],unLoc $1) }
1259           | {- empty -}                 { noLoc ([],nilOL) }
1260
1261 decllist_cls
1262         :: { Located ([AddAnn]
1263                      , OrdList (LHsDecl RdrName)) }      -- Reversed
1264         : '{'         decls_cls '}'     { sLL $1 $> (moc $1:mcc $3:(fst $ unLoc $2)
1265                                              ,snd $ unLoc $2) }
1266         |     vocurly decls_cls close   { $2 }
1267
1268 -- Class body
1269 --
1270 where_cls :: { Located ([AddAnn]
1271                        ,(OrdList (LHsDecl RdrName))) }    -- Reversed
1272                                 -- No implicit parameters
1273                                 -- May have type declarations
1274         : 'where' decllist_cls          { sLL $1 $> (mj AnnWhere $1:(fst $ unLoc $2)
1275                                              ,snd $ unLoc $2) }
1276         | {- empty -}                   { noLoc ([],nilOL) }
1277
1278 -- Declarations in instance bodies
1279 --
1280 decl_inst  :: { Located (OrdList (LHsDecl RdrName)) }
1281 decl_inst  : at_decl_inst               { sLL $1 $> (unitOL (sL1 $1 (InstD (unLoc $1)))) }
1282            | decl                       { $1 }
1283
1284 decls_inst :: { Located ([AddAnn],OrdList (LHsDecl RdrName)) }   -- Reversed
1285            : decls_inst ';' decl_inst   {% if isNilOL (snd $ unLoc $1)
1286                                              then return (sLL $1 $> (mj AnnSemi $2:(fst $ unLoc $1)
1287                                                                     , unLoc $3))
1288                                              else ams (lastOL $ snd $ unLoc $1) [mj AnnSemi $2]
1289                                            >> return
1290                                             (sLL $1 $> (fst $ unLoc $1
1291                                                        ,(snd $ unLoc $1) `appOL` unLoc $3)) }
1292            | decls_inst ';'             {% if isNilOL (snd $ unLoc $1)
1293                                              then return (sLL $1 $> (mj AnnSemi $2:(fst $ unLoc $1)
1294                                                                                    ,snd $ unLoc $1))
1295                                              else ams (lastOL $ snd $ unLoc $1) [mj AnnSemi $2]
1296                                            >> return (sLL $1 $> (unLoc $1)) }
1297            | decl_inst                  { sL1 $1 ([],unLoc $1) }
1298            | {- empty -}                { noLoc ([],nilOL) }
1299
1300 decllist_inst
1301         :: { Located ([AddAnn]
1302                      , OrdList (LHsDecl RdrName)) }      -- Reversed
1303         : '{'         decls_inst '}'    { sLL $1 $> (moc $1:mcc $3:(fst $ unLoc $2),snd $ unLoc $2) }
1304         |     vocurly decls_inst close  { L (gl $2) (unLoc $2) }
1305
1306 -- Instance body
1307 --
1308 where_inst :: { Located ([AddAnn]
1309                         , OrdList (LHsDecl RdrName)) }   -- Reversed
1310                                 -- No implicit parameters
1311                                 -- May have type declarations
1312         : 'where' decllist_inst         { sLL $1 $> (mj AnnWhere $1:(fst $ unLoc $2)
1313                                              ,(snd $ unLoc $2)) }
1314         | {- empty -}                   { noLoc ([],nilOL) }
1315
1316 -- Declarations in binding groups other than classes and instances
1317 --
1318 decls   :: { Located ([AddAnn],OrdList (LHsDecl RdrName)) }
1319         : decls ';' decl    {% if isNilOL (snd $ unLoc $1)
1320                                  then return (sLL $1 $> (mj AnnSemi $2:(fst $ unLoc $1)
1321                                                         , unLoc $3))
1322                                  else do ams (lastOL $ snd $ unLoc $1) [mj AnnSemi $2]
1323                                            >> return (
1324                                           let { this = unLoc $3;
1325                                                 rest = snd $ unLoc $1;
1326                                                 these = rest `appOL` this }
1327                                           in rest `seq` this `seq` these `seq`
1328                                              (sLL $1 $> (fst $ unLoc $1,these))) }
1329         | decls ';'          {% if isNilOL (snd $ unLoc $1)
1330                                   then return (sLL $1 $> ((mj AnnSemi $2:(fst $ unLoc $1)
1331                                                           ,snd $ unLoc $1)))
1332                                   else ams (lastOL $ snd $ unLoc $1) [mj AnnSemi $2]
1333                                            >> return (sLL $1 $> (unLoc $1)) }
1334         | decl                          { sL1 $1 ([],unLoc $1) }
1335         | {- empty -}                   { noLoc ([],nilOL) }
1336
1337 decllist :: { Located ([AddAnn],OrdList (LHsDecl RdrName)) }
1338         : '{'            decls '}'     { sLL $1 $> (moc $1:mcc $3:(fst $ unLoc $2)
1339                                                    ,snd $ unLoc $2) }
1340         |     vocurly    decls close   { L (gl $2) (fst $ unLoc $2,snd $ unLoc $2) }
1341
1342 -- Binding groups other than those of class and instance declarations
1343 --
1344 binds   ::  { Located ([AddAnn],HsLocalBinds RdrName) }
1345                                          -- May have implicit parameters
1346                                                 -- No type declarations
1347         : decllist          {% do { val_binds <- cvBindGroup (snd $ unLoc $1)
1348                                   ; return (sL1 $1 (fst $ unLoc $1
1349                                                     ,HsValBinds val_binds)) } }
1350
1351         | '{'            dbinds '}'     { sLL $1 $> ([moc $1,mcc $3]
1352                                              ,HsIPBinds (IPBinds (unLoc $2)
1353                                                          emptyTcEvBinds)) }
1354
1355         |     vocurly    dbinds close   { L (getLoc $2) ([]
1356                                             ,HsIPBinds (IPBinds (unLoc $2)
1357                                                         emptyTcEvBinds)) }
1358
1359
1360 wherebinds :: { Located ([AddAnn],HsLocalBinds RdrName) }
1361                                                 -- May have implicit parameters
1362                                                 -- No type declarations
1363         : 'where' binds                 { sLL $1 $> (mj AnnWhere $1 : (fst $ unLoc $2)
1364                                              ,snd $ unLoc $2) }
1365         | {- empty -}                   { noLoc ([],emptyLocalBinds) }
1366
1367
1368 -----------------------------------------------------------------------------
1369 -- Transformation Rules
1370
1371 rules   :: { OrdList (LRuleDecl RdrName) }
1372         :  rules ';' rule              {% addAnnotation (oll $1) AnnSemi (gl $2)
1373                                           >> return ($1 `snocOL` $3) }
1374         |  rules ';'                   {% addAnnotation (oll $1) AnnSemi (gl $2)
1375                                           >> return $1 }
1376         |  rule                        { unitOL $1 }
1377         |  {- empty -}                 { nilOL }
1378
1379 rule    :: { LRuleDecl RdrName }
1380         : STRING rule_activation rule_forall infixexp '=' exp
1381          {%ams (sLL $1 $> $ (HsRule (L (gl $1) (getSTRING $1))
1382                                   ((snd $2) `orElse` AlwaysActive)
1383                                   (snd $3) $4 placeHolderNames $6
1384                                   placeHolderNames))
1385                (mj AnnEqual $5 : (fst $2) ++ (fst $3)) }
1386
1387 -- Rules can be specified to be NeverActive, unlike inline/specialize pragmas
1388 rule_activation :: { ([AddAnn],Maybe Activation) }
1389         : {- empty -}                           { ([],Nothing) }
1390         | rule_explicit_activation              { (fst $1,Just (snd $1)) }
1391
1392 rule_explicit_activation :: { ([AddAnn]
1393                               ,Activation) }  -- In brackets
1394         : '[' INTEGER ']'       { ([mos $1,mj AnnVal $2,mcs $3]
1395                                   ,ActiveAfter  (fromInteger (getINTEGER $2))) }
1396         | '[' '~' INTEGER ']'   { ([mos $1,mj AnnTilde $2,mj AnnVal $3,mcs $4]
1397                                   ,ActiveBefore (fromInteger (getINTEGER $3))) }
1398         | '[' '~' ']'           { ([mos $1,mj AnnTilde $2,mcs $3]
1399                                   ,NeverActive) }
1400
1401 rule_forall :: { ([AddAnn],[LRuleBndr RdrName]) }
1402         : 'forall' rule_var_list '.'     { ([mj AnnForall $1,mj AnnDot $3],$2) }
1403         | {- empty -}                    { ([],[]) }
1404
1405 rule_var_list :: { [LRuleBndr RdrName] }
1406         : rule_var                              { [$1] }
1407         | rule_var rule_var_list                { $1 : $2 }
1408
1409 rule_var :: { LRuleBndr RdrName }
1410         : varid                         { sLL $1 $> (RuleBndr $1) }
1411         | '(' varid '::' ctype ')'      {% ams (sLL $1 $> (RuleBndrSig $2
1412                                                        (mkHsWithBndrs $4)))
1413                                                [mop $1,mj AnnDcolon $3,mcp $5] }
1414
1415 -----------------------------------------------------------------------------
1416 -- Warnings and deprecations (c.f. rules)
1417
1418 warnings :: { OrdList (LWarnDecl RdrName) }
1419         : warnings ';' warning         {% addAnnotation (oll $1) AnnSemi (gl $2)
1420                                           >> return ($1 `appOL` $3) }
1421         | warnings ';'                 {% addAnnotation (oll $1) AnnSemi (gl $2)
1422                                           >> return $1 }
1423         | warning                      { $1 }
1424         | {- empty -}                  { nilOL }
1425
1426 -- SUP: TEMPORARY HACK, not checking for `module Foo'
1427 warning :: { OrdList (LWarnDecl RdrName) }
1428         : namelist strings
1429                 {% amsu (sLL $1 $> (Warning (unLoc $1) (WarningTxt (noLoc "") $ snd $ unLoc $2)))
1430                      (fst $ unLoc $2) }
1431
1432 deprecations :: { OrdList (LWarnDecl RdrName) }
1433         : deprecations ';' deprecation
1434                                        {% addAnnotation (oll $1) AnnSemi (gl $2)
1435                                           >> return ($1 `appOL` $3) }
1436         | deprecations ';'             {% addAnnotation (oll $1) AnnSemi (gl $2)
1437                                           >> return $1 }
1438         | deprecation                  { $1 }
1439         | {- empty -}                  { nilOL }
1440
1441 -- SUP: TEMPORARY HACK, not checking for `module Foo'
1442 deprecation :: { OrdList (LWarnDecl RdrName) }
1443         : namelist strings
1444              {% amsu (sLL $1 $> $ (Warning (unLoc $1) (DeprecatedTxt (noLoc "") $ snd $ unLoc $2)))
1445                      (fst $ unLoc $2) }
1446
1447 strings :: { Located ([AddAnn],[Located FastString]) }
1448     : STRING { sL1 $1 ([],[L (gl $1) (getSTRING $1)]) }
1449     | '[' stringlist ']' { sLL $1 $> $ ([mos $1,mcs $3],fromOL (unLoc $2)) }
1450
1451 stringlist :: { Located (OrdList (Located FastString)) }
1452     : stringlist ',' STRING {% addAnnotation (oll $ unLoc $1) AnnComma (gl $2) >>
1453                                return (sLL $1 $> (unLoc $1 `snocOL`
1454                                                   (L (gl $3) (getSTRING $3)))) }
1455     | STRING                { sLL $1 $> (unitOL (L (gl $1) (getSTRING $1))) }
1456
1457 -----------------------------------------------------------------------------
1458 -- Annotations
1459 annotation :: { LHsDecl RdrName }
1460     : '{-# ANN' name_var aexp '#-}'      {% ams (sLL $1 $> (AnnD $ HsAnnotation
1461                                             (getANN_PRAGs $1)
1462                                             (ValueAnnProvenance $2) $3))
1463                                             [mo $1,mc $4] }
1464
1465     | '{-# ANN' 'type' tycon aexp '#-}'  {% ams (sLL $1 $> (AnnD $ HsAnnotation
1466                                             (getANN_PRAGs $1)
1467                                             (TypeAnnProvenance $3) $4))
1468                                             [mo $1,mj AnnType $2,mc $5] }
1469
1470     | '{-# ANN' 'module' aexp '#-}'      {% ams (sLL $1 $> (AnnD $ HsAnnotation
1471                                                 (getANN_PRAGs $1)
1472                                                  ModuleAnnProvenance $3))
1473                                                 [mo $1,mj AnnModule $2,mc $4] }
1474
1475
1476 -----------------------------------------------------------------------------
1477 -- Foreign import and export declarations
1478
1479 fdecl :: { Located ([AddAnn],HsDecl RdrName) }
1480 fdecl : 'import' callconv safety fspec
1481                {% mkImport $2 $3 (snd $ unLoc $4) >>= \i ->
1482                  return (sLL $1 $> (mj AnnImport $1 : (fst $ unLoc $4),i))  }
1483       | 'import' callconv        fspec
1484                {% do { d <- mkImport $2 (noLoc PlaySafe) (snd $ unLoc $3);
1485                     return (sLL $1 $> (mj AnnImport $1 : (fst $ unLoc $3),d)) }}
1486       | 'export' callconv fspec
1487                {% mkExport $2 (snd $ unLoc $3) >>= \i ->
1488                   return (sLL $1 $> (mj AnnExport $1 : (fst $ unLoc $3),i) ) }
1489
1490 callconv :: { Located CCallConv }
1491           : 'stdcall'                   { sLL $1 $> StdCallConv }
1492           | 'ccall'                     { sLL $1 $> CCallConv   }
1493           | 'capi'                      { sLL $1 $> CApiConv    }
1494           | 'prim'                      { sLL $1 $> PrimCallConv}
1495           | 'javascript'                { sLL $1 $> JavaScriptCallConv }
1496
1497 safety :: { Located Safety }
1498         : 'unsafe'                      { sLL $1 $> PlayRisky }
1499         | 'safe'                        { sLL $1 $> PlaySafe }
1500         | 'interruptible'               { sLL $1 $> PlayInterruptible }
1501
1502 fspec :: { Located ([AddAnn]
1503                     ,(Located FastString, Located RdrName, LHsType RdrName)) }
1504        : STRING var '::' sigtypedoc     { sLL $1 $> ([mj AnnDcolon $3]
1505                                              ,(L (getLoc $1)
1506                                                     (getSTRING $1), $2, $4)) }
1507        |        var '::' sigtypedoc     { sLL $1 $> ([mj AnnDcolon $2]
1508                                              ,(noLoc nilFS, $1, $3)) }
1509          -- if the entity string is missing, it defaults to the empty string;
1510          -- the meaning of an empty entity string depends on the calling
1511          -- convention
1512
1513 -----------------------------------------------------------------------------
1514 -- Type signatures
1515
1516 opt_sig :: { ([AddAnn],Maybe (LHsType RdrName)) }
1517         : {- empty -}                   { ([],Nothing) }
1518         | '::' sigtype                  { ([mj AnnDcolon $1],Just $2) }
1519
1520 opt_asig :: { ([AddAnn],Maybe (LHsType RdrName)) }
1521         : {- empty -}                   { ([],Nothing) }
1522         | '::' atype                    { ([mj AnnDcolon $1],Just $2) }
1523
1524 sigtype :: { LHsType RdrName }          -- Always a HsForAllTy,
1525                                         -- to tell the renamer where to generalise
1526         : ctype                         { sL1 $1 (mkImplicitHsForAllTy $1) }
1527         -- Wrap an Implicit forall if there isn't one there already
1528
1529 sigtypedoc :: { LHsType RdrName }       -- Always a HsForAllTy
1530         : ctypedoc                      { sL1 $1 (mkImplicitHsForAllTy $1) }
1531         -- Wrap an Implicit forall if there isn't one there already
1532
1533 sig_vars :: { Located [Located RdrName] }    -- Returned in reversed order
1534          : sig_vars ',' var           {% addAnnotation (gl $ head $ unLoc $1)
1535                                                        AnnComma (gl $2)
1536                                          >> return (sLL $1 $> ($3 : unLoc $1)) }
1537          | var                        { sL1 $1 [$1] }
1538
1539 sigtypes1 :: { (OrdList (LHsType RdrName)) }      -- Always HsForAllTys
1540         : sigtype                      { unitOL $1 }
1541         | sigtype ',' sigtypes1        {% addAnnotation (gl $1) AnnComma (gl $2)
1542                                           >> return ((unitOL $1) `appOL` $3) }
1543
1544 -----------------------------------------------------------------------------
1545 -- Types
1546
1547 strict_mark :: { Located ([AddAnn],HsBang) }
1548         : '!'                        { sL1 $1 ([mj AnnBang $1]
1549                                               ,HsSrcBang Nothing                       Nothing      True) }
1550         | '{-# UNPACK' '#-}'         { sLL $1 $> ([mo $1,mc $2]
1551                                               ,HsSrcBang (Just $ getUNPACK_PRAGs $1)   (Just True)  False) }
1552         | '{-# NOUNPACK' '#-}'       { sLL $1 $> ([mo $1,mc $2]
1553                                               ,HsSrcBang (Just $ getNOUNPACK_PRAGs $1) (Just False) False) }
1554         | '{-# UNPACK' '#-}' '!'     { sLL $1 $> ([mo $1,mc $2,mj AnnBang $3]
1555                                               ,HsSrcBang (Just $ getUNPACK_PRAGs $1)   (Just True)  True) }
1556         | '{-# NOUNPACK' '#-}' '!'   { sLL $1 $> ([mo $1,mc $2,mj AnnBang $3]
1557                                               ,HsSrcBang (Just $ getNOUNPACK_PRAGs $1) (Just False) True) }
1558         -- Although UNPACK with no '!' is illegal, we get a
1559         -- better error message if we parse it here
1560
1561 -- A ctype is a for-all type
1562 ctype   :: { LHsType RdrName }
1563         : 'forall' tv_bndrs '.' ctype   {% hintExplicitForall (getLoc $1) >>
1564                                            ams (sLL $1 $> $ mkExplicitHsForAllTy $2
1565                                                                  (noLoc []) $4)
1566                                                [mj AnnForall $1,mj AnnDot $3] }
1567         | context '=>' ctype          {% addAnnotation (gl $1) AnnDarrow (gl $2)
1568                                          >> return (sLL $1 $> $
1569                                                mkQualifiedHsForAllTy $1 $3) }
1570         | ipvar '::' type             {% ams (sLL $1 $> (HsIParamTy (unLoc $1) $3))
1571                                              [mj AnnVal $1,mj AnnDcolon $2] }
1572         | type                        { $1 }
1573
1574 ----------------------
1575 -- Notes for 'ctypedoc'
1576 -- It would have been nice to simplify the grammar by unifying `ctype` and
1577 -- ctypedoc` into one production, allowing comments on types everywhere (and
1578 -- rejecting them after parsing, where necessary).  This is however not possible
1579 -- since it leads to ambiguity. The reason is the support for comments on record
1580 -- fields:
1581 --         data R = R { field :: Int -- ^ comment on the field }
1582 -- If we allow comments on types here, it's not clear if the comment applies
1583 -- to 'field' or to 'Int'. So we must use `ctype` to describe the type.
1584
1585 ctypedoc :: { LHsType RdrName }
1586         : 'forall' tv_bndrs '.' ctypedoc {% hintExplicitForall (getLoc $1) >>
1587                                             ams (sLL $1 $> $ mkExplicitHsForAllTy $2
1588                                                                   (noLoc []) $4)
1589                                                 [mj AnnForall $1,mj AnnDot $3] }
1590         | context '=>' ctypedoc       {% addAnnotation (gl $1) AnnDarrow (gl $2)
1591                                          >> return (sLL $1 $> $
1592                                                   mkQualifiedHsForAllTy $1 $3) }
1593         | ipvar '::' type             {% ams (sLL $1 $> (HsIParamTy (unLoc $1) $3))
1594                                              [mj AnnVal $1,mj AnnDcolon $2] }
1595         | typedoc                     { $1 }
1596
1597 ----------------------
1598 -- Notes for 'context'
1599 -- We parse a context as a btype so that we don't get reduce/reduce
1600 -- errors in ctype.  The basic problem is that
1601 --      (Eq a, Ord a)
1602 -- looks so much like a tuple type.  We can't tell until we find the =>
1603
1604 -- We have the t1 ~ t2 form both in 'context' and in type,
1605 -- to permit an individual equational constraint without parenthesis.
1606 -- Thus for some reason we allow    f :: a~b => blah
1607 -- but not                          f :: ?x::Int => blah
1608 context :: { LHsContext RdrName }
1609         : btype '~'      btype          {% do { (anns,ctx) <- checkContext
1610                                                  (sLL $1 $> $ HsEqTy $1 $3)
1611                                               ; ams ctx (mj AnnTilde $2:anns) } }
1612         | btype                         {% do { (anns,ctx) <- checkContext $1
1613                                               ; if null (unLoc ctx)
1614                                                  then addAnnotation (gl $1) AnnUnit (gl $1)
1615                                                  else return ()
1616                                               ; ams ctx anns
1617                                               } }
1618
1619 type :: { LHsType RdrName }
1620         : btype                         { $1 }
1621         | btype qtyconop type           { sLL $1 $> $ mkHsOpTy $1 $2 $3 }
1622         | btype tyvarop  type           { sLL $1 $> $ mkHsOpTy $1 $2 $3 }
1623         | btype '->'     ctype          {% ams $1 [mj AnnRarrow $2]
1624                                         >> ams (sLL $1 $> $ HsFunTy $1 $3)
1625                                                [mj AnnRarrow $2] }
1626         | btype '~'      btype          {% ams (sLL $1 $> $ HsEqTy $1 $3)
1627                                                [mj AnnTilde $2] }
1628                                         -- see Note [Promotion]
1629         | btype SIMPLEQUOTE qconop type  {% ams (sLL $1 $> $ mkHsOpTy $1 $3 $4)
1630                                                 [mj AnnSimpleQuote $2] }
1631         | btype SIMPLEQUOTE varop  type  {% ams (sLL $1 $> $ mkHsOpTy $1 $3 $4)
1632                                                 [mj AnnSimpleQuote $2] }
1633
1634 typedoc :: { LHsType RdrName }
1635         : btype                          { $1 }
1636         | btype docprev                  { sLL $1 $> $ HsDocTy $1 $2 }
1637         | btype qtyconop type            { sLL $1 $> $ mkHsOpTy $1 $2 $3 }
1638         | btype qtyconop type docprev    { sLL $1 $> $ HsDocTy (L (comb3 $1 $2 $3) (mkHsOpTy $1 $2 $3)) $4 }
1639         | btype tyvarop  type            { sLL $1 $> $ mkHsOpTy $1 $2 $3 }
1640         | btype tyvarop  type docprev    { sLL $1 $> $ HsDocTy (L (comb3 $1 $2 $3) (mkHsOpTy $1 $2 $3)) $4 }
1641         | btype '->'     ctypedoc        {% ams (sLL $1 $> $ HsFunTy $1 $3)
1642                                                 [mj AnnRarrow $2] }
1643         | btype docprev '->' ctypedoc    {% ams (sLL $1 $> $ HsFunTy (L (comb2 $1 $2)
1644                                                             (HsDocTy $1 $2)) $4)
1645                                                 [mj AnnRarrow $3] }
1646         | btype '~'      btype           {% ams (sLL $1 $> $ HsEqTy $1 $3)
1647                                                 [mj AnnTilde $2] }
1648                                         -- see Note [Promotion]
1649         | btype SIMPLEQUOTE qconop type  {% ams (sLL $1 $> $ mkHsOpTy $1 $3 $4)
1650                                                 [mj AnnSimpleQuote $2] }
1651         | btype SIMPLEQUOTE varop  type  {% ams (sLL $1 $> $ mkHsOpTy $1 $3 $4)
1652                                                 [mj AnnSimpleQuote $2] }
1653
1654 btype :: { LHsType RdrName }
1655         : btype atype                   { sLL $1 $> $ HsAppTy $1 $2 }
1656         | atype                         { $1 }
1657
1658 atype :: { LHsType RdrName }
1659         : ntgtycon                       { sL1 $1 (HsTyVar (unLoc $1)) }      -- Not including unit tuples
1660         | tyvar                          {% do { nwc <- namedWildcardsEnabled -- (See Note [Unit tuples])
1661                                                ; let tv@(Unqual name) = unLoc $1
1662                                                ; return $ if (startsWithUnderscore name && nwc)
1663                                                           then (sL1 $1 (HsNamedWildcardTy tv))
1664                                                           else (sL1 $1 (HsTyVar tv)) } }
1665
1666         | strict_mark atype              {% ams (sLL $1 $> (HsBangTy (snd $ unLoc $1) $2))
1667                                                 (fst $ unLoc $1) }  -- Constructor sigs only
1668         | '{' fielddecls '}'             {% amms (checkRecordSyntax
1669                                                     (sLL $1 $> $ HsRecTy $2))
1670                                                         -- Constructor sigs only
1671                                                  [moc $1,mcc $3] }
1672         | '(' ')'                        {% ams (sLL $1 $> $ HsTupleTy
1673                                                     HsBoxedOrConstraintTuple [])
1674                                                 [mop $1,mcp $2] }
1675         | '(' ctype ',' comma_types1 ')' {% addAnnotation (gl $2) AnnComma
1676                                                           (gl $3) >>
1677                                             ams (sLL $1 $> $ HsTupleTy
1678                                              HsBoxedOrConstraintTuple ($2 : $4))
1679                                                 [mop $1,mcp $5] }
1680         | '(#' '#)'                   {% ams (sLL $1 $> $ HsTupleTy HsUnboxedTuple [])
1681                                              [mo $1,mc $2] }
1682         | '(#' comma_types1 '#)'      {% ams (sLL $1 $> $ HsTupleTy HsUnboxedTuple $2)
1683                                              [mo $1,mc $3] }
1684         | '[' ctype ']'               {% ams (sLL $1 $> $ HsListTy  $2) [mos $1,mcs $3] }
1685         | '[:' ctype ':]'             {% ams (sLL $1 $> $ HsPArrTy  $2) [mo $1,mc $3] }
1686         | '(' ctype ')'               {% ams (sLL $1 $> $ HsParTy   $2) [mop $1,mcp $3] }
1687         | '(' ctype '::' kind ')'     {% ams (sLL $1 $> $ HsKindSig $2 $4)
1688                                              [mop $1,mj AnnDcolon $3,mcp $5] }
1689         | quasiquote                  { sL1 $1 (HsSpliceTy (unLoc $1) placeHolderKind) }
1690         | '$(' exp ')'                {% ams (sLL $1 $> $ mkHsSpliceTy $2)
1691                                              [mj AnnOpenPE $1,mj AnnCloseP $3] }
1692         | TH_ID_SPLICE                {%ams (sLL $1 $> $ mkHsSpliceTy $ sL1 $1 $ HsVar $
1693                                              mkUnqual varName (getTH_ID_SPLICE $1))
1694                                              [mj AnnThIdSplice $1] }
1695                                       -- see Note [Promotion] for the followings
1696         | SIMPLEQUOTE qcon_nowiredlist {% ams (sLL $1 $> $ HsTyVar $ unLoc $2) [mj AnnSimpleQuote $1,mj AnnName $2] }
1697         | SIMPLEQUOTE  '(' ctype ',' comma_types1 ')'
1698                              {% addAnnotation (gl $3) AnnComma (gl $4) >>
1699                                 ams (sLL $1 $> $ HsExplicitTupleTy [] ($3 : $5))
1700                                     [mj AnnSimpleQuote $1,mop $2,mcp $6] }
1701         | SIMPLEQUOTE  '[' comma_types0 ']'     {% ams (sLL $1 $> $ HsExplicitListTy
1702                                                             placeHolderKind $3)
1703                                                        [mj AnnSimpleQuote $1,mos $2,mcs $4] }
1704         | SIMPLEQUOTE var                       {% ams (sLL $1 $> $ HsTyVar $ unLoc $2)
1705                                                        [mj AnnSimpleQuote $1,mj AnnName $2] }
1706
1707         -- Two or more [ty, ty, ty] must be a promoted list type, just as
1708         -- if you had written '[ty, ty, ty]
1709         -- (One means a list type, zero means the list type constructor,
1710         -- so you have to quote those.)
1711         | '[' ctype ',' comma_types1 ']'  {% addAnnotation (gl $2) AnnComma
1712                                                            (gl $3) >>
1713                                              ams (sLL $1 $> $ HsExplicitListTy
1714                                                      placeHolderKind ($2 : $4))
1715                                                  [mos $1,mcs $5] }
1716         | INTEGER              { sLL $1 $> $ HsTyLit $ HsNumTy (getINTEGERs $1)
1717                                                                (getINTEGER $1) }
1718         | STRING               { sLL $1 $> $ HsTyLit $ HsStrTy (getSTRINGs $1)
1719                                                                (getSTRING  $1) }
1720         | '_'                  { sL1 $1 $ HsWildcardTy }
1721
1722 -- An inst_type is what occurs in the head of an instance decl
1723 --      e.g.  (Foo a, Gaz b) => Wibble a b
1724 -- It's kept as a single type, with a MonoDictTy at the right
1725 -- hand corner, for convenience.
1726 inst_type :: { LHsType RdrName }
1727         : sigtype                       { $1 }
1728
1729 inst_types1 :: { [LHsType RdrName] }
1730         : inst_type                     { [$1] }
1731
1732         | inst_type ',' inst_types1    {% addAnnotation (gl $1) AnnComma (gl $2)
1733                                           >> return ($1 : $3) }
1734
1735 comma_types0  :: { [LHsType RdrName] }  -- Zero or more:  ty,ty,ty
1736         : comma_types1                  { $1 }
1737         | {- empty -}                   { [] }
1738
1739 comma_types1    :: { [LHsType RdrName] }  -- One or more:  ty,ty,ty
1740         : ctype                        { [$1] }
1741         | ctype  ',' comma_types1      {% addAnnotation (gl $1) AnnComma (gl $2)
1742                                           >> return ($1 : $3) }
1743
1744 tv_bndrs :: { [LHsTyVarBndr RdrName] }
1745          : tv_bndr tv_bndrs             { $1 : $2 }
1746          | {- empty -}                  { [] }
1747
1748 tv_bndr :: { LHsTyVarBndr RdrName }
1749         : tyvar                         { sL1 $1 (UserTyVar (unLoc $1)) }
1750         | '(' tyvar '::' kind ')'       {% ams (sLL $1 $>  (KindedTyVar $2 $4))
1751                                                [mop $1,mj AnnDcolon $3
1752                                                ,mcp $5] }
1753
1754 fds :: { Located ([AddAnn],[Located (FunDep (Located RdrName))]) }
1755         : {- empty -}                   { noLoc ([],[]) }
1756         | '|' fds1                      { (sLL $1 $> ([mj AnnVbar $1]
1757                                                  ,reverse (unLoc $2))) }
1758
1759 fds1 :: { Located [Located (FunDep (Located RdrName))] }
1760         : fds1 ',' fd   {% addAnnotation (gl $ head $ unLoc $1) AnnComma (gl $2)
1761                            >> return (sLL $1 $> ($3 : unLoc $1)) }
1762         | fd            { sL1 $1 [$1] }
1763
1764 fd :: { Located (FunDep (Located RdrName)) }
1765         : varids0 '->' varids0  {% ams (L (comb3 $1 $2 $3)
1766                                        (reverse (unLoc $1), reverse (unLoc $3)))
1767                                        [mj AnnRarrow $2] }
1768
1769 varids0 :: { Located [Located RdrName] }
1770         : {- empty -}                   { noLoc [] }
1771         | varids0 tyvar                 { sLL $1 $> ($2 : unLoc $1) }
1772
1773 -----------------------------------------------------------------------------
1774 -- Kinds
1775
1776 kind :: { LHsKind RdrName }
1777         : bkind                  { $1 }
1778         | bkind '->' kind        {% ams (sLL $1 $> $ HsFunTy $1 $3)
1779                                         [mj AnnRarrow $2] }
1780
1781 bkind :: { LHsKind RdrName }
1782         : akind                  { $1 }
1783         | bkind akind            { sLL $1 $> $ HsAppTy $1 $2 }
1784
1785 akind :: { LHsKind RdrName }
1786         : '*'                    { sL1 $1 $ HsTyVar (nameRdrName liftedTypeKindTyConName) }
1787         | '(' kind ')'           {% ams (sLL $1 $>  $ HsParTy $2)
1788                                         [mop $1,mcp $3] }
1789         | pkind                  { $1 }
1790         | tyvar                  { sL1 $1 $ HsTyVar (unLoc $1) }
1791
1792 pkind :: { LHsKind RdrName }  -- promoted type, see Note [Promotion]
1793         : qtycon                          { sL1 $1 $ HsTyVar $ unLoc $1 }
1794         | '(' ')'                   {% ams (sLL $1 $> $ HsTyVar $ getRdrName unitTyCon)
1795                                            [mop $1,mcp $2] }
1796         | '(' kind ',' comma_kinds1 ')'
1797                           {% addAnnotation (gl $2) AnnComma (gl $3) >>
1798                              ams (sLL $1 $> $ HsTupleTy HsBoxedTuple ( $2 : $4))
1799                                  [mop $1,mcp $5] }
1800         | '[' kind ']'                    {% ams (sLL $1 $> $ HsListTy $2)
1801                                                  [mos $1,mcs $3] }
1802
1803 comma_kinds1 :: { [LHsKind RdrName] }
1804         : kind                         { [$1] }
1805         | kind  ',' comma_kinds1       {% addAnnotation (gl $1) AnnComma (gl $2)
1806                                           >> return ($1 : $3) }
1807
1808 {- Note [Promotion]
1809    ~~~~~~~~~~~~~~~~
1810
1811 - Syntax of promoted qualified names
1812 We write 'Nat.Zero instead of Nat.'Zero when dealing with qualified
1813 names. Moreover ticks are only allowed in types, not in kinds, for a
1814 few reasons:
1815   1. we don't need quotes since we cannot define names in kinds
1816   2. if one day we merge types and kinds, tick would mean look in DataName
1817   3. we don't have a kind namespace anyway
1818
1819 - Syntax of explicit kind polymorphism  (IA0_TODO: not yet implemented)
1820 Kind abstraction is implicit. We write
1821 > data SList (s :: k -> *) (as :: [k]) where ...
1822 because it looks like what we do in terms
1823 > id (x :: a) = x
1824
1825 - Name resolution
1826 When the user write Zero instead of 'Zero in types, we parse it a
1827 HsTyVar ("Zero", TcClsName) instead of HsTyVar ("Zero", DataName). We
1828 deal with this in the renamer. If a HsTyVar ("Zero", TcClsName) is not
1829 bounded in the type level, then we look for it in the term level (we
1830 change its namespace to DataName, see Note [Demotion] in OccName). And
1831 both become a HsTyVar ("Zero", DataName) after the renamer.
1832
1833 -}
1834
1835
1836 -----------------------------------------------------------------------------
1837 -- Datatype declarations
1838
1839 gadt_constrlist :: { Located ([AddAnn]
1840                           ,[LConDecl RdrName]) } -- Returned in order
1841         : 'where' '{'        gadt_constrs '}'   { L (comb2 $1 $3)
1842                                                     ([mj AnnWhere $1
1843                                                      ,moc $2
1844                                                      ,mcc $4]
1845                                                     , unLoc $3) }
1846         | 'where' vocurly    gadt_constrs close  { L (comb2 $1 $3)
1847                                                      ([mj AnnWhere $1]
1848                                                      , unLoc $3) }
1849         | {- empty -}                            { noLoc ([],[]) }
1850
1851 gadt_constrs :: { Located [LConDecl RdrName] }
1852         : gadt_constr ';' gadt_constrs
1853                   {% addAnnotation (gl $1) AnnSemi (gl $2)
1854                      >> return (L (comb2 $1 $3) ($1 : unLoc $3)) }
1855         | gadt_constr                   { L (gl $1) [$1] }
1856         | {- empty -}                   { noLoc [] }
1857
1858 -- We allow the following forms:
1859 --      C :: Eq a => a -> T a
1860 --      C :: forall a. Eq a => !a -> T a
1861 --      D { x,y :: a } :: T a
1862 --      forall a. Eq a => D { x,y :: a } :: T a
1863
1864 gadt_constr :: { LConDecl RdrName }
1865                    -- Returns a list because of:   C,D :: ty
1866         : con_list '::' sigtype
1867                 {% do { (anns,gadtDecl) <- mkGadtDecl (unLoc $1) $3
1868                       ; ams (sLL $1 $> $ gadtDecl)
1869                             (mj AnnDcolon $2:anns) } }
1870
1871                 -- Deprecated syntax for GADT record declarations
1872         | oqtycon '{' fielddecls '}' '::' sigtype
1873                 {% do { cd <- mkDeprecatedGadtRecordDecl (comb2 $1 $6) $1 (noLoc $3) $6
1874                       ; cd' <- checkRecordSyntax cd
1875                       ; ams (L (comb2 $1 $6) (unLoc cd'))
1876                             [moc $2,mcc $4,mj AnnDcolon $5] } }
1877
1878 constrs :: { Located ([AddAnn],[LConDecl RdrName]) }
1879         : maybe_docnext '=' constrs1    { L (comb2 $2 $3) ([mj AnnEqual $2]
1880                                                      ,addConDocs (unLoc $3) $1)}
1881
1882 constrs1 :: { Located [LConDecl RdrName] }
1883         : constrs1 maybe_docnext '|' maybe_docprev constr
1884             {% addAnnotation (gl $ head $ unLoc $1) AnnVbar (gl $3)
1885                >> return (sLL $1 $> (addConDoc $5 $2 : addConDocFirst (unLoc $1) $4)) }
1886         | constr                                          { sL1 $1 [$1] }
1887
1888 constr :: { LConDecl RdrName }
1889         : maybe_docnext forall context '=>' constr_stuff maybe_docprev
1890                 {% ams (let (con,details) = unLoc $5 in
1891                   addConDoc (L (comb4 $2 $3 $4 $5) (mkSimpleConDecl con
1892                                                    (snd $ unLoc $2) $3 details))
1893                             ($1 `mplus` $6))
1894                         (mj AnnDarrow $4:(fst $ unLoc $2)) }
1895         | maybe_docnext forall constr_stuff maybe_docprev
1896                 {% ams ( let (con,details) = unLoc $3 in
1897                   addConDoc (L (comb2 $2 $3) (mkSimpleConDecl con
1898                                            (snd $ unLoc $2) (noLoc []) details))
1899                             ($1 `mplus` $4))
1900                        (fst $ unLoc $2) }
1901
1902 forall :: { Located ([AddAnn],[LHsTyVarBndr RdrName]) }
1903         : 'forall' tv_bndrs '.'       { sLL $1 $> ([mj AnnForall $1,mj AnnDot $3],$2) }
1904         | {- empty -}                 { noLoc ([],[]) }
1905
1906 constr_stuff :: { Located (Located RdrName, HsConDeclDetails RdrName) }
1907 -- We parse the constructor declaration
1908 --      C t1 t2
1909 -- as a btype (treating C as a type constructor) and then convert C to be
1910 -- a data constructor.  Reason: it might continue like this:
1911 --      C t1 t2 %: D Int
1912 -- in which case C really would be a type constructor.  We can't resolve this
1913 -- ambiguity till we come across the constructor oprerator :% (or not, more usually)
1914         : btype                         {% splitCon $1 >>= return.sLL $1 $> }
1915         | btype conop btype             {  sLL $1 $> ($2, InfixCon $1 $3) }
1916
1917 fielddecls :: { [LConDeclField RdrName] }
1918         : {- empty -}     { [] }
1919         | fielddecls1     { $1 }
1920
1921 fielddecls1 :: { [LConDeclField RdrName] }
1922         : fielddecl maybe_docnext ',' maybe_docprev fielddecls1
1923             {% addAnnotation (gl $1) AnnComma (gl $3) >>
1924                return ((addFieldDoc $1 $4) : addFieldDocs $5 $2) }
1925         | fielddecl   { [$1] }
1926
1927 fielddecl :: { LConDeclField RdrName }
1928                                               -- A list because of   f,g :: Int
1929         : maybe_docnext sig_vars '::' ctype maybe_docprev
1930             {% ams (L (comb2 $2 $4)
1931                       (ConDeclField (reverse (unLoc $2)) $4 ($1 `mplus` $5)))
1932                    [mj AnnDcolon $3] }
1933
1934 -- We allow the odd-looking 'inst_type' in a deriving clause, so that
1935 -- we can do deriving( forall a. C [a] ) in a newtype (GHC extension).
1936 -- The 'C [a]' part is converted to an HsPredTy by checkInstType
1937 -- We don't allow a context, but that's sorted out by the type checker.
1938 deriving :: { Located (Maybe (Located [LHsType RdrName])) }
1939         : {- empty -}             { noLoc Nothing }
1940         | 'deriving' qtycon       {% aljs ( let { L loc tv = $2 }
1941                                             in (sLL $1 $> (Just (sLL $1 $>
1942                                                        [L loc (HsTyVar tv)]))))
1943                                           [mj AnnDeriving $1] }
1944         | 'deriving' '(' ')'      {% aljs (sLL $1 $> (Just (sLL $1 $> [])))
1945                                           [mj AnnDeriving $1,mop $2,mcp $3] }
1946
1947         | 'deriving' '(' inst_types1 ')'  {% aljs (sLL $1 $> (Just (sLL $1 $> $3)))
1948                                                  [mj AnnDeriving $1,mop $2,mcp $4] }
1949              -- Glasgow extension: allow partial
1950              -- applications in derivings
1951
1952 -----------------------------------------------------------------------------
1953 -- Value definitions
1954
1955 {- Note [Declaration/signature overlap]
1956 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1957 There's an awkward overlap with a type signature.  Consider
1958         f :: Int -> Int = ...rhs...
1959    Then we can't tell whether it's a type signature or a value
1960    definition with a result signature until we see the '='.
1961    So we have to inline enough to postpone reductions until we know.
1962 -}
1963
1964 {-
1965   ATTENTION: Dirty Hackery Ahead! If the second alternative of vars is var
1966   instead of qvar, we get another shift/reduce-conflict. Consider the
1967   following programs:
1968
1969      { (^^) :: Int->Int ; }          Type signature; only var allowed
1970
1971      { (^^) :: Int->Int = ... ; }    Value defn with result signature;
1972                                      qvar allowed (because of instance decls)
1973
1974   We can't tell whether to reduce var to qvar until after we've read the signatures.
1975 -}
1976
1977 docdecl :: { LHsDecl RdrName }
1978         : docdecld { sL1 $1 (DocD (unLoc $1)) }
1979
1980 docdecld :: { LDocDecl }
1981         : docnext                               { sL1 $1 (DocCommentNext (unLoc $1)) }
1982         | docprev                               { sL1 $1 (DocCommentPrev (unLoc $1)) }
1983         | docnamed                              { sL1 $1 (case (unLoc $1) of (n, doc) -> DocCommentNamed n doc) }
1984         | docsection                            { sL1 $1 (case (unLoc $1) of (n, doc) -> DocGroup n doc) }
1985
1986 decl_no_th :: { Located (OrdList (LHsDecl RdrName)) }
1987         : sigdecl               { $1 }
1988
1989         | '!' aexp rhs          {% do { let { e = sLL $1 $2 (SectionR (sL1 $1 (HsVar bang_RDR)) $2) };
1990                                         pat <- checkPattern empty e;
1991                                         _ <- ams (sLL $1 $> ())
1992                                                (fst $ unLoc $3);
1993                                         return $ sLL $1 $> $ unitOL $ sLL $1 $> $ ValD $
1994                                             PatBind pat (snd $ unLoc $3)
1995                                                     placeHolderType
1996                                                     placeHolderNames
1997                                                     ([],[]) } }
1998                                 -- Turn it all into an expression so that
1999                                 -- checkPattern can check that bangs are enabled
2000
2001         | infixexp opt_sig rhs  {% do { (ann,r) <- checkValDef empty $1 (snd $2) $3;
2002                                         let { l = comb2 $1 $> };
2003                                         case r of {
2004                                           (FunBind n _ _ _ _ _) ->
2005                                                 ams (L l ()) (mj AnnFunId n:(fst $2)) >> return () ;
2006                                           (PatBind (L lh _lhs) _rhs _ _ _) ->
2007                                                 ams (L lh ()) (fst $2) >> return () } ;
2008                                         _ <- ams (L l ()) (ann ++ (fst $ unLoc $3));
2009                                         return $! (sL l (unitOL $! (sL l $ ValD r))) } }
2010         | pattern_synonym_decl  { sLL $1 $> $ unitOL $1 }
2011         | docdecl               { sLL $1 $> $ unitOL $1 }
2012
2013 decl    :: { Located (OrdList (LHsDecl RdrName)) }
2014         : decl_no_th            { $1 }
2015
2016         -- Why do we only allow naked declaration splices in top-level
2017         -- declarations and not here? Short answer: because readFail009
2018         -- fails terribly with a panic in cvBindsAndSigs otherwise.
2019         | splice_exp            { sLL $1 $> $ unitOL (sLL $1 $> $ mkSpliceDecl $1) }
2020
2021 rhs     :: { Located ([AddAnn],GRHSs RdrName (LHsExpr RdrName)) }
2022         : '=' exp wherebinds    { sL (comb3 $1 $2 $3)
2023                                     ((mj AnnEqual $1 : (fst $ unLoc $3))
2024                                     ,GRHSs (unguardedRHS (comb3 $1 $2 $3) $2)
2025                                    (snd $ unLoc $3)) }
2026         | gdrhs wherebinds      { sLL $1 $>  (fst $ unLoc $2
2027                                     ,GRHSs (reverse (unLoc $1))
2028                                                     (snd $ unLoc $2)) }
2029
2030 gdrhs :: { Located [LGRHS RdrName (LHsExpr RdrName)] }
2031         : gdrhs gdrh            { sLL $1 $> ($2 : unLoc $1) }
2032         | gdrh                  { sL1 $1 [$1] }
2033
2034 gdrh :: { LGRHS RdrName (LHsExpr RdrName) }
2035         : '|' guardquals '=' exp  {% ams (sL (comb2 $1 $>) $ GRHS (unLoc $2) $4)
2036                                          [mj AnnVbar $1,mj AnnEqual $3] }
2037
2038 sigdecl :: { Located (OrdList (LHsDecl RdrName)) }
2039         :
2040         -- See Note [Declaration/signature overlap] for why we need infixexp here
2041           infixexp '::' sigtypedoc
2042                         {% do ty <- checkPartialTypeSignature $3
2043                         ; s <- checkValSig $1 ty
2044                         ; _ <- ams (sLL $1 $> ()) [mj AnnDcolon $2]
2045                         ; return (sLL $1 $> $ unitOL (sLL $1 $> $ SigD s)) }
2046
2047         | var ',' sig_vars '::' sigtypedoc
2048            {% do { ty <- checkPartialTypeSignature $5
2049                  ; let sig = TypeSig ($1 : reverse (unLoc $3)) ty PlaceHolder
2050                  ; addAnnotation (gl $1) AnnComma (gl $2)
2051                  ; ams (sLL $1 $> $ toOL [ sLL $1 $> $ SigD sig ])
2052                        [mj AnnDcolon $4] } }
2053
2054         | infix prec ops
2055               {% ams (sLL $1 $> $ toOL [ sLL $1 $> $ SigD
2056                         (FixSig (FixitySig (fromOL $ unLoc $3)
2057                                 (Fixity (unLoc $2) (unLoc $1)))) ])
2058                      [mj AnnInfix $1,mj AnnVal $2] }
2059
2060         | pattern_synonym_sig   { sLL $1 $> $ unitOL $ sLL $1 $> . SigD . unLoc $ $1 }
2061
2062         | '{-# INLINE' activation qvar '#-}'
2063                 {% ams (sLL $1 $> $ unitOL (sLL $1 $> $ SigD (InlineSig $3
2064                             (mkInlinePragma (getINLINE_PRAGs $1) (getINLINE $1)
2065                                             (snd $2)))))
2066                        ((mo $1:fst $2) ++ [mc $4]) }
2067
2068         | '{-# SPECIALISE' activation qvar '::' sigtypes1 '#-}'
2069              {% ams (
2070                  let inl_prag = mkInlinePragma (getSPEC_PRAGs $1)
2071                                              (EmptyInlineSpec, FunLike) (snd $2)
2072                   in sLL $1 $> $
2073                             toOL [ sLL $1 $> $ SigD (SpecSig $3 (fromOL $5) inl_prag) ])
2074                     (mo $1:mj AnnDcolon $4:mc $6:(fst $2)) }
2075
2076         | '{-# SPECIALISE_INLINE' activation qvar '::' sigtypes1 '#-}'
2077              {% ams (sLL $1 $> $ toOL [ sLL $1 $> $ SigD (SpecSig $3 (fromOL $5)
2078                                (mkInlinePragma (getSPEC_INLINE_PRAGs $1)
2079                                                (getSPEC_INLINE $1) (snd $2))) ])
2080                        (mo $1:mj AnnDcolon $4:mc $6:(fst $2)) }
2081
2082         | '{-# SPECIALISE' 'instance' inst_type '#-}'
2083                 {% ams (sLL $1 $> $ unitOL (sLL $1 $>
2084                                   $ SigD (SpecInstSig (getSPEC_PRAGs $1) $3)))
2085                        [mo $1,mj AnnInstance $2,mc $4] }
2086
2087         -- AZ TODO: Do we need locations in the name_formula_opt?
2088         -- A minimal complete definition
2089         | '{-# MINIMAL' name_boolformula_opt '#-}'
2090             {% ams (sLL $1 $> $ unitOL (sLL $1 $> $ SigD (MinimalSig (getMINIMAL_PRAGs $1) (snd $2))))
2091                    (mo $1:mc $3:fst $2) }
2092
2093 activation :: { ([AddAnn],Maybe Activation) }
2094         : {- empty -}                           { ([],Nothing) }
2095         | explicit_activation                   { (fst $1,Just (snd $1)) }
2096
2097 explicit_activation :: { ([AddAnn],Activation) }  -- In brackets
2098         : '[' INTEGER ']'       { ([mj AnnOpenS $1,mj AnnVal $2,mj AnnCloseS $3]
2099                                   ,ActiveAfter  (fromInteger (getINTEGER $2))) }
2100         | '[' '~' INTEGER ']'   { ([mj AnnOpenS $1,mj AnnTilde $2,mj AnnVal $3
2101                                                  ,mj AnnCloseS $4]
2102                                   ,ActiveBefore (fromInteger (getINTEGER $3))) }
2103
2104 -----------------------------------------------------------------------------
2105 -- Expressions
2106
2107 quasiquote :: { Located (HsSplice RdrName) }
2108         : TH_QUASIQUOTE   { let { loc = getLoc $1
2109                                 ; ITquasiQuote (quoter, quote, quoteSpan) = unLoc $1
2110                                 ; quoterId = mkUnqual varName quoter }
2111                             in sL1 $1 (mkHsQuasiQuote quoterId (RealSrcSpan quoteSpan) quote) }
2112         | TH_QQUASIQUOTE  { let { loc = getLoc $1
2113                                 ; ITqQuasiQuote (qual, quoter, quote, quoteSpan) = unLoc $1
2114                                 ; quoterId = mkQual varName (qual, quoter) }
2115                             in sL (getLoc $1) (mkHsQuasiQuote quoterId (RealSrcSpan quoteSpan) quote) }
2116
2117 exp   :: { LHsExpr RdrName }
2118         : infixexp '::' sigtype {% ams (sLL $1 $> $ ExprWithTySig $1 $3 PlaceHolder)
2119                                        [mj AnnDcolon $2] }
2120         | infixexp '-<' exp     {% ams (sLL $1 $> $ HsArrApp $1 $3 placeHolderType
2121                                                         HsFirstOrderApp True)
2122                                        [mj Annlarrowtail $2] }
2123         | infixexp '>-' exp     {% ams (sLL $1 $> $ HsArrApp $3 $1 placeHolderType
2124                                                       HsFirstOrderApp False)
2125                                        [mj Annrarrowtail $2] }
2126         | infixexp '-<<' exp    {% ams (sLL $1 $> $ HsArrApp $1 $3 placeHolderType
2127                                                       HsHigherOrderApp True)
2128                                        [mj AnnLarrowtail $2] }
2129         | infixexp '>>-' exp    {% ams (sLL $1 $> $ HsArrApp $3 $1 placeHolderType
2130                                                       HsHigherOrderApp False)
2131                                        [mj AnnRarrowtail $2] }
2132         | infixexp              { $1 }
2133
2134 infixexp :: { LHsExpr RdrName }
2135         : exp10                   { $1 }
2136         | infixexp qop exp10      {% ams (sLL $1 $>
2137                                              (OpApp $1 $2 placeHolderFixity $3))
2138                                          [mj AnnVal $2] }
2139                  -- AnnVal annotation for NPlusKPat, which discards the operator
2140
2141
2142 exp10 :: { LHsExpr RdrName }
2143         : '\\' apat apats opt_asig '->' exp
2144                    {% ams (sLL $1 $> $ HsLam (mkMatchGroup FromSource
2145                             [sLL $1 $> $ Match Nothing ($2:$3) (snd $4) (unguardedGRHSs $6)]))
2146                           (mj AnnLam $1:mj AnnRarrow $5:(fst $4)) }
2147         | 'let' binds 'in' exp          {% ams (sLL $1 $> $ HsLet (snd $ unLoc $2) $4)
2148                                                (mj AnnLet $1:mj AnnIn $3
2149                                                  :(fst $ unLoc $2)) }
2150         | '\\' 'lcase' altslist
2151             {% ams (sLL $1 $> $ HsLamCase placeHolderType
2152                                    (mkMatchGroup FromSource (snd $ unLoc $3)))
2153                    (mj AnnLam $1:mj AnnCase $2:(fst $ unLoc $3)) }
2154         | 'if' exp optSemi 'then' exp optSemi 'else' exp
2155                            {% checkDoAndIfThenElse $2 (snd $3) $5 (snd $6) $8 >>
2156                               ams (sLL $1 $> $ mkHsIf $2 $5 $8)
2157                                   (mj AnnIf $1:mj AnnThen $4
2158                                      :mj AnnElse $7
2159                                      :(map (\l -> mj AnnSemi l) (fst $3))
2160                                     ++(map (\l -> mj AnnSemi l) (fst $6))) }
2161         | 'if' ifgdpats                 {% hintMultiWayIf (getLoc $1) >>
2162                                            ams (sLL $1 $> $ HsMultiIf
2163                                                      placeHolderType
2164                                                      (reverse $ snd $ unLoc $2))
2165                                                (mj AnnIf $1:(fst $ unLoc $2)) }
2166         | 'case' exp 'of' altslist      {% ams (sLL $1 $> $ HsCase $2 (mkMatchGroup
2167                                                    FromSource (snd $ unLoc $4)))
2168                                                (mj AnnCase $1:mj AnnOf $3
2169                                                   :(fst $ unLoc $4)) }
2170         | '-' fexp                      {% ams (sLL $1 $> $ NegApp $2 noSyntaxExpr)
2171                                                [mj AnnMinus $1] }
2172
2173         | 'do' stmtlist              {% ams (L (comb2 $1 $2)
2174                                                (mkHsDo DoExpr (snd $ unLoc $2)))
2175                                                (mj AnnDo $1:(fst $ unLoc $2)) }
2176         | 'mdo' stmtlist            {% ams (L (comb2 $1 $2)
2177                                               (mkHsDo MDoExpr (snd $ unLoc $2)))
2178                                            (mj AnnMdo $1:(fst $ unLoc $2)) }
2179
2180         | scc_annot exp        {% ams (sLL $1 $> $ HsSCC (snd $ fst $ unLoc $1) (snd $ unLoc $1) $2)
2181                                       (fst $ fst $ unLoc $1) }
2182
2183         | hpc_annot exp        {% ams (sLL $1 $> $ HsTickPragma (snd $ fst $ unLoc $1) (snd $ unLoc $1) $2)
2184                                       (fst $ fst $ unLoc $1) }
2185
2186         | 'proc' aexp '->' exp
2187                        {% checkPattern empty $2 >>= \ p ->
2188                            checkCommand $4 >>= \ cmd ->
2189                            ams (sLL $1 $> $ HsProc p (sLL $1 $> $ HsCmdTop cmd placeHolderType
2190                                                 placeHolderType []))
2191                                             -- TODO: is LL right here?
2192                                [mj AnnProc $1,mj AnnRarrow $3] }
2193
2194         | '{-# CORE' STRING '#-}' exp  {% ams (sLL $1 $> $ HsCoreAnn (getCORE_PRAGs $1) (getSTRING $2) $4)
2195                                               [mo $1,mj AnnVal $2
2196                                               ,mc $3] }
2197                                           -- hdaume: core annotation
2198         | fexp                         { $1 }
2199
2200         -- parsing error messages go below here
2201         | '\\' apat apats opt_asig '->' error        {% parseErrorSDoc (combineLocs $1 $5) $ text
2202                                                         "parse error in lambda: no expression after '->'"
2203                                                      }
2204         | '\\' error                                 {% parseErrorSDoc (getLoc $1) $ text
2205                                                         "parse error: naked lambda expression '\'"
2206                                                      }
2207         | 'let' binds 'in' error                     {% parseErrorSDoc (combineLocs $1 $2) $ text
2208                                                         "parse error in let binding: missing expression after 'in'"
2209                                                      }
2210         | 'let' binds error                          {% parseErrorSDoc (combineLocs $1 $2) $ text
2211                                                         "parse error in let binding: missing required 'in'"
2212                                                      }
2213         | 'let' error                                {% parseErrorSDoc (getLoc $1) $ text
2214                                                         "parse error: naked let binding"
2215                                                      }
2216         | 'if' exp optSemi 'then' exp optSemi
2217           'else' error                               {% hintIf (combineLocs $1 $5) "else clause empty" }
2218         | 'if' exp optSemi 'then' exp optSemi error  {% hintIf (combineLocs $1 $5) "missing required else clause" }
2219         | 'if' exp optSemi 'then' error              {% hintIf (combineLocs $1 $2) "then clause empty" }
2220         | 'if' exp optSemi error                     {% hintIf (combineLocs $1 $2) "missing required then and else clauses" }
2221         | 'if' error                                 {% hintIf (getLoc $1) "naked if statement" }
2222         | 'case' exp 'of' error                      {% parseErrorSDoc (combineLocs $1 $2) $ text
2223                                                         "parse error in case statement: missing list after '->'"
2224                                                      }
2225         | 'case' exp error                           {% parseErrorSDoc (combineLocs $1 $2) $ text
2226                                                         "parse error in case statement: missing required 'of'"
2227                                                      }
2228         | 'case' error                               {% parseErrorSDoc (getLoc $1) $ text
2229                                                         "parse error: naked case statement"
2230                                                      }
2231 optSemi :: { ([Located a],Bool) }
2232         : ';'         { ([$1],True) }
2233         | {- empty -} { ([],False) }
2234
2235 scc_annot :: { Located (([AddAnn],SourceText),FastString) }
2236         : '{-# SCC' STRING '#-}'      {% do scc <- getSCC $2
2237                                             ; return $ sLL $1 $>
2238                                                (([mo $1,mj AnnValStr $2
2239                                                 ,mc $3],getSCC_PRAGs $1),scc) }
2240         | '{-# SCC' VARID  '#-}'      { sLL $1 $> (([mo $1,mj AnnVal $2
2241                                          ,mc $3],getSCC_PRAGs $1)
2242                                         ,(getVARID $2)) }
2243
2244 hpc_annot :: { Located (([AddAnn],SourceText),(FastString,(Int,Int),(Int,Int))) }
2245       : '{-# GENERATED' STRING INTEGER ':' INTEGER '-' INTEGER ':' INTEGER '#-}'
2246                                       { sLL $1 $> $ (([mo $1,mj AnnVal $2
2247                                               ,mj AnnVal $3,mj AnnColon $4
2248                                               ,mj AnnVal $5,mj AnnMinus $6
2249                                               ,mj AnnVal $7,mj AnnColon $8
2250                                               ,mj AnnVal $9,mc $10],
2251                                                 getGENERATED_PRAGs $1)
2252                                               ,(getSTRING $2
2253                                                ,( fromInteger $ getINTEGER $3
2254                                                 , fromInteger $ getINTEGER $5
2255                                                 )
2256                                                ,( fromInteger $ getINTEGER $7
2257                                                 , fromInteger $ getINTEGER $9
2258                                                 )
2259                                                ))
2260                                          }
2261
2262 fexp    :: { LHsExpr RdrName }
2263         : fexp aexp                             { sLL $1 $> $ HsApp $1 $2 }
2264         | 'static' aexp                         {% ams (sLL $1 $> $ HsStatic $2)
2265                                                        [mj AnnStatic $1] }
2266         | aexp                                  { $1 }
2267
2268 aexp    :: { LHsExpr RdrName }
2269         : qvar '@' aexp         {% ams (sLL $1 $> $ EAsPat $1 $3) [mj AnnAt $2] }
2270         | '~' aexp              {% ams (sLL $1 $> $ ELazyPat $2) [mj AnnTilde $1] }
2271         | aexp1                 { $1 }
2272
2273 aexp1   :: { LHsExpr RdrName }
2274         : aexp1 '{' fbinds '}' {% do { r <- mkRecConstrOrUpdate $1 (comb2 $2 $4)
2275                                                                    (snd $3)
2276                                      ; _ <- ams (sLL $1 $> ()) (moc $2:mcc $4:(fst $3))
2277                                      ; checkRecordSyntax (sLL $1 $> r) }}
2278         | aexp2                { $1 }
2279
2280 aexp2   :: { LHsExpr RdrName }
2281         : qvar                          { sL1 $1 (HsVar   $! unLoc $1) }
2282         | qcon                          { sL1 $1 (HsVar   $! unLoc $1) }
2283         | ipvar                         { sL1 $1 (HsIPVar $! unLoc $1) }
2284         | literal                       { sL1 $1 (HsLit   $! unLoc $1) }
2285 -- This will enable overloaded strings permanently.  Normally the renamer turns HsString
2286 -- into HsOverLit when -foverloaded-strings is on.
2287 --      | STRING    { sL (getLoc $1) (HsOverLit $! mkHsIsString (getSTRINGs $1)
2288 --                                       (getSTRING $1) placeHolderType) }
2289         | INTEGER   { sL (getLoc $1) (HsOverLit $! mkHsIntegral (getINTEGERs $1)
2290                                          (getINTEGER $1) placeHolderType) }
2291         | RATIONAL  { sL (getLoc $1) (HsOverLit $! mkHsFractional
2292                                           (getRATIONAL $1) placeHolderType) }
2293
2294         -- N.B.: sections get parsed by these next two productions.
2295         -- This allows you to write, e.g., '(+ 3, 4 -)', which isn't
2296         -- correct Haskell (you'd have to write '((+ 3), (4 -))')
2297         -- but the less cluttered version fell out of having texps.
2298         | '(' texp ')'                  {% ams (sLL $1 $> (HsPar $2)) [mop $1,mcp $3] }
2299         | '(' tup_exprs ')'             {% ams (sLL $1 $> (ExplicitTuple $2 Boxed))
2300                                                [mop $1,mcp $3] }
2301
2302         | '(#' texp '#)'                {% ams (sLL $1 $> (ExplicitTuple [L (gl $2)
2303                                                          (Present $2)] Unboxed))
2304                                                [mo $1,mc $3] }
2305         | '(#' tup_exprs '#)'           {% ams (sLL $1 $> (ExplicitTuple $2 Unboxed))
2306                                                [mo $1,mc $3] }
2307
2308         | '[' list ']'      {% ams (sLL $1 $> (snd $2)) (mos $1:mcs $3:(fst $2)) }
2309         | '[:' parr ':]'    {% ams (sLL $1 $> (snd $2)) (mo $1:mc $3:(fst $2)) }
2310         | '_'               { sL1 $1 EWildPat }
2311
2312         -- Template Haskell Extension
2313         | splice_exp            { $1 }
2314
2315         | SIMPLEQUOTE  qvar     {% ams (sLL $1 $> $ HsBracket (VarBr True  (unLoc $2))) [mj AnnSimpleQuote $1,mj AnnName $2] }
2316         | SIMPLEQUOTE  qcon     {% ams (sLL $1 $> $ HsBracket (VarBr True  (unLoc $2))) [mj AnnSimpleQuote $1,mj AnnName $2] }
2317         | TH_TY_QUOTE tyvar     {% ams (sLL $1 $> $ HsBracket (VarBr False (unLoc $2))) [mj AnnThTyQuote $1,mj AnnName $2] }
2318         | TH_TY_QUOTE gtycon    {% ams (sLL $1 $> $ HsBracket (VarBr False (unLoc $2))) [mj AnnThTyQuote $1,mj AnnName $2] }
2319         | '[|' exp '|]'       {% ams (sLL $1 $> $ HsBracket (ExpBr $2)) [mo $1,mc $3] }
2320         | '[||' exp '||]'     {% ams (sLL $1 $> $ HsBracket (TExpBr $2)) [mo $1,mc $3]}
2321         | '[t|' ctype '|]'    {% checkNoPartialType
2322                                    (text "in type brackets" <> colon
2323                                     <+> quotes (text "[t|" <+> ppr $2 <+> text "|]")) $2 >>
2324                                  ams (sLL $1 $> $ HsBracket (TypBr $2)) [mo $1,mc $3] }
2325         | '[p|' infixexp '|]' {% checkPattern empty $2 >>= \p ->
2326                                       ams (sLL $1 $> $ HsBracket (PatBr p))
2327                                           [mo $1,mc $3] }
2328         | '[d|' cvtopbody '|]' {% ams (sLL $1 $> $ HsBracket (DecBrL (snd $2)))
2329                                       (mo $1:mc $3:fst $2) }
2330         | quasiquote          { sL1 $1 (HsSpliceE (unLoc $1)) }
2331
2332         -- arrow notation extension
2333         | '(|' aexp2 cmdargs '|)'  {% ams (sLL $1 $> $ HsArrForm $2
2334                                                            Nothing (reverse $3))
2335                                           [mo $1,mc $4] }
2336
2337 splice_exp :: { LHsExpr RdrName }
2338         : TH_ID_SPLICE          {% ams (sL1 $1 $ mkHsSpliceE
2339                                         (sL1 $1 $ HsVar (mkUnqual varName
2340                                                         (getTH_ID_SPLICE $1))))
2341                                        [mj AnnThIdSplice $1] }
2342         | '$(' exp ')'          {% ams (sLL $1 $> $ mkHsSpliceE $2)
2343                                        [mj AnnOpenPE $1,mj AnnCloseP $3] }
2344         | TH_ID_TY_SPLICE       {% ams (sL1 $1 $ mkHsSpliceTE
2345                                         (sL1 $1 $ HsVar (mkUnqual varName
2346                                                      (getTH_ID_TY_SPLICE $1))))
2347                                        [mj AnnThIdTySplice $1] }
2348         | '$$(' exp ')'         {% ams (sLL $1 $> $ mkHsSpliceTE $2)
2349                                        [mj AnnOpenPTE $1,mj AnnCloseP $3] }
2350
2351 cmdargs :: { [LHsCmdTop RdrName] }
2352         : cmdargs acmd                  { $2 : $1 }
2353         | {- empty -}                   { [] }
2354
2355 acmd    :: { LHsCmdTop RdrName }
2356         : aexp2                 {% checkCommand $1 >>= \ cmd ->
2357                                     return (sL1 $1 $ HsCmdTop cmd
2358                                            placeHolderType placeHolderType []) }
2359
2360 cvtopbody :: { ([AddAnn],[LHsDecl RdrName]) }
2361         :  '{'            cvtopdecls0 '}'      { ([mj AnnOpenC $1
2362                                                   ,mj AnnCloseC $3],$2) }
2363         |      vocurly    cvtopdecls0 close    { ([],$2) }
2364
2365 cvtopdecls0 :: { [LHsDecl RdrName] }
2366         : {- empty -}           { [] }
2367         | cvtopdecls            { $1 }
2368
2369 -----------------------------------------------------------------------------
2370 -- Tuple expressions
2371
2372 -- "texp" is short for tuple expressions:
2373 -- things that can appear unparenthesized as long as they're
2374 -- inside parens or delimitted by commas
2375 texp :: { LHsExpr RdrName }
2376         : exp                           { $1 }
2377
2378         -- Note [Parsing sections]
2379         -- ~~~~~~~~~~~~~~~~~~~~~~~
2380         -- We include left and right sections here, which isn't
2381         -- technically right according to the Haskell standard.
2382         -- For example (3 +, True) isn't legal.
2383         -- However, we want to parse bang patterns like
2384         --      (!x, !y)
2385         -- and it's convenient to do so here as a section
2386         -- Then when converting expr to pattern we unravel it again
2387         -- Meanwhile, the renamer checks that real sections appear
2388         -- inside parens.
2389         | infixexp qop        { sLL $1 $> $ SectionL $1 $2 }
2390         | qopm infixexp       { sLL $1 $> $ SectionR $1 $2 }
2391
2392        -- View patterns get parenthesized above
2393         | exp '->' texp   {% ams (sLL $1 $> $ EViewPat $1 $3) [mj AnnRarrow $2] }
2394
2395 -- Always at least one comma
2396 tup_exprs :: { [LHsTupArg RdrName] }
2397            : texp commas_tup_tail
2398                           {% do { addAnnotation (gl $1) AnnComma (fst $2)
2399                                 ; return ((sL1 $1 (Present $1)) : snd $2) } }
2400
2401            | commas tup_tail
2402                 {% do { mapM_ (\ll -> addAnnotation ll AnnComma ll) (fst $1)
2403                       ; return
2404                            (let tt = if null $2
2405                                        then [noLoc missingTupArg]
2406                                        else $2
2407                             in map (\l -> L l missingTupArg) (fst $1) ++ tt) } }
2408
2409 -- Always starts with commas; always follows an expr
2410 commas_tup_tail :: { (SrcSpan,[LHsTupArg RdrName]) }
2411 commas_tup_tail : commas tup_tail
2412        {% do { mapM_ (\ll -> addAnnotation ll AnnComma ll) (tail $ fst $1)
2413              ; return (
2414          let tt = if null $2
2415                     then [L (last $ fst $1) missingTupArg]
2416                     else $2
2417          in (head $ fst $1
2418             ,(map (\l -> L l missingTupArg) (tail $ fst $1)) ++ tt)) } }
2419
2420 -- Always follows a comma
2421 tup_tail :: { [LHsTupArg RdrName] }
2422           : texp commas_tup_tail {% addAnnotation (gl $1) AnnComma (fst $2) >>
2423                                     return ((L (gl $1) (Present $1)) : snd $2) }
2424           | texp                 { [L (gl $1) (Present $1)] }
2425           | {- empty -}          { [] {- [noLoc missingTupArg] -} }
2426
2427 -----------------------------------------------------------------------------
2428 -- List expressions
2429
2430 -- The rules below are little bit contorted to keep lexps left-recursive while
2431 -- avoiding another shift/reduce-conflict.
2432 list :: { ([AddAnn],HsExpr RdrName) }
2433         : texp    { ([],ExplicitList placeHolderType Nothing [$1]) }
2434         | lexps   { ([],ExplicitList placeHolderType Nothing
2435                                                    (reverse (unLoc $1))) }
2436         | texp '..'             { ([mj AnnDotdot $2],
2437                                       ArithSeq noPostTcExpr Nothing (From $1)) }
2438         | texp ',' exp '..'     { ([mj AnnComma $2,mj AnnDotdot $4],
2439                                   ArithSeq noPostTcExpr Nothing
2440                                                              (FromThen $1 $3)) }
2441         | texp '..' exp         { ([mj AnnDotdot $2],
2442                                    ArithSeq noPostTcExpr Nothing
2443                                                                (FromTo $1 $3)) }
2444         | texp ',' exp '..' exp { ([mj AnnComma $2,mj AnnDotdot $4],
2445                                     ArithSeq noPostTcExpr Nothing
2446                                                 (FromThenTo $1 $3 $5)) }
2447         | texp '|' flattenedpquals
2448              {% checkMonadComp >>= \ ctxt ->
2449                 return ([mj AnnVbar $2],
2450                         mkHsComp ctxt (unLoc $3) $1) }
2451
2452 lexps :: { Located [LHsExpr RdrName] }
2453         : lexps ',' texp          {% addAnnotation (gl $ head $ unLoc $1)
2454                                                             AnnComma (gl $2) >>
2455                                       return (sLL $1 $> (((:) $! $3) $! unLoc $1)) }
2456         | texp ',' texp            {% addAnnotation (gl $1) AnnComma (gl $2) >>
2457                                       return (sLL $1 $> [$3,$1]) }
2458
2459 -----------------------------------------------------------------------------
2460 -- List Comprehensions
2461
2462 flattenedpquals :: { Located [LStmt RdrName (LHsExpr RdrName)] }
2463     : pquals   { case (unLoc $1) of
2464                     [qs] -> sL1 $1 qs
2465                     -- We just had one thing in our "parallel" list so
2466                     -- we simply return that thing directly
2467
2468                     qss -> sL1 $1 [sL1 $1 $ ParStmt [ParStmtBlock qs [] noSyntaxExpr |
2469                                             qs <- qss]
2470                                             noSyntaxExpr noSyntaxExpr]
2471                     -- We actually found some actual parallel lists so
2472                     -- we wrap them into as a ParStmt
2473                 }
2474
2475 pquals :: { Located [[LStmt RdrName (LHsExpr RdrName)]] }
2476     : squals '|' pquals
2477                      {% addAnnotation (gl $ head $ unLoc $1) AnnVbar (gl $2) >>
2478                         return (sLL $1 $> (reverse (unLoc $1) : unLoc $3)) }
2479     | squals         { L (getLoc $1) [reverse (unLoc $1)] }
2480
2481 squals :: { Located [LStmt RdrName (LHsExpr RdrName)] }   -- In reverse order, because the last
2482                                         -- one can "grab" the earlier ones
2483     : squals ',' transformqual
2484              {% addAnnotation (gl $ head $ unLoc $1) AnnComma (gl $2) >>
2485                 ams (sLL $1 $> ()) (fst $ unLoc $3) >>
2486                 return (sLL $1 $> [sLL $1 $> ((snd $ unLoc $3) (reverse (unLoc $1)))]) }
2487     | squals ',' qual
2488              {% addAnnotation (gl $ head $ unLoc $1) AnnComma (gl $2) >>
2489                 return (sLL $1 $> ($3 : unLoc $1)) }
2490     | transformqual        {% ams $1 (fst $ unLoc $1) >>
2491                               return (sLL $1 $> [L (getLoc $1) ((snd $ unLoc $1) [])]) }
2492     | qual                                { sL1 $1 [$1] }
2493 --  | transformquals1 ',' '{|' pquals '|}'   { sLL $1 $> ($4 : unLoc $1) }
2494 --  | '{|' pquals '|}'                       { sL1 $1 [$2] }
2495
2496 -- It is possible to enable bracketing (associating) qualifier lists
2497 -- by uncommenting the lines with {| |} above. Due to a lack of
2498 -- consensus on the syntax, this feature is not being used until we
2499 -- get user demand.
2500
2501 transformqual :: { Located ([AddAnn],[LStmt RdrName (LHsExpr RdrName)] -> Stmt RdrName (LHsExpr RdrName)) }
2502                         -- Function is applied to a list of stmts *in order*
2503     : 'then' exp               { sLL $1 $> ([mj AnnThen $1], \ss -> (mkTransformStmt ss $2)) }
2504     | 'then' exp 'by' exp      { sLL $1 $> ([mj AnnThen $1,mj AnnBy  $3],\ss -> (mkTransformByStmt ss $2 $4)) }
2505     | 'then' 'group' 'using' exp
2506              { sLL $1 $> ([mj AnnThen $1,mj AnnGroup $2,mj AnnUsing $3], \ss -> (mkGroupUsingStmt ss $4)) }
2507
2508     | 'then' 'group' 'by' exp 'using' exp
2509              { sLL $1 $> ([mj AnnThen $1,mj AnnGroup $2,mj AnnBy $3,mj AnnUsing $5], \ss -> (mkGroupByUsingStmt ss $4 $6)) }
2510
2511 -- Note that 'group' is a special_id, which means that you can enable
2512 -- TransformListComp while still using Data.List.group. However, this
2513 -- introduces a shift/reduce conflict. Happy chooses to resolve the conflict
2514 -- in by choosing the "group by" variant, which is what we want.
2515
2516 -----------------------------------------------------------------------------
2517 -- Parallel array expressions
2518
2519 -- The rules below are little bit contorted; see the list case for details.
2520 -- Note that, in contrast to lists, we only have finite arithmetic sequences.
2521 -- Moreover, we allow explicit arrays with no element (represented by the nil
2522 -- constructor in the list case).
2523
2524 parr :: { ([AddAnn],HsExpr RdrName) }
2525         :                      { ([],ExplicitPArr placeHolderType []) }
2526         | texp                 { ([],ExplicitPArr placeHolderType [$1]) }
2527         | lexps                { ([],ExplicitPArr placeHolderType
2528                                                           (reverse (unLoc $1))) }
2529         | texp '..' exp        { ([mj AnnDotdot $2]
2530                                  ,PArrSeq noPostTcExpr (FromTo $1 $3)) }
2531         | texp ',' exp '..' exp
2532                         { ([mj AnnComma $2,mj AnnDotdot $4]
2533                           ,PArrSeq noPostTcExpr (FromThenTo $1 $3 $5)) }
2534         | texp '|' flattenedpquals
2535                         { ([mj AnnVbar $2],mkHsComp PArrComp (unLoc $3) $1) }
2536
2537 -- We are reusing `lexps' and `flattenedpquals' from the list case.
2538
2539 -----------------------------------------------------------------------------
2540 -- Guards
2541
2542 guardquals :: { Located [LStmt RdrName (LHsExpr RdrName)] }
2543     : guardquals1           { L (getLoc $1) (reverse (unLoc $1)) }
2544
2545 guardquals1 :: { Located [LStmt RdrName (LHsExpr RdrName)] }
2546     : guardquals1 ',' qual  {% addAnnotation (gl $ head $ unLoc $1) AnnComma
2547                                              (gl $2) >>
2548                                return (sLL $1 $> ($3 : unLoc $1)) }
2549     | qual                  { sL1 $1 [$1] }
2550
2551 -----------------------------------------------------------------------------
2552 -- Case alternatives
2553
2554 altslist :: { Located ([AddAnn],[LMatch RdrName (LHsExpr RdrName)]) }
2555         : '{'            alts '}'  { sLL $1 $> ((moc $1:mcc $3:(fst $ unLoc $2))
2556                                                ,(reverse (snd $ unLoc $2))) }
2557         |     vocurly    alts  close { L (getLoc $2) (fst $ unLoc $2
2558                                         ,(reverse (snd $ unLoc $2))) }
2559         | '{'                 '}'    { noLoc ([moc $1,mcc $2],[]) }
2560         |     vocurly          close { noLoc ([],[]) }
2561
2562 alts    :: { Located ([AddAnn],[LMatch RdrName (LHsExpr RdrName)]) }
2563         : alts1                    { sL1 $1 (fst $ unLoc $1,snd $ unLoc $1) }
2564         | ';' alts                 { sLL $1 $> ((mj AnnSemi $1:(fst $ unLoc $2))
2565                                                ,snd $ unLoc $2) }
2566
2567 alts1   :: { Located ([AddAnn],[LMatch RdrName (LHsExpr RdrName)]) }
2568         : alts1 ';' alt         {% if null (snd $ unLoc $1)
2569                                      then return (sLL $1 $> (mj AnnSemi $2:(fst $ unLoc $1)
2570                                                   ,[$3]))
2571                                      else (ams (head $ snd $ unLoc $1)
2572                                                (mj AnnSemi $2:(fst $ unLoc $1))
2573                                            >> return (sLL $1 $> ([],$3 : (snd $ unLoc $1))) ) }
2574         | alts1 ';'             {% if null (snd $ unLoc $1)
2575                                      then return (sLL $1 $> (mj AnnSemi $2:(fst $ unLoc $1)
2576                                                   ,snd $ unLoc $1))
2577                                      else (ams (head $ snd $ unLoc $1)
2578                                                (mj AnnSemi $2:(fst $ unLoc $1))
2579                                            >> return (sLL $1 $> ([],snd $ unLoc $1))) }
2580         | alt                   { sL1 $1 ([],[$1]) }
2581
2582 alt     :: { LMatch RdrName (LHsExpr RdrName) }
2583         : pat opt_sig alt_rhs      {%ams (sLL $1 $> (Match Nothing [$1] (snd $2)
2584                                                               (snd $ unLoc $3)))
2585                                          ((fst $2) ++ (fst $ unLoc $3))}
2586
2587 alt_rhs :: { Located ([AddAnn],GRHSs RdrName (LHsExpr RdrName)) }
2588         : ralt wherebinds           { sLL $1 $> (fst $ unLoc $2,
2589                                             GRHSs (unLoc $1) (snd $ unLoc $2)) }
2590
2591 ralt :: { Located [LGRHS RdrName (LHsExpr RdrName)] }
2592         : '->' exp            {% ams (sLL $1 $> (unguardedRHS (comb2 $1 $2) $2))
2593                                      [mj AnnRarrow $1] }
2594         | gdpats              { sL1 $1 (reverse (unLoc $1)) }
2595
2596 gdpats :: { Located [LGRHS RdrName (LHsExpr RdrName)] }
2597         : gdpats gdpat                  { sLL $1 $> ($2 : unLoc $1) }
2598         | gdpat                         { sL1 $1 [$1] }
2599
2600 -- optional semi-colons between the guards of a MultiWayIf, because we use
2601 -- layout here, but we don't need (or want) the semicolon as a separator (#7783).
2602 gdpatssemi :: { Located [LGRHS RdrName (LHsExpr RdrName)] }
2603         : gdpatssemi gdpat optSemi  {% ams (sL (comb2 $1 $2) ($2 : unLoc $1))
2604                                            (map (\l -> mj AnnSemi l) $ fst $3) }
2605         | gdpat optSemi             {% ams (sL1 $1 [$1])
2606                                            (map (\l -> mj AnnSemi l) $ fst $2) }
2607
2608 -- layout for MultiWayIf doesn't begin with an open brace, because it's hard to
2609 -- generate the open brace in addition to the vertical bar in the lexer, and
2610 -- we don't need it.
2611 ifgdpats :: { Located ([AddAnn],[LGRHS RdrName (LHsExpr RdrName)]) }
2612          : '{' gdpatssemi '}'             { sLL $1 $> ([moc $1,mcc $3],unLoc $2)  }
2613          |     gdpatssemi close           { sL1 $1 ([],unLoc $1) }
2614
2615 gdpat   :: { LGRHS RdrName (LHsExpr RdrName) }
2616         : '|' guardquals '->' exp
2617                                   {% ams (sL (comb2 $1 $>) $ GRHS (unLoc $2) $4)
2618                                          [mj AnnVbar $1,mj AnnRarrow $3] }
2619
2620 -- 'pat' recognises a pattern, including one with a bang at the top
2621 --      e.g.  "!x" or "!(x,y)" or "C a b" etc
2622 -- Bangs inside are parsed as infix operator applications, so that
2623 -- we parse them right when bang-patterns are off
2624 pat     :: { LPat RdrName }
2625 pat     :  exp          {% checkPattern empty $1 }
2626         | '!' aexp      {% amms (checkPattern empty (sLL $1 $> (SectionR
2627                                                      (sL1 $1 (HsVar bang_RDR)) $2)))
2628                                 [mj AnnBang $1] }
2629
2630 bindpat :: { LPat RdrName }
2631 bindpat :  exp            {% checkPattern
2632                                 (text "Possibly caused by a missing 'do'?") $1 }
2633         | '!' aexp        {% amms (checkPattern
2634                                      (text "Possibly caused by a missing 'do'?")
2635                                      (sLL $1 $> (SectionR (sL1 $1 (HsVar bang_RDR)) $2)))
2636                                   [mj AnnBang $1] }
2637
2638 apat   :: { LPat RdrName }
2639 apat    : aexp                  {% checkPattern empty $1 }
2640         | '!' aexp              {% amms (checkPattern empty
2641                                             (sLL $1 $> (SectionR
2642                                                 (sL1 $1 (HsVar bang_RDR)) $2)))
2643                                         [mj AnnBang $1] }
2644
2645 apats  :: { [LPat RdrName] }
2646         : apat apats            { $1 : $2 }
2647         | {- empty -}           { [] }
2648
2649 -----------------------------------------------------------------------------
2650 -- Statement sequences
2651
2652 stmtlist :: { Located ([AddAnn],[LStmt RdrName (LHsExpr RdrName)]) }
2653         : '{'           stmts '}'       { sLL $1 $> ((moc $1:mcc $3:(fst $ unLoc $2))
2654                                              ,(reverse $ snd $ unLoc $2)) } -- AZ:performance of reverse?
2655         |     vocurly   stmts close     { L (gl $2) (fst $ unLoc $2
2656                                                     ,reverse $ snd $ unLoc $2) }
2657
2658 --      do { ;; s ; s ; ; s ;; }
2659 -- The last Stmt should be an expression, but that's hard to enforce
2660 -- here, because we need too much lookahead if we see do { e ; }
2661 -- So we use BodyStmts throughout, and switch the last one over
2662 -- in ParseUtils.checkDo instead
2663 -- AZ: TODO check that we can retrieve multiple semis.
2664
2665 stmts :: { Located ([AddAnn],[LStmt RdrName (LHsExpr RdrName)]) }
2666         : stmts ';' stmt  {% if null (snd $ unLoc $1)
2667                               then return (sLL $1 $> (mj AnnSemi $2:(fst $ unLoc $1)
2668                                                      ,$3 : (snd $ unLoc $1)))
2669                               else do
2670                                { ams (head $ snd $ unLoc $1) [mj AnnSemi $2]
2671                                ; return $ sLL $1 $> (fst $ unLoc $1,$3 :(snd $ unLoc $1)) }}
2672
2673         | stmts ';'     {% if null (snd $ unLoc $1)
2674                              then return (sLL $1 $> (mj AnnSemi $2:(fst $ unLoc $1),snd $ unLoc $1))
2675                              else do
2676                                { ams (head $ snd $ unLoc $1)
2677                                                [mj AnnSemi $2]
2678                                ; return $1 } }
2679         | stmt                   { sL1 $1 ([],[$1]) }
2680         | {- empty -}            { noLoc ([],[]) }
2681
2682
2683 -- For typing stmts at the GHCi prompt, where
2684 -- the input may consist of just comments.
2685 maybe_stmt :: { Maybe (LStmt RdrName (LHsExpr RdrName)) }
2686         : stmt                          { Just $1 }
2687         | {- nothing -}                 { Nothing }
2688
2689 stmt  :: { LStmt RdrName (LHsExpr RdrName) }
2690         : qual                          { $1 }
2691         | 'rec' stmtlist                {% ams (sLL $1 $> $ mkRecStmt (snd $ unLoc $2))
2692                                                (mj AnnRec $1:(fst $ unLoc $2)) }
2693
2694 qual  :: { LStmt RdrName (LHsExpr RdrName) }
2695     : bindpat '<-' exp                  {% ams (sLL $1 $> $ mkBindStmt $1 $3)
2696                                                [mj AnnLarrow $2] }
2697     | exp                               { sL1 $1 $ mkBodyStmt $1 }
2698     | 'let' binds                       {% ams (sLL $1 $>$ LetStmt (snd $ unLoc $2))
2699                                                (mj AnnLet $1:(fst $ unLoc $2)) }
2700
2701 -----------------------------------------------------------------------------
2702 -- Record Field Update/Construction
2703
2704 fbinds  :: { ([AddAnn],([LHsRecField RdrName (LHsExpr RdrName)], Bool)) }
2705         : fbinds1                       { $1 }
2706         | {- empty -}                   { ([],([], False)) }
2707
2708 fbinds1 :: { ([AddAnn],([LHsRecField RdrName (LHsExpr RdrName)], Bool)) }
2709         : fbind ',' fbinds1
2710                 {% addAnnotation (gl $1) AnnComma (gl $2) >>
2711                    return (case $3 of (ma,(flds, dd)) -> (ma,($1 : flds, dd))) }
2712         | fbind                         { ([],([$1], False)) }
2713         | '..'                          { ([mj AnnDotdot $1],([],   True)) }
2714
2715 fbind   :: { LHsRecField RdrName (LHsExpr RdrName) }
2716         : qvar '=' texp {% ams  (sLL $1 $> $ HsRecField $1 $3             False)
2717                                 [mj AnnEqual $2] }
2718                         -- RHS is a 'texp', allowing view patterns (Trac #6038)
2719                         -- and, incidentaly, sections.  Eg
2720                         -- f (R { x = show -> s }) = ...
2721
2722         | qvar          { sLL $1 $> $ HsRecField $1 placeHolderPunRhs True }
2723                         -- In the punning case, use a place-holder
2724                         -- The renamer fills in the final value
2725
2726 -----------------------------------------------------------------------------
2727 -- Implicit Parameter Bindings
2728
2729 dbinds  :: { Located [LIPBind RdrName] }
2730         : dbinds ';' dbind
2731                       {% addAnnotation (gl $ last $ unLoc $1) AnnSemi (gl $2) >>
2732                          return (let { this = $3; rest = unLoc $1 }
2733                               in rest `seq` this `seq` sLL $1 $> (this : rest)) }
2734         | dbinds ';'  {% addAnnotation (gl $ last $ unLoc $1) AnnSemi (gl $2) >>
2735                          return (sLL $1 $> (unLoc $1)) }
2736         | dbind                        { let this = $1 in this `seq` sL1 $1 [this] }
2737 --      | {- empty -}                  { [] }
2738
2739 dbind   :: { LIPBind RdrName }
2740 dbind   : ipvar '=' exp                {% ams (sLL $1 $> (IPBind (Left $1) $3))
2741                                               [mj AnnEqual $2] }
2742
2743 ipvar   :: { Located HsIPName }
2744         : IPDUPVARID            { sL1 $1 (HsIPName (getIPDUPVARID $1)) }
2745
2746 -----------------------------------------------------------------------------
2747 -- Warnings and deprecations
2748
2749 name_boolformula_opt :: { ([AddAnn],BooleanFormula (Located RdrName)) }
2750         : name_boolformula          { $1 }
2751         | {- empty -}               { ([],mkTrue) }
2752
2753 name_boolformula :: { ([AddAnn],BooleanFormula (Located RdrName)) }
2754         : name_boolformula_and                      { $1 }
2755         | name_boolformula_and '|' name_boolformula
2756                                              { ((mj AnnVbar $2:fst $1)++(fst $3)
2757                                                 ,Or [snd $1,snd $3]) }
2758
2759 name_boolformula_and :: { ([AddAnn],BooleanFormula (Located RdrName)) }
2760         : name_boolformula_atom                             { $1 }
2761         | name_boolformula_atom ',' name_boolformula_and
2762                   { ((mj AnnComma $2:fst $1)++(fst $3), And [snd $1,snd $3]) }
2763
2764 name_boolformula_atom :: { ([AddAnn],BooleanFormula (Located RdrName)) }
2765         : '(' name_boolformula ')'  { ((mop $1:mcp $3:(fst $2)),snd $2) }
2766         | name_var                  { ([],Var $1) }
2767
2768 namelist :: { Located [Located RdrName] }
2769 namelist : name_var              { sL1 $1 [$1] }
2770          | name_var ',' namelist {% addAnnotation (gl $1) AnnComma (gl $2) >>
2771                                     return (sLL $1 $> ($1 : unLoc $3)) }
2772
2773 name_var :: { Located RdrName }
2774 name_var : var { $1 }
2775          | con { $1 }
2776
2777 -----------------------------------------
2778 -- Data constructors
2779 -- There are two different productions here as lifted list constructors
2780 -- are parsed differently.
2781
2782 qcon_nowiredlist :: { Located RdrName }
2783         : gen_qcon                     { $1 }
2784         | sysdcon_nolist               { sL1 $1 $ nameRdrName (dataConName (unLoc $1)) }
2785
2786 qcon :: { Located RdrName }
2787   : gen_qcon              { $1}
2788   | sysdcon               { sL1 $1 $ nameRdrName (dataConName (unLoc $1)) }
2789
2790 gen_qcon :: { Located RdrName }
2791   : qconid                { $1 }
2792   | '(' qconsym ')'       {% ams (sLL $1 $> (unLoc $2))
2793                                    [mop $1,mj AnnVal $2,mcp $3] }
2794
2795 -- The case of '[:' ':]' is part of the production `parr'
2796
2797 con     :: { Located RdrName }
2798         : conid                 { $1 }
2799         | '(' consym ')'        {% ams (sLL $1 $> (unLoc $2))
2800                                        [mop $1,mj AnnVal $2,mcp $3] }
2801         | sysdcon               { sL1 $1 $ nameRdrName (dataConName (unLoc $1)) }
2802
2803 con_list :: { Located [Located RdrName] }
2804 con_list : con                  { sL1 $1 [$1] }
2805          | con ',' con_list     {% addAnnotation (gl $1) AnnComma (gl $2) >>
2806                                    return (sLL $1 $> ($1 : unLoc $3)) }
2807
2808 sysdcon_nolist :: { Located DataCon }  -- Wired in data constructors
2809         : '(' ')'               {% ams (sLL $1 $> unitDataCon) [mop $1,mcp $2] }
2810         | '(' commas ')'        {% ams (sLL $1 $> $ tupleDataCon Boxed (snd $2 + 1))
2811                                        (mop $1:mcp $3:(mcommas (fst $2))) }
2812         | '(#' '#)'             {% ams (sLL $1 $> $ unboxedUnitDataCon) [mo $1,mc $2] }
2813         | '(#' commas '#)'      {% ams (sLL $1 $> $ tupleDataCon Unboxed (snd $2 + 1))
2814                                        (mo $1:mc $3:(mcommas (fst $2))) }
2815
2816 sysdcon :: { Located DataCon }
2817         : sysdcon_nolist                 { $1 }
2818         | '[' ']'               {% ams (sLL $1 $> nilDataCon) [mos $1,mcs $2] }
2819
2820 conop :: { Located RdrName }
2821         : consym                { $1 }
2822         | '`' conid '`'         {% ams (sLL $1 $> (unLoc $2))
2823                                        [mj AnnBackquote $1,mj AnnVal $2
2824                                        ,mj AnnBackquote $3] }
2825
2826 qconop :: { Located RdrName }
2827         : qconsym               { $1 }
2828         | '`' qconid '`'        {% ams (sLL $1 $> (unLoc $2))
2829                                        [mj AnnBackquote $1,mj AnnVal $2
2830                                        ,mj AnnBackquote $3] }
2831
2832 ----------------------------------------------------------------------------
2833 -- Type constructors
2834
2835
2836 -- See Note [Unit tuples] in HsTypes for the distinction
2837 -- between gtycon and ntgtycon
2838 gtycon :: { Located RdrName }  -- A "general" qualified tycon, including unit tuples
2839         : ntgtycon                     { $1 }
2840         | '(' ')'                      {% ams (sLL $1 $> $ getRdrName unitTyCon)
2841                                               [mop $1,mcp $2] }
2842         | '(#' '#)'                    {% ams (sLL $1 $> $ getRdrName unboxedUnitTyCon)
2843                                               [mo $1,mc $2] }
2844
2845 ntgtycon :: { Located RdrName }  -- A "general" qualified tycon, excluding unit tuples
2846         : oqtycon               { $1 }
2847         | '(' commas ')'        {% ams (sLL $1 $> $ getRdrName (tupleTyCon Boxed
2848                                                         (snd $2 + 1)))
2849                                        (mop $1:mcp $3:(mcommas (fst $2))) }
2850         | '(#' commas '#)'      {% ams (sLL $1 $> $ getRdrName (tupleTyCon Unboxed
2851                                                         (snd $2 + 1)))
2852                                        (mo $1:mc $3:(mcommas (fst $2))) }
2853         | '(' '->' ')'          {% ams (sLL $1 $> $ getRdrName funTyCon)
2854                                        [mop $1,mj AnnRarrow $2,mcp $3] }
2855         | '[' ']'               {% ams (sLL $1 $> $ listTyCon_RDR) [mos $1,mcs $2] }
2856         | '[:' ':]'             {% ams (sLL $1 $> $ parrTyCon_RDR) [mo $1,mc $2] }
2857         | '(' '~#' ')'          {% ams (sLL $1 $> $ getRdrName eqPrimTyCon)
2858                                         [mop $1,mj AnnTildehsh $2,mcp $3] }
2859
2860 oqtycon :: { Located RdrName }  -- An "ordinary" qualified tycon;
2861                                 -- These can appear in export lists
2862         : qtycon                        { $1 }
2863         | '(' qtyconsym ')'             {% ams (sLL $1 $> (unLoc $2))
2864                                                [mop $1,mj AnnVal $2,mcp $3] }
2865         | '(' '~' ')'                   {% ams (sLL $1 $> $ eqTyCon_RDR)
2866                                                [mop $1,mj AnnTilde $2,mcp $3] }
2867
2868 qtyconop :: { Located RdrName } -- Qualified or unqualified
2869         : qtyconsym                     { $1 }
2870         | '`' qtycon '`'                {% ams (sLL $1 $> (unLoc $2))
2871                                                [mj AnnBackquote $1,mj AnnVal $2
2872                                                ,mj AnnBackquote $3] }
2873
2874 qtycon :: { Located RdrName }   -- Qualified or unqualified
2875         : QCONID            { sL1 $1 $! mkQual tcClsName (getQCONID $1) }
2876         | PREFIXQCONSYM     { sL1 $1 $! mkQual tcClsName (getPREFIXQCONSYM $1) }
2877         | tycon             { $1 }
2878
2879 tycon   :: { Located RdrName }  -- Unqualified
2880         : CONID                   { sL1 $1 $! mkUnqual tcClsName (getCONID $1) }
2881
2882 qtyconsym :: { Located RdrName }
2883         : QCONSYM            { sL1 $1 $! mkQual tcClsName (getQCONSYM $1) }
2884         | QVARSYM            { sL1 $1 $! mkQual tcClsName (getQVARSYM $1) }
2885         | tyconsym           { $1 }
2886
2887 -- Does not include "!", because that is used for strictness marks
2888 --               or ".", because that separates the quantified type vars from the rest
2889 tyconsym :: { Located RdrName }
2890         : CONSYM                { sL1 $1 $! mkUnqual tcClsName (getCONSYM $1) }
2891         | VARSYM                { sL1 $1 $! mkUnqual tcClsName (getVARSYM $1) }
2892         | ':'                   { sL1 $1 $! consDataCon_RDR }
2893         | '*'                   { sL1 $1 $! mkUnqual tcClsName (fsLit "*") }
2894         | '-'                   { sL1 $1 $! mkUnqual tcClsName (fsLit "-") }
2895
2896
2897 -----------------------------------------------------------------------------
2898 -- Operators
2899
2900 op      :: { Located RdrName }   -- used in infix decls
2901         : varop                 { $1 }
2902         | conop                 { $1 }
2903
2904 varop   :: { Located RdrName }
2905         : varsym                { $1 }
2906         | '`' varid '`'         {% ams (sLL $1 $> (unLoc $2))
2907                                        [mj AnnBackquote $1,mj AnnVal $2
2908                                        ,mj AnnBackquote $3] }
2909
2910 qop     :: { LHsExpr RdrName }   -- used in sections
2911         : qvarop                { sL1 $1 $ HsVar (unLoc $1) }
2912         | qconop                { sL1 $1 $ HsVar (unLoc $1) }
2913
2914 qopm    :: { LHsExpr RdrName }   -- used in sections
2915         : qvaropm               { sL1 $1 $ HsVar (unLoc $1) }
2916         | qconop                { sL1 $1 $ HsVar (unLoc $1) }
2917
2918 qvarop :: { Located RdrName }
2919         : qvarsym               { $1 }
2920         | '`' qvarid '`'        {% ams (sLL $1 $> (unLoc $2))
2921                                        [mj AnnBackquote $1,mj AnnVal $2
2922                                        ,mj AnnBackquote $3] }
2923
2924 qvaropm :: { Located RdrName }
2925         : qvarsym_no_minus      { $1 }
2926         | '`' qvarid '`'        {% ams (sLL $1 $> (unLoc $2))
2927                                        [mj AnnBackquote $1,mj AnnVal $2
2928                                        ,mj AnnBackquote $3] }
2929
2930 -----------------------------------------------------------------------------
2931 -- Type variables
2932
2933 tyvar   :: { Located RdrName }
2934 tyvar   : tyvarid               { $1 }
2935
2936 tyvarop :: { Located RdrName }
2937 tyvarop : '`' tyvarid '`'       {% ams (sLL $1 $> (unLoc $2))
2938                                        [mj AnnBackquote $1,mj AnnVal $2
2939                                        ,mj AnnBackquote $3] }
2940         | '.'                   {% parseErrorSDoc (getLoc $1)
2941                                       (vcat [ptext (sLit "Illegal symbol '.' in type"),
2942                                              ptext (sLit "Perhaps you intended to use RankNTypes or a similar language"),
2943                                              ptext (sLit "extension to enable explicit-forall syntax: forall <tvs>. <type>")])
2944                                 }
2945
2946 tyvarid :: { Located RdrName }
2947         : VARID            { sL1 $1 $! mkUnqual tvName (getVARID $1) }
2948         | special_id       { sL1 $1 $! mkUnqual tvName (unLoc $1) }
2949         | 'unsafe'         { sL1 $1 $! mkUnqual tvName (fsLit "unsafe") }
2950         | 'safe'           { sL1 $1 $! mkUnqual tvName (fsLit "safe") }
2951         | 'interruptible'  { sL1 $1 $! mkUnqual tvName (fsLit "interruptible") }
2952
2953 -----------------------------------------------------------------------------
2954 -- Variables
2955
2956 var     :: { Located RdrName }
2957         : varid                 { $1 }
2958         | '(' varsym ')'        {% ams (sLL $1 $> (unLoc $2))
2959                                        [mop $1,mj AnnVal $2,mcp $3] }
2960
2961 qvar    :: { Located RdrName }
2962         : qvarid                { $1 }
2963         | '(' varsym ')'        {% ams (sLL $1 $> (unLoc $2))
2964                                        [mop $1,mj AnnVal $2,mcp $3] }
2965         | '(' qvarsym1 ')'      {% ams (sLL $1 $> (unLoc $2))
2966                                        [mop $1,mj AnnVal $2,mcp $3] }
2967 -- We've inlined qvarsym here so that the decision about
2968 -- whether it's a qvar or a var can be postponed until
2969 -- *after* we see the close paren.
2970
2971 qvarid :: { Located RdrName }
2972         : varid               { $1 }
2973         | QVARID              { sL1 $1 $! mkQual varName (getQVARID $1) }
2974         | PREFIXQVARSYM       { sL1 $1 $! mkQual varName (getPREFIXQVARSYM $1) }
2975
2976 -- Note that 'role' and 'family' get lexed separately regardless of
2977 -- the use of extensions. However, because they are listed here, this
2978 -- is OK and they can be used as normal varids.
2979 varid :: { Located RdrName }
2980         : VARID            { sL1 $1 $! mkUnqual varName (getVARID $1) }
2981         | special_id       { sL1 $1 $! mkUnqual varName (unLoc $1) }
2982         | 'unsafe'         { sL1 $1 $! mkUnqual varName (fsLit "unsafe") }
2983         | 'safe'           { sL1 $1 $! mkUnqual varName (fsLit "safe") }
2984         | 'interruptible'  { sL1 $1 $! mkUnqual varName (fsLit "interruptible")}
2985         | 'forall'         { sL1 $1 $! mkUnqual varName (fsLit "forall") }
2986         | 'family'         { sL1 $1 $! mkUnqual varName (fsLit "family") }
2987         | 'role'           { sL1 $1 $! mkUnqual varName (fsLit "role") }
2988
2989 qvarsym :: { Located RdrName }
2990         : varsym                { $1 }
2991         | qvarsym1              { $1 }
2992
2993 qvarsym_no_minus :: { Located RdrName }
2994         : varsym_no_minus       { $1 }
2995         | qvarsym1              { $1 }
2996
2997 qvarsym1 :: { Located RdrName }
2998 qvarsym1 : QVARSYM              { sL1 $1 $ mkQual varName (getQVARSYM $1) }
2999
3000 varsym :: { Located RdrName }
3001         : varsym_no_minus       { $1 }
3002         | '-'                   { sL1 $1 $ mkUnqual varName (fsLit "-") }
3003
3004 varsym_no_minus :: { Located RdrName } -- varsym not including '-'
3005         : VARSYM               { sL1 $1 $ mkUnqual varName (getVARSYM $1) }
3006         | special_sym          { sL1 $1 $ mkUnqual varName (unLoc $1) }
3007
3008
3009 -- These special_ids are treated as keywords in various places,
3010 -- but as ordinary ids elsewhere.   'special_id' collects all these
3011 -- except 'unsafe', 'interruptible', 'forall', 'family', and 'role',
3012 -- whose treatment differs depending on context
3013 special_id :: { Located FastString }
3014 special_id
3015         : 'as'                  { sL1 $1 (fsLit "as") }
3016         | 'qualified'           { sL1 $1 (fsLit "qualified") }
3017         | 'hiding'              { sL1 $1 (fsLit "hiding") }
3018         | 'export'              { sL1 $1 (fsLit "export") }
3019         | 'label'               { sL1 $1 (fsLit "label")  }
3020         | 'dynamic'             { sL1 $1 (fsLit "dynamic") }
3021         | 'stdcall'             { sL1 $1 (fsLit "stdcall") }
3022         | 'ccall'               { sL1 $1 (fsLit "ccall") }
3023         | 'capi'                { sL1 $1 (fsLit "capi") }
3024         | 'prim'                { sL1 $1 (fsLit "prim") }
3025         | 'javascript'          { sL1 $1 (fsLit "javascript") }
3026         | 'group'               { sL1 $1 (fsLit "group") }
3027
3028 special_sym :: { Located FastString }
3029 special_sym : '!'       {% ams (sL1 $1 (fsLit "!")) [mj AnnBang $1] }
3030             | '.'       { sL1 $1 (fsLit ".") }
3031             | '*'       { sL1 $1 (fsLit "*") }
3032
3033 -----------------------------------------------------------------------------
3034 -- Data constructors
3035
3036 qconid :: { Located RdrName }   -- Qualified or unqualified
3037         : conid              { $1 }
3038         | QCONID             { sL1 $1 $! mkQual dataName (getQCONID $1) }
3039         | PREFIXQCONSYM      { sL1 $1 $! mkQual dataName (getPREFIXQCONSYM $1) }
3040
3041 conid   :: { Located RdrName }
3042         : CONID                { sL1 $1 $ mkUnqual dataName (getCONID $1) }
3043
3044 qconsym :: { Located RdrName }  -- Qualified or unqualified
3045         : consym               { $1 }
3046         | QCONSYM              { sL1 $1 $ mkQual dataName (getQCONSYM $1) }
3047
3048 consym :: { Located RdrName }
3049         : CONSYM              { sL1 $1 $ mkUnqual dataName (getCONSYM $1) }
3050
3051         -- ':' means only list cons
3052         | ':'                { sL1 $1 $ consDataCon_RDR }
3053
3054
3055 -----------------------------------------------------------------------------
3056 -- Literals
3057
3058 literal :: { Located HsLit }
3059         : CHAR              { sL1 $1 $ HsChar       (getCHARs $1) $ getCHAR $1 }
3060         | STRING            { sL1 $1 $ HsString     (getSTRINGs $1)
3061                                                    $ getSTRING $1 }
3062         | PRIMINTEGER       { sL1 $1 $ HsIntPrim    (getPRIMINTEGERs $1)
3063                                                    $ getPRIMINTEGER $1 }
3064         | PRIMWORD          { sL1 $1 $ HsWordPrim   (getPRIMWORDs $1)
3065                                                    $ getPRIMWORD $1 }
3066         | PRIMCHAR          { sL1 $1 $ HsCharPrim   (getPRIMCHARs $1)
3067                                                    $ getPRIMCHAR $1 }
3068         | PRIMSTRING        { sL1 $1 $ HsStringPrim (getPRIMSTRINGs $1)
3069                                                    $ getPRIMSTRING $1 }
3070         | PRIMFLOAT         { sL1 $1 $ HsFloatPrim  $ getPRIMFLOAT $1 }
3071         | PRIMDOUBLE        { sL1 $1 $ HsDoublePrim $ getPRIMDOUBLE $1 }
3072
3073 -----------------------------------------------------------------------------
3074 -- Layout
3075
3076 close :: { () }
3077         : vccurly               { () } -- context popped in lexer.
3078         | error                 {% popContext }
3079
3080 -----------------------------------------------------------------------------
3081 -- Miscellaneous (mostly renamings)
3082
3083 modid   :: { Located ModuleName }
3084         : CONID                 { sL1 $1 $ mkModuleNameFS (getCONID $1) }
3085         | QCONID                { sL1 $1 $ let (mod,c) = getQCONID $1 in
3086                                   mkModuleNameFS
3087                                    (mkFastString
3088                                      (unpackFS mod ++ '.':unpackFS c))
3089                                 }
3090
3091 commas :: { ([SrcSpan],Int) }   -- One or more commas
3092         : commas ','             { ((fst $1)++[gl $2],snd $1 + 1) }
3093         | ','                    { ([gl $1],1) }
3094
3095 -----------------------------------------------------------------------------
3096 -- Documentation comments
3097
3098 docnext :: { LHsDocString }
3099   : DOCNEXT {% return (sL1 $1 (HsDocString (mkFastString (getDOCNEXT $1)))) }
3100
3101 docprev :: { LHsDocString }
3102   : DOCPREV {% return (sL1 $1 (HsDocString (mkFastString (getDOCPREV $1)))) }
3103
3104 docnamed :: { Located (String, HsDocString) }
3105   : DOCNAMED {%
3106       let string = getDOCNAMED $1
3107           (name, rest) = break isSpace string
3108       in return (sL1 $1 (name, HsDocString (mkFastString rest))) }
3109
3110 docsection :: { Located (Int, HsDocString) }
3111   : DOCSECTION {% let (n, doc) = getDOCSECTION $1 in
3112         return (sL1 $1 (n, HsDocString (mkFastString doc))) }
3113
3114 moduleheader :: { Maybe LHsDocString }
3115         : DOCNEXT {% let string = getDOCNEXT $1 in
3116                      return (Just (sL1 $1 (HsDocString (mkFastString string)))) }
3117
3118 maybe_docprev :: { Maybe LHsDocString }
3119         : docprev                       { Just $1 }
3120         | {- empty -}                   { Nothing }
3121
3122 maybe_docnext :: { Maybe LHsDocString }
3123         : docnext                       { Just $1 }
3124         | {- empty -}                   { Nothing }
3125
3126 {
3127 happyError :: P a
3128 happyError = srcParseFail
3129
3130 getVARID        (L _ (ITvarid    x)) = x
3131 getCONID        (L _ (ITconid    x)) = x
3132 getVARSYM       (L _ (ITvarsym   x)) = x
3133 getCONSYM       (L _ (ITconsym   x)) = x
3134 getQVARID       (L _ (ITqvarid   x)) = x
3135 getQCONID       (L _ (ITqconid   x)) = x
3136 getQVARSYM      (L _ (ITqvarsym  x)) = x
3137 getQCONSYM      (L _ (ITqconsym  x)) = x
3138 getPREFIXQVARSYM (L _ (ITprefixqvarsym  x)) = x
3139 getPREFIXQCONSYM (L _ (ITprefixqconsym  x)) = x
3140 getIPDUPVARID   (L _ (ITdupipvarid   x)) = x
3141 getCHAR         (L _ (ITchar   _ x)) = x
3142 getSTRING       (L _ (ITstring _ x)) = x
3143 getINTEGER      (L _ (ITinteger _ x)) = x
3144 getRATIONAL     (L _ (ITrational x)) = x
3145 getPRIMCHAR     (L _ (ITprimchar _ x)) = x
3146 getPRIMSTRING   (L _ (ITprimstring _ x)) = x
3147 getPRIMINTEGER  (L _ (ITprimint  _ x)) = x
3148 getPRIMWORD     (L _ (ITprimword _ x)) = x
3149 getPRIMFLOAT    (L _ (ITprimfloat x)) = x
3150 getPRIMDOUBLE   (L _ (ITprimdouble x)) = x
3151 getTH_ID_SPLICE (L _ (ITidEscape x)) = x
3152 getTH_ID_TY_SPLICE (L _ (ITidTyEscape x)) = x
3153 getINLINE       (L _ (ITinline_prag _ inl conl)) = (inl,conl)
3154 getSPEC_INLINE  (L _ (ITspec_inline_prag _ True))  = (Inline,  FunLike)
3155 getSPEC_INLINE  (L _ (ITspec_inline_prag _ False)) = (NoInline,FunLike)
3156
3157 getDOCNEXT (L _ (ITdocCommentNext x)) = x
3158 getDOCPREV (L _ (ITdocCommentPrev x)) = x
3159 getDOCNAMED (L _ (ITdocCommentNamed x)) = x
3160 getDOCSECTION (L _ (ITdocSection n x)) = (n, x)
3161
3162 getCHARs        (L _ (ITchar       src _)) = src
3163 getSTRINGs      (L _ (ITstring     src _)) = src
3164 getINTEGERs     (L _ (ITinteger    src _)) = src
3165 getPRIMCHARs    (L _ (ITprimchar   src _)) = src
3166 getPRIMSTRINGs  (L _ (ITprimstring src _)) = src
3167 getPRIMINTEGERs (L _ (ITprimint    src _)) = src
3168 getPRIMWORDs    (L _ (ITprimword   src _)) = src
3169
3170 -- See Note [Pragma source text] in BasicTypes for the following
3171 getINLINE_PRAGs       (L _ (ITinline_prag       src _ _)) = src
3172 getSPEC_PRAGs         (L _ (ITspec_prag         src))     = src
3173 getSPEC_INLINE_PRAGs  (L _ (ITspec_inline_prag  src _))   = src
3174 getSOURCE_PRAGs       (L _ (ITsource_prag       src)) = src
3175 getRULES_PRAGs        (L _ (ITrules_prag        src)) = src
3176 getWARNING_PRAGs      (L _ (ITwarning_prag      src)) = src
3177 getDEPRECATED_PRAGs   (L _ (ITdeprecated_prag   src)) = src
3178 getSCC_PRAGs          (L _ (ITscc_prag          src)) = src
3179 getGENERATED_PRAGs    (L _ (ITgenerated_prag    src)) = src
3180 getCORE_PRAGs         (L _ (ITcore_prag         src)) = src
3181 getUNPACK_PRAGs       (L _ (ITunpack_prag       src)) = src
3182 getNOUNPACK_PRAGs     (L _ (ITnounpack_prag     src)) = src
3183 getANN_PRAGs          (L _ (ITann_prag          src)) = src
3184 getVECT_PRAGs         (L _ (ITvect_prag         src)) = src
3185 getVECT_SCALAR_PRAGs  (L _ (ITvect_scalar_prag  src)) = src
3186 getNOVECT_PRAGs       (L _ (ITnovect_prag       src)) = src
3187 getMINIMAL_PRAGs      (L _ (ITminimal_prag      src)) = src
3188 getOVERLAPPABLE_PRAGs (L _ (IToverlappable_prag src)) = src
3189 getOVERLAPPING_PRAGs  (L _ (IToverlapping_prag  src)) = src
3190 getOVERLAPS_PRAGs     (L _ (IToverlaps_prag     src)) = src
3191 getINCOHERENT_PRAGs   (L _ (ITincoherent_prag   src)) = src
3192 getCTYPEs             (L _ (ITctype             src)) = src
3193
3194
3195 getSCC :: Located Token -> P FastString
3196 getSCC lt = do let s = getSTRING lt
3197                    err = "Spaces are not allowed in SCCs"
3198                -- We probably actually want to be more restrictive than this
3199                if ' ' `elem` unpackFS s
3200                    then failSpanMsgP (getLoc lt) (text err)
3201                    else return s
3202
3203 -- Utilities for combining source spans
3204 comb2 :: Located a -> Located b -> SrcSpan
3205 comb2 a b = a `seq` b `seq` combineLocs a b
3206