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

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

19 20 21 22 23 24 25 26
{-# OPTIONS_GHC -O0 -fno-ignore-interface-pragmas #-}
{-
Careful optimisation of the parser: we don't want to throw everything
at it, because that takes too long and doesn't buy much, but we do want
to inline certain key external functions, so we instruct GHC not to
throw away inlinings as it would normally do in -O0 mode.
-}

27
module Parser ( parseModule, parseStmt, parseIdentifier, parseType,
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
28
                parseHeader ) where
29 30 31

import HsSyn
import RdrHsSyn
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
32
import HscTypes         ( IsBootInterface, WarningTxt(..) )
33 34
import Lexer
import RdrName
35
import TcEvidence       ( emptyTcEvBinds )
dreixel's avatar
dreixel committed
36
import TysPrim          ( liftedTypeKindTyConName, eqPrimTyCon )
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
37
import TysWiredIn       ( unitTyCon, unitDataCon, tupleTyCon, tupleCon, nilDataCon,
38
                          unboxedUnitTyCon, unboxedUnitDataCon,
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
39 40 41 42 43 44 45
                          listTyCon_RDR, parrTyCon_RDR, consDataCon_RDR, eqTyCon_RDR )
import Type             ( funTyCon )
import ForeignCall      ( Safety(..), CExportSpec(..), CLabelString,
                          CCallConv(..), CCallTarget(..), defaultCCallConv
                        )
import OccName          ( varName, dataName, tcClsName, tvName )
import DataCon          ( DataCon, dataConName )
Ian Lynagh's avatar
Ian Lynagh committed
46
import SrcLoc
47
import Module
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
48
import StaticFlags      ( opt_SccProfilingOn, opt_Hpc )
dreixel's avatar
dreixel committed
49
import Kind             ( Kind, liftedTypeKind, unliftedTypeKind, mkArrowKind )
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
50
import Class            ( FunDep )
51
import BasicTypes
52
import DynFlags
53
import OrdList
54
import HaddockUtils
55 56

import FastString
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
57
import Maybes           ( orElse )
58
import Outputable
59

60
import Control.Monad    ( unless )
Simon Marlow's avatar
Simon Marlow committed
61
import GHC.Exts
62 63
import Data.Char
import Control.Monad    ( mplus )
64 65 66
}

{-
67 68 69 70 71 72 73 74 75 76 77
-----------------------------------------------------------------------------
24 Februar 2006

Conflicts: 33 shift/reduce
           1 reduce/reduce

The reduce/reduce conflict is weird.  It's between tyconsym and consym, and I
would think the two should never occur in the same context.

  -=chak

78 79 80 81 82 83 84 85 86 87 88
-----------------------------------------------------------------------------
31 December 2006

Conflicts: 34 shift/reduce
           1 reduce/reduce

The reduce/reduce conflict is weird.  It's between tyconsym and consym, and I
would think the two should never occur in the same context.

  -=chak

89 90 91 92 93 94 95 96 97 98 99
-----------------------------------------------------------------------------
6 December 2006

Conflicts: 32 shift/reduce
           1 reduce/reduce

The reduce/reduce conflict is weird.  It's between tyconsym and consym, and I
would think the two should never occur in the same context.

  -=chak

100 101 102 103 104 105 106 107 108 109 110
-----------------------------------------------------------------------------
26 July 2006

Conflicts: 37 shift/reduce
           1 reduce/reduce

The reduce/reduce conflict is weird.  It's between tyconsym and consym, and I
would think the two should never occur in the same context.

  -=chak

111
-----------------------------------------------------------------------------
112
Conflicts: 38 shift/reduce (1.25)
113

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
114 115 116
10 for abiguity in 'if x then y else z + 1'             [State 178]
        (shift parses as 'if x then y else (z + 1)', as per longest-parse rule)
        10 because op might be: : - ! * . `x` VARSYM CONSYM QVARSYM QCONSYM
117

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
118 119
1 for ambiguity in 'if x then y else z :: T'            [State 178]
        (shift parses as 'if x then y else (z :: T)', as per longest-parse rule)
120

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
121 122 123
4 for ambiguity in 'if x then y else z -< e'            [State 178]
        (shift parses as 'if x then y else (z -< T)', as per longest-parse rule)
        There are four such operators: -<, >-, -<<, >>-
124 125


chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
126 127 128 129
2 for ambiguity in 'case v of { x :: T -> T ... } '     [States 11, 253]
        Which of these two is intended?
          case v of
            (x::T) -> T         -- Rhs is T
130
    or
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
131 132
          case v of
            (x::T -> T) -> ..   -- Rhs is ...
133

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
134 135 136
10 for ambiguity in 'e :: a `b` c'.  Does this mean     [States 11, 253]
        (e::a) `b` c, or 
        (e :: (a `b` c))
137
    As well as `b` we can have !, VARSYM, QCONSYM, and CONSYM, hence 5 cases
138
    Same duplication between states 11 and 253 as the previous case
139

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
140 141 142 143
1 for ambiguity in 'let ?x ...'                         [State 329]
        the parser can't tell whether the ?x is the lhs of a normal binding or
        an implicit binding.  Fortunately resolving as shift gives it the only
        sensible meaning, namely the lhs of an implicit binding.
144

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
145 146 147 148
1 for ambiguity in '{-# RULES "name" [ ... #-}          [State 382]
        we don't know whether the '[' starts the activation or not: it
        might be the start of the declaration with the activation being
        empty.  --SDM 1/4/2002
149

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
150 151 152 153 154 155 156
1 for ambiguity in '{-# RULES "name" forall = ... #-}'  [State 474]
        since 'forall' is a valid variable name, we don't know whether
        to treat a forall on the input as the beginning of a quantifier
        or the beginning of the rule itself.  Resolving to shift means
        it's always treated as a quantifier, hence the above is disallowed.
        This saves explicitly defining a grammar for the rule lhs that
        doesn't include 'forall'.
157

158 159 160 161
1 for ambiguity when the source file starts with "-- | doc". We need another
  token of lookahead to determine if a top declaration or the 'module' keyword
  follows. Shift parses as if the 'module' keyword follows.   

162 163 164 165 166 167 168 169 170 171
-- ---------------------------------------------------------------------------
-- Adding location info

This is done in a stylised way using the three macros below, L0, L1
and LL.  Each of these macros can be thought of as having type

   L0, L1, LL :: a -> Located a

They each add a SrcSpan to their argument.

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
172
   L0   adds 'noSrcSpan', used for empty productions
173
     -- This doesn't seem to work anymore -=chak
174 175

   L1   for a production with a single token on the lhs.  Grabs the SrcSpan
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
176
        from that token.
177 178 179 180 181 182 183 184 185

   LL   for a production with >1 token on the lhs.  Makes up a SrcSpan from
        the first and last tokens.

These suffice for the majority of cases.  However, we must be
especially careful with empty productions: LL won't work if the first
or last token on the lhs can represent an empty span.  In these cases,
we have to calculate the span using more of the tokens from the lhs, eg.

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
186 187 188
        | 'newtype' tycl_hdr '=' newconstr deriving
                { L (comb3 $1 $4 $5)
                    (mkTyData NewType (unLoc $2) [$4] (unLoc $5)) }
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208

We provide comb3 and comb4 functions which are useful in such cases.

Be careful: there's no checking that you actually got this right, the
only symptom will be that the SrcSpans of your syntax will be
incorrect.

/*
 * We must expand these macros *before* running Happy, which is why this file is
 * Parser.y.pp rather than just Parser.y - we run the C pre-processor first.
 */
#define L0   L noSrcSpan
#define L1   sL (getLoc $1)
#define LL   sL (comb2 $1 $>)

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

-}

%token
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
 '_'            { L _ ITunderscore }            -- Haskell keywords
 'as'           { L _ ITas }
 'case'         { L _ ITcase }          
 'class'        { L _ ITclass } 
 'data'         { L _ ITdata } 
 'default'      { L _ ITdefault }
 'deriving'     { L _ ITderiving }
 'do'           { L _ ITdo }
 'else'         { L _ ITelse }
 'hiding'       { L _ IThiding }
 'if'           { L _ ITif }
 'import'       { L _ ITimport }
 'in'           { L _ ITin }
 'infix'        { L _ ITinfix }
 'infixl'       { L _ ITinfixl }
 'infixr'       { L _ ITinfixr }
 'instance'     { L _ ITinstance }
 'let'          { L _ ITlet }
 'module'       { L _ ITmodule }
 'newtype'      { L _ ITnewtype }
 'of'           { L _ ITof }
 'qualified'    { L _ ITqualified }
 'then'         { L _ ITthen }
 'type'         { L _ ITtype }
 'where'        { L _ ITwhere }
 '_scc_'        { L _ ITscc }         -- ToDo: remove

 'forall'       { L _ ITforall }                -- GHC extension keywords
 'foreign'      { L _ ITforeign }
 'export'       { L _ ITexport }
 'label'        { L _ ITlabel } 
 'dynamic'      { L _ ITdynamic }
 'safe'         { L _ ITsafe }
242
 'interruptible' { L _ ITinterruptible }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
243 244 245
 'unsafe'       { L _ ITunsafe }
 'mdo'          { L _ ITmdo }
 'family'       { L _ ITfamily }
246 247
 'stdcall'      { L _ ITstdcallconv }
 'ccall'        { L _ ITccallconv }
248
 'capi'         { L _ ITcapiconv }
249
 'prim'         { L _ ITprimcallconv }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
250 251
 'proc'         { L _ ITproc }          -- for arrow notation extension
 'rec'          { L _ ITrec }           -- for arrow notation extension
252 253 254
 'group'    { L _ ITgroup }     -- for list transform extension
 'by'       { L _ ITby }        -- for list transform extension
 'using'    { L _ ITusing }     -- for list transform extension
255

256 257
 '{-# INLINE'             { L _ (ITinline_prag _ _) }
 '{-# SPECIALISE'         { L _ ITspec_prag }
258
 '{-# SPECIALISE_INLINE'  { L _ (ITspec_inline_prag _) }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
259 260 261
 '{-# SOURCE'                                   { L _ ITsource_prag }
 '{-# RULES'                                    { L _ ITrules_prag }
 '{-# CORE'                                     { L _ ITcore_prag }              -- hdaume: annotated core
262 263 264 265 266
 '{-# SCC'                { L _ ITscc_prag }
 '{-# GENERATED'          { L _ ITgenerated_prag }
 '{-# DEPRECATED'         { L _ ITdeprecated_prag }
 '{-# WARNING'            { L _ ITwarning_prag }
 '{-# UNPACK'             { L _ ITunpack_prag }
267
 '{-# NOUNPACK'           { L _ ITnounpack_prag }
268
 '{-# ANN'                { L _ ITann_prag }
269 270
 '{-# VECTORISE'          { L _ ITvect_prag }
 '{-# VECTORISE_SCALAR'   { L _ ITvect_scalar_prag }
271
 '{-# NOVECTORISE'        { L _ ITnovect_prag }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
 '#-}'                                          { L _ ITclose_prag }

 '..'           { L _ ITdotdot }                        -- reserved symbols
 ':'            { L _ ITcolon }
 '::'           { L _ ITdcolon }
 '='            { L _ ITequal }
 '\\'           { L _ ITlam }
 '|'            { L _ ITvbar }
 '<-'           { L _ ITlarrow }
 '->'           { L _ ITrarrow }
 '@'            { L _ ITat }
 '~'            { L _ ITtilde }
 '~#'           { L _ ITtildehsh }
 '=>'           { L _ ITdarrow }
 '-'            { L _ ITminus }
 '!'            { L _ ITbang }
 '*'            { L _ ITstar }
 '-<'           { L _ ITlarrowtail }            -- for arrow notation
 '>-'           { L _ ITrarrowtail }            -- for arrow notation
 '-<<'          { L _ ITLarrowtail }            -- for arrow notation
 '>>-'          { L _ ITRarrowtail }            -- for arrow notation
 '.'            { L _ ITdot }

 '{'            { L _ ITocurly }                        -- special symbols
 '}'            { L _ ITccurly }
297 298
 '{|'           { L _ ITocurlybar }
 '|}'           { L _ ITccurlybar }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
 vocurly        { L _ ITvocurly } -- virtual open curly (from layout)
 vccurly        { L _ ITvccurly } -- virtual close curly (from layout)
 '['            { L _ ITobrack }
 ']'            { L _ ITcbrack }
 '[:'           { L _ ITopabrack }
 ':]'           { L _ ITcpabrack }
 '('            { L _ IToparen }
 ')'            { L _ ITcparen }
 '(#'           { L _ IToubxparen }
 '#)'           { L _ ITcubxparen }
 '(|'           { L _ IToparenbar }
 '|)'           { L _ ITcparenbar }
 ';'            { L _ ITsemi }
 ','            { L _ ITcomma }
 '`'            { L _ ITbackquote }
dreixel's avatar
dreixel committed
314
 SIMPLEQUOTE    { L _ ITsimpleQuote      }     -- 'x
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
315 316 317 318 319 320 321 322 323

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

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
 IPDUPVARID     { L _ (ITdupipvarid   _) }              -- GHC extension

 CHAR           { L _ (ITchar     _) }
 STRING         { L _ (ITstring   _) }
 INTEGER        { L _ (ITinteger  _) }
 RATIONAL       { L _ (ITrational _) }
                    
 PRIMCHAR       { L _ (ITprimchar   _) }
 PRIMSTRING     { L _ (ITprimstring _) }
 PRIMINTEGER    { L _ (ITprimint    _) }
 PRIMWORD       { L _ (ITprimword  _) }
 PRIMFLOAT      { L _ (ITprimfloat  _) }
 PRIMDOUBLE     { L _ (ITprimdouble _) }

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

346 347 348 349 350 351 352
-- Template Haskell 
'[|'            { L _ ITopenExpQuote  }       
'[p|'           { L _ ITopenPatQuote  }      
'[t|'           { L _ ITopenTypQuote  }      
'[d|'           { L _ ITopenDecQuote  }      
'|]'            { L _ ITcloseQuote    }
TH_ID_SPLICE    { L _ (ITidEscape _)  }     -- $x
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
353 354 355
'$('            { L _ ITparenEscape   }     -- $( exp )
TH_TY_QUOTE     { L _ ITtyQuote       }      -- ''T
TH_QUASIQUOTE   { L _ (ITquasiQuote _) }
356 357 358 359 360 361

%monad { P } { >>= } { return }
%lexer { lexer } { L _ ITeof }
%name parseModule module
%name parseStmt   maybe_stmt
%name parseIdentifier  identifier
362
%name parseType ctype
363
%partial parseHeader header
364
%tokentype { (Located Token) }
365 366
%%

367 368 369
-----------------------------------------------------------------------------
-- Identifiers; one of the entry points
identifier :: { Located RdrName }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
370 371 372 373
        : qvar                          { $1 }
        | qcon                          { $1 }
        | qvarop                        { $1 }
        | qconop                        { $1 }
374
    | '(' '->' ')'      { LL $ getRdrName funTyCon }
375

376 377 378 379 380 381 382 383 384 385
-----------------------------------------------------------------------------
-- Module Header

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

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
386 387 388 389
module  :: { Located (HsModule RdrName) }
        : maybedocheader 'module' modid maybemodwarning maybeexports 'where' body
                {% fileSrcSpan >>= \ loc ->
                   return (L loc (HsModule (Just $3) $5 (fst $7) (snd $7) $4 $1
390
                          ) )}
391
        | body2
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
392 393
                {% fileSrcSpan >>= \ loc ->
                   return (L loc (HsModule Nothing Nothing
394 395
                          (fst $1) (snd $1) Nothing Nothing
                          )) }
396

397
maybedocheader :: { Maybe LHsDocString }
398
        : moduleheader            { $1 }
399
        | {- empty -}             { Nothing }
400 401

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

Ian Lynagh's avatar
Ian Lynagh committed
404
maybemodwarning :: { Maybe WarningTxt }
405 406
    : '{-# DEPRECATED' strings '#-}' { Just (DeprecatedTxt $ unLoc $2) }
    | '{-# WARNING' strings '#-}'    { Just (WarningTxt $ unLoc $2) }
Ian Lynagh's avatar
Ian Lynagh committed
407
    |  {- empty -}                  { Nothing }
408

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
409 410 411
body    :: { ([LImportDecl RdrName], [LHsDecl RdrName]) }
        :  '{'            top '}'               { $2 }
        |      vocurly    top close             { $2 }
412

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
413 414 415
body2   :: { ([LImportDecl RdrName], [LHsDecl RdrName]) }
        :  '{' top '}'                          { $2 }
        |  missing_module_keyword top close     { $2 }
416

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
417 418 419 420
top     :: { ([LImportDecl RdrName], [LHsDecl RdrName]) }
        : importdecls                           { (reverse $1,[]) }
        | importdecls ';' cvtopdecls            { (reverse $1,$3) }
        | cvtopdecls                            { ([],$1) }
421 422

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

425 426 427
-----------------------------------------------------------------------------
-- Module declaration & imports only

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
428 429 430 431
header  :: { Located (HsModule RdrName) }
        : maybedocheader 'module' modid maybemodwarning maybeexports 'where' header_body
                {% fileSrcSpan >>= \ loc ->
                   return (L loc (HsModule (Just $3) $5 $7 [] $4 $1
432
                          ))}
433
        | header_body2
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
434
                {% fileSrcSpan >>= \ loc ->
435
                   return (L loc (HsModule Nothing Nothing $1 [] Nothing
436
                          Nothing)) }
437 438

header_body :: { [LImportDecl RdrName] }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
439
        :  '{'            importdecls           { $2 }
440 441 442 443 444
        |      vocurly    importdecls           { $2 }

header_body2 :: { [LImportDecl RdrName] }
        :  '{' importdecls                      { $2 }
        |  missing_module_keyword importdecls   { $2 }
445

446 447 448 449
-----------------------------------------------------------------------------
-- The Export List

maybeexports :: { Maybe [LIE RdrName] }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
450 451
        :  '(' exportlist ')'                   { Just $2 }
        |  {- empty -}                          { Nothing }
452

453
exportlist :: { [LIE RdrName] }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
454 455
        : expdoclist ',' expdoclist             { $1 ++ $3 }
        | exportlist1                           { $1 }
456 457

exportlist1 :: { [LIE RdrName] }
458
        : expdoclist export expdoclist ',' exportlist  { $1 ++ ($2 : $3) ++ $5 }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
459 460
        | expdoclist export expdoclist                 { $1 ++ ($2 : $3) }
        | expdoclist                                   { $1 }
461 462 463 464 465 466 467 468 469

expdoclist :: { [LIE RdrName] }
        : exp_doc expdoclist                           { $1 : $2 }
        | {- empty -}                                  { [] }

exp_doc :: { LIE RdrName }                                                   
        : docsection    { L1 (case (unLoc $1) of (n, doc) -> IEGroup n doc) }
        | docnamed      { L1 (IEDocNamed ((fst . unLoc) $1)) } 
        | docnext       { L1 (IEDoc (unLoc $1)) }       
470 471


472 473
   -- No longer allow things like [] and (,,,) to be exported
   -- They are built in syntax, always available
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
474
export  :: { LIE RdrName }
475 476
        : qcname_ext export_subspec     { LL (mkModuleImpExp (unLoc $1)
                                                             (unLoc $2)) }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
477
        |  'module' modid               { LL (IEModuleContents (unLoc $2)) }
478

479 480 481 482 483 484
export_subspec :: { Located ImpExpSubSpec }
        : {- empty -}                   { L0 ImpExpAbs }
        | '(' '..' ')'                  { LL ImpExpAll }
        | '(' ')'                       { LL (ImpExpList []) }
        | '(' qcnames ')'               { LL (ImpExpList $2) }

485
qcnames :: { [RdrName] }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
486 487
        :  qcnames ',' qcname_ext       { unLoc $3 : $1 }
        |  qcname_ext                   { [unLoc $1]  }
488

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
489 490 491
qcname_ext :: { Located RdrName }       -- Variable or data constructor
                                        -- or tagged type constructor
        :  qcname                       { $1 }
492
        |  'type' qcname                { sL (comb2 $1 $2) 
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
493 494
                                             (setRdrNameSpace (unLoc $2) 
                                                              tcClsName)  }
495 496

-- Cannot pull into qcname_ext, as qcname is also used in expression.
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
497 498 499
qcname  :: { Located RdrName }  -- Variable or data constructor
        :  qvar                         { $1 }
        |  qcon                         { $1 }
500 501 502 503 504 505 506 507

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

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

importdecls :: { [LImportDecl RdrName] }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
508 509 510 511
        : importdecls ';' importdecl            { $3 : $1 }
        | importdecls ';'                       { $1 }
        | importdecl                            { [ $1 ] }
        | {- empty -}                           { [] }
512 513

importdecl :: { LImportDecl RdrName }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
514 515
        : 'import' maybe_src maybe_safe optqualified maybe_pkg modid maybeas maybeimpspec 
                { L (comb4 $1 $6 $7 $8) $
516 517 518 519
                  ImportDecl { ideclName = $6, ideclPkgQual = $5
                             , ideclSource = $2, ideclSafe = $3
                             , ideclQualified = $4, ideclImplicit = False
                             , ideclAs = unLoc $7, ideclHiding = unLoc $8 } }
520 521

maybe_src :: { IsBootInterface }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
522 523
        : '{-# SOURCE' '#-}'                    { True }
        | {- empty -}                           { False }
524

525
maybe_safe :: { Bool }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
526 527
        : 'safe'                                { True }
        | {- empty -}                           { False }
528

529 530 531 532
maybe_pkg :: { Maybe FastString }
        : STRING                                { Just (getSTRING $1) }
        | {- empty -}                           { Nothing }

533
optqualified :: { Bool }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
534 535
        : 'qualified'                           { True  }
        | {- empty -}                           { False }
536

Simon Marlow's avatar
Simon Marlow committed
537
maybeas :: { Located (Maybe ModuleName) }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
538 539
        : 'as' modid                            { LL (Just (unLoc $2)) }
        | {- empty -}                           { noLoc Nothing }
540 541

maybeimpspec :: { Located (Maybe (Bool, [LIE RdrName])) }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
542 543
        : impspec                               { L1 (Just (unLoc $1)) }
        | {- empty -}                           { noLoc Nothing }
544 545

impspec :: { Located (Bool, [LIE RdrName]) }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
546 547
        :  '(' exportlist ')'                   { LL (False, $2) }
        |  'hiding' '(' exportlist ')'          { LL (True,  $3) }
548 549 550 551

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

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
552 553 554
prec    :: { Int }
        : {- empty -}           { 9 }
        | INTEGER               {% checkPrecP (L1 (fromInteger (getINTEGER $1))) }
555

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
556 557 558 559
infix   :: { Located FixityDirection }
        : 'infix'                               { L1 InfixN  }
        | 'infixl'                              { L1 InfixL  }
        | 'infixr'                              { L1 InfixR }
560

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
561 562 563
ops     :: { Located [Located RdrName] }
        : ops ',' op                            { LL ($3 : unLoc $1) }
        | op                                    { L1 [$1] }
564 565 566 567

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

568
topdecls :: { OrdList (LHsDecl RdrName) }
569 570 571
        : topdecls ';' topdecl                  { $1 `appOL` $3 }
        | topdecls ';'                          { $1 }
        | topdecl                               { $1 }
572

573
topdecl :: { OrdList (LHsDecl RdrName) }
574 575
        : cl_decl                               { unitOL (L1 (TyClD (unLoc $1))) }
        | ty_decl                               { unitOL (L1 (TyClD (unLoc $1))) }
576 577 578 579
        | 'instance' inst_type where_inst
            { let (binds, sigs, ats, _) = cvBindsAndSigs (unLoc $3)
              in 
              unitOL (L (comb3 $1 $2 $3) (InstD (InstDecl $2 binds sigs ats)))}
580
        | stand_alone_deriving                  { unitOL (LL (DerivD (unLoc $1))) }
581 582
        | 'default' '(' comma_types0 ')'        { unitOL (LL $ DefD (DefaultDecl $3)) }
        | 'foreign' fdecl                       { unitOL (LL (unLoc $2)) }
583 584
        | '{-# DEPRECATED' deprecations '#-}'   { $2 }
        | '{-# WARNING' warnings '#-}'          { $2 }
585
        | '{-# RULES' rules '#-}'               { $2 }
586 587 588
        | '{-# VECTORISE_SCALAR' qvar '#-}'     { unitOL $ LL $ VectD (HsVect       $2 Nothing) }
        | '{-# VECTORISE' qvar '=' exp '#-}'    { unitOL $ LL $ VectD (HsVect       $2 (Just $4)) }
        | '{-# NOVECTORISE' qvar '#-}'          { unitOL $ LL $ VectD (HsNoVect     $2) }
589 590 591 592 593 594 595 596 597
        | '{-# VECTORISE' 'type' gtycon '#-}'     
                                                { unitOL $ LL $ 
                                                    VectD (HsVectTypeIn False $3 Nothing) }
        | '{-# VECTORISE_SCALAR' 'type' gtycon '#-}'     
                                                { unitOL $ LL $ 
                                                    VectD (HsVectTypeIn True $3 Nothing) }
        | '{-# VECTORISE' 'type' gtycon '=' gtycon '#-}'     
                                                { unitOL $ LL $ 
                                                    VectD (HsVectTypeIn False $3 (Just $5)) }
598 599 600
        | '{-# VECTORISE_SCALAR' 'type' gtycon '=' gtycon '#-}'     
                                                { unitOL $ LL $ 
                                                    VectD (HsVectTypeIn True $3 (Just $5)) }
601 602
        | '{-# VECTORISE' 'class' gtycon '#-}'  { unitOL $ LL $ VectD (HsVectClassIn $3) }
        | '{-# VECTORISE_SCALAR' 'instance' type '#-}'     
603
                                                { unitOL $ LL $ VectD (HsVectInstIn $3) }
604 605 606 607 608 609 610 611
        | annotation { unitOL $1 }
        | decl                                  { unLoc $1 }

        -- Template Haskell Extension
        -- The $(..) form is one possible form of infixexp
        -- but we treat an arbitrary expression just as if 
        -- it had a $(..) wrapped around it
        | infixexp                              { unitOL (LL $ mkTopSpliceDecl $1) } 
612

613 614 615
-- Type classes
--
cl_decl :: { LTyClDecl RdrName }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
616
        : 'class' tycl_hdr fds where_cls        {% mkClassDecl (comb4 $1 $2 $3 $4) $2 $3 $4 }
617

618
-- Type declarations (toplevel)
619 620
--
ty_decl :: { LTyClDecl RdrName }
621
           -- ordinary type synonyms
622
        : 'type' type '=' ctypedoc
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
623 624 625 626 627 628 629 630
                -- Note ctype, not sigtype, on the right of '='
                -- We allow an explicit for-all but we don't insert one
                -- in   type Foo a = (b,b)
                -- Instead we just say b is out of scope
                --
                -- Note the use of type for the head; this allows
                -- infix type constructors to be declared 
                {% mkTySynonym (comb2 $1 $4) False $2 $4 }
631 632

           -- type family declarations
633
        | 'type' 'family' type opt_kind_sig 
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
634 635 636
                -- Note the use of type for the head; this allows
                -- infix type constructors to be declared
                {% mkTyFamily (comb3 $1 $3 $4) TypeFamily $3 (unLoc $4) }
637 638 639

           -- type instance declarations
        | 'type' 'instance' type '=' ctype
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
640 641 642
                -- Note the use of type for the head; this allows
                -- infix type constructors and type patterns
                {% mkTySynonym (comb2 $1 $5) True $3 $5 }
643

644
          -- ordinary data type or newtype declaration
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
645 646
        | data_or_newtype tycl_hdr constrs deriving
                {% mkTyData (comb4 $1 $2 $3 $4) (unLoc $1) False $2 
647
                            Nothing (reverse (unLoc $3)) (unLoc $4) }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
648 649
                                   -- We need the location on tycl_hdr in case 
                                   -- constrs and deriving are both empty
650

651
          -- ordinary GADT declaration
652
        | data_or_newtype tycl_hdr opt_kind_sig 
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
653 654 655
                 gadt_constrlist
                 deriving
                {% mkTyData (comb4 $1 $2 $4 $5) (unLoc $1) False $2 
656
                            (unLoc $3) (unLoc $4) (unLoc $5) }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
657 658
                                   -- We need the location on tycl_hdr in case 
                                   -- constrs and deriving are both empty
659

660
          -- data/newtype family
661
        | 'data' 'family' type opt_kind_sig
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
662
                {% mkTyFamily (comb3 $1 $2 $4) DataFamily $3 (unLoc $4) }
663

664
          -- data/newtype instance declaration
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
665 666 667
        | data_or_newtype 'instance' tycl_hdr constrs deriving
                {% mkTyData (comb4 $1 $3 $4 $5) (unLoc $1) True $3
                            Nothing (reverse (unLoc $4)) (unLoc $5) }
668

669
          -- GADT instance declaration
670
        | data_or_newtype 'instance' tycl_hdr opt_kind_sig 
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
671 672 673 674
                 gadt_constrlist
                 deriving
                {% mkTyData (comb4 $1 $3 $5 $6) (unLoc $1) True $3
                            (unLoc $4) (unLoc $5) (unLoc $6) }
675 676

-- Associated type family declarations
677 678 679 680 681 682 683
--
-- * They have a different syntax than on the toplevel (no family special
--   identifier).
--
-- * They also need to be separate from instances; otherwise, data family
--   declarations without a kind signature cause parsing conflicts with empty
--   data declarations. 
684
--
685
at_decl_cls :: { LTyClDecl RdrName }
686
           -- type family declarations
687
        : 'type' type opt_kind_sig
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
688 689 690
                -- Note the use of type for the head; this allows
                -- infix type constructors to be declared
                {% mkTyFamily (comb3 $1 $2 $3) TypeFamily $2 (unLoc $3) }
691

692 693
           -- default type instance
        | 'type' type '=' ctype
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
694 695 696
                -- Note the use of type for the head; this allows
                -- infix type constructors and type patterns
                {% mkTySynonym (comb2 $1 $4) True $2 $4 }
697

698
          -- data/newtype family declaration
699
        | 'data' type opt_kind_sig
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
700
                {% mkTyFamily (comb3 $1 $2 $3) DataFamily $2 (unLoc $3) }
701 702

-- Associated type instances
703 704 705 706
--
at_decl_inst :: { LTyClDecl RdrName }
           -- type instance declarations
        : 'type' type '=' ctype
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
707 708 709
                -- Note the use of type for the head; this allows
                -- infix type constructors and type patterns
                {% mkTySynonym (comb2 $1 $4) True $2 $4 }
710 711

        -- data/newtype instance declaration
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
712 713
        | data_or_newtype tycl_hdr constrs deriving
                {% mkTyData (comb4 $1 $2 $3 $4) (unLoc $1) True $2 
714
                            Nothing (reverse (unLoc $3)) (unLoc $4) }
715 716 717

        -- GADT instance declaration
        | data_or_newtype tycl_hdr opt_kind_sig 
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
718 719 720 721
                 gadt_constrlist
                 deriving
                {% mkTyData (comb4 $1 $2 $4 $5) (unLoc $1) True $2 
                            (unLoc $3) (unLoc $4) (unLoc $5) }
722

723
data_or_newtype :: { Located NewOrData }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
724 725
        : 'data'        { L1 DataType }
        | 'newtype'     { L1 NewType }
726

dreixel's avatar
dreixel committed
727
opt_kind_sig :: { Located (Maybe (LHsKind RdrName)) }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
728
        :                               { noLoc Nothing }
dreixel's avatar
dreixel committed
729
        | '::' kind                     { LL (Just $2) }
730

731
-- tycl_hdr parses the header of a class or data type decl,
732
-- which takes the form
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
733 734 735 736
--      T a b
--      Eq a => T a
--      (Eq a, Ord b) => T a b
--      T Int [a]                       -- for associated types
737
-- Rather a lot of inlining here, else we get reduce/reduce errors
738
tycl_hdr :: { Located (Maybe (LHsContext RdrName), LHsType RdrName) }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
739 740
        : context '=>' type             { LL (Just $1, $3) }
        | type                          { L1 (Nothing, $1) }
741

742 743 744 745 746
-----------------------------------------------------------------------------
-- Stand-alone deriving

-- Glasgow extension: stand-alone deriving declarations
stand_alone_deriving :: { LDerivDecl RdrName }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
747
        : 'deriving' 'instance' inst_type { LL (DerivDecl $3) }
748

749 750 751
-----------------------------------------------------------------------------
-- Nested declarations

752
-- Declaration in class bodies
753
--
754
decl_cls  :: { Located (OrdList (LHsDecl RdrName)) }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
755 756
decl_cls  : at_decl_cls                 { LL (unitOL (L1 (TyClD (unLoc $1)))) }
          | decl                        { $1 }
757

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
758
          -- A 'default' signature used with the generic-programming extension
759 760 761 762
          | 'default' infixexp '::' sigtypedoc
                    {% do { (TypeSig l ty) <- checkValSig $2 $4
                          ; return (LL $ unitOL (LL $ SigD (GenericSig l ty))) } }

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
763 764 765 766 767
decls_cls :: { Located (OrdList (LHsDecl RdrName)) }    -- Reversed
          : decls_cls ';' decl_cls      { LL (unLoc $1 `appOL` unLoc $3) }
          | decls_cls ';'               { LL (unLoc $1) }
          | decl_cls                    { $1 }
          | {- empty -}                 { noLoc nilOL }
768 769


770
decllist_cls
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
771 772 773
        :: { Located (OrdList (LHsDecl RdrName)) }      -- Reversed
        : '{'         decls_cls '}'     { LL (unLoc $2) }
        |     vocurly decls_cls close   { $2 }
774

775
-- Class body
776
--
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
777 778 779 780 781
where_cls :: { Located (OrdList (LHsDecl RdrName)) }    -- Reversed
                                -- No implicit parameters
                                -- May have type declarations
        : 'where' decllist_cls          { LL (unLoc $2) }
        | {- empty -}                   { noLoc nilOL }
782 783 784 785

-- Declarations in instance bodies
--
decl_inst  :: { Located (OrdList (LHsDecl RdrName)) }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
786 787
decl_inst  : at_decl_inst               { LL (unitOL (L1 (TyClD (unLoc $1)))) }
           | decl                       { $1 }
788

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
789 790 791 792 793
decls_inst :: { Located (OrdList (LHsDecl RdrName)) }   -- Reversed
           : decls_inst ';' decl_inst   { LL (unLoc $1 `appOL` unLoc $3) }
           | decls_inst ';'             { LL (unLoc $1) }
           | decl_inst                  { $1 }
           | {- empty -}                { noLoc nilOL }
794 795

decllist_inst 
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
796 797 798
        :: { Located (OrdList (LHsDecl RdrName)) }      -- Reversed
        : '{'         decls_inst '}'    { LL (unLoc $2) }
        |     vocurly decls_inst close  { $2 }
799 800 801

-- Instance body
--
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
802 803 804 805 806
where_inst :: { Located (OrdList (LHsDecl RdrName)) }   -- Reversed
                                -- No implicit parameters
                                -- May have type declarations
        : 'where' decllist_inst         { LL (unLoc $2) }
        | {- empty -}                   { noLoc nilOL }
807

808 809
-- Declarations in binding groups other than classes and instances
--
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
810 811
decls   :: { Located (OrdList (LHsDecl RdrName)) }      
        : decls ';' decl                { let { this = unLoc $3;
Ian Lynagh's avatar
Ian Lynagh committed
812
                                    rest = unLoc $1;
Ian Lynagh's avatar
Ian Lynagh committed
813
                                    these = rest `appOL` this }
Ian Lynagh's avatar
Ian Lynagh committed
814 815
                              in rest `seq` this `seq` these `seq`
                                    LL these }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
816 817 818
        | decls ';'                     { LL (unLoc $1) }
        | decl                          { $1 }
        | {- empty -}                   { noLoc nilOL }
819

820
decllist :: { Located (OrdList (LHsDecl RdrName)) }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
821 822
        : '{'            decls '}'      { LL (unLoc $2) }
        |     vocurly    decls close    { $2 }
823

824 825
-- Binding groups other than those of class and instance declarations
--
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
826 827 828 829 830
binds   ::  { Located (HsLocalBinds RdrName) }          -- May have implicit parameters
                                                -- No type declarations
        : decllist                      { L1 (HsValBinds (cvBindGroup (unLoc $1))) }
        | '{'            dbinds '}'     { LL (HsIPBinds (IPBinds (unLoc $2) emptyTcEvBinds)) }
        |     vocurly    dbinds close   { L (getLoc $2) (HsIPBinds (IPBinds (unLoc $2) emptyTcEvBinds)) }
831

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
832 833 834 835
wherebinds :: { Located (HsLocalBinds RdrName) }        -- May have implicit parameters
                                                -- No type declarations
        : 'where' binds                 { LL (unLoc $2) }
        | {- empty -}                   { noLoc emptyLocalBinds }
836 837 838 839 840


-----------------------------------------------------------------------------
-- Transformation Rules

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
841 842 843 844 845
rules   :: { OrdList (LHsDecl RdrName) }
        :  rules ';' rule                       { $1 `snocOL` $3 }
        |  rules ';'                            { $1 }
        |  rule                                 { unitOL $1 }
        |  {- empty -}                          { nilOL }
846

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
847 848 849 850 851
rule    :: { LHsDecl RdrName }
        : STRING activation rule_forall infixexp '=' exp
             { LL $ RuleD (HsRule (getSTRING $1) 
                                  ($2 `orElse` AlwaysActive) 
                                  $3 $4 placeHolderNames $6 placeHolderNames) }
852

853 854 855
activation :: { Maybe Activation } 
        : {- empty -}                           { Nothing }
        | explicit_activation                   { Just $1 }
856 857

explicit_activation :: { Activation }  -- In brackets
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
858 859
        : '[' INTEGER ']'               { ActiveAfter  (fromInteger (getINTEGER $2)) }
        | '[' '~' INTEGER ']'           { ActiveBefore (fromInteger (getINTEGER $3)) }
860 861

rule_forall :: { [RuleBndr RdrName] }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
862 863
        : 'forall' rule_var_list '.'            { $2 }
        | {- empty -}                           { [] }
864 865

rule_var_list :: { [RuleBndr RdrName] }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
866 867
        : rule_var                              { [$1] }
        | rule_var rule_var_list                { $1 : $2 }
868 869

rule_var :: { RuleBndr RdrName }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
870 871
        : varid                                 { RuleBndr $1 }
        | '(' varid '::' ctype ')'              { RuleBndrSig $2 $4 }
872 873

-----------------------------------------------------------------------------
Ian Lynagh's avatar
Ian Lynagh committed
874 875 876
-- Warnings and deprecations (c.f. rules)

warnings :: { OrdList (LHsDecl RdrName) }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
877 878 879 880
        : warnings ';' warning          { $1 `appOL` $3 }
        | warnings ';'                  { $1 }
        | warning                               { $1 }
        | {- empty -}                           { nilOL }
Ian Lynagh's avatar
Ian Lynagh committed
881 882 883

-- SUP: TEMPORARY HACK, not checking for `module Foo'
warning :: { OrdList (LHsDecl RdrName) }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
884 885 886
        : namelist strings
                { toOL [ LL $ WarningD (Warning n (WarningTxt $ unLoc $2))
                       | n <- unLoc $1 ] }
887

888
deprecations :: { OrdList (LHsDecl RdrName) }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
889 890 891 892
        : deprecations ';' deprecation          { $1 `appOL` $3 }
        | deprecations ';'                      { $1 }
        | deprecation                           { $1 }
        | {- empty -}                           { nilOL }
893 894

-- SUP: TEMPORARY HACK, not checking for `module Foo'
895
deprecation :: { OrdList (LHsDecl RdrName) }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
896 897 898
        : namelist strings
                { toOL [ LL $ WarningD (Warning n (DeprecatedTxt $ unLoc $2))
                       | n <- unLoc $1 ] }
899

900 901 902 903 904 905 906 907
strings :: { Located [FastString] }
    : STRING { L1 [getSTRING $1] }
    | '[' stringlist ']' { LL $ fromOL (unLoc $2) }

stringlist :: { Located (OrdList FastString) }
    : stringlist ',' STRING { LL (unLoc $1 `snocOL` getSTRING $3) }
    | STRING                { LL (unitOL (getSTRING $1)) }

908 909 910 911 912 913 914
-----------------------------------------------------------------------------
-- Annotations
annotation :: { LHsDecl RdrName }
    : '{-# ANN' name_var aexp '#-}'      { LL (AnnD $ HsAnnotation (ValueAnnProvenance (unLoc $2)) $3) }
    | '{-# ANN' 'type' tycon aexp '#-}'  { LL (AnnD $ HsAnnotation (TypeAnnProvenance (unLoc $3)) $4) }
    | '{-# ANN' 'module' aexp '#-}'      { LL (AnnD $ HsAnnotation ModuleAnnProvenance $3) }

915 916 917 918 919

-----------------------------------------------------------------------------
-- Foreign import and export declarations

fdecl :: { LHsDecl RdrName }
Simon Marlow's avatar
Simon Marlow committed
920
fdecl : 'import' callconv safety fspec
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
921 922 923 924
                {% mkImport $2 $3 (unLoc $4) >>= return.LL }
      | 'import' callconv        fspec          
                {% do { d <- mkImport $2 PlaySafe (unLoc $3);
                        return (LL d) } }
925
      | 'export' callconv fspec
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
926
                {% mkExport $2 (unLoc $3) >>= return.LL }
927

928
callconv :: { CCallConv }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
929 930
          : 'stdcall'                   { StdCallConv }
          | 'ccall'                     { CCallConv   }
931
          | 'capi'                      { CApiConv    }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
932
          | 'prim'                      { PrimCallConv}
933 934

safety :: { Safety }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
935 936 937
        : 'unsafe'                      { PlayRisky }
        | 'safe'                        { PlaySafe }
        | 'interruptible'               { PlayInterruptible }
938 939

fspec :: { Located (Located FastString, Located RdrName, LHsType RdrName) }
940 941
       : STRING var '::' sigtypedoc     { LL (L (getLoc $1) (getSTRING $1), $2, $4) }
       |        var '::' sigtypedoc     { LL (noLoc nilFS, $1, $3) }
942 943 944 945 946 947 948 949
         -- if the entity string is missing, it defaults to the empty string;
         -- the meaning of an empty entity string depends on the calling
         -- convention

-----------------------------------------------------------------------------
-- Type signatures

opt_sig :: { Maybe (LHsType RdrName) }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
950 951
        : {- empty -}                   { Nothing }
        | '::' sigtype                  { Just $2 }
952 953

opt_asig :: { Maybe (LHsType RdrName) }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
954 955
        : {- empty -}                   { Nothing }
        | '::' atype                    { Just $2 }
956

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
957
sigtype :: { LHsType RdrName }          -- Always a HsForAllTy,
958
                                        -- to tell the renamer where to generalise
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
959 960
        : ctype                         { L1 (mkImplicitHsForAllTy (noLoc []) $1) }
        -- Wrap an Implicit forall if there isn't one there already
961

962
sigtypedoc :: { LHsType RdrName }       -- Always a HsForAllTy
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
963 964
        : ctypedoc                      { L1 (mkImplicitHsForAllTy (noLoc []) $1) }
        -- Wrap an Implicit forall if there isn't one there already
965

966
sig_vars :: { Located [Located RdrName] }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
967 968
         : sig_vars ',' var             { LL ($3 : unLoc $1) }
         | var                          { L1 [$1] }
969

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
970 971 972
sigtypes1 :: { [LHsType RdrName] }      -- Always HsForAllTys
        : sigtype                       { [ $1 ] }
        | sigtype ',' sigtypes1         { $1 : $3 }
973

974 975 976
-----------------------------------------------------------------------------
-- Types

977
infixtype :: { LHsType RdrName }
dreixel's avatar
dreixel committed
978 979
        : btype qtyconop type         { LL $ mkHsOpTy $1 $2 $3 }
        | btype tyvarop  type    { LL $ mkHsOpTy $1 $2 $3 }
980

981
strict_mark :: { Located HsBang }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
982 983
        : '!'                           { L1 HsStrict }
        | '{-# UNPACK' '#-}' '!'        { LL HsUnpack }
984
        | '{-# NOUNPACK' '#-}' '!'      { LL HsNoUnpack }
985

986
-- A ctype is a for-all type
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
987 988 989 990 991 992
ctype   :: { LHsType RdrName }
        : 'forall' tv_bndrs '.' ctype   { LL $ mkExplicitHsForAllTy $2 (noLoc []) $4 }
        | context '=>' ctype            { LL $ mkImplicitHsForAllTy   $1 $3 }
        -- A type of form (context => type) is an *implicit* HsForAllTy
        | ipvar '::' type               { LL (HsIParamTy (unLoc $1) $3) }
        | type                          { $1 }
993

994 995 996 997 998 999 1000 1001 1002 1003 1004
----------------------
-- Notes for 'ctypedoc'
-- It would have been nice to simplify the grammar by unifying `ctype` and 
-- ctypedoc` into one production, allowing comments on types everywhere (and
-- rejecting them after parsing, where necessary).  This is however not possible
-- since it leads to ambiguity. The reason is the support for comments on record
-- fields: 
--         data R = R { field :: Int -- ^ comment on the field }
-- If we allow comments on types here, it's not clear if the comment applies
-- to 'field' or to 'Int'. So we must use `ctype` to describe the type.

1005
ctypedoc :: { LHsType RdrName }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
1006 1007 1008 1009 1010
        : 'forall' tv_bndrs '.' ctypedoc        { LL $ mkExplicitHsForAllTy $2 (noLoc []) $4 }
        | context '=>' ctypedoc         { LL $ mkImplicitHsForAllTy   $1 $3 }
        -- A type of form (context => type) is an *implicit* HsForAllTy
        | ipvar '::' type               { LL (HsIParamTy (unLoc $1) $3) }
        | typedoc                       { $1 }
1011

1012 1013
----------------------
-- Notes for 'context'
1014 1015
-- We parse a context as a btype so that we don't get reduce/reduce
-- errors in ctype.  The basic problem is that
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
1016
--      (Eq a, Ord a)
1017
-- looks so much like a tuple type.  We can't tell until we find the =>
1018

waern's avatar
waern committed
1019
-- We have the t1 ~ t2 form both in 'context' and in type, 
1020 1021
-- to permit an individual equational constraint without parenthesis.
-- Thus for some reason we allow    f :: a~b => blah
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
1022
-- but not                          f :: ?x::Int => blah
1023
context :: { LHsContext RdrName }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
1024 1025 1026
        : btype '~'      btype          {% checkContext
                                             (LL $ HsEqTy $1 $3) }
        | btype                         {% checkContext $1 }
1027

waern's avatar
waern committed
1028
type :: { LHsType RdrName }
1029
        : btype                         { $1 }
dreixel's avatar
dreixel committed
1030 1031
        | btype qtyconop type           { LL $ mkHsOpTy $1 $2 $3 }
        | btype tyvarop  type           { LL $ mkHsOpTy $1 $2 $3 }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
1032 1033
        | btype '->'     ctype          { LL $ HsFunTy $1 $3 }
        | btype '~'      btype          { LL $ HsEqTy $1 $3 }
dreixel's avatar
dreixel committed
1034 1035 1036
                                        -- see Note [Promotion]
        | btype SIMPLEQUOTE qconop type     { LL $ mkHsOpTy $1 $3 $4 }
        | btype SIMPLEQUOTE varop  type     { LL $ mkHsOpTy $1 $3 $4 }
1037

waern's avatar
waern committed
1038
typedoc :: { LHsType RdrName }
1039 1040
        : btype                          { $1 }
        | btype docprev                  { LL $ HsDocTy $1 $2 }
dreixel's avatar
dreixel committed
1041 1042 1043 1044
        | btype qtyconop type            { LL $ mkHsOpTy $1 $2 $3 }
        | btype qtyconop type docprev    { LL $ HsDocTy (L (comb3 $1 $2 $3) (mkHsOpTy $1 $2 $3)) $4 }
        | btype tyvarop  type            { LL $ mkHsOpTy $1 $2 $3 }
        | btype tyvarop  type docprev    { LL $ HsDocTy (L (comb3 $1 $2 $3) (mkHsOpTy $1 $2 $3)) $4 }
1045 1046
        | btype '->'     ctypedoc        { LL $ HsFunTy $1 $3 }
        | btype docprev '->' ctypedoc    { LL $ HsFunTy (L (comb2 $1 $2) (HsDocTy $1 $2)) $4 }
batterseapower's avatar
batterseapower committed
1047
        | btype '~'      btype           { LL $ HsEqTy $1 $3 }
1048

1049
btype :: { LHsType RdrName }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
1050 1051
        : btype atype                   { LL $ HsAppTy $1 $2 }
        | atype                         { $1 }
1052 1053

atype :: { LHsType RdrName }
1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069
        : ntgtycon                       { L1 (HsTyVar (unLoc $1)) }      -- Not including unit tuples
        | tyvar                          { L1 (HsTyVar (unLoc $1)) }      -- (See Note [Unit tuples])
        | strict_mark atype              { LL (HsBangTy (unLoc $1) $2) }  -- Constructor sigs only
        | '{' fielddecls '}'             {% checkRecordSyntax (LL $ HsRecTy $2) } -- Constructor sigs only
        | '(' ')'                        { LL $ HsTupleTy HsBoxedOrConstraintTuple []      }
        | '(' ctype ',' comma_types1 ')' { LL $ HsTupleTy HsBoxedOrConstraintTuple ($2:$4) }
        | '(#' '#)'                      { LL $ HsTupleTy HsUnboxedTuple           []      }       
        | '(#' comma_types1 '#)'         { LL $ HsTupleTy HsUnboxedTuple           $2      }
        | '[' ctype ']'                  { LL $ HsListTy  $2 }
        | '[:' ctype ':]'                { LL $ HsPArrTy  $2 }
        | '(' ctype ')'                  { LL $ HsParTy   $2 }
        | '(' ctype '::' kind ')'        { LL $ HsKindSig $2 $4 }
        | quasiquote                     { L1 (HsQuasiQuoteTy (unLoc $1)) }
        | '$(' exp ')'                   { LL $ mkHsSpliceTy $2 }
        | TH_ID_SPLICE                   { LL $ mkHsSpliceTy $ L1 $ HsVar $
                                           mkUnqual varName (getTH_ID_SPLICE $1) }
dreixel's avatar
dreixel committed
1070 1071 1072 1073 1074 1075
                                                      -- see Note [Promotion] for the followings
        | SIMPLEQUOTE qconid                          { LL $ HsTyVar $ unLoc $2 }
        | SIMPLEQUOTE  '(' ')'                        { LL $ HsTyVar $ getRdrName unitDataCon }
        | SIMPLEQUOTE  '(' ctype ',' comma_types1 ')' { LL $ HsExplicitTupleTy [] ($3 : $5) }
        | SIMPLEQUOTE  '[' comma_types0 ']'           { LL $ HsExplicitListTy placeHolderKind $3 }
        | '[' ctype ',' comma_types1 ']'              { LL $ HsExplicitListTy placeHolderKind ($2 : $4) }
1076
        | INTEGER                       { LL $ HsNumberTy $ getINTEGER $1 }
1077 1078

-- An inst_type is what occurs in the head of an instance decl
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
1079
--      e.g.  (Foo a, Gaz b) => Wibble a b
1080 1081 1082
-- It's kept as a single type, with a MonoDictTy at the right
-- hand corner, for convenience.
inst_type :: { LHsType RdrName }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
1083
        : sigtype                       { $1 }
1084

1085
inst_types1 :: { [LHsType RdrName] }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
1086 1087
        : inst_type                     { [$1] }
        | inst_type ',' inst_types1     { $1 : $3 }
1088

1089
comma_types0  :: { [LHsType RdrName] }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
1090 1091
        : comma_types1                  { $1 }
        | {- empty -}                   { [] }
1092

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
1093 1094 1095
comma_types1    :: { [LHsType RdrName] }
        : ctype                         { [$1] }
        | ctype  ',' comma_types1       { $1 : $3 }
1096 1097

tv_bndrs :: { [LHsTyVarBndr RdrName] }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
1098 1099
         : tv_bndr tv_bndrs             { $1 : $2 }
         | {- empty -}                  { [] }
1100 1101

tv_bndr :: { LHsTyVarBndr RdrName }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
1102
        : tyvar                         { L1 (UserTyVar (unLoc $1) placeHolderKind) }
dreixel's avatar
dreixel committed
1103
        | '(' tyvar '::' kind ')'       { LL (KindedTyVar (unLoc $2) $4 placeHolderKind) }