aboutsummaryrefslogtreecommitdiff
path: root/src/Haddock/Interface/AttachInstances.hs
Commit message (Collapse)AuthorAgeFilesLines
* Hide RHS of TFs with non-exported right hand sidesNiklas Haas2014-03-131-3/+2
| | | | | | 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-111-26/+29
| | | | | | This resolves fixity information not appearing across package borders. The binary file version has been increased accordingly.
* 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>
* Add support for type/data familiesnand2014-02-111-25/+32
| | | | | | | | 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>
* Updates to reflect changes in HsDecls to support closed type families.Richard Eisenberg2013-06-211-1/+1
|
* 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-011-13/+78
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
| * 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.
| * | Merge branch 'dev' of https://github.com/sol/haddock into ghc-7.6David Waern2012-07-231-1/+1
| |\ \ | | | | | | | | | | | | | | | | Conflicts: src/Haddock/InterfaceFile.hs
| | * | Use LANGUAGE pragmas instead of default-extensions in cabal fileSimon Hengel2012-05-271-1/+1
| | |/
* | | Use InstEnv.instanceSig rather than instanceHead (name change)Simon Peyton Jones2013-01-021-1/+1
| | |
* | | Implement overlapping type family instances.Richard Eisenberg2012-12-211-1/+1
|/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* | Add support for type-level literals.Iavor S. Diatchki2012-03-151-1/+4
| |
* | Follow rename of Instance to ClsInst in GHCIan Lynagh2012-01-031-1/+1
|/
* Go back to having a doc, sub and decl map instead of one big decl map.David Waern2011-12-271-6/+3
| | | | | | | | | 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.
* Remove #ifs for older compiler versions.David Waern2011-11-251-4/+0
|
* Adapt Haddock for the ConstraintKind extension changesMax Bolingbroke2011-09-061-2/+0
|
* Add git commits since switchover:David Waern2011-06-101-1/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* follow changes in the GHC APISimon Marlow2010-10-271-2/+9
|
* Fix a bug in attachInstancesDavid Waern2010-07-041-18/+39
| | | | | | | We didn't look for instance docs in all the interfaces of the package. This had the effect of instance docs not always showing up under a declaration. I took the opportunity to clean up the code in H.I.AttachInstances a bit as well. More cleanup is needed, however.
* Position the module header the same way everywhereDavid Waern2010-05-131-1/+0
| | | | Silly, but nice with some consistency :-)
* Rename HsDoc back into DocDavid Waern2009-11-281-1/+1
|
* Remove cruft due to compatibility with older GHCsDavid Waern2009-11-281-6/+0
|
* Remove Name from DocInstanceDavid Waern2009-11-281-1/+1
| | | | It's not used.
* Comments on instancesDavid Waern2009-11-241-12/+31
| | | | | | | | | | | | | | | 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
* Move toHsInstHead to Haddock.Convert and call it synifyInstHeadDavid Waern2009-09-061-10/+1
|
* Style policeDavid Waern2009-09-061-0/+1
|
* Add more copyright owners to H.I.AttachInstancesDavid Waern2009-09-061-1/+3
|
* re-implement function-argument docsIsaac Dupree2009-08-231-2/+3
| | | | | | | ..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.
* fix preprocessor conditional senseIsaac Dupree2009-08-171-1/+1
|
* Find instances using GHC, which is more complete.Isaac Dupree2009-08-181-38/+23
| | | | | | | | | | | In particular, it works cross-package. An intermediate patch also moved the instance-finding into createInterface, but that move turned out not to be necessary, so if we want to do that, it'd go in a separate patch. (Is that possible? Or will we need GHC to have loaded all the modules first, before we can go searching for the instances (e.g. if the modules are recursive or something)?)
* switch AttachInstances to use synify codeIsaac Dupree2009-08-181-37/+6
| | | | | | | | It changed an instance from showing ((,) a b) to (a, b) because my synify code is more sophisticated; I hope the latter is a good thing rather than a bad thing aesthetically, here. But this definitely reduces code duplication!
* Fix unused import warningsIan Lynagh2009-07-071-2/+0
|
* Add Haddock module headersDavid Waern2009-06-241-8/+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.
* hlint policeDavid Waern2009-04-011-3/+3
|
* hlint policeDavid Waern2009-04-011-1/+1
|
* -Wall police in H.I.AttachInstancesDavid Waern2009-03-281-13/+16
|
* Hide fynTyConName only for recent GHC versionsDavid Waern2009-02-251-0/+6
|
* Hide funTyConName, now exported by TypeRepsimonpj2009-02-021-1/+1
|
* Fix #61David Waern2008-10-161-2/+2
| | | | | | | | | | | | | | | | | | | We were not getting docs for re-exported class methods. This was because we were looking up the docs in a map made from the declarations in the current module being rendered. Obviously, re-exported class methods come from another module. Class methods and ATs were the only thing we were looking up using the doc map, everything else we found in the ExporItems. So now I've put subordinate docs in the ExportItem's directly, to make things a bit more consistent. To do this, I added subordinates to the the declarations in the declaration map. This was easy since we were computing subordinates anyway, to store stand-alone in the map. I added a new type synonym 'DeclInfo', which is what we call what is now stored in the map. This little refactoring removes duplicate code to retrieve subordinates and documentation from the HsGroup.
* Remove matching on NoteTy in AttachInstances, it has been removedDavid Waern2008-08-121-3/+1
|
* Support type equality predicatesDavid Waern2008-07-281-0/+1
|
* Preparation for rendering instances as separate declarationsDavid Waern2008-07-201-5/+6
| | | | | | | | | We want to be able to render instances as separate declarations. So we remove the Name argument of ExportDecl, since instances are nameless. This patch also contains the first steps needed to gather type family instances and display them in the backend, but the implementation is far from complete. Because of this, we don't actually show the instances yet.
* Remove filtering of instancesDavid Waern2008-07-071-2/+2
| | | | | | | We were filtering out all instances for types with unknown names. This was probably an attempt to filter out instances for internal types. I am removing the filtering for the moment, and will try to fix this properly later.
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-11 09:31:17 +0000