Lexer.x 122 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,
71
   starIsTypeEnabled,
Jedai's avatar
Jedai committed
72
   addWarning,
Alan Zimmerman's avatar
Alan Zimmerman committed
73
   lexTokenStream,
74
   addAnnotation,AddAnn,addAnnsAt,mkParensApiAnn,
75
   commentToAnnotation,
76
   moveAnnotations
77 78
  ) where

79 80
import GhcPrelude

rodlogic's avatar
rodlogic committed
81 82
-- base
import Control.Monad
83
import Control.Monad.Fail as MonadFail
rodlogic's avatar
rodlogic committed
84
import Data.Bits
85
import Data.Char
rodlogic's avatar
rodlogic committed
86 87 88 89
import Data.List
import Data.Maybe
import Data.Word

90 91
import EnumSet (EnumSet)
import qualified EnumSet
92

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

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

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

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

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

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

rodlogic's avatar
rodlogic committed
122 123
-- compiler/parser
import Ctype
Alan Zimmerman's avatar
Alan Zimmerman committed
124 125

import ApiAnnotation
126 127
}

128 129 130
-- -----------------------------------------------------------------------------
-- Alex "Character set macros"

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

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

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

149
$unilarge  = \x01 -- Trick Alex into handling Unicode. See [Unicode in Alex].
150
$asclarge  = [A-Z]
151 152
$large     = [$asclarge $unilarge]

153
$unismall  = \x02 -- Trick Alex into handling Unicode. See [Unicode in Alex].
154
$ascsmall  = [a-z]
155 156
$small     = [$ascsmall $unismall \_]

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

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

164
$uniidchar = \x07 -- Trick Alex into handling Unicode. See [Unicode in Alex].
165
$idchar    = [$small $large $digit $uniidchar \']
166

167 168
$pragmachar = [$small $large $digit]

169 170
$docsym    = [\| \^ \* \$]

171

172 173 174 175 176 177 178 179
-- -----------------------------------------------------------------------------
-- 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
180

181 182 183 184 185 186 187 188
-- See Note [Lexing NumericUnderscores extension] and #14473
@numspc       = _*                   -- numeric spacer (#14473)
@decimal      = $decdigit(@numspc $decdigit)*
@binary       = $binit(@numspc $binit)*
@octal        = $octit(@numspc $octit)*
@hexadecimal  = $hexit(@numspc $hexit)*
@exponent     = @numspc [eE] [\-\+]? @decimal
@bin_exponent = @numspc [pP] [\-\+]? @decimal
189 190

@qual = (@conid \.)+
191 192 193 194
@qvarid = @qual @varid
@qconid = @qual @conid
@qvarsym = @qual @varsym
@qconsym = @qual @consym
195

196 197
@floating_point = @numspc @decimal \. @decimal @exponent? | @numspc @decimal @exponent
@hex_floating_point = @numspc @hexadecimal \. @hexadecimal @bin_exponent? | @numspc @hexadecimal @bin_exponent
198

199 200 201 202 203
-- normal signed numerical literals can only be explicitly negative,
-- not explicitly positive (contrast @exponent)
@negative = \-
@signed = @negative ?

204 205 206 207

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

208 209
haskell :-

210 211 212 213 214

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

-- everywhere: skip whitespace
Ian Lynagh's avatar
Ian Lynagh committed
215
$white_no_nl+ ;
216
$tab          { warnTab }
217 218 219 220 221

-- 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
222 223 224 225
-- are). We also rule out nested Haddock comments, if the -haddock flag is
-- set.

"{-" / { isNormalComment } { nested_comment lexToken }
226 227 228 229

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

-- Since Haddock comments aren't valid in every state, we need to rule them
Ian Lynagh's avatar
Ian Lynagh committed
232
-- out here.
233 234 235 236 237 238 239

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

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

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

245
"-- " $docsym .* / { ifExtension (not . haddockEnabled) } { lineCommentToken }
246 247 248 249 250 251 252

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

253
"---"\-* ~$symbol .* { lineCommentToken }
254 255 256 257

-- 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
258
"--"\-* / { atEOL } { lineCommentToken }
259 260 261 262

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

Jedai's avatar
Jedai committed
263
"-- " / { atEOL } { lineCommentToken }
264 265 266 267 268 269 270 271 272 273 274

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

-- 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.
286
<layout, layout_do, layout_if> {
Ian Lynagh's avatar
Ian Lynagh committed
287 288 289 290
  \{ / { notFollowedBy '-' }            { hopefully_open_brace }
        -- we might encounter {-# here, but {- has been handled already
  \n                                    ;
  ^\# (line)?                           { begin line_prag1 }
291 292
}

293 294
-- after an 'if', a vertical bar starts a layout context for MultiWayIf
<layout_if> {
295
  \| / { notFollowedBySymbol }          { new_layout_context True dontGenerateSemic ITvbar }
296 297 298
  ()                                    { pop }
}

299
-- do is treated in a subtly different way, see new_layout_context
300 301
<layout>    ()                          { new_layout_context True  generateSemic ITvocurly }
<layout_do> ()                          { new_layout_context False generateSemic ITvocurly }
302 303 304 305

-- 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
306
<layout_left>  ()                       { do_layout_left }
307

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

310 311
"{-#" $whitechar* $pragmachar+ / { known_pragma linePrags }
                                { dispatch_pragmas linePrags }
312 313 314

-- single-line line pragmas, of the form
--    # <line> "<file>" <extra-stuff> \n
315 316 317 318 319
<line_prag1> {
  @decimal $white_no_nl+ \" [$graphic \ ]* \"  { setLineAndFile line_prag1a }
  ()                                           { failLinePrag1 }
}
<line_prag1a> .*                               { popLinePrag1 }
320 321 322

-- Haskell-style line pragmas, of the form
--    {-# LINE <line> "<file>" #-}
323 324 325 326
<line_prag2> {
  @decimal $white_no_nl+ \" [$graphic \ ]* \"  { setLineAndFile line_prag2a }
}
<line_prag2a> "#-}"|"-}"                       { pop }
327 328
   -- NOTE: accept -} at the end of a LINE pragma, for compatibility
   -- with older versions of GHC which generated these.
329

Rufflewind's avatar
Rufflewind committed
330 331 332 333
-- Haskell-style column pragmas, of the form
--    {-# COLUMN <column> #-}
<column_prag> @decimal $whitechar* "#-}" { setColumn }

334
<0,option_prags> {
Ian Lynagh's avatar
Ian Lynagh committed
335
  "{-#" $whitechar* $pragmachar+
336 337 338 339 340
        $whitechar+ $pragmachar+ / { known_pragma twoWordPrags }
                                 { dispatch_pragmas twoWordPrags }

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

342
  -- We ignore all these pragmas, but don't generate a warning for them
343 344
  "{-#" $whitechar* $pragmachar+ / { known_pragma ignoredPrags }
                                 { dispatch_pragmas ignoredPrags }
345 346

  -- ToDo: should only be valid inside a pragma:
Ian Lynagh's avatar
Ian Lynagh committed
347
  "#-}"                          { endPrag }
348 349
}

350
<option_prags> {
351 352
  "{-#"  $whitechar* $pragmachar+ / { known_pragma fileHeaderPrags }
                                   { dispatch_pragmas fileHeaderPrags }
David Waern's avatar
David Waern committed
353 354
}

355 356
<0> {
  -- In the "0" mode we ignore these pragmas
357
  "{-#"  $whitechar* $pragmachar+ / { known_pragma fileHeaderPrags }
358 359 360
                     { nested_comment lexToken }
}

361
<0,option_prags> {
362 363
  "{-#"  { warnThen Opt_WarnUnrecognisedPragmas (text "Unrecognised pragma")
                    (nested_comment lexToken) }
364 365
}

366 367
-- '0' state: ordinary lexemes

368 369
-- Haddock comments

370
<0,option_prags> {
David Waern's avatar
David Waern committed
371 372
  "-- " $docsym      / { ifExtension haddockEnabled } { multiline_doc_comment }
  "{-" \ ? $docsym   / { ifExtension haddockEnabled } { nested_doc_comment }
373 374
}

375 376
-- "special" symbols

377
<0> {
378 379
  "[|"        / { ifExtension thQuotesEnabled } { token (ITopenExpQuote NoE
                                                                NormalSyntax) }
380
  "[||"       / { ifExtension thQuotesEnabled } { token (ITopenTExpQuote NoE) }
381 382
  "[e|"       / { ifExtension thQuotesEnabled } { token (ITopenExpQuote HasE
                                                                NormalSyntax) }
383 384 385 386
  "[e||"      / { ifExtension thQuotesEnabled } { token (ITopenTExpQuote HasE) }
  "[p|"       / { ifExtension thQuotesEnabled } { token ITopenPatQuote }
  "[d|"       / { ifExtension thQuotesEnabled } { layout_token ITopenDecQuote }
  "[t|"       / { ifExtension thQuotesEnabled } { token ITopenTypQuote }
387 388
  "|]"        / { ifExtension thQuotesEnabled } { token (ITcloseQuote
                                                                NormalSyntax) }
389
  "||]"       / { ifExtension thQuotesEnabled } { token ITcloseTExpQuote }
390 391 392 393
  \$ @varid   / { ifExtension thEnabled } { skip_one_varid ITidEscape }
  "$$" @varid / { ifExtension thEnabled } { skip_two_varid ITidTyEscape }
  "$("        / { ifExtension thEnabled } { token ITparenEscape }
  "$$("       / { ifExtension thEnabled } { token ITparenTyEscape }
394

395
  "[" @varid "|"  / { ifExtension qqEnabled }
396
                     { lex_quasiquote_tok }
397 398

  -- qualified quasi-quote (#5555)
399 400
  "[" @qvarid "|"  / { ifExtension qqEnabled }
                     { lex_qquasiquote_tok }
401 402 403 404 405 406 407 408 409

  $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) }
410 411
}

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
412 413 414 415 416 417 418 419
  -- See Note [Lexing type applications]
<0> {
    [^ $idchar \) ] ^
  "@"
    / { ifExtension typeApplicationEnabled `alexAndPred` notFollowedBySymbol }
    { token ITtypeApp }
}

420
<0> {
ross's avatar
ross committed
421
  "(|" / { ifExtension arrowsEnabled `alexAndPred` notFollowedBySymbol }
422 423 424 425 426 427 428 429 430 431 432
                                        { 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) }
433 434
}

435
<0> {
Ian Lynagh's avatar
Ian Lynagh committed
436
  \? @varid / { ifExtension ipEnabled } { skip_one_varid ITdupipvarid }
437 438
}

Adam Gundry's avatar
Adam Gundry committed
439 440 441 442 443
<0> {
  "#" @varid / { ifExtension overloadedLabelsEnabled }
               { skip_one_varid ITlabelvarid }
}

444
<0> {
445
  "(#" / { orExtensions unboxedTuplesEnabled unboxedSumsEnabled }
Ian Lynagh's avatar
Ian Lynagh committed
446
         { token IToubxparen }
447
  "#)" / { orExtensions unboxedTuplesEnabled unboxedSumsEnabled }
Ian Lynagh's avatar
Ian Lynagh committed
448 449 450
         { token ITcubxparen }
}

451
<0,option_prags> {
Ian Lynagh's avatar
Ian Lynagh committed
452 453 454 455 456 457 458 459 460 461
  \(                                    { special IToparen }
  \)                                    { special ITcparen }
  \[                                    { special ITobrack }
  \]                                    { special ITcbrack }
  \,                                    { special ITcomma }
  \;                                    { special ITsemi }
  \`                                    { special ITbackquote }

  \{                                    { open_brace }
  \}                                    { close_brace }
462 463
}

464
<0,option_prags> {
465 466
  @qvarid                       { idtoken qvarid }
  @qconid                       { idtoken qconid }
Ian Lynagh's avatar
Ian Lynagh committed
467
  @varid                        { varid }
468
  @conid                        { idtoken conid }
469 470
}

471
<0> {
472 473
  @qvarid "#"+      / { ifExtension magicHashEnabled } { idtoken qvarid }
  @qconid "#"+      / { ifExtension magicHashEnabled } { idtoken qconid }
474
  @varid "#"+       / { ifExtension magicHashEnabled } { varid }
475
  @conid "#"+       / { ifExtension magicHashEnabled } { idtoken conid }
476 477
}

478 479
-- ToDo: - move `var` and (sym) into lexical syntax?
--       - remove backquote from $special?
480
<0> {
481 482
  @qvarsym                                         { idtoken qvarsym }
  @qconsym                                         { idtoken qconsym }
483 484
  @varsym                                          { varsym }
  @consym                                          { consym }
485 486
}

487 488
-- For the normal boxed literals we need to be careful
-- when trying to be close to Haskell98
489 490 491 492 493 494 495 496 497 498

-- Note [Lexing NumericUnderscores extension] (#14473)
--
-- NumericUnderscores extension allows underscores in numeric literals.
-- Multiple underscores are represented with @numspc macro.
-- To be simpler, we have only the definitions with underscores.
-- And then we have a separate function (tok_integral and tok_frac)
-- that validates the literals.
-- If extensions are not enabled, check that there are no underscores.
--
499
<0> {
500
  -- Normal integral literals (:: Num a => a, from Integer)
501
  @decimal                                                               { tok_num positive 0 0 decimal }
502 503 504
  0[bB] @numspc @binary        / { ifExtension binaryLiteralsEnabled }   { tok_num positive 2 2 binary }
  0[oO] @numspc @octal                                                   { tok_num positive 2 2 octal }
  0[xX] @numspc @hexadecimal                                             { tok_num positive 2 2 hexadecimal }
505
  @negative @decimal           / { ifExtension negativeLiteralsEnabled } { tok_num negative 1 1 decimal }
506 507 508 509
  @negative 0[bB] @numspc @binary  / { ifExtension negativeLiteralsEnabled `alexAndPred`
                                       ifExtension binaryLiteralsEnabled }   { tok_num negative 3 3 binary }
  @negative 0[oO] @numspc @octal   / { ifExtension negativeLiteralsEnabled } { tok_num negative 3 3 octal }
  @negative 0[xX] @numspc @hexadecimal / { ifExtension negativeLiteralsEnabled } { tok_num negative 3 3 hexadecimal }
510 511

  -- Normal rational literals (:: Fractional a => a, from Rational)
512 513 514 515 516
  @floating_point                                                        { tok_frac 0 tok_float }
  @negative @floating_point    / { ifExtension negativeLiteralsEnabled } { tok_frac 0 tok_float }
  0[xX] @numspc @hex_floating_point     / { ifExtension hexFloatLiteralsEnabled } { tok_frac 0 tok_hex_float }
  @negative 0[xX] @numspc @hex_floating_point / { ifExtension hexFloatLiteralsEnabled `alexAndPred`
                                                  ifExtension negativeLiteralsEnabled } { tok_frac 0 tok_hex_float }
517 518
}

519
<0> {
Ian Lynagh's avatar
Ian Lynagh committed
520
  -- Unboxed ints (:: Int#) and words (:: Word#)
521 522
  -- It's simpler (and faster?) to give separate cases to the negatives,
  -- especially considering octal/hexadecimal prefixes.
Ian Lynagh's avatar
Ian Lynagh committed
523
  @decimal                     \# / { ifExtension magicHashEnabled } { tok_primint positive 0 1 decimal }
524
  0[bB] @numspc @binary        \# / { ifExtension magicHashEnabled `alexAndPred`
525
                                      ifExtension binaryLiteralsEnabled } { tok_primint positive 2 3 binary }
526 527
  0[oO] @numspc @octal         \# / { ifExtension magicHashEnabled } { tok_primint positive 2 3 octal }
  0[xX] @numspc @hexadecimal   \# / { ifExtension magicHashEnabled } { tok_primint positive 2 3 hexadecimal }
Ian Lynagh's avatar
Ian Lynagh committed
528
  @negative @decimal           \# / { ifExtension magicHashEnabled } { tok_primint negative 1 2 decimal }
529 530 531 532
  @negative 0[bB] @numspc @binary  \# / { ifExtension magicHashEnabled `alexAndPred`
                                          ifExtension binaryLiteralsEnabled } { tok_primint negative 3 4 binary }
  @negative 0[oO] @numspc @octal   \# / { ifExtension magicHashEnabled } { tok_primint negative 3 4 octal }
  @negative 0[xX] @numspc @hexadecimal \# / { ifExtension magicHashEnabled } { tok_primint negative 3 4 hexadecimal }
533

Ian Lynagh's avatar
Ian Lynagh committed
534
  @decimal                     \# \# / { ifExtension magicHashEnabled } { tok_primword 0 2 decimal }
535
  0[bB] @numspc @binary        \# \# / { ifExtension magicHashEnabled `alexAndPred`
536
                                         ifExtension binaryLiteralsEnabled } { tok_primword 2 4 binary }
537 538
  0[oO] @numspc @octal         \# \# / { ifExtension magicHashEnabled } { tok_primword 2 4 octal }
  0[xX] @numspc @hexadecimal   \# \# / { ifExtension magicHashEnabled } { tok_primword 2 4 hexadecimal }
Ian Lynagh's avatar
Ian Lynagh committed
539

540 541
  -- Unboxed floats and doubles (:: Float#, :: Double#)
  -- prim_{float,double} work with signed literals
542 543
  @signed @floating_point \# / { ifExtension magicHashEnabled } { tok_frac 1 tok_primfloat }
  @signed @floating_point \# \# / { ifExtension magicHashEnabled } { tok_frac 2 tok_primdouble }
544 545 546 547 548 549
}

-- 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.
550
<0> {
Ian Lynagh's avatar
Ian Lynagh committed
551 552
  \'                            { lex_char_tok }
  \"                            { lex_string_tok }
553 554
}

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
555 556 557 558 559 560 561 562 563 564 565
-- 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
566
-- Disambiguation is accomplished by requiring *something* to appear between
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
567 568 569 570 571 572 573 574 575 576 577 578 579 580
-- 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.
581 582 583 584

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

585
{
586

587 588 589
-- -----------------------------------------------------------------------------
-- The token type

590
data Token
Ian Lynagh's avatar
Ian Lynagh committed
591
  = ITas                        -- Haskell keywords
592 593 594 595 596 597 598 599
  | ITcase
  | ITclass
  | ITdata
  | ITdefault
  | ITderiving
  | ITdo
  | ITelse
  | IThiding
600
  | ITforeign
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616
  | ITif
  | ITimport
  | ITin
  | ITinfix
  | ITinfixl
  | ITinfixr
  | ITinstance
  | ITlet
  | ITmodule
  | ITnewtype
  | ITof
  | ITqualified
  | ITthen
  | ITtype
  | ITwhere

617
  | ITforall            IsUnicodeSyntax -- GHC extension keywords
618 619 620 621
  | ITexport
  | ITlabel
  | ITdynamic
  | ITsafe
622
  | ITinterruptible
623 624 625
  | ITunsafe
  | ITstdcallconv
  | ITccallconv
626
  | ITcapiconv
627
  | ITprimcallconv
thoughtpolice's avatar
thoughtpolice committed
628
  | ITjavascriptcallconv
629
  | ITmdo
630
  | ITfamily
631
  | ITrole
632 633 634
  | ITgroup
  | ITby
  | ITusing
cactus's avatar
cactus committed
635
  | ITpattern
Facundo Domínguez's avatar
Facundo Domínguez committed
636
  | ITstatic
Ryan Scott's avatar
Ryan Scott committed
637 638
  | ITstock
  | ITanyclass
Ryan Scott's avatar
Ryan Scott committed
639
  | ITvia
640

Edward Z. Yang's avatar
Edward Z. Yang committed
641 642 643 644 645 646
  -- Backpack tokens
  | ITunit
  | ITsignature
  | ITdependency
  | ITrequires

Alan Zimmerman's avatar
Alan Zimmerman committed
647 648 649 650 651 652 653 654
  -- 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
655 656
  | ITline_prag         SourceText  -- not usually produced, see 'use_pos_prags'
  | ITcolumn_prag       SourceText  -- not usually produced, see 'use_pos_prags'
Alan Zimmerman's avatar
Alan Zimmerman committed
657 658 659 660 661 662
  | ITscc_prag          SourceText
  | ITgenerated_prag    SourceText
  | ITcore_prag         SourceText         -- hdaume: core annotations
  | ITunpack_prag       SourceText
  | ITnounpack_prag     SourceText
  | ITann_prag          SourceText
663
  | ITcomplete_prag     SourceText
664
  | ITclose_prag
665 666 667
  | IToptions_prag String
  | ITinclude_prag String
  | ITlanguage_prag
Alan Zimmerman's avatar
Alan Zimmerman committed
668 669 670 671 672 673
  | 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
674
  | ITcomment_line_prag         -- See Note [Nested comment line pragmas]
675

Ian Lynagh's avatar
Ian Lynagh committed
676
  | ITdotdot                    -- reserved symbols
677
  | ITcolon
678
  | ITdcolon            IsUnicodeSyntax
679 680
  | ITequal
  | ITlam
681
  | ITlcase
682
  | ITvbar
683 684
  | ITlarrow            IsUnicodeSyntax
  | ITrarrow            IsUnicodeSyntax
685 686
  | ITat
  | ITtilde
687
  | ITdarrow            IsUnicodeSyntax
688 689
  | ITminus
  | ITbang
690
  | ITstar              IsUnicodeSyntax
691 692
  | ITdot

Ian Lynagh's avatar
Ian Lynagh committed
693
  | ITbiglam                    -- GHC-extension symbols
694

Ian Lynagh's avatar
Ian Lynagh committed
695
  | ITocurly                    -- special symbols
696 697 698 699
  | ITccurly
  | ITvocurly
  | ITvccurly
  | ITobrack
Ian Lynagh's avatar
Ian Lynagh committed
700 701
  | ITopabrack                  -- [:, for parallel arrays with -XParallelArrays
  | ITcpabrack                  -- :], for parallel arrays with -XParallelArrays
702 703 704 705 706 707 708 709 710
  | ITcbrack
  | IToparen
  | ITcparen
  | IToubxparen
  | ITcubxparen
  | ITsemi
  | ITcomma
  | ITunderscore
  | ITbackquote
dreixel's avatar
dreixel committed
711
  | ITsimpleQuote               --  '
712

Ian Lynagh's avatar
Ian Lynagh committed
713
  | ITvarid   FastString        -- identifiers
714 715 716 717 718 719 720 721
  | 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
722
  | ITdupipvarid   FastString   -- GHC extension: implicit param: ?x
Adam Gundry's avatar
Adam Gundry committed
723
  | ITlabelvarid   FastString   -- Overloaded label: #x
724

725 726
  | ITchar     SourceText Char       -- Note [Literal source text] in BasicTypes
  | ITstring   SourceText FastString -- Note [Literal source text] in BasicTypes
727
  | ITinteger  IntegralLit           -- Note [Literal source text] in BasicTypes
Alan Zimmerman's avatar
Alan Zimmerman committed
728
  | ITrational FractionalLit
729

730 731 732 733
  | 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
734 735
  | ITprimfloat  FractionalLit
  | ITprimdouble FractionalLit
736

737
  -- Template Haskell extension tokens
738 739 740 741 742 743 744 745 746 747 748 749
  | 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                           --  ''
750 751 752 753 754 755 756 757
  | 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 |]
758 759 760 761

  -- Arrow notation extension
  | ITproc
  | ITrec
762 763
  | IToparenbar  IsUnicodeSyntax --  (|
  | ITcparenbar  IsUnicodeSyntax --  |)
764 765 766 767
  | ITlarrowtail IsUnicodeSyntax --  -<
  | ITrarrowtail IsUnicodeSyntax --  >-
  | ITLarrowtail IsUnicodeSyntax --  -<<
  | ITRarrowtail IsUnicodeSyntax --  >>-
768

eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
769 770 771 772 773 774 775
  -- 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
776 777 778 779 780 781 782

  -- 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
783 784
  | ITlineComment     String     -- comment starting by "--"
  | ITblockComment    String     -- comment in {- -}
785

786
  deriving Show
787

Alan Zimmerman's avatar
Alan Zimmerman committed
788 789 790
instance Outputable Token where
  ppr x = text (show x)

Alan Zimmerman's avatar
Alan Zimmerman committed
791

792 793 794 795 796 797 798
-- 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)
--
799
reservedWordsFM :: UniqFM (Token, ExtsBitmap)
800
reservedWordsFM = listToUFM $
Ian Lynagh's avatar
Ian Lynagh committed
801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827
    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 ),

828 829
         ( "forall",         ITforall NormalSyntax,
                                              xbit ExplicitForallBit .|.
830 831
                                              xbit InRulePragBit),
         ( "mdo",            ITmdo,           xbit RecursiveDoBit),
832 833 834
             -- See Note [Lexing type pseudo-keywords]
         ( "family",         ITfamily,        0 ),
         ( "role",           ITrole,          0 ),
835
         ( "pattern",        ITpattern,       xbit PatternSynonymsBit),
Facundo Domínguez's avatar
Facundo Domínguez committed
836
         ( "static",         ITstatic,        0 ),
Ryan Scott's avatar
Ryan Scott committed
837 838
         ( "stock",          ITstock,         0 ),
         ( "anyclass",       ITanyclass,      0 ),
Ryan Scott's avatar
Ryan Scott committed
839
         ( "via",            ITvia,           0 ),
840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857
         ( "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
858 859 860 861
         ( "unit",           ITunit,          0 ),
         ( "dependency",     ITdependency,       0 ),
         ( "signature",      ITsignature,     0 ),

862 863 864
         ( "rec",            ITrec,           xbit ArrowsBit .|.
                                              xbit RecursiveDoBit),
         ( "proc",           ITproc,          xbit ArrowsBit)
865 866
     ]

867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882
{-----------------------------------
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.
-------------------------------------}
883

884
reservedSymsFM :: UniqFM (Token, ExtsBitmap -> Bool)
885
reservedSymsFM = listToUFM $
Ian Lynagh's avatar
Ian Lynagh committed
886
    map (\ (x,y,z) -> (mkFastString x,(y,z)))
887
      [ ("..",  ITdotdot,              always)
Ian Lynagh's avatar
Ian Lynagh committed
888
        -- (:) is a reserved op, meaning only list cons
889 890 891 892 893 894 895 896 897 898 899 900
       ,(":",   ITcolon,               always)
       ,("::",  ITdcolon NormalSyntax, always)
       ,("=",   ITequal,               always)
       ,("\\",  ITlam,                 always)
       ,("|",   ITvbar,                always)
       ,("<-",  ITlarrow NormalSyntax, always)
       ,("->",  ITrarrow NormalSyntax, always)
       ,("@",   ITat,                  always)
       ,("~",   ITtilde,               always)
       ,("=>",  ITdarrow NormalSyntax, always)
       ,("-",   ITminus,               always)
       ,("!",   ITbang,                always)
Ian Lynagh's avatar
Ian Lynagh committed
901

902 903
       ,("*", ITstar NormalSyntax, starIsTypeEnabled)

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

907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925
       ,("-<",  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)
926 927
       ,("★",   ITstar UnicodeSyntax,
                  \i -> unicodeSyntaxEnabled i && starIsTypeEnabled i)
928

Simon Marlow's avatar
Simon Marlow committed
929 930 931
        -- 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).
932 933 934 935 936
       ]

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

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

939
special :: Token -> Action
twanvl's avatar
twanvl committed
940
special tok span _buf _len = return (L span tok)
941

942
token, layout_token :: Token -> Action
twanvl's avatar
twanvl committed
943 944
token t span _buf _len = return (L span t)
layout_token t span _buf _len = pushLexState layout >> return (L span t)
945

946 947
idtoken :: (StringBuffer -> Int -> Token) -> Action
idtoken f span buf len = return (L span $! (f buf len))
948

949
skip_one_varid :: (FastString -> Token) -> Action
Ian Lynagh's avatar
Ian Lynagh committed
950
skip_one_varid f span buf len
951
  = return (L span $! f (lexemeToFastString (stepOn buf) (len-1)))
952

953 954 955 956
skip_two_varid :: (FastString -> Token) -> Action
skip_two_varid f span buf len
  = return (L span $! f (lexemeToFastString (stepOn (stepOn buf)) (len-2)))

957
strtoken :: (String -> Token) -> Action
Ian Lynagh's avatar
Ian Lynagh committed
958
strtoken f span buf len =
959
  return (L span $! (f $! lexemeToString buf len))
960 961

begin :: Int -> Action
962
begin code _span _str _len = do pushLexState code; lexToken
963 964

pop :: Action
Ian Lynagh's avatar
Ian Lynagh committed
965 966
pop _span _buf _len = do _ <- popLexState
                         lexToken
967 968 969 970 971 972 973 974 975 976 977 978 979 980
-- See Note [Nested comment line pragmas]
failLinePrag1 :: Action
failLinePrag1 span _buf _len = do
  b <- extension inNestedComment
  if b then return (L span ITcomment_line_prag)
       else lexError "lexical error in pragma"

-- See Note [Nested comment line pragmas]
popLinePrag1 :: Action
popLinePrag1 span _buf _len = do
  b <- extension inNestedComment
  if b then return (L span ITcomment_line_prag) else do
    _ <- popLexState
    lexToken
981

982 983 984 985 986 987 988 989
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
990 991
                 Layout prev_off _ : _ -> prev_off < offset
                 _                     -> True
992
      if isOK then pop_and open_brace span buf len
Ian Lynagh's avatar
Ian Lynagh committed
993
              else failSpanMsgP (RealSrcSpan span) (text "Missing block")
994

995
pop_and :: Action -> Action
Ian Lynagh's avatar
Ian Lynagh committed
996 997
pop_and act span buf len = do _ <- popLexState
                              act span buf len
998

999
{-# INLINE nextCharIs #-}
Ian Lynagh's avatar
Ian Lynagh committed
1000
nextCharIs :: StringBuffer -> (Char -> Bool) -> Bool
1001 1002
nextCharIs buf p = not (atEnd buf) && p (currentChar buf)

1003 1004 1005 1006
{-# INLINE nextCharIsNot #-}
nextCharIsNot :: StringBuffer -> (Char -> Bool) -> Bool
nextCharIsNot buf p = not (nextCharIs buf p)

1007
notFollowedBy :: Char -> AlexAccPred ExtsBitmap
Ian Lynagh's avatar
Ian Lynagh committed
1008
notFollowedBy char _ _ _ (AI _ buf)
1009
  = nextCharIsNot buf (== char)
1010

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

Adam Gundry's avatar
Adam Gundry committed
1015 1016 1017 1018
followedByDigit :: AlexAccPred ExtsBitmap
followedByDigit _ _ _ (AI _ buf)
  = afterOptionalSpace buf (\b -> nextCharIs b (`elem` ['0'..'9']))

1019 1020 1021 1022
ifCurrentChar :: Char -> AlexAccPred ExtsBitmap
ifCurrentChar char _ (AI _ buf) _ _
  = nextCharIs buf (== char)

1023 1024 1025 1026 1027
-- 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.
1028
isNormalComment :: AlexAccPred ExtsBitmap
1029
isNormalComment bits _ _ (AI _ buf)
1030
  | haddockEnabled bits = notFollowedByDocOrPragma
1031
  | otherwise           = nextCharIsNot buf (== '#')
1032 1033
  where
    notFollowedByDocOrPragma
1034
       = afterOptionalSpace buf (\b -> nextCharIsNot b (`elem` "|^*$#"))
1035

1036 1037 1038 1039 1040
afterOptionalSpace :: StringBuffer -> (StringBuffer -> Bool) -> Bool
afterOptionalSpace buf p
    = if nextCharIs buf (== ' ')
      then p (snd (nextChar buf))
      else p buf
1041

1042
atEOL :: AlexAccPred ExtsBitmap
1043
atEOL _ _ _ (AI _ buf) = atEnd buf || currentChar buf == '\n'
1044

1045
ifExtension :: (ExtsBitmap -> Bool) -> AlexAccPred ExtsBitmap
1046 1047
ifExtension pred bits _ _ _ = pred bits

1048 1049 1050
orExtensions :: (ExtsBitmap -> Bool) -> (ExtsBitmap -> Bool) -> AlexAccPred ExtsBitmap
orExtensions pred1 pred2 bits _ _ _ = pred1 bits || pred2 bits

1051 1052 1053
multiline_doc_comment :: Action
multiline_doc_comment span buf _len = withLexedDocType (worker "")
  where
1054
    worker commentAcc input docType checkNextLine = case alexGetChar' input of
Ian Lynagh's avatar
Ian Lynagh committed
1055
      Just ('\n', input')
1056 1057
        | checkNextLine -> case checkIfCommentLine input' of
          Just input -> worker ('\n':commentAcc) input docType checkNextLine
1058
          Nothing -> docCommentEnd input commentAcc docType buf span
1059 1060
        | otherwise -> docCommentEnd input commentAcc docType buf span
      Just (c, input) -> worker (c:commentAcc) input docType checkNextLine
1061
      Nothing -> docCommentEnd input commentAcc docType buf span
Ian Lynagh's avatar
Ian Lynagh committed
1062