aboutsummaryrefslogtreecommitdiff
path: root/src/Haddock/Interface
Commit message (Collapse)AuthorAgeFilesLines
* Crash when exporting record selectors of data family instancesNiklas Haas2014-03-311-10/+24
| | | | | | | | | | | | | | | | | | | This fixes bug #294. This also fixes a related but never-before-mentioned bug about the display of GADT record selectors with non-polymorphic type signatures. Note: Associated data type constructors fail to show up if nothing is exported that they could be attached to. Exporting any of the data types in the instance head, or the class + data family itself, causes them to show up, but in the absence of either of these, exporting just the associated data type with the constructor itself will result in it being hidden. The only scenario I can come up that would involve this kind of situation involved OverlappingInstances, and even then it can be mitigated by just exporting the class itself, so I'm not going to solve it since the logic would most likely be very complicated.
* Display minimal complete definitions for type classesNiklas Haas2014-03-132-15/+27
| | | | | | | | | This corresponds to the new {-# MINIMAL #-} pragma present in GHC 7.8+. I also cleaned up some of the places in which ExportDecl is used to make adding fields easier in the future. Lots of test cases have been updated since they now render with minimality information.
* Hide RHS of TFs with non-exported right hand sidesNiklas Haas2014-03-132-4/+3
| | | | | | Not sure what to do about data families yet, since technically it would not make a lot of sense to display constructors that cannot be used by the user.
* Filter family instances of hidden typesNiklas Haas2014-03-111-4/+11
| | | | | Currently, this check does not extend to hidden right hand sides, although it probably should hide them in that case.
* Include fixity information in the Interface fileNiklas Haas2014-03-112-26/+30
| | | | | | This resolves fixity information not appearing across package borders. The binary file version has been increased accordingly.
* Differentiate between TH splices (line-links) and regular namesNiklas Haas2014-03-092-24/+29
| | | | | | | | | | | | | | | | | 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.
* Render fixity informationNiklas Haas2014-03-082-20/+43
| | | | | | 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.
* Change rendering of duplicate record field docsMateusz Kowalczyk2014-02-271-1/+2
| | | | | | | | See Haddock Trac #195. We now change this behaviour to only rendering the documentation attached to the first instance of a duplicate field. Perhaps we could improve this by rendering the first instance that has documentation attached to it but for now, we'll stick with this.
* Get rid of re-implementation of sortByNiklas Haas2014-02-131-7/+3
| | | | | | | I have no idea what this was doing lying around here, and due to the usage of tuples it's actually slower, too. Signed-off-by: Mateusz Kowalczyk <fuuzetsu@fuuzetsu.co.uk>
* Improve display of poly-kinded type operatorsnand2014-02-111-2/+3
| | | | | | | 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-113-99/+89
| | | | | | | | 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>
* Support for -XPatternSynonymsDr. ERDI Gergo2014-01-192-10/+23
| | | | Signed-off-by: Austin Seipp <austin@well-typed.com>
* Per-module extension flags and language listing.Mateusz Kowalczyk2014-01-123-15/+29
| | | | | | | | | | | | | 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-121-0/+1
| | | | | | | | | | | | | 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-122-2/+3
| | | | | | | Conflicts: src/Haddock/Backends/Hoogle.hs src/Haddock/Interface/Rename.hs src/Haddock/Parser.hs
* Fix totality, unicode, examples, paragraph parsingSimon Hengel2014-01-122-4/+4
| | | | | | | | Also simplify specs and parsers while we're at it. Some parsers were made more generic. This commit is a part of GHC pre-merge squash, email fuuzetsu@fuuzetsu.co.uk if you need the full commit history.
* One pass parser and tests.Mateusz Kowalczyk2014-01-122-12/+8
| | | | | | | | 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.
* Some code simplification by using traverseSimon Hengel2014-01-121-50/+5
|
* Track changes in HsSpliceTy data constructorSimon Peyton Jones2013-11-251-1/+1
|
* Revision to reflect new role annotation syntax in GHC.Richard Eisenberg2013-09-172-6/+7
|
* Fixes #253Mateusz Kowalczyk2013-09-021-2/+16
|
* Output Copright and License keys in Xhtml backend.Mathieu Boespflug2013-08-041-5/+8
| | | | | | | 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-021-6/+5
|
* Updates to reflect changes in HsDecls to support closed type families.Richard Eisenberg2013-06-213-12/+22
|
* Adapt to tcRnGetInfo returning family instances tooSimon Peyton Jones2013-03-151-3/+3
| | | | | | | | | This API change was part of the fix to Trac #4175. But it offers new information to Haddock: the type-family instances, as well as the class instances, of this type. This patch just drops the new information on the floor, but there's an open opportunity to use it in the information that Haddock displays.
* Refactoring instanceHead'.Kazu Yamamoto2013-02-061-1/+1
|
* Using tcSplitSigmaTy in instanceHead' (FIXME is resolved.)Kazu Yamamoto2013-02-061-6/+5
|
* Merge branch 'ghc-7.6' into ghc-7.6-merge-2Kazu Yamamoto2013-02-015-84/+175
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
| * Properly handle deprecation messages for re-exported things (fixes #220)Simon Hengel2012-10-141-3/+4
| |
| * Minor formatting changeSimon Hengel2012-10-141-19/+19
| |
| * If parsing of deprecation message fails, include it verbatimSimon Hengel2012-10-141-9/+10
| |
| * Allow haddock markup in deprecation messagesSimon Hengel2012-10-141-20/+29
| |
| * Handle more cases in renameTypeSimon Hengel2012-10-141-14/+19
| |
| * Simplify lookupRnSimon Hengel2012-10-141-7/+7
| |
| * Simplify RnM typeSimon Hengel2012-10-141-10/+9
| |
| * Better error messagesSimon Hengel2012-10-131-2/+6
| |
| * Handle HsExplicitListTy in renameer (fixes #213)Simon Hengel2012-10-131-0/+2
| |
| * Add markup support for propertiesKazu Yamamoto2012-10-092-0/+2
| |
| * Fix spurious superclass constraints bug.David Waern2012-09-281-8/+23
| |
| * Follow changes in GHC.David Waern2012-09-071-0/+1
| |
| * Merge branch 'hiddenInstances2' of http://github.com/feuerbach/haddock into ↵David Waern2012-09-071-6/+49
| |\ | | | | | | | | | ghc-7.6
| | * Hide "internal" instancesRoman Cheplyaka2012-07-271-6/+49
| | | | | | | | | | | | | | | | | | | | | This fixes #37 (http://trac.haskell.org/haddock/ticket/37) Precisely, we show an instance iff its class and all the types are exported by non-hidden modules.
| * | Improve haddock memory usageIan Lynagh2012-08-133-22/+39
| | |
| * | Merge branch 'dev' of https://github.com/sol/haddock into ghc-7.6David Waern2012-07-234-4/+5
| |\ \ | | | | | | | | | | | | | | | | Conflicts: src/Haddock/InterfaceFile.hs
| | * | Add a type signature for a where-bindingSimon Hengel2012-05-271-0/+1
| | | |
| | * | Fix typo in commentSimon Hengel2012-05-271-1/+1
| | | |
| | * | Use LANGUAGE pragmas instead of default-extensions in cabal fileSimon Hengel2012-05-271-1/+1
| | | |
| | * | Add an optional label to URLsSimon Hengel2012-05-272-2/+2
| | | |
* | | | Use InstEnv.instanceSig rather than instanceHead (name change)Simon Peyton Jones2013-01-021-1/+1
| | | |
* | | | Implement overlapping type family instances.Richard Eisenberg2012-12-213-47/+82
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
generated by cgit v1.2.3 (git 2.39.1) at 2024-09-22 00:24:02 +0000