| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
AlexTools
Synopsis
- initialInput :: Text -> Text -> Input
- initialInputAt :: SourcePos -> Text -> Input
- data Input = Input {}
- inputFile :: Input -> Text
- data Lexeme t = Lexeme {
- lexemeText :: !Text
- lexemeToken :: !t
- lexemeRange :: !SourceRange
- data SourcePos = SourcePos {
- sourceIndex :: !Int
- sourceLine :: !Int
- sourceColumn :: !Int
- sourceFile :: !Text
- startPos :: Text -> SourcePos
- beforeStartPos :: Text -> SourcePos
- prevPos :: SourcePos -> SourcePos
- data SourceRange = SourceRange {
- sourceFrom :: !SourcePos
- sourceTo :: !SourcePos
- prettySourcePos :: SourcePos -> String
- prettySourceRange :: SourceRange -> String
- prettySourcePosLong :: SourcePos -> String
- prettySourceRangeLong :: SourceRange -> String
- class HasRange t where
- range :: t -> SourceRange
- (<->) :: (HasRange a, HasRange b) => a -> b -> SourceRange
- moveSourcePos :: Char -> SourcePos -> SourcePos
- data Action s a
- lexeme :: t -> Action s [Lexeme t]
- matchLength :: Action s Int
- matchRange :: Action s SourceRange
- matchText :: Action s Text
- getLexerState :: Action s s
- setLexerState :: s -> Action s ()
- startInput :: Action s Input
- endInput :: Action s Input
- type AlexInput = Input
- alexInputPrevChar :: AlexInput -> Char
- makeAlexGetByte :: (Char -> Word8) -> AlexInput -> Maybe (Word8, AlexInput)
- makeLexer :: ExpQ
- data LexerConfig s t = LexerConfig {
- lexerInitialState :: s
- lexerStateMode :: s -> Int
- lexerEOF :: s -> SourcePos -> [Lexeme t]
- simpleLexer :: LexerConfig () t
- data Word8
Lexer Basics
Prepare the text for lexing.
Arguments
| :: SourcePos | Starting poistion |
| -> Text | The text to lex, not including any preceeding text |
| -> Input |
Prepare the text for lexing, starting at a particular position. This is useful when the document is not at the start of the file. Since: 0.6
Information about the lexer's input.
Constructors
| Lexeme | |
Fields
| |
Constructors
| SourcePos | |
Fields
| |
beforeStartPos :: Text -> SourcePos Source #
prevPos :: SourcePos -> SourcePos Source #
Move one position back. Assumes that newlines use a single bytes.
This function is intended to be used when starting the lexing somewhere in the middle of the input, for example, if we are implementing a quasi quoter, and the previous part of the input is not in our language.
data SourceRange Source #
A range in the source code.
Constructors
| SourceRange | |
Fields
| |
Instances
| HasRange SourceRange Source # | |
Defined in AlexTools Methods range :: SourceRange -> SourceRange Source # | |
| Show SourceRange Source # | |
Defined in AlexTools Methods showsPrec :: Int -> SourceRange -> ShowS # show :: SourceRange -> String # showList :: [SourceRange] -> ShowS # | |
| NFData SourceRange Source # | |
Defined in AlexTools Methods rnf :: SourceRange -> () # | |
| Eq SourceRange Source # | |
Defined in AlexTools | |
| Lift SourceRange Source # | |
Defined in AlexTools Methods lift :: Quote m => SourceRange -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => SourceRange -> Code m SourceRange # | |
prettySourcePos :: SourcePos -> String Source #
Pretty print the source position without the file name.
prettySourceRange :: SourceRange -> String Source #
Pretty print the range, without the file name
prettySourcePosLong :: SourcePos -> String Source #
Pretty print the source position, including the file name.
prettySourceRangeLong :: SourceRange -> String Source #
Pretty print the range, including the file name.
class HasRange t where Source #
Methods
range :: t -> SourceRange Source #
moveSourcePos :: Char -> SourcePos -> SourcePos Source #
Update a SourcePos for a particular matched character
Writing Lexer Actions
An action to be taken when a regular expression matchers.
Lexemes
lexeme :: t -> Action s [Lexeme t] Source #
Use the token and the current match to construct a lexeme.
matchLength :: Action s Int Source #
The number of characters in the matching input.
matchRange :: Action s SourceRange Source #
Get the range for the matching input.
Manipulating the lexer's state
getLexerState :: Action s s Source #
Acces the curent state of the lexer.
setLexerState :: s -> Action s () Source #
Change the state of the lexer.
Access to the lexer's input
startInput :: Action s Input Source #
Acces the input just before the regular expression started matching.
Interface with Alex
alexInputPrevChar :: AlexInput -> Char Source #
Generate a function to use an Alex lexer.
The expression is of type LexerConfig s t -> Input -> [Lexeme t]
data LexerConfig s t Source #
Lexer configuration.
Constructors
| LexerConfig | |
Fields
| |
simpleLexer :: LexerConfig () t Source #
A lexer that uses no lexer-modes, and does not emit anything at the end of the file.
8-bit unsigned integer type