aboutsummaryrefslogtreecommitdiff
path: root/src/Haddock/Interface/Create.hs
Commit message (Collapse)AuthorAgeFilesLines
* Differentiate between TH splices (line-links) and regular namesNiklas Haas2014-03-091-22/+27
| | | | | | | | | | | | | | | | | 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-081-18/+35
| | | | | | 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.
* Add support for type/data familiesnand2014-02-111-71/+51
| | | | | | | | 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-10/+14
| | | | Signed-off-by: Austin Seipp <austin@well-typed.com>
* Per-module extension flags and language listing.Mateusz Kowalczyk2014-01-121-10/+15
| | | | | | | | | | | | | 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
* Revision to reflect new role annotation syntax in GHC.Richard Eisenberg2013-09-171-1/+1
|
* Updates to reflect changes in HsDecls to support closed type families.Richard Eisenberg2013-06-211-5/+8
|
* Merge branch 'ghc-7.6' into ghc-7.6-merge-2Kazu Yamamoto2013-02-011-44/+56
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | 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
| |
| * Improve haddock memory usageIan Lynagh2012-08-131-21/+34
| |
| * Merge branch 'dev' of https://github.com/sol/haddock into ghc-7.6David Waern2012-07-231-1/+2
| |\ | | | | | | | | | | | | 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
| | |
* | | Implement overlapping type family instances.Richard Eisenberg2012-12-211-9/+16
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 GHC: 'flags' has been renamed 'generalFlags'Ian Lynagh2012-10-181-1/+1
| | |
* | | Remove some temporary pragmas I accidentally recordedIan Lynagh2012-08-141-1/+0
| | |
* | | Improve haddock memory usageIan Lynagh2012-08-131-21/+34
|/ /
* | Forward port changes from stable.Paolo Capriotti2012-07-191-122/+197
|\|
| * Use a map for warnings, as suggested by @waernSimon Hengel2012-05-261-23/+20
| |
| * Simplify lookupWarningSimon Hengel2012-05-171-6/+8
| |
| * Attach warnings to `Documentation` typeSimon Hengel2012-05-171-40/+35
| |
| * newtype-wrap Doc nodes for things that may have warnings attachedSimon Hengel2012-05-171-5/+7
| |
| * Merge http://code.haskell.org/~thielema/haddock/ into ghc-7.4David Waern2012-05-161-12/+33
| |\
| | * qualification style 'abbreviated' -> 'aliased'Henning Thielemann2012-04-021-7/+7
| | |
| | * abbreviated qualification: use Packages.lookupModuleInAllPackages for ↵Henning Thielemann2012-04-021-10/+31
| | | | | | | | | | | | finding the package that a module belongs to
| * | Merge branch 'ghc-7.4' of http://darcs.haskell.org/haddock into ghc-7.4David Waern2012-05-151-1/+2
| |\ \ | | |/ | |/|
| | * Fix reporting of modules safe haskell mode (#5989)David Terei2012-04-061-1/+2
| | |
| * | 'abbreviate' qualification style - basic supportHenning Thielemann2012-04-011-0/+14
| |/ | | | | | | | | 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.
| * Don't filter out unexported names from the four maps - fixes a regression.David Waern2012-04-011-5/+4
| |
| * Cleanup.David Waern2012-04-011-12/+1
| |
| * Take reader environment directly from TypecheckedSource.David Waern2012-04-011-3/+11
| |
| * Mostly hlint-inspired cleanup.David Waern2012-02-041-12/+12
| |
| * Clean up some code from last SoC project.David Waern2012-02-041-34/+41
| |
| * Use <> instead of mappend.David Waern2012-02-041-3/+3
| |
| * Some cleanup and make sure we filter warnings through exports.David Waern2012-02-041-33/+47
| |
| * Fix issues in support for warnings.David Waern2012-02-041-24/+9
| | | | | | | | | | * Match against local names only. * Simplify (it's OK to map over the warnings).
| * Expand type signatures for modules without explicit export listSimon Hengel2012-02-041-1/+14
| |
| * Expand type signatures in export list (fixes #192)Simon Hengel2012-02-041-14/+5
| |
| * Add support for warningsSimon Hengel2012-02-041-2/+25
| |
| * Add support for module warningsSimon Hengel2012-02-041-1/+20
| |
| * Cleanup mkMaps and avoid quadratic behaviour.David Waern2012-02-011-28/+29
| |
| * Fix bug introduced in my recent refactoring.David Waern2012-02-011-16/+18
| |
* | Use right docMap to get decl documentation.Paolo Capriotti2012-06-221-1/+7
| |
* | Follow changes in GHCIan Lynagh2012-06-121-18/+18
| |
* | Follow changes in LHsTyVarBndrsSimon Peyton Jones2012-05-251-1/+1
| |
* | Track changes in HsSynSimon Peyton Jones2012-04-201-3/+3
| |