Lexer.x 92.4 KB
Newer Older
1
-----------------------------------------------------------------------------
2
-- (c) The University of Glasgow, 2006
3 4 5 6 7 8 9
--
-- GHC's lexer.
--
-- This is a combination of an Alex-generated lexer from a regex
-- definition, with some hand-coded bits.
--
-- 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 18 19 20 21 22
--
-----------------------------------------------------------------------------

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

23
--   qualified operator NOTES.
Ian Lynagh's avatar
Ian Lynagh committed
24
--
25 26 27 28 29 30 31 32 33
--   - 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.

34
{
35
-- XXX The above flags turn off warnings in the generated code:
36
{-# LANGUAGE BangPatterns #-}
37 38 39 40 41 42 43 44
{-# OPTIONS_GHC -fno-warn-unused-matches #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-missing-signatures #-}
-- But alex still generates some code that causes the "lazy unlifted bindings"
-- warning, and old compilers don't know about it so we can't easily turn
-- it off, so for now we use the sledge hammer:
{-# OPTIONS_GHC -w #-}
45

46 47
{-# OPTIONS_GHC -funbox-strict-fields #-}

48
module Lexer (
49
   Token(..), lexer, pragState, mkPState, PState(..),
Ian Lynagh's avatar
Ian Lynagh committed
50
   P(..), ParseResult(..), getSrcLoc,
51
   getPState, getDynFlags, withThisPackage,
52
   failLocMsgP, failSpanMsgP, srcParseFail,
Ian Lynagh's avatar
Ian Lynagh committed
53
   getMessages,
54
   popContext, pushCurrentContext, setLastToken, setSrcLoc,
vivian's avatar
vivian committed
55
   activeContext, nextIsEOF,
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
56
   getLexState, popLexState, pushLexState,
57
   extension, bangPatEnabled, datatypeContextsEnabled,
58
   traditionalRecordSyntaxEnabled,
59
   typeLiteralsEnabled,
60 61
   explicitForallEnabled,
   inRulePrag,
ian@well-typed.com's avatar
ian@well-typed.com committed
62
   explicitNamespacesEnabled, sccProfilingOn, hpcEnabled,
Jedai's avatar
Jedai committed
63 64
   addWarning,
   lexTokenStream
65 66
  ) where

67 68
import Bag
import ErrUtils
69 70 71 72 73
import Outputable
import StringBuffer
import FastString
import SrcLoc
import UniqFM
74
import DynFlags
75
import Module
76
import Ctype
Ian Lynagh's avatar
Ian Lynagh committed
77 78
import BasicTypes       ( InlineSpec(..), RuleMatchInfo(..), FractionalLit(..) )
import Util             ( readRational )
79

80
import Control.Monad
Simon Marlow's avatar
Simon Marlow committed
81
import Data.Bits
82
import Data.ByteString (ByteString)
83
import Data.Char
84
import Data.List
Ian Lynagh's avatar
Ian Lynagh committed
85
import Data.Maybe
86 87
import Data.Map (Map)
import qualified Data.Map as Map
Simon Marlow's avatar
Simon Marlow committed
88
import Data.Ratio
89
import Data.Word
90 91
}

92
$unispace    = \x05 -- Trick Alex into handling Unicode. See alexGetChar.
93
$whitechar   = [\ \n\r\f\v $unispace]
94
$white_no_nl = $whitechar # \n
95
$tab         = \t
96 97

$ascdigit  = 0-9
98
$unidigit  = \x03 -- Trick Alex into handling Unicode. See alexGetChar.
99
$decdigit  = $ascdigit -- for now, should really be $digit (ToDo)
100 101 102
$digit     = [$ascdigit $unidigit]

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

107
$unilarge  = \x01 -- Trick Alex into handling Unicode. See alexGetChar.
108
$asclarge  = [A-Z]
109 110
$large     = [$asclarge $unilarge]

111
$unismall  = \x02 -- Trick Alex into handling Unicode. See alexGetChar.
112
$ascsmall  = [a-z]
113 114
$small     = [$ascsmall $unismall \_]

115
$unigraphic = \x06 -- Trick Alex into handling Unicode. See alexGetChar.
116
$graphic   = [$small $large $symbol $digit $special $unigraphic \:\"\']
117

Ian Lynagh's avatar
Ian Lynagh committed
118
$octit     = 0-7
119
$hexit     = [$decdigit A-F a-f]
120 121 122 123
$symchar   = [$symbol \:]
$nl        = [\n\r]
$idchar    = [$small $large $digit \']

124 125
$pragmachar = [$small $large $digit]

126 127
$docsym    = [\| \^ \* \$]

128 129 130 131 132 133
@varid     = $small $idchar*
@conid     = $large $idchar*

@varsym    = $symbol $symchar*
@consym    = \: $symchar*

134
@decimal     = $decdigit+
135 136 137 138 139 140 141 142 143
@octal       = $octit+
@hexadecimal = $hexit+
@exponent    = [eE] [\-\+]? @decimal

-- we support the hierarchical module name extension:
@qual = (@conid \.)+

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

144 145 146 147 148
-- normal signed numerical literals can only be explicitly negative,
-- not explicitly positive (contrast @exponent)
@negative = \-
@signed = @negative ?

149 150 151
haskell :-

-- everywhere: skip whitespace and comments
Ian Lynagh's avatar
Ian Lynagh committed
152
$white_no_nl+ ;
153
$tab+         { warn Opt_WarnTabs (text "Tab character") }
154 155 156 157 158

-- 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
159 160 161 162
-- are). We also rule out nested Haddock comments, if the -haddock flag is
-- set.

"{-" / { isNormalComment } { nested_comment lexToken }
163 164 165 166

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

-- Since Haddock comments aren't valid in every state, we need to rule them
Ian Lynagh's avatar
Ian Lynagh committed
169
-- out here.
170 171 172 173 174 175 176

-- 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
177 178
"-- " ~[$docsym \#] .* { lineCommentToken }
"--" [^$symbol : \ ] .* { lineCommentToken }
179 180 181

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

Jedai's avatar
Jedai committed
182
"-- " [$docsym \#] .* / { ifExtension (not . haddockEnabled) } { lineCommentToken }
183 184 185 186 187 188 189

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

Jedai's avatar
Jedai committed
190
"---"\-* [^$symbol :] .* { lineCommentToken }
191 192 193 194

-- 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
195
"--"\-* / { atEOL } { lineCommentToken }
196 197 198 199

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

Jedai's avatar
Jedai committed
200
"-- " / { atEOL } { lineCommentToken }
201 202 203 204 205 206 207 208 209 210 211

-- '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
212 213 214 215 216
  \n                                    ;
  ^\# (line)?                           { begin line_prag1 }
  ^\# pragma .* \n                      ; -- GCC 3.3 CPP generated, apparently
  ^\# \! .* \n                          ; -- #!, for scripts
  ()                                    { do_bol }
217 218 219 220 221
}

-- 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.
222
<layout, layout_do, layout_if> {
Ian Lynagh's avatar
Ian Lynagh committed
223 224 225 226
  \{ / { notFollowedBy '-' }            { hopefully_open_brace }
        -- we might encounter {-# here, but {- has been handled already
  \n                                    ;
  ^\# (line)?                           { begin line_prag1 }
227 228
}

229 230 231 232 233 234
-- after an 'if', a vertical bar starts a layout context for MultiWayIf
<layout_if> {
  \| / { notFollowedBySymbol }          { new_layout_context True ITvbar }
  ()                                    { pop }
}

235
-- do is treated in a subtly different way, see new_layout_context
236 237
<layout>    ()                          { new_layout_context True  ITvocurly }
<layout_do> ()                          { new_layout_context False ITvocurly }
238 239 240 241

-- 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
242
<layout_left>  ()                       { do_layout_left }
243

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

246 247
"{-#" $whitechar* $pragmachar+ / { known_pragma linePrags }
                                { dispatch_pragmas linePrags }
248 249 250

-- single-line line pragmas, of the form
--    # <line> "<file>" <extra-stuff> \n
Ian Lynagh's avatar
Ian Lynagh committed
251 252 253
<line_prag1> $decdigit+                 { setLine line_prag1a }
<line_prag1a> \" [$graphic \ ]* \"      { setFile line_prag1b }
<line_prag1b> .*                        { pop }
254 255 256

-- Haskell-style line pragmas, of the form
--    {-# LINE <line> "<file>" #-}
Ian Lynagh's avatar
Ian Lynagh committed
257 258 259
<line_prag2> $decdigit+                 { setLine line_prag2a }
<line_prag2a> \" [$graphic \ ]* \"      { setFile line_prag2b }
<line_prag2b> "#-}"|"-}"                { pop }
260 261
   -- NOTE: accept -} at the end of a LINE pragma, for compatibility
   -- with older versions of GHC which generated these.
262

263
<0,option_prags> {
Ian Lynagh's avatar
Ian Lynagh committed
264
  "{-#" $whitechar* $pragmachar+
265 266 267 268 269
        $whitechar+ $pragmachar+ / { known_pragma twoWordPrags }
                                 { dispatch_pragmas twoWordPrags }

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

271
  -- We ignore all these pragmas, but don't generate a warning for them
272 273
  "{-#" $whitechar* $pragmachar+ / { known_pragma ignoredPrags }
                                 { dispatch_pragmas ignoredPrags }
274 275

  -- ToDo: should only be valid inside a pragma:
Ian Lynagh's avatar
Ian Lynagh committed
276
  "#-}"                          { endPrag }
277 278
}

279
<option_prags> {
280 281 282
  "{-#"  $whitechar* $pragmachar+ / { known_pragma fileHeaderPrags }
                                   { dispatch_pragmas fileHeaderPrags }

Ian Lynagh's avatar
Ian Lynagh committed
283
  "-- #"                           { multiline_doc_comment }
David Waern's avatar
David Waern committed
284 285
}

286 287
<0> {
  -- In the "0" mode we ignore these pragmas
288
  "{-#"  $whitechar* $pragmachar+ / { known_pragma fileHeaderPrags }
289 290 291
                     { nested_comment lexToken }
}

David Waern's avatar
David Waern committed
292
<0> {
Jedai's avatar
Jedai committed
293
  "-- #" .* { lineCommentToken }
294
}
295

296
<0,option_prags> {
297 298
  "{-#"  { warnThen Opt_WarnUnrecognisedPragmas (text "Unrecognised pragma")
                    (nested_comment lexToken) }
299 300
}

301 302
-- '0' state: ordinary lexemes

303 304
-- Haddock comments

305
<0,option_prags> {
David Waern's avatar
David Waern committed
306 307
  "-- " $docsym      / { ifExtension haddockEnabled } { multiline_doc_comment }
  "{-" \ ? $docsym   / { ifExtension haddockEnabled } { nested_doc_comment }
308 309
}

310 311
-- "special" symbols

312
<0> {
Ian Lynagh's avatar
Ian Lynagh committed
313 314
  "[:" / { ifExtension parrEnabled }    { token ITopabrack }
  ":]" / { ifExtension parrEnabled }    { token ITcpabrack }
315
}
Ian Lynagh's avatar
Ian Lynagh committed
316

317
<0> {
Ian Lynagh's avatar
Ian Lynagh committed
318 319 320 321 322 323 324 325
  "[|"      / { ifExtension thEnabled } { token ITopenExpQuote }
  "[e|"     / { ifExtension thEnabled } { token ITopenExpQuote }
  "[p|"     / { ifExtension thEnabled } { token ITopenPatQuote }
  "[d|"     / { ifExtension thEnabled } { layout_token ITopenDecQuote }
  "[t|"     / { ifExtension thEnabled } { token ITopenTypQuote }
  "|]"      / { ifExtension thEnabled } { token ITcloseQuote }
  \$ @varid / { ifExtension thEnabled } { skip_one_varid ITidEscape }
  "$("      / { ifExtension thEnabled } { token ITparenEscape }
326

327 328 329 330
-- For backward compatibility, accept the old dollar syntax
  "[$" @varid "|"  / { ifExtension qqEnabled }
                     { lex_quasiquote_tok }

331
  "[" @varid "|"  / { ifExtension qqEnabled }
332
                     { lex_quasiquote_tok }
333 334 335 336

  -- qualified quasi-quote (#5555)
  "[" @qual @varid "|"  / { ifExtension qqEnabled }
                          { lex_qquasiquote_tok }
337 338
}

339
<0> {
ross's avatar
ross committed
340
  "(|" / { ifExtension arrowsEnabled `alexAndPred` notFollowedBySymbol }
Ian Lynagh's avatar
Ian Lynagh committed
341
                                        { special IToparenbar }
342 343 344
  "|)" / { ifExtension arrowsEnabled }  { special ITcparenbar }
}

345
<0> {
Ian Lynagh's avatar
Ian Lynagh committed
346
  \? @varid / { ifExtension ipEnabled } { skip_one_varid ITdupipvarid }
347 348
}

349
<0> {
350
  "(#" / { ifExtension unboxedTuplesEnabled }
Ian Lynagh's avatar
Ian Lynagh committed
351 352 353 354 355
         { token IToubxparen }
  "#)" / { ifExtension unboxedTuplesEnabled }
         { token ITcubxparen }
}

356
<0,option_prags> {
Ian Lynagh's avatar
Ian Lynagh committed
357 358 359 360 361 362 363 364 365 366
  \(                                    { special IToparen }
  \)                                    { special ITcparen }
  \[                                    { special ITobrack }
  \]                                    { special ITcbrack }
  \,                                    { special ITcomma }
  \;                                    { special ITsemi }
  \`                                    { special ITbackquote }

  \{                                    { open_brace }
  \}                                    { close_brace }
367 368
}

369
<0,option_prags> {
Ian Lynagh's avatar
Ian Lynagh committed
370 371 372
  @qual @varid                  { idtoken qvarid }
  @qual @conid                  { idtoken qconid }
  @varid                        { varid }
373
  @conid                        { idtoken conid }
374 375
}

376
<0> {
377 378 379
  @qual @varid "#"+ / { ifExtension magicHashEnabled } { idtoken qvarid }
  @qual @conid "#"+ / { ifExtension magicHashEnabled } { idtoken qconid }
  @varid "#"+       / { ifExtension magicHashEnabled } { varid }
380
  @conid "#"+       / { ifExtension magicHashEnabled } { idtoken conid }
381 382
}

383 384
-- ToDo: - move `var` and (sym) into lexical syntax?
--       - remove backquote from $special?
385
<0> {
Ian Lynagh's avatar
Ian Lynagh committed
386 387
  @qual @varsym                                    { idtoken qvarsym }
  @qual @consym                                    { idtoken qconsym }
388 389
  @varsym                                          { varsym }
  @consym                                          { consym }
390 391
}

392 393
-- For the normal boxed literals we need to be careful
-- when trying to be close to Haskell98
394
<0> {
395
  -- Normal integral literals (:: Num a => a, from Integer)
396 397 398 399 400 401
  @decimal                                                               { tok_num positive 0 0 decimal }
  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 }
  @negative 0[oO] @octal       / { ifExtension negativeLiteralsEnabled } { tok_num negative 3 3 octal }
  @negative 0[xX] @hexadecimal / { ifExtension negativeLiteralsEnabled } { tok_num negative 3 3 hexadecimal }
402 403

  -- Normal rational literals (:: Fractional a => a, from Rational)
404 405
  @floating_point                                                        { strtoken tok_float }
  @negative @floating_point    / { ifExtension negativeLiteralsEnabled } { strtoken tok_float }
406 407
}

408
<0> {
Ian Lynagh's avatar
Ian Lynagh committed
409
  -- Unboxed ints (:: Int#) and words (:: Word#)
410 411
  -- It's simpler (and faster?) to give separate cases to the negatives,
  -- especially considering octal/hexadecimal prefixes.
Ian Lynagh's avatar
Ian Lynagh committed
412 413 414 415 416
  @decimal                     \# / { ifExtension magicHashEnabled } { tok_primint positive 0 1 decimal }
  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 }
  @negative 0[oO] @octal       \# / { ifExtension magicHashEnabled } { tok_primint negative 3 4 octal }
417
  @negative 0[xX] @hexadecimal \# / { ifExtension magicHashEnabled } { tok_primint negative 3 4 hexadecimal }
418

Ian Lynagh's avatar
Ian Lynagh committed
419 420 421 422
  @decimal                     \# \# / { ifExtension magicHashEnabled } { tok_primword 0 2 decimal }
  0[oO] @octal                 \# \# / { ifExtension magicHashEnabled } { tok_primword 2 4 octal }
  0[xX] @hexadecimal           \# \# / { ifExtension magicHashEnabled } { tok_primword 2 4 hexadecimal }

423 424
  -- Unboxed floats and doubles (:: Float#, :: Double#)
  -- prim_{float,double} work with signed literals
425 426
  @signed @floating_point \# / { ifExtension magicHashEnabled } { init_strtoken 1 tok_primfloat }
  @signed @floating_point \# \# / { ifExtension magicHashEnabled } { init_strtoken 2 tok_primdouble }
427 428 429 430 431 432
}

-- 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.
433
<0> {
Ian Lynagh's avatar
Ian Lynagh committed
434 435
  \'                            { lex_char_tok }
  \"                            { lex_string_tok }
436 437 438 439 440 441
}

{
-- -----------------------------------------------------------------------------
-- The token type

442
data Token
Ian Lynagh's avatar
Ian Lynagh committed
443
  = ITas                        -- Haskell keywords
444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
  | ITcase
  | ITclass
  | ITdata
  | ITdefault
  | ITderiving
  | ITdo
  | ITelse
  | IThiding
  | ITif
  | ITimport
  | ITin
  | ITinfix
  | ITinfixl
  | ITinfixr
  | ITinstance
  | ITlet
  | ITmodule
  | ITnewtype
  | ITof
  | ITqualified
  | ITthen
  | ITtype
  | ITwhere
Ian Lynagh's avatar
Ian Lynagh committed
467
  | ITscc                       -- ToDo: remove (we use {-# SCC "..." #-} now)
468

Ian Lynagh's avatar
Ian Lynagh committed
469
  | ITforall                    -- GHC extension keywords
470 471 472 473 474
  | ITforeign
  | ITexport
  | ITlabel
  | ITdynamic
  | ITsafe
475
  | ITinterruptible
476 477 478
  | ITunsafe
  | ITstdcallconv
  | ITccallconv
479
  | ITcapiconv
480
  | ITprimcallconv
thoughtpolice's avatar
thoughtpolice committed
481
  | ITjavascriptcallconv
482
  | ITmdo
483
  | ITfamily
484
  | ITrole
485 486 487
  | ITgroup
  | ITby
  | ITusing
488

Ian Lynagh's avatar
Ian Lynagh committed
489
  -- Pragmas
490
  | ITinline_prag InlineSpec RuleMatchInfo
Ian Lynagh's avatar
Ian Lynagh committed
491 492
  | ITspec_prag                 -- SPECIALISE
  | ITspec_inline_prag Bool     -- SPECIALISE INLINE (or NOINLINE)
493 494
  | ITsource_prag
  | ITrules_prag
Ian Lynagh's avatar
Ian Lynagh committed
495
  | ITwarning_prag
496 497 498
  | ITdeprecated_prag
  | ITline_prag
  | ITscc_prag
andy@galois.com's avatar
andy@galois.com committed
499
  | ITgenerated_prag
500
  | ITcore_prag                 -- hdaume: core annotations
501
  | ITunpack_prag
502
  | ITnounpack_prag
503
  | ITann_prag
504
  | ITclose_prag
505 506 507
  | IToptions_prag String
  | ITinclude_prag String
  | ITlanguage_prag
508 509
  | ITvect_prag
  | ITvect_scalar_prag
510
  | ITnovect_prag
511
  | ITminimal_prag
512
  | ITctype
513

Ian Lynagh's avatar
Ian Lynagh committed
514
  | ITdotdot                    -- reserved symbols
515 516 517 518
  | ITcolon
  | ITdcolon
  | ITequal
  | ITlam
519
  | ITlcase
520 521 522 523 524
  | ITvbar
  | ITlarrow
  | ITrarrow
  | ITat
  | ITtilde
batterseapower's avatar
batterseapower committed
525
  | ITtildehsh
526 527 528 529 530 531
  | ITdarrow
  | ITminus
  | ITbang
  | ITstar
  | ITdot

Ian Lynagh's avatar
Ian Lynagh committed
532
  | ITbiglam                    -- GHC-extension symbols
533

Ian Lynagh's avatar
Ian Lynagh committed
534
  | ITocurly                    -- special symbols
535 536 537 538
  | ITccurly
  | ITvocurly
  | ITvccurly
  | ITobrack
Ian Lynagh's avatar
Ian Lynagh committed
539 540
  | ITopabrack                  -- [:, for parallel arrays with -XParallelArrays
  | ITcpabrack                  -- :], for parallel arrays with -XParallelArrays
541 542 543 544 545 546 547 548 549
  | ITcbrack
  | IToparen
  | ITcparen
  | IToubxparen
  | ITcubxparen
  | ITsemi
  | ITcomma
  | ITunderscore
  | ITbackquote
dreixel's avatar
dreixel committed
550
  | ITsimpleQuote               --  '
551

Ian Lynagh's avatar
Ian Lynagh committed
552
  | ITvarid   FastString        -- identifiers
553 554 555 556 557 558 559
  | ITconid   FastString
  | ITvarsym  FastString
  | ITconsym  FastString
  | ITqvarid  (FastString,FastString)
  | ITqconid  (FastString,FastString)
  | ITqvarsym (FastString,FastString)
  | ITqconsym (FastString,FastString)
560 561
  | ITprefixqvarsym (FastString,FastString)
  | ITprefixqconsym (FastString,FastString)
562

Ian Lynagh's avatar
Ian Lynagh committed
563
  | ITdupipvarid   FastString   -- GHC extension: implicit param: ?x
564 565 566 567

  | ITchar       Char
  | ITstring     FastString
  | ITinteger    Integer
568
  | ITrational   FractionalLit
569 570

  | ITprimchar   Char
571
  | ITprimstring ByteString
572
  | ITprimint    Integer
Ian Lynagh's avatar
Ian Lynagh committed
573
  | ITprimword   Integer
574 575
  | ITprimfloat  FractionalLit
  | ITprimdouble FractionalLit
576

577
  -- Template Haskell extension tokens
Ian Lynagh's avatar
Ian Lynagh committed
578 579 580 581 582 583 584 585
  | ITopenExpQuote              --  [| or [e|
  | ITopenPatQuote              --  [p|
  | ITopenDecQuote              --  [d|
  | ITopenTypQuote              --  [t|
  | ITcloseQuote                --  |]
  | ITidEscape   FastString     --  $x
  | ITparenEscape               --  $(
  | ITtyQuote                   --  ''
586 587 588 589 590 591 592 593
  | 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 |]
594 595 596 597

  -- Arrow notation extension
  | ITproc
  | ITrec
Ian Lynagh's avatar
Ian Lynagh committed
598 599 600 601 602 603
  | IToparenbar                 --  (|
  | ITcparenbar                 --  |)
  | ITlarrowtail                --  -<
  | ITrarrowtail                --  >-
  | ITLarrowtail                --  -<<
  | ITRarrowtail                --  >>-
604

Ian Lynagh's avatar
Ian Lynagh committed
605 606
  | ITunknown String            -- Used when the lexer can't make sense of it
  | ITeof                       -- end of file token
607 608 609 610 611 612 613

  -- 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
614
  | ITdocOptionsOld   String     -- doc options declared "-- # ..."-style
Jedai's avatar
Jedai committed
615 616
  | ITlineComment     String     -- comment starting by "--"
  | ITblockComment    String     -- comment in {- -}
617

618
  deriving Show
619 620 621 622 623 624 625 626

-- 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)
--
Ian Lynagh's avatar
Ian Lynagh committed
627
reservedWordsFM :: UniqFM (Token, Int)
628
reservedWordsFM = listToUFM $
Ian Lynagh's avatar
Ian Lynagh committed
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659
    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 ),
         ( "_scc_",          ITscc,           0 ),            -- ToDo: remove

         ( "forall",         ITforall,        bit explicitForallBit .|.
                                              bit inRulePragBit),
         ( "mdo",            ITmdo,           bit recursiveDoBit),
660 661 662
             -- See Note [Lexing type pseudo-keywords]
         ( "family",         ITfamily,        0 ),
         ( "role",           ITrole,          0 ),
Ian Lynagh's avatar
Ian Lynagh committed
663 664 665 666 667 668 669 670 671 672 673 674 675 676
         ( "group",          ITgroup,         bit transformComprehensionsBit),
         ( "by",             ITby,            bit transformComprehensionsBit),
         ( "using",          ITusing,         bit transformComprehensionsBit),

         ( "foreign",        ITforeign,       bit ffiBit),
         ( "export",         ITexport,        bit ffiBit),
         ( "label",          ITlabel,         bit ffiBit),
         ( "dynamic",        ITdynamic,       bit ffiBit),
         ( "safe",           ITsafe,          bit ffiBit .|.
                                              bit safeHaskellBit),
         ( "interruptible",  ITinterruptible, bit interruptibleFfiBit),
         ( "unsafe",         ITunsafe,        bit ffiBit),
         ( "stdcall",        ITstdcallconv,   bit ffiBit),
         ( "ccall",          ITccallconv,     bit ffiBit),
677
         ( "capi",           ITcapiconv,      bit cApiFfiBit),
Ian Lynagh's avatar
Ian Lynagh committed
678
         ( "prim",           ITprimcallconv,  bit ffiBit),
thoughtpolice's avatar
thoughtpolice committed
679
         ( "javascript",     ITjavascriptcallconv, bit ffiBit),
Ian Lynagh's avatar
Ian Lynagh committed
680

681
         ( "rec",            ITrec,           bit arrowsBit .|.
682
                                              bit recursiveDoBit),
Ian Lynagh's avatar
Ian Lynagh committed
683
         ( "proc",           ITproc,          bit arrowsBit)
684 685
     ]

686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701
{-----------------------------------
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.
-------------------------------------}
702

Ian Lynagh's avatar
Ian Lynagh committed
703
reservedSymsFM :: UniqFM (Token, Int -> Bool)
704
reservedSymsFM = listToUFM $
Ian Lynagh's avatar
Ian Lynagh committed
705 706 707 708 709 710 711 712 713 714 715 716
    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)
717
       ,("~#",  ITtildehsh, magicHashEnabled)
Ian Lynagh's avatar
Ian Lynagh committed
718 719 720 721 722
       ,("=>",  ITdarrow,   always)
       ,("-",   ITminus,    always)
       ,("!",   ITbang,     always)

        -- For data T (a::*) = MkT
723
       ,("*", ITstar, always) -- \i -> kindSigsEnabled i || tyFamEnabled i)
Ian Lynagh's avatar
Ian Lynagh committed
724
        -- For 'forall a . t'
725
       ,(".", ITdot,  always) -- \i -> explicitForallEnabled i || inRulePrag i)
Ian Lynagh's avatar
Ian Lynagh committed
726 727 728 729 730

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

Ian Lynagh's avatar
Ian Lynagh committed
732 733
       ,("∷",   ITdcolon, unicodeSyntaxEnabled)
       ,("⇒",   ITdarrow, unicodeSyntaxEnabled)
734
       ,("∀",   ITforall, unicodeSyntaxEnabled)
Ian Lynagh's avatar
Ian Lynagh committed
735 736
       ,("→",   ITrarrow, unicodeSyntaxEnabled)
       ,("←",   ITlarrow, unicodeSyntaxEnabled)
737 738 739 740 741 742 743 744

       ,("⤙",   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
745 746 747
        -- 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).
748 749 750 751 752
       ]

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

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

755
special :: Token -> Action
twanvl's avatar
twanvl committed
756
special tok span _buf _len = return (L span tok)
757

758
token, layout_token :: Token -> Action
twanvl's avatar
twanvl committed
759 760
token t span _buf _len = return (L span t)
layout_token t span _buf _len = pushLexState layout >> return (L span t)
761

762 763
idtoken :: (StringBuffer -> Int -> Token) -> Action
idtoken f span buf len = return (L span $! (f buf len))
764

765
skip_one_varid :: (FastString -> Token) -> Action
Ian Lynagh's avatar
Ian Lynagh committed
766
skip_one_varid f span buf len
767
  = return (L span $! f (lexemeToFastString (stepOn buf) (len-1)))
768

769
strtoken :: (String -> Token) -> Action
Ian Lynagh's avatar
Ian Lynagh committed
770
strtoken f span buf len =
771
  return (L span $! (f $! lexemeToString buf len))
772

773
init_strtoken :: Int -> (String -> Token) -> Action
774
-- like strtoken, but drops the last N character(s)
Ian Lynagh's avatar
Ian Lynagh committed
775
init_strtoken drop f span buf len =
776
  return (L span $! (f $! lexemeToString buf (len-drop)))
777 778

begin :: Int -> Action
779
begin code _span _str _len = do pushLexState code; lexToken
780 781

pop :: Action
Ian Lynagh's avatar
Ian Lynagh committed
782 783
pop _span _buf _len = do _ <- popLexState
                         lexToken
784

785 786 787 788 789 790 791 792 793 794 795
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
796
              else failSpanMsgP (RealSrcSpan span) (text "Missing block")
797

798
pop_and :: Action -> Action
Ian Lynagh's avatar
Ian Lynagh committed
799 800
pop_and act span buf len = do _ <- popLexState
                              act span buf len
801

802
{-# INLINE nextCharIs #-}
Ian Lynagh's avatar
Ian Lynagh committed
803
nextCharIs :: StringBuffer -> (Char -> Bool) -> Bool
804 805
nextCharIs buf p = not (atEnd buf) && p (currentChar buf)

806 807 808 809
{-# INLINE nextCharIsNot #-}
nextCharIsNot :: StringBuffer -> (Char -> Bool) -> Bool
nextCharIsNot buf p = not (nextCharIs buf p)

Ian Lynagh's avatar
Ian Lynagh committed
810
notFollowedBy :: Char -> AlexAccPred Int
Ian Lynagh's avatar
Ian Lynagh committed
811
notFollowedBy char _ _ _ (AI _ buf)
812
  = nextCharIsNot buf (== char)
813

Ian Lynagh's avatar
Ian Lynagh committed
814
notFollowedBySymbol :: AlexAccPred Int
815
notFollowedBySymbol _ _ _ (AI _ buf)
816
  = nextCharIsNot buf (`elem` "!#$%&*+./<=>?@\\^|-~")
ross's avatar
ross committed
817

818 819 820 821 822
-- 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.
Ian Lynagh's avatar
Ian Lynagh committed
823
isNormalComment :: AlexAccPred Int
824
isNormalComment bits _ _ (AI _ buf)
825
  | haddockEnabled bits = notFollowedByDocOrPragma
826
  | otherwise           = nextCharIsNot buf (== '#')
827 828
  where
    notFollowedByDocOrPragma
829
       = afterOptionalSpace buf (\b -> nextCharIsNot b (`elem` "|^*$#"))
830

831 832 833 834 835
afterOptionalSpace :: StringBuffer -> (StringBuffer -> Bool) -> Bool
afterOptionalSpace buf p
    = if nextCharIs buf (== ' ')
      then p (snd (nextChar buf))
      else p buf
836

Ian Lynagh's avatar
Ian Lynagh committed
837
atEOL :: AlexAccPred Int
838
atEOL _ _ _ (AI _ buf) = atEnd buf || currentChar buf == '\n'
839

Ian Lynagh's avatar
Ian Lynagh committed
840
ifExtension :: (Int -> Bool) -> AlexAccPred Int
841 842
ifExtension pred bits _ _ _ = pred bits

843 844 845
multiline_doc_comment :: Action
multiline_doc_comment span buf _len = withLexedDocType (worker "")
  where
846
    worker commentAcc input docType oneLine = case alexGetChar' input of
Ian Lynagh's avatar
Ian Lynagh committed
847
      Just ('\n', input')
848 849 850 851 852 853
        | 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
854

855 856
    checkIfCommentLine input = check (dropNonNewlineSpace input)
      where
857 858 859
        check input = case alexGetChar' input of
          Just ('-', input) -> case alexGetChar' input of
            Just ('-', input) -> case alexGetChar' input of
860 861 862 863 864
              Just (c, _) | c /= '-' -> Just input
              _ -> Nothing
            _ -> Nothing
          _ -> Nothing

865
        dropNonNewlineSpace input = case alexGetChar' input of
Ian Lynagh's avatar
Ian Lynagh committed
866
          Just (c, input')
867 868 869 870
            | isSpace c && c /= '\n' -> dropNonNewlineSpace input'
            | otherwise -> input
          Nothing -> input

Jedai's avatar
Jedai committed
871 872 873 874 875
lineCommentToken :: Action
lineCommentToken span buf len = do
  b <- extension rawTokenStreamEnabled
  if b then strtoken ITlineComment span buf len else lexToken

876 877 878 879
{-
  nested comments require traversing by hand, they can't be parsed
  using regular expressions.
-}
Ian Lynagh's avatar
Ian Lynagh committed
880
nested_comment :: P (RealLocated Token) -> Action
881
nested_comment cont span _str _len = do
882
  input <- getInput
Jedai's avatar
Jedai committed
883
  go "" (1::Int) input
884
  where
Jedai's avatar
Jedai committed
885 886 887 888 889
    go commentAcc 0 input = do setInput input
                               b <- extension rawTokenStreamEnabled
                               if b
                                 then docCommentEnd input commentAcc ITblockComment _str span
                                 else cont
890
    go commentAcc n input = case alexGetChar' input of
891
      Nothing -> errBrace input span
892
      Just ('-',input) -> case alexGetChar' input of
893
        Nothing  -> errBrace input span
Jedai's avatar
Jedai committed
894 895
        Just ('\125',input) -> go commentAcc (n-1) input
        Just (_,_)          -> go ('-':commentAcc) n input
896
      Just ('\123',input) -> case alexGetChar' input of
897
        Nothing  -> errBrace input span
Jedai's avatar
Jedai committed
898 899 900
        Just ('-',input) -> go ('-':'\123':commentAcc) (n+1) input
        Just (_,_)       -> go ('\123':commentAcc) n input
      Just (c,input) -> go (c:commentAcc) n input
901 902 903 904

nested_doc_comment :: Action
nested_doc_comment span buf _len = withLexedDocType (go "")
  where
905
    go commentAcc input docType _ = case alexGetChar' input of
906
      Nothing -> errBrace input span
907
      Just ('-',input) -> case alexGetChar' input of
908
        Nothing -> errBrace input span
twanvl's avatar
twanvl committed
909
        Just ('\125',input) ->
910
          docCommentEnd input commentAcc docType buf span
twanvl's avatar
twanvl committed
911
        Just (_,_) -> go ('-':commentAcc) input docType False
912
      Just ('\123', input) -> case alexGetChar' input of
913 914 915 916 917
        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
918
        Just (_,_) -> go ('\123':commentAcc) input docType False
919 920
      Just (c,input) -> go (c:commentAcc) input docType False

Ian Lynagh's avatar
Ian Lynagh committed
921 922
withLexedDocType :: (AlexInput -> (String -> Token) -> Bool -> P (RealLocated Token))
                 -> P (RealLocated Token)
923
withLexedDocType lexDocComment = do
924
  input@(AI _ buf) <- getInput
925 926 927 928
  case prevChar buf ' ' of
    '|' -> lexDocComment input ITdocCommentNext False
    '^' -> lexDocComment input ITdocCommentPrev False
    '$' -> lexDocComment input ITdocCommentNamed False
David Waern's avatar
David Waern committed
929 930
    '*' -> lexDocSection 1 input
    '#' -> lexDocComment input ITdocOptionsOld False
Ian Lynagh's avatar
Ian Lynagh committed
931
    _ -> panic "withLexedDocType: Bad doc type"
Ian Lynagh's avatar
Ian Lynagh committed
932
 where
933
    lexDocSection n input = case alexGetChar' input of
934
      Just ('*', input) -> lexDocSection (n+1) input
twanvl's avatar
twanvl committed
935
      Just (_,   _)     -> lexDocComment input (ITdocSection n) True
936 937
      Nothing -> do setInput input; lexToken -- eof reached, lex it normally

938 939 940
-- RULES pragmas turn on the forall and '.' keywords, and we turn them
-- off again at the end of the pragma.
rulePrag :: Action
941
rulePrag span _buf _len = do
942
  setExts (.|. bit inRulePragBit)
943 944 945
  return (L span ITrules_prag)

endPrag :: Action
946
endPrag span _buf _len = do
947 948 949
  setExts (.&. complement (bit inRulePragBit))
  return (L span ITclose_prag)

950 951 952 953
-- docCommentEnd
-------------------------------------------------------------------------------
-- This function is quite tricky. We can't just return a new token, we also
-- need to update the state of the parser. Why? Because the token is longer
Ian Lynagh's avatar
Ian Lynagh committed
954
-- than what was lexed by Alex, and the lexToken function doesn't know this, so
955
-- it writes the wrong token length to the parser state. This function is
Ian Lynagh's avatar
Ian Lynagh committed
956
-- called afterwards, so it can just update the state.
957 958

docCommentEnd :: AlexInput -> String -> (String -> Token) -> StringBuffer ->
Ian Lynagh's avatar
Ian Lynagh committed
959
                 RealSrcSpan -> P (RealLocated Token)
960 961
docCommentEnd input commentAcc docType buf span = do
  setInput input
962
  let (AI loc nextBuf) = input
963
      comment = reverse commentAcc
Ian Lynagh's avatar
Ian Lynagh committed
964
      span' = mkRealSrcSpan (realSrcSpanStart span) loc
965
      last_len = byteDiff buf nextBuf
Ian Lynagh's avatar
Ian Lynagh committed
966

967
  span `seq` setLastToken span' last_len
968
  return (L span' (docType comment))
Ian Lynagh's avatar
Ian Lynagh committed
969

Ian Lynagh's avatar
Ian Lynagh committed
970 971
errBrace :: AlexInput -> RealSrcSpan -> P a
errBrace (AI end _) span = failLocMsgP (realSrcSpanStart span) end "unterminated `{-'"
Ian Lynagh's avatar
Ian Lynagh committed
972

973
open_brace, close_brace :: Action
Ian Lynagh's avatar
Ian Lynagh committed
974
open_brace span _str _len = do
975 976
  ctx <- getContext
  setContext (NoLayout:ctx)
977
  return (L span ITocurly)
Ian Lynagh's avatar
Ian Lynagh committed
978
close_brace span _str _len = do
979
  popContext
980
  return (L span ITccurly)
981

Ian Lynagh's avatar
Ian Lynagh committed
982
qvarid, qconid :: StringBuffer -> Int -> Token
983 984
qvarid buf len = ITqvarid $! splitQualName buf len False
qconid buf len = ITqconid $! splitQualName buf len False
985

986
splitQualName :: StringBuffer -> Int -> Bool -> (FastString,FastString)
987 988 989
-- takes a StringBuffer and a length, and returns the module name
-- and identifier parts of a qualified name.  Splits at the *last* dot,
-- because of hierarchical module names.
990
splitQualName orig_buf len parens = split orig_buf orig_buf
991
  where
992
    split buf dot_buf
Ian Lynagh's avatar
Ian Lynagh committed
993 994 995
        | orig_buf `byteDiff` buf >= len  = done dot_buf
        | c == '.'                        = found_dot buf'
        | otherwise                       = split buf' dot_buf
996 997
      where
       (c,buf') = nextChar buf
Ian Lynagh's avatar
Ian Lynagh committed
998