Gen

Generic interface for Term types.

Documentation

data Syntax

Syntactic annotations used for highlighting. This should be stored in the pretty-printed code output, in addition to term contexts.

Constructors

Type

type information

Keyword

standard keywords of the language

Literal

literal values (e.g. strings, numbers)

Unique

unique identifiers

Qualifier

qualifiers for modules

Custom String

used for user-supplied styling

Instances

Show Syntax

Defined in Gen

Methods

showsPrec :: Int -> Syntax -> ShowS

show :: Syntax -> String

showList :: [Syntax] -> ShowS

class Eq (Ctx term) => Diff term where

This is the typeclass that the user-supplied term type should implement. It requires all operations, which are necessary for our TUI to runn.

Minimal complete definition

ppr', patch

Associated Types

type Ann term :: *

The type of annotations associated to the given term type.

type Options term :: *

The type of options for the associated pretty-printer for term.

type Ctx term :: *

The type of navigation contexts for values of type term.

Methods

readHistory :: FilePath -> IO (History term (Ctx term))

Read a rewrite history from a binBooary file on disk.

readHistory :: (Binary term, Binary (Ctx term)) => FilePath -> IO (History term (Ctx term))

Read a rewrite history from a binBooary file on disk.

initialExpr :: History term (Ctx term) -> term

Given a rewrite history, extract the top-level initial expression.

topEntity :: String

If a binder containing this name exists, display first in the list of binders.

handleAnn :: Ann term -> Either Syntax (Ctx term)

Handle annotations of the pretty-printed code, emitting either syntax elements or navigation contexts.

handleAnn :: Ann term ~ Ctx term => Ann term -> Either Syntax (Ctx term)

Handle annotations of the pretty-printed code, emitting either syntax elements or navigation contexts.

userStyles :: [(String, Attr)]

User-supplied styling for the TUI.

initOptions :: Options term

Initial options for the pretty-printer.

initOptions :: Default (Options term) => Options term

Initial options for the pretty-printer.

flagFields :: [(Options term -> Bool, Options term -> Bool -> Options term, String)]

Provide the boolean flags of the pretty-printing options. NB: Lenses are not used here, due to impredicativity...

ppr' :: Options term -> term -> Doc (Ann term)

Pretty-print a given expression, given some options. The resulting document format should contain syntax/context annotations.

patch :: term -> [Ctx term] -> term -> term

Patch a given expression, given a navigation context to a sub-expression and a new sub-expression to replace it.

Rewrite history.

type History term ctx = [HStep term ctx]

The rewrite history consists of multiple single steps of rewriting.

data HStep term ctx

Each step of the rewrite history contains information about a single rewrite.

Constructors

HStep

Fields

• _ctx :: [ctx]

  the current context of the sub-expression being rewritten

• _bndrS :: String

  the name of the current binder

• _name :: String

  the name of the applied transformation

• _before :: term

  the sub-expression before rewriting

• _after :: term

  the sub-expression after rewriting

Instances

(Show ctx, Show term) => Show (HStep term ctx)

Defined in Gen

Methods

showsPrec :: Int -> HStep term ctx -> ShowS

show :: HStep term ctx -> String

showList :: [HStep term ctx] -> ShowS

Generic (HStep term ctx)

Defined in Gen

Associated Types

type Rep (HStep term ctx) :: Type -> Type

Methods

from :: HStep term ctx -> Rep (HStep term ctx) x

to :: Rep (HStep term ctx) x -> HStep term ctx

(Binary ctx, Binary term) => Binary (HStep term ctx)

Defined in Gen

Methods

put :: HStep term ctx -> Put

get :: Get (HStep term ctx)

putList :: [HStep term ctx] -> Put

type Rep (HStep term ctx)

Defined in Gen

type Rep (HStep term ctx) = D1 (MetaData "HStep" "Gen" "rewrite-inspector-0.1.0.11-inplace" False) (C1 (MetaCons "HStep" PrefixI True) ((S1 (MetaSel (Just "_ctx") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ctx]) :*: S1 (MetaSel (Just "_bndrS") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :*: (S1 (MetaSel (Just "_name") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: (S1 (MetaSel (Just "_before") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 term) :*: S1 (MetaSel (Just "_after") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 term)))))

name :: forall term ctx. Lens' (HStep term ctx) String

ctx :: forall term ctx ctx. Lens (HStep term ctx) (HStep term ctx) [ctx] [ctx]

bndrS :: forall term ctx. Lens' (HStep term ctx) String

before :: forall term ctx. Lens' (HStep term ctx) term

after :: forall term ctx. Lens' (HStep term ctx) term