Lexer.x 105 KB
Newer Older
1
-----------------------------------------------------------------------------
2
-- (c) The University of Glasgow, 2006
3
--
4
-- GHC's lexer for Haskell 2010 [1].
5
--
6 7
-- This is a combination of an Alex-generated lexer [2] from a regex
-- definition, with some hand-coded bits. [3]
8 9
--
-- Completely accurate information about token-spans within the source
Ian Lynagh's avatar
Ian Lynagh committed
10 11
-- file is maintained.  Every token has a start and end RealSrcLoc
-- attached to it.
12
--
13 14 15 16 17
-- References:
-- [1] https://www.haskell.org/onlinereport/haskell2010/haskellch2.html
-- [2] http://www.haskell.org/alex/
-- [3] https://ghc.haskell.org/trac/ghc/wiki/Commentary/Compiler/Parser
--
18 19 20 21 22 23 24 25 26 27
-----------------------------------------------------------------------------

--   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

28
--   qualified operator NOTES.
Ian Lynagh's avatar
Ian Lynagh committed
29
--
30 31 32 33 34 35 36 37 38
--   - 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.

39 40 41 42

-- -----------------------------------------------------------------------------
-- Alex "Haskell code fragment top"

43
{
44
{-# LANGUAGE BangPatterns #-}
45 46

-- See Note [Warnings in code generated by Alex] in compiler/parser/Lexer.x
47 48
{-# OPTIONS_GHC -fno-warn-unused-matches #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
49
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
50
{-# OPTIONS_GHC -fno-warn-tabs #-}
51
{-# OPTIONS_GHC -fno-warn-missing-signatures #-}
52

53 54
{-# OPTIONS_GHC -funbox-strict-fields #-}

55
module Lexer (
Alan Zimmerman's avatar
Alan Zimmerman committed
56
   Token(..), lexer, pragState, mkPState, PState(..),
Ian Lynagh's avatar
Ian Lynagh committed
57
   P(..), ParseResult(..), getSrcLoc,
58
   getPState, getDynFlags, withThisPackage,
59
   failLocMsgP, failSpanMsgP, srcParseFail,
Ian Lynagh's avatar
Ian Lynagh committed
60
   getMessages,
61
   popContext, pushCurrentContext, setLastToken, setSrcLoc,
vivian's avatar
vivian committed
62
   activeContext, nextIsEOF,
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
63
   getLexState, popLexState, pushLexState,
64
   extension, bangPatEnabled, datatypeContextsEnabled,
65
   traditionalRecordSyntaxEnabled,
66 67
   explicitForallEnabled,
   inRulePrag,
cactus's avatar
cactus committed
68 69 70
   explicitNamespacesEnabled,
   patternSynonymsEnabled,
   sccProfilingOn, hpcEnabled,
Jedai's avatar
Jedai committed
71
   addWarning,
Alan Zimmerman's avatar
Alan Zimmerman committed
72
   lexTokenStream,
Alan Zimmerman's avatar
Alan Zimmerman committed
73
   addAnnotation,AddAnn,mkParensApiAnn
74 75
  ) where

rodlogic's avatar
rodlogic committed
76
-- base
77
#if __GLASGOW_HASKELL__ < 709
rodlogic's avatar
rodlogic committed
78
import Control.Applicative
79
#endif
rodlogic's avatar
rodlogic committed
80 81
import Control.Monad
import Data.Bits
82
import Data.Char
rodlogic's avatar
rodlogic committed
83 84 85 86 87 88 89 90 91 92 93 94
import Data.List
import Data.Maybe
import Data.Word

-- bytestring
import Data.ByteString (ByteString)

-- containers
import Data.Map (Map)
import qualified Data.Map as Map

-- compiler/utils
95
import Bag
96 97 98 99
import Outputable
import StringBuffer
import FastString
import UniqFM
rodlogic's avatar
rodlogic committed
100 101 102 103
import Util             ( readRational )

-- compiler/main
import ErrUtils
104
import DynFlags
rodlogic's avatar
rodlogic committed
105 106 107

-- compiler/basicTypes
import SrcLoc
108
import Module
Alan Zimmerman's avatar
Alan Zimmerman committed
109 110
import BasicTypes     ( InlineSpec(..), RuleMatchInfo(..), FractionalLit(..),
                        SourceText )
111

rodlogic's avatar
rodlogic committed
112 113
-- compiler/parser
import Ctype
Alan Zimmerman's avatar
Alan Zimmerman committed
114 115

import ApiAnnotation
116 117
}

118 119 120
-- -----------------------------------------------------------------------------
-- Alex "Character set macros"

121 122
-- NB: The logic behind these definitions is also reflected in basicTypes/Lexeme.hs
-- Any changes here should likely be reflected there.
123 124 125 126
$unispace    = \x05 -- Trick Alex into handling Unicode. See alexGetByte.
$nl          = [\n\r\f]
$whitechar   = [$nl\v\ $unispace]
$white_no_nl = $whitechar # \n -- TODO #8424
127
$tab         = \t
128 129

$ascdigit  = 0-9
130
$unidigit  = \x03 -- Trick Alex into handling Unicode. See alexGetByte.
131
$decdigit  = $ascdigit -- for now, should really be $digit (ToDo)
132 133 134
$digit     = [$ascdigit $unidigit]

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

139
$unilarge  = \x01 -- Trick Alex into handling Unicode. See alexGetByte.
140
$asclarge  = [A-Z]
141 142
$large     = [$asclarge $unilarge]

143
$unismall  = \x02 -- Trick Alex into handling Unicode. See alexGetByte.
144
$ascsmall  = [a-z]
145 146
$small     = [$ascsmall $unismall \_]

147 148
$unigraphic = \x06 -- Trick Alex into handling Unicode. See alexGetByte.
$graphic   = [$small $large $symbol $digit $special $unigraphic \"\']
149

150
$binit     = 0-1
Ian Lynagh's avatar
Ian Lynagh committed
151
$octit     = 0-7
152
$hexit     = [$decdigit A-F a-f]
153 154 155 156

$suffix    = \x07 -- Trick Alex into handling Unicode. See alexGetByte.
-- TODO #10196. Only allow modifier letters in the suffix of an identifier.
$idchar    = [$small $large $digit $suffix \']
157

158 159
$pragmachar = [$small $large $digit]

160 161
$docsym    = [\| \^ \* \$]

162

163 164 165 166 167 168 169 170
-- -----------------------------------------------------------------------------
-- Alex "Regular expression macros"

@varid     = $small $idchar*          -- variable identifiers
@conid     = $large $idchar*          -- constructor identifiers

@varsym    = ($symbol # \:) $symbol*  -- variable (operator) symbol
@consym    = \: $symbol*              -- constructor (operator) symbol
171

172
@decimal     = $decdigit+
173
@binary      = $binit+
174 175 176 177 178
@octal       = $octit+
@hexadecimal = $hexit+
@exponent    = [eE] [\-\+]? @decimal

@qual = (@conid \.)+
179 180 181 182
@qvarid = @qual @varid
@qconid = @qual @conid
@qvarsym = @qual @varsym
@qconsym = @qual @consym
183 184 185

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

186 187 188 189 190
-- normal signed numerical literals can only be explicitly negative,
-- not explicitly positive (contrast @exponent)
@negative = \-
@signed = @negative ?

191 192 193 194

-- -----------------------------------------------------------------------------
-- Alex "Identifier"

195 196
haskell :-

197 198 199 200 201

-- -----------------------------------------------------------------------------
-- Alex "Rules"

-- everywhere: skip whitespace
Ian Lynagh's avatar
Ian Lynagh committed
202
$white_no_nl+ ;
203
$tab          { warnTab }
204 205 206 207 208

-- 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
209 210 211 212
-- are). We also rule out nested Haddock comments, if the -haddock flag is
-- set.

"{-" / { isNormalComment } { nested_comment lexToken }
213 214 215 216

-- 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.
217 218

-- Since Haddock comments aren't valid in every state, we need to rule them
Ian Lynagh's avatar
Ian Lynagh committed
219
-- out here.
220 221 222 223 224 225 226

-- 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
227
"-- " ~[$docsym \#] .* { lineCommentToken }
228
"--" [^$symbol \ ] .* { lineCommentToken }
229 230 231

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

Jedai's avatar
Jedai committed
232
"-- " [$docsym \#] .* / { ifExtension (not . haddockEnabled) } { lineCommentToken }
233 234 235 236 237 238 239

-- 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.

240
"---"\-* ~$symbol .* { lineCommentToken }
241 242 243 244

-- 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
245
"--"\-* / { atEOL } { lineCommentToken }
246 247 248 249

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

Jedai's avatar
Jedai committed
250
"-- " / { atEOL } { lineCommentToken }
251 252 253 254 255 256 257 258 259 260 261

-- '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> {
Ian Lynagh's avatar
Ian Lynagh committed
262
  \n                                    ;
Adam Gundry's avatar
Adam Gundry committed
263 264
  ^\# line                              { begin line_prag1 }
  ^\# / { followedByDigit }             { begin line_prag1 }
Ian Lynagh's avatar
Ian Lynagh committed
265 266 267
  ^\# pragma .* \n                      ; -- GCC 3.3 CPP generated, apparently
  ^\# \! .* \n                          ; -- #!, for scripts
  ()                                    { do_bol }
268 269 270 271 272
}

-- 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.
273
<layout, layout_do, layout_if> {
Ian Lynagh's avatar
Ian Lynagh committed
274 275 276 277
  \{ / { notFollowedBy '-' }            { hopefully_open_brace }
        -- we might encounter {-# here, but {- has been handled already
  \n                                    ;
  ^\# (line)?                           { begin line_prag1 }
278 279
}

280 281 282 283 284 285
-- after an 'if', a vertical bar starts a layout context for MultiWayIf
<layout_if> {
  \| / { notFollowedBySymbol }          { new_layout_context True ITvbar }
  ()                                    { pop }
}

286
-- do is treated in a subtly different way, see new_layout_context
287 288
<layout>    ()                          { new_layout_context True  ITvocurly }
<layout_do> ()                          { new_layout_context False ITvocurly }
289 290 291 292

-- 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.
Ian Lynagh's avatar
Ian Lynagh committed
293
<layout_left>  ()                       { do_layout_left }
294

Ian Lynagh's avatar
Ian Lynagh committed
295
<0,option_prags> \n                     { begin bol }
296

297 298
"{-#" $whitechar* $pragmachar+ / { known_pragma linePrags }
                                { dispatch_pragmas linePrags }
299 300 301

-- single-line line pragmas, of the form
--    # <line> "<file>" <extra-stuff> \n
302
<line_prag1> @decimal                   { setLine line_prag1a }
Ian Lynagh's avatar
Ian Lynagh committed
303 304
<line_prag1a> \" [$graphic \ ]* \"      { setFile line_prag1b }
<line_prag1b> .*                        { pop }
305 306 307

-- Haskell-style line pragmas, of the form
--    {-# LINE <line> "<file>" #-}
308
<line_prag2> @decimal                   { setLine line_prag2a }
Ian Lynagh's avatar
Ian Lynagh committed
309 310
<line_prag2a> \" [$graphic \ ]* \"      { setFile line_prag2b }
<line_prag2b> "#-}"|"-}"                { pop }
311 312
   -- NOTE: accept -} at the end of a LINE pragma, for compatibility
   -- with older versions of GHC which generated these.
313

314
<0,option_prags> {
Ian Lynagh's avatar
Ian Lynagh committed
315
  "{-#" $whitechar* $pragmachar+
316 317 318 319 320
        $whitechar+ $pragmachar+ / { known_pragma twoWordPrags }
                                 { dispatch_pragmas twoWordPrags }

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

322
  -- We ignore all these pragmas, but don't generate a warning for them
323 324
  "{-#" $whitechar* $pragmachar+ / { known_pragma ignoredPrags }
                                 { dispatch_pragmas ignoredPrags }
325 326

  -- ToDo: should only be valid inside a pragma:
Ian Lynagh's avatar
Ian Lynagh committed
327
  "#-}"                          { endPrag }
328 329
}

330
<option_prags> {
331 332 333
  "{-#"  $whitechar* $pragmachar+ / { known_pragma fileHeaderPrags }
                                   { dispatch_pragmas fileHeaderPrags }

Ian Lynagh's avatar
Ian Lynagh committed
334
  "-- #"                           { multiline_doc_comment }
David Waern's avatar
David Waern committed
335 336
}

337 338
<0> {
  -- In the "0" mode we ignore these pragmas
339
  "{-#"  $whitechar* $pragmachar+ / { known_pragma fileHeaderPrags }
340 341 342
                     { nested_comment lexToken }
}

David Waern's avatar
David Waern committed
343
<0> {
Jedai's avatar
Jedai committed
344
  "-- #" .* { lineCommentToken }
345
}
346

347
<0,option_prags> {
348 349
  "{-#"  { warnThen Opt_WarnUnrecognisedPragmas (text "Unrecognised pragma")
                    (nested_comment lexToken) }
350 351
}

352 353
-- '0' state: ordinary lexemes

354 355
-- Haddock comments

356
<0,option_prags> {
David Waern's avatar
David Waern committed
357 358
  "-- " $docsym      / { ifExtension haddockEnabled } { multiline_doc_comment }
  "{-" \ ? $docsym   / { ifExtension haddockEnabled } { nested_doc_comment }
359 360
}

361 362
-- "special" symbols

363
<0> {
Ian Lynagh's avatar
Ian Lynagh committed
364 365
  "[:" / { ifExtension parrEnabled }    { token ITopabrack }
  ":]" / { ifExtension parrEnabled }    { token ITcpabrack }
366
}
Ian Lynagh's avatar
Ian Lynagh committed
367

368
<0> {
369 370 371 372
  "[|"        / { ifExtension thEnabled } { token (ITopenExpQuote NoE) }
  "[||"       / { ifExtension thEnabled } { token (ITopenTExpQuote NoE) }
  "[e|"       / { ifExtension thEnabled } { token (ITopenExpQuote HasE) }
  "[e||"      / { ifExtension thEnabled } { token (ITopenTExpQuote HasE) }
373 374 375 376 377 378 379 380 381
  "[p|"       / { ifExtension thEnabled } { token ITopenPatQuote }
  "[d|"       / { ifExtension thEnabled } { layout_token ITopenDecQuote }
  "[t|"       / { ifExtension thEnabled } { token ITopenTypQuote }
  "|]"        / { ifExtension thEnabled } { token ITcloseQuote }
  "||]"       / { ifExtension thEnabled } { token ITcloseTExpQuote }
  \$ @varid   / { ifExtension thEnabled } { skip_one_varid ITidEscape }
  "$$" @varid / { ifExtension thEnabled } { skip_two_varid ITidTyEscape }
  "$("        / { ifExtension thEnabled } { token ITparenEscape }
  "$$("       / { ifExtension thEnabled } { token ITparenTyEscape }
382

383 384 385 386
-- For backward compatibility, accept the old dollar syntax
  "[$" @varid "|"  / { ifExtension qqEnabled }
                     { lex_quasiquote_tok }

387
  "[" @varid "|"  / { ifExtension qqEnabled }
388
                     { lex_quasiquote_tok }
389 390

  -- qualified quasi-quote (#5555)
391 392
  "[" @qvarid "|"  / { ifExtension qqEnabled }
                     { lex_qquasiquote_tok }
393 394
}

395
<0> {
ross's avatar
ross committed
396
  "(|" / { ifExtension arrowsEnabled `alexAndPred` notFollowedBySymbol }
Ian Lynagh's avatar
Ian Lynagh committed
397
                                        { special IToparenbar }
398 399 400
  "|)" / { ifExtension arrowsEnabled }  { special ITcparenbar }
}

401
<0> {
Ian Lynagh's avatar
Ian Lynagh committed
402
  \? @varid / { ifExtension ipEnabled } { skip_one_varid ITdupipvarid }
403 404
}

Adam Gundry's avatar
Adam Gundry committed
405 406 407 408 409
<0> {
  "#" @varid / { ifExtension overloadedLabelsEnabled }
               { skip_one_varid ITlabelvarid }
}

410
<0> {
411
  "(#" / { ifExtension unboxedTuplesEnabled }
Ian Lynagh's avatar
Ian Lynagh committed
412 413 414 415 416
         { token IToubxparen }
  "#)" / { ifExtension unboxedTuplesEnabled }
         { token ITcubxparen }
}

417
<0,option_prags> {
Ian Lynagh's avatar
Ian Lynagh committed
418 419 420 421 422 423 424 425 426 427
  \(                                    { special IToparen }
  \)                                    { special ITcparen }
  \[                                    { special ITobrack }
  \]                                    { special ITcbrack }
  \,                                    { special ITcomma }
  \;                                    { special ITsemi }
  \`                                    { special ITbackquote }

  \{                                    { open_brace }
  \}                                    { close_brace }
428 429
}

430
<0,option_prags> {
431 432
  @qvarid                       { idtoken qvarid }
  @qconid                       { idtoken qconid }
Ian Lynagh's avatar
Ian Lynagh committed
433
  @varid                        { varid }
434
  @conid                        { idtoken conid }
435 436
}

437
<0> {
438 439
  @qvarid "#"+      / { ifExtension magicHashEnabled } { idtoken qvarid }
  @qconid "#"+      / { ifExtension magicHashEnabled } { idtoken qconid }
440
  @varid "#"+       / { ifExtension magicHashEnabled } { varid }
441
  @conid "#"+       / { ifExtension magicHashEnabled } { idtoken conid }
442 443
}

444 445
-- ToDo: - move `var` and (sym) into lexical syntax?
--       - remove backquote from $special?
446
<0> {
447 448
  @qvarsym                                         { idtoken qvarsym }
  @qconsym                                         { idtoken qconsym }
449 450
  @varsym                                          { varsym }
  @consym                                          { consym }
451 452
}

453 454
-- For the normal boxed literals we need to be careful
-- when trying to be close to Haskell98
455
<0> {
456
  -- Normal integral literals (:: Num a => a, from Integer)
457
  @decimal                                                               { tok_num positive 0 0 decimal }
458
  0[bB] @binary                / { ifExtension binaryLiteralsEnabled }   { tok_num positive 2 2 binary }
459 460 461
  0[oO] @octal                                                           { tok_num positive 2 2 octal }
  0[xX] @hexadecimal                                                     { tok_num positive 2 2 hexadecimal }
  @negative @decimal           / { ifExtension negativeLiteralsEnabled } { tok_num negative 1 1 decimal }
462 463
  @negative 0[bB] @binary      / { ifExtension negativeLiteralsEnabled `alexAndPred`
                                   ifExtension binaryLiteralsEnabled }   { tok_num negative 3 3 binary }
464 465
  @negative 0[oO] @octal       / { ifExtension negativeLiteralsEnabled } { tok_num negative 3 3 octal }
  @negative 0[xX] @hexadecimal / { ifExtension negativeLiteralsEnabled } { tok_num negative 3 3 hexadecimal }
466 467

  -- Normal rational literals (:: Fractional a => a, from Rational)
468 469
  @floating_point                                                        { strtoken tok_float }
  @negative @floating_point    / { ifExtension negativeLiteralsEnabled } { strtoken tok_float }
470 471
}

472
<0> {
Ian Lynagh's avatar
Ian Lynagh committed
473
  -- Unboxed ints (:: Int#) and words (:: Word#)
474 475
  -- It's simpler (and faster?) to give separate cases to the negatives,
  -- especially considering octal/hexadecimal prefixes.
Ian Lynagh's avatar
Ian Lynagh committed
476
  @decimal                     \# / { ifExtension magicHashEnabled } { tok_primint positive 0 1 decimal }
477 478
  0[bB] @binary                \# / { ifExtension magicHashEnabled `alexAndPred`
                                      ifExtension binaryLiteralsEnabled } { tok_primint positive 2 3 binary }
Ian Lynagh's avatar
Ian Lynagh committed
479 480 481
  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 }
482 483
  @negative 0[bB] @binary      \# / { ifExtension magicHashEnabled `alexAndPred`
                                      ifExtension binaryLiteralsEnabled } { tok_primint negative 3 4 binary }
Ian Lynagh's avatar
Ian Lynagh committed
484
  @negative 0[oO] @octal       \# / { ifExtension magicHashEnabled } { tok_primint negative 3 4 octal }
485
  @negative 0[xX] @hexadecimal \# / { ifExtension magicHashEnabled } { tok_primint negative 3 4 hexadecimal }
486

Ian Lynagh's avatar
Ian Lynagh committed
487
  @decimal                     \# \# / { ifExtension magicHashEnabled } { tok_primword 0 2 decimal }
488 489
  0[bB] @binary                \# \# / { ifExtension magicHashEnabled `alexAndPred`
                                         ifExtension binaryLiteralsEnabled } { tok_primword 2 4 binary }
Ian Lynagh's avatar
Ian Lynagh committed
490 491 492
  0[oO] @octal                 \# \# / { ifExtension magicHashEnabled } { tok_primword 2 4 octal }
  0[xX] @hexadecimal           \# \# / { ifExtension magicHashEnabled } { tok_primword 2 4 hexadecimal }

493 494
  -- Unboxed floats and doubles (:: Float#, :: Double#)
  -- prim_{float,double} work with signed literals
495 496
  @signed @floating_point \# / { ifExtension magicHashEnabled } { init_strtoken 1 tok_primfloat }
  @signed @floating_point \# \# / { ifExtension magicHashEnabled } { init_strtoken 2 tok_primdouble }
497 498 499 500 501 502
}

-- 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.
503
<0> {
Ian Lynagh's avatar
Ian Lynagh committed
504 505
  \'                            { lex_char_tok }
  \"                            { lex_string_tok }
506 507
}

508 509 510 511

-- -----------------------------------------------------------------------------
-- Alex "Haskell code fragment bottom"

512
{
513

514 515 516
-- -----------------------------------------------------------------------------
-- The token type

517
data Token
Ian Lynagh's avatar
Ian Lynagh committed
518
  = ITas                        -- Haskell keywords
519 520 521 522 523 524 525 526
  | ITcase
  | ITclass
  | ITdata
  | ITdefault
  | ITderiving
  | ITdo
  | ITelse
  | IThiding
527
  | ITforeign
528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543
  | ITif
  | ITimport
  | ITin
  | ITinfix
  | ITinfixl
  | ITinfixr
  | ITinstance
  | ITlet
  | ITmodule
  | ITnewtype
  | ITof
  | ITqualified
  | ITthen
  | ITtype
  | ITwhere

544
  | ITforall            IsUnicodeSyntax -- GHC extension keywords
545 546 547 548
  | ITexport
  | ITlabel
  | ITdynamic
  | ITsafe
549
  | ITinterruptible
550 551 552
  | ITunsafe
  | ITstdcallconv
  | ITccallconv
553
  | ITcapiconv
554
  | ITprimcallconv
thoughtpolice's avatar
thoughtpolice committed
555
  | ITjavascriptcallconv
556
  | ITmdo
557
  | ITfamily
558
  | ITrole
559 560 561
  | ITgroup
  | ITby
  | ITusing
cactus's avatar
cactus committed
562
  | ITpattern
Facundo Domínguez's avatar
Facundo Domínguez committed
563
  | ITstatic
564

Alan Zimmerman's avatar
Alan Zimmerman committed
565 566 567 568 569 570 571 572
  -- Pragmas, see  note [Pragma source text] in BasicTypes
  | ITinline_prag       SourceText InlineSpec RuleMatchInfo
  | ITspec_prag         SourceText                -- SPECIALISE
  | ITspec_inline_prag  SourceText Bool    -- SPECIALISE INLINE (or NOINLINE)
  | ITsource_prag       SourceText
  | ITrules_prag        SourceText
  | ITwarning_prag      SourceText
  | ITdeprecated_prag   SourceText
573
  | ITline_prag
Alan Zimmerman's avatar
Alan Zimmerman committed
574 575 576 577 578 579
  | ITscc_prag          SourceText
  | ITgenerated_prag    SourceText
  | ITcore_prag         SourceText         -- hdaume: core annotations
  | ITunpack_prag       SourceText
  | ITnounpack_prag     SourceText
  | ITann_prag          SourceText
580
  | ITclose_prag
581 582 583
  | IToptions_prag String
  | ITinclude_prag String
  | ITlanguage_prag
Alan Zimmerman's avatar
Alan Zimmerman committed
584 585 586 587 588 589 590 591 592
  | ITvect_prag         SourceText
  | ITvect_scalar_prag  SourceText
  | ITnovect_prag       SourceText
  | ITminimal_prag      SourceText
  | IToverlappable_prag SourceText  -- instance overlap mode
  | IToverlapping_prag  SourceText  -- instance overlap mode
  | IToverlaps_prag     SourceText  -- instance overlap mode
  | ITincoherent_prag   SourceText  -- instance overlap mode
  | ITctype             SourceText
593

Ian Lynagh's avatar
Ian Lynagh committed
594
  | ITdotdot                    -- reserved symbols
595
  | ITcolon
596
  | ITdcolon            IsUnicodeSyntax
597 598
  | ITequal
  | ITlam
599
  | ITlcase
600
  | ITvbar
601 602
  | ITlarrow            IsUnicodeSyntax
  | ITrarrow            IsUnicodeSyntax
603 604
  | ITat
  | ITtilde
batterseapower's avatar
batterseapower committed
605
  | ITtildehsh
606
  | ITdarrow            IsUnicodeSyntax
607 608
  | ITminus
  | ITbang
609
  | ITstar              IsUnicodeSyntax
610 611
  | ITdot

Ian Lynagh's avatar
Ian Lynagh committed
612
  | ITbiglam                    -- GHC-extension symbols
613

Ian Lynagh's avatar
Ian Lynagh committed
614
  | ITocurly                    -- special symbols
615 616 617 618
  | ITccurly
  | ITvocurly
  | ITvccurly
  | ITobrack
Ian Lynagh's avatar
Ian Lynagh committed
619 620
  | ITopabrack                  -- [:, for parallel arrays with -XParallelArrays
  | ITcpabrack                  -- :], for parallel arrays with -XParallelArrays
621 622 623 624 625 626 627 628 629
  | ITcbrack
  | IToparen
  | ITcparen
  | IToubxparen
  | ITcubxparen
  | ITsemi
  | ITcomma
  | ITunderscore
  | ITbackquote
dreixel's avatar
dreixel committed
630
  | ITsimpleQuote               --  '
631

Ian Lynagh's avatar
Ian Lynagh committed
632
  | ITvarid   FastString        -- identifiers
633 634 635 636 637 638 639 640
  | ITconid   FastString
  | ITvarsym  FastString
  | ITconsym  FastString
  | ITqvarid  (FastString,FastString)
  | ITqconid  (FastString,FastString)
  | ITqvarsym (FastString,FastString)
  | ITqconsym (FastString,FastString)

Ian Lynagh's avatar
Ian Lynagh committed
641
  | ITdupipvarid   FastString   -- GHC extension: implicit param: ?x
Adam Gundry's avatar
Adam Gundry committed
642
  | ITlabelvarid   FastString   -- Overloaded label: #x
643

644 645 646
  | ITchar     SourceText Char       -- Note [Literal source text] in BasicTypes
  | ITstring   SourceText FastString -- Note [Literal source text] in BasicTypes
  | ITinteger  SourceText Integer    -- Note [Literal source text] in BasicTypes
Alan Zimmerman's avatar
Alan Zimmerman committed
647
  | ITrational FractionalLit
648

649 650 651 652
  | ITprimchar   SourceText Char     -- Note [Literal source text] in BasicTypes
  | ITprimstring SourceText ByteString -- Note [Literal source text] @BasicTypes
  | ITprimint    SourceText Integer  -- Note [Literal source text] in BasicTypes
  | ITprimword   SourceText Integer  -- Note [Literal source text] in BasicTypes
653 654
  | ITprimfloat  FractionalLit
  | ITprimdouble FractionalLit
655

656
  -- Template Haskell extension tokens
657
  | ITopenExpQuote HasE         --  [| or [e|
Ian Lynagh's avatar
Ian Lynagh committed
658 659 660 661
  | ITopenPatQuote              --  [p|
  | ITopenDecQuote              --  [d|
  | ITopenTypQuote              --  [t|
  | ITcloseQuote                --  |]
662
  | ITopenTExpQuote HasE        --  [|| or [e||
663
  | ITcloseTExpQuote            --  ||]
Ian Lynagh's avatar
Ian Lynagh committed
664 665
  | ITidEscape   FastString     --  $x
  | ITparenEscape               --  $(
666 667
  | ITidTyEscape   FastString   --  $$x
  | ITparenTyEscape             --  $$(
Ian Lynagh's avatar
Ian Lynagh committed
668
  | ITtyQuote                   --  ''
669 670 671 672 673 674 675 676
  | ITquasiQuote (FastString,FastString,RealSrcSpan)
    -- ITquasiQuote(quoter, quote, loc)
    -- represents a quasi-quote of the form
    -- [quoter| quote |]
  | ITqQuasiQuote (FastString,FastString,FastString,RealSrcSpan)
    -- ITqQuasiQuote(Qual, quoter, quote, loc)
    -- represents a qualified quasi-quote of the form
    -- [Qual.quoter| quote |]
677 678 679 680

  -- Arrow notation extension
  | ITproc
  | ITrec
681 682 683 684 685 686
  | IToparenbar                  --  (|
  | ITcparenbar                  --  |)
  | ITlarrowtail IsUnicodeSyntax --  -<
  | ITrarrowtail IsUnicodeSyntax --  >-
  | ITLarrowtail IsUnicodeSyntax --  -<<
  | ITRarrowtail IsUnicodeSyntax --  >>-
687

688 689
  | ITunknown String             -- Used when the lexer can't make sense of it
  | ITeof                        -- end of file token
690 691 692 693 694 695 696

  -- 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
697
  | ITdocOptionsOld   String     -- doc options declared "-- # ..."-style
Jedai's avatar
Jedai committed
698 699
  | ITlineComment     String     -- comment starting by "--"
  | ITblockComment    String     -- comment in {- -}
700

701
  deriving Show
702

Alan Zimmerman's avatar
Alan Zimmerman committed
703 704 705
instance Outputable Token where
  ppr x = text (show x)

Alan Zimmerman's avatar
Alan Zimmerman committed
706

707 708 709 710 711 712 713
-- 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)
--
714
reservedWordsFM :: UniqFM (Token, ExtsBitmap)
715
reservedWordsFM = listToUFM $
Ian Lynagh's avatar
Ian Lynagh committed
716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742
    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 ),

743 744
         ( "forall",         ITforall NormalSyntax,
                                              xbit ExplicitForallBit .|.
745 746
                                              xbit InRulePragBit),
         ( "mdo",            ITmdo,           xbit RecursiveDoBit),
747 748 749
             -- See Note [Lexing type pseudo-keywords]
         ( "family",         ITfamily,        0 ),
         ( "role",           ITrole,          0 ),
750
         ( "pattern",        ITpattern,       xbit PatternSynonymsBit),
Facundo Domínguez's avatar
Facundo Domínguez committed
751
         ( "static",         ITstatic,        0 ),
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772
         ( "group",          ITgroup,         xbit TransformComprehensionsBit),
         ( "by",             ITby,            xbit TransformComprehensionsBit),
         ( "using",          ITusing,         xbit TransformComprehensionsBit),

         ( "foreign",        ITforeign,       xbit FfiBit),
         ( "export",         ITexport,        xbit FfiBit),
         ( "label",          ITlabel,         xbit FfiBit),
         ( "dynamic",        ITdynamic,       xbit FfiBit),
         ( "safe",           ITsafe,          xbit FfiBit .|.
                                              xbit SafeHaskellBit),
         ( "interruptible",  ITinterruptible, xbit InterruptibleFfiBit),
         ( "unsafe",         ITunsafe,        xbit FfiBit),
         ( "stdcall",        ITstdcallconv,   xbit FfiBit),
         ( "ccall",          ITccallconv,     xbit FfiBit),
         ( "capi",           ITcapiconv,      xbit CApiFfiBit),
         ( "prim",           ITprimcallconv,  xbit FfiBit),
         ( "javascript",     ITjavascriptcallconv, xbit FfiBit),

         ( "rec",            ITrec,           xbit ArrowsBit .|.
                                              xbit RecursiveDoBit),
         ( "proc",           ITproc,          xbit ArrowsBit)
773 774
     ]

775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790
{-----------------------------------
Note [Lexing type pseudo-keywords]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

One might think that we wish to treat 'family' and 'role' as regular old
varids whenever -XTypeFamilies and -XRoleAnnotations are off, respectively.
But, there is no need to do so. These pseudo-keywords are not stolen syntax:
they are only used after the keyword 'type' at the top-level, where varids are
not allowed. Furthermore, checks further downstream (TcTyClsDecls) ensure that
type families and role annotations are never declared without their extensions
on. In fact, by unconditionally lexing these pseudo-keywords as special, we
can get better error messages.

Also, note that these are included in the `varid` production in the parser --
a key detail to make all this work.
-------------------------------------}
791

792
reservedSymsFM :: UniqFM (Token, ExtsBitmap -> Bool)
793
reservedSymsFM = listToUFM $
Ian Lynagh's avatar
Ian Lynagh committed
794
    map (\ (x,y,z) -> (mkFastString x,(y,z)))
795
      [ ("..",  ITdotdot,              always)
Ian Lynagh's avatar
Ian Lynagh committed
796
        -- (:) is a reserved op, meaning only list cons
797 798 799 800 801 802 803 804 805 806 807 808 809
       ,(":",   ITcolon,               always)
       ,("::",  ITdcolon NormalSyntax, always)
       ,("=",   ITequal,               always)
       ,("\\",  ITlam,                 always)
       ,("|",   ITvbar,                always)
       ,("<-",  ITlarrow NormalSyntax, always)
       ,("->",  ITrarrow NormalSyntax, always)
       ,("@",   ITat,                  always)
       ,("~",   ITtilde,               always)
       ,("~#",  ITtildehsh,            magicHashEnabled)
       ,("=>",  ITdarrow NormalSyntax, always)
       ,("-",   ITminus,               always)
       ,("!",   ITbang,                always)
Ian Lynagh's avatar
Ian Lynagh committed
810 811

        -- For data T (a::*) = MkT
812 813
       ,("*", ITstar NormalSyntax, always)
                                  -- \i -> kindSigsEnabled i || tyFamEnabled i)
Ian Lynagh's avatar
Ian Lynagh committed
814
        -- For 'forall a . t'
815
       ,(".", ITdot,  always) -- \i -> explicitForallEnabled i || inRulePrag i)
Ian Lynagh's avatar
Ian Lynagh committed
816

817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837
       ,("-<",  ITlarrowtail NormalSyntax, arrowsEnabled)
       ,(">-",  ITrarrowtail NormalSyntax, arrowsEnabled)
       ,("-<<", ITLarrowtail NormalSyntax, arrowsEnabled)
       ,(">>-", ITRarrowtail NormalSyntax, arrowsEnabled)

       ,("∷",   ITdcolon UnicodeSyntax, unicodeSyntaxEnabled)
       ,("⇒",   ITdarrow UnicodeSyntax, unicodeSyntaxEnabled)
       ,("∀",   ITforall UnicodeSyntax, unicodeSyntaxEnabled)
       ,("→",   ITrarrow UnicodeSyntax, unicodeSyntaxEnabled)
       ,("←",   ITlarrow UnicodeSyntax, unicodeSyntaxEnabled)

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

       ,("★", ITstar UnicodeSyntax, unicodeSyntaxEnabled)
838

Simon Marlow's avatar
Simon Marlow committed
839 840 841
        -- 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).
842 843 844 845 846
       ]

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

Ian Lynagh's avatar
Ian Lynagh committed
847
type Action = RealSrcSpan -> StringBuffer -> Int -> P (RealLocated Token)
848

849
special :: Token -> Action
twanvl's avatar
twanvl committed
850
special tok span _buf _len = return (L span tok)
851

852
token, layout_token :: Token -> Action
twanvl's avatar
twanvl committed
853 854
token t span _buf _len = return (L span t)
layout_token t span _buf _len = pushLexState layout >> return (L span t)
855

856 857
idtoken :: (StringBuffer -> Int -> Token) -> Action
idtoken f span buf len = return (L span $! (f buf len))
858

859
skip_one_varid :: (FastString -> Token) -> Action
Ian Lynagh's avatar
Ian Lynagh committed
860
skip_one_varid f span buf len
861
  = return (L span $! f (lexemeToFastString (stepOn buf) (len-1)))
862

863 864 865 866
skip_two_varid :: (FastString -> Token) -> Action
skip_two_varid f span buf len
  = return (L span $! f (lexemeToFastString (stepOn (stepOn buf)) (len-2)))

867
strtoken :: (String -> Token) -> Action
Ian Lynagh's avatar
Ian Lynagh committed
868
strtoken f span buf len =
869
  return (L span $! (f $! lexemeToString buf len))
870

871
init_strtoken :: Int -> (String -> Token) -> Action
872
-- like strtoken, but drops the last N character(s)
Ian Lynagh's avatar
Ian Lynagh committed
873
init_strtoken drop f span buf len =
874
  return (L span $! (f $! lexemeToString buf (len-drop)))
875 876

begin :: Int -> Action
877
begin code _span _str _len = do pushLexState code; lexToken
878 879

pop :: Action
Ian Lynagh's avatar
Ian Lynagh committed
880 881
pop _span _buf _len = do _ <- popLexState
                         lexToken
882

883 884 885 886 887 888 889 890 891 892 893
hopefully_open_brace :: Action
hopefully_open_brace span buf len
 = do relaxed <- extension relaxedLayout
      ctx <- getContext
      (AI l _) <- getInput
      let offset = srcLocCol l
          isOK = relaxed ||
                 case ctx of
                 Layout prev_off : _ -> prev_off < offset
                 _                   -> True
      if isOK then pop_and open_brace span buf len
Ian Lynagh's avatar
Ian Lynagh committed
894
              else failSpanMsgP (RealSrcSpan span) (text "Missing block")
895

896
pop_and :: Action -> Action
Ian Lynagh's avatar
Ian Lynagh committed
897 898
pop_and act span buf len = do _ <- popLexState
                              act span buf len
899

900
{-# INLINE nextCharIs #-}
Ian Lynagh's avatar
Ian Lynagh committed
901
nextCharIs :: StringBuffer -> (Char -> Bool) -> Bool
902 903
nextCharIs buf p = not (atEnd buf) && p (currentChar buf)

904 905 906 907
{-# INLINE nextCharIsNot #-}
nextCharIsNot :: StringBuffer -> (Char -> Bool) -> Bool
nextCharIsNot buf p = not (nextCharIs buf p)

908
notFollowedBy :: Char -> AlexAccPred ExtsBitmap
Ian Lynagh's avatar
Ian Lynagh committed
909
notFollowedBy char _ _ _ (AI _ buf)
910
  = nextCharIsNot buf (== char)
911

912
notFollowedBySymbol :: AlexAccPred ExtsBitmap
913
notFollowedBySymbol _ _ _ (AI _ buf)
914
  = nextCharIsNot buf (`elem` "!#$%&*+./<=>?@\\^|-~")
ross's avatar
ross committed
915

Adam Gundry's avatar
Adam Gundry committed
916 917 918 919
followedByDigit :: AlexAccPred ExtsBitmap
followedByDigit _ _ _ (AI _ buf)
  = afterOptionalSpace buf (\b -> nextCharIs b (`elem` ['0'..'9']))

920 921 922 923 924
-- 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.
925
isNormalComment :: AlexAccPred ExtsBitmap
926
isNormalComment bits _ _ (AI _ buf)
927
  | haddockEnabled bits = notFollowedByDocOrPragma
928
  | otherwise           = nextCharIsNot buf (== '#')
929 930
  where
    notFollowedByDocOrPragma
931
       = afterOptionalSpace buf (\b -> nextCharIsNot b (`elem` "|^*$#"))
932

933 934 935 936 937
afterOptionalSpace :: StringBuffer -> (StringBuffer -> Bool) -> Bool
afterOptionalSpace buf p
    = if nextCharIs buf (== ' ')
      then p (snd (nextChar buf))
      else p buf
938

939
atEOL :: AlexAccPred ExtsBitmap
940
atEOL _ _ _ (AI _ buf) = atEnd buf || currentChar buf == '\n'
941

942
ifExtension :: (ExtsBitmap -> Bool) -> AlexAccPred ExtsBitmap
943 944
ifExtension pred bits _ _ _ = pred bits

945 946 947
multiline_doc_comment :: Action
multiline_doc_comment span buf _len = withLexedDocType (worker "")
  where
948
    worker commentAcc input docType oneLine = case alexGetChar' input of
Ian Lynagh's avatar
Ian Lynagh committed
949
      Just ('\n', input')
950 951 952 953 954 955
        | 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
Ian Lynagh's avatar
Ian Lynagh committed
956

957 958
    checkIfCommentLine input = check (dropNonNewlineSpace input)
      where
959 960 961
        check input = case alexGetChar' input of
          Just ('-', input) -> case alexGetChar' input of
            Just ('-', input) -> case alexGetChar' input of
962 963 964 965 966
              Just (c, _) | c /= '-' -> Just input
              _ -> Nothing
            _ -> Nothing
          _ -> Nothing

967
        dropNonNewlineSpace input = case alexGetChar' input of
Ian Lynagh's avatar
Ian Lynagh committed
968
          Just (c, input')
969 970 971 972
            | isSpace c && c /= '\n' -> dropNonNewlineSpace input'
            | otherwise -> input
          Nothing -> input

Jedai's avatar
Jedai committed
973 974 975 976 977
lineCommentToken :: Action
lineCommentToken span buf len = do
  b <- extension rawTokenStreamEnabled
  if b then strtoken ITlineComment span buf len else lexToken

978 979 980 981
{-
  nested comments require traversing by hand, they can't be parsed
  using regular expressions.
-}
Ian Lynagh's avatar
Ian Lynagh committed
982
nested_comment :: P (RealLocated Token) -> Action
Alan Zimmerman's avatar
Alan Zimmerman committed
983
nested_comment cont span buf len = do
984
  input <- getInput
985
  go (reverse $ lexemeToString buf len) (1::Int) input
986
  where
Alan Zimmerman's avatar
Alan Zimmerman committed
987 988 989 990 991 992
    go commentAcc 0 input = do
      setInput input
      b <- extension rawTokenStreamEnabled
      if b
        then docCommentEnd input commentAcc ITblockComment buf span
        else cont
993
    go commentAcc n input = case alexGetChar' input of
994
      Nothing -> errBrace input span
995
      Just ('-',input) -> case alexGetChar' input of
996
        Nothing  -> errBrace input span
997
        Just ('\125',input) -> go ('\125':'-':commentAcc) (n-1) input -- '}'
Jedai's avatar
Jedai committed
998
        Just (_,_)          -> go ('-':commentAcc) n input
999
      Just ('\123',input) -> case alexGetChar' input of  -- '{' char
1000
        Nothing  -> errBrace input span
Jedai's avatar
Jedai committed
1001 1002 1003
        Just ('-',input) -> go ('-':'\123':commentAcc) (n+1) input
        Just (_,_)       -> go ('\123':commentAcc) n input
      Just (c,input) -> go (c:commentAcc) n input
1004 1005 1006 1007

nested_doc_comment :: Action
nested_doc_comment span buf _len = withLexedDocType (go "")
  where
1008
    go commentAcc input docType _ = case alexGetChar' input of
1009
      Nothing -> errBrace input span
1010
      Just ('-',input) -> case alexGetChar' input of
1011
        Nothing -> errBrace input span
twanvl's avatar
twanvl committed
1012
        Just ('\125',input) ->
1013
          docCommentEnd input commentAcc docType buf span
twanvl's avatar
twanvl committed
1014
        Just (_,_) -> go ('-':commentAcc) input docType False
1015
      Just ('\123', input) -> case alexGetChar' input of
1016 1017 1018 1019 1020
        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
1021
        Just (_,_) -> go ('\123':commentAcc) input docType False
1022 1023
      Just (c,input) -> go (c:commentAcc) input docType False