Parser.y.pp 73.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
--								-*-haskell-*-
-- ---------------------------------------------------------------------------
-- (c) The University of Glasgow 1997-2003
---
-- The GHC grammar.
--
-- Author(s): Simon Marlow, Sven Panne 1997, 1998, 1999
-- ---------------------------------------------------------------------------

{
11 12 13 14 15 16 17
{-# OPTIONS -w #-}
-- 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

18 19 20 21 22 23 24 25
{-# 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.
-}

26
module Parser ( parseModule, parseStmt, parseIdentifier, parseType,
27
		parseHeader ) where
28 29 30

import HsSyn
import RdrHsSyn
Ian Lynagh's avatar
Ian Lynagh committed
31
import HscTypes		( IsBootInterface, WarningTxt(..) )
32 33 34
import Lexer
import RdrName
import TysWiredIn	( unitTyCon, unitDataCon, tupleTyCon, tupleCon, nilDataCon,
35
			  unboxedSingletonTyCon, unboxedSingletonDataCon,
36 37
			  listTyCon_RDR, parrTyCon_RDR, consDataCon_RDR )
import Type		( funTyCon )
38
import ForeignCall	( Safety(..), CExportSpec(..), CLabelString,
39 40
			  CCallConv(..), CCallTarget(..), defaultCCallConv
			)
41
import OccName		( varName, dataName, tcClsName, tvName )
42 43
import DataCon		( DataCon, dataConName )
import SrcLoc		( Located(..), unLoc, getLoc, noLoc, combineSrcSpans,
44 45
			  SrcSpan, combineLocs, srcLocFile, 
			  mkSrcLoc, mkSrcSpan )
46
import Module
andy@galois.com's avatar
andy@galois.com committed
47
import StaticFlags	( opt_SccProfilingOn, opt_Hpc )
Simon Marlow's avatar
Simon Marlow committed
48
import Type		( Kind, mkArrowKind, liftedTypeKind, unliftedTypeKind )
49
import BasicTypes	( Boxity(..), Fixity(..), FixityDirection(..), IPName(..),
50
			  Activation(..), defaultInlineSpec )
51
import DynFlags
52
import OrdList
53 54 55
import HaddockParse
import {-# SOURCE #-} HaddockLex hiding ( Token )
import HaddockUtils
56 57 58 59

import FastString
import Maybes		( orElse )
import Outputable
60

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

{-
68 69 70 71 72 73 74 75 76 77 78
-----------------------------------------------------------------------------
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

79 80 81 82 83 84 85 86 87 88 89
-----------------------------------------------------------------------------
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

90 91 92 93 94 95 96 97 98 99 100
-----------------------------------------------------------------------------
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

101 102 103 104 105 106 107 108 109 110 111
-----------------------------------------------------------------------------
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

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

115
10 for abiguity in 'if x then y else z + 1'		[State 178]
116 117 118
	(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

119
1 for ambiguity in 'if x then y else z :: T'		[State 178]
120 121
	(shift parses as 'if x then y else (z :: T)', as per longest-parse rule)

122
4 for ambiguity in 'if x then y else z -< e'		[State 178]
123
	(shift parses as 'if x then y else (z -< T)', as per longest-parse rule)
124 125 126 127 128 129 130 131 132 133
	There are four such operators: -<, >-, -<<, >>-


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
    or
	  case v of
	    (x::T -> T) -> ..	-- Rhs is ...
134

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

141
1 for ambiguity in 'let ?x ...'				[State 329]
142 143 144 145
	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.

146
1 for ambiguity in '{-# RULES "name" [ ... #-}		[State 382]
147 148 149 150
	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

151
1 for ambiguity in '{-# RULES "name" forall = ... #-}' 	[State 474]
152 153 154 155 156 157 158
	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'.

159 160 161 162
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.   

163 164 165 166 167 168 169 170 171 172 173
-- ---------------------------------------------------------------------------
-- 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.

   L0	adds 'noSrcSpan', used for empty productions
174
     -- This doesn't seem to work anymore -=chak
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 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

   L1   for a production with a single token on the lhs.  Grabs the SrcSpan
	from that token.

   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.

	| 'newtype' tycl_hdr '=' newconstr deriving
		{ L (comb3 $1 $4 $5)
		    (mkTyData NewType (unLoc $2) [$4] (unLoc $5)) }

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
 '_'            { 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

237
 'forall'	{ L _ ITforall }		-- GHC extension keywords
238 239 240 241 242 243 244 245
 'foreign'	{ L _ ITforeign }
 'export'	{ L _ ITexport }
 'label'	{ L _ ITlabel } 
 'dynamic'	{ L _ ITdynamic }
 'safe'		{ L _ ITsafe }
 'threadsafe'	{ L _ ITthreadsafe }
 'unsafe'	{ L _ ITunsafe }
 'mdo'		{ L _ ITmdo }
246
 'family'	{ L _ ITfamily }
247 248 249 250 251
 'stdcall'      { L _ ITstdcallconv }
 'ccall'        { L _ ITccallconv }
 'dotnet'       { L _ ITdotnet }
 '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 258
 '{-# INLINE'      	  { L _ (ITinline_prag _) }
 '{-# SPECIALISE'  	  { L _ ITspec_prag }
 '{-# SPECIALISE_INLINE'  { L _ (ITspec_inline_prag _) }
259 260 261 262
 '{-# SOURCE'	   { L _ ITsource_prag }
 '{-# RULES'	   { L _ ITrules_prag }
 '{-# CORE'        { L _ ITcore_prag }              -- hdaume: annotated core
 '{-# SCC'	   { L _ ITscc_prag }
andy@galois.com's avatar
andy@galois.com committed
263
 '{-# GENERATED'   { L _ ITgenerated_prag }
264
 '{-# DEPRECATED'  { L _ ITdeprecated_prag }
Ian Lynagh's avatar
Ian Lynagh committed
265
 '{-# WARNING'  { L _ ITwarning_prag }
266 267 268 269 270 271 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 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
 '{-# UNPACK'      { L _ ITunpack_prag }
 '#-}'		   { 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 _ 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 }
 '{|'           { L _ ITocurlybar }
 '|}'           { L _ ITccurlybar }
 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 }

 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  _) }
317 318
 PREFIXQVARSYM  { L _ (ITprefixqvarsym  _) }
 PREFIXQCONSYM  { L _ (ITprefixqconsym  _) }
319 320 321 322 323 324 325 326 327 328 329

 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    _) }
Ian Lynagh's avatar
Ian Lynagh committed
330
 PRIMWORD 	{ L _ (ITprimword  _) }
331 332
 PRIMFLOAT	{ L _ (ITprimfloat  _) }
 PRIMDOUBLE	{ L _ (ITprimdouble _) }
333 334 335 336 337 338

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

339 340 341 342 343 344 345 346 347 348
-- Template Haskell 
'[|'            { L _ ITopenExpQuote  }       
'[p|'           { L _ ITopenPatQuote  }      
'[t|'           { L _ ITopenTypQuote  }      
'[d|'           { L _ ITopenDecQuote  }      
'|]'            { L _ ITcloseQuote    }
TH_ID_SPLICE    { L _ (ITidEscape _)  }     -- $x
'$('	        { L _ ITparenEscape   }     -- $( exp )
TH_VAR_QUOTE	{ L _ ITvarQuote      }     -- 'x
TH_TY_QUOTE	{ L _ ITtyQuote       }      -- ''T
349
TH_QUASIQUOTE	{ L _ (ITquasiQuote _) }
350 351 352 353 354 355

%monad { P } { >>= } { return }
%lexer { lexer } { L _ ITeof }
%name parseModule module
%name parseStmt   maybe_stmt
%name parseIdentifier  identifier
356
%name parseType ctype
357
%partial parseHeader header
358
%tokentype { (Located Token) }
359 360
%%

361 362 363 364 365 366 367
-----------------------------------------------------------------------------
-- Identifiers; one of the entry points
identifier :: { Located RdrName }
	: qvar				{ $1 }
	| qcon				{ $1 }
	| qvarop			{ $1 }
	| qconop			{ $1 }
368
    | '(' '->' ')'      { LL $ getRdrName funTyCon }
369

370 371 372 373 374 375 376 377 378 379 380
-----------------------------------------------------------------------------
-- 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. :-)

module 	:: { Located (HsModule RdrName) }
Ian Lynagh's avatar
Ian Lynagh committed
381
 	: maybedocheader 'module' modid maybemodwarning maybeexports 'where' body
David Waern's avatar
David Waern committed
382 383 384
		{% fileSrcSpan >>= \ loc -> case $1 of { (info, doc) ->
		   return (L loc (HsModule (Just $3) $5 (fst $7) (snd $7) $4
                          info doc) )}}
385
        | body2
386
		{% fileSrcSpan >>= \ loc ->
David Waern's avatar
David Waern committed
387 388
		   return (L loc (HsModule Nothing Nothing
                          (fst $1) (snd $1) Nothing emptyHaddockModInfo
389 390
                          Nothing)) }

David Waern's avatar
David Waern committed
391
maybedocheader :: { (HaddockModInfo RdrName, Maybe (HsDoc RdrName)) }
392
        : moduleheader            { $1 }
David Waern's avatar
David Waern committed
393
        | {- empty -}             { (emptyHaddockModInfo, Nothing) }
394 395 396 397

missing_module_keyword :: { () }
	: {- empty -}				{% pushCurrentContext }

Ian Lynagh's avatar
Ian Lynagh committed
398 399 400 401
maybemodwarning :: { Maybe WarningTxt }
    : '{-# DEPRECATED' STRING '#-}' { Just (DeprecatedTxt (getSTRING $2)) }
    | '{-# WARNING' STRING '#-}'    { Just (WarningTxt (getSTRING $2)) }
    |  {- empty -}                  { Nothing }
402 403 404 405 406

body 	:: { ([LImportDecl RdrName], [LHsDecl RdrName]) }
	:  '{'            top '}'		{ $2 }
 	|      vocurly    top close		{ $2 }

407 408 409 410
body2 	:: { ([LImportDecl RdrName], [LHsDecl RdrName]) }
	:  '{' top '}'          		{ $2 }
 	|  missing_module_keyword top close     { $2 }

411 412 413 414 415 416 417 418
top 	:: { ([LImportDecl RdrName], [LHsDecl RdrName]) }
	: importdecls				{ (reverse $1,[]) }
	| importdecls ';' cvtopdecls		{ (reverse $1,$3) }
	| cvtopdecls				{ ([],$1) }

cvtopdecls :: { [LHsDecl RdrName] }
	: topdecls				{ cvTopDecls $1 }

419 420 421 422
-----------------------------------------------------------------------------
-- Module declaration & imports only

header 	:: { Located (HsModule RdrName) }
Ian Lynagh's avatar
Ian Lynagh committed
423
 	: maybedocheader 'module' modid maybemodwarning maybeexports 'where' header_body
David Waern's avatar
David Waern committed
424 425 426
		{% fileSrcSpan >>= \ loc -> case $1 of { (info, doc) ->
		   return (L loc (HsModule (Just $3) $5 $7 [] $4
                   info doc))}}
427 428
	| missing_module_keyword importdecls
		{% fileSrcSpan >>= \ loc ->
David Waern's avatar
David Waern committed
429 430
		   return (L loc (HsModule Nothing Nothing $2 [] Nothing
                   emptyHaddockModInfo Nothing)) }
431 432 433 434 435

header_body :: { [LImportDecl RdrName] }
	:  '{'            importdecls		{ $2 }
 	|      vocurly    importdecls		{ $2 }

436 437 438 439 440 441 442
-----------------------------------------------------------------------------
-- The Export List

maybeexports :: { Maybe [LIE RdrName] }
	:  '(' exportlist ')'			{ Just $2 }
	|  {- empty -}				{ Nothing }

443 444
exportlist :: { [LIE RdrName] }
	: expdoclist ',' expdoclist		{ $1 ++ $3 }
445 446 447
	| exportlist1				{ $1 }

exportlist1 :: { [LIE RdrName] }
448 449 450 451 452 453 454 455 456 457 458 459 460
        : expdoclist export expdoclist ',' exportlist  { $1 ++ ($2 : $3) ++ $5 }
 	| expdoclist export expdoclist	               { $1 ++ ($2 : $3) }
	| expdoclist				       { $1 }

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)) }       
                       
461 462 463 464 465 466 467 468 469 470 471
   -- No longer allow things like [] and (,,,) to be exported
   -- They are built in syntax, always available
export 	:: { LIE RdrName }
	:  qvar				{ L1 (IEVar (unLoc $1)) }
	|  oqtycon			{ L1 (IEThingAbs (unLoc $1)) }
	|  oqtycon '(' '..' ')'		{ LL (IEThingAll (unLoc $1)) }
	|  oqtycon '(' ')'		{ LL (IEThingWith (unLoc $1) []) }
	|  oqtycon '(' qcnames ')'	{ LL (IEThingWith (unLoc $1) (reverse $3)) }
	|  'module' modid		{ LL (IEModuleContents (unLoc $2)) }

qcnames :: { [RdrName] }
472 473
	:  qcnames ',' qcname_ext	{ unLoc $3 : $1 }
	|  qcname_ext			{ [unLoc $1]  }
474

475 476 477 478 479 480 481 482
qcname_ext :: { Located RdrName }	-- Variable or data constructor
					-- or tagged type constructor
	:  qcname			{ $1 }
	|  'type' qcon			{ sL (comb2 $1 $2) 
					     (setRdrNameSpace (unLoc $2) 
							      tcClsName)  }

-- Cannot pull into qcname_ext, as qcname is also used in expression.
483
qcname 	:: { Located RdrName }	-- Variable or data constructor
484 485
	:  qvar				{ $1 }
	|  qcon				{ $1 }
486 487 488 489 490 491 492 493 494 495 496 497 498 499

-----------------------------------------------------------------------------
-- 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] }
	: importdecls ';' importdecl		{ $3 : $1 }
	| importdecls ';'			{ $1 }
	| importdecl				{ [ $1 ] }
	| {- empty -}				{ [] }

importdecl :: { LImportDecl RdrName }
500 501
	: 'import' maybe_src optqualified maybe_pkg modid maybeas maybeimpspec 
		{ L (comb4 $1 $5 $6 $7) (ImportDecl $5 $4 $2 $3 (unLoc $6) (unLoc $7)) }
502 503 504 505 506

maybe_src :: { IsBootInterface }
	: '{-# SOURCE' '#-}'			{ True }
	| {- empty -}				{ False }

507 508 509 510
maybe_pkg :: { Maybe FastString }
        : STRING                                { Just (getSTRING $1) }
        | {- empty -}                           { Nothing }

511 512 513 514
optqualified :: { Bool }
      	: 'qualified'                           { True  }
      	| {- empty -}				{ False }

Simon Marlow's avatar
Simon Marlow committed
515
maybeas :: { Located (Maybe ModuleName) }
516 517 518 519 520 521 522 523
      	: 'as' modid                            { LL (Just (unLoc $2)) }
      	| {- empty -}				{ noLoc Nothing }

maybeimpspec :: { Located (Maybe (Bool, [LIE RdrName])) }
	: impspec				{ L1 (Just (unLoc $1)) }
	| {- empty -}				{ noLoc Nothing }

impspec :: { Located (Bool, [LIE RdrName]) }
524 525
	:  '(' exportlist ')'  			{ LL (False, $2) }
	|  'hiding' '(' exportlist ')' 		{ LL (True,  $3) }
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545

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

prec 	:: { Int }
	: {- empty -}		{ 9 }
	| INTEGER		{% checkPrecP (L1 (fromInteger (getINTEGER $1))) }

infix 	:: { Located FixityDirection }
	: 'infix'				{ L1 InfixN  }
	| 'infixl'				{ L1 InfixL  }
	| 'infixr'				{ L1 InfixR }

ops   	:: { Located [Located RdrName] }
	: ops ',' op				{ LL ($3 : unLoc $1) }
	| op					{ L1 [$1] }

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

546
topdecls :: { OrdList (LHsDecl RdrName) }
547 548 549
        : topdecls ';' topdecl		        { $1 `appOL` $3 }
        | topdecls ';'			        { $1 }
	| topdecl			        { $1 }
550

551
topdecl :: { OrdList (LHsDecl RdrName) }
552
  	: cl_decl			{ unitOL (L1 (TyClD (unLoc $1))) }
chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
553
  	| ty_decl			{ unitOL (L1 (TyClD (unLoc $1))) }
554 555 556 557
	| '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)))}
558
        | stand_alone_deriving                  { unitOL (LL (DerivD (unLoc $1))) }
559 560
	| 'default' '(' comma_types0 ')'	{ unitOL (LL $ DefD (DefaultDecl $3)) }
	| 'foreign' fdecl			{ unitOL (LL (unLoc $2)) }
Ian Lynagh's avatar
Ian Lynagh committed
561 562
    | '{-# DEPRECATED' deprecations '#-}' { $2 }
    | '{-# WARNING' warnings '#-}'        { $2 }
563
	| '{-# RULES' rules '#-}'		{ $2 }
564 565
      	| decl					{ unLoc $1 }

566 567 568 569 570 571
	-- Template Haskell Extension
	| '$(' exp ')'				{ unitOL (LL $ SpliceD (SpliceDecl $2)) }
	| TH_ID_SPLICE				{ unitOL (LL $ SpliceD (SpliceDecl $
							L1 $ HsVar (mkUnqual varName (getTH_ID_SPLICE $1))
						  )) }

572 573 574
-- Type classes
--
cl_decl :: { LTyClDecl RdrName }
575
	: 'class' tycl_hdr fds where_cls
576
		{% do { let { (binds, sigs, ats, docs)           = 
577
			        cvBindsAndSigs (unLoc $4)
578
		            ; (ctxt, tc, tvs, tparms) = unLoc $2}
579
                      ; checkTyVars tparms      -- only type vars allowed
580
		      ; checkKindSigs ats
581 582
		      ; return $ L (comb4 $1 $2 $3 $4) 
				   (mkClassDecl (ctxt, tc, tvs) 
583
					        (unLoc $3) sigs binds ats docs) } }
584

585
-- Type declarations (toplevel)
586 587
--
ty_decl :: { LTyClDecl RdrName }
588 589 590 591 592 593
           -- ordinary type synonyms
        : 'type' type '=' ctype
		-- 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
594 595
	        --
		-- Note the use of type for the head; this allows
596 597 598
		-- infix type constructors to be declared 
 		{% do { (tc, tvs, _) <- checkSynHdr $2 False
		      ; return (L (comb2 $1 $4) 
599
				  (TySynonym tc tvs Nothing $4))
600 601 602
                      } }

           -- type family declarations
603
        | 'type' 'family' type opt_kind_sig 
604 605
		-- Note the use of type for the head; this allows
		-- infix type constructors to be declared
606
		--
607 608
 		{% do { (tc, tvs, _) <- checkSynHdr $3 False
		      ; return (L (comb3 $1 $3 $4) 
609
				  (TyFamily TypeFamily tc tvs (unLoc $4)))
610 611 612 613 614 615 616 617 618 619 620
		      } }

           -- type instance declarations
        | 'type' 'instance' type '=' ctype
		-- Note the use of type for the head; this allows
		-- infix type constructors and type patterns
		--
 		{% do { (tc, tvs, typats) <- checkSynHdr $3 True
		      ; return (L (comb2 $1 $5) 
				  (TySynonym tc tvs (Just typats) $5)) 
                      } }
621

622
          -- ordinary data type or newtype declaration
623
	| data_or_newtype tycl_hdr constrs deriving
624
		{% do { let {(ctxt, tc, tvs, tparms) = unLoc $2}
625
                      ; checkTyVars tparms    -- no type pattern
626 627
		      ; return $!
			  sL (comb4 $1 $2 $3 $4)
628 629
			           -- We need the location on tycl_hdr in case 
				   -- constrs and deriving are both empty
630 631
			    (mkTyData (unLoc $1) (ctxt, tc, tvs, Nothing) 
			       Nothing (reverse (unLoc $3)) (unLoc $4)) } }
632

633
          -- ordinary GADT declaration
634
        | data_or_newtype tycl_hdr opt_kind_sig 
635
		 'where' gadt_constrlist
636
		 deriving
637
		{% do { let {(ctxt, tc, tvs, tparms) = unLoc $2}
638
                      ; checkTyVars tparms    -- can have type pats
639 640
		      ; return $!
			  sL (comb4 $1 $2 $4 $5)
641 642
			    (mkTyData (unLoc $1) (ctxt, tc, tvs, Nothing) 
			      (unLoc $3) (reverse (unLoc $5)) (unLoc $6)) } }
643

644
          -- data/newtype family
645
        | 'data' 'family' tycl_hdr opt_kind_sig
646
		{% do { let {(ctxt, tc, tvs, tparms) = unLoc $3}
647 648 649 650
                      ; checkTyVars tparms            -- no type pattern
		      ; unless (null (unLoc ctxt)) $  -- and no context
			  parseError (getLoc ctxt) 
			    "A family declaration cannot have a context"
651
		      ; return $
652
			  L (comb3 $1 $2 $4)
653
			    (TyFamily DataFamily tc tvs (unLoc $4)) } }
654

655
          -- data/newtype instance declaration
656 657 658 659 660 661 662 663 664 665
	| data_or_newtype 'instance' tycl_hdr constrs deriving
		{% do { let {(ctxt, tc, tvs, tparms) = unLoc $3}
                                             -- can have type pats
		      ; return $
			  L (comb4 $1 $3 $4 $5)
			           -- We need the location on tycl_hdr in case 
				   -- constrs and deriving are both empty
			    (mkTyData (unLoc $1) (ctxt, tc, tvs, Just tparms) 
			      Nothing (reverse (unLoc $4)) (unLoc $5)) } }

666
          -- GADT instance declaration
667 668 669 670 671 672 673 674
        | data_or_newtype 'instance' tycl_hdr opt_kind_sig 
		 'where' gadt_constrlist
		 deriving
		{% do { let {(ctxt, tc, tvs, tparms) = unLoc $3}
                                             -- can have type pats
		      ; return $
			  L (comb4 $1 $3 $6 $7)
			    (mkTyData (unLoc $1) (ctxt, tc, tvs, Just tparms) 
675
			       (unLoc $4) (reverse (unLoc $6)) (unLoc $7)) } }
676

677 678 679 680 681 682 683 684
-- Associate type family declarations
--
-- * 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. 
685
--
686
at_decl_cls :: { LTyClDecl RdrName }
687
           -- type family declarations
688
        : 'type' type opt_kind_sig
689 690 691
		-- Note the use of type for the head; this allows
		-- infix type constructors to be declared
		--
692 693
 		{% do { (tc, tvs, _) <- checkSynHdr $2 False
		      ; return (L (comb3 $1 $2 $3) 
694
				  (TyFamily TypeFamily tc tvs (unLoc $3)))
695 696
		      } }

697
           -- default type instance
698
        | 'type' type '=' ctype
699 700 701
		-- Note the use of type for the head; this allows
		-- infix type constructors and type patterns
		--
702 703 704
 		{% do { (tc, tvs, typats) <- checkSynHdr $2 True
		      ; return (L (comb2 $1 $4) 
				  (TySynonym tc tvs (Just typats) $4)) 
705 706
                      } }

707
          -- data/newtype family declaration
708
        | 'data' tycl_hdr opt_kind_sig
709
		{% do { let {(ctxt, tc, tvs, tparms) = unLoc $2}
710 711 712 713
                      ; checkTyVars tparms            -- no type pattern
		      ; unless (null (unLoc ctxt)) $  -- and no context
			  parseError (getLoc ctxt) 
			    "A family declaration cannot have a context"
714
		      ; return $
715
			  L (comb3 $1 $2 $3)
716
			    (TyFamily DataFamily tc tvs (unLoc $3)) 
717
                      } }
718 719 720 721 722 723 724 725 726 727 728 729 730

-- Associate type instances
--
at_decl_inst :: { LTyClDecl RdrName }
           -- type instance declarations
        : 'type' type '=' ctype
		-- Note the use of type for the head; this allows
		-- infix type constructors and type patterns
		--
 		{% do { (tc, tvs, typats) <- checkSynHdr $2 True
		      ; return (L (comb2 $1 $4) 
				  (TySynonym tc tvs (Just typats) $4)) 
                      } }
731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751

        -- data/newtype instance declaration
	| data_or_newtype tycl_hdr constrs deriving
		{% do { let {(ctxt, tc, tvs, tparms) = unLoc $2}
                                             -- can have type pats
		      ; return $
			  L (comb4 $1 $2 $3 $4)
			           -- We need the location on tycl_hdr in case 
				   -- constrs and deriving are both empty
			    (mkTyData (unLoc $1) (ctxt, tc, tvs, Just tparms) 
			      Nothing (reverse (unLoc $3)) (unLoc $4)) } }

        -- GADT instance declaration
        | data_or_newtype tycl_hdr opt_kind_sig 
		 'where' gadt_constrlist
		 deriving
		{% do { let {(ctxt, tc, tvs, tparms) = unLoc $2}
                                             -- can have type pats
		      ; return $
			  L (comb4 $1 $2 $5 $6)
			    (mkTyData (unLoc $1) (ctxt, tc, tvs, Just tparms) 
752
			     (unLoc $3) (reverse (unLoc $5)) (unLoc $6)) } }
753

754 755 756 757
data_or_newtype :: { Located NewOrData }
	: 'data'	{ L1 DataType }
	| 'newtype'	{ L1 NewType }

758 759 760
opt_kind_sig :: { Located (Maybe Kind) }
	: 				{ noLoc Nothing }
	| '::' kind			{ LL (Just (unLoc $2)) }
761

762
-- tycl_hdr parses the header of a class or data type decl,
763 764 765 766
-- which takes the form
--	T a b
-- 	Eq a => T a
--	(Eq a, Ord b) => T a b
767
--      T Int [a]			-- for associated types
768
-- Rather a lot of inlining here, else we get reduce/reduce errors
769 770 771
tycl_hdr :: { Located (LHsContext RdrName, 
		       Located RdrName, 
		       [LHsTyVarBndr RdrName],
772
		       [LHsType RdrName]) }
773
	: context '=>' type		{% checkTyClHdr $1         $3 >>= return.LL }
774 775
	| type				{% checkTyClHdr (noLoc []) $1 >>= return.L1 }

776 777 778 779 780
-----------------------------------------------------------------------------
-- Stand-alone deriving

-- Glasgow extension: stand-alone deriving declarations
stand_alone_deriving :: { LDerivDecl RdrName }
781
  	: 'deriving' 'instance' inst_type {% checkDerivDecl (LL (DerivDecl $3)) }
782

783 784 785
-----------------------------------------------------------------------------
-- Nested declarations

786
-- Declaration in class bodies
787
--
788 789 790 791 792 793 794 795 796
decl_cls  :: { Located (OrdList (LHsDecl RdrName)) }
decl_cls  : at_decl_cls		        { LL (unitOL (L1 (TyClD (unLoc $1)))) }
	  | decl                        { $1 }

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 }
797 798


799
decllist_cls
800
        :: { Located (OrdList (LHsDecl RdrName)) }	-- Reversed
801 802
	: '{'         decls_cls '}'	{ LL (unLoc $2) }
	|     vocurly decls_cls close	{ $2 }
803

804
-- Class body
805
--
806
where_cls :: { Located (OrdList (LHsDecl RdrName)) }	-- Reversed
807 808
				-- No implicit parameters
				-- May have type declarations
809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834
	: 'where' decllist_cls	        { LL (unLoc $2) }
	| {- empty -}		        { noLoc nilOL }

-- Declarations in instance bodies
--
decl_inst  :: { Located (OrdList (LHsDecl RdrName)) }
decl_inst  : at_decl_inst	        { LL (unitOL (L1 (TyClD (unLoc $1)))) }
	   | decl                       { $1 }

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 }

decllist_inst 
        :: { Located (OrdList (LHsDecl RdrName)) }	-- Reversed
	: '{'         decls_inst '}'	{ LL (unLoc $2) }
	|     vocurly decls_inst close	{ $2 }

-- Instance body
--
where_inst :: { Located (OrdList (LHsDecl RdrName)) }	-- Reversed
				-- No implicit parameters
				-- May have type declarations
	: 'where' decllist_inst		{ LL (unLoc $2) }
835 836
	| {- empty -}			{ noLoc nilOL }

837 838
-- Declarations in binding groups other than classes and instances
--
839
decls 	:: { Located (OrdList (LHsDecl RdrName)) }	
Ian Lynagh's avatar
Ian Lynagh committed
840 841
	: decls ';' decl		{ let { this = unLoc $3;
                                    rest = unLoc $1;
Ian Lynagh's avatar
Ian Lynagh committed
842
                                    these = rest `appOL` this }
Ian Lynagh's avatar
Ian Lynagh committed
843 844
                              in rest `seq` this `seq` these `seq`
                                    LL these }
845
	| decls ';'			{ LL (unLoc $1) }
846
	| decl				{ $1 }
847
	| {- empty -}			{ noLoc nilOL }
848

849
decllist :: { Located (OrdList (LHsDecl RdrName)) }
850 851 852
	: '{'            decls '}'	{ LL (unLoc $2) }
	|     vocurly    decls close	{ $2 }

853 854
-- Binding groups other than those of class and instance declarations
--
855
binds 	::  { Located (HsLocalBinds RdrName) } 		-- May have implicit parameters
856
						-- No type declarations
857 858 859
	: decllist			{ L1 (HsValBinds (cvBindGroup (unLoc $1))) }
	| '{'            dbinds '}'	{ LL (HsIPBinds (IPBinds (unLoc $2) emptyLHsBinds)) }
	|     vocurly    dbinds close	{ L (getLoc $2) (HsIPBinds (IPBinds (unLoc $2) emptyLHsBinds)) }
860

861
wherebinds :: { Located (HsLocalBinds RdrName) }	-- May have implicit parameters
862
						-- No type declarations
863
	: 'where' binds			{ LL (unLoc $2) }
864
	| {- empty -}			{ noLoc emptyLocalBinds }
865 866 867 868 869


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

870
rules	:: { OrdList (LHsDecl RdrName) }
871
	:  rules ';' rule			{ $1 `snocOL` $3 }
872
        |  rules ';'				{ $1 }
873 874
        |  rule					{ unitOL $1 }
	|  {- empty -}				{ nilOL }
875

876
rule  	:: { LHsDecl RdrName }
877
	: STRING activation rule_forall infixexp '=' exp
878 879
	     { LL $ RuleD (HsRule (getSTRING $1) 
				  ($2 `orElse` AlwaysActive) 
880
				  $3 $4 placeHolderNames $6 placeHolderNames) }
881

882 883 884
activation :: { Maybe Activation } 
        : {- empty -}                           { Nothing }
        | explicit_activation                   { Just $1 }
885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902

explicit_activation :: { Activation }  -- In brackets
        : '[' INTEGER ']'		{ ActiveAfter  (fromInteger (getINTEGER $2)) }
        | '[' '~' INTEGER ']'		{ ActiveBefore (fromInteger (getINTEGER $3)) }

rule_forall :: { [RuleBndr RdrName] }
	: 'forall' rule_var_list '.'            { $2 }
        | {- empty -}				{ [] }

rule_var_list :: { [RuleBndr RdrName] }
        : rule_var				{ [$1] }
        | rule_var rule_var_list		{ $1 : $2 }

rule_var :: { RuleBndr RdrName }
	: varid                              	{ RuleBndr $1 }
       	| '(' varid '::' ctype ')'             	{ RuleBndrSig $2 $4 }

-----------------------------------------------------------------------------
Ian Lynagh's avatar
Ian Lynagh committed
903 904 905 906 907 908 909 910 911 912 913 914 915
-- Warnings and deprecations (c.f. rules)

warnings :: { OrdList (LHsDecl RdrName) }
	: warnings ';' warning		{ $1 `appOL` $3 }
	| warnings ';' 			{ $1 }
	| warning				{ $1 }
	| {- empty -}				{ nilOL }

-- SUP: TEMPORARY HACK, not checking for `module Foo'
warning :: { OrdList (LHsDecl RdrName) }
	: namelist STRING
		{ toOL [ LL $ WarningD (Warning n (WarningTxt (getSTRING $2)))
		       | n <- unLoc $1 ] }
916

917
deprecations :: { OrdList (LHsDecl RdrName) }
918
	: deprecations ';' deprecation		{ $1 `appOL` $3 }
919
	| deprecations ';' 			{ $1 }
920 921
	| deprecation				{ $1 }
	| {- empty -}				{ nilOL }
922 923

-- SUP: TEMPORARY HACK, not checking for `module Foo'
924
deprecation :: { OrdList (LHsDecl RdrName) }
Ian Lynagh's avatar
Ian Lynagh committed
925 926
	: namelist STRING
		{ toOL [ LL $ WarningD (Warning n (DeprecatedTxt (getSTRING $2)))
927
		       | n <- unLoc $1 ] }
928 929 930 931 932 933


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

fdecl :: { LHsDecl RdrName }
Simon Marlow's avatar
Simon Marlow committed
934
fdecl : 'import' callconv safety fspec
935
		{% mkImport $2 $3 (unLoc $4) >>= return.LL }
Simon Marlow's avatar
Simon Marlow committed
936
      | 'import' callconv        fspec		
937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952
		{% do { d <- mkImport $2 (PlaySafe False) (unLoc $3);
			return (LL d) } }
      | 'export' callconv fspec
		{% mkExport $2 (unLoc $3) >>= return.LL }

callconv :: { CallConv }
	  : 'stdcall'			{ CCall  StdCallConv }
	  | 'ccall'			{ CCall  CCallConv   }
	  | 'dotnet'			{ DNCall	     }

safety :: { Safety }
	: 'unsafe'			{ PlayRisky }
	| 'safe'			{ PlaySafe  False }
	| 'threadsafe'			{ PlaySafe  True }

fspec :: { Located (Located FastString, Located RdrName, LHsType RdrName) }
953 954
       : STRING var '::' sigtypedoc     { LL (L (getLoc $1) (getSTRING $1), $2, $4) }
       |        var '::' sigtypedoc     { LL (noLoc nilFS, $1, $3) }
955 956 957 958 959 960 961 962 963 964 965 966 967 968 969
         -- 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) }
	: {- empty -}			{ Nothing }
	| '::' sigtype			{ Just $2 }

opt_asig :: { Maybe (LHsType RdrName) }
	: {- empty -}			{ Nothing }
	| '::' atype			{ Just $2 }

970
sigtypes1 :: { [LHsType RdrName] }
971
	: sigtype			{ [ $1 ] }
972
	| sigtype ',' sigtypes1		{ $1 : $3 }
973 974 975 976 977

sigtype :: { LHsType RdrName }
	: ctype				{ L1 (mkImplicitHsForAllTy (noLoc []) $1) }
	-- Wrap an Implicit forall if there isn't one there already

978 979 980 981
sigtypedoc :: { LHsType RdrName }
	: ctypedoc			{ L1 (mkImplicitHsForAllTy (noLoc []) $1) }
	-- Wrap an Implicit forall if there isn't one there already

982 983 984 985 986 987 988
sig_vars :: { Located [Located RdrName] }
	 : sig_vars ',' var		{ LL ($3 : unLoc $1) }
	 | var				{ L1 [$1] }

-----------------------------------------------------------------------------
-- Types

989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005
infixtype :: { LHsType RdrName }
	: btype qtyconop gentype         { LL $ HsOpTy $1 $2 $3 }
        | btype tyvarop  gentype  	 { LL $ HsOpTy $1 $2 $3 }

infixtypedoc :: { LHsType RdrName }
        : infixtype                      { $1 }
	| infixtype docprev              { LL $ HsDocTy $1 $2 }

gentypedoc :: { LHsType RdrName }
        : btype                          { $1 }
        | btypedoc                       { $1 }
        | infixtypedoc                   { $1 }
        | btype '->' ctypedoc            { LL $ HsFunTy $1 $3 }
        | btypedoc '->' ctypedoc         { LL $ HsFunTy $1 $3 }

ctypedoc  :: { LHsType RdrName }
        : 'forall' tv_bndrs '.' ctypedoc { LL $ mkExplicitHsForAllTy $2 (noLoc []) $4 }
1006
        | context '=>' ctypedoc          { LL $ mkImplicitHsForAllTy   $1 $3 }
1007 1008 1009
	-- A type of form (context => type) is an *implicit* HsForAllTy
	| gentypedoc			 { $1 }
	
1010 1011 1012 1013
strict_mark :: { Located HsBang }
	: '!'				{ L1 HsStrict }
	| '{-# UNPACK' '#-}' '!'	{ LL HsUnbox }

1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024
-- A ctype is a for-all type
ctype	:: { LHsType RdrName }
	: 'forall' tv_bndrs '.' ctype	{ LL $ mkExplicitHsForAllTy $2 (noLoc []) $4 }
	| context '=>' type		{ LL $ mkImplicitHsForAllTy   $1 $3 }
	-- A type of form (context => type) is an *implicit* HsForAllTy
	| type				{ $1 }

-- We parse a context as a btype so that we don't get reduce/reduce
-- errors in ctype.  The basic problem is that
--	(Eq a, Ord a)
-- looks so much like a tuple type.  We can't tell until we find the =>
1025 1026 1027
--
-- We have the t1 ~ t2 form here and in gentype, to permit an individual
-- equational constraint without parenthesis.
1028
context :: { LHsContext RdrName }
1029 1030 1031
        : btype '~'      btype  	{% checkContext
					     (LL $ HsPredTy (HsEqualP $1 $3)) }
	| btype 			{% checkContext $1 }
1032 1033

type :: { LHsType RdrName }
1034
	: ipvar '::' gentype		{ LL (HsPredTy (HsIParam (unLoc $1) $3)) }
1035 1036 1037 1038 1039
	| gentype			{ $1 }

gentype :: { LHsType RdrName }
        : btype                         { $1 }
        | btype qtyconop gentype        { LL $ HsOpTy $1 $2 $3 }
1040
        | btype tyvarop  gentype  	{ LL $ HsOpTy $1 $2 $3 }
1041
 	| btype '->'     ctype		{ LL $ HsFunTy $1 $3 }
1042
        | btype '~'      btype  	{ LL $ HsPredTy (HsEqualP $1 $3) }
1043 1044 1045 1046 1047

btype :: { LHsType RdrName }
	: btype atype			{ LL $ HsAppTy $1 $2 }
	| atype				{ $1 }

1048 1049 1050 1051
btypedoc :: { LHsType RdrName }
	: btype atype docprev		{ LL $ HsDocTy (L (comb2 $1 $2) (HsAppTy $1 $2)) $3 }
        | atype docprev                 { LL $ HsDocTy $1 $2 }

1052 1053
atype :: { LHsType RdrName }
	: gtycon			{ L1 (HsTyVar (unLoc $1)) }
1054
	| tyvar				{ L1 (HsTyVar (unLoc $1)) }
1055
	| strict_mark atype		{ LL (HsBangTy (unLoc $1) $2) }
1056
	| '(' ctype ',' comma_types1 ')'  { LL $ HsTupleTy Boxed  ($2:$4) }
1057
	| '(#' comma_types1 '#)'	{ LL $ HsTupleTy Unboxed $2     }
1058 1059
	| '[' ctype ']'			{ LL $ HsListTy  $2 }
	| '[:' ctype ':]'		{ LL $ HsPArrTy  $2 }
1060
	| '(' ctype ')'		        { LL $ HsParTy   $2 }
1061
	| '(' ctype '::' kind ')'	{ LL $ HsKindSig $2 (unLoc $4) }
1062 1063 1064 1065 1066 1067 1068 1069
-- Generics
        | INTEGER                       { L1 (HsNumTy (getINTEGER $1)) }

-- An inst_type is what occurs in the head of an instance decl
--	e.g.  (Foo a, Gaz b) => Wibble a b
-- It's kept as a single type, with a MonoDictTy at the right
-- hand corner, for convenience.
inst_type :: { LHsType RdrName }
1070
	: sigtype			{% checkInstType $1 }
1071

1072 1073 1074 1075
inst_types1 :: { [LHsType RdrName] }
	: inst_type			{ [$1] }
	| inst_type ',' inst_types1	{ $1 : $3 }

1076 1077 1078 1079 1080
comma_types0  :: { [LHsType RdrName] }
	: comma_types1			{ $1 }
	| {- empty -}			{ [] }

comma_types1	:: { [LHsType RdrName] }
1081 1082
	: ctype				{ [$1] }
	| ctype  ',' comma_types1	{ $1 : $3 }
1083 1084 1085 1086 1087 1088 1089

tv_bndrs :: { [LHsTyVarBndr RdrName] }
	 : tv_bndr tv_bndrs		{ $1 : $2 }
	 | {- empty -}			{ [] }

tv_bndr :: { LHsTyVarBndr RdrName }
	: tyvar				{ L1 (UserTyVar (unLoc $1)) }
1090 1091
	| '(' tyvar '::' kind ')'	{ LL (KindedTyVar (unLoc $2) 
							  (unLoc $4)) }
1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111

fds :: { Located [Located ([RdrName], [RdrName])] }
	: {- empty -}			{ noLoc [] }
	| '|' fds1			{ LL (reverse (unLoc $2)) }

fds1 :: { Located [Located ([RdrName], [RdrName])] }
	: fds1 ',' fd			{ LL ($3 : unLoc $1) }
	| fd				{ L1 [$1] }

fd :: { Located ([RdrName], [RdrName]) }
	: varids0 '->' varids0		{ L (comb3 $1 $2 $3)
					   (reverse (unLoc $1), reverse (unLoc $3)) }

varids0	:: { Located [RdrName] }
	: {- empty -}			{ noLoc [] }
	| varids0 tyvar			{ LL (unLoc $2 : unLoc $1) }

-----------------------------------------------------------------------------
-- Kinds

1112
kind	:: { Located Kind }
1113
	: akind			{ $1 }
1114
	| akind '->' kind	{ LL (mkArrowKind (unLoc $1) (unLoc $3)) }
1115

1116 1117 1118 1119
akind	:: { Located Kind }
	: '*'			{ L1 liftedTypeKind }
	| '!'			{ L1 unliftedTypeKind }
	| '(' kind ')'		{ LL (unLoc $2) }
1120 1121 1122 1123 1124


-----------------------------------------------------------------------------
-- Datatype declarations

1125 1126 1127 1128 1129 1130
gadt_constrlist :: { Located [LConDecl RdrName] }
	: '{'            gadt_constrs '}'	{ LL (unLoc $2) }
	|     vocurly    gadt_constrs close	{ $2 }

gadt_constrs :: { Located [LConDecl RdrName] }
        : gadt_constrs ';' gadt_constr  { LL ($3 : unLoc $1) }
1131
        | gadt_constrs ';' 		{ $1 }
1132 1133
        | gadt_constr                   { L1 [$1] } 

1134 1135 1136 1137 1138 1139
-- We allow the following forms:
--	C :: Eq a => a -> T a
--	C :: forall a. Eq a => !a -> T a
--	D { x,y :: a } :: T a
--	forall a. Eq a => D { x,y :: a } :: T a

1140
gadt_constr :: { LConDecl RdrName }
1141
        : con '::' sigtype
1142 1143 1144
              { LL (mkGadtDecl $1 $3) } 
        -- Syntax: Maybe merge the record stuff with the single-case above?
        --         (to kill the mostly harmless reduce/reduce error)
1145
        -- XXX revisit audreyt
1146 1147
	| constr_stuff_record '::' sigtype
		{ let (con,details) = unLoc $1 in 
1148
		  LL (ConDecl con Implicit [] (noLoc []) details (ResTyGADT $3) Nothing) }
1149 1150 1151
{-
	| forall context '=>' constr_stuff_record '::' sigtype
		{ let (con,details) = unLoc $4 in 
1152
		  LL (ConDecl con Implicit (unLoc $1) $2 details (ResTyGADT $6) Nothing ) }
1153 1154
	| forall constr_stuff_record '::' sigtype
		{ let (con,details) = unLoc $2 in 
1155
		  LL (ConDecl con Implicit (unLoc $1) (noLoc []) details (ResTyGADT $4) Nothing) }
1156 1157
-}

1158 1159 1160

constrs :: { Located [LConDecl RdrName] }
        : {- empty; a GHC extension -}  { noLoc [] }
1161
        | maybe_docnext '=' constrs1    { L (comb2 $2 $3) (addConDocs (unLoc $3) $1) }
1162 1163

constrs1 :: { Located [LConDecl RdrName] }
1164 1165
	: constrs1 maybe_docnext '|' maybe_docprev constr { LL (addConDoc $5 $2 : addConDocFirst (unLoc $1) $4) }
	| constr			                  { L1 [$1] }
1166 1167

constr :: { LConDecl RdrName }
1168 1169 1170 1171 1172 1173
	: maybe_docnext forall context '=>' constr_stuff maybe_docprev	
		{ let (con,details) = unLoc $5 in 
		  L (comb4 $2 $3 $4 $5) (ConDecl con Explicit (unLoc $2) $3 details ResTyH98 ($1 `mplus` $6)) }
	| maybe_docnext forall constr_stuff maybe_docprev
		{ let (con,details) = unLoc $3 in 
		  L (comb2 $2 $3) (ConDecl con Explicit (unLoc $2) (noLoc []) details ResTyH98 ($1 `mplus` $4)) }
1174 1175 1176 1177 1178

forall :: { Located [LHsTyVarBndr RdrName] }
	: 'forall' tv_bndrs '.'		{ LL $2 }
	| {- empty -}			{ noLoc [] }

1179
constr_stuff :: { Located (Located RdrName, HsConDeclDetails RdrName) }
1180 1181 1182 1183 1184 1185 1186
-- We parse the constructor declaration 
--	C t1 t2
-- as a btype (treating C as a type constructor) and then convert C to be
-- a data constructor.  Reason: it might continue like this:
--	C t1 t2 %: D Int
-- in which case C really would be a type constructor.  We can't resolve this
-- ambiguity till we come across the constructor oprerator :% (or not, more usually)
1187 1188 1189
	: btype				{% mkPrefixCon $1 [] >>= return.LL }
	| oqtycon '{' '}' 		{% mkRecCon $1 [] >>= return.LL }
	| oqtycon '{' fielddecls '}' 	{% mkRecCon $1 $3 >>= return.LL }
1190
	| btype conop btype		{ LL ($2, InfixCon $1 $3) }
1191

1192
constr_stuff_record :: { Located (Located RdrName, HsConDeclDetails RdrName) }
1193 1194 1195
	: oqtycon '{' '}' 		{% mkRecCon $1 [] >>= return.sL (comb2 $1 $>) }
	| oqtycon '{' fielddecls '}' 	{% mkRecCon $1 $3 >>= return.sL (comb2 $1 $>) }

1196 1197 1198
fielddecls :: { [([Located RdrName], LBangType RdrName, Maybe (LHsDoc RdrName))] }
	: fielddecl maybe_docnext ',' maybe_docprev fielddecls { addFieldDoc (unLoc $1) $4 : addFieldDocs $5 $2 }
	| fielddecl			                       { [unLoc $1] }
1199

1200 1201
fielddecl :: { Located ([Located RdrName], LBangType RdrName, Maybe (LHsDoc RdrName)) }
	: maybe_docnext sig_vars '::' ctype maybe_docprev      { L (comb3 $2 $3 $4) (reverse (unLoc $2), $4, $1 `mplus` $5) }
1202

1203 1204 1205 1206
-- We allow the odd-looking 'inst_type' in a deriving clause, so that
-- we can do deriving( forall a. C [a] ) in a newtype (GHC extension).
-- The 'C [a]' part is converted to an HsPredTy by checkInstType
-- We don't allow a context, but that's sorted out by the type checker.
1207 1208
deriving :: { Located (Maybe [LHsType RdrName]) }
	: {- empty -}				{ noLoc Nothing }
1209 1210 1211
	| 'deriving' qtycon	{% do { let { L loc tv = $2 }
				      ; p <- checkInstType (L loc (HsTyVar tv))
				      ; return (LL (Just [p])) } }
1212 1213
	| 'deriving' '(' ')'	 		{ LL (Just []) }
	| 'deriving' '(' inst_types1 ')' 	{ LL (Just $3) }
1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239
             -- Glasgow extension: allow partial 
             -- applications in derivings

-----------------------------------------------------------------------------
-- Value definitions

{- There's an awkward overlap with a type signature.  Consider
	f :: Int -> Int = ...rhs...
   Then we can't tell whether it's a type signature or a value
   definition with a result signature until we see the '='.
   So we have to inline enough to postpone reductions until we know.
-}

{-
  ATTENTION: Dirty Hackery Ahead! If the second alternative of vars is var
  instead of qvar, we get another shift/reduce-conflict. Consider the
  following programs:
  
     { (^^) :: Int->Int ; }          Type signature; only var allowed

     { (^^) :: Int->Int = ... ; }    Value defn with result signature;
				     qvar allowed (because of instance decls)
  
  We can't tell whether to reduce var to qvar until after we've read the signatures.
-}

1240 1241 1242 1243 1244 1245 1246 1247 1248
docdecl :: { LHsDecl RdrName }
        : docdecld { L1 (DocD (unLoc $1)) }

docdecld :: { LDocDecl RdrName }
        : docnext                               { L1 (DocCommentNext (unLoc $1)) }
        | docprev                               { L1 (DocCommentPrev (unLoc $1)) }
        | docnamed                              { L1 (case (unLoc $1) of (n, doc) -> DocCommentNamed n doc) }
        | docsection                            { L1 (case (unLoc $1) of (n, doc) -> DocGroup n doc) }

1249
decl 	:: { Located (OrdList (LHsDecl RdrName)) }
1250
	: sigdecl			{ $1 }
1251
	| '!' aexp rhs			{% do { pat <- checkPattern $2;
1252
					        return (LL $ unitOL $ LL $ ValD ( 
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
1253
							PatBind (LL $ BangPat pat) (unLoc $3)
1254
								placeHolderType placeHolderNames)) } }
Ian Lynagh's avatar
Ian Lynagh committed
1255 1256 1257
        | infixexp opt_sig rhs          {% do { r <- checkValDef $1 $2 $3;
                                                let { l = comb2 $1 $> };
                                                return $! (sL l (unitOL $! (sL l $ ValD r))) } }
1258
        | docdecl                       { LL $ unitOL $1 }
1259 1260

rhs	:: { Located (GRHSs RdrName) }
Ian Lynagh's avatar
Ian Lynagh committed
1261
	: '=' exp wherebinds	{ sL (comb3 $1 $2 $3) $ GRHSs (unguardedRHS $2) (unLoc $3) }
1262
	| gdrhs	wherebinds	{ LL $ GRHSs (reverse (unLoc $1)) (unLoc $2) }
1263 1264 1265 1266 1267 1268

gdrhs :: { Located [LGRHS RdrName] }
	: gdrhs gdrh		{ LL ($2 : unLoc $1) }
	| gdrh			{ L1 [$1] }

gdrh :: { LGRHS RdrName }
1269
	: '|' guardquals '=' exp  	{ sL (comb2 $1 $>) $ GRHS (unLoc $2) $4 }
1270

1271
sigdecl :: { Located (OrdList (LHsDecl RdrName)) }
1272
	: infixexp '::' sigtypedoc
1273
				{% do s <- checkValSig $1 $3; 
1274
				      return (LL $ unitOL (LL $ SigD s)) }
1275
		-- See the above notes for why we need infixexp here
1276
	| var ',' sig_vars '::' sigtypedoc
1277
				{ LL $ toOL [ LL $ SigD (TypeSig n $5) | n <- $1 : unLoc $3 ] }
1278
	| infix prec ops	{ LL $ toOL [ LL $ SigD (FixSig (FixitySig n (Fixity $2 (unLoc $1))))
1279 1280
					     | n <- unLoc $3 ] }
	| '{-# INLINE'   activation qvar '#-}'	      
1281
				{ LL $ unitOL (LL $ SigD (InlineSig $3 (mkInlineSpec $2 (getINLINE $1)))) }
1282
	| '{-# SPECIALISE' qvar '::' sigtypes1 '#-}'
1283
			 	{ LL $ toOL [ LL $ SigD (SpecSig $2 t defaultInlineSpec) 
1284
					    | t <- $4] }
1285
	| '{-# SPECIALISE_INLINE' activation qvar '::' sigtypes1 '#-}'
1286
			 	{ LL $ toOL [ LL $ SigD (SpecSig $3 t (mkInlineSpec $2 (getSPEC_INLINE $1)))
1287
					    | t <- $5] }
1288
	| '{-# SPECIALISE' 'instance' inst_type '#-}'