Data.HDiff.Diff.Types

Documentation

data DiffOpaques

Controls the sharing of opaque values.

Constructors

DO_Never

Never share opaque values

DO_OnSpine

Only share opaque values that appear on the spine.

DO_AsIs

Handle values of type K k normally, as we handle recursive trees, of type I i.

Instances

Eq DiffOpaques

Defined in Data.HDiff.Diff.Types

Methods

(==) :: DiffOpaques -> DiffOpaques -> Bool

(/=) :: DiffOpaques -> DiffOpaques -> Bool

Show DiffOpaques

Defined in Data.HDiff.Diff.Types

Methods

showsPrec :: Int -> DiffOpaques -> ShowS

show :: DiffOpaques -> String

showList :: [DiffOpaques] -> ShowS

data DiffMode

Diffing Algorithm modes. This is better illustrated with an example. Supposte we have the following source and destination trees:

src = Bin (Bin t k) u
dst = Bin (Bin t k) t

Constructors

DM_ProperShare

The proper share algorithm will only share the trees that are supposed to be a proper share. With the src and dst above, it will produce:

diff src dst = Bin (Bin 0 1) u |-> Bin (Bin 0 1) 0

A good intuition is that this approach will prefer maximum sharing as opposed to sharing bigger trees.

DM_NoNested

The first algoritm we produced. Does not share nested trees. In fact, with this mode we will get the following result:

diff src dst = Bin 0 u |-> Bin 0 t

DM_Patience

Similar to git --patience, we share only unique trees. In this example, this would result in the same as DM_NoNested, but if we take u = (Bin t k), no sharing would be performed whatsoever.

Instances

Enum DiffMode

Defined in Data.HDiff.Diff.Types

Methods

succ :: DiffMode -> DiffMode

pred :: DiffMode -> DiffMode

toEnum :: Int -> DiffMode

fromEnum :: DiffMode -> Int

enumFrom :: DiffMode -> [DiffMode]

enumFromThen :: DiffMode -> DiffMode -> [DiffMode]

enumFromTo :: DiffMode -> DiffMode -> [DiffMode]

enumFromThenTo :: DiffMode -> DiffMode -> DiffMode -> [DiffMode]

Eq DiffMode

Defined in Data.HDiff.Diff.Types

Methods

(==) :: DiffMode -> DiffMode -> Bool

(/=) :: DiffMode -> DiffMode -> Bool

Show DiffMode

Defined in Data.HDiff.Diff.Types

Methods

showsPrec :: Int -> DiffMode -> ShowS

show :: DiffMode -> String

showList :: [DiffMode] -> ShowS

data DiffOptions

Specifies the options for the diffing algorithm

Constructors

DiffOptions

Minimum height of trees considered for sharing

Fields

• doMinHeight :: Int
• doOpaqueHandling :: DiffOpaques
• doMode :: DiffMode

Instances

Eq DiffOptions

Defined in Data.HDiff.Diff.Types

Methods

(==) :: DiffOptions -> DiffOptions -> Bool

(/=) :: DiffOptions -> DiffOptions -> Bool

Show DiffOptions

Defined in Data.HDiff.Diff.Types

Methods

showsPrec :: Int -> DiffOptions -> ShowS

show :: DiffOptions -> String

showList :: [DiffOptions] -> ShowS

diffOptionsDefault :: DiffOptions

type IsSharedMap = Trie MetavarAndArity

The data structure that captures which subtrees are shared between source and destination. Besides providing an efficient answer to the query: "is this tree shared?", it also gives a unique identifier to that tree, allowing us to easily build our n-holed treefix.

data MetavarAndArity

Constructors

MAA

Fields

• getMetavar :: Int
• getArity :: Int

Instances

Eq MetavarAndArity

Defined in Data.HDiff.Diff.Types

Methods

(==) :: MetavarAndArity -> MetavarAndArity -> Bool

(/=) :: MetavarAndArity -> MetavarAndArity -> Bool

Show MetavarAndArity

Defined in Data.HDiff.Diff.Types

Methods

showsPrec :: Int -> MetavarAndArity -> ShowS

show :: MetavarAndArity -> String

showList :: [MetavarAndArity] -> ShowS

type MinHeight = Int

A tree smaller than the minimum height will never be shared.