aboutsummaryrefslogtreecommitdiff
path: root/src/Haddock/GhcUtils.hs
Commit message (Collapse)AuthorAgeFilesLines
* Adapt to new definition of HsDecls.TyFamEqnSimon Peyton Jones2014-07-141-1/+1
| | | | | This is a knock-on from the refactoring from Trac #9063. I'll push the corresponding changes to GHC shortly.
* Display minimal complete definitions for type classesNiklas Haas2014-03-131-1/+10
| | | | | | | | | 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.
* Add support for type/data familiesnand2014-02-111-0/+11
| | | | | | | | 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-191-0/+4
| | | | Signed-off-by: Austin Seipp <austin@well-typed.com>
* Add missing `traverse` method for `GenLocated`Herbert Valerio Riedel2013-09-181-1/+1
| | | | | | | As `Traversable` needs at least one of `traverse` or `sequenceA` to be overridden. Signed-off-by: Herbert Valerio Riedel <hvr@gnu.org>
* Implement overlapping type family instances.Richard Eisenberg2012-12-211-5/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* Follow changes in GHCIan Lynagh2012-06-121-4/+4
|
* Follow refactoring of TyClDecl/HsTyDefnSimon Peyton Jones2012-03-261-4/+3
|
* Go back to having a doc, sub and decl map instead of one big decl map.David Waern2011-12-271-1/+1
| | | | | | | | | This setup makes more sense since when we add value bindings to the processed declarations (for type inference), we will have multiple declarations which should share documentation. Also, we already have a separate doc map for instances which we can now merge into the main doc map. Another benefit is that we don't need the DeclInfo type any longer.
* Slightly better behaviour on top-levels without type signatures.David Waern2011-12-031-1/+11
| | | | | | | | - Docs don't get attached to the next top-level with signature by mistake. - If there's an export list and the top-level is part of it, its doc comment shows up in the documentation.
* Fix module reference bug.David Waern2011-11-261-4/+0
|
* Remove #ifs for older compiler versions.David Waern2011-11-251-2/+0
|
* Use getDeclMainBinder instead of declNames.David Waern2011-11-061-7/+1
|
* Follow changes to ForeignImport/ForeignExport in GHCIan Lynagh2011-10-011-2/+2
|
* Fix buildIan Lynagh2011-06-171-2/+2
|
* * Merge in git patch from Michal TerepetaDavid Waern2011-06-111-8/+45
| | | | | | | | | | | | | | | | From 6fc71d067738ef4b7de159327bb6dc3d0596be29 Mon Sep 17 00:00:00 2001 From: Michal Terepeta <michal.terepeta@gmail.com> Date: Sat, 14 May 2011 19:18:22 +0200 Subject: [PATCH] Follow the change of TypeSig in GHC. This follows the change in GHC to make TypeSig take a list of names (instead of just one); GHC ticket #1595. This should also improve the Haddock output in case the user writes a type signature that refers to many names: -- | Some comment.. foo, bar :: ... will now generate the expected output with one signature for both names.
* Remove code for ghc < 7David Waern2010-11-151-10/+0
|
* follow changes in the GHC APISimon Marlow2010-10-271-1/+4
|
* Remove duplicate Outputable instance for Data.Map.MapIan Lynagh2010-09-151-5/+0
|
* Add source entity path to --read-interfaceDavid Waern2010-08-291-6/+1
| | | | | | | | | | | | | You can now use this flag like this: --read-interface=<html path>,<source entity path>,<.haddock file> By "source entity path" I mean the same thing that is specified with the --source-entity flag. The purpose of this is to be able to specify the source entity path per package, to allow source links to work in the presence of cross-package documentation. When given two arguments or less the --read-interface flag behaves as before.
* Style police in Haddock.GhcUtilsDavid Waern2010-07-211-6/+6
|
* Re-direct compilation output to a temporary directoryDavid Waern2010-05-141-0/+34
| | | | | Also add a flag --no-tmp-comp-dir that can be used to get the old behaviour of writing compilation files to GHC's output directory (default ".").
* Position the module header the same way everywhereDavid Waern2010-05-131-1/+0
| | | | Silly, but nice with some consistency :-)
* Fix build with GHC 6.12david.waern2010-03-291-0/+4
|
* Follow LazyUniqFM->UniqFM in GHCIan Lynagh2010-03-201-1/+1
|
* Fix build with GHC 6.12.1david.waern2010-03-181-4/+12
|
* Track change in HsUtils; and use a nicer function not an internal onesimonpj2010-03-041-2/+2
|
* Remove cruft due to compatibility with older GHCsDavid Waern2009-11-281-4/+2
|
* define unpackPackageId (it was removed from GHC)Simon Marlow2009-07-291-0/+17
|
* GhcUtils: ghc >= 6.10Isaac Dupree2009-08-231-4/+0
|
* Move doc parsing/lexing into Haddock for ghc>=6.11Isaac Dupree2009-08-231-2/+11
|
* Fix unused import warningsIan Lynagh2009-07-071-1/+0
|
* Add Haddock module headersDavid Waern2009-06-241-8/+12
| | | | | | | | | Add a proper Haddock module header to each module, with a more finegrained copyright. If you feel mis-accreditted, please correct any copyright notice! The maintainer field is set to haddock@projects.haskell.org. Next step is to add a brief description to each module.
* Move H.GHC.Utils to H.GhcUtilsDavid Waern2009-04-051-0/+195