Lexer.x 114 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, pushModuleContext, 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
   addAnnotation,AddAnn,addAnnsAt,mkParensApiAnn,
74
   commentToAnnotation,
75
   moveAnnotations
76 77
  ) where

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

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

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

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

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

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

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

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

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

import ApiAnnotation
124 125
}

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

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

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

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

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

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

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

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

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

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

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

169

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

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

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

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

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

198 199 200 201

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

202 203
haskell :-

204 205 206 207 208

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

353 354
-- '0' state: ordinary lexemes

355 356
-- Haddock comments

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

362 363
-- "special" symbols

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

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

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 396 397 398 399 400 401

  $unigraphic -- ⟦
    / { ifCurrentChar '⟦' `alexAndPred`
        ifExtension (\i -> unicodeSyntaxEnabled i && thQuotesEnabled i) }
    { token (ITopenExpQuote NoE UnicodeSyntax) }
  $unigraphic -- ⟧
    / { ifCurrentChar '⟧' `alexAndPred`
        ifExtension (\i -> unicodeSyntaxEnabled i && thQuotesEnabled i) }
    { token (ITcloseQuote UnicodeSyntax) }
402 403
}

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
404 405 406 407 408 409 410 411
  -- See Note [Lexing type applications]
<0> {
    [^ $idchar \) ] ^
  "@"
    / { ifExtension typeApplicationEnabled `alexAndPred` notFollowedBySymbol }
    { token ITtypeApp }
}

412
<0> {
ross's avatar
ross committed
413
  "(|" / { ifExtension arrowsEnabled `alexAndPred` notFollowedBySymbol }
414 415 416 417 418 419 420 421 422 423 424
                                        { 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) }
425 426
}

427
<0> {
Ian Lynagh's avatar
Ian Lynagh committed
428
  \? @varid / { ifExtension ipEnabled } { skip_one_varid ITdupipvarid }
429 430
}

Adam Gundry's avatar
Adam Gundry committed
431 432 433 434 435
<0> {
  "#" @varid / { ifExtension overloadedLabelsEnabled }
               { skip_one_varid ITlabelvarid }
}

436
<0> {
437
  "(#" / { orExtensions unboxedTuplesEnabled unboxedSumsEnabled }
Ian Lynagh's avatar
Ian Lynagh committed
438
         { token IToubxparen }
439
  "#)" / { orExtensions unboxedTuplesEnabled unboxedSumsEnabled }
Ian Lynagh's avatar
Ian Lynagh committed
440 441 442
         { token ITcubxparen }
}

443
<0,option_prags> {
Ian Lynagh's avatar
Ian Lynagh committed
444 445 446 447 448 449 450 451 452 453
  \(                                    { special IToparen }
  \)                                    { special ITcparen }
  \[                                    { special ITobrack }
  \]                                    { special ITcbrack }
  \,                                    { special ITcomma }
  \;                                    { special ITsemi }
  \`                                    { special ITbackquote }

  \{                                    { open_brace }
  \}                                    { close_brace }
454 455
}

456
<0,option_prags> {
457 458
  @qvarid                       { idtoken qvarid }
  @qconid                       { idtoken qconid }
Ian Lynagh's avatar
Ian Lynagh committed
459
  @varid                        { varid }
460
  @conid                        { idtoken conid }
461 462
}

463
<0> {
464 465
  @qvarid "#"+      / { ifExtension magicHashEnabled } { idtoken qvarid }
  @qconid "#"+      / { ifExtension magicHashEnabled } { idtoken qconid }
466
  @varid "#"+       / { ifExtension magicHashEnabled } { varid }
467
  @conid "#"+       / { ifExtension magicHashEnabled } { idtoken conid }
468 469
}

470 471
-- ToDo: - move `var` and (sym) into lexical syntax?
--       - remove backquote from $special?
472
<0> {
473 474
  @qvarsym                                         { idtoken qvarsym }
  @qconsym                                         { idtoken qconsym }
475 476
  @varsym                                          { varsym }
  @consym                                          { consym }
477 478
}

479 480
-- For the normal boxed literals we need to be careful
-- when trying to be close to Haskell98
481
<0> {
482
  -- Normal integral literals (:: Num a => a, from Integer)
483
  @decimal                                                               { tok_num positive 0 0 decimal }
484
  0[bB] @binary                / { ifExtension binaryLiteralsEnabled }   { tok_num positive 2 2 binary }
485 486 487
  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 }
488 489
  @negative 0[bB] @binary      / { ifExtension negativeLiteralsEnabled `alexAndPred`
                                   ifExtension binaryLiteralsEnabled }   { tok_num negative 3 3 binary }
490 491
  @negative 0[oO] @octal       / { ifExtension negativeLiteralsEnabled } { tok_num negative 3 3 octal }
  @negative 0[xX] @hexadecimal / { ifExtension negativeLiteralsEnabled } { tok_num negative 3 3 hexadecimal }
492 493

  -- Normal rational literals (:: Fractional a => a, from Rational)
494 495
  @floating_point                                                        { strtoken tok_float }
  @negative @floating_point    / { ifExtension negativeLiteralsEnabled } { strtoken tok_float }
496 497
}

498
<0> {
Ian Lynagh's avatar
Ian Lynagh committed
499
  -- Unboxed ints (:: Int#) and words (:: Word#)
500 501
  -- It's simpler (and faster?) to give separate cases to the negatives,
  -- especially considering octal/hexadecimal prefixes.
Ian Lynagh's avatar
Ian Lynagh committed
502
  @decimal                     \# / { ifExtension magicHashEnabled } { tok_primint positive 0 1 decimal }
503 504
  0[bB] @binary                \# / { ifExtension magicHashEnabled `alexAndPred`
                                      ifExtension binaryLiteralsEnabled } { tok_primint positive 2 3 binary }
Ian Lynagh's avatar
Ian Lynagh committed
505 506 507
  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 }
508 509
  @negative 0[bB] @binary      \# / { ifExtension magicHashEnabled `alexAndPred`
                                      ifExtension binaryLiteralsEnabled } { tok_primint negative 3 4 binary }
Ian Lynagh's avatar
Ian Lynagh committed
510
  @negative 0[oO] @octal       \# / { ifExtension magicHashEnabled } { tok_primint negative 3 4 octal }
511
  @negative 0[xX] @hexadecimal \# / { ifExtension magicHashEnabled } { tok_primint negative 3 4 hexadecimal }
512

Ian Lynagh's avatar
Ian Lynagh committed
513
  @decimal                     \# \# / { ifExtension magicHashEnabled } { tok_primword 0 2 decimal }
514 515
  0[bB] @binary                \# \# / { ifExtension magicHashEnabled `alexAndPred`
                                         ifExtension binaryLiteralsEnabled } { tok_primword 2 4 binary }
Ian Lynagh's avatar
Ian Lynagh committed
516 517 518
  0[oO] @octal                 \# \# / { ifExtension magicHashEnabled } { tok_primword 2 4 octal }
  0[xX] @hexadecimal           \# \# / { ifExtension magicHashEnabled } { tok_primword 2 4 hexadecimal }

519 520
  -- Unboxed floats and doubles (:: Float#, :: Double#)
  -- prim_{float,double} work with signed literals
521 522
  @signed @floating_point \# / { ifExtension magicHashEnabled } { init_strtoken 1 tok_primfloat }
  @signed @floating_point \# \# / { ifExtension magicHashEnabled } { init_strtoken 2 tok_primdouble }
523 524 525 526 527 528
}

-- 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.
529
<0> {
Ian Lynagh's avatar
Ian Lynagh committed
530 531
  \'                            { lex_char_tok }
  \"                            { lex_string_tok }
532 533
}

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
534 535 536 537 538 539 540 541 542 543 544
-- 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
545
-- Disambiguation is accomplished by requiring *something* to appear between
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
546 547 548 549 550 551 552 553 554 555 556 557 558 559
-- 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.
560 561 562 563

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

564
{
565

566 567 568
-- -----------------------------------------------------------------------------
-- The token type

569
data Token
Ian Lynagh's avatar
Ian Lynagh committed
570
  = ITas                        -- Haskell keywords
571 572 573 574 575 576 577 578
  | ITcase
  | ITclass
  | ITdata
  | ITdefault
  | ITderiving
  | ITdo
  | ITelse
  | IThiding
579
  | ITforeign
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595
  | ITif
  | ITimport
  | ITin
  | ITinfix
  | ITinfixl
  | ITinfixr
  | ITinstance
  | ITlet
  | ITmodule
  | ITnewtype
  | ITof
  | ITqualified
  | ITthen
  | ITtype
  | ITwhere

596
  | ITforall            IsUnicodeSyntax -- GHC extension keywords
597 598 599 600
  | ITexport
  | ITlabel
  | ITdynamic
  | ITsafe
601
  | ITinterruptible
602 603 604
  | ITunsafe
  | ITstdcallconv
  | ITccallconv
605
  | ITcapiconv
606
  | ITprimcallconv
thoughtpolice's avatar
thoughtpolice committed
607
  | ITjavascriptcallconv
608
  | ITmdo
609
  | ITfamily
610
  | ITrole
611 612 613
  | ITgroup
  | ITby
  | ITusing
cactus's avatar
cactus committed
614
  | ITpattern
Facundo Domínguez's avatar
Facundo Domínguez committed
615
  | ITstatic
Ryan Scott's avatar
Ryan Scott committed
616 617
  | ITstock
  | ITanyclass
618

Edward Z. Yang's avatar
Edward Z. Yang committed
619 620 621 622 623 624
  -- Backpack tokens
  | ITunit
  | ITsignature
  | ITdependency
  | ITrequires

Alan Zimmerman's avatar
Alan Zimmerman committed
625 626 627 628 629 630 631 632
  -- 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
633
  | ITline_prag
Alan Zimmerman's avatar
Alan Zimmerman committed
634 635 636 637 638 639
  | ITscc_prag          SourceText
  | ITgenerated_prag    SourceText
  | ITcore_prag         SourceText         -- hdaume: core annotations
  | ITunpack_prag       SourceText
  | ITnounpack_prag     SourceText
  | ITann_prag          SourceText
640
  | ITcomplete_prag     SourceText
641
  | ITclose_prag
642 643 644
  | IToptions_prag String
  | ITinclude_prag String
  | ITlanguage_prag
Alan Zimmerman's avatar
Alan Zimmerman committed
645 646 647 648 649 650 651 652 653
  | 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
654

Ian Lynagh's avatar
Ian Lynagh committed
655
  | ITdotdot                    -- reserved symbols
656
  | ITcolon
657
  | ITdcolon            IsUnicodeSyntax
658 659
  | ITequal
  | ITlam
660
  | ITlcase
661
  | ITvbar
662 663
  | ITlarrow            IsUnicodeSyntax
  | ITrarrow            IsUnicodeSyntax
664 665
  | ITat
  | ITtilde
batterseapower's avatar
batterseapower committed
666
  | ITtildehsh
667
  | ITdarrow            IsUnicodeSyntax
668 669 670 671
  | ITminus
  | ITbang
  | ITdot

Ian Lynagh's avatar
Ian Lynagh committed
672
  | ITbiglam                    -- GHC-extension symbols
673

Ian Lynagh's avatar
Ian Lynagh committed
674
  | ITocurly                    -- special symbols
675 676 677 678
  | ITccurly
  | ITvocurly
  | ITvccurly
  | ITobrack
Ian Lynagh's avatar
Ian Lynagh committed
679 680
  | ITopabrack                  -- [:, for parallel arrays with -XParallelArrays
  | ITcpabrack                  -- :], for parallel arrays with -XParallelArrays
681 682 683 684 685 686 687 688 689
  | ITcbrack
  | IToparen
  | ITcparen
  | IToubxparen
  | ITcubxparen
  | ITsemi
  | ITcomma
  | ITunderscore
  | ITbackquote
dreixel's avatar
dreixel committed
690
  | ITsimpleQuote               --  '
691

Ian Lynagh's avatar
Ian Lynagh committed
692
  | ITvarid   FastString        -- identifiers
693 694 695 696 697 698 699 700
  | 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
701
  | ITdupipvarid   FastString   -- GHC extension: implicit param: ?x
Adam Gundry's avatar
Adam Gundry committed
702
  | ITlabelvarid   FastString   -- Overloaded label: #x
703

704 705 706
  | 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
707
  | ITrational FractionalLit
708

709 710 711 712
  | 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
713 714
  | ITprimfloat  FractionalLit
  | ITprimdouble FractionalLit
715

716
  -- Template Haskell extension tokens
717 718 719 720 721 722 723 724 725 726 727 728
  | ITopenExpQuote HasE IsUnicodeSyntax --  [| or [e|
  | ITopenPatQuote                      --  [p|
  | ITopenDecQuote                      --  [d|
  | ITopenTypQuote                      --  [t|
  | ITcloseQuote IsUnicodeSyntax        --  |]
  | ITopenTExpQuote HasE                --  [|| or [e||
  | ITcloseTExpQuote                    --  ||]
  | ITidEscape   FastString             --  $x
  | ITparenEscape                       --  $(
  | ITidTyEscape   FastString           --  $$x
  | ITparenTyEscape                     --  $$(
  | ITtyQuote                           --  ''
729 730 731 732 733 734 735 736
  | 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 |]
737 738 739 740

  -- Arrow notation extension
  | ITproc
  | ITrec
741 742
  | IToparenbar  IsUnicodeSyntax --  (|
  | ITcparenbar  IsUnicodeSyntax --  |)
743 744 745 746
  | ITlarrowtail IsUnicodeSyntax --  -<
  | ITrarrowtail IsUnicodeSyntax --  >-
  | ITLarrowtail IsUnicodeSyntax --  -<<
  | ITRarrowtail IsUnicodeSyntax --  >>-
747

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
748 749 750 751 752 753 754
  -- 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
755 756 757 758 759 760 761

  -- 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
762 763
  | ITlineComment     String     -- comment starting by "--"
  | ITblockComment    String     -- comment in {- -}
764

765
  deriving Show
766

Alan Zimmerman's avatar
Alan Zimmerman committed
767 768 769
instance Outputable Token where
  ppr x = text (show x)

Alan Zimmerman's avatar
Alan Zimmerman committed
770

771 772 773 774 775 776 777
-- 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)
--
778
reservedWordsFM :: UniqFM (Token, ExtsBitmap)
779
reservedWordsFM = listToUFM $
Ian Lynagh's avatar
Ian Lynagh committed
780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806
    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 ),

807 808
         ( "forall",         ITforall NormalSyntax,
                                              xbit ExplicitForallBit .|.
809 810
                                              xbit InRulePragBit),
         ( "mdo",            ITmdo,           xbit RecursiveDoBit),
811 812 813
             -- See Note [Lexing type pseudo-keywords]
         ( "family",         ITfamily,        0 ),
         ( "role",           ITrole,          0 ),
814
         ( "pattern",        ITpattern,       xbit PatternSynonymsBit),
Facundo Domínguez's avatar
Facundo Domínguez committed
815
         ( "static",         ITstatic,        0 ),
Ryan Scott's avatar
Ryan Scott committed
816 817
         ( "stock",          ITstock,         0 ),
         ( "anyclass",       ITanyclass,      0 ),
818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835
         ( "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),

Edward Z. Yang's avatar
Edward Z. Yang committed
836 837 838 839
         ( "unit",           ITunit,          0 ),
         ( "dependency",     ITdependency,       0 ),
         ( "signature",      ITsignature,     0 ),

840 841 842
         ( "rec",            ITrec,           xbit ArrowsBit .|.
                                              xbit RecursiveDoBit),
         ( "proc",           ITproc,          xbit ArrowsBit)
843 844
     ]

845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860
{-----------------------------------
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.
-------------------------------------}
861

862
reservedSymsFM :: UniqFM (Token, ExtsBitmap -> Bool)
863
reservedSymsFM = listToUFM $
Ian Lynagh's avatar
Ian Lynagh committed
864
    map (\ (x,y,z) -> (mkFastString x,(y,z)))
865
      [ ("..",  ITdotdot,              always)
Ian Lynagh's avatar
Ian Lynagh committed
866
        -- (:) is a reserved op, meaning only list cons
867 868 869 870 871 872 873 874 875 876 877 878 879
       ,(":",   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
880 881

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

884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903
       ,("-<",  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
904 905 906
        -- 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).
907 908 909 910 911
       ]

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

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

914
special :: Token -> Action
twanvl's avatar
twanvl committed
915
special tok span _buf _len = return (L span tok)
916

917
token, layout_token :: Token -> Action
twanvl's avatar
twanvl committed
918 919
token t span _buf _len = return (L span t)
layout_token t span _buf _len = pushLexState layout >> return (L span t)
920

921 922
idtoken :: (StringBuffer -> Int -> Token) -> Action
idtoken f span buf len = return (L span $! (f buf len))
923

924
skip_one_varid :: (FastString -> Token) -> Action
Ian Lynagh's avatar
Ian Lynagh committed
925
skip_one_varid f span buf len
926
  = return (L span $! f (lexemeToFastString (stepOn buf) (len-1)))
927

928 929 930 931
skip_two_varid :: (FastString -> Token) -> Action
skip_two_varid f span buf len
  = return (L span $! f (lexemeToFastString (stepOn (stepOn buf)) (len-2)))

932
strtoken :: (String -> Token) -> Action
Ian Lynagh's avatar
Ian Lynagh committed
933
strtoken f span buf len =
934
  return (L span $! (f $! lexemeToString buf len))
935

936
init_strtoken :: Int -> (String -> Token) -> Action
937
-- like strtoken, but drops the last N character(s)
Ian Lynagh's avatar
Ian Lynagh committed
938
init_strtoken drop f span buf len =
939
  return (L span $! (f $! lexemeToString buf (len-drop)))
940 941

begin :: Int -> Action
942
begin code _span _str _len = do pushLexState code; lexToken
943 944

pop :: Action
Ian Lynagh's avatar
Ian Lynagh committed
945 946
pop _span _buf _len = do _ <- popLexState
                         lexToken
947

948 949 950 951 952 953 954 955
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
956 957
                 Layout prev_off _ : _ -> prev_off < offset
                 _                     -> True
958
      if isOK then pop_and open_brace span buf len
Ian Lynagh's avatar
Ian Lynagh committed
959
              else failSpanMsgP (RealSrcSpan span) (text "Missing block")
960

961
pop_and :: Action -> Action
Ian Lynagh's avatar
Ian Lynagh committed
962 963
pop_and act span buf len = do _ <- popLexState
                              act span buf len
964

965
{-# INLINE nextCharIs #-}
Ian Lynagh's avatar
Ian Lynagh committed
966
nextCharIs :: StringBuffer -> (Char -> Bool) -> Bool
967 968
nextCharIs buf p = not (atEnd buf) && p (currentChar buf)

969 970 971 972
{-# INLINE nextCharIsNot #-}
nextCharIsNot :: StringBuffer -> (Char -> Bool) -> Bool
nextCharIsNot buf p = not (nextCharIs buf p)

973
notFollowedBy :: Char -> AlexAccPred ExtsBitmap
Ian Lynagh's avatar
Ian Lynagh committed
974
notFollowedBy char _ _ _ (AI _ buf)
975
  = nextCharIsNot buf (== char)
976

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

Adam Gundry's avatar
Adam Gundry committed
981 982 983 984
followedByDigit :: AlexAccPred ExtsBitmap
followedByDigit _ _ _ (AI _ buf)
  = afterOptionalSpace buf (\b -> nextCharIs b (`elem` ['0'..'9']))

985 986 987 988
ifCurrentChar :: Char -> AlexAccPred ExtsBitmap
ifCurrentChar char _ (AI _ buf) _ _
  = nextCharIs buf (== char)

989 990 991 992 993
-- 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.
994
isNormalComment :: AlexAccPred ExtsBitmap
995
isNormalComment bits _ _ (AI _ buf)
996
  | haddockEnabled bits = notFollowedByDocOrPragma
997
  | otherwise           = nextCharIsNot buf (== '#')
998 999
  where
    notFollowedByDocOrPragma
1000
       = afterOptionalSpace buf (\b -> nextCharIsNot b (`elem` "|^*$#"))
1001

1002 1003 1004 1005 1006
afterOptionalSpace :: StringBuffer -> (StringBuffer -> Bool) -> Bool
afterOptionalSpace buf p
    = if nextCharIs buf (== ' ')
      then p (snd (nextChar buf))
      else p buf
1007

1008
atEOL :: AlexAccPred ExtsBitmap
1009
atEOL _ _ _ (AI _ buf) = atEnd buf || currentChar buf == '\n'
1010

1011
ifExtension :: (ExtsBitmap -> Bool) -> AlexAccPred ExtsBitmap
1012 1013
ifExtension pred bits _ _ _ = pred bits

1014 1015 1016
orExtensions :: (ExtsBitmap -> Bool) -> (ExtsBitmap -> Bool) -> AlexAccPred ExtsBitmap
orExtensions pred1 pred2 bits _ _ _ = pred1 bits || pred2 bits

1017 1018 1019
multiline_doc_comment :: Action
multiline_doc_comment span buf _len = withLexedDocType (worker "")
  where
1020
    worker commentAcc input docType checkNextLine = case alexGetChar' input of
Ian Lynagh's avatar
Ian Lynagh committed
1021
      Just ('\n', input')
1022 1023
        | checkNextLine -> case checkIfCommentLine input' of
          Just input -> worker ('\n':commentAcc) input docType checkNextLine
1024
          Nothing -> docCommentEnd input commentAcc docType buf span
1025 1026
        | otherwise -> docCommentEnd input commentAcc docType buf span
      Just (c, input) -> worker (c:commentAcc) input docType checkNextLine
1027
      Nothing -> docCommentEnd input commentAcc docType buf span
Ian Lynagh's avatar
Ian Lynagh committed
1028

1029 1030 1031 1032 1033 1034 1035 1036
    -- 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
1037 1038
    checkIfCommentLine input = check (dropNonNewlineSpace input)
      where
1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
        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
1049

1050
        dropNonNewlineSpace input = case alexGetChar' input of
Ian Lynagh's avatar
Ian Lynagh committed
1051
          Just (c, input')
1052 1053 1054 1055
            | isSpace c && c /= '\n' -> dropNonNewlineSpace input'
            | otherwise -> input
          Nothing -> input

Jedai's avatar
Jedai committed
1056 1057 1058 1059 1060
lineCommentToken :: Action
lineCommentToken span buf len = do
  b <- extension rawTokenStreamEnabled
  if b then strtoken ITlineComment span buf len else lexToken

1061 1062 1063 1064
{-
  nested comments require traversing by hand, they can't be parsed
  using regular expressions.
-}
Ian Lynagh's avatar
Ian Lynagh committed
1065
nested_comment :: P (RealLocated Token) -> Action
Alan Zimmerman's avatar
Alan Zimmerman committed
1066
nested_comment cont span buf len = do
1067
  input <- getInput