Safe Haskell	None

Language.Haskell.Refact.Utils.TokenUtilsTypes

Contents

The cache of trees comprising the manipulated tokens
Structure of each tree

Description

This module contains types shared between TokenUtils and Monad, and exists to break import cycles

Synopsis

The cache of trees comprising the manipulated tokens

data TokenCache Source

Constructors

TK
Fields tkCache :: !(Map TreeId (Tree Entry)) tkLastTreeId :: !TreeId

data TreeId Source

Constructors

TId !Int

Instances

Eq TreeId
Ord TreeId
Show TreeId

mainTid :: TreeId Source

Identifies the tree carrying the main tokens, not any work in progress or deleted ones

Structure of each tree

data Entry Source

An entry in the data structure for a particular srcspan.

Constructors

Entry !ForestSpan !Layout ![PosToken]	The tokens for the SrcSpan if subtree is empty
Deleted !ForestSpan RowOffset SimpPos	The gap between this span end and the start of the next in the fringe of the tree. deriving (Show)

Instances

Eq Entry
Ord LayoutTree
Show Entry
Outputable Entry
Outputable (Tree Entry)

data Layout Source

Constructors

Above EndOffset (Row, Col) (Row, Col) EndOffset	Initial offset from token before the stacked list of items, the (r,c) of the first non-comment token, the (r,c) of the end of the last non-comment token in the stacked list to be able to calculate the (RowOffset,ColOffset) between the last token and the start of the next item.
NoChange

Instances

Eq Layout
Show Layout
Outputable Layout

data EndOffset Source

Constructors

None
SameLine ColOffset
FromAlignCol (RowOffset, ColOffset)

Instances

Eq EndOffset
Show EndOffset
Outputable EndOffset
Outputable EndOffset

type RowOffset = Int Source

type ColOffset = Int Source

type Row = Int Source

type Col = Int Source

data ForestLine Source

Constructors

ForestLine
Fields flSpanLengthChanged :: !Bool The length of the span may have changed due to updated tokens. flTreeSelector :: !Int flInsertVersion :: !Int flLine :: !Int

Instances

Eq ForestLine
Ord ForestLine
Show ForestLine
Outputable ForestLine

type ForestPos = (ForestLine, Int)Source

type ForestSpan = (ForestPos, ForestPos)Source

Match a SrcSpan, using a ForestLine as the marker

data PprOrigin Source

Constructors

Original	Original tokens
Added	Added tokens

Instances

Eq PprOrigin
Show PprOrigin
Outputable PprOrigin

data Ppr Source

A data structure to make the ppr process visible

Constructors

PprText Row Col PprOrigin String	Original row and col of the tokens making up the string
PprAbove EndOffset (Row, Col) EndOffset [Ppr]	Offset of start of embedded parts, coords of last token, offset to start of next part, relative to the column of the start
PprDeleted Row Col RowOffset RowOffset RowOffset	Marks lines that have been deleted together with the original gap before, how many lines were originally included, and gap after. And a note field for debugging

Instances

Eq Ppr
Show Ppr
Outputable Ppr