aboutsummaryrefslogtreecommitdiff
path: root/src/Haddock/Backends
Commit message (Collapse)AuthorAgeFilesLines
* Differentiate between TH splices (line-links) and regular namesNiklas Haas2014-03-096-107/+134
| | | | | | | | | | | | | | | | | This adds a new type of source code link, to a specific line rather than a specific declaration/name - this is used to link to the location of a TH splice that defines a certain name. Rather hefty changes throughout and still one unresolved issue (the line URLs aren't parsed from the third form of --read-interface which means they're currently restricted to same-interface links). Not sure if this issue is really worth all the hassle, especially since we could just use line links in general. This commit also contains some cleanup/clarification of the types in Haddock.Backends.Xhtml.Decl and shortens some overlong lines in the process. Notably, the Bool parameter was replaced by a Unicode type synonym to help clarify its presence in type signatures.
* Reorder topDeclElem to move the source/wiki links to the topNiklas Haas2014-03-091-1/+1
| | | | | They appear in the same position due to the float: right attribute but now they're always at the top of the box instead of at the bottom.
* Render fixity informationNiklas Haas2014-03-085-82/+133
| | | | | | Affects functions, type synonyms, type families, class names, data type names, constructors, data families, associated TFs/DFs, type synonyms, pattern synonyms and everything else I could think of.
* Fix rendering of Contents when links are presentMateusz Kowalczyk2014-02-244-22/+37
| | | | Fixes Haddock Trac #267.
* Lower precedence of equality constraintsNiklas Haas2014-02-231-1/+1
| | | | | | | This drops them to the new precedence pREC_CTX, which makes single eqaulity constraints show up as (a ~ b) => ty, in line with GHC's rendering. Additional tests added to make sure other type operators render as intended. Current behavior matches GHC
* Make ImplicitParams render correctly (#260)Niklas Haas2014-02-232-8/+13
| | | | | | This introduces a new precedence level for single contexts (because implicit param contexts always need parens around them, but other types of contexts don't necessarily, even when alone)
* Use a bespoke data type to indicate fixityMateusz Kowalczyk2014-02-194-66/+66
| | | | | | This deals with what I imagine was an ancient TODO and makes it much clearer what the argument actually does rather than having the user chase down the comment.
* Improve display of poly-kinded type operatorsnand2014-02-113-27/+27
| | | | | | | This now displays them as (==) k a b c ... to mirror GHC's behavior, instead of the old (k == a) b c ... which was just wrong. Signed-off-by: Mateusz Kowalczyk <fuuzetsu@fuuzetsu.co.uk>
* Add support for type/data familiesnand2014-02-114-24/+40
| | | | | | | | This adds support for type/data families with their respective instances, as well as closed type families and associated type/data families. Signed-off-by: Mateusz Kowalczyk <fuuzetsu@fuuzetsu.co.uk>
* Ensure a space between type signature and ‘Source’Mateusz Kowalczyk2014-02-101-2/+1
| | | | | | This is briefly related to Haddock Trac #249 and employs effectively the suggested fix _but_ it doesn't actually fix the reported issue. This commit simply makes copying the full line a bit less of a pain.
* Insert a space between module link and descriptionMateusz Kowalczyk2014-02-101-1/+1
| | | | Fixes Haddock Trac #277.
* Handle infix vs prefix names correctly everywhere, by explicitly specifying ↵Dr. ERDI Gergo2014-01-314-56/+66
| | | | | | the context The basic idea is that "a" and "+" are either pretty-printed as "a" and "(+)" or "`a`" and "+"
* <+>: Don't insert a space when concatenating empty nodesDr. ERDI Gergo2014-01-311-1/+3
|
* Support for -XPatternSynonymsDr. ERDI Gergo2014-01-194-22/+118
| | | | Signed-off-by: Austin Seipp <austin@well-typed.com>
* Fixes #271Mateusz Kowalczyk2014-01-131-1/+1
| | | | Signed-off-by: Austin Seipp <austin@well-typed.com>
* Per-module extension flags and language listing.Mateusz Kowalczyk2014-01-122-14/+33
| | | | | | | | | | | | | Any extensions that are not enabled by a used language (Haskell2010 &c) will be shown. Furthermore, any implicitly enabled are also going to be shown. While we could eliminate this either by using the GHC API or a dirty hack, I opted not to: if a user doesn't want the implied flags to show, they are recommended to use enable extensions more carefully or individually. Perhaps this will encourage users to not enable the most powerful flags needlessly. Enabled with show-extensions. Conflicts: src/Haddock/InterfaceFile.hs
* Allow for headings inside function documentation.Mateusz Kowalczyk2014-01-123-3/+22
| | | | | | | | | | | | | LaTeX will treat the h3-h6 headings the same as we'd have to hack the style file heavily otherwise and it would make the headings tiny anyway. Hoogle upstream said they will put in the functionality on their end. Conflicts: src/Haddock/Interface/Rename.hs src/Haddock/Types.hs test/Haddock/ParserSpec.hs
* Support for bold.Mateusz Kowalczyk2014-01-123-3/+8
| | | | | | | Conflicts: src/Haddock/Backends/Hoogle.hs src/Haddock/Interface/Rename.hs src/Haddock/Parser.hs
* One pass parser and tests.Mateusz Kowalczyk2014-01-123-29/+40
| | | | | | | | We remove the HTML test as it is no longer necessary. We cover the test case in spec tests and other HTML tests but keeping this around fails: this is because the new parser has different semantics there. In fact, I suspect the original behaviour was a bug that wasn't caught/fixed but simply included as-is during the testing.
* Adapt to small change in Pretty's exportsSimon Peyton Jones2014-01-101-3/+3
|
* Revision to reflect new role annotation syntax in GHC.Richard Eisenberg2013-09-173-3/+1
|
* Fix ticket #247.Mateusz Kowalczyk2013-08-271-2/+6
| | | | | I do the same thing that the XHTML backend does: give these no special treatment and just act as if they are regular functions.
* Output Copright and License keys in Xhtml backend.Mathieu Boespflug2013-08-041-5/+7
| | | | | | | This information is as relevant in the documentation as it is in the source files themselves. Signed-off-by: David Waern <david.waern@gmail.com>
* Changes to reflect changes in GHC's type HsTyVarBndrRichard Eisenberg2013-08-023-1/+3
|
* Updates to reflect changes in HsDecls to support closed type families.Richard Eisenberg2013-06-211-6/+14
|
* Follow changes in baseIan Lynagh2013-02-161-0/+3
|
* Merge branch 'ghc-7.6' into ghc-7.6-merge-2Kazu Yamamoto2013-02-013-3/+11
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: haddock.cabal src/Haddock/Interface/AttachInstances.hs src/Haddock/Interface/Create.hs src/Haddock/Interface/LexParseRn.hs src/Haddock/InterfaceFile.hs src/Haddock/Types.hs Only GHC HEAD can compile this. GHC 7.6.x cannot compile this. Some test fail.
| * Add markup support for propertiesKazu Yamamoto2012-10-093-0/+3
| |
| * Merge branch 'dev' of https://github.com/sol/haddock into ghc-7.6David Waern2012-07-233-3/+8
| |\ | | | | | | | | | | | | Conflicts: src/Haddock/InterfaceFile.hs
| | * Add an optional label to URLsSimon Hengel2012-05-273-3/+8
| | |
* | | Implement overlapping type family instances.Richard Eisenberg2012-12-214-56/+57
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | An ordered, overlapping type family instance is introduced by 'type instance where', followed by equations. See the new section in the user manual (7.7.2.2) for details. The canonical example is Boolean equality at the type level: type family Equals (a :: k) (b :: k) :: Bool type instance where Equals a a = True Equals a b = False A branched family instance, such as this one, checks its equations in order and applies only the first the matches. As explained in the note [Instance checking within groups] in FamInstEnv.lhs, we must be careful not to simplify, say, (Equals Int b) to False, because b might later unify with Int. This commit includes all of the commits on the overlapping-tyfams branch. SPJ requested that I combine all my commits over the past several months into one monolithic commit. The following GHC repos are affected: ghc, testsuite, utils/haddock, libraries/template-haskell, and libraries/dph. Here are some details for the interested: - The definition of CoAxiom has been moved from TyCon.lhs to a new file CoAxiom.lhs. I made this decision because of the number of definitions necessary to support BranchList. - BranchList is a GADT whose type tracks whether it is a singleton list or not-necessarily-a-singleton-list. The reason I introduced this type is to increase static checking of places where GHC code assumes that a FamInst or CoAxiom is indeed a singleton. This assumption takes place roughly 10 times throughout the code. I was worried that a future change to GHC would invalidate the assumption, and GHC might subtly fail to do the right thing. By explicitly labeling CoAxioms and FamInsts as being Unbranched (singleton) or Branched (not-necessarily-singleton), we make this assumption explicit and checkable. Furthermore, to enforce the accuracy of this label, the list of branches of a CoAxiom or FamInst is stored using a BranchList, whose constructors constrain its type index appropriately. I think that the decision to use BranchList is probably the most controversial decision I made from a code design point of view. Although I provide conversions to/from ordinary lists, it is more efficient to use the brList... functions provided in CoAxiom than always to convert. The use of these functions does not wander far from the core CoAxiom/FamInst logic. BranchLists are motivated and explained in the note [Branched axioms] in CoAxiom.lhs. - The CoAxiom type has changed significantly. You can see the new type in CoAxiom.lhs. It uses a CoAxBranch type to track branches of the CoAxiom. Correspondingly various functions producing and consuming CoAxioms had to change, including the binary layout of interface files. - To get branched axioms to work correctly, it is important to have a notion of type "apartness": two types are apart if they cannot unify, and no substitution of variables can ever get them to unify, even after type family simplification. (This is different than the normal failure to unify because of the type family bit.) This notion in encoded in tcApartTys, in Unify.lhs. Because apartness is finer-grained than unification, the tcUnifyTys now calls tcApartTys. - CoreLinting axioms has been updated, both to reflect the new form of CoAxiom and to enforce the apartness rules of branch application. The formalization of the new rules is in docs/core-spec/core-spec.pdf. - The FamInst type (in types/FamInstEnv.lhs) has changed significantly, paralleling the changes to CoAxiom. Of course, this forced minor changes in many files. - There are several new Notes in FamInstEnv.lhs, including one discussing confluent overlap and why we're not doing it. - lookupFamInstEnv, lookupFamInstEnvConflicts, and lookup_fam_inst_env' (the function that actually does the work) have all been more-or-less completely rewritten. There is a Note [lookup_fam_inst_env' implementation] describing the implementation. One of the changes that affects other files is to change the type of matches from a pair of (FamInst, [Type]) to a new datatype (which now includes the index of the matching branch). This seemed a better design. - The TySynInstD constructor in Template Haskell was updated to use the new datatype TySynEqn. I also bumped the TH version number, requiring changes to DPH cabal files. (That's why the DPH repo has an overlapping-tyfams branch.) - As SPJ requested, I refactored some of the code in HsDecls: * splitting up TyDecl into SynDecl and DataDecl, correspondingly changing HsTyDefn to HsDataDefn (with only one constructor) * splitting FamInstD into TyFamInstD and DataFamInstD and splitting FamInstDecl into DataFamInstDecl and TyFamInstDecl * making the ClsInstD take a ClsInstDecl, for parallelism with InstDecl's other constructors * changing constructor TyFamily into FamDecl * creating a FamilyDecl type that stores the details for a family declaration; this is useful because FamilyDecls can appear in classes but other decls cannot * restricting the associated types and associated type defaults for a * class to be the new, more restrictive types * splitting cid_fam_insts into cid_tyfam_insts and cid_datafam_insts, according to the new types * perhaps one or two more that I'm overlooking None of these changes has far-reaching implications. - The user manual, section 7.7.2.2, is updated to describe the new type family instances.
* | | Merge branch 'master' of darcs.haskell.org:/srv/darcs//haddockIan Lynagh2012-07-198-144/+146
|\| |
| * | Forward port changes from stable.Paolo Capriotti2012-07-198-144/+146
| |\|
| | * Attach warnings to `Documentation` typeSimon Hengel2012-05-175-9/+9
| | |
| | * newtype-wrap Doc nodes for things that may have warnings attachedSimon Hengel2012-05-175-62/+66
| | |
| | * Use >>= instead of fmap and joinSimon Hengel2012-05-172-7/+4
| | |
| | * qualification style 'abbreviated' -> 'aliased'Henning Thielemann2012-04-022-5/+5
| | |
| | * abbreviated qualification: use Packages.lookupModuleInAllPackages for ↵Henning Thielemann2012-04-021-1/+1
| | | | | | | | | | | | finding the package that a module belongs to
| | * 'abbreviate' qualification style - basic supportHenning Thielemann2012-04-012-7/+18
| | | | | | | | | | | | | | | Currently we ignore the package a module is imported from. This means that a module import would shadow another one with the same module name from a different package.
| | * add QualOption type for distinction between qualification argument given by ↵Henning Thielemann2012-04-012-15/+7
| | | | | | | | | | | | | | | the user and the actual qualification for a concrete module
| | * Fix crash when using --qual. Naughty GHC API!David Waern2012-04-011-1/+4
| | |
| | * Mostly hlint-inspired cleanup.David Waern2012-02-044-41/+38
| | |
| | * Remove code for older ghc versions.David Waern2012-02-041-4/+0
| | |
| | * Style police.David Waern2012-02-041-2/+2
| | |
| | * Merge branch 'fix-for-186' of https://github.com/sol/haddock into ghc-7.4David Waern2012-02-043-11/+11
| | |\
| | | * Make sure that generated xhtml is valid (close #186)Simon Hengel2012-01-123-11/+11
| | | | | | | | | | | | | | | | Thanks to Phyx.
| | * | Remove obsolete TODOSimon Hengel2012-02-041-1/+0
| | | |
| | * | Add DocWarning to DocSimon Hengel2012-02-043-0/+3
| | |/ | | | | | | | | | | | | The Xhtml backend has special markup for that, Hoogle and LaTeX reuse what we have for DocEmphasis.
* | / Follow changes in GHCIan Lynagh2012-07-151-1/+2
|/ /
* | Follow changes for the implementation of implicit parametersSimon Peyton Jones2012-06-133-4/+9
| |
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-14 18:26:27 +0000