FastTags.LexerM

All the types and functions needed to make lexer run: - AlexInput - primary workhorse, an optimized representation of input stream as a pointer to utf8 bytes and our position within it. - Lexer monad AlexM - a monad (self-explanatory) with state that describes current lexing context. - AlexState - state of the lexing monad, maintains current Alex code, comment depth, quasiquoter depth, indentation size, whether we're in a literate mode (and in which one) or vanilla mode and whether there are any TH quasiquotes present till the end of file.

All the functions are to do with

Documentation

data AlexState

Constructors

AlexState

Fields

• asInput :: !AlexInput
• asIntStore :: !Word64

  Integer field that stores all the other useful fields for lexing.

• asContextStack :: [Context]

Instances

Eq AlexState

Defined in FastTags.LexerM

Methods

(==) :: AlexState -> AlexState -> Bool

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

Ord AlexState

Defined in FastTags.LexerM

Methods

compare :: AlexState -> AlexState -> Ordering

(<) :: AlexState -> AlexState -> Bool

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

(>) :: AlexState -> AlexState -> Bool

(>=) :: AlexState -> AlexState -> Bool

max :: AlexState -> AlexState -> AlexState

min :: AlexState -> AlexState -> AlexState

Show AlexState

Defined in FastTags.LexerM

Methods

showsPrec :: Int -> AlexState -> ShowS

show :: AlexState -> String

showList :: [AlexState] -> ShowS

mkAlexState :: LitMode Void -> AlexCode -> AlexInput -> AlexState

alexEnterBirdLiterateEnv :: MonadState AlexState m => m ()

alexEnterLiterateLatexEnv :: MonadState AlexState m => m ()

alexExitLiterateEnv :: MonadState AlexState m => m ()

pushContext :: MonadState AlexState m => Context -> m ()

modifyCommentDepth :: MonadState AlexState m => (Int16 -> Int16) -> m Int16

modifyQuasiquoterDepth :: MonadState AlexState m => (Int16 -> Int16) -> m Int16

modifyPreprocessorDepth :: MonadState AlexState m => (Int16 -> Int16) -> m Int16

addIndentationSize :: MonadState AlexState m => Int16 -> m ()

checkQuasiQuoteEndPresent :: Ptr Word8 -> Bool

type AlexM = WriterT [(AlexInput, TokenVal)] (State AlexState)

runAlexM :: FilePath -> Bool -> LitMode Void -> AlexCode -> ByteString -> AlexM a -> (a, [Token])

alexSetInput :: MonadState AlexState m => AlexInput -> m ()

alexSetNextCode :: MonadState AlexState m => AlexCode -> m ()

data AlexInput

Constructors

AlexInput

Fields

• aiPtr :: !(Ptr Word8)
• aiIntStore :: !Word64

  Integer field that stores all the other useful fields for lexing.

Instances

Eq AlexInput

Defined in FastTags.LexerM

Methods

(==) :: AlexInput -> AlexInput -> Bool

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

Ord AlexInput

Defined in FastTags.LexerM

Methods

compare :: AlexInput -> AlexInput -> Ordering

(<) :: AlexInput -> AlexInput -> Bool

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

(>) :: AlexInput -> AlexInput -> Bool

(>=) :: AlexInput -> AlexInput -> Bool

max :: AlexInput -> AlexInput -> AlexInput

min :: AlexInput -> AlexInput -> AlexInput

Show AlexInput

Defined in FastTags.LexerM

Methods

showsPrec :: Int -> AlexInput -> ShowS

show :: AlexInput -> String

showList :: [AlexInput] -> ShowS

aiLineL :: Lens' AlexInput Line

Current line in input stream.

takeText :: AlexInput -> Int -> Text

countInputSpace :: AlexInput -> Int -> Int

extractDefineOrLetName :: AlexInput -> Int -> Text

dropUntilNL :: AlexInput -> AlexInput

dropUntilUnescapedNL :: AlexInput -> AlexInput

dropUntilNLOr :: Word8 -> AlexInput -> AlexInput

dropUntilNLOrEither :: Word8 -> Word8 -> AlexInput -> AlexInput

Drop until either of two bytes.

unsafeTextHeadAscii :: Ptr Word8 -> Word8

unsafeTextHeadOfTailAscii :: Ptr Word8 -> Word8

unsafeTextHead :: Ptr Word8 -> Char

utf8BS :: Int -> Ptr Word8 -> ByteString

asCodeL :: Lens' AlexState AlexCode

Current Alex state the lexer is in. E.g. comments, string, TH quasiquoter or vanilla toplevel mode.

asCommentDepthL :: Lens' AlexState Int16

asQuasiquoterDepthL :: Lens' AlexState Int16

asIndentationSizeL :: Lens' AlexState Int16

asPreprocessorDepthL :: Lens' AlexState Int16

How many directives deep are we.

asLiterateLocL :: Lens' AlexState (LitMode LitStyle)

Whether we're in bird-style or latex-style literate environment

asHaveQQEndL :: Lens' AlexState (Maybe Bool)

Alex interface

alexInputPrevChar :: AlexInput -> Char

alexGetByte :: AlexInput -> Maybe (Word8, AlexInput)