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

Yi.Lexer.Alex

Contents Names expected by Alex code Other things closely associated with the lexer Lexer actions Data produced by the scanner

Description

Utilities to turn a lexer generated by Alex into a scanner that can be used by Yi.

Synopsis

type AlexInput = (Char, IndexedStr) alexGetChar :: AlexInput -> Maybe (Char, AlexInput) alexInputPrevChar :: AlexInput -> Char data AlexState lexerState = AlexState { stLexer :: lexerState lookedOffset :: !Point stPosn :: !Posn } unfoldLexer :: ((AlexState lexState, input) -> Maybe (token, (AlexState lexState, input))) -> (AlexState lexState, input) -> [(AlexState lexState, token)] lexScanner :: forall lexerState token. ((AlexState lexerState, AlexInput) -> Maybe (token, (AlexState lexerState, AlexInput))) -> lexerState -> Scanner Point Char -> Scanner (AlexState lexerState) token alexCollectChar :: AlexInput -> [Char] actionConst :: token -> Action lexState token actionAndModify :: (lexState -> lexState) -> token -> Action lexState token actionStringAndModify :: (lexState -> lexState) -> (String -> token) -> Action lexState token actionStringConst :: (String -> token) -> Action lexState token data Tok t = Tok { tokT :: t tokLen :: Size tokPosn :: Posn } tokBegin :: forall t. Tok t -> Point tokEnd :: forall t. Tok t -> Point tokFromT :: forall t. t -> Tok t tokRegion :: Tok t -> Region data Posn = Posn { posnOfs :: !Point posnLine :: !Int posnCol :: !Int } startPosn :: Posn moveStr :: Posn -> IndexedStr -> Posn type ASI s = (AlexState s, AlexInput) (+~) :: SemiNum absolute relative => absolute -> relative -> absolute (~-) :: SemiNum absolute relative => absolute -> absolute -> relative newtype Size = Size { fromSize :: Int } type Stroke = Span StyleName tokToSpan :: Tok t -> Span t

Names expected by Alex code

type AlexInput = (Char, IndexedStr) Source

alexGetChar :: AlexInput -> Maybe (Char, AlexInput) Source

alexInputPrevChar :: AlexInput -> Char Source

Other things closely associated with the lexer

data AlexState lexerState Source

Lexer state Constructors AlexState stLexer :: lexerState lookedOffset :: !Point stPosn :: !Posn Instances Show lexerState => Show (AlexState lexerState)

unfoldLexer :: ((AlexState lexState, input) -> Maybe (token, (AlexState lexState, input))) -> (AlexState lexState, input) -> [(AlexState lexState, token)] Source

unfold lexer function into a function that returns a stream of (state x token)

lexScanner Source

:: forall lexerState token . => (AlexState lexerState, AlexInput) -> Maybe (token, (AlexState lexerState, AlexInput)) A lexer -> lexerState Initial user state for the lexer -> Scanner Point Char -> Scanner (AlexState lexerState) token Combine a character scanner with a lexer to produce a token scanner. May be used together with mkHighlighter to produce a Highlighter, or with linearSyntaxMode to produce a Mode.

alexCollectChar :: AlexInput -> [Char] Source

Lexer actions

actionConst :: token -> Action lexState token Source

Return a constant token

actionAndModify :: (lexState -> lexState) -> token -> Action lexState token Source

Return a constant token, and modify the lexer state

actionStringAndModify :: (lexState -> lexState) -> (String -> token) -> Action lexState token Source

Convert the parsed string into a token, and also modify the lexer state

actionStringConst :: (String -> token) -> Action lexState token Source

Convert the parsed string into a token

Data produced by the scanner

data Tok t Source

Constructors Tok tokT :: t tokLen :: Size tokPosn :: Posn Instances Functor Tok Show t => Show (Tok t) Strokable (Tok Token)

tokBegin :: forall t. Tok t -> Point Source

tokEnd :: forall t. Tok t -> Point Source

tokFromT :: forall t. t -> Tok t Source

tokRegion :: Tok t -> Region Source

data Posn Source

Constructors Posn posnOfs :: !Point posnLine :: !Int posnCol :: !Int Instances Eq Posn Ord Posn Show Posn Ix Posn

startPosn :: Posn Source

moveStr :: Posn -> IndexedStr -> Posn Source

type ASI s = (AlexState s, AlexInput) Source

(+~) :: SemiNum absolute relative => absolute -> relative -> absolute Source

(~-) :: SemiNum absolute relative => absolute -> absolute -> relative Source

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 Stroke = Span StyleName Source

tokToSpan :: Tok t -> Span t Source

Produced by Haddock version 2.6.1