Data.Generics.Fixplate.Base

The core types of Fixplate.

Documentation

attribute :: Attr f a -> a

The attribute of the root node.

forget :: Functor f => Attr f a -> Mu f

A function forgetting all the attributes from an annotated tree.

newtype Mu f

The fixed-point type.

Constructors

Fix

Fields

unFix :: f (Mu f)

Instances

EqF f => Eq (Mu f)

OrdF f => Ord (Mu f)

ReadF f => Read (Mu f)

ShowF f => Show (Mu f)

data Ann f a b

Annotations.

Constructors

Ann

Fields

attr :: a

unAnn :: f b

Instances

Functor f => Functor (Ann f a)

Foldable f => Foldable (Ann f a)

Traversable f => Traversable (Ann f a)

(Read a, ReadF f) => ReadF (Ann f a)

(Show a, ShowF f) => ShowF (Ann f a)

(Ord a, OrdF f) => OrdF (Ann f a)

(Eq a, EqF f) => EqF (Ann f a)

type Attr f a = Mu (Ann f a)

Annotated fixed-point type.

class EqF f where

"Functorised" versions of standard type classes. If you have your own structure functor, for example

 Expr e 
   = Kst Int 
   | Var String 
   | Add e e 
   deriving (Eq,Ord,Read,Show,Functor,Foldable,Traversable)

you should make it an instance of these, so that the fixed-point type Mu Expr can be an instance of Eq, Ord and Show. Doing so is very easy:

 instance EqF   Expr where equalF     = (==)
 instance OrdF  Expr where compareF   = compare
 instance ShowF Expr where showsPrecF = showsPrec

The Read instance depends on whether we are using GHC or not. The Haskell98 version is

 instance ReadF Expr where readsPrecF = readsPrec

while the GHC version is

 instance ReadF Expr where readPrecF  = readPrec

Methods

equalF :: Eq a => f a -> f a -> Bool

Instances

(Eq a, EqF f) => EqF (Ann f a)

class EqF f => OrdF f where

Methods

compareF :: Ord a => f a -> f a -> Ordering

Instances

(Ord a, OrdF f) => OrdF (Ann f a)

class ShowF f where

Methods

showsPrecF :: Show a => Int -> f a -> ShowS

Instances

(Show a, ShowF f) => ShowF (Ann f a)

class ReadF f where

Methods

readPrecF :: Read a => ReadPrec (f a)

Instances

(Read a, ReadF f) => ReadF (Ann f a)

newtype Attrib f a

A newtype wrapper around Attr f a so that we can make Attr f an instance of Functor, Foldable and Traversable. This is necessary since Haskell does not allow partial application of type synonyms.

Constructors

Attrib

Fields

unAttrib :: Attr f a

Instances

Functor f => Functor (Attrib f)

Foldable f => Foldable (Attrib f)

Traversable f => Traversable (Attrib f)

(ShowF f, Show a) => Show (Attrib f a)