Yi.Syntax

This module defines a common interface for syntax-awareness.

There have been many tens of wasted hours in this and lexer modules. This note is to commemorate those who have fallen in battle.

Documentation

data Highlighter cache syntax

The main type of syntax highlighters. This record type combines all the required functions, and is parametrized on the type of the internal state.

Constructors

SynHL

Fields

hlStartState :: cache

The start state for the highlighter.

hlRun :: Scanner Point Char -> Point -> cache -> cache

hlGetTree :: cache -> WindowRef -> syntax

hlFocus :: Map WindowRef Region -> cache -> cache

focus at a given point, and return the coresponding node. (hint -- the root can always be returned, at the cost of performance.)

data Cache state result

data Scanner st a

Constructors

Scanner

Fields

scanInit :: st

Initial state

scanLooked :: st -> Point

How far did the scanner look to produce this intermediate state? The state can be reused as long as nothing changes before that point.

scanEmpty :: a

scanRun :: st -> [(st, a)]

Running function returns a list of results and intermediate states. Note: the state is the state before producing the result in the second component.

Instances

Functor (Scanner st)

data ExtHL syntax

Constructors

forall cache . ExtHL (Highlighter cache syntax)

noHighlighter :: Highlighter () syntax

mkHighlighter :: forall state result. Show state => (Scanner Point Char -> Scanner state result) -> Highlighter (Cache state result) result

This takes as input a scanner that returns the "full" result at each element in the list; perhaps in a different form for the purpose of incremental-lazy eval.

skipScanner :: Int -> Scanner st a -> Scanner st a

emptyFileScan :: Scanner Point Char

newtype Point

A point in a buffer

Constructors

Point

Fields

fromPoint :: Int

Instances

Bounded Point

Enum Point

Eq Point

Integral Point

Num Point

Ord Point

Real Point

Show Point

Ix Point

Binary Point

Typeable * Point

SemiNum Point Size

newtype Size

Size of a buffer region

Constructors

Size

Fields

fromSize :: Int

Instances

Enum Size

Eq Size

Integral Size

Num Size

Ord Size

Real Size

Show Size

Binary Size

SemiNum Point Size

type Length = Int

type Stroke = Span StyleName

data Span a

Constructors

Span

Fields

spanBegin :: !Point

spanContents :: !a

spanEnd :: !Point

Instances

Functor Span

Foldable Span

Traversable Span

Show a => Show (Span a)