Lexer.x 110 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 (
56 57 58
   Token(..), lexer, pragState, mkPState, mkPStatePure, PState(..),
   P(..), ParseResult(..), mkParserFlags, ParserFlags(..), getSrcLoc,
   getPState, extopt, 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,
73 74
   addAnnotation,AddAnn,addAnnsAt,mkParensApiAnn,
   moveAnnotations
75 76
  ) where

rodlogic's avatar
rodlogic committed
77 78
-- base
import Control.Monad
quchen's avatar
quchen committed
79 80 81
#if __GLASGOW_HASKELL__ > 710
import Control.Monad.Fail
#endif
rodlogic's avatar
rodlogic committed
82
import Data.Bits
83
import Data.Char
rodlogic's avatar
rodlogic committed
84 85 86 87
import Data.List
import Data.Maybe
import Data.Word

88 89 90
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

91 92 93
-- ghc-boot
import qualified GHC.LanguageExtensions as LangExt

rodlogic's avatar
rodlogic committed
94 95 96 97 98 99 100 101
-- bytestring
import Data.ByteString (ByteString)

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

-- compiler/utils
102
import Bag
103 104 105 106
import Outputable
import StringBuffer
import FastString
import UniqFM
rodlogic's avatar
rodlogic committed
107 108 109 110
import Util             ( readRational )

-- compiler/main
import ErrUtils
111
import DynFlags
rodlogic's avatar
rodlogic committed
112 113 114

-- compiler/basicTypes
import SrcLoc
115
import Module
Alan Zimmerman's avatar
Alan Zimmerman committed
116 117
import BasicTypes     ( InlineSpec(..), RuleMatchInfo(..), FractionalLit(..),
                        SourceText )
118

rodlogic's avatar
rodlogic committed
119 120
-- compiler/parser
import Ctype
Alan Zimmerman's avatar
Alan Zimmerman committed
121 122

import ApiAnnotation
123 124
}

125 126 127
-- -----------------------------------------------------------------------------
-- Alex "Character set macros"

128 129
-- NB: The logic behind these definitions is also reflected in basicTypes/Lexeme.hs
-- Any changes here should likely be reflected there.
130 131 132 133
$unispace    = \x05 -- Trick Alex into handling Unicode. See alexGetByte.
$nl          = [\n\r\f]
$whitechar   = [$nl\v\ $unispace]
$white_no_nl = $whitechar # \n -- TODO #8424
134
$tab         = \t
135 136

$ascdigit  = 0-9
137
$unidigit  = \x03 -- Trick Alex into handling Unicode. See alexGetByte.
138
$decdigit  = $ascdigit -- for now, should really be $digit (ToDo)
139 140 141
$digit     = [$ascdigit $unidigit]

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

146
$unilarge  = \x01 -- Trick Alex into handling Unicode. See alexGetByte.
147
$asclarge  = [A-Z]
148 149
$large     = [$asclarge $unilarge]

150
$unismall  = \x02 -- Trick Alex into handling Unicode. See alexGetByte.
151
$ascsmall  = [a-z]
152 153
$small     = [$ascsmall $unismall \_]

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

157
$binit     = 0-1
Ian Lynagh's avatar
Ian Lynagh committed
158
$octit     = 0-7
159
$hexit     = [$decdigit A-F a-f]
160

161 162
$uniidchar = \x07 -- Trick Alex into handling Unicode. See alexGetByte.
$idchar    = [$small $large $digit $uniidchar \']
163

164 165
$pragmachar = [$small $large $digit]

166 167
$docsym    = [\| \^ \* \$]

168

169 170 171 172 173 174 175 176
-- -----------------------------------------------------------------------------
-- 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
177

178
@decimal     = $decdigit+
179
@binary      = $binit+
180 181 182 183 184
@octal       = $octit+
@hexadecimal = $hexit+
@exponent    = [eE] [\-\+]? @decimal

@qual = (@conid \.)+
185 186 187 188
@qvarid = @qual @varid
@qconid = @qual @conid
@qvarsym = @qual @varsym
@qconsym = @qual @consym
189 190 191

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

192 193 194 195 196
-- normal signed numerical literals can only be explicitly negative,
-- not explicitly positive (contrast @exponent)
@negative = \-
@signed = @negative ?

197 198 199 200

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

201 202
haskell :-

203 204 205 206 207

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

-- everywhere: skip whitespace
Ian Lynagh's avatar
Ian Lynagh committed
208
$white_no_nl+ ;
209
$tab          { warnTab }
210 211 212 213 214

-- 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
215 216 217 218
-- are). We also rule out nested Haddock comments, if the -haddock flag is
-- set.

"{-" / { isNormalComment } { nested_comment lexToken }
219 220 221 222

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

-- Since Haddock comments aren't valid in every state, we need to rule them
Ian Lynagh's avatar
Ian Lynagh committed
225
-- out here.
226 227 228 229 230 231 232

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

233
"-- " ~$docsym .* { lineCommentToken }
234
"--" [^$symbol \ ] .* { lineCommentToken }
235 236 237

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

238
"-- " $docsym .* / { ifExtension (not . haddockEnabled) } { lineCommentToken }
239 240 241 242 243 244 245

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

246
"---"\-* ~$symbol .* { lineCommentToken }
247 248 249 250

-- 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
251
"--"\-* / { atEOL } { lineCommentToken }
252 253 254 255

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

Jedai's avatar
Jedai committed
256
"-- " / { atEOL } { lineCommentToken }
257 258 259 260 261 262 263 264 265 266 267

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

-- 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.
279
<layout, layout_do, layout_if> {
Ian Lynagh's avatar
Ian Lynagh committed
280 281 282 283
  \{ / { notFollowedBy '-' }            { hopefully_open_brace }
        -- we might encounter {-# here, but {- has been handled already
  \n                                    ;
  ^\# (line)?                           { begin line_prag1 }
284 285
}

286 287 288 289 290 291
-- after an 'if', a vertical bar starts a layout context for MultiWayIf
<layout_if> {
  \| / { notFollowedBySymbol }          { new_layout_context True ITvbar }
  ()                                    { pop }
}

292
-- do is treated in a subtly different way, see new_layout_context
293 294
<layout>    ()                          { new_layout_context True  ITvocurly }
<layout_do> ()                          { new_layout_context False ITvocurly }
295 296 297 298

-- 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
299
<layout_left>  ()                       { do_layout_left }
300

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

303 304
"{-#" $whitechar* $pragmachar+ / { known_pragma linePrags }
                                { dispatch_pragmas linePrags }
305 306 307

-- single-line line pragmas, of the form
--    # <line> "<file>" <extra-stuff> \n
308
<line_prag1> @decimal                   { setLine line_prag1a }
Ian Lynagh's avatar
Ian Lynagh committed
309 310
<line_prag1a> \" [$graphic \ ]* \"      { setFile line_prag1b }
<line_prag1b> .*                        { pop }
311 312 313

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

320
<0,option_prags> {
Ian Lynagh's avatar
Ian Lynagh committed
321
  "{-#" $whitechar* $pragmachar+
322 323 324 325 326
        $whitechar+ $pragmachar+ / { known_pragma twoWordPrags }
                                 { dispatch_pragmas twoWordPrags }

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

328
  -- We ignore all these pragmas, but don't generate a warning for them
329 330
  "{-#" $whitechar* $pragmachar+ / { known_pragma ignoredPrags }
                                 { dispatch_pragmas ignoredPrags }
331 332

  -- ToDo: should only be valid inside a pragma:
Ian Lynagh's avatar
Ian Lynagh committed
333
  "#-}"                          { endPrag }
334 335
}

336
<option_prags> {
337 338
  "{-#"  $whitechar* $pragmachar+ / { known_pragma fileHeaderPrags }
                                   { dispatch_pragmas fileHeaderPrags }
David Waern's avatar
David Waern committed
339 340
}

341 342
<0> {
  -- In the "0" mode we ignore these pragmas
343
  "{-#"  $whitechar* $pragmachar+ / { known_pragma fileHeaderPrags }
344 345 346
                     { nested_comment lexToken }
}

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

383
  "[" @varid "|"  / { ifExtension qqEnabled }
384
                     { lex_quasiquote_tok }
385 386

  -- qualified quasi-quote (#5555)
387 388
  "[" @qvarid "|"  / { ifExtension qqEnabled }
                     { lex_qquasiquote_tok }
389 390
}

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
391 392 393 394 395 396 397 398
  -- See Note [Lexing type applications]
<0> {
    [^ $idchar \) ] ^
  "@"
    / { ifExtension typeApplicationEnabled `alexAndPred` notFollowedBySymbol }
    { token ITtypeApp }
}

399
<0> {
ross's avatar
ross committed
400
  "(|" / { ifExtension arrowsEnabled `alexAndPred` notFollowedBySymbol }
401 402 403 404 405 406 407 408 409 410 411
                                        { special (IToparenbar NormalSyntax) }
  "|)" / { ifExtension arrowsEnabled }  { special (ITcparenbar NormalSyntax) }

  $unigraphic -- ⦇
    / { ifCurrentChar '⦇' `alexAndPred`
        ifExtension (\i -> unicodeSyntaxEnabled i && arrowsEnabled i) }
    { special (IToparenbar UnicodeSyntax) }
  $unigraphic -- ⦈
    / { ifCurrentChar '⦈' `alexAndPred`
        ifExtension (\i -> unicodeSyntaxEnabled i && arrowsEnabled i) }
    { special (ITcparenbar UnicodeSyntax) }
412 413
}

414
<0> {
Ian Lynagh's avatar
Ian Lynagh committed
415
  \? @varid / { ifExtension ipEnabled } { skip_one_varid ITdupipvarid }
416 417
}

Adam Gundry's avatar
Adam Gundry committed
418 419 420 421 422
<0> {
  "#" @varid / { ifExtension overloadedLabelsEnabled }
               { skip_one_varid ITlabelvarid }
}

423
<0> {
424
  "(#" / { ifExtension unboxedTuplesEnabled }
Ian Lynagh's avatar
Ian Lynagh committed
425 426 427 428 429
         { token IToubxparen }
  "#)" / { ifExtension unboxedTuplesEnabled }
         { token ITcubxparen }
}

430
<0,option_prags> {
Ian Lynagh's avatar
Ian Lynagh committed
431 432 433 434 435 436 437 438 439 440
  \(                                    { special IToparen }
  \)                                    { special ITcparen }
  \[                                    { special ITobrack }
  \]                                    { special ITcbrack }
  \,                                    { special ITcomma }
  \;                                    { special ITsemi }
  \`                                    { special ITbackquote }

  \{                                    { open_brace }
  \}                                    { close_brace }
441 442
}

443
<0,option_prags> {
444 445
  @qvarid                       { idtoken qvarid }
  @qconid                       { idtoken qconid }
Ian Lynagh's avatar
Ian Lynagh committed
446
  @varid                        { varid }
447
  @conid                        { idtoken conid }
448 449
}

450
<0> {
451 452
  @qvarid "#"+      / { ifExtension magicHashEnabled } { idtoken qvarid }
  @qconid "#"+      / { ifExtension magicHashEnabled } { idtoken qconid }
453
  @varid "#"+       / { ifExtension magicHashEnabled } { varid }
454
  @conid "#"+       / { ifExtension magicHashEnabled } { idtoken conid }
455 456
}

457 458
-- ToDo: - move `var` and (sym) into lexical syntax?
--       - remove backquote from $special?
459
<0> {
460 461
  @qvarsym                                         { idtoken qvarsym }
  @qconsym                                         { idtoken qconsym }
462 463
  @varsym                                          { varsym }
  @consym                                          { consym }
464 465
}

466 467
-- For the normal boxed literals we need to be careful
-- when trying to be close to Haskell98
468
<0> {
469
  -- Normal integral literals (:: Num a => a, from Integer)
470
  @decimal                                                               { tok_num positive 0 0 decimal }
471
  0[bB] @binary                / { ifExtension binaryLiteralsEnabled }   { tok_num positive 2 2 binary }
472 473 474
  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 }
475 476
  @negative 0[bB] @binary      / { ifExtension negativeLiteralsEnabled `alexAndPred`
                                   ifExtension binaryLiteralsEnabled }   { tok_num negative 3 3 binary }
477 478
  @negative 0[oO] @octal       / { ifExtension negativeLiteralsEnabled } { tok_num negative 3 3 octal }
  @negative 0[xX] @hexadecimal / { ifExtension negativeLiteralsEnabled } { tok_num negative 3 3 hexadecimal }
479 480

  -- Normal rational literals (:: Fractional a => a, from Rational)
481 482
  @floating_point                                                        { strtoken tok_float }
  @negative @floating_point    / { ifExtension negativeLiteralsEnabled } { strtoken tok_float }
483 484
}

485
<0> {
Ian Lynagh's avatar
Ian Lynagh committed
486
  -- Unboxed ints (:: Int#) and words (:: Word#)
487 488
  -- It's simpler (and faster?) to give separate cases to the negatives,
  -- especially considering octal/hexadecimal prefixes.
Ian Lynagh's avatar
Ian Lynagh committed
489
  @decimal                     \# / { ifExtension magicHashEnabled } { tok_primint positive 0 1 decimal }
490 491
  0[bB] @binary                \# / { ifExtension magicHashEnabled `alexAndPred`
                                      ifExtension binaryLiteralsEnabled } { tok_primint positive 2 3 binary }
Ian Lynagh's avatar
Ian Lynagh committed
492 493 494
  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 }
495 496
  @negative 0[bB] @binary      \# / { ifExtension magicHashEnabled `alexAndPred`
                                      ifExtension binaryLiteralsEnabled } { tok_primint negative 3 4 binary }
Ian Lynagh's avatar
Ian Lynagh committed
497
  @negative 0[oO] @octal       \# / { ifExtension magicHashEnabled } { tok_primint negative 3 4 octal }
498
  @negative 0[xX] @hexadecimal \# / { ifExtension magicHashEnabled } { tok_primint negative 3 4 hexadecimal }
499

Ian Lynagh's avatar
Ian Lynagh committed
500
  @decimal                     \# \# / { ifExtension magicHashEnabled } { tok_primword 0 2 decimal }
501 502
  0[bB] @binary                \# \# / { ifExtension magicHashEnabled `alexAndPred`
                                         ifExtension binaryLiteralsEnabled } { tok_primword 2 4 binary }
Ian Lynagh's avatar
Ian Lynagh committed
503 504 505
  0[oO] @octal                 \# \# / { ifExtension magicHashEnabled } { tok_primword 2 4 octal }
  0[xX] @hexadecimal           \# \# / { ifExtension magicHashEnabled } { tok_primword 2 4 hexadecimal }

506 507
  -- Unboxed floats and doubles (:: Float#, :: Double#)
  -- prim_{float,double} work with signed literals
508 509
  @signed @floating_point \# / { ifExtension magicHashEnabled } { init_strtoken 1 tok_primfloat }
  @signed @floating_point \# \# / { ifExtension magicHashEnabled } { init_strtoken 2 tok_primdouble }
510 511 512 513 514 515
}

-- 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.
516
<0> {
Ian Lynagh's avatar
Ian Lynagh committed
517 518
  \'                            { lex_char_tok }
  \"                            { lex_string_tok }
519 520
}

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
521 522 523 524 525 526 527 528 529 530 531
-- Note [Lexing type applications]
-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- The desired syntax for type applications is to prefix the type application
-- with '@', like this:
--
--   foo @Int @Bool baz bum
--
-- This, of course, conflicts with as-patterns. The conflict arises because
-- expressions and patterns use the same parser, and also because we want
-- to allow type patterns within expression patterns.
--
Gabor Greif's avatar
Gabor Greif committed
532
-- Disambiguation is accomplished by requiring *something* to appear between
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
533 534 535 536 537 538 539 540 541 542 543 544 545 546
-- type application and the preceding token. This something must end with
-- a character that cannot be the end of the variable bound in an as-pattern.
-- Currently (June 2015), this means that the something cannot end with a
-- $idchar or a close-paren. (The close-paren is necessary if the as-bound
-- identifier is symbolic.)
--
-- Note that looking for whitespace before the '@' is insufficient, because
-- of this pathological case:
--
--   foo {- hi -}@Int
--
-- This design is predicated on the fact that as-patterns are generally
-- whitespace-free, and also that this whole thing is opt-in, with the
-- TypeApplications extension.
547 548 549 550

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

551
{
552

553 554 555
-- -----------------------------------------------------------------------------
-- The token type

556
data Token
Ian Lynagh's avatar
Ian Lynagh committed
557
  = ITas                        -- Haskell keywords
558 559 560 561 562 563 564 565
  | ITcase
  | ITclass
  | ITdata
  | ITdefault
  | ITderiving
  | ITdo
  | ITelse
  | IThiding
566
  | ITforeign
567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582
  | ITif
  | ITimport
  | ITin
  | ITinfix
  | ITinfixl
  | ITinfixr
  | ITinstance
  | ITlet
  | ITmodule
  | ITnewtype
  | ITof
  | ITqualified
  | ITthen
  | ITtype
  | ITwhere

583
  | ITforall            IsUnicodeSyntax -- GHC extension keywords
584 585 586 587
  | ITexport
  | ITlabel
  | ITdynamic
  | ITsafe
588
  | ITinterruptible
589 590 591
  | ITunsafe
  | ITstdcallconv
  | ITccallconv
592
  | ITcapiconv
593
  | ITprimcallconv
thoughtpolice's avatar
thoughtpolice committed
594
  | ITjavascriptcallconv
595
  | ITmdo
596
  | ITfamily
597
  | ITrole
598 599 600
  | ITgroup
  | ITby
  | ITusing
cactus's avatar
cactus committed
601
  | ITpattern
Facundo Domínguez's avatar
Facundo Domínguez committed
602
  | ITstatic
603

Alan Zimmerman's avatar
Alan Zimmerman committed
604 605 606 607 608 609 610 611
  -- 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
612
  | ITline_prag
Alan Zimmerman's avatar
Alan Zimmerman committed
613 614 615 616 617 618
  | ITscc_prag          SourceText
  | ITgenerated_prag    SourceText
  | ITcore_prag         SourceText         -- hdaume: core annotations
  | ITunpack_prag       SourceText
  | ITnounpack_prag     SourceText
  | ITann_prag          SourceText
619
  | ITclose_prag
620 621 622
  | IToptions_prag String
  | ITinclude_prag String
  | ITlanguage_prag
Alan Zimmerman's avatar
Alan Zimmerman committed
623 624 625 626 627 628 629 630 631
  | 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
632

Ian Lynagh's avatar
Ian Lynagh committed
633
  | ITdotdot                    -- reserved symbols
634
  | ITcolon
635
  | ITdcolon            IsUnicodeSyntax
636 637
  | ITequal
  | ITlam
638
  | ITlcase
639
  | ITvbar
640 641
  | ITlarrow            IsUnicodeSyntax
  | ITrarrow            IsUnicodeSyntax
642 643
  | ITat
  | ITtilde
batterseapower's avatar
batterseapower committed
644
  | ITtildehsh
645
  | ITdarrow            IsUnicodeSyntax
646 647 648 649
  | ITminus
  | ITbang
  | ITdot

Ian Lynagh's avatar
Ian Lynagh committed
650
  | ITbiglam                    -- GHC-extension symbols
651

Ian Lynagh's avatar
Ian Lynagh committed
652
  | ITocurly                    -- special symbols
653 654 655 656
  | ITccurly
  | ITvocurly
  | ITvccurly
  | ITobrack
Ian Lynagh's avatar
Ian Lynagh committed
657 658
  | ITopabrack                  -- [:, for parallel arrays with -XParallelArrays
  | ITcpabrack                  -- :], for parallel arrays with -XParallelArrays
659 660 661 662 663 664 665 666 667
  | ITcbrack
  | IToparen
  | ITcparen
  | IToubxparen
  | ITcubxparen
  | ITsemi
  | ITcomma
  | ITunderscore
  | ITbackquote
dreixel's avatar
dreixel committed
668
  | ITsimpleQuote               --  '
669

Ian Lynagh's avatar
Ian Lynagh committed
670
  | ITvarid   FastString        -- identifiers
671 672 673 674 675 676 677 678
  | 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
679
  | ITdupipvarid   FastString   -- GHC extension: implicit param: ?x
Adam Gundry's avatar
Adam Gundry committed
680
  | ITlabelvarid   FastString   -- Overloaded label: #x
681

682 683 684
  | 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
685
  | ITrational FractionalLit
686

687 688 689 690
  | 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
691 692
  | ITprimfloat  FractionalLit
  | ITprimdouble FractionalLit
693

694
  -- Template Haskell extension tokens
695
  | ITopenExpQuote HasE         --  [| or [e|
Ian Lynagh's avatar
Ian Lynagh committed
696 697 698 699
  | ITopenPatQuote              --  [p|
  | ITopenDecQuote              --  [d|
  | ITopenTypQuote              --  [t|
  | ITcloseQuote                --  |]
700
  | ITopenTExpQuote HasE        --  [|| or [e||
701
  | ITcloseTExpQuote            --  ||]
Ian Lynagh's avatar
Ian Lynagh committed
702 703
  | ITidEscape   FastString     --  $x
  | ITparenEscape               --  $(
704 705
  | ITidTyEscape   FastString   --  $$x
  | ITparenTyEscape             --  $$(
Ian Lynagh's avatar
Ian Lynagh committed
706
  | ITtyQuote                   --  ''
707 708 709 710 711 712 713 714
  | 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 |]
715 716 717 718

  -- Arrow notation extension
  | ITproc
  | ITrec
719 720
  | IToparenbar  IsUnicodeSyntax --  (|
  | ITcparenbar  IsUnicodeSyntax --  |)
721 722 723 724
  | ITlarrowtail IsUnicodeSyntax --  -<
  | ITrarrowtail IsUnicodeSyntax --  >-
  | ITLarrowtail IsUnicodeSyntax --  -<<
  | ITRarrowtail IsUnicodeSyntax --  >>-
725

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
726 727 728 729 730 731 732
  -- type application '@' (lexed differently than as-pattern '@',
  -- due to checking for preceding whitespace)
  | ITtypeApp


  | ITunknown String            -- Used when the lexer can't make sense of it
  | ITeof                       -- end of file token
733 734 735 736 737 738 739

  -- 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)
Jedai's avatar
Jedai committed
740 741
  | ITlineComment     String     -- comment starting by "--"
  | ITblockComment    String     -- comment in {- -}
742

743
  deriving Show
744

Alan Zimmerman's avatar
Alan Zimmerman committed
745 746 747
instance Outputable Token where
  ppr x = text (show x)

Alan Zimmerman's avatar
Alan Zimmerman committed
748

749 750 751 752 753 754 755
-- 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)
--
756
reservedWordsFM :: UniqFM (Token, ExtsBitmap)
757
reservedWordsFM = listToUFM $
Ian Lynagh's avatar
Ian Lynagh committed
758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784
    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 ),

785 786
         ( "forall",         ITforall NormalSyntax,
                                              xbit ExplicitForallBit .|.
787 788
                                              xbit InRulePragBit),
         ( "mdo",            ITmdo,           xbit RecursiveDoBit),
789 790 791
             -- See Note [Lexing type pseudo-keywords]
         ( "family",         ITfamily,        0 ),
         ( "role",           ITrole,          0 ),
792
         ( "pattern",        ITpattern,       xbit PatternSynonymsBit),
Facundo Domínguez's avatar
Facundo Domínguez committed
793
         ( "static",         ITstatic,        0 ),
794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814
         ( "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)
815 816
     ]

817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832
{-----------------------------------
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.
-------------------------------------}
833

834
reservedSymsFM :: UniqFM (Token, ExtsBitmap -> Bool)
835
reservedSymsFM = listToUFM $
Ian Lynagh's avatar
Ian Lynagh committed
836
    map (\ (x,y,z) -> (mkFastString x,(y,z)))
837
      [ ("..",  ITdotdot,              always)
Ian Lynagh's avatar
Ian Lynagh committed
838
        -- (:) is a reserved op, meaning only list cons
839 840 841 842 843 844 845 846 847 848 849 850 851
       ,(":",   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
852 853

        -- For 'forall a . t'
854
       ,(".", ITdot,  always) -- \i -> explicitForallEnabled i || inRulePrag i)
Ian Lynagh's avatar
Ian Lynagh committed
855

856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875
       ,("-<",  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)

Simon Marlow's avatar
Simon Marlow committed
876 877 878
        -- 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).
879 880 881 882 883
       ]

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

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

886
special :: Token -> Action
twanvl's avatar
twanvl committed
887
special tok span _buf _len = return (L span tok)
888

889
token, layout_token :: Token -> Action
twanvl's avatar
twanvl committed
890 891
token t span _buf _len = return (L span t)
layout_token t span _buf _len = pushLexState layout >> return (L span t)
892

893 894
idtoken :: (StringBuffer -> Int -> Token) -> Action
idtoken f span buf len = return (L span $! (f buf len))
895

896
skip_one_varid :: (FastString -> Token) -> Action
Ian Lynagh's avatar
Ian Lynagh committed
897
skip_one_varid f span buf len
898
  = return (L span $! f (lexemeToFastString (stepOn buf) (len-1)))
899

900 901 902 903
skip_two_varid :: (FastString -> Token) -> Action
skip_two_varid f span buf len
  = return (L span $! f (lexemeToFastString (stepOn (stepOn buf)) (len-2)))

904
strtoken :: (String -> Token) -> Action
Ian Lynagh's avatar
Ian Lynagh committed
905
strtoken f span buf len =
906
  return (L span $! (f $! lexemeToString buf len))
907

908
init_strtoken :: Int -> (String -> Token) -> Action
909
-- like strtoken, but drops the last N character(s)
Ian Lynagh's avatar
Ian Lynagh committed
910
init_strtoken drop f span buf len =
911
  return (L span $! (f $! lexemeToString buf (len-drop)))
912 913

begin :: Int -> Action
914
begin code _span _str _len = do pushLexState code; lexToken
915 916

pop :: Action
Ian Lynagh's avatar
Ian Lynagh committed
917 918
pop _span _buf _len = do _ <- popLexState
                         lexToken
919

920 921 922 923 924 925 926 927 928 929 930
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
931
              else failSpanMsgP (RealSrcSpan span) (text "Missing block")
932

933
pop_and :: Action -> Action
Ian Lynagh's avatar
Ian Lynagh committed
934 935
pop_and act span buf len = do _ <- popLexState
                              act span buf len
936

937
{-# INLINE nextCharIs #-}
Ian Lynagh's avatar
Ian Lynagh committed
938
nextCharIs :: StringBuffer -> (Char -> Bool) -> Bool
939 940
nextCharIs buf p = not (atEnd buf) && p (currentChar buf)

941 942 943 944
{-# INLINE nextCharIsNot #-}
nextCharIsNot :: StringBuffer -> (Char -> Bool) -> Bool
nextCharIsNot buf p = not (nextCharIs buf p)

945
notFollowedBy :: Char -> AlexAccPred ExtsBitmap
Ian Lynagh's avatar
Ian Lynagh committed
946
notFollowedBy char _ _ _ (AI _ buf)
947
  = nextCharIsNot buf (== char)
948

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

Adam Gundry's avatar
Adam Gundry committed
953 954 955 956
followedByDigit :: AlexAccPred ExtsBitmap
followedByDigit _ _ _ (AI _ buf)
  = afterOptionalSpace buf (\b -> nextCharIs b (`elem` ['0'..'9']))

957 958 959 960
ifCurrentChar :: Char -> AlexAccPred ExtsBitmap
ifCurrentChar char _ (AI _ buf) _ _
  = nextCharIs buf (== char)

961 962 963 964 965
-- 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.
966
isNormalComment :: AlexAccPred ExtsBitmap
967
isNormalComment bits _ _ (AI _ buf)
968
  | haddockEnabled bits = notFollowedByDocOrPragma
969
  | otherwise           = nextCharIsNot buf (== '#')
970 971
  where
    notFollowedByDocOrPragma
972
       = afterOptionalSpace buf (\b -> nextCharIsNot b (`elem` "|^*$#"))
973

974 975 976 977 978
afterOptionalSpace :: StringBuffer -> (StringBuffer -> Bool) -> Bool
afterOptionalSpace buf p
    = if nextCharIs buf (== ' ')
      then p (snd (nextChar buf))
      else p buf
979

980
atEOL :: AlexAccPred ExtsBitmap
981
atEOL _ _ _ (AI _ buf) = atEnd buf || currentChar buf == '\n'
982

983
ifExtension :: (ExtsBitmap -> Bool) -> AlexAccPred ExtsBitmap
984 985
ifExtension pred bits _ _ _ = pred bits

986 987 988
multiline_doc_comment :: Action
multiline_doc_comment span buf _len = withLexedDocType (worker "")
  where
989
    worker commentAcc input docType checkNextLine = case alexGetChar' input of
Ian Lynagh's avatar
Ian Lynagh committed
990
      Just ('\n', input')
991 992
        | checkNextLine -> case checkIfCommentLine input' of
          Just input -> worker ('\n':commentAcc) input docType checkNextLine
993
          Nothing -> docCommentEnd input commentAcc docType buf span
994 995
        | otherwise -> docCommentEnd input commentAcc docType buf span
      Just (c, input) -> worker (c:commentAcc) input docType checkNextLine
996
      Nothing -> docCommentEnd input commentAcc docType buf span
Ian Lynagh's avatar
Ian Lynagh committed
997

998 999 1000 1001 1002 1003 1004 1005
    -- Check if the next line of input belongs to this doc comment as well.
    -- A doc comment continues onto the next line when the following
    -- conditions are met:
    --   * The line starts with "--"
    --   * The line doesn't start with "---".
    --   * The line doesn't start with "-- $", because that would be the
    --     start of a /new/ named haddock chunk (#10398).
    checkIfCommentLine :: AlexInput -> Maybe AlexInput
1006 1007
    checkIfCommentLine input = check (dropNonNewlineSpace input)
      where
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
        check input = do
          ('-', input) <- alexGetChar' input
          ('-', input) <- alexGetChar' input
          (c, after_c) <- alexGetChar' input
          case c of
            '-' -> Nothing
            ' ' -> case alexGetChar' after_c of
                     Just ('$', _) -> Nothing
                     _ -> Just input
            _   -> Just input
1018

1019
        dropNonNewlineSpace input = case alexGetChar' input of
Ian Lynagh's avatar
Ian Lynagh committed
1020
          Just (c, input')
1021 1022 1023 1024
            | isSpace c && c /= '\n' -> dropNonNewlineSpace input'
            | otherwise -> input
          Nothing -> input

Jedai's avatar
Jedai committed
1025 1026 1027 1028 1029
lineCommentToken :: Action
lineCommentToken span buf len = do
  b <- extension rawTokenStreamEnabled
  if b then strtoken ITlineComment span buf len else lexToken

1030 1031 1032 1033
{-
  nested comments require traversing by hand, they can't be parsed
  using regular expressions.
-}
Ian Lynagh's avatar
Ian Lynagh committed
1034
nested_comment :: P (RealLocated Token) -> Action
Alan Zimmerman's avatar
Alan Zimmerman committed
1035
nested_comment cont span buf len = do
1036
  input <- getInput
1037
  go (reverse $ lexemeToString buf len) (1::Int) input
1038
  where
Alan Zimmerman's avatar
Alan Zimmerman committed
1039 1040 1041 1042 1043 1044
    go commentAcc 0 input = do
      setInput input
      b <- extension rawTokenStreamEnabled
      if b
        then docCommentEnd input commentAcc ITblockComment buf span
        else cont
1045
    go commentAcc n input = case alexGetChar' input of
1046
      Nothing -> errBrace input span
1047
      Just ('-',input) -> case alexGetChar' input of
1048
        Nothing  -> errBrace input span
1049
        Just ('\125',input) -> go ('\125':'-':commentAcc) (n-1) input -- '}'
Jedai's avatar
Jedai committed
1050
        Just (_,_)          -> go ('-':commentAcc) n input
1051
      Just ('\123',input) -> case alexGetChar' input of  -- '{' char
1052
        Nothing  -> errBrace input span
Jedai's avatar
Jedai committed
1053 1054 1055
        Just ('-',input) -> go ('-':'\123':commentAcc) (n+1) input
        Just (_,_)       -> go ('\123':commentAcc) n input
      Just (c,input) -> go (c:commentAcc) n input
1056 1057 1058 1059

nested_doc_comment :: Action
nested_doc_comment span buf _len = withLexedDocType (go "")
  where
1060
    go commentAcc input docType _ = case alexGetChar' input of
1061
      Nothing -> errBrace input span
1062
      Just ('-',input) -> case alexGetChar' input of
1063
        Nothing -> errBrace input span
twanvl's avatar