aboutsummaryrefslogtreecommitdiff
path: root/src/Haddock/Interface/Rename.hs
Commit message (Collapse)AuthorAgeFilesLines
* Implement overlapping type family instances.Richard Eisenberg2012-12-211-37/+65
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* Forward port changes from stable.Paolo Capriotti2012-07-191-14/+24
|\
| * Add Applicative instance for (GenRnM a)Simon Hengel2012-05-261-2/+6
| |
| * Attach warnings to `Documentation` typeSimon Hengel2012-05-171-1/+2
| |
| * newtype-wrap Doc nodes for things that may have warnings attachedSimon Hengel2012-05-171-8/+6
| |
| * Mostly hlint-inspired cleanup.David Waern2012-02-041-8/+12
| |
| * Add DocWarning to DocSimon Hengel2012-02-041-0/+3
| | | | | | | | | | The Xhtml backend has special markup for that, Hoogle and LaTeX reuse what we have for DocEmphasis.
* | Follow changes for the implementation of implicit parametersSimon Peyton Jones2012-06-131-2/+1
| |
* | Follow changes in GHCIan Lynagh2012-06-121-3/+3
| |
* | Follow changes in LHsTyVarBndrsSimon Peyton Jones2012-05-251-3/+4
| |
* | Follow changes to LHsTyVarBndrsSimon Peyton Jones2012-05-111-14/+19
| |
* | Track changes in HsSynSimon Peyton Jones2012-04-201-7/+12
| |
* | Merge branch 'master' of http://darcs.haskell.org//haddockSimon Peyton Jones2012-03-261-0/+2
|\ \
| * | Add a missing case for type literals.Iavor S. Diatchki2012-03-191-0/+2
| | |
* | | Follow refactoring of TyClDecl/HsTyDefnSimon Peyton Jones2012-03-261-35/+45
|/ /
* | Follow changes to tcdKindSig (Trac #5937)Simon Peyton Jones2012-03-161-6/+9
| |
* | Follow changes in data representation from the big PolyKinds commitSimon Peyton Jones2012-03-021-7/+9
| |
* | Follow changes in GHCIan Lynagh2012-02-221-2/+2
| |
* | Follow changes in GHC caused by the CAPI CTYPE pragmaIan Lynagh2012-02-161-4/+4
| |
* | Track changes in HsDeclsSimon Peyton Jones2012-02-061-2/+5
|/
* Go back to having a doc, sub and decl map instead of one big decl map.David Waern2011-12-271-13/+6
| | | | | | | | | 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.
* Allow doc comments to link to out-of-scope things (#78).David Waern2011-11-261-0/+1
| | | | (A bug that should have been fixed long ago.)
* Give preference to type over data constructors for doc comment links at ↵David Waern2011-11-261-6/+4
| | | | | | | | | | | renaming time. Previously this was done in the backends. Also, warn when a doc comment refers to something that is in scope but which we don't have the .haddock file for. These changes mean we can make DocIdentifier [a] into DocIdentifier a.
* New kind-polymorphic coreJose Pedro Magalhaes2011-11-111-7/+20
| | | | | | | | | This big patch implements a kind-polymorphic core for GHC. The current implementation focuses on making sure that all kind-monomorphic programs still work in the new core; it is not yet guaranteed that kind-polymorphic programs (using the new -XPolyKinds flag) will work. For more information, see http://haskell.org/haskellwiki/GHC/Kinds
* Follow changes to ForeignImport/ForeignExport in GHCIan Lynagh2011-10-011-4/+4
|
* Merge branch 'no-pred-ty'Max Bolingbroke2011-09-091-25/+6
|\ | | | | | | | | Conflicts: src/Haddock/Convert.hs
| * Adapt Haddock for the ConstraintKind extension changesMax Bolingbroke2011-09-061-25/+6
| |
* | Ignore associated type defaults (just as we ignore default methods)Max Bolingbroke2011-09-091-2/+3
|/
* * Merge in git patch from Michal TerepetaDavid Waern2011-06-111-3/+3
| | | | | | | | | | | | | | | | 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.
* Add git commits since switchover:David Waern2011-06-101-2/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | darcs format (followed by a conflict resolution): commit 6f92cdd12d1354dfbd80f8323ca333bea700896a Merge: f420cc4 28df3a1 Author: Simon Peyton Jones <simonpj@microsoft.com> Date: Thu May 19 17:54:34 2011 +0100 Merge remote branch 'origin/master' into ghc-generics commit 28df3a119f770fdfe85c687dd73d5f6712b8e7d0 Author: Max Bolingbroke <batterseapower@hotmail.com> Date: Sat May 14 22:37:02 2011 +0100 Unicode fix for getExecDir on Windows commit 89813e729be8bce26765b95419a171a7826f6d70 Merge: 6df3a04 797ab27 Author: Simon Peyton Jones <simonpj@microsoft.com> Date: Mon May 9 11:55:17 2011 +0100 Merge branch 'ghc-new-co' commit 6df3a040da3dbddee67c6e30a892f87e6b164383 Author: Ian Lynagh <igloo@earth.li> Date: Sun May 8 17:05:50 2011 +0100 Follow changes in SDoc commit f420cc48b9259f0b1afd2438b12f9a2bde57053d Author: Jose Pedro Magalhaes <jpm@cs.uu.nl> Date: Wed May 4 17:31:52 2011 +0200 Adapt haddock to the removal of HsNumTy and TypePat. commit 797ab27bdccf39c73ccad374fea265f124cb52ea Merge: 1d81436 5a91450 Author: Simon Peyton Jones <simonpj@microsoft.com> Date: Mon May 2 12:05:03 2011 +0100 Merge remote branch 'origin/master' into ghc-new-co commit 1d8143659a81cf9611668348e33fd0775c7ab1d2 Author: Simon Peyton Jones <simonpj@microsoft.com> Date: Mon May 2 12:03:46 2011 +0100 Wibbles for ghc-new-co branch commit 5a91450e2ea5a93c70bd3904b022445c9cc82488 Author: Ian Lynagh <igloo@earth.li> Date: Fri Apr 22 00:51:56 2011 +0100 Follow defaultDynFlags change in GHC
* Position the module header the same way everywhereDavid Waern2010-05-131-1/+0
| | | | Silly, but nice with some consistency :-)
* Add markup support for interactive examplessimon.hengel2010-04-021-0/+1
|
* Rename HsDoc back into DocDavid Waern2009-11-281-3/+3
|
* Remove cruft due to compatibility with older GHCsDavid Waern2009-11-281-15/+1
|
* Remove Name from DocInstanceDavid Waern2009-11-281-3/+2
| | | | It's not used.
* Comments on instancesDavid Waern2009-11-241-3/+12
| | | | | | | | | | | | | | | Implementing this was a little trickier than I thought, since we need to match up instances from the renamed syntax with instances represented by InstEnv.Instance. This is due to the current design of Haddock, which matches comments with declarations from the renamed syntax, while getting the list of instances of a class/family directly using the GHC API. - Works for class instances only (Haddock has no support for type family instances yet) - The comments are rendered to the right of the instance head in the HTML output - No change to the .haddock file format - Works for normal user-written instances only. No comments are added on derived or TH-generated instances
* Haddock.Interface.Rename: eliminate warningsIsaac Dupree2009-08-231-1/+2
|
* re-implement function-argument docsIsaac Dupree2009-08-231-5/+16
| | | | | | | ..on top of the lexParseRn work. This patch doesn't change the InstalledInterface format, and thus, it does not work cross-package, but that will be easy to add subsequently.
* Move doc parsing/lexing into Haddock for ghc>=6.11Isaac Dupree2009-08-231-3/+10
|
* follow changes in GHC's ForeignTypeSimon Marlow2009-07-281-0/+6
|
* Fix unused import warningsIan Lynagh2009-07-071-1/+0
|
* Resolve conflictsIan Lynagh2009-07-051-1/+2
|
* Follow extra field in ConDeclsimonpj2009-07-021-2/+4
|
* Remove misplaced whitespace in H.I.RenameDavid Waern2009-06-271-42/+42
|
* Add Haddock module headersDavid Waern2009-06-241-5/+10
| | | | | | | | | 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-1/+1
|
* hlint policeDavid Waern2009-04-011-5/+5
|
* -Wall police in H.I.RenameDavid Waern2009-03-281-38/+49
|
* Define Foldable and Traversable instances for LocatedDavid Waern2009-03-271-2/+6
|
* Remove H.DocName and put DocName in H.TypesDavid Waern2009-03-271-1/+0
|
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-29 09:59:54 +0000