yi-0.6.2.3: The Haskell-Scriptable Editor Source code Contents Index

Yi.Syntax

Description

This module defines a common interface for syntax-awareness.

Synopsis

data Highlighter cache syntax = SynHL { hlStartState :: cache hlRun :: Scanner Point Char -> Point -> cache -> cache hlGetTree :: cache -> Int -> syntax hlFocus :: Map Int Region -> cache -> cache } data Cache state result data Scanner st a = Scanner { scanInit :: st scanLooked :: st -> Point scanEmpty :: a scanRun :: st -> [(st, a)] } data ExtHL syntax = 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 skipScanner :: Int -> Scanner st a -> Scanner st a emptyFileScan :: Scanner Point Char newtype Point = Point { fromPoint :: Int } newtype Size = Size { fromSize :: Int } type Length = Int type Stroke = Span StyleName data Span a = Span { spanBegin :: !Point spanContents :: !a spanEnd :: !Point }

Documentation

data Highlighter cache syntax Source

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 hlStartState :: cache The start state for the highlighter. hlRun :: Scanner Point Char -> Point -> cache -> cache hlGetTree :: cache -> Int -> syntax hlFocus :: Map Int 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 Source

data Scanner st a Source

Constructors Scanner 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 Source

Constructors forall cache . ExtHL (Highlighter cache syntax)

noHighlighter :: Highlighter () syntax Source

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

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 Source

emptyFileScan :: Scanner Point Char Source

newtype Point Source

A point in a buffer Constructors Point fromPoint :: Int Instances Bounded Point Enum Point Eq Point Integral Point Num Point Ord Point Real Point Show Point Ix Point Typeable Point Binary Point SemiNum Point Size

newtype Size Source

Size of a buffer region Constructors Size 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 Source

type Stroke = Span StyleName Source

data Span a Source

Constructors Span spanBegin :: !Point spanContents :: !a spanEnd :: !Point Instances Functor Span Foldable Span Traversable Span Show a => Show (Span a)

Produced by Haddock version 2.6.1