Doug Wilson authored 7 years ago and Alex Biehl committed 7 years ago

* Use new function getNameToInstancesIndex instead of tcRnGetInfo

There is some significant performance improvement in the ghc testsuite.

haddock.base: -23.3%
haddock.Cabal: -16.7%
haddock.compiler: -19.8%

* Remove unused imports

Christiaan Baaij authored 7 years ago and Alex Biehl committed 7 years ago

* Haddock support for bundled pattern synonyms

* Add fixities to bundled pattern synonyms

* Add bundled pattern synonyms to the synopsis

* Store bundled pattern fixities in expItemFixities

* Add test for bundled pattern synonyms

* Stop threading fixities

* Include bundled pattern synonyms for re-exported data types

Sadly, fixity information isn't found for re-exported data types

* Support for pattern synonyms

* Modify tests after #631

* Test some reexport variations

* Also lookup bundled pattern synonyms from `InstalledInterface`s

* Check isExported for bundled pattern synonyms

* Pattern synonym is exported check

* Always look for pattern synonyms in the current module

Another overlooked cornercase

* Account for types named twice in export lists

Also introduce a fast function for nubbing on a `Name` and use it
throughout the code base.

* correct fixities for reexported pattern synonyms

* Fuse concatMap and map

* Remove obsolete import

* Add pattern synonyms to visible exports

* Fix test

* Remove corner case

Simon Peyton Jones authored 10 years ago and Matthew Pickering committed 9 years ago

This is made possible by the elimination of "silent superclass
parameters" in GHC

JeanPhilippeMoresmau authored 9 years ago and Mateusz Kowalczyk committed 9 years ago

Fixes #383

This is made possible by the elimination of "silent superclass
parameters" in GHC

This should at the very least not abort when something weird happens. It
does feel like we should have a type that carries these errors until the
end however as the user might not see them unless they are printed at
the end.

Niklas Haas authored 11 years ago and Mateusz Kowalczyk committed 11 years ago

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.

Currently, this check does not extend to hidden right hand sides,
although it probably should hide them in that case.

This resolves fixity information not appearing across package borders.

The binary file version has been increased accordingly.

Niklas Haas authored 11 years ago and Mateusz Kowalczyk committed 11 years ago

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>

nand authored 11 years ago and Mateusz Kowalczyk committed 11 years ago

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>

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.

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.

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.

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.

  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