hi haddock: Lex and store haddock docs in interface fileswip/hi-haddock2021

Names appearing in Haddock docstrings are lexed and renamed like any other names
appearing in the AST. We currently rename names irrespective of the namespace,
so both type and constructor names corresponding to an identifier will appear in
the docstring. Haddock will select a given name as the link destination based on
its own heuristics.

This patch also restricts the limitation of `-haddock` being incompatible with
`Opt_KeepRawTokenStream`.

The export and documenation structure is now computed in GHC and serialised in
.hi files. This can be used by haddock to directly generate doc pages without
reparsing or renaming the source. At the moment the operation of haddock
is not modified, that's left to a future patch.

Updates the haddock submodule with the minimum changes needed.

1 files changed, 4 insertions, 4 deletions

diff --git a/compiler/GHC/Builtin/Utils.hs b/compiler/GHC/Builtin/Utils.hs
index c577c46b75..a815c5e5bb 100644
--- a/compiler/GHC/Builtin/Utils.hs
+++ b/compiler/GHC/Builtin/Utils.hs
@@ -65,6 +65,7 @@ import GHC.Types.Name
 import GHC.Types.Name.Env
 import GHC.Types.Id.Make
 import GHC.Types.Unique.FM
+import GHC.Types.Unique.Map
 import GHC.Types.TyThing
 import GHC.Types.Unique ( isValidKnownKeyUnique )
 
@@ -80,7 +81,6 @@ import GHC.Data.List.SetOps
 import Control.Applicative ((<|>))
 import Data.List        ( intercalate , find )
 import Data.Maybe
-import qualified Data.Map as Map
 
 {-
 ************************************************************************
@@ -244,15 +244,15 @@ ghcPrimExports
    [ availTC n [n] []
    | tc <- exposedPrimTyCons, let n = tyConName tc  ]
 
-ghcPrimDeclDocs :: DeclDocMap
-ghcPrimDeclDocs = DeclDocMap $ Map.fromList $ mapMaybe findName primOpDocs
+ghcPrimDeclDocs :: Docs
+ghcPrimDeclDocs = emptyDocs { docs_decls = listToUniqMap $ mapMaybe findName primOpDocs }
   where
     names = map idName ghcPrimIds ++
             map idName allThePrimOpIds ++
             map tyConName exposedPrimTyCons
     findName (nameStr, doc)
       | Just name <- find ((nameStr ==) . getOccString) names
-      = Just (name, mkHsDocString doc)
+      = Just (name, [WithHsDocIdentifiers (mkGeneratedHsDocString doc) []])
       | otherwise = Nothing
 
 {-