From 36418c4f70d7d2b179a77925b3ad5caedb08c9b5 Mon Sep 17 00:00:00 2001 From: Oleg Grenrus Date: Sat, 20 Mar 2021 03:48:13 +0200 Subject: Specialization of Data.List --- html-test/ref/BundledPatterns.html | 2 +- html-test/ref/BundledPatterns2.html | 2 +- html-test/ref/Identifiers.html | 18 +++++++++--------- 3 files changed, 11 insertions(+), 11 deletions(-) (limited to 'html-test') diff --git a/html-test/ref/BundledPatterns.html b/html-test/ref/BundledPatterns.html index 82f58e49..8ac16a68 100644 --- a/html-test/ref/BundledPatterns.html +++ b/html-test/ref/BundledPatterns.html @@ -152,7 +152,7 @@ > subscript starting from 0 and ending at length - 1 subscript starting from 0 and ending at length - 1++, elemFoldable
  • , ++, elemFoldable, elem
  • Unqualified: 1 `elem``Foldable` [-3..3]
  • Qualified: 1 `elem` [-3..3]
  • Namespaced: `elem``Foldable`, `elem` Date: Thu, 20 May 2021 22:42:42 +0900 Subject: Update ref, the variables got renamed. (#1391) This is due to ghc/ghc!5555 which caused a change in ModDetails in case of NoBackend. Now the initModDetails is used to recreate the ModDetails from interface and in-memory ModDetails is not used. --- html-test/ref/Instances.html | 50 ++++++++++++++++++++++---------------------- 1 file changed, 25 insertions(+), 25 deletions(-) (limited to 'html-test') diff --git a/html-test/ref/Instances.html b/html-test/ref/Instances.html index 9e9f2300..e99f82e4 100644 --- a/html-test/ref/Instances.html +++ b/html-test/ref/Instances.html @@ -1300,9 +1300,9 @@ >baz :: [c] -> (forall a. a -> a) -> (b, a1. a1 -> a1) -> (b, forall c0. c0 -> [c]) -> (b, c1) c1. c1 -> [c]) -> (b, c0) #

    baz' :: b -> (forall b. b -> [c]) -> ( b1. b1 -> [c]) -> (forall b. b -> [c]) -> [(b, [c])] b1. b1 -> [c]) -> [(b, [c])] #

    baz'' :: b -> (forall b. ( b1. (forall b. b -> [c]) -> c0) -> b2. b2 -> [c]) -> c0) -> forall c1. c1 -> b #baz :: (a -> b) -> (forall a0. a0 -> a0) -> (b0, a1. a1 -> a1) -> (b0, forall c. c -> a -> b) -> (b0, c) c1. c1 -> a -> b) -> (b0, c) #

    forall b1. b1 -> a -> b) -> (forall b2. b2 -> a -> b) -> [(b0, a -> b)] b1. b1 -> a -> b) -> [(b0, a -> b)] #

    forall b2. b2 -> a -> b) -> c) -> forall c. c -> b0 c1. c1 -> b0 #

    Quux a b c -> (forall a0. a0 -> a0) -> (b0, a1. a1 -> a1) -> (b0, forall c0. c0 -> c1. c1 -> Quux a b c) -> (b0, c1) a b c) -> (b0, c0) #

    Quux a b c) -> (forall b2. b2 -> b1. b1 -> Quux a b c) -> [(b0, Quuxbaz :: (a, b, c) -> (forall a0. a0 -> a0) -> (b0, a1. a1 -> a1) -> (b0, forall c0. c0 -> (a, b, c)) -> (b0, c1) c1. c1 -> (a, b, c)) -> (b0, c0) #

    forall b1. b1 -> (a, b, c)) -> (forall b2. b2 -> (a, b, c)) -> [(b0, (a, b, c))] b1. b1 -> (a, b, c)) -> [(b0, (a, b, c))] #

    baz :: (a, [b], b, a) -> (forall a0. a0 -> a0) -> (b0, a1. a1 -> a1) -> (b0, forall c. c -> (a, [b], b, a)) -> (b0, c) c1. c1 -> (a, [b], b, a)) -> (b0, c) #

    forall b1. b1 -> (a, [b], b, a)) -> (forall b2. b2 -> (a, [b], b, a)) -> [(b0, (a, [b], b, a))] b1. b1 -> (a, [b], b, a)) -> [(b0, (a, [b], b, a))] #

    forall b2. b2 -> (a, [b], b, a)) -> c) -> forall c. c -> b0 c1. c1 -> b0 #

    Quux a b c -> (forall a0. a0 -> a0) -> (b0, a1. a1 -> a1) -> (b0, forall c0. c0 -> c1. c1 -> Quux a b c) -> (b0, c1) a b c) -> (b0, c0) #

    Quux a b c) -> (forall b2. b2 -> b1. b1 -> Quux a b c) -> [(b0, Quux Date: Mon, 11 Oct 2021 15:40:19 +0530 Subject: Enable Haddock tests in GHC windows CI (#1428) * testsuite: strip windows line endings for haddock * hyperlinker: Work around double escaping (#19236) * deterministic SCC --- haddock-api/src/Haddock/Backends/Hyperlinker.hs | 12 +++++- haddock-api/src/Haddock/Interface.hs | 54 +++++++++++++++++++++++-- haddock-test/src/Test/Haddock/Xhtml.hs | 3 +- html-test/ref/Bug1004.html | 12 +++--- html-test/ref/BundledPatterns.html | 8 ++-- html-test/ref/BundledPatterns2.html | 8 ++-- 6 files changed, 76 insertions(+), 21 deletions(-) (limited to 'html-test') diff --git a/haddock-api/src/Haddock/Backends/Hyperlinker.hs b/haddock-api/src/Haddock/Backends/Hyperlinker.hs index 39be6762..68e03fd5 100644 --- a/haddock-api/src/Haddock/Backends/Hyperlinker.hs +++ b/haddock-api/src/Haddock/Backends/Hyperlinker.hs @@ -22,7 +22,7 @@ import System.FilePath import GHC.Iface.Ext.Types ( pattern HiePath, HieFile(..), HieASTs(..), HieAST(..), SourcedNodeInfo(..) ) import GHC.Iface.Ext.Binary ( readHieFile, hie_file_result ) -import GHC.Types.SrcLoc ( realSrcLocSpan, mkRealSrcLoc ) +import GHC.Types.SrcLoc ( realSrcLocSpan, mkRealSrcLoc, srcSpanFile ) import Data.Map as M import GHC.Data.FastString ( mkFastString ) import GHC.Unit.Module ( Module, moduleName ) @@ -71,7 +71,7 @@ ppHyperlinkedModuleSource verbosity srcdir pretty srcs iface = case ifaceHieFile let fileFs = mkFastString file mast | M.size asts == 1 = snd <$> M.lookupMin asts | otherwise = M.lookup (HiePath (mkFastString file)) asts - tokens = parse df file rawSrc + tokens' = parse df file rawSrc ast = fromMaybe (emptyHieAst fileFs) mast fullAst = recoverFullIfaceTypes df types ast @@ -81,6 +81,14 @@ ppHyperlinkedModuleSource verbosity srcdir pretty srcs iface = case ifaceHieFile else out verbosity verbose $ unwords [ "couldn't find ast for" , file, show (M.keys asts) ] + -- The C preprocessor can double the backslashes on tokens (see #19236), + -- which means the source spans will not be comparable and we will not + -- be able to associate the HieAST with the correct tokens. + -- + -- We work around this by setting the source span of the tokens to the file + -- name from the HieAST + let tokens = fmap (\tk -> tk {tkSpan = (tkSpan tk){srcSpanFile = srcSpanFile $ nodeSpan fullAst}}) tokens' + -- Produce and write out the hyperlinked sources writeUtf8File path . renderToString pretty . render' fullAst $ tokens Nothing -> return () diff --git a/haddock-api/src/Haddock/Interface.hs b/haddock-api/src/Haddock/Interface.hs index 2e9b2f7e..ba7d9d30 100644 --- a/haddock-api/src/Haddock/Interface.hs +++ b/haddock-api/src/Haddock/Interface.hs @@ -55,7 +55,7 @@ import qualified Data.Set as Set import GHC hiding (verbosity) import GHC.Data.FastString (unpackFS) -import GHC.Data.Graph.Directed (flattenSCCs) +import GHC.Data.Graph.Directed import GHC.Driver.Env (hscUpdateFlags, hsc_home_unit, hsc_logger, hsc_static_plugins, hsc_units) import GHC.Driver.Monad (modifySession, withTimingM) import GHC.Driver.Session hiding (verbosity) @@ -68,7 +68,7 @@ import GHC.Types.Name (nameIsFromExternalPackage, nameOccName) import GHC.Types.Name.Occurrence (isTcOcc) import GHC.Types.Name.Reader (globalRdrEnvElts, greMangledName, unQualOK) import GHC.Unit.Module.Env (ModuleSet, emptyModuleSet, mkModuleSet, unionModuleSet) -import GHC.Unit.Module.Graph (ModuleGraphNode (..)) +import GHC.Unit.Module.Graph import GHC.Unit.Module.ModSummary (emsModSummary, isBootSummary) import GHC.Unit.Types (IsBootInterface (..)) import GHC.Utils.Error (withTiming) @@ -170,13 +170,59 @@ createIfaces verbosity modules flags instIfaceMap = do moduleSet <- liftIO getModules let + -- We topologically sort the module graph including boot files, + -- so it should be acylic (hopefully we failed much earlier if this is not the case) + -- We then filter out boot modules from the resultant topological sort + -- + -- We do it this way to make 'buildHomeLinks' a bit more stable + -- 'buildHomeLinks' depends on the topological order of its input in order + -- to construct its result. In particular, modules closer to the bottom of + -- the dependency chain are to be prefered for link destinations. + -- + -- If there are cycles in the graph, then this order is indeterminate + -- (the nodes in the cycle can be ordered in any way). + -- While 'topSortModuleGraph' does guarantee stability for equivalent + -- module graphs, seemingly small changes in the ModuleGraph can have + -- big impacts on the `LinkEnv` constructed. + -- + -- For example, suppose + -- G1 = A.hs -> B.hs -> C.hs (where '->' denotes an import). + -- + -- Then suppose C.hs is changed to have a cyclic dependency on A + -- + -- G2 = A.hs -> B.hs -> C.hs -> A.hs-boot + -- + -- For G1, `C.hs` is preferred for link destinations. However, for G2, + -- the topologically sorted order not taking into account boot files (so + -- C -> A) is completely indeterminate. + -- Using boot files to resolve cycles, we end up with the original order + -- [C, B, A] (in decreasing order of preference for links) + -- + -- This exact case came up in testing for the 'base' package, where there + -- is a big module cycle involving 'Prelude' on windows, but the cycle doesn't + -- include 'Prelude' on non-windows platforms. This lead to drastically different + -- LinkEnv's (and failing haddockHtmlTests) across the platforms + -- + -- In effect, for haddock users this behaviour (using boot files to eliminate cycles) + -- means that {-# SOURCE #-} imports no longer count towards re-ordering + -- the preference of modules for linking. + -- + -- i.e. if module A imports B, then B is preferred over A, + -- but if module A {-# SOURCE #-} imports B, then we can't say the same. + -- + go (AcyclicSCC (ModuleNode ems)) + | NotBoot <- isBootSummary (emsModSummary ems) = [ems] + | otherwise = [] + go (AcyclicSCC _) = [] + go (CyclicSCC _) = error "haddock: module graph cyclic even with boot files" + ifaces :: [Interface] ifaces = [ Map.findWithDefault (error "haddock:iface") (ms_mod (emsModSummary ems)) ifaceMap - | ModuleNode ems <- flattenSCCs $ topSortModuleGraph True modGraph Nothing + | ems <- concatMap go $ topSortModuleGraph False modGraph Nothing ] return (ifaces, moduleSet) @@ -352,7 +398,7 @@ processModule1 verbosity flags ifaces inst_ifaces hsc_env mod_summary tc_gbl_env -- The interfaces are passed in in topologically sorted order, but we start -- by reversing the list so we can do a foldl. buildHomeLinks :: [Interface] -> LinkEnv -buildHomeLinks ifaces = foldl upd Map.empty (reverse ifaces) +buildHomeLinks ifaces = foldl' upd Map.empty (reverse ifaces) where upd old_env iface | OptHide `elem` ifaceOptions iface = old_env diff --git a/haddock-test/src/Test/Haddock/Xhtml.hs b/haddock-test/src/Test/Haddock/Xhtml.hs index bca2c4cc..74d8c4f7 100644 --- a/haddock-test/src/Test/Haddock/Xhtml.hs +++ b/haddock-test/src/Test/Haddock/Xhtml.hs @@ -23,8 +23,9 @@ import Data.Char ( isSpace ) newtype Xml = Xml { unXml :: String } -- | Part of parsing involves dropping the @DOCTYPE@ line +-- and windows newline endings parseXml :: String -> Maybe Xml -parseXml = Just . Xml . dropDocTypeLine +parseXml = Just . Xml . filter (/= '\r') . dropDocTypeLine where dropDocTypeLine bs | " ( (Typeable a, a, Typeable f, f, Typeable g, g, Typeable k, Data

    dataCast1 :: :: Typeable t => (forall

    dataCast2 :: :: Typeable t => (foralldata Vec :: :: Nat -> * -> * wheredata RTree :: :: Nat -> * -> * wheredata Vec :: :: Nat -> * -> * wheredata RTree :: :: Nat -> * -> * wheredata Vec :: :: Nat -> * -> * wheredata RTree :: :: Nat -> * -> * wheredata Vec :: :: Nat -> * -> * wheredata RTree :: :: Nat -> * -> * where Date: Thu, 2 Dec 2021 11:46:54 +0000 Subject: Update html-test for Data.List revert --- html-test/ref/Identifiers.html | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'html-test') diff --git a/html-test/ref/Identifiers.html b/html-test/ref/Identifiers.html index b177266d..76487140 100644 --- a/html-test/ref/Identifiers.html +++ b/html-test/ref/Identifiers.html @@ -147,7 +147,7 @@ >, Foldableelem

  • ++, Foldableelem, elemUnqualified: 1 `Foldable``elem` [-3..3]
  • Qualified: 1 `elem` [-3..3]
  • Namespaced: `Foldable``elem`, `elem` Date: Sun, 18 Oct 2020 16:25:35 +0300 Subject: Link to (~) --- haddock-api/src/Haddock/GhcUtils.hs | 1 + haddock-api/src/Haddock/Types.hs | 1 + haddock-library/src/Documentation/Haddock/Parser/Monad.hs | 1 + html-test/ref/FunArgs.html | 4 +++- html-test/ref/TypeOperators.html | 10 ++++++++-- 5 files changed, 14 insertions(+), 3 deletions(-) (limited to 'html-test') diff --git a/haddock-api/src/Haddock/GhcUtils.hs b/haddock-api/src/Haddock/GhcUtils.hs index 85e6fcf4..3f97236a 100644 --- a/haddock-api/src/Haddock/GhcUtils.hs +++ b/haddock-api/src/Haddock/GhcUtils.hs @@ -1,5 +1,6 @@ {-# LANGUAGE BangPatterns, StandaloneDeriving, FlexibleInstances, ViewPatterns #-} {-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeOperators #-} {-# LANGUAGE RankNTypes #-} {-# LANGUAGE TypeApplications #-} {-# LANGUAGE ScopedTypeVariables #-} diff --git a/haddock-api/src/Haddock/Types.hs b/haddock-api/src/Haddock/Types.hs index ba86f429..7d00c5ec 100644 --- a/haddock-api/src/Haddock/Types.hs +++ b/haddock-api/src/Haddock/Types.hs @@ -1,4 +1,5 @@ {-# LANGUAGE CPP, DeriveDataTypeable, DeriveFunctor, DeriveFoldable, DeriveTraversable, StandaloneDeriving, TypeFamilies, RecordWildCards #-} +{-# LANGUAGE TypeOperators #-} {-# LANGUAGE ConstraintKinds #-} {-# LANGUAGE FlexibleContexts #-} {-# LANGUAGE PartialTypeSignatures #-} diff --git a/haddock-library/src/Documentation/Haddock/Parser/Monad.hs b/haddock-library/src/Documentation/Haddock/Parser/Monad.hs index 7c73a168..2fa79961 100644 --- a/haddock-library/src/Documentation/Haddock/Parser/Monad.hs +++ b/haddock-library/src/Documentation/Haddock/Parser/Monad.hs @@ -2,6 +2,7 @@ {-# LANGUAGE FlexibleContexts #-} {-# LANGUAGE FlexibleInstances #-} {-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeOperators #-} {-# LANGUAGE BangPatterns #-} {-# LANGUAGE TypeSynonymInstances #-} -- | diff --git a/html-test/ref/FunArgs.html b/html-test/ref/FunArgs.html index 2fac6d4e..855f1b89 100644 --- a/html-test/ref/FunArgs.html +++ b/html-test/ref/FunArgs.html @@ -230,7 +230,9 @@ >:: forall a (b :: ()) d. d ~ ' a (b :: ()) d. d ~ '()

    f :: a ~ b => a -> b :: a ~ b => a -> b #

    g :: (a ~ b, b ~ c) => a -> c :: (a ~ b, b ~ c) => a -> c #

    Date: Mon, 28 Mar 2022 15:00:51 +0300 Subject: Rename [] to List --- html-test/ref/Instances.html | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) (limited to 'html-test') diff --git a/html-test/ref/Instances.html b/html-test/ref/Instances.html index e99f82e4..109e866c 100644 --- a/html-test/ref/Instances.html +++ b/html-test/ref/Instances.html @@ -262,7 +262,9 @@ > Foo [] List # Bar [] (a, a) List (a, a) # Date: Fri, 29 Apr 2022 23:58:38 -0400 Subject: Update test output --- html-test/ref/Instances.html | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) (limited to 'html-test') diff --git a/html-test/ref/Instances.html b/html-test/ref/Instances.html index 109e866c..e99f82e4 100644 --- a/html-test/ref/Instances.html +++ b/html-test/ref/Instances.html @@ -262,9 +262,7 @@ > Foo List [] # Bar List (a, a) [] (a, a) #