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