1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
|
-- |
-- Module : Haddock.Parser
-- Copyright : (c) Mateusz Kowalczyk 2013,
-- Simon Hengel 2013
-- License : BSD-like
--
-- Maintainer : haddock@projects.haskell.org
-- Stability : experimental
-- Portability : portable
module Haddock.Parser ( parseParas
, parseString
, parseIdent
) where
import qualified Documentation.Haddock.Parser as P
import Documentation.Haddock.Types
import Haddock.Types
import GHC.Driver.Session ( DynFlags )
import GHC.Driver.Config
import GHC.Data.FastString ( fsLit )
import GHC.Parser.Lexer ( initParserState, unP, ParseResult(POk, PFailed) )
import GHC.Parser ( parseIdentifier )
import GHC.Types.Name.Occurrence ( occNameString )
import GHC.Types.Name.Reader ( RdrName(..) )
import GHC.Types.SrcLoc ( mkRealSrcLoc, GenLocated(..) )
import GHC.Data.StringBuffer ( stringToStringBuffer )
parseParas :: DynFlags -> Maybe Package -> String -> MetaDoc mod (Wrap NsRdrName)
parseParas d p = overDoc (P.overIdentifier (parseIdent d)) . P.parseParas p
parseString :: DynFlags -> String -> DocH mod (Wrap NsRdrName)
parseString d = P.overIdentifier (parseIdent d) . P.parseString
parseIdent :: DynFlags -> Namespace -> String -> Maybe (Wrap NsRdrName)
parseIdent dflags ns str0 =
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 = initParserState (initParserOpts 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)
|
