Version 4 (modified by simonpj, 2 years ago) (diff) |
---|

# Overloaded list notation

This wiki page documens the design and implementation of the GHC extension for overloading Haskell's list notation.

A preliminary implementation of the extension can be pulled from the following repositories:

git://github.com/achimkrause/ghc.git git://github.com/achimkrause/packages-base.git git://github.com/achimkrause/packages-dph.git git://github.com/achimkrause/testsuite.git

We would very much welcome contributions. If you would like to make a change in the current design and implementation, please document it (e.g., on this wiki page) and/or send us a GHC patch or a pull request.

## Current Implementation

Let us briefly recap the notation for constructing lists. In Haskell, the list notation can be be used in the following seven ways:

[] -- Empty list [x] -- x : [] [x,y,z] -- x : y : z : [] [x .. ] -- enumFrom x [x,y ..] -- enumFromThen x y [x .. y] -- enumFromTo x y [x,y .. z] -- enumFromThenTo x y z

When the `OverloadedLists` extension is turned on, the aforementioned seven
notations are desugared as follows:

[] -- fromListN 0 [] [x] -- fromListN 1 (x : []) [x,y,z] -- fromListN 3 (x : y : z : []) [x .. ] -- fromList (enumFrom x) [x,y ..] -- fromList (enumFromThen x y) [x .. y] -- fromList (enumFromTo x y) [x,y .. z] -- fromList (enumFromThenTo x y z)

This extension allows programmers to use the list notation for construction of
structures like: `Set`, `Map`, `IntMap`, `Vector`, `Text`
and `Array`. The following code listing gives a few examples:

['0' .. '9'] :: Set Char [1 .. 10] :: Vector Int [("default",0), (k1,v1)] :: Map String Int ['a' .. 'z'] :: Text

GHC, during the typechecking and desugaring phases, uses whatever is in scope
with the names of `fromList` and `fromListN` (i.e., `fromList` and
`fromListN` are rebindable).

That said, the `GHC.Exts` module exports the `FromList` class that can
be used to overload `fromListN` and `fromListN` for different
structures. The type class is defined as follows:

class FromList l where type Item l fromList :: [Item l] -> l fromListN :: Int -> [Item l] -> l fromListN _ = fromList

The `FromList` class and its methods are intended to be used in
conjunction with the `OverloadedLists` extension. The `Item` type
function returns the type of items of the structure `l`. The fromList
function constructs the structure `l` from the given list of `Item l`.
The `fromListN` function takes the input list's length as a hint. Its
behaviour should be equivalent to `fromList`. The hint can be used for
more efficient construction of the structure `l` compared to
`fromList`. If the given hint is not equal to the input list's length the
behaviour of `fromListN` is not specified.

In the following, we give several example instances of the `FromList` type
class:

instance FromList [a] where type Item [a] = a fromList = id instance (Ord a) => FromList (Set a) where type Item (Set a) = a fromList = Set.fromList instance (Ord k) => FromList (Map k v) where type Item (Map k v) = (k,v) fromList = Map.fromList instance FromList (IntMap v) where type Item (IntMap v) = (Int,v) fromList = IntMap.fromList instance FromList Text where type Item Text = Char fromList = Text.pack instance FromList (Vector a) where type Item (Vector a) = a fromList = Vector.fromList fromListN = Vector.fromListN

## TODO Overloading Pattern Matching on Lists

One way to overload list patterns is to replace the `FromList` class from
the previous section with the `OverloadedLists` class defined as follows:

class OverloadedLists l where type Item l fromList :: [Item l] -> l toList :: l -> [Item l] fromListN :: Int -> [Item l] -> l fromListN _ = fromList

This class allows us to view the structure `l` as a list. Now, the
`toList` can be used to overload the list notation in patters.
For example, When the `OverloadedLists` extension is turned on, the
definitions

f [] = ... g [x,y,z] = ...

will be treated as

f (toList -> []) = ... g (toList -> [x,y,z]) = ...

Here, just like for expressions, we propose to overload list patterns that use
square brackets. The `:` infix operator will remain list specific both in
expressions and patterns. In other words, `:` is not overloaded.

The instances of the `OverloadedLists` class should satisfy the following
property:

fromList . toList = id

The example `FromList` instances from the previous section can be extended
into the `OverloadedLists` instances as follows:

instance OverloadedLists [a] where type Item [a] = a fromList = id toList = id instance (Ord a) => OverloadedLists (Set a) where type Item (Set a) = a fromList = Set.fromList toList = Set.toList instance (Ord k) => OverloadedLists (Map k v) where type Item (Map k v) = (k,v) fromList = Map.fromList toList = Map.toList instance OverloadedLists (IntMap v) where type Item (IntMap v) = (Int,v) fromList = IntMap.fromList toList = IntMap.toList instance OverloadedLists Text where type Item Text = Char fromList = Text.pack toList = Text.unpack instance OverloadedLists (Vector a) where type Item (Vector a) = a fromList = Vector.fromList fromListN = Vector.fromListN toList = Vector.toList

## Further Improvements

## Defaulting

Currently, the `FromList` class is not accompanied with defaulting rules.
Although feasible, not much thought has gone into how to specify the meaning
of the default declarations like: `default ([a])`

## Literal Lists

The current implementation of the `OverloadedLists` extension can be
improved by handling the lists that are only populated with literals in a
special way. More specifically, the compiler could allocate such lists
statically using a compact representation and allow `FromList` instances
to take advantage of the compact representation. Equipped with this capability
the `OverloadedLists` extension will be in a good position to subsume the
`OverloadedStrings` extension (currently, as a special case, string
literals benefit from statically allocated compact representation).