diff options
| author | simonmar <unknown> | 2005-02-02 16:23:04 +0000 |
|---|---|---|
| committer | simonmar <unknown> | 2005-02-02 16:23:04 +0000 |
| commit | d8450a233a8e9e0fabcd34e9daf53c82db4dd3bd (patch) | |
| tree | 4d05856cf7d2181061b6deb5931a34756dec57c4 /src/HaddockHH2.hs | |
| parent | a8c82f239a7fa8940abb35c32b82b4ebec9f6761 (diff) | |
[haddock @ 2005-02-02 16:23:00 by simonmar]
Revamp the linking strategy in Haddock.
Now name resolution is done in two phases:
- first resolve everything to original names, like a Haskell compiler
would.
- then, figure out the "home" location for every entity, and point
all the links to there. The home location is the lowest non-hidden
module in the import hierarchy that documents the entity. If there
are multiple candidates, one is chosen at random.
Also:
- Haddock should not generate any HTML with dangling links any more.
Unlinked references are just rendered as plain text.
- Error reporting is better: if we can't find a link destination for
an entity reference, we now emit a warning.
Diffstat (limited to 'src/HaddockHH2.hs')
| -rw-r--r-- | src/HaddockHH2.hs | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/src/HaddockHH2.hs b/src/HaddockHH2.hs index 9e023dda..6d4ce5c0 100644 --- a/src/HaddockHH2.hs +++ b/src/HaddockHH2.hs @@ -56,7 +56,7 @@ ppHH2Contents odir doctitle maybe_package tree = do ----------------------------------------------------------------------------------- -ppHH2Index :: FilePath -> Maybe String -> [(Module,Interface)] -> IO () +ppHH2Index :: FilePath -> Maybe String -> [Interface] -> IO () ppHH2Index odir maybe_package ifaces = do let indexKHH2File = package++"K.HxK" @@ -83,8 +83,9 @@ ppHH2Index odir maybe_package ifaces = do index :: [(HsName, [Module])] index = Map.toAscList (foldr getIfaceIndex Map.empty ifaces) - getIfaceIndex (mdl,iface) fm = + getIfaceIndex iface fm = Map.unionWith (++) (Map.fromListWith (flip (++)) [(name, [mdl]) | (name, Qual mdl' _) <- Map.toAscList (iface_env iface), mdl == mdl']) fm + where mdl = iface_module iface ppList [] = empty ppList ((name,mdls):vs) = @@ -98,7 +99,7 @@ ppHH2Index odir maybe_package ifaces = do ----------------------------------------------------------------------------------- -ppHH2Files :: FilePath -> Maybe String -> [(Module,Interface)] -> [FilePath] -> IO () +ppHH2Files :: FilePath -> Maybe String -> [Interface] -> [FilePath] -> IO () ppHH2Files odir maybe_package ifaces pkg_paths = do let filesHH2File = package++".HxF" doc = @@ -116,9 +117,10 @@ ppHH2Files odir maybe_package ifaces pkg_paths = do package = fromMaybe "pkg" maybe_package ppMods [] = empty - ppMods ((Module mdl,_):ifaces) = + ppMods (iface:ifaces) = text "<File Url=\"" <> text (moduleHtmlFile mdl) <> text "\"/>" $$ ppMods ifaces + where Module mdl = iface_module iface ppIndexFiles [] = empty ppIndexFiles (c:cs) = @@ -141,8 +143,9 @@ ppHH2Files odir maybe_package ifaces pkg_paths = do chars :: [Char] chars = map fst (Map.toAscList (foldr getIfaceIndex Map.empty ifaces)) - getIfaceIndex (mdl,iface) fm = + getIfaceIndex iface fm = Map.union (Map.fromList [(toUpper (head (show name)),()) | (name, Qual mdl' _) <- Map.toAscList (iface_env iface), mdl == mdl']) fm + where mdl = iface_module iface ----------------------------------------------------------------------------------- |