Lexer.x 95.7 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
-- XXX The above flags turn off warnings in the generated code:
45
{-# LANGUAGE BangPatterns #-}
46 47 48 49 50 51 52 53
{-# OPTIONS_GHC -fno-warn-unused-matches #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-missing-signatures #-}
-- But alex still generates some code that causes the "lazy unlifted bindings"
-- warning, and old compilers don't know about it so we can't easily turn
-- it off, so for now we use the sledge hammer:
{-# OPTIONS_GHC -w #-}
54

55 56
{-# OPTIONS_GHC -funbox-strict-fields #-}

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

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

-- bytestring
import Data.ByteString (ByteString)

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

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

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

-- compiler/basicTypes
import SrcLoc
108
import Module
Ian Lynagh's avatar
Ian Lynagh committed
109
import BasicTypes       ( InlineSpec(..), RuleMatchInfo(..), FractionalLit(..) )
110

rodlogic's avatar
rodlogic committed
111 112
-- compiler/parser
import Ctype
113 114
}

115 116 117 118 119 120 121
-- -----------------------------------------------------------------------------
-- Alex "Character set macros"

$unispace    = \x05 -- Trick Alex into handling Unicode. See alexGetByte.
$nl          = [\n\r\f]
$whitechar   = [$nl\v\ $unispace]
$white_no_nl = $whitechar # \n -- TODO #8424
122
$tab         = \t
123 124

$ascdigit  = 0-9
125
$unidigit  = \x03 -- Trick Alex into handling Unicode. See alexGetByte.
126
$decdigit  = $ascdigit -- for now, should really be $digit (ToDo)
127 128 129
$digit     = [$ascdigit $unidigit]

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

134
$unilarge  = \x01 -- Trick Alex into handling Unicode. See alexGetByte.
135
$asclarge  = [A-Z]
136 137
$large     = [$asclarge $unilarge]

138
$unismall  = \x02 -- Trick Alex into handling Unicode. See alexGetByte.
139
$ascsmall  = [a-z]
140 141
$small     = [$ascsmall $unismall \_]

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

145
$binit     = 0-1
Ian Lynagh's avatar
Ian Lynagh committed
146
$octit     = 0-7
147
$hexit     = [$decdigit A-F a-f]
148 149
$idchar    = [$small $large $digit \']

150 151
$pragmachar = [$small $large $digit]

152 153
$docsym    = [\| \^ \* \$]

154

155 156 157 158 159 160 161 162
-- -----------------------------------------------------------------------------
-- 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
163

164
@decimal     = $decdigit+
165
@binary      = $binit+
166 167 168 169 170
@octal       = $octit+
@hexadecimal = $hexit+
@exponent    = [eE] [\-\+]? @decimal

@qual = (@conid \.)+
171 172 173 174
@qvarid = @qual @varid
@qconid = @qual @conid
@qvarsym = @qual @varsym
@qconsym = @qual @consym
175 176 177

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

178 179 180 181 182
-- normal signed numerical literals can only be explicitly negative,
-- not explicitly positive (contrast @exponent)
@negative = \-
@signed = @negative ?

183 184 185 186

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

187 188
haskell :-

189 190 191 192 193

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

-- everywhere: skip whitespace
Ian Lynagh's avatar
Ian Lynagh committed
194
$white_no_nl+ ;
195
$tab+         { warn Opt_WarnTabs (text "Tab character") }
196 197 198 199 200

-- 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
201 202 203 204
-- are). We also rule out nested Haddock comments, if the -haddock flag is
-- set.

"{-" / { isNormalComment } { nested_comment lexToken }
205 206 207 208

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

-- Since Haddock comments aren't valid in every state, we need to rule them
Ian Lynagh's avatar
Ian Lynagh committed
211
-- out here.
212 213 214 215 216 217 218

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

Jedai's avatar
Jedai committed
219
"-- " ~[$docsym \#] .* { lineCommentToken }
220
"--" [^$symbol \ ] .* { lineCommentToken }
221 222 223

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

Jedai's avatar
Jedai committed
224
"-- " [$docsym \#] .* / { ifExtension (not . haddockEnabled) } { lineCommentToken }
225 226 227 228 229 230 231

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

232
"---"\-* ~$symbol .* { lineCommentToken }
233 234 235 236

-- 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
237
"--"\-* / { atEOL } { lineCommentToken }
238 239 240 241

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

Jedai's avatar
Jedai committed
242
"-- " / { atEOL } { lineCommentToken }
243 244 245 246 247 248 249 250 251 252 253

-- '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
254 255 256 257 258
  \n                                    ;
  ^\# (line)?                           { begin line_prag1 }
  ^\# pragma .* \n                      ; -- GCC 3.3 CPP generated, apparently
  ^\# \! .* \n                          ; -- #!, for scripts
  ()                                    { do_bol }
259 260 261 262 263
}

-- 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.
264
<layout, layout_do, layout_if> {
Ian Lynagh's avatar
Ian Lynagh committed
265 266 267 268
  \{ / { notFollowedBy '-' }            { hopefully_open_brace }
        -- we might encounter {-# here, but {- has been handled already
  \n                                    ;
  ^\# (line)?                           { begin line_prag1 }
269 270
}

271 272 273 274 275 276
-- after an 'if', a vertical bar starts a layout context for MultiWayIf
<layout_if> {
  \| / { notFollowedBySymbol }          { new_layout_context True ITvbar }
  ()                                    { pop }
}

277
-- do is treated in a subtly different way, see new_layout_context
278 279
<layout>    ()                          { new_layout_context True  ITvocurly }
<layout_do> ()                          { new_layout_context False ITvocurly }
280 281 282 283

-- 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
284
<layout_left>  ()                       { do_layout_left }
285

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

288 289
"{-#" $whitechar* $pragmachar+ / { known_pragma linePrags }
                                { dispatch_pragmas linePrags }
290 291 292

-- single-line line pragmas, of the form
--    # <line> "<file>" <extra-stuff> \n
293
<line_prag1> @decimal                   { setLine line_prag1a }
Ian Lynagh's avatar
Ian Lynagh committed
294 295
<line_prag1a> \" [$graphic \ ]* \"      { setFile line_prag1b }
<line_prag1b> .*                        { pop }
296 297 298

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

305
<0,option_prags> {
Ian Lynagh's avatar
Ian Lynagh committed
306
  "{-#" $whitechar* $pragmachar+
307 308 309 310 311
        $whitechar+ $pragmachar+ / { known_pragma twoWordPrags }
                                 { dispatch_pragmas twoWordPrags }

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

313
  -- We ignore all these pragmas, but don't generate a warning for them
314 315
  "{-#" $whitechar* $pragmachar+ / { known_pragma ignoredPrags }
                                 { dispatch_pragmas ignoredPrags }
316 317

  -- ToDo: should only be valid inside a pragma:
Ian Lynagh's avatar
Ian Lynagh committed
318
  "#-}"                          { endPrag }
319 320
}

321
<option_prags> {
322 323 324
  "{-#"  $whitechar* $pragmachar+ / { known_pragma fileHeaderPrags }
                                   { dispatch_pragmas fileHeaderPrags }

Ian Lynagh's avatar
Ian Lynagh committed
325
  "-- #"                           { multiline_doc_comment }
David Waern's avatar
David Waern committed
326 327
}

328 329
<0> {
  -- In the "0" mode we ignore these pragmas
330
  "{-#"  $whitechar* $pragmachar+ / { known_pragma fileHeaderPrags }
331 332 333
                     { nested_comment lexToken }
}

David Waern's avatar
David Waern committed
334
<0> {
Jedai's avatar
Jedai committed
335
  "-- #" .* { lineCommentToken }
336
}
337

338
<0,option_prags> {
339 340
  "{-#"  { warnThen Opt_WarnUnrecognisedPragmas (text "Unrecognised pragma")
                    (nested_comment lexToken) }
341 342
}

343 344
-- '0' state: ordinary lexemes

345 346
-- Haddock comments

347
<0,option_prags> {
David Waern's avatar
David Waern committed
348 349
  "-- " $docsym      / { ifExtension haddockEnabled } { multiline_doc_comment }
  "{-" \ ? $docsym   / { ifExtension haddockEnabled } { nested_doc_comment }
350 351
}

352 353
-- "special" symbols

354
<0> {
Ian Lynagh's avatar
Ian Lynagh committed
355 356
  "[:" / { ifExtension parrEnabled }    { token ITopabrack }
  ":]" / { ifExtension parrEnabled }    { token ITcpabrack }
357
}
Ian Lynagh's avatar
Ian Lynagh committed
358

359
<0> {
360 361 362
  "[|"        / { ifExtension thEnabled } { token ITopenExpQuote }
  "[||"       / { ifExtension thEnabled } { token ITopenTExpQuote }
  "[e|"       / { ifExtension thEnabled } { token ITopenExpQuote }
363
  "[e||"      / { ifExtension thEnabled } { token ITopenTExpQuote }
364 365 366 367 368 369 370 371 372
  "[p|"       / { ifExtension thEnabled } { token ITopenPatQuote }
  "[d|"       / { ifExtension thEnabled } { layout_token ITopenDecQuote }
  "[t|"       / { ifExtension thEnabled } { token ITopenTypQuote }
  "|]"        / { ifExtension thEnabled } { token ITcloseQuote }
  "||]"       / { ifExtension thEnabled } { token ITcloseTExpQuote }
  \$ @varid   / { ifExtension thEnabled } { skip_one_varid ITidEscape }
  "$$" @varid / { ifExtension thEnabled } { skip_two_varid ITidTyEscape }
  "$("        / { ifExtension thEnabled } { token ITparenEscape }
  "$$("       / { ifExtension thEnabled } { token ITparenTyEscape }
373

374 375 376 377
-- For backward compatibility, accept the old dollar syntax
  "[$" @varid "|"  / { ifExtension qqEnabled }
                     { lex_quasiquote_tok }

378
  "[" @varid "|"  / { ifExtension qqEnabled }
379
                     { lex_quasiquote_tok }
380 381

  -- qualified quasi-quote (#5555)
382 383
  "[" @qvarid "|"  / { ifExtension qqEnabled }
                     { lex_qquasiquote_tok }
384 385
}

386
<0> {
ross's avatar
ross committed
387
  "(|" / { ifExtension arrowsEnabled `alexAndPred` notFollowedBySymbol }
Ian Lynagh's avatar
Ian Lynagh committed
388
                                        { special IToparenbar }
389 390 391
  "|)" / { ifExtension arrowsEnabled }  { special ITcparenbar }
}

392
<0> {
Ian Lynagh's avatar
Ian Lynagh committed
393
  \? @varid / { ifExtension ipEnabled } { skip_one_varid ITdupipvarid }
394 395
}

396
<0> {
397
  "(#" / { ifExtension unboxedTuplesEnabled }
Ian Lynagh's avatar
Ian Lynagh committed
398 399 400 401 402
         { token IToubxparen }
  "#)" / { ifExtension unboxedTuplesEnabled }
         { token ITcubxparen }
}

403
<0,option_prags> {
Ian Lynagh's avatar
Ian Lynagh committed
404 405 406 407 408 409 410 411 412 413
  \(                                    { special IToparen }
  \)                                    { special ITcparen }
  \[                                    { special ITobrack }
  \]                                    { special ITcbrack }
  \,                                    { special ITcomma }
  \;                                    { special ITsemi }
  \`                                    { special ITbackquote }

  \{                                    { open_brace }
  \}                                    { close_brace }
414 415
}

416
<0,option_prags> {
417 418
  @qvarid                       { idtoken qvarid }
  @qconid                       { idtoken qconid }
Ian Lynagh's avatar
Ian Lynagh committed
419
  @varid                        { varid }
420
  @conid                        { idtoken conid }
421 422
}

423
<0> {
424 425
  @qvarid "#"+      / { ifExtension magicHashEnabled } { idtoken qvarid }
  @qconid "#"+      / { ifExtension magicHashEnabled } { idtoken qconid }
426
  @varid "#"+       / { ifExtension magicHashEnabled } { varid }
427
  @conid "#"+       / { ifExtension magicHashEnabled } { idtoken conid }
428 429
}

430 431
-- ToDo: - move `var` and (sym) into lexical syntax?
--       - remove backquote from $special?
432
<0> {
433 434
  @qvarsym                                         { idtoken qvarsym }
  @qconsym                                         { idtoken qconsym }
435 436
  @varsym                                          { varsym }
  @consym                                          { consym }
437 438
}

439 440
-- For the normal boxed literals we need to be careful
-- when trying to be close to Haskell98
441
<0> {
442
  -- Normal integral literals (:: Num a => a, from Integer)
443
  @decimal                                                               { tok_num positive 0 0 decimal }
444
  0[bB] @binary                / { ifExtension binaryLiteralsEnabled }   { tok_num positive 2 2 binary }
445 446 447
  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 }
448 449
  @negative 0[bB] @binary      / { ifExtension negativeLiteralsEnabled `alexAndPred`
                                   ifExtension binaryLiteralsEnabled }   { tok_num negative 3 3 binary }
450 451
  @negative 0[oO] @octal       / { ifExtension negativeLiteralsEnabled } { tok_num negative 3 3 octal }
  @negative 0[xX] @hexadecimal / { ifExtension negativeLiteralsEnabled } { tok_num negative 3 3 hexadecimal }
452 453

  -- Normal rational literals (:: Fractional a => a, from Rational)
454 455
  @floating_point                                                        { strtoken tok_float }
  @negative @floating_point    / { ifExtension negativeLiteralsEnabled } { strtoken tok_float }
456 457
}

458
<0> {
Ian Lynagh's avatar
Ian Lynagh committed
459
  -- Unboxed ints (:: Int#) and words (:: Word#)
460 461
  -- It's simpler (and faster?) to give separate cases to the negatives,
  -- especially considering octal/hexadecimal prefixes.
Ian Lynagh's avatar
Ian Lynagh committed
462
  @decimal                     \# / { ifExtension magicHashEnabled } { tok_primint positive 0 1 decimal }
463 464
  0[bB] @binary                \# / { ifExtension magicHashEnabled `alexAndPred`
                                      ifExtension binaryLiteralsEnabled } { tok_primint positive 2 3 binary }
Ian Lynagh's avatar
Ian Lynagh committed
465 466 467
  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 }
468 469
  @negative 0[bB] @binary      \# / { ifExtension magicHashEnabled `alexAndPred`
                                      ifExtension binaryLiteralsEnabled } { tok_primint negative 3 4 binary }
Ian Lynagh's avatar
Ian Lynagh committed
470
  @negative 0[oO] @octal       \# / { ifExtension magicHashEnabled } { tok_primint negative 3 4 octal }
471
  @negative 0[xX] @hexadecimal \# / { ifExtension magicHashEnabled } { tok_primint negative 3 4 hexadecimal }
472

Ian Lynagh's avatar
Ian Lynagh committed
473
  @decimal                     \# \# / { ifExtension magicHashEnabled } { tok_primword 0 2 decimal }
474 475
  0[bB] @binary                \# \# / { ifExtension magicHashEnabled `alexAndPred`
                                         ifExtension binaryLiteralsEnabled } { tok_primword 2 4 binary }
Ian Lynagh's avatar
Ian Lynagh committed
476 477 478
  0[oO] @octal                 \# \# / { ifExtension magicHashEnabled } { tok_primword 2 4 octal }
  0[xX] @hexadecimal           \# \# / { ifExtension magicHashEnabled } { tok_primword 2 4 hexadecimal }

479 480
  -- Unboxed floats and doubles (:: Float#, :: Double#)
  -- prim_{float,double} work with signed literals
481 482
  @signed @floating_point \# / { ifExtension magicHashEnabled } { init_strtoken 1 tok_primfloat }
  @signed @floating_point \# \# / { ifExtension magicHashEnabled } { init_strtoken 2 tok_primdouble }
483 484 485 486 487 488
}

-- 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.
489
<0> {
Ian Lynagh's avatar
Ian Lynagh committed
490 491
  \'                            { lex_char_tok }
  \"                            { lex_string_tok }
492 493
}

494 495 496 497

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

498 499 500 501
{
-- -----------------------------------------------------------------------------
-- The token type

502
data Token
Ian Lynagh's avatar
Ian Lynagh committed
503
  = ITas                        -- Haskell keywords
504 505 506 507 508 509 510 511
  | ITcase
  | ITclass
  | ITdata
  | ITdefault
  | ITderiving
  | ITdo
  | ITelse
  | IThiding
512
  | ITforeign
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528
  | ITif
  | ITimport
  | ITin
  | ITinfix
  | ITinfixl
  | ITinfixr
  | ITinstance
  | ITlet
  | ITmodule
  | ITnewtype
  | ITof
  | ITqualified
  | ITthen
  | ITtype
  | ITwhere

Ian Lynagh's avatar
Ian Lynagh committed
529
  | ITforall                    -- GHC extension keywords
530 531 532 533
  | ITexport
  | ITlabel
  | ITdynamic
  | ITsafe
534
  | ITinterruptible
535 536 537
  | ITunsafe
  | ITstdcallconv
  | ITccallconv
538
  | ITcapiconv
539
  | ITprimcallconv
thoughtpolice's avatar
thoughtpolice committed
540
  | ITjavascriptcallconv
541
  | ITmdo
542
  | ITfamily
543
  | ITrole
544 545 546
  | ITgroup
  | ITby
  | ITusing
cactus's avatar
cactus committed
547
  | ITpattern
548

Ian Lynagh's avatar
Ian Lynagh committed
549
  -- Pragmas
550
  | ITinline_prag InlineSpec RuleMatchInfo
Ian Lynagh's avatar
Ian Lynagh committed
551 552
  | ITspec_prag                 -- SPECIALISE
  | ITspec_inline_prag Bool     -- SPECIALISE INLINE (or NOINLINE)
553 554
  | ITsource_prag
  | ITrules_prag
Ian Lynagh's avatar
Ian Lynagh committed
555
  | ITwarning_prag
556 557 558
  | ITdeprecated_prag
  | ITline_prag
  | ITscc_prag
andy@galois.com's avatar
andy@galois.com committed
559
  | ITgenerated_prag
560
  | ITcore_prag                 -- hdaume: core annotations
561
  | ITunpack_prag
562
  | ITnounpack_prag
563
  | ITann_prag
564
  | ITclose_prag
565 566 567
  | IToptions_prag String
  | ITinclude_prag String
  | ITlanguage_prag
568 569
  | ITvect_prag
  | ITvect_scalar_prag
570
  | ITnovect_prag
571
  | ITminimal_prag
572 573 574
  | IToverlappable_prag         -- instance overlap mode
  | IToverlapping_prag          -- instance overlap mode
  | IToverlaps_prag             -- instance overlap mode
575
  | ITincoherent_prag           -- instance overlap mode
576
  | ITctype
577

Ian Lynagh's avatar
Ian Lynagh committed
578
  | ITdotdot                    -- reserved symbols
579 580 581 582
  | ITcolon
  | ITdcolon
  | ITequal
  | ITlam
583
  | ITlcase
584 585 586 587 588
  | ITvbar
  | ITlarrow
  | ITrarrow
  | ITat
  | ITtilde
batterseapower's avatar
batterseapower committed
589
  | ITtildehsh
590 591 592 593 594 595
  | ITdarrow
  | ITminus
  | ITbang
  | ITstar
  | ITdot

Ian Lynagh's avatar
Ian Lynagh committed
596
  | ITbiglam                    -- GHC-extension symbols
597

Ian Lynagh's avatar
Ian Lynagh committed
598
  | ITocurly                    -- special symbols
599 600 601 602
  | ITccurly
  | ITvocurly
  | ITvccurly
  | ITobrack
Ian Lynagh's avatar
Ian Lynagh committed
603 604
  | ITopabrack                  -- [:, for parallel arrays with -XParallelArrays
  | ITcpabrack                  -- :], for parallel arrays with -XParallelArrays
605 606 607 608 609 610 611 612 613
  | ITcbrack
  | IToparen
  | ITcparen
  | IToubxparen
  | ITcubxparen
  | ITsemi
  | ITcomma
  | ITunderscore
  | ITbackquote
dreixel's avatar
dreixel committed
614
  | ITsimpleQuote               --  '
615

Ian Lynagh's avatar
Ian Lynagh committed
616
  | ITvarid   FastString        -- identifiers
617 618 619 620 621 622 623
  | ITconid   FastString
  | ITvarsym  FastString
  | ITconsym  FastString
  | ITqvarid  (FastString,FastString)
  | ITqconid  (FastString,FastString)
  | ITqvarsym (FastString,FastString)
  | ITqconsym (FastString,FastString)
624 625
  | ITprefixqvarsym (FastString,FastString)
  | ITprefixqconsym (FastString,FastString)
626

Ian Lynagh's avatar
Ian Lynagh committed
627
  | ITdupipvarid   FastString   -- GHC extension: implicit param: ?x
628 629 630 631

  | ITchar       Char
  | ITstring     FastString
  | ITinteger    Integer
632
  | ITrational   FractionalLit
633 634

  | ITprimchar   Char
635
  | ITprimstring ByteString
636
  | ITprimint    Integer
Ian Lynagh's avatar
Ian Lynagh committed
637
  | ITprimword   Integer
638 639
  | ITprimfloat  FractionalLit
  | ITprimdouble FractionalLit
640

641
  -- Template Haskell extension tokens
Ian Lynagh's avatar
Ian Lynagh committed
642 643 644 645 646
  | ITopenExpQuote              --  [| or [e|
  | ITopenPatQuote              --  [p|
  | ITopenDecQuote              --  [d|
  | ITopenTypQuote              --  [t|
  | ITcloseQuote                --  |]
647 648
  | ITopenTExpQuote             --  [||
  | ITcloseTExpQuote            --  ||]
Ian Lynagh's avatar
Ian Lynagh committed
649 650
  | ITidEscape   FastString     --  $x
  | ITparenEscape               --  $(
651 652
  | ITidTyEscape   FastString   --  $$x
  | ITparenTyEscape             --  $$(
Ian Lynagh's avatar
Ian Lynagh committed
653
  | ITtyQuote                   --  ''
654 655 656 657 658 659 660 661
  | 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 |]
662 663 664 665

  -- Arrow notation extension
  | ITproc
  | ITrec
Ian Lynagh's avatar
Ian Lynagh committed
666 667 668 669 670 671
  | IToparenbar                 --  (|
  | ITcparenbar                 --  |)
  | ITlarrowtail                --  -<
  | ITrarrowtail                --  >-
  | ITLarrowtail                --  -<<
  | ITRarrowtail                --  >>-
672

Ian Lynagh's avatar
Ian Lynagh committed
673 674
  | ITunknown String            -- Used when the lexer can't make sense of it
  | ITeof                       -- end of file token
675 676 677 678 679 680 681

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

686
  deriving Show
687 688 689 690 691 692 693 694

-- 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)
--
695
reservedWordsFM :: UniqFM (Token, ExtsBitmap)
696
reservedWordsFM = listToUFM $
Ian Lynagh's avatar
Ian Lynagh committed
697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723
    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 ),

724 725 726
         ( "forall",         ITforall,        xbit ExplicitForallBit .|.
                                              xbit InRulePragBit),
         ( "mdo",            ITmdo,           xbit RecursiveDoBit),
727 728 729
             -- See Note [Lexing type pseudo-keywords]
         ( "family",         ITfamily,        0 ),
         ( "role",           ITrole,          0 ),
730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751
         ( "pattern",        ITpattern,       xbit PatternSynonymsBit),
         ( "group",          ITgroup,         xbit TransformComprehensionsBit),
         ( "by",             ITby,            xbit TransformComprehensionsBit),
         ( "using",          ITusing,         xbit TransformComprehensionsBit),

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

         ( "rec",            ITrec,           xbit ArrowsBit .|.
                                              xbit RecursiveDoBit),
         ( "proc",           ITproc,          xbit ArrowsBit)
752 753
     ]

754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769
{-----------------------------------
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.
-------------------------------------}
770

771
reservedSymsFM :: UniqFM (Token, ExtsBitmap -> Bool)
772
reservedSymsFM = listToUFM $
Ian Lynagh's avatar
Ian Lynagh committed
773 774 775 776 777 778 779 780 781 782 783 784
    map (\ (x,y,z) -> (mkFastString x,(y,z)))
      [ ("..",  ITdotdot,   always)
        -- (:) is a reserved op, meaning only list cons
       ,(":",   ITcolon,    always)
       ,("::",  ITdcolon,   always)
       ,("=",   ITequal,    always)
       ,("\\",  ITlam,      always)
       ,("|",   ITvbar,     always)
       ,("<-",  ITlarrow,   always)
       ,("->",  ITrarrow,   always)
       ,("@",   ITat,       always)
       ,("~",   ITtilde,    always)
785
       ,("~#",  ITtildehsh, magicHashEnabled)
Ian Lynagh's avatar
Ian Lynagh committed
786 787 788 789 790
       ,("=>",  ITdarrow,   always)
       ,("-",   ITminus,    always)
       ,("!",   ITbang,     always)

        -- For data T (a::*) = MkT
791
       ,("*", ITstar, always) -- \i -> kindSigsEnabled i || tyFamEnabled i)
Ian Lynagh's avatar
Ian Lynagh committed
792
        -- For 'forall a . t'
793
       ,(".", ITdot,  always) -- \i -> explicitForallEnabled i || inRulePrag i)
Ian Lynagh's avatar
Ian Lynagh committed
794 795 796 797 798

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

Ian Lynagh's avatar
Ian Lynagh committed
800 801
       ,("∷",   ITdcolon, unicodeSyntaxEnabled)
       ,("⇒",   ITdarrow, unicodeSyntaxEnabled)
802
       ,("∀",   ITforall, unicodeSyntaxEnabled)
Ian Lynagh's avatar
Ian Lynagh committed
803 804
       ,("→",   ITrarrow, unicodeSyntaxEnabled)
       ,("←",   ITlarrow, unicodeSyntaxEnabled)
805 806 807 808 809 810 811 812

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

       ,("★", ITstar, unicodeSyntaxEnabled)

Simon Marlow's avatar
Simon Marlow committed
813 814 815
        -- 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).
816 817 818 819 820
       ]

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

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

823
special :: Token -> Action
twanvl's avatar
twanvl committed
824
special tok span _buf _len = return (L span tok)
825

826
token, layout_token :: Token -> Action
twanvl's avatar
twanvl committed
827 828
token t span _buf _len = return (L span t)
layout_token t span _buf _len = pushLexState layout >> return (L span t)
829

830 831
idtoken :: (StringBuffer -> Int -> Token) -> Action
idtoken f span buf len = return (L span $! (f buf len))
832

833
skip_one_varid :: (FastString -> Token) -> Action
Ian Lynagh's avatar
Ian Lynagh committed
834
skip_one_varid f span buf len
835
  = return (L span $! f (lexemeToFastString (stepOn buf) (len-1)))
836

837 838 839 840
skip_two_varid :: (FastString -> Token) -> Action
skip_two_varid f span buf len
  = return (L span $! f (lexemeToFastString (stepOn (stepOn buf)) (len-2)))

841
strtoken :: (String -> Token) -> Action
Ian Lynagh's avatar
Ian Lynagh committed
842
strtoken f span buf len =
843
  return (L span $! (f $! lexemeToString buf len))
844

845
init_strtoken :: Int -> (String -> Token) -> Action
846
-- like strtoken, but drops the last N character(s)
Ian Lynagh's avatar
Ian Lynagh committed
847
init_strtoken drop f span buf len =
848
  return (L span $! (f $! lexemeToString buf (len-drop)))
849 850

begin :: Int -> Action
851
begin code _span _str _len = do pushLexState code; lexToken
852 853

pop :: Action
Ian Lynagh's avatar
Ian Lynagh committed
854 855
pop _span _buf _len = do _ <- popLexState
                         lexToken
856

857 858 859 860 861 862 863 864 865 866 867
hopefully_open_brace :: Action
hopefully_open_brace span buf len
 = do relaxed <- extension relaxedLayout
      ctx <- getContext
      (AI l _) <- getInput
      let offset = srcLocCol l
          isOK = relaxed ||
                 case ctx of
                 Layout prev_off : _ -> prev_off < offset
                 _                   -> True
      if isOK then pop_and open_brace span buf len
Ian Lynagh's avatar
Ian Lynagh committed
868
              else failSpanMsgP (RealSrcSpan span) (text "Missing block")
869

870
pop_and :: Action -> Action
Ian Lynagh's avatar
Ian Lynagh committed
871 872
pop_and act span buf len = do _ <- popLexState
                              act span buf len
873

874
{-# INLINE nextCharIs #-}
Ian Lynagh's avatar
Ian Lynagh committed
875
nextCharIs :: StringBuffer -> (Char -> Bool) -> Bool
876 877
nextCharIs buf p = not (atEnd buf) && p (currentChar buf)

878 879 880 881
{-# INLINE nextCharIsNot #-}
nextCharIsNot :: StringBuffer -> (Char -> Bool) -> Bool
nextCharIsNot buf p = not (nextCharIs buf p)

882
notFollowedBy :: Char -> AlexAccPred ExtsBitmap
Ian Lynagh's avatar
Ian Lynagh committed
883
notFollowedBy char _ _ _ (AI _ buf)
884
  = nextCharIsNot buf (== char)
885

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

890 891 892 893 894
-- 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.
895
isNormalComment :: AlexAccPred ExtsBitmap
896
isNormalComment bits _ _ (AI _ buf)
897
  | haddockEnabled bits = notFollowedByDocOrPragma
898
  | otherwise           = nextCharIsNot buf (== '#')
899 900
  where
    notFollowedByDocOrPragma
901
       = afterOptionalSpace buf (\b -> nextCharIsNot b (`elem` "|^*$#"))
902

903 904 905 906 907
afterOptionalSpace :: StringBuffer -> (StringBuffer -> Bool) -> Bool
afterOptionalSpace buf p
    = if nextCharIs buf (== ' ')
      then p (snd (nextChar buf))
      else p buf
908

909
atEOL :: AlexAccPred ExtsBitmap
910
atEOL _ _ _ (AI _ buf) = atEnd buf || currentChar buf == '\n'
911

912
ifExtension :: (ExtsBitmap -> Bool) -> AlexAccPred ExtsBitmap
913 914
ifExtension pred bits _ _ _ = pred bits

915 916 917
multiline_doc_comment :: Action
multiline_doc_comment span buf _len = withLexedDocType (worker "")
  where
918
    worker commentAcc input docType oneLine = case alexGetChar' input of
Ian Lynagh's avatar
Ian Lynagh committed
919
      Just ('\n', input')
920 921 922 923 924 925
        | oneLine -> docCommentEnd input commentAcc docType buf span
        | otherwise -> case checkIfCommentLine input' of
          Just input -> worker ('\n':commentAcc) input docType False
          Nothing -> docCommentEnd input commentAcc docType buf span
      Just (c, input) -> worker (c:commentAcc) input docType oneLine
      Nothing -> docCommentEnd input commentAcc docType buf span
Ian Lynagh's avatar
Ian Lynagh committed
926

927 928
    checkIfCommentLine input = check (dropNonNewlineSpace input)
      where
929 930 931
        check input = case alexGetChar' input of
          Just ('-', input) -> case alexGetChar' input of
            Just ('-', input) -> case alexGetChar' input of
932 933 934 935 936
              Just (c, _) | c /= '-' -> Just input
              _ -> Nothing
            _ -> Nothing
          _ -> Nothing

937
        dropNonNewlineSpace input = case alexGetChar' input of
Ian Lynagh's avatar
Ian Lynagh committed
938
          Just (c, input')
939 940 941 942
            | isSpace c && c /= '\n' -> dropNonNewlineSpace input'
            | otherwise -> input
          Nothing -> input

Jedai's avatar
Jedai committed
943 944 945 946 947
lineCommentToken :: Action
lineCommentToken span buf len = do
  b <- extension rawTokenStreamEnabled
  if b then strtoken ITlineComment span buf len else lexToken

948 949 950 951
{-
  nested comments require traversing by hand, they can't be parsed
  using regular expressions.
-}
Ian Lynagh's avatar
Ian Lynagh committed
952
nested_comment :: P (RealLocated Token) -> Action
953
nested_comment cont span _str _len = do
954
  input <- getInput
Jedai's avatar
Jedai committed
955
  go "" (1::Int) input
956
  where
Jedai's avatar
Jedai committed
957 958 959 960 961
    go commentAcc 0 input = do setInput input
                               b <- extension rawTokenStreamEnabled
                               if b
                                 then docCommentEnd input commentAcc ITblockComment _str span
                                 else cont
962
    go commentAcc n input = case alexGetChar' input of
963
      Nothing -> errBrace input span
964
      Just ('-',input) -> case alexGetChar' input of
965
        Nothing  -> errBrace input span
Jedai's avatar
Jedai committed
966 967
        Just ('\125',input) -> go commentAcc (n-1) input
        Just (_,_)          -> go ('-':commentAcc) n input
968
      Just ('\123',input) -> case alexGetChar' input of
969
        Nothing  -> errBrace input span
Jedai's avatar
Jedai committed
970 971 972
        Just ('-',input) -> go ('-':'\123':commentAcc) (n+1) input
        Just (_,_)       -> go ('\123':commentAcc) n input
      Just (c,input) -> go (c:commentAcc) n input
973 974 975 976

nested_doc_comment :: Action
nested_doc_comment span buf _len = withLexedDocType (go "")
  where
977
    go commentAcc input docType _ = case alexGetChar' input of
978
      Nothing -> errBrace input span
979
      Just ('-',input) -> case alexGetChar' input of
980
        Nothing -> errBrace input span
twanvl's avatar
twanvl committed
981
        Just ('\125',input) ->
982
          docCommentEnd input commentAcc docType buf span
twanvl's avatar
twanvl committed
983
        Just (_,_) -> go ('-':commentAcc) input docType False
984
      Just ('\123', input) -> case alexGetChar' input of
985 986 987 988 989
        Nothing  -> errBrace input span
        Just ('-',input) -> do
          setInput input
          let cont = do input <- getInput; go commentAcc input docType False
          nested_comment cont span buf _len
twanvl's avatar
twanvl committed
990
        Just (_,_) -> go ('\123':commentAcc) input docType False
991 992
      Just (c,input) -> go (c:commentAcc) input docType False

Ian Lynagh's avatar
Ian Lynagh committed
993 994
withLexedDocType :: (AlexInput -> (String -> Token) -> Bool -> P (RealLocated Token))
                 -> P (RealLocated Token)
995
withLexedDocType lexDocComment = do
996
  input@(AI _ buf) <- getInput
997 998 999 1000
  case prevChar buf ' ' of
    '|' -> lexDocComment input ITdocCommentNext False
    '^' -> lexDocComment input ITdocCommentPrev False
    '$' -> lexDocComment input ITdocCommentNamed False
David Waern's avatar
David Waern committed
1001 1002
    '*' -> lexDocSection 1 input
    '#' -> lexDocComment input ITdocOptionsOld False
Ian Lynagh's avatar
Ian Lynagh committed
1003
    _ -> panic "withLexedDocType: Bad doc type"
Ian Lynagh's avatar
Ian Lynagh committed
1004
 where
1005
    lexDocSection n input = case alexGetChar' input of
1006
      Just ('*', input) -> lexDocSection (n+1) input
twanvl's avatar
twanvl committed
1007
      Just (_,   _)     -> lexDocComment input (ITdocSection n) True
1008 1009
      Nothing -> do setInput input; lexToken -- eof reached, lex it normally

1010 1011 1012
-- RULES pragmas turn on the forall and '.' keywords, and we turn them
-- off again at the end of the pragma.
rulePrag :: Action
1013
rulePrag span _buf _len = do
1014
  setExts (.|. xbit InRulePragBit)
1015 1016 1017
  return (L span ITrules_prag)

endPrag :: Action
1018
endPrag span _buf _len = do
1019
  setExts (.&. complement (xbit InRulePragBit))
1020 1021
  return (L span ITclose_prag)

1022 1023 1024 1025
-- docCommentEnd
-------------------------------------------------------------------------------
-- This function is quite tricky. We can't just return a new token, we also
-- need to update the state of the parser. Why? Because the token is longer
Ian Lynagh's avatar
Ian Lynagh committed
1026
-- than what was lexed by Alex, and the lexToken function doesn't know this, so