aboutsummaryrefslogtreecommitdiff
path: root/haddock-api/src/Haddock
Commit message (Collapse)AuthorAgeFilesLines
* Merge branch 'ghc-8.8' into ghc-8.10Alec Theriault2020-03-2023-443/+695
|\
| * Replace the 'caption' class so that the collapsible sections are shownKleidukos2020-03-191-1/+1
| |
| * Changes from #14579Ryan Scott2019-11-031-22/+5
| | | | | | | | | | | | | | We now have a top-level `tyConAppNeedsKindSig` function, which means that we can delete lots of code in `Convert`. (cherry picked from commit cfd682c5fd03b099a3d78c44f9279faf56a0ac70)
| * Reify oversaturated data family instances correctly (#1103)Ryan Scott2019-10-231-15/+23
| | | | | | | | | | | | This fixes #1103 by adapting the corresponding patch for GHC (see https://gitlab.haskell.org/ghc/ghc/issues/17296 and https://gitlab.haskell.org/ghc/ghc/merge_requests/1877).
| * Prefer un-hyperlinked sources to no sourcesAlec Theriault2019-10-072-14/+26
| | | | | | | | | | | | It is possible to fail to extract an HIE ast. This is however not a reason to produce _no_ output - we should still make a colorized HTML page.
| * Fix crash when there are no srcspans in the file due to CPPZubin Duggal2019-10-071-8/+11
| |
| * Fix the ignore-exports option (#1082)Alexis King2019-09-301-4/+5
| | | | | | The `ignore-exports` option has been broken since #688, as mentioned in https://github.com/haskell/haddock/pull/766#issue-172505043. This PR fixes it.
| * update for new way to store hiefile headersZubin Duggal2019-06-041-2/+3
| |
| * Remove Haddock's dependency on `Cabal`Alec Theriault2019-05-263-8/+21
| | | | | | | | | | | | | | | | At this point, Haddock depended on Cabal-the-library solely for a verbosity parser (which misleadingly accepts all sorts of verbosity options that Haddock never uses). Now, the only dependency on Cabal is for `haddock-test` (which uses Cabal to locate the Haddock interface files of a couple boot libraries).
| * Fix #1063 with better parenthesization logic for contextsAlec Theriault2019-05-171-2/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The only other change in html/hoogle/hyperlinker output for the boot libraries that this caused is a fix to some Hoogle output for implicit params. ``` $ diff -r _build/docs/ old_docs diff -r _build/docs/html/libraries/base/base.txt old_docs/html/libraries/base/base.txt 13296c13296 < assertError :: (?callStack :: CallStack) => Bool -> a -> a --- > assertError :: ?callStack :: CallStack => Bool -> a -> a ```
| * Comment C, which clarifies why e.g. ReadP is not enoughOleg Grenrus2019-05-131-0/+7
| |
| * Redo ParseModuleHeaderOleg Grenrus2019-05-131-93/+125
| |
| * Matching changes in GHC for #16236Alan Zimmerman2019-03-294-10/+10
| | | | | | | | (cherry picked from commit 3ee6526d4ae7bf4deb7cd1caf24b3d7355573576)
| * Remove workaround for now-fixed Clang CPP bug (#1028)Alec Theriault2019-03-292-48/+3
| | | | | | | | | | | | | | | | | | | | | | Before LLVM 6.0.1 (or 10.0 on Apple LLVM), there was a bug where lines that started with an octothorpe but turned out not to lex like pragmas would have an extra line added after them. Since this bug has been fixed upstream and that it doesn't have dire consequences anyways, the workaround is not really worth it anymore - we can just tell people to update their clang version (or re-structure their pragma code).
| * Many LaTeX backend fixesAlec Theriault2019-03-091-98/+118
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | After this commit, we can run with `--latex` on all boot libraries without crashing (although the generated LaTeX still fails to compile in a handful of larger packages like `ghc` and `base`). * Add newlines after all block elements in LaTeX. This is important to prevent the final output from being more an more indented. See the `latext-test/src/Example` test case for a sample of this. * Support associated types in class declarations (but not yet defaults) * Several small issues for producing compiling LaTeX; - avoid empy `\haddockbeginargs` lists (ex: `type family Any`) - properly escape identifiers depending on context (ex: `Int#`) - add `vbox` around `itemize`/`enumerate` (so they can be in tables) * Several spacing fixes: - limit the width of `Pretty`-arranged monospaced code - cut out extra space characters in export lists - only escape spaces if there are _multiple_ spaces - allow type signatures to be multiline (even without docs) * Remove uninteresting and repetitive `main.tex`/`haddock.sty` files from `latex-test` test reference output. Fixes #935, #929 (LaTeX docs for `text` build & compile) Fixes #727, #930 (I think both are really about type families...)
| * Avoid multi-line `emph` in LaTeX backendAlec Theriault2019-03-091-1/+1
| | | | | | | | | | | | | | | | `markupWarning` often processes inputs which span across paragraphs. Unfortunately, LaTeX's `emph` is not made to handle this (and will crash). Fixes #936.
| * Better support for default methods in classesAlec Theriault2019-03-094-51/+102
| | | | | | | | | | | | | | | | | | | | * default methods now get rendered differently * default associated types get rendered * fix a forgotten `s/TypeSig/ClassOpSig/` refactor in LaTeX backend * LaTeX backend now renders default method signatures NB: there is still no way to document default class members and the NB: LaTeX backend still crashes on associated types
| * Merge branch 'ghc-8.6' into ghc-8.8Alec Theriault2019-03-037-77/+78
| |\
| | * Fix standalone deriving docsAlec Theriault2019-02-251-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | Docs on standalone deriving decls for classes with associated types should be associated with the class instance, not the associated type instance. Fixes #1033
| | * Fix #1004 with a pinch of dropForAllsRyan Scott2019-01-271-1/+1
| | |
| | * Keep forall on H98 existential data constructors (#1003)Alec Theriault2019-01-232-3/+3
| | | | | | | | | | | | | | | | | | | | | The information about whether or not there is a source-level `forall` is already available on a `ConDecl` (as `con_forall`), so we should use it instead of always assuming `False`! Fixes #1002.
| | * Print kinded tyvars in constructors for Hoogle (#993)Alec Theriault2019-01-071-2/+8
| | | | | | | | | Fixes #992
| | * Load plugins when compiling each module (#983)Alec Theriault2018-12-201-1/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * WIP: Load (typechecker) plugins from language pragmas * Revert "Load plugins when starting a GHC session (#905)" This reverts commit 72d82e52f2a6225686d9668790ac33c1d1743193. * Simplify plugin initialization code
| | * More uniform handling of `forall`'s in HTML/LaTeXAlec Theriault2018-11-262-60/+50
| | | | | | | | | | | | | | | | | | | | | * don't forget to print explicit `forall`'s when there are arg docs * when printing an explicit `forall`, print all tyvars Fixes #973
| | * Rename 'NewOcean' theme to 'Linuwial'Alec Theriault2018-11-111-1/+1
| | |
| * | Fix bogus identifier defaultingAlec Theriault2019-02-261-9/+5
| | | | | | | | | | | | | | | | | | | | | | | | This avoids a situation in which an identifier would get defaulted to a completely different identifier. Prior to this commit, the 'Bug1035' test case would hyperlink 'Foo' into 'Bar'! Fixes #1035.
| * | Better identifier parsingAlec Theriault2019-02-2510-65/+141
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * '(<|>)' and '`elem`' now get parsed and rendered properly as links * 'DbModule'/'DbUnitId' now properly get split apart into two links * tuple names now get parsed properly * some more small niceties... The identifier parsing code is more precise and more efficient (although to be fair: it is also longer and in its own module). On the rendering side, we need to pipe through information about backticks/parens/neither all the way through from renaming to the backends. In terms of impact: a total of 35 modules in the entirety of the bootlib + ghc lib docs change. The only "regression" is things like '\0'. These should be changed to @\\0@ (the path by which this previously worked seems accidental).
| * | Support value/type namespaces on identifier linksAlec Theriault2019-02-254-21/+56
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Identifier links can be prefixed with a 'v' or 't' to indicate the value or type namespace of the desired identifier. For example: -- | Some link to a value: v'Data.Functor.Identity' -- -- Some link to a type: t'Data.Functor.Identity' The default is still the type (with a warning about the ambiguity)
* | | Define `XRec` for location information and get rid of `HasSrcSpan`Sebastian Graf2019-11-011-16/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | In https://gitlab.haskell.org/ghc/ghc/merge_requests/1970 I propose a simpler way to encode location information into the GHC and Haddock AST while incurring no cost for e.g. TH which doesn't need location information. These are just changes that have to happen in lock step.
* | | Refactor for OutputableBndrId changesSebastian Graf2019-10-252-4/+4
| | |
* | | Refactor for withTiming changes.Andreas Klebinger2019-10-211-4/+4
| | |
* | | Remove spaces around @-patterns (#1093)Vladislav Zavialov2019-09-282-3/+3
| | | | | | | | | This is needed to compile `haddock` when [GHC Proposal #229](https://github.com/ghc-proposals/ghc-proposals/blob/master/proposals/0229-whitespace-bang-patterns.rst) is implemented.
* | | Small change in to facilitate extended typed-holes (#1090)Matthías Páll Gissurarson2019-09-281-4/+4
| | | | | | | | | This change has no functional effect on haddock itself, it just changes one pattern to use `_ (` rather than `_(`, so that we may use `_(` as a token for extended typed-holes later.
* | | Fix for GHC module renamingSylvain Henry2019-09-121-1/+1
| | |
* | | Changes for #15247Ryan Scott2019-07-0310-321/+347
| | |
* | | update for new way to store hiefile headersZubin Duggal2019-05-301-2/+3
| | |
* | | Match changes with #14332Ryan Scott2019-05-221-3/+15
| | |
* | | Changes for #16110/#16356Ryan Scott2019-05-144-37/+19
| | |
* | | Match changes for "Stop inferring over-polymorphic kinds"Alec Theriault2019-03-092-8/+3
| | | | | | | | | | | | | | | | | | | | | | | | The `hsq_ext` field of `HsQTvs` is now just the implicit variables (instead of also including information about which of these variables are dependent). This commit shouldn't change any functionality in Haddock.
* | | Visible dependent quantification (#16326) changesRyan Scott2019-02-279-51/+80
| | |
* | | Match GHC changes for T16185Alec Theriault2019-02-224-19/+17
| | | | | | | | | | | | | | | | | | | | | `FunTy` now has an `AnonArgFlag` that indicates whether the arrow is a `t1 => t2` or `t1 -> t2`. This commit shouldn't change any functionality in Haddock.
* | | Bump ghc version to 8.9Ryan Scott2019-02-181-1/+1
| | |
* | | Parser changes to match !380Vladislav Zavialov2019-02-171-6/+9
| | |
* | | Fix tests broken by GHCAlec Theriault2019-02-162-4/+4
| | | | | | | | | | | | | | | | | | | | | | | | Changes in 19626218566ea709b5f6f287d3c296b0c4021de2 affected some of the hyperlinker output. Accepted the new output (hovering over a `..` now shows you what that wildcard binds). Also fixed some stray deprecation warnings.
* | | Remove workaround for now-fixed Clang CPP bug (#1028)Alec Theriault2019-02-112-48/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Before LLVM 6.0.1 (or 10.0 on Apple LLVM), there was a bug where lines that started with an octothorpe but turned out not to lex like pragmas would have an extra line added after them. Since this bug has been fixed upstream and that it doesn't have dire consequences anyways, the workaround is not really worth it anymore - we can just tell people to update their clang version (or re-structure their pragma code).
* | | Matching changes in GHC for #16236Alan Zimmerman2019-02-054-10/+10
| | |
* | | Changes from #14579Ryan Scott2019-02-041-22/+5
|/ / | | | | | | | | We now have a top-level `tyConAppNeedsKindSig` function, which means that we can delete lots of code in `Convert`.
* | Fix #1015 with dataConUserTyVars (#1022)Ryan Scott2019-02-041-3/+4
| | | | | | | | | | | | | | The central trick in this patch is to use `dataConUserTyVars` instead of `univ_tvs ++ ex_tvs`, which displays the foralls in a GADT constructor in a way that's more faithful to how the user originally wrote it. Fixes #1015.
* | Miscellaneous improvements to `Convert` (#1020)Alec Theriault2019-02-035-152/+444
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Now that Haddock is moving towards working entirely over `.hi` and `.hie` files, all declarations and types are going to be synthesized via the `Convert` module. In preparation for this change, here are a bunch of fixes to this module: * Add kind annotations to type variables in `forall`'s whose kind is not `Type`, unless the kind can be inferred from some later use of the variable. See `implicitForAll` and `noKindTyVars` in particular if you wish to dive into this. * Properly detect `HsQualTy` in `synifyType`. This is done by following suit with what GHC's `toIfaceTypeX` does and checking the first argument of `FunTy{} :: Type` to see if it classified as a given/wanted in the typechecker (see `isPredTy`). * Beef up the logic around figuring out when an explicit `forall` is needed. This includes: observing if any of the type variables will need kind signatures, if the inferred type variable order _without_ a forall will still match the one GHC claims, and some other small things. * Add some (not yet used) functionality for default levity polymorphic type signatures. This functionality similar to `fprint-explicit-runtime-reps`. Couple other smaller fixes only worth mentioning: * Show the family result signature only when it isn't `Type` * Fix rendering of implicit parameters in the LaTeX and Hoogle backends * Better handling of the return kind of polykinded H98 data declarations * Class decls produced by `tyThingToLHsDecl` now contain associated type defaults and default method signatures when appropriate * Filter out more `forall`'s in pattern synonyms
* | Use `.hie` files for the Hyperlinker backend (#977)Alec Theriault2019-01-3111-650/+688
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | # Summary This is a large architectural change to the Hyperlinker. * extract link (and now also type) information from `.hie` instead of doing ad-hoc SYB traversals of the `RenamedSource`. Also adds a superb type-on-hover feature (#715). * re-engineer the lexer to avoid needless string conversions. By going directly through GHC's `P` monad and taking bytestring slices, we avoid a ton of allocation and have better handling of position pragmas and CPP. In terms of performance, the Haddock side of things has gotten _much_ more efficient. Unfortunately, much of this is cancelled out by the increased GHC workload for generating `.hie` files. For the full set of boot libs (including `ghc`-the-library) * the sum of total time went down by 9-10% overall * the sum of total allocations went down by 6-7% # Motivation Haddock is moving towards working entirely over `.hi` and `.hie` files. This change means we no longer need the `RenamedSource` from `TypecheckedModule` (something which is _not_ in `.hi` files). # Details Along the way a bunch of things were fixed: * Cross package (and other) links are now more reliable (#496) * The lexer tries to recover from errors on every line (instead of at CPP boundaries) * `LINE`/`COLUMN` pragmas are taken into account * filter out zero length tokens before rendering * avoid recomputing the `ModuleName`-based `SrcMap` * remove the last use of `Documentation.Haddock.Utf8` (see #998) * restructure temporary folder logic for `.hi`/`.hie` model