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 #-}
46 47
{-# OPTIONS_GHC -fno-warn-unused-matches #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
48
{-# OPTIONS_GHC -fno-warn-tabs #-}
49
{-# OPTIONS_GHC -fno-warn-missing-signatures #-}
50 51 52 53 54 55 56
{-# OPTIONS_GHC -fno-warn-overlapping-patterns #-}
{-# OPTIONS_GHC -fno-warn-incomplete-patterns #-}
-- The above warning suppression flags are a temporary kludge.
-- While working on this module you are encouraged to remove it and fix
-- any warnings in the module. See
--     http://ghc.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Warnings
-- for details
57

58 59
{-# OPTIONS_GHC -funbox-strict-fields #-}

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

rodlogic's avatar
rodlogic committed
81
-- base
82
#if __GLASGOW_HASKELL__ < 709
rodlogic's avatar
rodlogic committed
83
import Control.Applicative
84
#endif
rodlogic's avatar
rodlogic committed
85 86
import Control.Monad
import Data.Bits
87
import Data.Char hiding (ord)
rodlogic's avatar
rodlogic committed
88 89 90 91 92 93 94 95 96 97 98 99
import Data.List
import Data.Maybe
import Data.Word

-- bytestring
import Data.ByteString (ByteString)

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

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

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

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

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

import ApiAnnotation
121 122
}

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

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

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

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

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

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

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

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

$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 \']
162

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

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

167

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

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

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

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

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

196 197 198 199

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

200 201
haskell :-

202 203 204 205 206

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

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

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

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

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

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

-- 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
232
"-- " ~[$docsym \#] .* { lineCommentToken }
233
"--" [^$symbol \ ] .* { lineCommentToken }
234 235 236

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

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

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

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

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

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

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

-- '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
267 268 269 270 271
  \n                                    ;
  ^\# (line)?                           { begin line_prag1 }
  ^\# pragma .* \n                      ; -- GCC 3.3 CPP generated, apparently
  ^\# \! .* \n                          ; -- #!, for scripts
  ()                                    { do_bol }
272 273 274 275 276
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

356 357
-- '0' state: ordinary lexemes

358 359
-- Haddock comments

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

365 366
-- "special" symbols

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

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

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

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

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

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

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

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

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

  \{                                    { open_brace }
  \}                                    { close_brace }
427 428
}

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

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

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

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

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

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

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

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

-- 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.
502
<0> {
Ian Lynagh's avatar
Ian Lynagh committed
503 504
  \'                            { lex_char_tok }
  \"                            { lex_string_tok }
505 506
}

507 508 509 510

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

511
{
512

513 514 515
-- -----------------------------------------------------------------------------
-- The token type

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

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

Alan Zimmerman's avatar
Alan Zimmerman committed
564 565 566 567 568 569 570 571
  -- 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
572
  | ITline_prag
Alan Zimmerman's avatar
Alan Zimmerman committed
573 574 575 576 577 578
  | ITscc_prag          SourceText
  | ITgenerated_prag    SourceText
  | ITcore_prag         SourceText         -- hdaume: core annotations
  | ITunpack_prag       SourceText
  | ITnounpack_prag     SourceText
  | ITann_prag          SourceText
579
  | ITclose_prag
580 581 582
  | IToptions_prag String
  | ITinclude_prag String
  | ITlanguage_prag
Alan Zimmerman's avatar
Alan Zimmerman committed
583 584 585 586 587 588 589 590 591
  | 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
592

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

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

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

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

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

644 645 646
  | 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
647
  | ITrational FractionalLit
648

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

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

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

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

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

701
  deriving Show
702

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

Alan Zimmerman's avatar
Alan Zimmerman committed
706

707 708 709 710 711 712 713
-- 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)
--
714
reservedWordsFM :: UniqFM (Token, ExtsBitmap)
715
reservedWordsFM = listToUFM $
Ian Lynagh's avatar
Ian Lynagh committed
716 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
    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 ),

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

774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789
{-----------------------------------
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.
-------------------------------------}
790

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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