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)

Methods

fmap :: (a -> b) -> Scanner st a -> Scanner st b

(<$) :: a -> Scanner st b -> Scanner st a

data ExtHL syntax

Constructors

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

Methods

minBound :: Point

maxBound :: Point

Enum Point

Methods

succ :: Point -> Point

pred :: Point -> Point

toEnum :: Int -> Point

fromEnum :: Point -> Int

enumFrom :: Point -> [Point]

enumFromThen :: Point -> Point -> [Point]

enumFromTo :: Point -> Point -> [Point]

enumFromThenTo :: Point -> Point -> Point -> [Point]

Eq Point

Methods

(==) :: Point -> Point -> Bool

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

Integral Point

Methods

quot :: Point -> Point -> Point

rem :: Point -> Point -> Point

div :: Point -> Point -> Point

mod :: Point -> Point -> Point

quotRem :: Point -> Point -> (Point, Point)

divMod :: Point -> Point -> (Point, Point)

toInteger :: Point -> Integer

Num Point

Methods

(+) :: Point -> Point -> Point

(-) :: Point -> Point -> Point

(*) :: Point -> Point -> Point

negate :: Point -> Point

abs :: Point -> Point

signum :: Point -> Point

fromInteger :: Integer -> Point

Ord Point

Methods

compare :: Point -> Point -> Ordering

(<) :: Point -> Point -> Bool

(<=) :: Point -> Point -> Bool

(>) :: Point -> Point -> Bool

(>=) :: Point -> Point -> Bool

max :: Point -> Point -> Point

min :: Point -> Point -> Point

Real Point

Methods

toRational :: Point -> Rational

Show Point

Methods

showsPrec :: Int -> Point -> ShowS

show :: Point -> String

showList :: [Point] -> ShowS

Ix Point

Methods

range :: (Point, Point) -> [Point]

index :: (Point, Point) -> Point -> Int

unsafeIndex :: (Point, Point) -> Point -> Int

inRange :: (Point, Point) -> Point -> Bool

rangeSize :: (Point, Point) -> Int

unsafeRangeSize :: (Point, Point) -> Int

Binary Point

Methods

put :: Point -> Put

get :: Get Point

putList :: [Point] -> Put

SemiNum Point Size

Methods

(+~) :: Point -> Size -> Point

(-~) :: Point -> Size -> Point

(~-) :: Point -> Point -> Size

newtype Size

Size of a buffer region

Constructors

Size

Fields

• fromSize :: Int

Instances

Enum Size

Methods

succ :: Size -> Size

pred :: Size -> Size

toEnum :: Int -> Size

fromEnum :: Size -> Int

enumFrom :: Size -> [Size]

enumFromThen :: Size -> Size -> [Size]

enumFromTo :: Size -> Size -> [Size]

enumFromThenTo :: Size -> Size -> Size -> [Size]

Eq Size

Methods

(==) :: Size -> Size -> Bool

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

Integral Size

Methods

quot :: Size -> Size -> Size

rem :: Size -> Size -> Size

div :: Size -> Size -> Size

mod :: Size -> Size -> Size

quotRem :: Size -> Size -> (Size, Size)

divMod :: Size -> Size -> (Size, Size)

toInteger :: Size -> Integer

Num Size

Methods

(+) :: Size -> Size -> Size

(-) :: Size -> Size -> Size

(*) :: Size -> Size -> Size

negate :: Size -> Size

abs :: Size -> Size

signum :: Size -> Size

fromInteger :: Integer -> Size

Ord Size

Methods

compare :: Size -> Size -> Ordering

(<) :: Size -> Size -> Bool

(<=) :: Size -> Size -> Bool

(>) :: Size -> Size -> Bool

(>=) :: Size -> Size -> Bool

max :: Size -> Size -> Size

min :: Size -> Size -> Size

Real Size

Methods

toRational :: Size -> Rational

Show Size

Methods

showsPrec :: Int -> Size -> ShowS

show :: Size -> String

showList :: [Size] -> ShowS

Binary Size

Methods

put :: Size -> Put

get :: Get Size

putList :: [Size] -> Put

SemiNum Point Size

Methods

(+~) :: Point -> Size -> Point

(-~) :: Point -> Size -> Point

(~-) :: Point -> Point -> Size

type Length = Int

type Stroke = Span StyleName

data Span a

Constructors

Span

Fields

• spanBegin :: !Point
• spanContents :: !a
• spanEnd :: !Point

Instances

Functor Span

Methods

fmap :: (a -> b) -> Span a -> Span b

(<$) :: a -> Span b -> Span a

Foldable Span

Methods

fold :: Monoid m => Span m -> m

foldMap :: Monoid m => (a -> m) -> Span a -> m

foldr :: (a -> b -> b) -> b -> Span a -> b

foldr' :: (a -> b -> b) -> b -> Span a -> b

foldl :: (b -> a -> b) -> b -> Span a -> b

foldl' :: (b -> a -> b) -> b -> Span a -> b

foldr1 :: (a -> a -> a) -> Span a -> a

foldl1 :: (a -> a -> a) -> Span a -> a

toList :: Span a -> [a]

null :: Span a -> Bool

length :: Span a -> Int

elem :: Eq a => a -> Span a -> Bool

maximum :: Ord a => Span a -> a

minimum :: Ord a => Span a -> a

sum :: Num a => Span a -> a

product :: Num a => Span a -> a

Traversable Span

Methods

traverse :: Applicative f => (a -> f b) -> Span a -> f (Span b)

sequenceA :: Applicative f => Span (f a) -> f (Span a)

mapM :: Monad m => (a -> m b) -> Span a -> m (Span b)

sequence :: Monad m => Span (m a) -> m (Span a)

Show a => Show (Span a)

Methods

showsPrec :: Int -> Span a -> ShowS

show :: Span a -> String

showList :: [Span a] -> ShowS