aboutsummaryrefslogtreecommitdiff
path: root/haddock-api
diff options
context:
space:
mode:
authorAlec Theriault <alec.theriault@gmail.com>2019-02-28 12:41:09 -0800
committerAlec Theriault <alec.theriault@gmail.com>2020-03-27 21:57:32 -0400
commit2a2020c5331c593319bd196aadccdc46e7a3f779 (patch)
treef3f6e605c1d82e10ad8afeb046ba8c8e4a7a1f5b /haddock-api
parentb0514cc5d53bb37424177d2ba986216a914f8b1c (diff)
Disallow qualified uses of reserved identifiers
This a GHC bug (https://gitlab.haskell.org/ghc/ghc/issues/14109) too, but it is a relatively easy fix in Haddock. Note that the fix must live in `haddock-api` instead of `haddock-library` because we can only really decide if an identifier is a reserved one by asking the GHC lexer. Fixes #952
Diffstat (limited to 'haddock-api')
-rw-r--r--haddock-api/src/Haddock/Parser.hs34
1 files changed, 22 insertions, 12 deletions
diff --git a/haddock-api/src/Haddock/Parser.hs b/haddock-api/src/Haddock/Parser.hs
index 6d5dc103..05f3c7f0 100644
--- a/haddock-api/src/Haddock/Parser.hs
+++ b/haddock-api/src/Haddock/Parser.hs
@@ -1,3 +1,4 @@
+{-# LANGUAGE ViewPatterns #-}
-- |
-- Module : Haddock.Parser
-- Copyright : (c) Mateusz Kowalczyk 2013,
@@ -19,8 +20,10 @@ import Haddock.Types
import DynFlags ( DynFlags )
import FastString ( fsLit )
-import Lexer ( mkPState, unP, ParseResult(POk) )
+import Lexer ( mkPState, unP, ParseResult(..) )
+import OccName ( occNameString )
import Parser ( parseIdentifier )
+import RdrName ( RdrName(Qual) )
import SrcLoc ( mkRealSrcLoc, GenLocated(..) )
import StringBuffer ( stringToStringBuffer )
@@ -33,14 +36,21 @@ parseString d = P.overIdentifier (parseIdent d) . P.parseString
parseIdent :: DynFlags -> Namespace -> String -> Maybe (Wrap NsRdrName)
parseIdent dflags ns str0 =
- let buffer = stringToStringBuffer str1
- realSrcLc = mkRealSrcLoc (fsLit "<unknown file>") 0 0
- pstate = mkPState dflags buffer realSrcLc
- (wrap,str1) = case str0 of
- '(' : s@(c : _) | c /= ',', c /= ')' -- rule out tuple names
- -> (Parenthesized, init s)
- '`' : s@(_ : _) -> (Backticked, init s)
- _ -> (Unadorned, str0)
- in case unP parseIdentifier pstate of
- POk _ (L _ name) -> Just (wrap (NsRdrName ns name))
- _ -> Nothing
+ case unP parseIdentifier (pstate str1) of
+ POk _ (L _ name)
+ -- Guards against things like 'Q.--', 'Q.case', etc.
+ -- See https://github.com/haskell/haddock/issues/952 and Trac #14109
+ | Qual _ occ <- name
+ , PFailed{} <- unP parseIdentifier (pstate (occNameString occ))
+ -> Nothing
+ | otherwise
+ -> Just (wrap (NsRdrName ns name))
+ PFailed{} -> Nothing
+ where
+ realSrcLc = mkRealSrcLoc (fsLit "<unknown file>") 0 0
+ pstate str = mkPState dflags (stringToStringBuffer str) realSrcLc
+ (wrap,str1) = case str0 of
+ '(' : s@(c : _) | c /= ',', c /= ')' -- rule out tuple names
+ -> (Parenthesized, init s)
+ '`' : s@(_ : _) -> (Backticked, init s)
+ _ -> (Unadorned, str0)