Record pattern synonyms
authorMatthew Pickering <matthewtpickering@gmail.com>
Mon, 19 Oct 2015 20:17:29 +0000 (21:17 +0100)
committerBen Gamari <ben@smart-cactus.org>
Thu, 29 Oct 2015 11:24:21 +0000 (12:24 +0100)
commit2a74a64e8329ab9e0c74bec47198cb492d25affb
tree2f0ac8dc3f1d372062eba5a4945fad55580cf9f0
parenta0517889383127848faf82b32919d3f742a59278
Record pattern synonyms

This patch implements an extension to pattern synonyms which allows user
to specify pattern synonyms using record syntax. Doing so generates
appropriate selectors and update functions.

=== Interaction with Duplicate Record Fields ===

The implementation given here isn't quite as general as it could be with
respect to the recently-introduced `DuplicateRecordFields` extension.

Consider the following module:

    {-# LANGUAGE DuplicateRecordFields #-}
    {-# LANGUAGE PatternSynonyms #-}

    module Main where

    pattern S{a, b} = (a, b)
    pattern T{a}    = Just a

    main = do
      print S{ a = "fst", b = "snd" }
      print T{ a = "a" }

In principle, this ought to work, because there is no ambiguity. But at
the moment it leads to a "multiple declarations of a" error. The problem
is that pattern synonym record selectors don't do the same name mangling
as normal datatypes when DuplicateRecordFields is enabled. They could,
but this would require some work to track the field label and selector
name separately.

In particular, we currently represent datatype selectors in the third
component of AvailTC, but pattern synonym selectors are just represented
as Avails (because they don't have a corresponding type constructor).
Moreover, the GlobalRdrElt for a selector currently requires it to have
a parent tycon.

(example due to Adam Gundry)

=== Updating Explicitly Bidirectional Pattern Synonyms ===

Consider the following

```
pattern Silly{a} <- [a] where
  Silly a = [a, a]

f1 = a [5] -- 5

f2 = [5] {a = 6} -- currently [6,6]
```

=== Fixing Polymorphic Updates ===

They were fixed by adding these two lines in `dsExpr`. This might break
record updates but will be easy to fix.

```
+ ; let req_wrap = mkWpTyApps (mkTyVarTys univ_tvs)

- , pat_wrap = idHsWrapper }
+, pat_wrap = req_wrap }
```

=== Mixed selectors error ===

Note [Mixed Record Field Updates]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Consider the following pattern synonym.

    data MyRec = MyRec { foo :: Int, qux :: String }

    pattern HisRec{f1, f2} = MyRec{foo = f1, qux=f2}

This allows updates such as the following

    updater :: MyRec -> MyRec
    updater a = a {f1 = 1 }

It would also make sense to allow the following update (which we
reject).

    updater a = a {f1 = 1, qux = "two" } ==? MyRec 1 "two"

This leads to confusing behaviour when the selectors in fact refer the
same field.

    updater a = a {f1 = 1, foo = 2} ==? ???

For this reason, we reject a mixture of pattern synonym and normal
record selectors in the same update block. Although of course we still
allow the following.

    updater a = (a {f1 = 1}) {foo = 2}

    > updater (MyRec 0 "str")
    MyRec 2 "str"
60 files changed:
compiler/basicTypes/ConLike.hs
compiler/basicTypes/ConLike.hs-boot [new file with mode: 0644]
compiler/basicTypes/Id.hs
compiler/basicTypes/IdInfo.hs
compiler/basicTypes/PatSyn.hs
compiler/deSugar/Coverage.hs
compiler/deSugar/DsExpr.hs
compiler/deSugar/DsMeta.hs
compiler/hsSyn/Convert.hs
compiler/hsSyn/HsBinds.hs
compiler/hsSyn/HsExpr.hs
compiler/hsSyn/HsUtils.hs
compiler/hsSyn/PlaceHolder.hs
compiler/iface/BuildTyCl.hs
compiler/iface/IfaceSyn.hs
compiler/iface/MkIface.hs
compiler/iface/TcIface.hs
compiler/main/HscTypes.hs
compiler/parser/Parser.y
compiler/parser/RdrHsSyn.hs
compiler/prelude/TysWiredIn.hs
compiler/rename/RnBinds.hs
compiler/rename/RnExpr.hs
compiler/rename/RnNames.hs
compiler/rename/RnSource.hs
compiler/typecheck/TcBinds.hs
compiler/typecheck/TcExpr.hs
compiler/typecheck/TcHsSyn.hs
compiler/typecheck/TcPat.hs
compiler/typecheck/TcPatSyn.hs
compiler/typecheck/TcPatSyn.hs-boot
compiler/typecheck/TcRnDriver.hs
compiler/typecheck/TcTyClsDecls.hs
compiler/types/TyCon.hs
compiler/types/TypeRep.hs
compiler/types/TypeRep.hs-boot
testsuite/tests/patsyn/should_compile/all.T
testsuite/tests/patsyn/should_compile/records-compile.hs [new file with mode: 0644]
testsuite/tests/patsyn/should_compile/records-poly.hs [new file with mode: 0644]
testsuite/tests/patsyn/should_compile/records-prov-req.hs [new file with mode: 0644]
testsuite/tests/patsyn/should_compile/records-req-only.hs [new file with mode: 0644]
testsuite/tests/patsyn/should_compile/records-req.hs [new file with mode: 0644]
testsuite/tests/patsyn/should_fail/all.T
testsuite/tests/patsyn/should_fail/mixed-pat-syn-record-sels.hs [new file with mode: 0644]
testsuite/tests/patsyn/should_fail/mixed-pat-syn-record-sels.stderr [new file with mode: 0644]
testsuite/tests/patsyn/should_fail/records-check-sels.hs [new file with mode: 0644]
testsuite/tests/patsyn/should_fail/records-check-sels.stderr [new file with mode: 0644]
testsuite/tests/patsyn/should_fail/records-exquant.hs [new file with mode: 0644]
testsuite/tests/patsyn/should_fail/records-exquant.stderr [new file with mode: 0644]
testsuite/tests/patsyn/should_fail/records-mixing-fields.hs [new file with mode: 0644]
testsuite/tests/patsyn/should_fail/records-mixing-fields.stderr [new file with mode: 0644]
testsuite/tests/patsyn/should_fail/records-no-uni-update.hs [new file with mode: 0644]
testsuite/tests/patsyn/should_fail/records-no-uni-update.stderr [new file with mode: 0644]
testsuite/tests/patsyn/should_fail/records-no-uni-update2.hs [new file with mode: 0644]
testsuite/tests/patsyn/should_fail/records-no-uni-update2.stderr [new file with mode: 0644]
testsuite/tests/patsyn/should_fail/records-poly-update.hs [new file with mode: 0644]
testsuite/tests/patsyn/should_fail/records-poly-update.stderr [new file with mode: 0644]
testsuite/tests/patsyn/should_run/all.T
testsuite/tests/patsyn/should_run/records-run.hs [new file with mode: 0644]
testsuite/tests/patsyn/should_run/records-run.stdout [new file with mode: 0644]