Lexer.x 78.5 KB
Newer Older
1
-----------------------------------------------------------------------------
2
-- (c) The University of Glasgow, 2006
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
--
-- GHC's lexer.
--
-- This is a combination of an Alex-generated lexer from a regex
-- definition, with some hand-coded bits.
--
-- Completely accurate information about token-spans within the source
-- file is maintained.  Every token has a start and end SrcLoc attached to it.
--
-----------------------------------------------------------------------------

--   ToDo / known bugs:
--    - parsing integers is a bit slow
--    - readRational is a bit slow
--
--   Known bugs, that were also in the previous version:
--    - M... should be 3 tokens, not 1.
--    - pragma-end should be only valid in a pragma

22 23 24 25 26 27 28 29 30 31 32
--   qualified operator NOTES.
--   
--   - If M.(+) is a single lexeme, then..
--     - Probably (+) should be a single lexeme too, for consistency.
--       Otherwise ( + ) would be a prefix operator, but M.( + ) would not be.
--     - But we have to rule out reserved operators, otherwise (..) becomes
--       a different lexeme.
--     - Should we therefore also rule out reserved operators in the qualified
--       form?  This is quite difficult to achieve.  We don't do it for
--       qualified varids.

33
{
34 35 36 37 38 39 40 41 42
-- XXX The above flags turn off warnings in the generated code:
{-# OPTIONS_GHC -fno-warn-unused-matches #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-missing-signatures #-}
-- But alex still generates some code that causes the "lazy unlifted bindings"
-- warning, and old compilers don't know about it so we can't easily turn
-- it off, so for now we use the sledge hammer:
{-# OPTIONS_GHC -w #-}
43

44 45
{-# OPTIONS_GHC -funbox-strict-fields #-}

46
module Lexer (
47
   Token(..), lexer, pragState, mkPState, PState(..),
48
   P(..), ParseResult(..), getSrcLoc, 
49
   getPState, getDynFlags, withThisPackage,
50
   failLocMsgP, failSpanMsgP, srcParseFail,
51
   getMessages, 
52
   popContext, pushCurrentContext, setLastToken, setSrcLoc,
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
53
   getLexState, popLexState, pushLexState,
54
   extension, bangPatEnabled, datatypeContextsEnabled,
Jedai's avatar
Jedai committed
55 56
   addWarning,
   lexTokenStream
57 58
  ) where

59 60
import Bag
import ErrUtils
61 62 63 64 65
import Outputable
import StringBuffer
import FastString
import SrcLoc
import UniqFM
66
import DynFlags
67
import Module
68
import Ctype
69
import BasicTypes	( InlineSpec(..), RuleMatchInfo(..) )
70
import Util		( readRational )
71

72
import Control.Monad
Simon Marlow's avatar
Simon Marlow committed
73
import Data.Bits
74
import Data.Char
75
import Data.List
Ian Lynagh's avatar
Ian Lynagh committed
76
import Data.Maybe
77 78
import Data.Map (Map)
import qualified Data.Map as Map
Simon Marlow's avatar
Simon Marlow committed
79
import Data.Ratio
80 81
}

82
$unispace    = \x05 -- Trick Alex into handling Unicode. See alexGetChar.
83
$whitechar   = [\ \n\r\f\v $unispace]
84
$white_no_nl = $whitechar # \n
85
$tab         = \t
86 87

$ascdigit  = 0-9
88
$unidigit  = \x03 -- Trick Alex into handling Unicode. See alexGetChar.
89
$decdigit  = $ascdigit -- for now, should really be $digit (ToDo)
90 91 92
$digit     = [$ascdigit $unidigit]

$special   = [\(\)\,\;\[\]\`\{\}]
93
$ascsymbol = [\!\#\$\%\&\*\+\.\/\<\=\>\?\@\\\^\|\-\~]
94
$unisymbol = \x04 -- Trick Alex into handling Unicode. See alexGetChar.
95 96
$symbol    = [$ascsymbol $unisymbol] # [$special \_\:\"\']

97
$unilarge  = \x01 -- Trick Alex into handling Unicode. See alexGetChar.
98
$asclarge  = [A-Z]
99 100
$large     = [$asclarge $unilarge]

101
$unismall  = \x02 -- Trick Alex into handling Unicode. See alexGetChar.
102
$ascsmall  = [a-z]
103 104
$small     = [$ascsmall $unismall \_]

105
$unigraphic = \x06 -- Trick Alex into handling Unicode. See alexGetChar.
106
$graphic   = [$small $large $symbol $digit $special $unigraphic \:\"\']
107 108

$octit	   = 0-7
109
$hexit     = [$decdigit A-F a-f]
110 111 112 113
$symchar   = [$symbol \:]
$nl        = [\n\r]
$idchar    = [$small $large $digit \']

114 115
$pragmachar = [$small $large $digit]

116 117
$docsym    = [\| \^ \* \$]

118 119 120 121 122 123
@varid     = $small $idchar*
@conid     = $large $idchar*

@varsym    = $symbol $symchar*
@consym    = \: $symchar*

124
@decimal     = $decdigit+
125 126 127 128 129 130 131 132 133
@octal       = $octit+
@hexadecimal = $hexit+
@exponent    = [eE] [\-\+]? @decimal

-- we support the hierarchical module name extension:
@qual = (@conid \.)+

@floating_point = @decimal \. @decimal @exponent? | @decimal @exponent

134 135 136 137 138
-- normal signed numerical literals can only be explicitly negative,
-- not explicitly positive (contrast @exponent)
@negative = \-
@signed = @negative ?

139 140 141 142
haskell :-

-- everywhere: skip whitespace and comments
$white_no_nl+ 				;
143
$tab+         { warn Opt_WarnTabs (text "Warning: Tab character") }
144 145 146 147 148

-- Everywhere: deal with nested comments.  We explicitly rule out
-- pragmas, "{-#", so that we don't accidentally treat them as comments.
-- (this can happen even though pragmas will normally take precedence due to
-- longest-match, because pragmas aren't valid in every state, but comments
149 150 151 152
-- are). We also rule out nested Haddock comments, if the -haddock flag is
-- set.

"{-" / { isNormalComment } { nested_comment lexToken }
153 154 155 156

-- Single-line comments are a bit tricky.  Haskell 98 says that two or
-- more dashes followed by a symbol should be parsed as a varsym, so we
-- have to exclude those.
157 158 159 160 161 162 163 164 165 166

-- Since Haddock comments aren't valid in every state, we need to rule them
-- out here.  

-- The following two rules match comments that begin with two dashes, but
-- continue with a different character. The rules test that this character
-- is not a symbol (in which case we'd have a varsym), and that it's not a
-- space followed by a Haddock comment symbol (docsym) (in which case we'd
-- have a Haddock comment). The rules then munch the rest of the line.

Jedai's avatar
Jedai committed
167 168
"-- " ~[$docsym \#] .* { lineCommentToken }
"--" [^$symbol : \ ] .* { lineCommentToken }
169 170 171

-- Next, match Haddock comments if no -haddock flag

Jedai's avatar
Jedai committed
172
"-- " [$docsym \#] .* / { ifExtension (not . haddockEnabled) } { lineCommentToken }
173 174 175 176 177 178 179

-- Now, when we've matched comments that begin with 2 dashes and continue
-- with a different character, we need to match comments that begin with three
-- or more dashes (which clearly can't be Haddock comments). We only need to
-- make sure that the first non-dash character isn't a symbol, and munch the
-- rest of the line.

Jedai's avatar
Jedai committed
180
"---"\-* [^$symbol :] .* { lineCommentToken }
181 182 183 184

-- Since the previous rules all match dashes followed by at least one
-- character, we also need to match a whole line filled with just dashes.

Jedai's avatar
Jedai committed
185
"--"\-* / { atEOL } { lineCommentToken }
186 187 188 189

-- We need this rule since none of the other single line comment rules
-- actually match this case.

Jedai's avatar
Jedai committed
190
"-- " / { atEOL } { lineCommentToken }
191 192 193 194 195 196 197 198 199 200 201 202 203

-- 'bol' state: beginning of a line.  Slurp up all the whitespace (including
-- blank lines) until we find a non-whitespace character, then do layout
-- processing.
--
-- One slight wibble here: what if the line begins with {-#? In
-- theory, we have to lex the pragma to see if it's one we recognise,
-- and if it is, then we backtrack and do_bol, otherwise we treat it
-- as a nested comment.  We don't bother with this: if the line begins
-- with {-#, then we'll assume it's a pragma we know about and go for do_bol.
<bol> {
  \n					;
  ^\# (line)?				{ begin line_prag1 }
204
  ^\# pragma .* \n			; -- GCC 3.3 CPP generated, apparently
205
  ^\# \! .* \n				; -- #!, for scripts
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
  ()					{ do_bol }
}

-- after a layout keyword (let, where, do, of), we begin a new layout
-- context if the curly brace is missing.
-- Careful! This stuff is quite delicate.
<layout, layout_do> {
  \{ / { notFollowedBy '-' }		{ pop_and open_brace }
	-- we might encounter {-# here, but {- has been handled already
  \n					;
  ^\# (line)?				{ begin line_prag1 }
}

-- do is treated in a subtly different way, see new_layout_context
<layout>    ()				{ new_layout_context True }
<layout_do> ()				{ new_layout_context False }

-- after a new layout context which was found to be to the left of the
-- previous context, we have generated a '{' token, and we now need to
-- generate a matching '}' token.
<layout_left>  ()			{ do_layout_left }

228
<0,option_prags> \n				{ begin bol }
229

230 231
"{-#" $whitechar* $pragmachar+ / { known_pragma linePrags }
                                { dispatch_pragmas linePrags }
232 233 234

-- single-line line pragmas, of the form
--    # <line> "<file>" <extra-stuff> \n
235
<line_prag1> $decdigit+			{ setLine line_prag1a }
236
<line_prag1a> \" [$graphic \ ]* \"	{ setFile line_prag1b }
237 238 239 240
<line_prag1b> .*			{ pop }

-- Haskell-style line pragmas, of the form
--    {-# LINE <line> "<file>" #-}
241
<line_prag2> $decdigit+			{ setLine line_prag2a }
242
<line_prag2a> \" [$graphic \ ]* \"	{ setFile line_prag2b }
243 244 245
<line_prag2b> "#-}"|"-}"		{ pop }
   -- NOTE: accept -} at the end of a LINE pragma, for compatibility
   -- with older versions of GHC which generated these.
246

247
<0,option_prags> {
248 249 250 251 252 253
  "{-#" $whitechar* $pragmachar+ 
        $whitechar+ $pragmachar+ / { known_pragma twoWordPrags }
                                 { dispatch_pragmas twoWordPrags }

  "{-#" $whitechar* $pragmachar+ / { known_pragma oneWordPrags }
                                 { dispatch_pragmas oneWordPrags }
254

255
  -- We ignore all these pragmas, but don't generate a warning for them
256 257
  "{-#" $whitechar* $pragmachar+ / { known_pragma ignoredPrags }
                                 { dispatch_pragmas ignoredPrags }
258 259

  -- ToDo: should only be valid inside a pragma:
260
  "#-}" 				{ endPrag }
261 262
}

263
<option_prags> {
264 265 266
  "{-#"  $whitechar* $pragmachar+ / { known_pragma fileHeaderPrags }
                                   { dispatch_pragmas fileHeaderPrags }

David Waern's avatar
David Waern committed
267 268 269
  "-- #"                                 { multiline_doc_comment }
}

270 271
<0> {
  -- In the "0" mode we ignore these pragmas
272
  "{-#"  $whitechar* $pragmachar+ / { known_pragma fileHeaderPrags }
273 274 275
                     { nested_comment lexToken }
}

David Waern's avatar
David Waern committed
276
<0> {
Jedai's avatar
Jedai committed
277
  "-- #" .* { lineCommentToken }
278
}
279

280
<0,option_prags> {
281 282
  "{-#"  { warnThen Opt_WarnUnrecognisedPragmas (text "Unrecognised pragma")
                    (nested_comment lexToken) }
283 284
}

285 286
-- '0' state: ordinary lexemes

287 288
-- Haddock comments

289
<0,option_prags> {
David Waern's avatar
David Waern committed
290 291
  "-- " $docsym      / { ifExtension haddockEnabled } { multiline_doc_comment }
  "{-" \ ? $docsym   / { ifExtension haddockEnabled } { nested_doc_comment }
292 293
}

294 295
-- "special" symbols

296
<0> {
297 298 299 300
  "[:" / { ifExtension parrEnabled }	{ token ITopabrack }
  ":]" / { ifExtension parrEnabled }	{ token ITcpabrack }
}
  
301
<0> {
302 303 304 305 306 307 308 309
  "[|"	    / { ifExtension thEnabled }	{ token ITopenExpQuote }
  "[e|"	    / { ifExtension thEnabled }	{ token ITopenExpQuote }
  "[p|"	    / { ifExtension thEnabled }	{ token ITopenPatQuote }
  "[d|"	    / { ifExtension thEnabled }	{ layout_token ITopenDecQuote }
  "[t|"	    / { ifExtension thEnabled }	{ token ITopenTypQuote }
  "|]"	    / { ifExtension thEnabled }	{ token ITcloseQuote }
  \$ @varid / { ifExtension thEnabled }	{ skip_one_varid ITidEscape }
  "$("	    / { ifExtension thEnabled }	{ token ITparenEscape }
310

311
  "[" @varid "|"  / { ifExtension qqEnabled }
312
                     { lex_quasiquote_tok }
313 314
}

315
<0> {
ross's avatar
ross committed
316 317
  "(|" / { ifExtension arrowsEnabled `alexAndPred` notFollowedBySymbol }
					{ special IToparenbar }
318 319 320
  "|)" / { ifExtension arrowsEnabled }  { special ITcparenbar }
}

321
<0> {
322 323 324
  \? @varid / { ifExtension ipEnabled }	{ skip_one_varid ITdupipvarid }
}

325
<0> {
Ian Lynagh's avatar
Ian Lynagh committed
326 327 328 329 330 331
  "(#" / { ifExtension unboxedTuplesEnabled `alexAndPred` notFollowedBySymbol }
         { token IToubxparen }
  "#)" / { ifExtension unboxedTuplesEnabled }
         { token ITcubxparen }
}

332
<0> {
Ian Lynagh's avatar
Ian Lynagh committed
333 334
  "{|" / { ifExtension genericsEnabled } { token ITocurlybar }
  "|}" / { ifExtension genericsEnabled } { token ITccurlybar }
335 336
}

337
<0,option_prags> {
338 339 340 341 342 343 344 345 346 347 348 349
  \(					{ special IToparen }
  \)					{ special ITcparen }
  \[					{ special ITobrack }
  \]					{ special ITcbrack }
  \,					{ special ITcomma }
  \;					{ special ITsemi }
  \`					{ special ITbackquote }
 				
  \{					{ open_brace }
  \}					{ close_brace }
}

350
<0,option_prags> {
351
  @qual @varid			{ idtoken qvarid }
352 353 354 355 356
  @qual @conid			{ idtoken qconid }
  @varid			{ varid }
  @conid			{ idtoken conid }
}

357
<0> {
358 359 360 361
  @qual @varid "#"+ / { ifExtension magicHashEnabled } { idtoken qvarid }
  @qual @conid "#"+ / { ifExtension magicHashEnabled } { idtoken qconid }
  @varid "#"+       / { ifExtension magicHashEnabled } { varid }
  @conid "#"+       / { ifExtension magicHashEnabled } { idtoken conid }
362 363
}

364 365
-- ToDo: - move `var` and (sym) into lexical syntax?
--       - remove backquote from $special?
366
<0> {
367 368 369 370 371 372
  @qual @varsym       / { ifExtension oldQualOps } { idtoken qvarsym }
  @qual @consym       / { ifExtension oldQualOps } { idtoken qconsym }
  @qual \( @varsym \) / { ifExtension newQualOps } { idtoken prefixqvarsym }
  @qual \( @consym \) / { ifExtension newQualOps } { idtoken prefixqconsym }
  @varsym                                          { varsym }
  @consym                                          { consym }
373 374
}

375 376
-- For the normal boxed literals we need to be careful
-- when trying to be close to Haskell98
377
<0> {
378
  -- Normal integral literals (:: Num a => a, from Integer)
Ian Lynagh's avatar
Ian Lynagh committed
379 380 381
  @decimal           { tok_num positive 0 0 decimal }
  0[oO] @octal       { tok_num positive 2 2 octal }
  0[xX] @hexadecimal { tok_num positive 2 2 hexadecimal }
382 383

  -- Normal rational literals (:: Fractional a => a, from Rational)
Ian Lynagh's avatar
Ian Lynagh committed
384
  @floating_point    { strtoken tok_float }
385 386
}

387
<0> {
Ian Lynagh's avatar
Ian Lynagh committed
388
  -- Unboxed ints (:: Int#) and words (:: Word#)
389 390
  -- It's simpler (and faster?) to give separate cases to the negatives,
  -- especially considering octal/hexadecimal prefixes.
Ian Lynagh's avatar
Ian Lynagh committed
391 392 393 394 395
  @decimal                     \# / { ifExtension magicHashEnabled } { tok_primint positive 0 1 decimal }
  0[oO] @octal                 \# / { ifExtension magicHashEnabled } { tok_primint positive 2 3 octal }
  0[xX] @hexadecimal           \# / { ifExtension magicHashEnabled } { tok_primint positive 2 3 hexadecimal }
  @negative @decimal           \# / { ifExtension magicHashEnabled } { tok_primint negative 1 2 decimal }
  @negative 0[oO] @octal       \# / { ifExtension magicHashEnabled } { tok_primint negative 3 4 octal }
396
  @negative 0[xX] @hexadecimal \# / { ifExtension magicHashEnabled } { tok_primint negative 3 4 hexadecimal }
397

Ian Lynagh's avatar
Ian Lynagh committed
398 399 400 401
  @decimal                     \# \# / { ifExtension magicHashEnabled } { tok_primword 0 2 decimal }
  0[oO] @octal                 \# \# / { ifExtension magicHashEnabled } { tok_primword 2 4 octal }
  0[xX] @hexadecimal           \# \# / { ifExtension magicHashEnabled } { tok_primword 2 4 hexadecimal }

402 403
  -- Unboxed floats and doubles (:: Float#, :: Double#)
  -- prim_{float,double} work with signed literals
404 405
  @signed @floating_point \# / { ifExtension magicHashEnabled } { init_strtoken 1 tok_primfloat }
  @signed @floating_point \# \# / { ifExtension magicHashEnabled } { init_strtoken 2 tok_primdouble }
406 407 408 409 410 411
}

-- Strings and chars are lexed by hand-written code.  The reason is
-- that even if we recognise the string or char here in the regex
-- lexer, we would still have to parse the string afterward in order
-- to convert it to a String.
412
<0> {
413 414 415 416 417 418 419 420
  \'				{ lex_char_tok }
  \" 				{ lex_string_tok }
}

{
-- -----------------------------------------------------------------------------
-- The token type

421
data Token
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
  = ITas  			-- Haskell keywords
  | ITcase
  | ITclass
  | ITdata
  | ITdefault
  | ITderiving
  | ITdo
  | ITelse
  | IThiding
  | ITif
  | ITimport
  | ITin
  | ITinfix
  | ITinfixl
  | ITinfixr
  | ITinstance
  | ITlet
  | ITmodule
  | ITnewtype
  | ITof
  | ITqualified
  | ITthen
  | ITtype
  | ITwhere
  | ITscc			-- ToDo: remove (we use {-# SCC "..." #-} now)

  | ITforall			-- GHC extension keywords
  | ITforeign
  | ITexport
  | ITlabel
  | ITdynamic
  | ITsafe
  | ITthreadsafe
455
  | ITinterruptible
456 457 458
  | ITunsafe
  | ITstdcallconv
  | ITccallconv
459
  | ITprimcallconv
460
  | ITmdo
461
  | ITfamily
462 463 464
  | ITgroup
  | ITby
  | ITusing
465

466
	-- Pragmas
467
  | ITinline_prag InlineSpec RuleMatchInfo
468 469
  | ITspec_prag			-- SPECIALISE	
  | ITspec_inline_prag Bool	-- SPECIALISE INLINE (or NOINLINE)
470 471
  | ITsource_prag
  | ITrules_prag
Ian Lynagh's avatar
Ian Lynagh committed
472
  | ITwarning_prag
473 474 475
  | ITdeprecated_prag
  | ITline_prag
  | ITscc_prag
andy@galois.com's avatar
andy@galois.com committed
476
  | ITgenerated_prag
477
  | ITcore_prag                 -- hdaume: core annotations
478
  | ITunpack_prag
479
  | ITann_prag
480
  | ITclose_prag
481 482 483
  | IToptions_prag String
  | ITinclude_prag String
  | ITlanguage_prag
484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509

  | ITdotdot  			-- reserved symbols
  | ITcolon
  | ITdcolon
  | ITequal
  | ITlam
  | ITvbar
  | ITlarrow
  | ITrarrow
  | ITat
  | ITtilde
  | ITdarrow
  | ITminus
  | ITbang
  | ITstar
  | ITdot

  | ITbiglam			-- GHC-extension symbols

  | ITocurly  			-- special symbols
  | ITccurly
  | ITocurlybar                 -- {|, for type applications
  | ITccurlybar                 -- |}, for type applications
  | ITvocurly
  | ITvccurly
  | ITobrack
510 511
  | ITopabrack			-- [:, for parallel arrays with -XParr
  | ITcpabrack			-- :], for parallel arrays with -XParr
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529
  | ITcbrack
  | IToparen
  | ITcparen
  | IToubxparen
  | ITcubxparen
  | ITsemi
  | ITcomma
  | ITunderscore
  | ITbackquote

  | ITvarid   FastString	-- identifiers
  | ITconid   FastString
  | ITvarsym  FastString
  | ITconsym  FastString
  | ITqvarid  (FastString,FastString)
  | ITqconid  (FastString,FastString)
  | ITqvarsym (FastString,FastString)
  | ITqconsym (FastString,FastString)
530 531
  | ITprefixqvarsym (FastString,FastString)
  | ITprefixqconsym (FastString,FastString)
532 533 534 535 536 537 538 539 540 541 542

  | ITdupipvarid   FastString	-- GHC extension: implicit param: ?x

  | ITchar       Char
  | ITstring     FastString
  | ITinteger    Integer
  | ITrational   Rational

  | ITprimchar   Char
  | ITprimstring FastString
  | ITprimint    Integer
Ian Lynagh's avatar
Ian Lynagh committed
543
  | ITprimword   Integer
544 545 546
  | ITprimfloat  Rational
  | ITprimdouble Rational

547
  -- Template Haskell extension tokens
548 549 550 551 552 553 554 555 556
  | ITopenExpQuote  		--  [| or [e|
  | ITopenPatQuote		--  [p|
  | ITopenDecQuote		--  [d|
  | ITopenTypQuote		--  [t|         
  | ITcloseQuote		--  |]
  | ITidEscape   FastString	--  $x
  | ITparenEscape		--  $( 
  | ITvarQuote			--  '
  | ITtyQuote			--  ''
557
  | ITquasiQuote (FastString,FastString,SrcSpan) --  [:...|...|]
558 559 560 561

  -- Arrow notation extension
  | ITproc
  | ITrec
562 563 564 565 566 567
  | IToparenbar			--  (|
  | ITcparenbar			--  |)
  | ITlarrowtail		--  -<
  | ITrarrowtail		--  >-
  | ITLarrowtail		--  -<<
  | ITRarrowtail		--  >>-
568 569 570

  | ITunknown String		-- Used when the lexer can't make sense of it
  | ITeof			-- end of file token
571 572 573 574 575 576 577

  -- Documentation annotations
  | ITdocCommentNext  String     -- something beginning '-- |'
  | ITdocCommentPrev  String     -- something beginning '-- ^'
  | ITdocCommentNamed String     -- something beginning '-- $'
  | ITdocSection      Int String -- a section heading
  | ITdocOptions      String     -- doc options (prune, ignore-exports, etc)
David Waern's avatar
David Waern committed
578
  | ITdocOptionsOld   String     -- doc options declared "-- # ..."-style
Jedai's avatar
Jedai committed
579 580
  | ITlineComment     String     -- comment starting by "--"
  | ITblockComment    String     -- comment in {- -}
581

582 583 584 585
#ifdef DEBUG
  deriving Show -- debugging
#endif

twanvl's avatar
twanvl committed
586
{-
587
isSpecial :: Token -> Bool
588 589 590 591 592 593 594 595 596 597 598 599
-- If we see M.x, where x is a keyword, but
-- is special, we treat is as just plain M.x, 
-- not as a keyword.
isSpecial ITas        	= True
isSpecial IThiding    	= True
isSpecial ITqualified 	= True
isSpecial ITforall    	= True
isSpecial ITexport    	= True
isSpecial ITlabel     	= True
isSpecial ITdynamic   	= True
isSpecial ITsafe    	= True
isSpecial ITthreadsafe 	= True
600
isSpecial ITinterruptible = True
601 602 603
isSpecial ITunsafe    	= True
isSpecial ITccallconv   = True
isSpecial ITstdcallconv = True
604
isSpecial ITprimcallconv = True
605
isSpecial ITmdo		= True
606
isSpecial ITfamily	= True
607 608 609
isSpecial ITgroup   = True
isSpecial ITby      = True
isSpecial ITusing   = True
610
isSpecial _             = False
twanvl's avatar
twanvl committed
611
-}
612 613 614 615 616 617 618 619

-- the bitmap provided as the third component indicates whether the
-- corresponding extension keyword is valid under the extension options
-- provided to the compiler; if the extension corresponding to *any* of the
-- bits set in the bitmap is enabled, the keyword is valid (this setup
-- facilitates using a keyword in two different extensions that can be
-- activated independently)
--
Ian Lynagh's avatar
Ian Lynagh committed
620
reservedWordsFM :: UniqFM (Token, Int)
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649
reservedWordsFM = listToUFM $
	map (\(x, y, z) -> (mkFastString x, (y, z)))
       [( "_",		ITunderscore, 	0 ),
	( "as",		ITas, 		0 ),
	( "case",	ITcase, 	0 ),     
	( "class",	ITclass, 	0 ),    
	( "data",	ITdata, 	0 ),     
	( "default",	ITdefault, 	0 ),  
	( "deriving",	ITderiving, 	0 ), 
	( "do",		ITdo, 		0 ),       
	( "else",	ITelse, 	0 ),     
	( "hiding",	IThiding, 	0 ),
	( "if",		ITif, 		0 ),       
	( "import",	ITimport, 	0 ),   
	( "in",		ITin, 		0 ),       
	( "infix",	ITinfix, 	0 ),    
	( "infixl",	ITinfixl, 	0 ),   
	( "infixr",	ITinfixr, 	0 ),   
	( "instance",	ITinstance, 	0 ), 
	( "let",	ITlet, 		0 ),      
	( "module",	ITmodule, 	0 ),   
	( "newtype",	ITnewtype, 	0 ),  
	( "of",		ITof, 		0 ),       
	( "qualified",	ITqualified, 	0 ),
	( "then",	ITthen, 	0 ),     
	( "type",	ITtype, 	0 ),     
	( "where",	ITwhere, 	0 ),
	( "_scc_",	ITscc, 		0 ),		-- ToDo: remove

650
    ( "forall",	ITforall,	 bit explicitForallBit .|. bit inRulePragBit),
Ian Lynagh's avatar
Ian Lynagh committed
651
	( "mdo",	ITmdo,		 bit recursiveDoBit),
652
	( "family",	ITfamily,	 bit tyFamBit),
653 654 655
    ( "group",  ITgroup,     bit transformComprehensionsBit),
    ( "by",     ITby,        bit transformComprehensionsBit),
    ( "using",  ITusing,     bit transformComprehensionsBit),
656 657 658 659 660 661

	( "foreign",	ITforeign,	 bit ffiBit),
	( "export",	ITexport,	 bit ffiBit),
	( "label",	ITlabel,	 bit ffiBit),
	( "dynamic",	ITdynamic,	 bit ffiBit),
	( "safe",	ITsafe,		 bit ffiBit),
662
	( "threadsafe",	ITthreadsafe,	 bit ffiBit),  -- ToDo: remove
663
	( "interruptible", ITinterruptible, bit ffiBit),
664 665 666
	( "unsafe",	ITunsafe,	 bit ffiBit),
	( "stdcall",    ITstdcallconv,	 bit ffiBit),
	( "ccall",      ITccallconv,	 bit ffiBit),
667
	( "prim",       ITprimcallconv,	 bit ffiBit),
668

669
	( "rec",	ITrec,		 bit recBit),
670
	( "proc",	ITproc,		 bit arrowsBit)
671 672
     ]

Ian Lynagh's avatar
Ian Lynagh committed
673
reservedSymsFM :: UniqFM (Token, Int -> Bool)
674
reservedSymsFM = listToUFM $
Ian Lynagh's avatar
Ian Lynagh committed
675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691
    map (\ (x,y,z) -> (mkFastString x,(y,z)))
      [ ("..",  ITdotdot,   always)
        -- (:) is a reserved op, meaning only list cons
       ,(":",   ITcolon,    always)
       ,("::",  ITdcolon,   always)
       ,("=",   ITequal,    always)
       ,("\\",  ITlam,      always)
       ,("|",   ITvbar,     always)
       ,("<-",  ITlarrow,   always)
       ,("->",  ITrarrow,   always)
       ,("@",   ITat,       always)
       ,("~",   ITtilde,    always)
       ,("=>",  ITdarrow,   always)
       ,("-",   ITminus,    always)
       ,("!",   ITbang,     always)

        -- For data T (a::*) = MkT
692
       ,("*", ITstar, always) -- \i -> kindSigsEnabled i || tyFamEnabled i)
Ian Lynagh's avatar
Ian Lynagh committed
693
        -- For 'forall a . t'
694
       ,(".", ITdot,  always) -- \i -> explicitForallEnabled i || inRulePrag i)
Ian Lynagh's avatar
Ian Lynagh committed
695 696 697 698 699

       ,("-<",  ITlarrowtail, arrowsEnabled)
       ,(">-",  ITrarrowtail, arrowsEnabled)
       ,("-<<", ITLarrowtail, arrowsEnabled)
       ,(">>-", ITRarrowtail, arrowsEnabled)
700

Ian Lynagh's avatar
Ian Lynagh committed
701 702
       ,("∷",   ITdcolon, unicodeSyntaxEnabled)
       ,("⇒",   ITdarrow, unicodeSyntaxEnabled)
Ian Lynagh's avatar
Ian Lynagh committed
703 704
       ,("∀",   ITforall, \i -> unicodeSyntaxEnabled i &&
                                explicitForallEnabled i)
Ian Lynagh's avatar
Ian Lynagh committed
705 706
       ,("→",   ITrarrow, unicodeSyntaxEnabled)
       ,("←",   ITlarrow, unicodeSyntaxEnabled)
707 708 709 710 711 712 713 714

       ,("⤙",   ITlarrowtail, \i -> unicodeSyntaxEnabled i && arrowsEnabled i)
       ,("⤚",   ITrarrowtail, \i -> unicodeSyntaxEnabled i && arrowsEnabled i)
       ,("⤛",   ITLarrowtail, \i -> unicodeSyntaxEnabled i && arrowsEnabled i)
       ,("⤜",   ITRarrowtail, \i -> unicodeSyntaxEnabled i && arrowsEnabled i)

       ,("★", ITstar, unicodeSyntaxEnabled)

Simon Marlow's avatar
Simon Marlow committed
715 716 717
        -- ToDo: ideally, → and ∷ should be "specials", so that they cannot
        -- form part of a large operator.  This would let us have a better
        -- syntax for kinds: ɑ∷*→* would be a legal kind signature. (maybe).
718 719 720 721 722
       ]

-- -----------------------------------------------------------------------------
-- Lexer actions

723
type Action = SrcSpan -> StringBuffer -> Int -> P (Located Token)
724

725
special :: Token -> Action
twanvl's avatar
twanvl committed
726
special tok span _buf _len = return (L span tok)
727

728
token, layout_token :: Token -> Action
twanvl's avatar
twanvl committed
729 730
token t span _buf _len = return (L span t)
layout_token t span _buf _len = pushLexState layout >> return (L span t)
731

732 733
idtoken :: (StringBuffer -> Int -> Token) -> Action
idtoken f span buf len = return (L span $! (f buf len))
734

735 736 737
skip_one_varid :: (FastString -> Token) -> Action
skip_one_varid f span buf len 
  = return (L span $! f (lexemeToFastString (stepOn buf) (len-1)))
738

739 740 741
strtoken :: (String -> Token) -> Action
strtoken f span buf len = 
  return (L span $! (f $! lexemeToString buf len))
742

743
init_strtoken :: Int -> (String -> Token) -> Action
744
-- like strtoken, but drops the last N character(s)
745 746
init_strtoken drop f span buf len = 
  return (L span $! (f $! lexemeToString buf (len-drop)))
747 748

begin :: Int -> Action
749
begin code _span _str _len = do pushLexState code; lexToken
750 751

pop :: Action
Ian Lynagh's avatar
Ian Lynagh committed
752 753
pop _span _buf _len = do _ <- popLexState
                         lexToken
754 755

pop_and :: Action -> Action
Ian Lynagh's avatar
Ian Lynagh committed
756 757
pop_and act span buf len = do _ <- popLexState
                              act span buf len
758

759
{-# INLINE nextCharIs #-}
Ian Lynagh's avatar
Ian Lynagh committed
760
nextCharIs :: StringBuffer -> (Char -> Bool) -> Bool
761 762
nextCharIs buf p = not (atEnd buf) && p (currentChar buf)

Ian Lynagh's avatar
Ian Lynagh committed
763
notFollowedBy :: Char -> AlexAccPred Int
764
notFollowedBy char _ _ _ (AI _ buf) 
765
  = nextCharIs buf (/=char)
766

Ian Lynagh's avatar
Ian Lynagh committed
767
notFollowedBySymbol :: AlexAccPred Int
768
notFollowedBySymbol _ _ _ (AI _ buf)
769
  = nextCharIs buf (`notElem` "!#$%&*+./<=>?@\\^|-~")
ross's avatar
ross committed
770

771 772 773 774 775
-- We must reject doc comments as being ordinary comments everywhere.
-- In some cases the doc comment will be selected as the lexeme due to
-- maximal munch, but not always, because the nested comment rule is
-- valid in all states, but the doc-comment rules are only valid in
-- the non-layout states.
Ian Lynagh's avatar
Ian Lynagh committed
776
isNormalComment :: AlexAccPred Int
777
isNormalComment bits _ _ (AI _ buf)
778 779 780 781 782 783
  | haddockEnabled bits = notFollowedByDocOrPragma
  | otherwise           = nextCharIs buf (/='#')
  where
    notFollowedByDocOrPragma
       = not $ spaceAndP buf (`nextCharIs` (`elem` "|^*$#"))

Ian Lynagh's avatar
Ian Lynagh committed
784
spaceAndP :: StringBuffer -> (StringBuffer -> Bool) -> Bool
785
spaceAndP buf p = p buf || nextCharIs buf (==' ') && p (snd (nextChar buf))
786

twanvl's avatar
twanvl committed
787
{-
788
haddockDisabledAnd p bits _ _ (AI _ buf)
789
  = if haddockEnabled bits then False else (p buf)
twanvl's avatar
twanvl committed
790
-}
791

Ian Lynagh's avatar
Ian Lynagh committed
792
atEOL :: AlexAccPred Int
793
atEOL _ _ _ (AI _ buf) = atEnd buf || currentChar buf == '\n'
794

Ian Lynagh's avatar
Ian Lynagh committed
795
ifExtension :: (Int -> Bool) -> AlexAccPred Int
796 797
ifExtension pred bits _ _ _ = pred bits

798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825
multiline_doc_comment :: Action
multiline_doc_comment span buf _len = withLexedDocType (worker "")
  where
    worker commentAcc input docType oneLine = case alexGetChar input of
      Just ('\n', input') 
        | oneLine -> docCommentEnd input commentAcc docType buf span
        | otherwise -> case checkIfCommentLine input' of
          Just input -> worker ('\n':commentAcc) input docType False
          Nothing -> docCommentEnd input commentAcc docType buf span
      Just (c, input) -> worker (c:commentAcc) input docType oneLine
      Nothing -> docCommentEnd input commentAcc docType buf span
      
    checkIfCommentLine input = check (dropNonNewlineSpace input)
      where
        check input = case alexGetChar input of
          Just ('-', input) -> case alexGetChar input of
            Just ('-', input) -> case alexGetChar input of
              Just (c, _) | c /= '-' -> Just input
              _ -> Nothing
            _ -> Nothing
          _ -> Nothing

        dropNonNewlineSpace input = case alexGetChar input of
          Just (c, input') 
            | isSpace c && c /= '\n' -> dropNonNewlineSpace input'
            | otherwise -> input
          Nothing -> input

Jedai's avatar
Jedai committed
826 827 828 829 830
lineCommentToken :: Action
lineCommentToken span buf len = do
  b <- extension rawTokenStreamEnabled
  if b then strtoken ITlineComment span buf len else lexToken

831 832 833 834
{-
  nested comments require traversing by hand, they can't be parsed
  using regular expressions.
-}
835 836
nested_comment :: P (Located Token) -> Action
nested_comment cont span _str _len = do
837
  input <- getInput
Jedai's avatar
Jedai committed
838
  go "" (1::Int) input
839
  where
Jedai's avatar
Jedai committed
840 841 842 843 844 845
    go commentAcc 0 input = do setInput input
                               b <- extension rawTokenStreamEnabled
                               if b
                                 then docCommentEnd input commentAcc ITblockComment _str span
                                 else cont
    go commentAcc n input = case alexGetChar input of
846 847 848
      Nothing -> errBrace input span
      Just ('-',input) -> case alexGetChar input of
        Nothing  -> errBrace input span
Jedai's avatar
Jedai committed
849 850
        Just ('\125',input) -> go commentAcc (n-1) input
        Just (_,_)          -> go ('-':commentAcc) n input
851 852
      Just ('\123',input) -> case alexGetChar input of
        Nothing  -> errBrace input span
Jedai's avatar
Jedai committed
853 854 855
        Just ('-',input) -> go ('-':'\123':commentAcc) (n+1) input
        Just (_,_)       -> go ('\123':commentAcc) n input
      Just (c,input) -> go (c:commentAcc) n input
856 857 858 859 860 861 862 863

nested_doc_comment :: Action
nested_doc_comment span buf _len = withLexedDocType (go "")
  where
    go commentAcc input docType _ = case alexGetChar input of
      Nothing -> errBrace input span
      Just ('-',input) -> case alexGetChar input of
        Nothing -> errBrace input span
twanvl's avatar
twanvl committed
864
        Just ('\125',input) ->
865
          docCommentEnd input commentAcc docType buf span
twanvl's avatar
twanvl committed
866
        Just (_,_) -> go ('-':commentAcc) input docType False
867 868 869 870 871 872
      Just ('\123', input) -> case alexGetChar input of
        Nothing  -> errBrace input span
        Just ('-',input) -> do
          setInput input
          let cont = do input <- getInput; go commentAcc input docType False
          nested_comment cont span buf _len
twanvl's avatar
twanvl committed
873
        Just (_,_) -> go ('\123':commentAcc) input docType False
874 875
      Just (c,input) -> go (c:commentAcc) input docType False

Ian Lynagh's avatar
Ian Lynagh committed
876 877
withLexedDocType :: (AlexInput -> (String -> Token) -> Bool -> P (Located Token))
                 -> P (Located Token)
878
withLexedDocType lexDocComment = do
879
  input@(AI _ buf) <- getInput
880 881 882 883
  case prevChar buf ' ' of
    '|' -> lexDocComment input ITdocCommentNext False
    '^' -> lexDocComment input ITdocCommentPrev False
    '$' -> lexDocComment input ITdocCommentNamed False
David Waern's avatar
David Waern committed
884 885
    '*' -> lexDocSection 1 input
    '#' -> lexDocComment input ITdocOptionsOld False
Ian Lynagh's avatar
Ian Lynagh committed
886
    _ -> panic "withLexedDocType: Bad doc type"
887 888 889
 where 
    lexDocSection n input = case alexGetChar input of 
      Just ('*', input) -> lexDocSection (n+1) input
twanvl's avatar
twanvl committed
890
      Just (_,   _)     -> lexDocComment input (ITdocSection n) True
891 892
      Nothing -> do setInput input; lexToken -- eof reached, lex it normally

893 894 895
-- RULES pragmas turn on the forall and '.' keywords, and we turn them
-- off again at the end of the pragma.
rulePrag :: Action
896
rulePrag span _buf _len = do
897
  setExts (.|. bit inRulePragBit)
898 899 900
  return (L span ITrules_prag)

endPrag :: Action
901
endPrag span _buf _len = do
902 903 904
  setExts (.&. complement (bit inRulePragBit))
  return (L span ITclose_prag)

905 906 907 908 909 910 911 912 913 914 915 916
-- docCommentEnd
-------------------------------------------------------------------------------
-- This function is quite tricky. We can't just return a new token, we also
-- need to update the state of the parser. Why? Because the token is longer
-- than what was lexed by Alex, and the lexToken function doesn't know this, so 
-- it writes the wrong token length to the parser state. This function is
-- called afterwards, so it can just update the state. 

docCommentEnd :: AlexInput -> String -> (String -> Token) -> StringBuffer ->
                 SrcSpan -> P (Located Token) 
docCommentEnd input commentAcc docType buf span = do
  setInput input
917
  let (AI loc nextBuf) = input
918 919 920 921
      comment = reverse commentAcc
      span' = mkSrcSpan (srcSpanStart span) loc
      last_len = byteDiff buf nextBuf
      
922
  span `seq` setLastToken span' last_len
923 924
  return (L span' (docType comment))
 
Ian Lynagh's avatar
Ian Lynagh committed
925
errBrace :: AlexInput -> SrcSpan -> P a
926
errBrace (AI end _) span = failLocMsgP (srcSpanStart span) end "unterminated `{-'"
Ian Lynagh's avatar
Ian Lynagh committed
927

928
open_brace, close_brace :: Action
929
open_brace span _str _len = do 
930 931
  ctx <- getContext
  setContext (NoLayout:ctx)
932 933
  return (L span ITocurly)
close_brace span _str _len = do 
934
  popContext
935
  return (L span ITccurly)
936

Ian Lynagh's avatar
Ian Lynagh committed
937
qvarid, qconid :: StringBuffer -> Int -> Token
938 939
qvarid buf len = ITqvarid $! splitQualName buf len False
qconid buf len = ITqconid $! splitQualName buf len False
940

941
splitQualName :: StringBuffer -> Int -> Bool -> (FastString,FastString)
942 943 944
-- takes a StringBuffer and a length, and returns the module name
-- and identifier parts of a qualified name.  Splits at the *last* dot,
-- because of hierarchical module names.
945
splitQualName orig_buf len parens = split orig_buf orig_buf
946
  where
947 948 949 950 951 952
    split buf dot_buf
	| orig_buf `byteDiff` buf >= len  = done dot_buf
	| c == '.'                	  = found_dot buf'
	| otherwise               	  = split buf' dot_buf
      where
       (c,buf') = nextChar buf
953 954 955 956
  
    -- careful, we might get names like M....
    -- so, if the character after the dot is not upper-case, this is
    -- the end of the qualifier part.
957 958 959 960 961 962 963 964
    found_dot buf -- buf points after the '.'
	| isUpper c    = split buf' buf
	| otherwise    = done buf
      where
       (c,buf') = nextChar buf

    done dot_buf =
	(lexemeToFastString orig_buf (qual_size - 1),
965 966 967
	 if parens -- Prelude.(+)
            then lexemeToFastString (stepOn dot_buf) (len - qual_size - 2)
            else lexemeToFastString dot_buf (len - qual_size))
968 969
      where
	qual_size = orig_buf `byteDiff` dot_buf
970

Ian Lynagh's avatar
Ian Lynagh committed
971 972
varid :: Action
varid span buf len =
Ian Lynagh's avatar
Ian Lynagh committed
973
  fs `seq`
974 975 976
  case lookupUFM reservedWordsFM fs of
	Just (keyword,0)    -> do
		maybe_layout keyword
977
		return (L span keyword)
978 979 980
	Just (keyword,exts) -> do
		b <- extension (\i -> exts .&. i /= 0)
		if b then do maybe_layout keyword
981 982 983
			     return (L span keyword)
		     else return (L span (ITvarid fs))
	_other -> return (L span (ITvarid fs))
984 985 986
  where
	fs = lexemeToFastString buf len

Ian Lynagh's avatar
Ian Lynagh committed
987
conid :: StringBuffer -> Int -> Token
988 989 990
conid buf len = ITconid fs
  where fs = lexemeToFastString buf len

Ian Lynagh's avatar
Ian Lynagh committed
991
qvarsym, qconsym, prefixqvarsym, prefixqconsym :: StringBuffer -> Int -> Token
992 993 994 995
qvarsym buf len = ITqvarsym $! splitQualName buf len False
qconsym buf len = ITqconsym $! splitQualName buf len False
prefixqvarsym buf len = ITprefixqvarsym $! splitQualName buf len True
prefixqconsym buf len = ITprefixqconsym $! splitQualName buf len True
996

Ian Lynagh's avatar
Ian Lynagh committed
997
varsym, consym :: Action
998 999 1000
varsym = sym ITvarsym
consym = sym ITconsym

Ian Lynagh's avatar
Ian Lynagh committed
1001 1002
sym :: (FastString -> Token) -> SrcSpan -> StringBuffer -> Int
    -> P (Located Token)
1003
sym con span buf len = 
1004 1005
  case lookupUFM reservedSymsFM fs of
	Just (keyword,exts) -> do
Ian Lynagh's avatar
Ian Lynagh committed
1006
		b <- extension exts
1007 1008 1009
		if b then return (L span keyword)
		     else return (L span $! con fs)
	_other -> return (L span $! con fs)
1010 1011 1012
  where
	fs = lexemeToFastString buf len

1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023
-- Variations on the integral numeric literal.
tok_integral :: (Integer -> Token)
     -> (Integer -> Integer)
 --    -> (StringBuffer -> StringBuffer) -> (Int -> Int)
     -> Int -> Int
     -> (Integer, (Char->Int)) -> Action
tok_integral itint transint transbuf translen (radix,char_to_int) span buf len =
  return $ L span $ itint $! transint $ parseUnsignedInteger
     (offsetBytes transbuf buf) (subtract translen len) radix char_to_int

-- some conveniences for use with tok_integral
Ian Lynagh's avatar
Ian Lynagh committed
1024 1025 1026
tok_num :: (Integer -> Integer)
        -> Int -> Int
        -> (Integer, (Char->Int)) -> Action
1027
tok_num = tok_integral ITinteger
Ian Lynagh's avatar
Ian Lynagh committed
1028 1029 1030
tok_primint :: (Integer -> Integer)
            -> Int -> Int
            -> (Integer, (Char->Int)) -> Action
1031
tok_primint = tok_integral ITprimint
Ian Lynagh's avatar
Ian Lynagh committed
1032 1033
tok_primword :: Int -> Int
             -> (Integer, (Char->Int)) -> Action
Ian Lynagh's avatar
Ian Lynagh committed
1034
tok_primword = tok_integral ITprimword positive
Ian Lynagh's avatar
Ian Lynagh committed
1035
positive, negative :: (Integer -> Integer)
1036 1037
positive = id
negative = negate
Ian Lynagh's avatar
Ian Lynagh committed
1038
decimal, octal, hexadecimal :: (Integer, Char -> Int)
1039 1040 1041 1042 1043
decimal = (10,octDecDigit)
octal = (8,octDecDigit)
hexadecimal = (16,hexDigit)

-- readRational can understand negative rationals, exponents, everything.
Ian Lynagh's avatar
Ian Lynagh committed
1044
tok_float, tok_primfloat, tok_primdouble :: String -> Token
1045
tok_float        str = ITrational   $! readRational str
1046 1047
tok_primfloat    str = ITprimfloat  $! readRational str
tok_primdouble   str = ITprimdouble $! readRational str
1048 1049 1050 1051 1052 1053

-- -----------------------------------------------------------------------------
-- Layout processing

-- we're at the first token on a line, insert layout tokens if necessary
do_bol :: Action
1054
do_bol span _str _len = do
1055
	pos <- getOffside
1056 1057 1058 1059 1060
	case pos of
	    LT -> do
                --trace "layout: inserting '}'" $ do
		popContext
		-- do NOT pop the lex state, we might have a ';' to insert
1061
		return (L span ITvccurly)
1062 1063
	    EQ -> do
                --trace "layout: inserting ';'" $ do
Ian Lynagh's avatar
Ian Lynagh committed
1064
		_ <- popLexState
1065
		return (L span ITsemi)
1066
	    GT -> do
Ian Lynagh's avatar
Ian Lynagh committed
1067
		_ <- popLexState
1068 1069 1070 1071
		lexToken

-- certain keywords put us in the "layout" state, where we might
-- add an opening curly brace.
Ian Lynagh's avatar
Ian Lynagh committed
1072
maybe_layout :: Token -> P ()
1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088
maybe_layout t = do -- If the alternative layout rule is enabled then
                    -- we never create an implicit layout context here.
                    -- Layout is handled XXX instead.
                    -- The code for closing implicit contexts, or
                    -- inserting implicit semi-colons, is therefore
                    -- irrelevant as it only applies in an implicit
                    -- context.
                    alr <- extension alternativeLayoutRule
                    unless alr $ f t
    where f ITdo    = pushLexState layout_do
          f ITmdo   = pushLexState layout_do
          f ITof    = pushLexState layout
          f ITlet   = pushLexState layout
          f ITwhere = pushLexState layout
          f ITrec   = pushLexState layout
          f _       = return ()
1089 1090 1091 1092 1093 1094 1095 1096 1097 1098

-- Pushing a new implicit layout context.  If the indentation of the
-- next token is not greater than the previous layout context, then
-- Haskell 98 says that the new layout context should be empty; that is
-- the lexer must generate {}.
--
-- We are slightly more lenient than this: when the new context is started
-- by a 'do', then we allow the new context to be at the same indentation as
-- the previous context.  This is what the 'strict' argument is for.
--
Ian Lynagh's avatar
Ian Lynagh committed
1099
new_layout_context :: Bool -> Action
1100
new_layout_context strict span _buf _len = do
Ian Lynagh's avatar
Ian Lynagh committed
1101
    _ <- popLexState
1102 1103
    (AI l _) <- getInput
    let offset = srcLocCol l
1104 1105 1106 1107 1108 1109 1110 1111
    ctx <- getContext
    case ctx of
	Layout prev_off : _  | 
	   (strict     && prev_off >= offset  ||
	    not strict && prev_off > offset) -> do
		-- token is indented to the left of the previous context.
		-- we must generate a {} sequence now.
		pushLexState layout_left
1112
		return (L span ITvocurly)
twanvl's avatar
twanvl committed
1113
	_ -> do
1114
		setContext (Layout offset : ctx)
1115
		return (L span ITvocurly)
1116

Ian Lynagh's avatar
Ian Lynagh committed
1117
do_layout_left :: Action
1118
do_layout_left span _buf _len = do
Ian Lynagh's avatar
Ian Lynagh committed
1119
    _ <- popLexState
1120
    pushLexState bol  -- we must be at the start of a line
1121
    return (L span ITvccurly)
1122 1123 1124 1125

-- -----------------------------------------------------------------------------
-- LINE pragmas

1126 1127
setLine :: Int -> Action
setLine code span buf len = do
1128
  let line = parseUnsignedInteger buf len 10 octDecDigit
1129
  setSrcLoc (mkSrcLoc (srcSpanFile span) (fromIntegral line - 1) 1)
1130
	-- subtract one: the line number refers to the *following* line
Ian Lynagh's avatar
Ian Lynagh committed
1131
  _ <- popLexState
simonmar's avatar