Lexer.x 103 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 #-}
Alan Zimmerman's avatar
Alan Zimmerman committed
46
{-# LANGUAGE DeriveDataTypeable #-}
47 48 49 50 51 52 53 54
{-# 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 #-}
55

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

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

rodlogic's avatar
rodlogic committed
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
-- 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

Alan Zimmerman's avatar
Alan Zimmerman committed
96 97 98 99
-- data/typeable
import Data.Data
import Data.Typeable

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

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

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

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

import ApiAnnotation
122 123
}

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

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

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

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

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

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

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

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

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

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

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

168

169 170 171 172 173 174 175 176
-- -----------------------------------------------------------------------------
-- Alex "Regular expression macros"

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

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

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

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

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

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

197 198 199 200

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

201 202
haskell :-

203 204 205 206 207

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

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

-- Everywhere: deal with nested comments.  We explicitly rule out
-- pragmas, "{-#", so that we don't accidentally treat them as comments.
-- (this can happen even though pragmas will normally take precedence due to
-- longest-match, because pragmas aren't valid in every state, but comments
215 216 217 218
-- are). We also rule out nested Haddock comments, if the -haddock flag is
-- set.

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

-- Single-line comments are a bit tricky.  Haskell 98 says that two or
-- more dashes followed by a symbol should be parsed as a varsym, so we
-- have to exclude those.
223 224

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

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

Jedai's avatar
Jedai committed
233
"-- " ~[$docsym \#] .* { lineCommentToken }
234
"--" [^$symbol \ ] .* { lineCommentToken }
235 236 237

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

Jedai's avatar
Jedai committed
238
"-- " [$docsym \#] .* / { ifExtension (not . haddockEnabled) } { lineCommentToken }
239 240 241 242 243 244 245

-- Now, when we've matched comments that begin with 2 dashes and continue
-- with a different character, we need to match comments that begin with three
-- or more dashes (which clearly can't be Haddock comments). We only need to
-- make sure that the first non-dash character isn't a symbol, and munch the
-- rest of the line.

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

-- Since the previous rules all match dashes followed by at least one
-- character, we also need to match a whole line filled with just dashes.

Jedai's avatar
Jedai committed
251
"--"\-* / { atEOL } { lineCommentToken }
252 253 254 255

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

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

-- 'bol' state: beginning of a line.  Slurp up all the whitespace (including
-- blank lines) until we find a non-whitespace character, then do layout
-- processing.
--
-- One slight wibble here: what if the line begins with {-#? In
-- theory, we have to lex the pragma to see if it's one we recognise,
-- and if it is, then we backtrack and do_bol, otherwise we treat it
-- as a nested comment.  We don't bother with this: if the line begins
-- with {-#, then we'll assume it's a pragma we know about and go for do_bol.
<bol> {
Ian Lynagh's avatar
Ian Lynagh committed
268 269 270 271 272
  \n                                    ;
  ^\# (line)?                           { begin line_prag1 }
  ^\# pragma .* \n                      ; -- GCC 3.3 CPP generated, apparently
  ^\# \! .* \n                          ; -- #!, for scripts
  ()                                    { do_bol }
273 274 275 276 277
}

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

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

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

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

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

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

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

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

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

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

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

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

335
<option_prags> {
336 337 338
  "{-#"  $whitechar* $pragmachar+ / { known_pragma fileHeaderPrags }
                                   { dispatch_pragmas fileHeaderPrags }

Ian Lynagh's avatar
Ian Lynagh committed
339
  "-- #"                           { multiline_doc_comment }
David Waern's avatar
David Waern committed
340 341
}

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

David Waern's avatar
David Waern committed
348
<0> {
Jedai's avatar
Jedai committed
349
  "-- #" .* { lineCommentToken }
350
}
351

352
<0,option_prags> {
353 354
  "{-#"  { warnThen Opt_WarnUnrecognisedPragmas (text "Unrecognised pragma")
                    (nested_comment lexToken) }
355 356
}

357 358
-- '0' state: ordinary lexemes

359 360
-- Haddock comments

361
<0,option_prags> {
David Waern's avatar
David Waern committed
362 363
  "-- " $docsym      / { ifExtension haddockEnabled } { multiline_doc_comment }
  "{-" \ ? $docsym   / { ifExtension haddockEnabled } { nested_doc_comment }
364 365
}

366 367
-- "special" symbols

368
<0> {
Ian Lynagh's avatar
Ian Lynagh committed
369 370
  "[:" / { ifExtension parrEnabled }    { token ITopabrack }
  ":]" / { ifExtension parrEnabled }    { token ITcpabrack }
371
}
Ian Lynagh's avatar
Ian Lynagh committed
372

373
<0> {
374 375 376
  "[|"        / { ifExtension thEnabled } { token ITopenExpQuote }
  "[||"       / { ifExtension thEnabled } { token ITopenTExpQuote }
  "[e|"       / { ifExtension thEnabled } { token ITopenExpQuote }
377
  "[e||"      / { ifExtension thEnabled } { token ITopenTExpQuote }
378 379 380 381 382 383 384 385 386
  "[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 }
387

388 389 390 391
-- For backward compatibility, accept the old dollar syntax
  "[$" @varid "|"  / { ifExtension qqEnabled }
                     { lex_quasiquote_tok }

392
  "[" @varid "|"  / { ifExtension qqEnabled }
393
                     { lex_quasiquote_tok }
394 395

  -- qualified quasi-quote (#5555)
396 397
  "[" @qvarid "|"  / { ifExtension qqEnabled }
                     { lex_qquasiquote_tok }
398 399
}

400
<0> {
ross's avatar
ross committed
401
  "(|" / { ifExtension arrowsEnabled `alexAndPred` notFollowedBySymbol }
Ian Lynagh's avatar
Ian Lynagh committed
402
                                        { special IToparenbar }
403 404 405
  "|)" / { ifExtension arrowsEnabled }  { special ITcparenbar }
}

406
<0> {
Ian Lynagh's avatar
Ian Lynagh committed
407
  \? @varid / { ifExtension ipEnabled } { skip_one_varid ITdupipvarid }
408 409
}

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

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

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

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

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

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

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

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

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

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

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

-- Strings and chars are lexed by hand-written code.  The reason is
-- that even if we recognise the string or char here in the regex
-- lexer, we would still have to parse the string afterward in order
-- to convert it to a String.
503
<0> {
Ian Lynagh's avatar
Ian Lynagh committed
504 505
  \'                            { lex_char_tok }
  \"                            { lex_string_tok }
506 507
}

508 509 510 511

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

512
{
513

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

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

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

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

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

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

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

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

Ian Lynagh's avatar
Ian Lynagh committed
643
  | ITdupipvarid   FastString   -- GHC extension: implicit param: ?x
644

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

650 651 652 653
  | 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
654 655
  | ITprimfloat  FractionalLit
  | ITprimdouble FractionalLit
656

657
  -- Template Haskell extension tokens
Ian Lynagh's avatar
Ian Lynagh committed
658 659 660 661 662
  | ITopenExpQuote              --  [| or [e|
  | ITopenPatQuote              --  [p|
  | ITopenDecQuote              --  [d|
  | ITopenTypQuote              --  [t|
  | ITcloseQuote                --  |]
663 664
  | ITopenTExpQuote             --  [||
  | ITcloseTExpQuote            --  ||]
Ian Lynagh's avatar
Ian Lynagh committed
665 666
  | ITidEscape   FastString     --  $x
  | ITparenEscape               --  $(
667 668
  | ITidTyEscape   FastString   --  $$x
  | ITparenTyEscape             --  $$(
Ian Lynagh's avatar
Ian Lynagh committed
669
  | ITtyQuote                   --  ''
670 671 672 673 674 675 676 677
  | 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 |]
678 679 680 681

  -- Arrow notation extension
  | ITproc
  | ITrec
Ian Lynagh's avatar
Ian Lynagh committed
682 683 684 685 686 687
  | IToparenbar                 --  (|
  | ITcparenbar                 --  |)
  | ITlarrowtail                --  -<
  | ITrarrowtail                --  >-
  | ITLarrowtail                --  -<<
  | ITRarrowtail                --  >>-
688

Ian Lynagh's avatar
Ian Lynagh committed
689 690
  | ITunknown String            -- Used when the lexer can't make sense of it
  | ITeof                       -- end of file token
691 692 693 694 695 696 697

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

702
  deriving Show
703

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

Alan Zimmerman's avatar
Alan Zimmerman committed
707

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

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

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

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

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

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

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

792
reservedSymsFM :: UniqFM (Token, ExtsBitmap -> Bool)
793
reservedSymsFM = listToUFM $
Ian Lynagh's avatar
Ian Lynagh committed
794 795 796 797 798 799 800 801 802 803 804 805
    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)
806
       ,("~#",  ITtildehsh, magicHashEnabled)
Ian Lynagh's avatar
Ian Lynagh committed
807 808 809 810 811
       ,("=>",  ITdarrow,   always)
       ,("-",   ITminus,    always)
       ,("!",   ITbang,     always)

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

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

Ian Lynagh's avatar
Ian Lynagh committed
821 822
       ,("∷",   ITdcolon, unicodeSyntaxEnabled)
       ,("⇒",   ITdarrow, unicodeSyntaxEnabled)
823
       ,("∀",   ITforall, unicodeSyntaxEnabled)
Ian Lynagh's avatar
Ian Lynagh committed
824 825
       ,("→",   ITrarrow, unicodeSyntaxEnabled)
       ,("←",   ITlarrow, unicodeSyntaxEnabled)
826 827 828 829 830 831 832 833

       ,("⤙",   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
834 835 836
        -- 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).
837 838 839 840 841
       ]

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

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

844
special :: Token -> Action
twanvl's avatar
twanvl committed
845
special tok span _buf _len = return (L span tok)
846

847
token, layout_token :: Token -> Action
twanvl's avatar
twanvl committed
848 849
token t span _buf _len = return (L span t)
layout_token t span _buf _len = pushLexState layout >> return (L span t)
850

851 852
idtoken :: (StringBuffer -> Int -> Token) -> Action
idtoken f span buf len = return (L span $! (f buf len))
853

854
skip_one_varid :: (FastString -> Token) -> Action
Ian Lynagh's avatar
Ian Lynagh committed
855
skip_one_varid f span buf len
856
  = return (L span $! f (lexemeToFastString (stepOn buf) (len-1)))
857

858 859 860 861
skip_two_varid :: (FastString -> Token) -> Action
skip_two_varid f span buf len
  = return (L span $! f (lexemeToFastString (stepOn (stepOn buf)) (len-2)))

862
strtoken :: (String -> Token) -> Action
Ian Lynagh's avatar
Ian Lynagh committed
863
strtoken f span buf len =
864
  return (L span $! (f $! lexemeToString buf len))
865

866
init_strtoken :: Int -> (String -> Token) -> Action
867
-- like strtoken, but drops the last N character(s)
Ian Lynagh's avatar
Ian Lynagh committed
868
init_strtoken drop f span buf len =
869
  return (L span $! (f $! lexemeToString buf (len-drop)))
870 871

begin :: Int -> Action
872
begin code _span _str _len = do pushLexState code; lexToken
873 874

pop :: Action
Ian Lynagh's avatar
Ian Lynagh committed
875 876
pop _span _buf _len = do _ <- popLexState
                         lexToken
877

878 879 880 881 882 883 884 885 886 887 888
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
889
              else failSpanMsgP (RealSrcSpan span) (text "Missing block")
890

891
pop_and :: Action -> Action
Ian Lynagh's avatar
Ian Lynagh committed
892 893
pop_and act span buf len = do _ <- popLexState
                              act span buf len
894

895
{-# INLINE nextCharIs #-}
Ian Lynagh's avatar
Ian Lynagh committed
896
nextCharIs :: StringBuffer -> (Char -> Bool) -> Bool
897 898
nextCharIs buf p = not (atEnd buf) && p (currentChar buf)

899 900 901 902
{-# INLINE nextCharIsNot #-}
nextCharIsNot :: StringBuffer -> (Char -> Bool) -> Bool
nextCharIsNot buf p = not (nextCharIs buf p)

903
notFollowedBy :: Char -> AlexAccPred ExtsBitmap
Ian Lynagh's avatar
Ian Lynagh committed
904
notFollowedBy char _ _ _ (AI _ buf)
905
  = nextCharIsNot buf (== char)
906

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

911 912 913 914 915
-- 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.
916
isNormalComment :: AlexAccPred ExtsBitmap
917
isNormalComment bits _ _ (AI _ buf)
918
  | haddockEnabled bits = notFollowedByDocOrPragma
919
  | otherwise           = nextCharIsNot buf (== '#')
920 921
  where
    notFollowedByDocOrPragma
922
       = afterOptionalSpace buf (\b -> nextCharIsNot b (`elem` "|^*$#"))
923

924 925 926 927 928
afterOptionalSpace :: StringBuffer -> (StringBuffer -> Bool) -> Bool
afterOptionalSpace buf p
    = if nextCharIs buf (== ' ')
      then p (snd (nextChar buf))
      else p buf
929

930
atEOL :: AlexAccPred ExtsBitmap
931
atEOL _ _ _ (AI _ buf) = atEnd buf || currentChar buf == '\n'
932

933
ifExtension :: (ExtsBitmap -> Bool) -> AlexAccPred ExtsBitmap
934 935
ifExtension pred bits _ _ _ = pred bits

936 937 938
multiline_doc_comment :: Action
multiline_doc_comment span buf _len = withLexedDocType (worker "")
  where
939
    worker commentAcc input docType oneLine = case alexGetChar' input of
Ian Lynagh's avatar
Ian Lynagh committed
940
      Just ('\n', input')
941 942 943 944 945 946
        | 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
947

948 949
    checkIfCommentLine input = check (dropNonNewlineSpace input)
      where
950 951 952
        check input = case alexGetChar' input of
          Just ('-', input) -> case alexGetChar' input of
            Just ('-', input) -> case alexGetChar' input of
953 954 955 956 957
              Just (c, _) | c /= '-' -> Just input
              _ -> Nothing
            _ -> Nothing
          _ -> Nothing

958
        dropNonNewlineSpace input = case alexGetChar' input of
Ian Lynagh's avatar
Ian Lynagh committed
959
          Just (c, input')
960 961 962 963
            | isSpace c && c /= '\n' -> dropNonNewlineSpace input'
            | otherwise -> input
          Nothing -> input

Jedai's avatar
Jedai committed
964 965 966 967 968
lineCommentToken :: Action
lineCommentToken span buf len = do
  b <- extension rawTokenStreamEnabled
  if b then strtoken ITlineComment span buf len else lexToken

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

nested_doc_comment :: Action
nested_doc_comment span buf _len = withLexedDocType (go "")
  where
999
    go commentAcc input docType _ = case alexGetChar' input of
1000
      Nothing -> errBrace input span
1001
      Just ('-',input) -> case alexGetChar' input of
1002
        Nothing -> errBrace input span
twanvl's avatar
twanvl committed
1003
        Just ('\125',input) ->
1004
          docCommentEnd input commentAcc docType buf span
twanvl's avatar
twanvl committed
1005
        Just (_,_) -> go ('-':commentAcc) input docType False
1006
      Just ('\123', input) -> case alexGetChar' input of
1007 1008 1009 1010 1011
        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
1012
        Just (_,_) -> go ('\123':commentAcc) input docType False
1013 1014
      Just (c,input) -> go (c:commentAcc) input docType False

Ian Lynagh's avatar
Ian Lynagh committed
1015 1016
withLexedDocType :: (AlexInput -> (String -> Token) -> Bool -> P (RealLocated Token))
                 -> P (RealLocated Token)
1017
withLexedDocType lexDocComment = do
1018
  input@(AI _ buf) <- getInput
1019 1020 1021 1022
  case prevChar buf ' ' of
    '|' -> lexDocComment input ITdocCommentNext False
    '^' -> lexDocComment input ITdocCommentPrev False
    '$' -> lexDocComment input ITdocCommentNamed False
David Waern's avatar
David Waern committed
1023 1024
    '*' -> lexDocSection 1 input
    '#' -> lexDocComment input ITdocOptionsOld False
Ian Lynagh's avatar
Ian Lynagh committed
1025
    _ -> panic "withLexedDocType: Bad doc type"
Ian Lynagh's avatar
Ian Lynagh committed
1026
 where
1027
    lexDocSection n input = case alexGetChar' input of
1028
      Just ('*', input) -> lexDocSection (n+1) input
twanvl's avatar
twanvl committed
1029
      Just (_,   _)     -> lexDocComment input (ITdocSection n) True
1030 1031
      Nothing -> do setInput input; lexToken -- eof reached, lex it normally

1032 1033 1034
-- RULES pragmas turn on the forall and '.' keywords, and we turn them
-- off again at the end of the pragma.
rulePrag :: Action
Alan Zimmerman's avatar
Alan Zimmerman committed
1035
rulePrag span buf len = do
1036
  setExts (.|. xbit InRulePragBit)