aboutsummaryrefslogtreecommitdiff
path: root/haddock-api/src/Haddock/Backends
Commit message (Collapse)AuthorAgeFilesLines
* No MonadFail/Alternative for PVladislav Zavialov2020-02-161-26/+28
|
* Changes for GHC#17566Ryan Scott2020-01-253-4/+4
| | | | See https://gitlab.haskell.org/ghc/ghc/merge_requests/2469
* Fix after Iface modules renamingSylvain Henry2020-01-023-7/+7
|
* Update Hyperlinker.Parser.classify to use ITdollarVladislav Zavialov2019-11-241-4/+2
|
* Refactor for OutputableBndrId changesSebastian Graf2019-10-251-2/+2
|
* 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.
* Changes for #15247Ryan Scott2019-07-033-50/+50
|
* update for new way to store hiefile headersZubin Duggal2019-05-301-2/+3
|
* Changes for #16110/#16356Ryan Scott2019-05-141-11/+2
|
* Visible dependent quantification (#16326) changesRyan Scott2019-02-274-25/+47
|
* Match GHC changes for T16185Alec Theriault2019-02-221-2/+2
| | | | | | | `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.
* Parser changes to match !380Vladislav Zavialov2019-02-171-6/+9
|
* 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-052-5/+5
|
* Miscellaneous improvements to `Convert` (#1020)Alec Theriault2019-02-032-7/+12
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-316-556/+532
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | # 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
* Visible kind application haddock updatemynguyen2018-12-304-9/+38
|
* Properly synify and render promoted type variables (#985)Alec Theriault2018-12-231-3/+4
| | | | | | | | * Synify and render properly promoted type variables Fixes #923. * Accept output
* Refactor names + unused functions (#982)Alec Theriault2018-12-173-15/+9
| | | | | | | This commit should not introduce any change in functionality! * consistently use `getOccString` to convert `Name`s to strings * compare names directly when possible (instead of comparing strings) * get rid of unused utility functions
* Fix warnings, accept outputAlec Theriault2018-12-121-1/+0
| | | | | | | * remove redundant imports (only brought to light due to recent work for improving redundant import detection) * fix a bug that was casuing exports to appear in reverse order * fix something in haddock-library that prevented compilation on old GHC's
* [TTG: Handling Source Locations] Foundation and PatShayan-Najd2018-11-234-33/+54
| | | | | | | | | | | Trac Issues #15495 This patch removes the ping-pong style from HsPat (only, for now), using the plan laid out at https://ghc.haskell.org/trac/ghc/wiki/ImplementingTreesThatGrow/HandlingSourceLocations (solution A). - the class `HasSrcSpan`, and its functions (e.g., `cL` and `dL`), are introduced - some instances of `HasSrcSpan` are introduced - some constructors `L` are replaced with `cL` - some patterns `L` are replaced with `dL->L` view pattern - some type annotation are necessarily updated (e.g., `Pat p` --> `Pat (GhcPass p)`)
* Follow GHC HEAD's HsTypes.Promoted -> BasicTypes.PromotionFlag changeAlp Mestanogullari2018-11-153-4/+7
| | | | It got introduced in ghc/ghc@ae2c9b40f5b6bf272251d1f4107c60003f541b62.
* Merge branch 'ghc-8.6' into ghc-headAlec Theriault2018-11-106-42/+64
|\
| * Merge branch 'ghc-8.6' into wip/new-oceanAlec Theriault2018-11-093-17/+24
| |\
| | * Only run MathJax on entities with "mathjax" class (#960)Alec Theriault2018-11-052-11/+17
| | | | | | | | | | | | | | | | | | | | | Correspondingly, we wrap all inline/diplay math in <span class="mathjax"> ... the math .... </span> This fixes #959.
| | * Fix documentation in `haddock-api` (#957)Alec Theriault2018-10-271-5/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Fix misplaced Haddocks in Haddock itself Haddock should be able to generate documentation for 'haddock-api' again. * Make CI check that documentation can be built. * Add back a doc that is OK
| * | Clicking on "Contents" navigates to top of pageAlec Theriault2018-11-081-1/+1
| | |
| * | Allow "Contents" summary to scroll in a fixed divAlec Theriault2018-11-072-4/+5
| | | | | | | | | | | | | | | In the unfortunate event that the "Contents" summary doesn't fit vertically (like in the "Prelude"), it will be scrollable.
| * | Fix issues around plus/minusAlec Theriault2018-11-072-3/+5
| | | | | | | | | | | | | | | | | | * swap the minimize unicode to something more intuitive * use new unicode expander/collapser for instance lists * address some alignment issues in the "index" page
| * | Merge branch 'ghc-8.6' into wip/new-oceanAlec Theriault2018-10-251-6/+10
| |\|
| | * Avoid more conflicts in generated ids (#954)Alec Theriault2018-10-251-6/+10
| | | | | | | | | | | | | | | This fixes #953 by passing more names into the generated ids.
| * | Make package-header caption backward-compatibleNuno Alexandre2018-10-181-2/+2
| | | | | | | | | | | | | | | | | | | | | The current html generator of this branch wraps the package-header caption as a div, which does not work (without style adjustments) with the old themes. Changing it from div to span does the trick, without needing to adjust the old stylesheets.
| * | Update font in Xhtml.hs to PT SansNuno Alexandre2018-10-181-1/+1
| | |
| * | Avoid name shadowingalexbiehl2018-10-181-2/+3
| | |
| * | Add an initial-scale property to all haddock pagesNuno Alexandre2018-10-181-2/+3
| | | | | | | | | | | | | | | This solves an issue reported about the content looking incredibly small on mobile devices.
| * | Place the package name before the menu linksNuno Alexandre2018-10-181-2/+2
| | | | | | | | | | | | | | | This supports the expected responsive menu design, where the package name appears above the menu links.
| * | Make the style consistent with hackageNuno Alexandre2018-10-182-4/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | Several things are addressed here: - better responsive behaviour on the header - better space usage - consistent colors overall - other nit PR comments
| * | Update html test reference filesNunoAlexandre2018-10-181-1/+1
| | |
| * | Include custom font in the html headNunoAlexandre2018-10-181-1/+2
| |/
| * Output pattern synonyms in Hoogle backend (#947)Alec Theriault2018-10-161-8/+13
| | | | | | | | | | | | | | | | | | | | | | * Output pattern synonyms in Hoogle backend We were previously weren't outputting _any_ pattern synonyms, bundled or not. Now, we output both. Fixes #946. * Update changelog
| * Latex type families (#734)Alec Theriault2018-10-162-144/+209
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Support for type families in LaTeX The code is ported over from the XHTML backend. * Refactor XHTML and LaTeX family handling This is mostly a consolidation effort: stripping extra exports, inlining some short definitions, and trying to make the backends match. The LaTeX backend now has preliminary support for data families, although the only the data instance head is printed (not the actual constructors). Both backends also now use "newtype" for newtype data family instances. * Add some tests
| * Update the ghc-8.6 branch (#889)Simon Jakobi2018-07-204-176/+124
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Revert "Bump GHC version to 8.6" This was applied to the wrong branch; there's now a `ghc-8.6` branch; ghc-head is always supposed to point to GHC HEAD, i.e. an odd major version. The next version bump to `ghc-head` is supposed to go from e.g. 8.5 to 8.7 This reverts commit 5e3cf5d8868323079ff5494a8225b0467404a5d1. * README updates (#856) * README: Remove mentions of master branch * README: Add instructions for using html-test * README: Change command to run _all_ the testsuites * README: Add project overview section (cherry picked from commit 61d6f935da97eb96685f07bf385102c2dbc2a33c) * Export more fixities for Hoogle (#871) This exports fixities for more things, including class methods and type-level operators. (cherry picked from commit 88316b972e3d47197b1019111bae0f7f87275fce) * Avoid line breaks due to line length in Hoogle (#868) * Avoid line breaks due to line length in Hoogle Hoogle operates in a line-oriented fashion, so we should avoid ever breaking due to long lines. One way of doing this non-intrusively is to modify the 'DynFlags' that are threaded through the 'Hoogle' module (note this is anyways only passed through for use in the various 'showSDoc' functions). * Amend test case (cherry picked from commit 657b1b3d519545f8d4ca048c06210d6cbf0f0da0) * tyThingToLHsDecl: Preserve type synonyms that contain a forall (#880) * tyThingToLHsDecls: Preserve type synonyms that contain a forall Fixes #879. * Add Note [Invariant: Never expand type synonyms] * Clarify Note [Invariant: Never expand type synonyms] (cherry picked from commit c3eb3f0581f69e816f9453b1747a9f2a3ba02bb9) * Fix HEAD html-test (#860) * Update tests for 'StarIsType' * Accept tests * Revert "Update tests for 'StarIsType'" This reverts commit 7f0c01383bbba6dc5af554ee82988d2cf44e407a. * Refactor handling of parens in types (#874) * Fix type parenthesization in Hoogle backend Ported the logic in the HTML and LaTeX backends for adding in parens into something top-level in 'GhcUtil'. Calling that from the Hoogle backend fixes #873. * Remove parenthesizing logic from LaTeX and XHTML backends Now, the only times that parenthesis in types are added in any backend is through the explicit 'HsParTy' constructor. Precedence is also represented as its own datatype. * List out cases explicitly vs. catch-all * Fix printing of parens for QuantifiedConstraints The priority of printing 'forall' types was just one too high. Fixes #877. * Accept HTML output for quantified contexts test * Preserve docs on type family instances (#867) * Preserve docs on type family instances The only problem was that the instance location was slightly off for type family instances. * Accept output (cherry picked from commit 133e9c2c168db19c1135479f7ab144c4e33af2a4) * Fix broken instance source links (#869) The problem manifests itself in instances that are defined in modules other than the module where the class is defined. The fix is just to thread through the 'Module' of the instance further along. Since orphan instances appear to already have been working, I didn't do anything there. (cherry picked from commit 2de7c2acf9b1ec85b09027a8bb58bf8512e91c05) * Add some more unicode related tests (#872) This has been fixed for sure ever since we switched from attoparsec to parsec. Parts of it may have been working before that, but there was a point where this would have failed (see #191). A regression test never hurt anyone. :) (cherry picked from commit 5ec7715d418bfac0f26aec6039792a99a6e89370) * Misc tests (#858) * More tests * spliced types * constructor/pattern argument docs * strictness marks on fields with argument docs * latex test cases need seperate directory * Accept tests * Additional tests for the identifier parser (#816) * Add tests for the identifier parser * docs: Clarify how to delimit identifiers (cherry picked from commit 0861affeca4d72938f05a2eceddfae2c19199071)
* | Support hyperlink labels with inline markupAlec Theriault2018-11-063-6/+6
| | | | | | | | The parser for pictures hasn't been properly adjusted yet.
* | Set UTF-8 encoding before writing files (#934)Alec Theriault2018-10-164-13/+10
| | | | | | | | | | This should fix #929, as well as guard against future problems of this sort in other places. Basically replaces 'writeFile' (which selects the users default locale) with 'writeUtf8File' (which always uses utf8).
* | Better rendering of unboxed sums/tuplesAlec Theriault2018-08-212-3/+3
| | | | | | | | | | * adds space after/before the '#' marks * properly reify 'HsSumTy' in 'synifyType'
* | Add ITcomment_line_prag token to Hyperlinker ParserBen Sklaroff2018-08-211-5/+6
| | | | | | | | | | | | | | | | | | | | This token is necessary for parsing #line pragmas inside nested comments. Reviewers: bgamari Reviewed By: bgamari Differential Revision: https://phabricator.haskell.org/D4935
* | Latex type families (#734)Alec Theriault2018-08-042-144/+209
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Support for type families in LaTeX The code is ported over from the XHTML backend. * Refactor XHTML and LaTeX family handling This is mostly a consolidation effort: stripping extra exports, inlining some short definitions, and trying to make the backends match. The LaTeX backend now has preliminary support for data families, although the only the data instance head is printed (not the actual constructors). Both backends also now use "newtype" for newtype data family instances. * Add some tests
* | Fix broken instance source links (#869)Alec Theriault2018-07-202-19/+22
| | | | | | | | | | | | | | | | | | | | | | | | The problem manifests itself in instances that are defined in modules other than the module where the class is defined. The fix is just to thread through the 'Module' of the instance further along. Since orphan instances appear to already have been working, I didn't do anything there. (cherry picked from commit 2de7c2acf9b1ec85b09027a8bb58bf8512e91c05)
* | Avoid line breaks due to line length in Hoogle (#868)Alec Theriault2018-07-201-3/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Avoid line breaks due to line length in Hoogle Hoogle operates in a line-oriented fashion, so we should avoid ever breaking due to long lines. One way of doing this non-intrusively is to modify the 'DynFlags' that are threaded through the 'Hoogle' module (note this is anyways only passed through for use in the various 'showSDoc' functions). * Amend test case (cherry picked from commit 657b1b3d519545f8d4ca048c06210d6cbf0f0da0)
* | Export more fixities for Hoogle (#871)Alec Theriault2018-07-201-2/+2
| | | | | | | | | | | | | | This exports fixities for more things, including class methods and type-level operators. (cherry picked from commit 88316b972e3d47197b1019111bae0f7f87275fce)
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-21 10:19:52 +0000