diff options
| author | Ryan Scott <ryan.gl.scott@gmail.com> | 2017-11-14 09:21:30 -0500 |
|---|---|---|
| committer | Alexander Biehl <alexbiehl@gmail.com> | 2018-02-01 14:58:18 +0100 |
| commit | 60e10eb876899165e9644013508361bf72048bdb (patch) | |
| tree | 737a3c08704ac521882f9fc8f200335f1fecb6a4 | |
| parent | deddced31cabadf62fe01fff77b094cd005e52a1 (diff) | |
Fix #548 by rendering datatype kinds more carefully (#702)
| -rw-r--r-- | .gitignore | 2 | ||||
| -rw-r--r-- | haddock-api/src/Haddock/Convert.hs | 27 | ||||
| -rw-r--r-- | html-test/ref/Bug548.html | 600 | ||||
| -rw-r--r-- | html-test/src/Bug548.hs | 3 |
4 files changed, 629 insertions, 3 deletions
@@ -25,5 +25,7 @@ TAGS .cabal-sandbox .ghc.environment.* cabal.sandbox.config +cabal.project.local +cabal.project.local~ .stack-work/ diff --git a/haddock-api/src/Haddock/Convert.hs b/haddock-api/src/Haddock/Convert.hs index fc808568..b712660f 100644 --- a/haddock-api/src/Haddock/Convert.hs +++ b/haddock-api/src/Haddock/Convert.hs @@ -164,7 +164,7 @@ synifyTyCon _coax tc -- algebraic data nor newtype: , dd_ctxt = noLoc [] , dd_cType = Nothing - , dd_kindSig = Just (synifyKindSig (tyConKind tc)) + , dd_kindSig = synifyDataTyConReturnKind tc -- we have their kind accurately: , dd_cons = [] -- No constructors , dd_derivs = noLoc [] } @@ -219,7 +219,7 @@ synifyTyCon coax tc -- CoAxioms, not their TyCons _ -> synifyName tc tyvars = synifyTyVars (tyConVisibleTyVars tc) - kindSig = Just (tyConKind tc) + kindSig = synifyDataTyConReturnKind tc -- The data constructors. -- -- Any data-constructors not exported from the module that *defines* the @@ -244,7 +244,7 @@ synifyTyCon coax tc defn = HsDataDefn { dd_ND = alg_nd , dd_ctxt = alg_ctx , dd_cType = Nothing - , dd_kindSig = fmap synifyKindSig kindSig + , dd_kindSig = kindSig , dd_cons = cons , dd_derivs = alg_deriv } in case lefts consRaw of @@ -254,6 +254,27 @@ synifyTyCon coax tc , tcdDataCusk = False, tcdFVs = placeHolderNamesTc } dataConErrs -> Left $ unlines dataConErrs +-- In this module, every TyCon being considered has come from an interface +-- file. This means that when considering a data type constructor such as: +-- +-- data Foo (w :: *) (m :: * -> *) (a :: *) +-- +-- Then its tyConKind will be (* -> (* -> *) -> * -> *). But beware! We are +-- also rendering the type variables of Foo, so if we synify the tyConKind of +-- Foo in full, we will end up displaying this in Haddock: +-- +-- data Foo (w :: *) (m :: * -> *) (a :: *) +-- :: * -> (* -> *) -> * -> * +-- +-- Which is entirely wrong (#548). We only want to display the *return* kind, +-- which this function obtains. +synifyDataTyConReturnKind :: TyCon -> Maybe (LHsKind Name) +synifyDataTyConReturnKind tc + = case splitFunTys (tyConKind tc) of + (_, ret_kind) + | isLiftedTypeKind ret_kind -> Nothing -- Don't bother displaying :: * + | otherwise -> Just (synifyKindSig ret_kind) + synifyInjectivityAnn :: Maybe Name -> [TyVar] -> Injectivity -> Maybe (LInjectivityAnn GhcRn) synifyInjectivityAnn Nothing _ _ = Nothing diff --git a/html-test/ref/Bug548.html b/html-test/ref/Bug548.html new file mode 100644 index 00000000..1ae91878 --- /dev/null +++ b/html-test/ref/Bug548.html @@ -0,0 +1,600 @@ +<html xmlns="http://www.w3.org/1999/xhtml" +><head + ><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" + /><title + >Bug548</title + ><link href="#" rel="stylesheet" type="text/css" title="Ocean" + /><link rel="stylesheet" type="text/css" href="#" + /><script src="haddock-bundle.min.js" async="async" type="text/javascript" + ></script + ><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript" + ></script + ></head + ><body + ><div id="package-header" + ><ul class="links" id="page-menu" + ><li + ><a href="#" + >Contents</a + ></li + ><li + ><a href="#" + >Index</a + ></li + ></ul + ><p class="caption empty" + ></p + ></div + ><div id="content" + ><div id="module-header" + ><table class="info" + ><tr + ><th + >Safe Haskell</th + ><td + >Safe</td + ></tr + ></table + ><p class="caption" + >Bug548</p + ></div + ><div id="interface" + ><h1 + >Documentation</h1 + ><div class="top" + ><p class="src" + ><span class="keyword" + >newtype</span + > <a id="t:WrappedArrow" class="def" + >WrappedArrow</a + > (a :: <a href="#" + >*</a + > -> <a href="#" + >*</a + > -> <a href="#" + >*</a + >) b c <a href="#" class="selflink" + >#</a + ></p + ><div class="subs constructors" + ><p class="caption" + >Constructors</p + ><table + ><tr + ><td class="src" + ><a id="v:WrapArrow" class="def" + >WrapArrow</a + ></td + ><td class="doc empty" + ></td + ></tr + ><tr + ><td colspan="2" + ><div class="subs fields" + ><p class="caption" + >Fields</p + ><ul + ><li + ><dfn class="src" + ><a id="v:unwrapArrow" class="def" + >unwrapArrow</a + > :: a b c</dfn + ><div class="doc empty" + ></div + ></li + ></ul + ></div + ></td + ></tr + ></table + ></div + ><div class="subs instances" + ><details id="i:WrappedArrow" open="open" + ><summary + >Instances</summary + ><table + ><tr + ><td class="src clearfix" + ><span class="inst-left" + ><span class="instance details-toggle-control details-toggle" data-details-id="i:id:WrappedArrow:Generic1:1" + ></span + > <a href="#" + >Generic1</a + > <a href="#" + >*</a + > (<a href="#" + >WrappedArrow</a + > a b)</span + ></td + ><td class="doc empty" + ></td + ></tr + ><tr + ><td colspan="2" + ><details id="i:id:WrappedArrow:Generic1:1" + ><summary class="hide-when-js-enabled" + >Instance details</summary + ><div class="subs associated-types" + ><p class="caption" + >Associated Types</p + ><p class="src" + ><span class="keyword" + >type</span + > <a href="#" + >Rep1</a + > (<a href="#" + >WrappedArrow</a + > a b) (f :: <a href="#" + >WrappedArrow</a + > a b -> <a href="#" + >*</a + >) :: k -> <a href="#" + >*</a + > <a href="#" class="selflink" + >#</a + ></p + ></div + > <div class="subs methods" + ><p class="caption" + >Methods</p + ><p class="src" + ><a href="#" + >from1</a + > :: f a0 -> <a href="#" + >Rep1</a + > (<a href="#" + >WrappedArrow</a + > a b) f a0 <a href="#" class="selflink" + >#</a + ></p + ><p class="src" + ><a href="#" + >to1</a + > :: <a href="#" + >Rep1</a + > (<a href="#" + >WrappedArrow</a + > a b) f a0 -> f a0 <a href="#" class="selflink" + >#</a + ></p + ></div + ></details + ></td + ></tr + ><tr + ><td class="src clearfix" + ><span class="inst-left" + ><span class="instance details-toggle-control details-toggle" data-details-id="i:id:WrappedArrow:Functor:2" + ></span + > <a href="#" + >Arrow</a + > a => <a href="#" + >Functor</a + > (<a href="#" + >WrappedArrow</a + > a b)</span + ></td + ><td class="doc" + ><p + ><em + >Since: 2.1</em + ></p + ></td + ></tr + ><tr + ><td colspan="2" + ><details id="i:id:WrappedArrow:Functor:2" + ><summary class="hide-when-js-enabled" + >Instance details</summary + ><div class="subs methods" + ><p class="caption" + >Methods</p + ><p class="src" + ><a href="#" + >fmap</a + > :: (a0 -> b0) -> <a href="#" + >WrappedArrow</a + > a b a0 -> <a href="#" + >WrappedArrow</a + > a b b0 <a href="#" class="selflink" + >#</a + ></p + ><p class="src" + ><a href="#" + >(<$)</a + > :: a0 -> <a href="#" + >WrappedArrow</a + > a b b0 -> <a href="#" + >WrappedArrow</a + > a b a0 <a href="#" class="selflink" + >#</a + ></p + ></div + ></details + ></td + ></tr + ><tr + ><td class="src clearfix" + ><span class="inst-left" + ><span class="instance details-toggle-control details-toggle" data-details-id="i:id:WrappedArrow:Applicative:3" + ></span + > <a href="#" + >Arrow</a + > a => <a href="#" + >Applicative</a + > (<a href="#" + >WrappedArrow</a + > a b)</span + ></td + ><td class="doc" + ><p + ><em + >Since: 2.1</em + ></p + ></td + ></tr + ><tr + ><td colspan="2" + ><details id="i:id:WrappedArrow:Applicative:3" + ><summary class="hide-when-js-enabled" + >Instance details</summary + ><div class="subs methods" + ><p class="caption" + >Methods</p + ><p class="src" + ><a href="#" + >pure</a + > :: a0 -> <a href="#" + >WrappedArrow</a + > a b a0 <a href="#" class="selflink" + >#</a + ></p + ><p class="src" + ><a href="#" + >(<*>)</a + > :: <a href="#" + >WrappedArrow</a + > a b (a0 -> b0) -> <a href="#" + >WrappedArrow</a + > a b a0 -> <a href="#" + >WrappedArrow</a + > a b b0 <a href="#" class="selflink" + >#</a + ></p + ><p class="src" + ><a href="#" + >liftA2</a + > :: (a0 -> b0 -> c) -> <a href="#" + >WrappedArrow</a + > a b a0 -> <a href="#" + >WrappedArrow</a + > a b b0 -> <a href="#" + >WrappedArrow</a + > a b c <a href="#" class="selflink" + >#</a + ></p + ><p class="src" + ><a href="#" + >(*>)</a + > :: <a href="#" + >WrappedArrow</a + > a b a0 -> <a href="#" + >WrappedArrow</a + > a b b0 -> <a href="#" + >WrappedArrow</a + > a b b0 <a href="#" class="selflink" + >#</a + ></p + ><p class="src" + ><a href="#" + >(<*)</a + > :: <a href="#" + >WrappedArrow</a + > a b a0 -> <a href="#" + >WrappedArrow</a + > a b b0 -> <a href="#" + >WrappedArrow</a + > a b a0 <a href="#" class="selflink" + >#</a + ></p + ></div + ></details + ></td + ></tr + ><tr + ><td class="src clearfix" + ><span class="inst-left" + ><span class="instance details-toggle-control details-toggle" data-details-id="i:id:WrappedArrow:Alternative:4" + ></span + > (<a href="#" + >ArrowZero</a + > a, <a href="#" + >ArrowPlus</a + > a) => <a href="#" + >Alternative</a + > (<a href="#" + >WrappedArrow</a + > a b)</span + ></td + ><td class="doc" + ><p + ><em + >Since: 2.1</em + ></p + ></td + ></tr + ><tr + ><td colspan="2" + ><details id="i:id:WrappedArrow:Alternative:4" + ><summary class="hide-when-js-enabled" + >Instance details</summary + ><div class="subs methods" + ><p class="caption" + >Methods</p + ><p class="src" + ><a href="#" + >empty</a + > :: <a href="#" + >WrappedArrow</a + > a b a0 <a href="#" class="selflink" + >#</a + ></p + ><p class="src" + ><a href="#" + >(<|>)</a + > :: <a href="#" + >WrappedArrow</a + > a b a0 -> <a href="#" + >WrappedArrow</a + > a b a0 -> <a href="#" + >WrappedArrow</a + > a b a0 <a href="#" class="selflink" + >#</a + ></p + ><p class="src" + ><a href="#" + >some</a + > :: <a href="#" + >WrappedArrow</a + > a b a0 -> <a href="#" + >WrappedArrow</a + > a b [a0] <a href="#" class="selflink" + >#</a + ></p + ><p class="src" + ><a href="#" + >many</a + > :: <a href="#" + >WrappedArrow</a + > a b a0 -> <a href="#" + >WrappedArrow</a + > a b [a0] <a href="#" class="selflink" + >#</a + ></p + ></div + ></details + ></td + ></tr + ><tr + ><td class="src clearfix" + ><span class="inst-left" + ><span class="instance details-toggle-control details-toggle" data-details-id="i:id:WrappedArrow:Generic:5" + ></span + > <a href="#" + >Generic</a + > (<a href="#" + >WrappedArrow</a + > a b c)</span + ></td + ><td class="doc empty" + ></td + ></tr + ><tr + ><td colspan="2" + ><details id="i:id:WrappedArrow:Generic:5" + ><summary class="hide-when-js-enabled" + >Instance details</summary + ><div class="subs associated-types" + ><p class="caption" + >Associated Types</p + ><p class="src" + ><span class="keyword" + >type</span + > <a href="#" + >Rep</a + > (<a href="#" + >WrappedArrow</a + > a b c) :: <a href="#" + >*</a + > -> <a href="#" + >*</a + > <a href="#" class="selflink" + >#</a + ></p + ></div + > <div class="subs methods" + ><p class="caption" + >Methods</p + ><p class="src" + ><a href="#" + >from</a + > :: <a href="#" + >WrappedArrow</a + > a b c -> <a href="#" + >Rep</a + > (<a href="#" + >WrappedArrow</a + > a b c) x <a href="#" class="selflink" + >#</a + ></p + ><p class="src" + ><a href="#" + >to</a + > :: <a href="#" + >Rep</a + > (<a href="#" + >WrappedArrow</a + > a b c) x -> <a href="#" + >WrappedArrow</a + > a b c <a href="#" class="selflink" + >#</a + ></p + ></div + ></details + ></td + ></tr + ><tr + ><td class="src clearfix" + ><span class="inst-left" + ><span class="instance details-toggle-control details-toggle" data-details-id="i:id:WrappedArrow:Rep1:6" + ></span + > <span class="keyword" + >type</span + > <a href="#" + >Rep1</a + > <a href="#" + >*</a + > (<a href="#" + >WrappedArrow</a + > a b)</span + ></td + ><td class="doc empty" + ></td + ></tr + ><tr + ><td colspan="2" + ><details id="i:id:WrappedArrow:Rep1:6" + ><summary class="hide-when-js-enabled" + >Instance details</summary + ><div class="src" + ><span class="keyword" + >type</span + > <a href="#" + >Rep1</a + > <a href="#" + >*</a + > (<a href="#" + >WrappedArrow</a + > a b) = <a href="#" + >D1</a + > <a href="#" + >*</a + > (<a href="#" + >MetaData</a + > "WrappedArrow" "Control.Applicative" "base" <a href="#" + >True</a + >) (<a href="#" + >C1</a + > <a href="#" + >*</a + > (<a href="#" + >MetaCons</a + > "WrapArrow" <a href="#" + >PrefixI</a + > <a href="#" + >True</a + >) (<a href="#" + >S1</a + > <a href="#" + >*</a + > (<a href="#" + >MetaSel</a + > (<a href="#" + >Just</a + > <a href="#" + >Symbol</a + > "unwrapArrow") <a href="#" + >NoSourceUnpackedness</a + > <a href="#" + >NoSourceStrictness</a + > <a href="#" + >DecidedLazy</a + >) (<a href="#" + >Rec1</a + > <a href="#" + >*</a + > (a b))))</div + ></details + ></td + ></tr + ><tr + ><td class="src clearfix" + ><span class="inst-left" + ><span class="instance details-toggle-control details-toggle" data-details-id="i:id:WrappedArrow:Rep:7" + ></span + > <span class="keyword" + >type</span + > <a href="#" + >Rep</a + > (<a href="#" + >WrappedArrow</a + > a b c)</span + ></td + ><td class="doc empty" + ></td + ></tr + ><tr + ><td colspan="2" + ><details id="i:id:WrappedArrow:Rep:7" + ><summary class="hide-when-js-enabled" + >Instance details</summary + ><div class="src" + ><span class="keyword" + >type</span + > <a href="#" + >Rep</a + > (<a href="#" + >WrappedArrow</a + > a b c) = <a href="#" + >D1</a + > <a href="#" + >*</a + > (<a href="#" + >MetaData</a + > "WrappedArrow" "Control.Applicative" "base" <a href="#" + >True</a + >) (<a href="#" + >C1</a + > <a href="#" + >*</a + > (<a href="#" + >MetaCons</a + > "WrapArrow" <a href="#" + >PrefixI</a + > <a href="#" + >True</a + >) (<a href="#" + >S1</a + > <a href="#" + >*</a + > (<a href="#" + >MetaSel</a + > (<a href="#" + >Just</a + > <a href="#" + >Symbol</a + > "unwrapArrow") <a href="#" + >NoSourceUnpackedness</a + > <a href="#" + >NoSourceStrictness</a + > <a href="#" + >DecidedLazy</a + >) (<a href="#" + >Rec0</a + > <a href="#" + >*</a + > (a b c))))</div + ></details + ></td + ></tr + ></table + ></details + ></div + ></div + ></div + ></div + ><div id="footer" + ></div + ></body + ></html +>
\ No newline at end of file diff --git a/html-test/src/Bug548.hs b/html-test/src/Bug548.hs new file mode 100644 index 00000000..652d3d32 --- /dev/null +++ b/html-test/src/Bug548.hs @@ -0,0 +1,3 @@ +module Bug548 (WrappedArrow(..)) where + +import Control.Applicative |