Lexer.x 104 KB
Newer Older
1
-----------------------------------------------------------------------------
2
-- (c) The University of Glasgow, 2006
3
--
4
-- GHC's lexer for Haskell 2010 [1].
5
--
6 7
-- This is a combination of an Alex-generated lexer [2] from a regex
-- definition, with some hand-coded bits. [3]
8 9
--
-- Completely accurate information about token-spans within the source
Ian Lynagh's avatar
Ian Lynagh committed
10 11
-- file is maintained.  Every token has a start and end RealSrcLoc
-- attached to it.
12
--
13 14 15 16 17
-- References:
-- [1] https://www.haskell.org/onlinereport/haskell2010/haskellch2.html
-- [2] http://www.haskell.org/alex/
-- [3] https://ghc.haskell.org/trac/ghc/wiki/Commentary/Compiler/Parser
--
18 19 20 21 22 23 24 25 26 27
-----------------------------------------------------------------------------

--   ToDo / known bugs:
--    - parsing integers is a bit slow
--    - readRational is a bit slow
--
--   Known bugs, that were also in the previous version:
--    - M... should be 3 tokens, not 1.
--    - pragma-end should be only valid in a pragma

28
--   qualified operator NOTES.
Ian Lynagh's avatar
Ian Lynagh committed
29
--
30 31 32 33 34 35 36 37 38
--   - If M.(+) is a single lexeme, then..
--     - Probably (+) should be a single lexeme too, for consistency.
--       Otherwise ( + ) would be a prefix operator, but M.( + ) would not be.
--     - But we have to rule out reserved operators, otherwise (..) becomes
--       a different lexeme.
--     - Should we therefore also rule out reserved operators in the qualified
--       form?  This is quite difficult to achieve.  We don't do it for
--       qualified varids.

39 40 41 42

-- -----------------------------------------------------------------------------
-- Alex "Haskell code fragment top"

43
{
44
{-# LANGUAGE BangPatterns #-}
45 46

-- See Note [Warnings in code generated by Alex] in compiler/parser/Lexer.x
47 48
{-# OPTIONS_GHC -fno-warn-unused-matches #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
49
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
50
{-# OPTIONS_GHC -fno-warn-tabs #-}
51
{-# OPTIONS_GHC -fno-warn-missing-signatures #-}
52

53 54
{-# OPTIONS_GHC -funbox-strict-fields #-}

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

rodlogic's avatar
rodlogic committed
76
-- base
77
#if __GLASGOW_HASKELL__ < 709
rodlogic's avatar
rodlogic committed
78
import Control.Applicative
79
#endif
rodlogic's avatar
rodlogic committed
80 81
import Control.Monad
import Data.Bits
82
import Data.Char
rodlogic's avatar
rodlogic committed
83 84 85 86 87 88 89 90 91 92 93 94
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
95
import Bag
96 97 98 99
import Outputable
import StringBuffer
import FastString
import UniqFM
rodlogic's avatar
rodlogic committed
100 101 102 103
import Util             ( readRational )

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

-- compiler/basicTypes
import SrcLoc
108
import Module
Alan Zimmerman's avatar
Alan Zimmerman committed
109 110
import BasicTypes     ( InlineSpec(..), RuleMatchInfo(..), FractionalLit(..),
                        SourceText )
111

rodlogic's avatar
rodlogic committed
112 113
-- compiler/parser
import Ctype
Alan Zimmerman's avatar
Alan Zimmerman committed
114 115

import ApiAnnotation
116 117
}

118 119 120
-- -----------------------------------------------------------------------------
-- Alex "Character set macros"

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

$ascdigit  = 0-9
130
$unidigit  = \x03 -- Trick Alex into handling Unicode. See alexGetByte.
131
$decdigit  = $ascdigit -- for now, should really be $digit (ToDo)
132 133 134
$digit     = [$ascdigit $unidigit]

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

139
$unilarge  = \x01 -- Trick Alex into handling Unicode. See alexGetByte.
140
$asclarge  = [A-Z]
141 142
$large     = [$asclarge $unilarge]

143
$unismall  = \x02 -- Trick Alex into handling Unicode. See alexGetByte.
144
$ascsmall  = [a-z]
145 146
$small     = [$ascsmall $unismall \_]

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

150
$binit     = 0-1
Ian Lynagh's avatar
Ian Lynagh committed
151
$octit     = 0-7
152
$hexit     = [$decdigit A-F a-f]
153 154 155 156

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

158 159
$pragmachar = [$small $large $digit]

160 161
$docsym    = [\| \^ \* \$]

162

163 164 165 166 167 168 169 170
-- -----------------------------------------------------------------------------
-- 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
171

172
@decimal     = $decdigit+
173
@binary      = $binit+
174 175 176 177 178
@octal       = $octit+
@hexadecimal = $hexit+
@exponent    = [eE] [\-\+]? @decimal

@qual = (@conid \.)+
179 180 181 182
@qvarid = @qual @varid
@qconid = @qual @conid
@qvarsym = @qual @varsym
@qconsym = @qual @consym
183 184 185

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

186 187 188 189 190
-- normal signed numerical literals can only be explicitly negative,
-- not explicitly positive (contrast @exponent)
@negative = \-
@signed = @negative ?

191 192 193 194

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

195 196
haskell :-

197 198 199 200 201

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

-- everywhere: skip whitespace
Ian Lynagh's avatar
Ian Lynagh committed
202
$white_no_nl+ ;
203
$tab          { warnTab }
204 205 206 207 208

-- 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
209 210 211 212
-- are). We also rule out nested Haddock comments, if the -haddock flag is
-- set.

"{-" / { isNormalComment } { nested_comment lexToken }
213 214 215 216

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

-- Since Haddock comments aren't valid in every state, we need to rule them
Ian Lynagh's avatar
Ian Lynagh committed
219
-- out here.
220 221 222 223 224 225 226

-- 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
227
"-- " ~[$docsym \#] .* { lineCommentToken }
228
"--" [^$symbol \ ] .* { lineCommentToken }
229 230 231

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

Jedai's avatar
Jedai committed
232
"-- " [$docsym \#] .* / { ifExtension (not . haddockEnabled) } { lineCommentToken }
233 234 235 236 237 238 239

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

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

-- 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
245
"--"\-* / { atEOL } { lineCommentToken }
246 247 248 249

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

Jedai's avatar
Jedai committed
250
"-- " / { atEOL } { lineCommentToken }
251 252 253 254 255 256 257 258 259 260 261

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

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

279 280 281 282 283 284
-- after an 'if', a vertical bar starts a layout context for MultiWayIf
<layout_if> {
  \| / { notFollowedBySymbol }          { new_layout_context True ITvbar }
  ()                                    { pop }
}

285
-- do is treated in a subtly different way, see new_layout_context
286 287
<layout>    ()                          { new_layout_context True  ITvocurly }
<layout_do> ()                          { new_layout_context False ITvocurly }
288 289 290 291

-- 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
292
<layout_left>  ()                       { do_layout_left }
293

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

296 297
"{-#" $whitechar* $pragmachar+ / { known_pragma linePrags }
                                { dispatch_pragmas linePrags }
298 299 300

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

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

313
<0,option_prags> {
Ian Lynagh's avatar
Ian Lynagh committed
314
  "{-#" $whitechar* $pragmachar+
315 316 317 318 319
        $whitechar+ $pragmachar+ / { known_pragma twoWordPrags }
                                 { dispatch_pragmas twoWordPrags }

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

321
  -- We ignore all these pragmas, but don't generate a warning for them
322 323
  "{-#" $whitechar* $pragmachar+ / { known_pragma ignoredPrags }
                                 { dispatch_pragmas ignoredPrags }
324 325

  -- ToDo: should only be valid inside a pragma:
Ian Lynagh's avatar
Ian Lynagh committed
326
  "#-}"                          { endPrag }
327 328
}

329
<option_prags> {
330 331 332
  "{-#"  $whitechar* $pragmachar+ / { known_pragma fileHeaderPrags }
                                   { dispatch_pragmas fileHeaderPrags }

Ian Lynagh's avatar
Ian Lynagh committed
333
  "-- #"                           { multiline_doc_comment }
David Waern's avatar
David Waern committed
334 335
}

336 337
<0> {
  -- In the "0" mode we ignore these pragmas
338
  "{-#"  $whitechar* $pragmachar+ / { known_pragma fileHeaderPrags }
339 340 341
                     { nested_comment lexToken }
}

David Waern's avatar
David Waern committed
342
<0> {
Jedai's avatar
Jedai committed
343
  "-- #" .* { lineCommentToken }
344
}
345

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

351 352
-- '0' state: ordinary lexemes

353 354
-- Haddock comments

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

360 361
-- "special" symbols

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

367
<0> {
368 369 370
  "[|"        / { ifExtension thEnabled } { token ITopenExpQuote }
  "[||"       / { ifExtension thEnabled } { token ITopenTExpQuote }
  "[e|"       / { ifExtension thEnabled } { token ITopenExpQuote }
371
  "[e||"      / { ifExtension thEnabled } { token ITopenTExpQuote }
372 373 374 375 376 377 378 379 380
  "[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 }
381

382 383 384 385
-- For backward compatibility, accept the old dollar syntax
  "[$" @varid "|"  / { ifExtension qqEnabled }
                     { lex_quasiquote_tok }

386
  "[" @varid "|"  / { ifExtension qqEnabled }
387
                     { lex_quasiquote_tok }
388 389

  -- qualified quasi-quote (#5555)
390 391
  "[" @qvarid "|"  / { ifExtension qqEnabled }
                     { lex_qquasiquote_tok }
392 393
}

394
<0> {
ross's avatar
ross committed
395
  "(|" / { ifExtension arrowsEnabled `alexAndPred` notFollowedBySymbol }
Ian Lynagh's avatar
Ian Lynagh committed
396
                                        { special IToparenbar }
397 398 399
  "|)" / { ifExtension arrowsEnabled }  { special ITcparenbar }
}

400
<0> {
Ian Lynagh's avatar
Ian Lynagh committed
401
  \? @varid / { ifExtension ipEnabled } { skip_one_varid ITdupipvarid }
402 403
}

404
<0> {
405
  "(#" / { ifExtension unboxedTuplesEnabled }
Ian Lynagh's avatar
Ian Lynagh committed
406 407 408 409 410
         { token IToubxparen }
  "#)" / { ifExtension unboxedTuplesEnabled }
         { token ITcubxparen }
}

411
<0,option_prags> {
Ian Lynagh's avatar
Ian Lynagh committed
412 413 414 415 416 417 418 419 420 421
  \(                                    { special IToparen }
  \)                                    { special ITcparen }
  \[                                    { special ITobrack }
  \]                                    { special ITcbrack }
  \,                                    { special ITcomma }
  \;                                    { special ITsemi }
  \`                                    { special ITbackquote }

  \{                                    { open_brace }
  \}                                    { close_brace }
422 423
}

424
<0,option_prags> {
425 426
  @qvarid                       { idtoken qvarid }
  @qconid                       { idtoken qconid }
Ian Lynagh's avatar
Ian Lynagh committed
427
  @varid                        { varid }
428
  @conid                        { idtoken conid }
429 430
}

431
<0> {
432 433
  @qvarid "#"+      / { ifExtension magicHashEnabled } { idtoken qvarid }
  @qconid "#"+      / { ifExtension magicHashEnabled } { idtoken qconid }
434
  @varid "#"+       / { ifExtension magicHashEnabled } { varid }
435
  @conid "#"+       / { ifExtension magicHashEnabled } { idtoken conid }
436 437
}

438 439
-- ToDo: - move `var` and (sym) into lexical syntax?
--       - remove backquote from $special?
440
<0> {
441 442
  @qvarsym                                         { idtoken qvarsym }
  @qconsym                                         { idtoken qconsym }
443 444
  @varsym                                          { varsym }
  @consym                                          { consym }
445 446
}

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

  -- Normal rational literals (:: Fractional a => a, from Rational)
462 463
  @floating_point                                                        { strtoken tok_float }
  @negative @floating_point    / { ifExtension negativeLiteralsEnabled } { strtoken tok_float }
464 465
}

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

Ian Lynagh's avatar
Ian Lynagh committed
481
  @decimal                     \# \# / { ifExtension magicHashEnabled } { tok_primword 0 2 decimal }
482 483
  0[bB] @binary                \# \# / { ifExtension magicHashEnabled `alexAndPred`
                                         ifExtension binaryLiteralsEnabled } { tok_primword 2 4 binary }
Ian Lynagh's avatar
Ian Lynagh committed
484 485 486
  0[oO] @octal                 \# \# / { ifExtension magicHashEnabled } { tok_primword 2 4 octal }
  0[xX] @hexadecimal           \# \# / { ifExtension magicHashEnabled } { tok_primword 2 4 hexadecimal }

487 488
  -- Unboxed floats and doubles (:: Float#, :: Double#)
  -- prim_{float,double} work with signed literals
489 490
  @signed @floating_point \# / { ifExtension magicHashEnabled } { init_strtoken 1 tok_primfloat }
  @signed @floating_point \# \# / { ifExtension magicHashEnabled } { init_strtoken 2 tok_primdouble }
491 492 493 494 495 496
}

-- 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.
497
<0> {
Ian Lynagh's avatar
Ian Lynagh committed
498 499
  \'                            { lex_char_tok }
  \"                            { lex_string_tok }
500 501
}

502 503 504 505

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

506
{
507

508 509 510
-- -----------------------------------------------------------------------------
-- The token type

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

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

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

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

Ian Lynagh's avatar
Ian Lynagh committed
606
  | ITbiglam                    -- GHC-extension symbols
607

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

Ian Lynagh's avatar
Ian Lynagh committed
626
  | ITvarid   FastString        -- identifiers
627 628 629 630 631 632 633 634
  | ITconid   FastString
  | ITvarsym  FastString
  | ITconsym  FastString
  | ITqvarid  (FastString,FastString)
  | ITqconid  (FastString,FastString)
  | ITqvarsym (FastString,FastString)
  | ITqconsym (FastString,FastString)

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

637 638 639
  | 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
640
  | ITrational FractionalLit
641

642 643 644 645
  | 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
646 647
  | ITprimfloat  FractionalLit
  | ITprimdouble FractionalLit
648

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

  -- Arrow notation extension
  | ITproc
  | ITrec
Ian Lynagh's avatar
Ian Lynagh committed
674 675 676 677 678 679
  | IToparenbar                 --  (|
  | ITcparenbar                 --  |)
  | ITlarrowtail                --  -<
  | ITrarrowtail                --  >-
  | ITLarrowtail                --  -<<
  | ITRarrowtail                --  >>-
680

Ian Lynagh's avatar
Ian Lynagh committed
681 682
  | ITunknown String            -- Used when the lexer can't make sense of it
  | ITeof                       -- end of file token
683 684 685 686 687 688 689

  -- 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
690
  | ITdocOptionsOld   String     -- doc options declared "-- # ..."-style
Jedai's avatar
Jedai committed
691 692
  | ITlineComment     String     -- comment starting by "--"
  | ITblockComment    String     -- comment in {- -}
693

694
  deriving Show
695

Alan Zimmerman's avatar
Alan Zimmerman committed
696 697 698
instance Outputable Token where
  ppr x = text (show x)

Alan Zimmerman's avatar
Alan Zimmerman committed
699

700 701 702 703 704 705 706
-- 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)
--
707
reservedWordsFM :: UniqFM (Token, ExtsBitmap)
708
reservedWordsFM = listToUFM $
Ian Lynagh's avatar
Ian Lynagh committed
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735
    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 ),

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

767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782
{-----------------------------------
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.
-------------------------------------}
783

784
reservedSymsFM :: UniqFM (Token, ExtsBitmap -> Bool)
785
reservedSymsFM = listToUFM $
Ian Lynagh's avatar
Ian Lynagh committed
786 787 788 789 790 791 792 793 794 795 796 797
    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)
798
       ,("~#",  ITtildehsh, magicHashEnabled)
Ian Lynagh's avatar
Ian Lynagh committed
799 800 801 802 803
       ,("=>",  ITdarrow,   always)
       ,("-",   ITminus,    always)
       ,("!",   ITbang,     always)

        -- For data T (a::*) = MkT
804
       ,("*", ITstar, always) -- \i -> kindSigsEnabled i || tyFamEnabled i)
Ian Lynagh's avatar
Ian Lynagh committed
805
        -- For 'forall a . t'
806
       ,(".", ITdot,  always) -- \i -> explicitForallEnabled i || inRulePrag i)
Ian Lynagh's avatar
Ian Lynagh committed
807 808 809 810 811

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

Ian Lynagh's avatar
Ian Lynagh committed
813 814
       ,("∷",   ITdcolon, unicodeSyntaxEnabled)
       ,("⇒",   ITdarrow, unicodeSyntaxEnabled)
815
       ,("∀",   ITforall, unicodeSyntaxEnabled)
Ian Lynagh's avatar
Ian Lynagh committed
816 817
       ,("→",   ITrarrow, unicodeSyntaxEnabled)
       ,("←",   ITlarrow, unicodeSyntaxEnabled)
818 819 820 821 822 823 824 825

       ,("⤙",   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
826 827 828
        -- 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).
829 830 831 832 833
       ]

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

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

836
special :: Token -> Action
twanvl's avatar
twanvl committed
837
special tok span _buf _len = return (L span tok)
838

839
token, layout_token :: Token -> Action
twanvl's avatar
twanvl committed
840 841
token t span _buf _len = return (L span t)
layout_token t span _buf _len = pushLexState layout >> return (L span t)
842

843 844
idtoken :: (StringBuffer -> Int -> Token) -> Action
idtoken f span buf len = return (L span $! (f buf len))
845

846
skip_one_varid :: (FastString -> Token) -> Action
Ian Lynagh's avatar
Ian Lynagh committed
847
skip_one_varid f span buf len
848
  = return (L span $! f (lexemeToFastString (stepOn buf) (len-1)))
849

850 851 852 853
skip_two_varid :: (FastString -> Token) -> Action
skip_two_varid f span buf len
  = return (L span $! f (lexemeToFastString (stepOn (stepOn buf)) (len-2)))

854
strtoken :: (String -> Token) -> Action
Ian Lynagh's avatar
Ian Lynagh committed
855
strtoken f span buf len =
856
  return (L span $! (f $! lexemeToString buf len))
857

858
init_strtoken :: Int -> (String -> Token) -> Action
859
-- like strtoken, but drops the last N character(s)
Ian Lynagh's avatar
Ian Lynagh committed
860
init_strtoken drop f span buf len =
861
  return (L span $! (f $! lexemeToString buf (len-drop)))
862 863

begin :: Int -> Action
864
begin code _span _str _len = do pushLexState code; lexToken
865 866

pop :: Action
Ian Lynagh's avatar
Ian Lynagh committed
867 868
pop _span _buf _len = do _ <- popLexState
                         lexToken
869

870 871 872 873 874 875 876 877 878 879 880
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
881
              else failSpanMsgP (RealSrcSpan span) (text "Missing block")
882

883
pop_and :: Action -> Action
Ian Lynagh's avatar
Ian Lynagh committed
884 885
pop_and act span buf len = do _ <- popLexState
                              act span buf len
886

887
{-# INLINE nextCharIs #-}
Ian Lynagh's avatar
Ian Lynagh committed
888
nextCharIs :: StringBuffer -> (Char -> Bool) -> Bool
889 890
nextCharIs buf p = not (atEnd buf) && p (currentChar buf)

891 892 893 894
{-# INLINE nextCharIsNot #-}
nextCharIsNot :: StringBuffer -> (Char -> Bool) -> Bool
nextCharIsNot buf p = not (nextCharIs buf p)

895
notFollowedBy :: Char -> AlexAccPred ExtsBitmap
Ian Lynagh's avatar
Ian Lynagh committed
896
notFollowedBy char _ _ _ (AI _ buf)
897
  = nextCharIsNot buf (== char)
898

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

903 904 905 906 907
-- 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.
908
isNormalComment :: AlexAccPred ExtsBitmap
909
isNormalComment bits _ _ (AI _ buf)
910
  | haddockEnabled bits = notFollowedByDocOrPragma
911
  | otherwise           = nextCharIsNot buf (== '#')
912 913
  where
    notFollowedByDocOrPragma
914
       = afterOptionalSpace buf (\b -> nextCharIsNot b (`elem` "|^*$#"))
915

916 917 918 919 920
afterOptionalSpace :: StringBuffer -> (StringBuffer -> Bool) -> Bool
afterOptionalSpace buf p
    = if nextCharIs buf (== ' ')
      then p (snd (nextChar buf))
      else p buf
921

922
atEOL :: AlexAccPred ExtsBitmap
923
atEOL _ _ _ (AI _ buf) = atEnd buf || currentChar buf == '\n'
924

925
ifExtension :: (ExtsBitmap -> Bool) -> AlexAccPred ExtsBitmap
926 927
ifExtension pred bits _ _ _ = pred bits

928 929 930
multiline_doc_comment :: Action
multiline_doc_comment span buf _len = withLexedDocType (worker "")
  where
931
    worker commentAcc input docType oneLine = case alexGetChar' input of
Ian Lynagh's avatar
Ian Lynagh committed
932
      Just ('\n', input')
933 934 935 936 937 938
        | 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
939

940 941
    checkIfCommentLine input = check (dropNonNewlineSpace input)
      where
942 943 944
        check input = case alexGetChar' input of
          Just ('-', input) -> case alexGetChar' input of
            Just ('-', input) -> case alexGetChar' input of
945 946 947 948 949
              Just (c, _) | c /= '-' -> Just input
              _ -> Nothing
            _ -> Nothing
          _ -> Nothing

950
        dropNonNewlineSpace input = case alexGetChar' input of
Ian Lynagh's avatar
Ian Lynagh committed
951
          Just (c, input')
952 953 954 955
            | isSpace c && c /= '\n' -> dropNonNewlineSpace input'
            | otherwise -> input
          Nothing -> input

Jedai's avatar
Jedai committed
956 957 958 959 960
lineCommentToken :: Action
lineCommentToken span buf len = do
  b <- extension rawTokenStreamEnabled
  if b then strtoken ITlineComment span buf len else lexToken

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

nested_doc_comment :: Action
nested_doc_comment span buf _len = withLexedDocType (go "")
  where
991
    go commentAcc input docType _ = case alexGetChar' input of
992
      Nothing -> errBrace input span
993
      Just ('-',input) -> case alexGetChar' input of
994
        Nothing -> errBrace input span
twanvl's avatar
twanvl committed
995
        Just ('\125',input) ->
996
          docCommentEnd input commentAcc docType buf span
twanvl's avatar
twanvl committed
997
        Just (_,_) -> go ('-':commentAcc) input docType False
998
      Just ('\123', input) -> case alexGetChar' input of
999 1000 1001 1002 1003
        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
1004
        Just (_,_) -> go ('\123':commentAcc) input docType False
1005 1006
      Just (c,input) -> go (c:commentAcc) input docType False

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

1024 1025 1026
-- RULES pragmas turn on the forall and '.' keywords, and we turn them