Struct antlr_rust::lexer::BaseLexer

source · [−]

pub struct BaseLexer<'input, T: LexerRecog<'input, Self> + 'static, Input: CharStream<TF::From>, TF: TokenFactory<'input> = CommonTokenFactory> {
    pub interpreter: Option<Box<LexerATNSimulator>>,
    pub input: Option<Input>,
    pub token_start_char_index: isize,
    pub token_start_line: isize,
    pub token_start_column: isize,
    pub token_type: isize,
    pub token: Option<TF::Tok>,
    pub channel: isize,
    pub mode_stack: Vec<usize>,
    pub mode: usize,
    pub text: Option<<TF::Data as ToOwned>::Owned>,
    /* private fields */
}

Expand description

Default implementation of Lexer

Public fields in this struct are intended to be used by embedded actions

Fields

interpreter: Option<Box<LexerATNSimulator>>

LexerATNSimulator instance of this lexer

input: Option<Input>

CharStream used by this lexer

token_start_char_index: isizetoken_start_line: isizetoken_start_column: isizetoken_type: isize

Overrides token type emitted by lexer for current token

token: Option<TF::Tok>

Make it Some to override token that is currently being generated by lexer

channel: isize

Channel lexer is currently assigning tokens to

mode_stack: Vec<usize>

stack of modes, which is used for pushMode,popMode lexer actions

mode: usize

Mode lexer is currently in

text: Option<<TF::Data as ToOwned>::Owned>

Make it Some to override text for token that is currently being generated by lexer

Implementations

source

impl<'input, T, Input, TF> BaseLexer<'input, T, Input, TF> where
 T: LexerRecog<'input, Self> + 'static,
 Input: CharStream<TF::From>,
 TF: TokenFactory<'input>,

source

pub fn get_char_index(&self) -> isize

Current position in input stream

source

pub fn get_text<'a>(&'a self) -> Cow<'a, TF::Data> where
'input: 'a,

Current token text

source

pub fn set_text(&mut self, _text: <TF::Data as ToOwned>::Owned)

Used from lexer actions to override text of the token that will be emitted next

source

pub fn add_error_listener(
&mut self,
listener: Box<dyn ErrorListener<'input, Self>>
)

Add error listener

source

pub fn remove_error_listeners(&mut self)

Remove and drop all error listeners

source

pub fn new_base_lexer(
    input: Input,
    interpreter: LexerATNSimulator,
    recog: T,
    factory: &'input TF
) -> Self

Creates new lexer instance

Trait Implementations

source

impl<'input, T, Input, TF> Deref for BaseLexer<'input, T, Input, TF> where
 T: LexerRecog<'input, Self> + 'static,
 Input: CharStream<TF::From>,
 TF: TokenFactory<'input>,

type Target = T

The resulting type after dereferencing.

source

fn deref(&self) -> &Self::Target

Dereferences the value.

source

impl<'input, T, Input, TF> DerefMut for BaseLexer<'input, T, Input, TF> where
 T: LexerRecog<'input, Self> + 'static,
 Input: CharStream<TF::From>,
 TF: TokenFactory<'input>,

source

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

source

impl<'input, T, Input, TF> Lexer<'input> for BaseLexer<'input, T, Input, TF> where
 T: LexerRecog<'input, Self> + 'static,
 Input: CharStream<TF::From>,
 TF: TokenFactory<'input>,

type Input = Input

Concrete input stream used by this parser

source

fn input(&mut self) -> &mut Self::Input

Same as TokenStream::get_input_stream but returns concrete type instance important for proper inlining in hot code of LexerATNSimulator Read more

source

fn set_channel(&mut self, v: isize)

Sets channel where current token will be pushed Read more

source

fn push_mode(&mut self, m: usize)

Pushes current mode to internal mode stack and sets m as current lexer mode `pop_mode should be used to recover previous mode Read more

source

fn pop_mode(&mut self) -> Option<usize>

Pops mode from internal mode stack

source

fn set_type(&mut self, t: isize)

Sets type of the current token Called from action to override token that will be emitted by lexer Read more

source

fn set_mode(&mut self, m: usize)

Sets lexer mode discarding current one

source

fn more(&mut self)

Used to informs lexer that it should consider next token as a continuation of the current one

source

fn skip(&mut self)

Tells lexer to completely ignore and not emit current token.

source

impl<'input, T, Input, TF> TokenSource<'input> for BaseLexer<'input, T, Input, TF> where
 T: LexerRecog<'input, Self> + 'static,
 Input: CharStream<TF::From>,
 TF: TokenFactory<'input>,

type TF = TF

TokenFactory this token source produce tokens with

source

fn next_token(&mut self) -> <Self::TF as TokenFactory<'input>>::Tok

Return a {@link Token} object from your input stream (usually a {@link CharStream}). Do not fail/return upon lexing error; keep chewing on the characters until you get a good one; errors are not passed through to the parser. Read more

source

fn get_line(&self) -> isize

Get the line number for the current position in the input stream. The first line in the input is line 1. Read more

source

fn get_char_position_in_line(&self) -> isize

Get the index into the current line for the current position in the input stream. The first character on a line has position 0. Read more

source

fn get_input_stream(&mut self) -> Option<&mut dyn IntStream>

Returns underlying input stream

source

fn get_source_name(&self) -> String

Returns string identifier of underlying input e.g. file name

source

fn get_token_factory(&self) -> &'input TF

Gets the TokenFactory this token source is currently using for creating Token objects from the input. Read more

Auto Trait Implementations

impl<'input, T, Input, TF = CommonTokenFactory> !RefUnwindSafe for BaseLexer<'input, T, Input, TF>

impl<'input, T, Input, TF = CommonTokenFactory> !Send for BaseLexer<'input, T, Input, TF>

impl<'input, T, Input, TF = CommonTokenFactory> !Sync for BaseLexer<'input, T, Input, TF>

impl<'input, T, Input, TF> Unpin for BaseLexer<'input, T, Input, TF> where
 Input: Unpin,
 T: Unpin,
 <<TF as TokenFactory<'input>>::Data as ToOwned>::Owned: Unpin,
 <TF as TokenFactory<'input>>::Tok: Unpin,

impl<'input, T, Input, TF = CommonTokenFactory> !UnwindSafe for BaseLexer<'input, T, Input, TF>

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> AnyExt for T where
T: Any + ?Sized,

source

fn downcast_ref<T>(this: &Self) -> Option<&T> where
T: Any,

Attempts to downcast this to T behind reference

source

fn downcast_mut<T>(this: &mut Self) -> Option<&mut T> where
T: Any,

Attempts to downcast this to T behind mutable reference

source

fn downcast_rc<T>(this: Rc<Self>) -> Result<Rc<T>, Rc<Self>> where
T: Any,

Attempts to downcast this to T behind Rc pointer

source

fn downcast_arc<T>(this: Arc<Self>) -> Result<Arc<T>, Arc<Self>> where
T: Any,

Attempts to downcast this to T behind Arc pointer

source

fn downcast_box<T>(
this: Box<Self, Global>
) -> Result<Box<T, Global>, Box<Self, Global>> where
T: Any,

Attempts to downcast this to T behind Box pointer

source

fn downcast_move<T>(this: Self) -> Option<T> where
T: Any,

Attempts to downcast owned Self to T, useful only in generic context as a workaround for specialization Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T, X> CoerceTo<T> for X where
T: CoerceFrom<X> + ?Sized,

source

fn coerce_rc_to(self: Rc<X>) -> Rc<T>

source

fn coerce_box_to(self: Box<X, Global>) -> Box<T, Global>ⓘNotable traits for Box<W, Global>`impl<W> Write for Box<W, Global> where W: Write + ?Sized, impl<R> Read for Box<R, Global> where R: Read + ?Sized, impl<I, A> Iterator for Box<I, A> where I: Iterator + ?Sized, A: Allocator, type Item = ::Item;impl<F, A> Future for Box<F, A> where F: Future + Unpin + ?Sized, A: Allocator + 'static, type Output = <F as Future>::Output;`

source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct antlr_rust::lexer::BaseLexer

Fields

Implementations

impl<'input, T, Input, TF> BaseLexer<'input, T, Input, TF> where T: LexerRecog<'input, Self> + 'static, Input: CharStream<TF::From>, TF: TokenFactory<'input>,

pub fn get_char_index(&self) -> isize

pub fn get_text<'a>(&'a self) -> Cow<'a, TF::Data> where 'input: 'a,

pub fn set_text(&mut self, _text: <TF::Data as ToOwned>::Owned)

pub fn add_error_listener( &mut self, listener: Box<dyn ErrorListener<'input, Self>>)

pub fn remove_error_listeners(&mut self)

pub fn new_base_lexer( input: Input, interpreter: LexerATNSimulator, recog: T, factory: &'input TF) -> Self

Trait Implementations

impl<'input, T, Input, TF> Deref for BaseLexer<'input, T, Input, TF> where T: LexerRecog<'input, Self> + 'static, Input: CharStream<TF::From>, TF: TokenFactory<'input>,

type Target = T

fn deref(&self) -> &Self::Target

impl<'input, T, Input, TF> DerefMut for BaseLexer<'input, T, Input, TF> where T: LexerRecog<'input, Self> + 'static, Input: CharStream<TF::From>, TF: TokenFactory<'input>,

fn deref_mut(&mut self) -> &mut Self::Target

impl<'input, T, Input, TF> Lexer<'input> for BaseLexer<'input, T, Input, TF> where T: LexerRecog<'input, Self> + 'static, Input: CharStream<TF::From>, TF: TokenFactory<'input>,

type Input = Input

fn input(&mut self) -> &mut Self::Input

fn set_channel(&mut self, v: isize)

fn push_mode(&mut self, m: usize)

fn pop_mode(&mut self) -> Option<usize>

fn set_type(&mut self, t: isize)

fn set_mode(&mut self, m: usize)

fn more(&mut self)

fn skip(&mut self)

impl<'input, T, Input, TF> TokenSource<'input> for BaseLexer<'input, T, Input, TF> where T: LexerRecog<'input, Self> + 'static, Input: CharStream<TF::From>, TF: TokenFactory<'input>,

type TF = TF

fn next_token(&mut self) -> <Self::TF as TokenFactory<'input>>::Tok

fn get_line(&self) -> isize

fn get_char_position_in_line(&self) -> isize

fn get_input_stream(&mut self) -> Option<&mut dyn IntStream>

fn get_source_name(&self) -> String

fn get_token_factory(&self) -> &'input TF

Auto Trait Implementations

impl<'input, T, Input, TF = CommonTokenFactory> !RefUnwindSafe for BaseLexer<'input, T, Input, TF>

impl<'input, T, Input, TF = CommonTokenFactory> !Send for BaseLexer<'input, T, Input, TF>

impl<'input, T, Input, TF = CommonTokenFactory> !Sync for BaseLexer<'input, T, Input, TF>

impl<'input, T, Input, TF> Unpin for BaseLexer<'input, T, Input, TF> where Input: Unpin, T: Unpin, <<TF as TokenFactory<'input>>::Data as ToOwned>::Owned: Unpin, <TF as TokenFactory<'input>>::Tok: Unpin,

impl<'input, T, Input, TF = CommonTokenFactory> !UnwindSafe for BaseLexer<'input, T, Input, TF>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> AnyExt for T where T: Any + ?Sized,

fn downcast_ref<T>(this: &Self) -> Option<&T> where T: Any,

fn downcast_mut<T>(this: &mut Self) -> Option<&mut T> where T: Any,

fn downcast_rc<T>(this: Rc<Self>) -> Result<Rc<T>, Rc<Self>> where T: Any,

fn downcast_arc<T>(this: Arc<Self>) -> Result<Arc<T>, Arc<Self>> where T: Any,

fn downcast_box<T>( this: Box<Self, Global>) -> Result<Box<T, Global>, Box<Self, Global>> where T: Any,

fn downcast_move<T>(this: Self) -> Option<T> where T: Any,

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T, X> CoerceTo<T> for X where T: CoerceFrom<X> + ?Sized,

fn coerce_rc_to(self: Rc<X>) -> Rc<T>

fn coerce_ref_to(&self) -> &T

fn coerce_mut_to(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<'input, T, Input, TF> BaseLexer<'input, T, Input, TF> where
T: LexerRecog<'input, Self> + 'static,
Input: CharStream<TF::From>,
TF: TokenFactory<'input>,

pub fn get_text<'a>(&'a self) -> Cow<'a, TF::Data> where
'input: 'a,

pub fn add_error_listener(
&mut self,
listener: Box<dyn ErrorListener<'input, Self>>
)

pub fn new_base_lexer(
input: Input,
interpreter: LexerATNSimulator,
recog: T,
factory: &'input TF
) -> Self

impl<'input, T, Input, TF> Deref for BaseLexer<'input, T, Input, TF> where
T: LexerRecog<'input, Self> + 'static,
Input: CharStream<TF::From>,
TF: TokenFactory<'input>,

impl<'input, T, Input, TF> DerefMut for BaseLexer<'input, T, Input, TF> where
T: LexerRecog<'input, Self> + 'static,
Input: CharStream<TF::From>,
TF: TokenFactory<'input>,

impl<'input, T, Input, TF> Lexer<'input> for BaseLexer<'input, T, Input, TF> where
T: LexerRecog<'input, Self> + 'static,
Input: CharStream<TF::From>,
TF: TokenFactory<'input>,

impl<'input, T, Input, TF> TokenSource<'input> for BaseLexer<'input, T, Input, TF> where
T: LexerRecog<'input, Self> + 'static,
Input: CharStream<TF::From>,
TF: TokenFactory<'input>,

impl<'input, T, Input, TF> Unpin for BaseLexer<'input, T, Input, TF> where
Input: Unpin,
T: Unpin,
<<TF as TokenFactory<'input>>::Data as ToOwned>::Owned: Unpin,
<TF as TokenFactory<'input>>::Tok: Unpin,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> AnyExt for T where
T: Any + ?Sized,

fn downcast_ref<T>(this: &Self) -> Option<&T> where
T: Any,

fn downcast_mut<T>(this: &mut Self) -> Option<&mut T> where
T: Any,

fn downcast_rc<T>(this: Rc<Self>) -> Result<Rc<T>, Rc<Self>> where
T: Any,

fn downcast_arc<T>(this: Arc<Self>) -> Result<Arc<T>, Arc<Self>> where
T: Any,

fn downcast_box<T>(
this: Box<Self, Global>
) -> Result<Box<T, Global>, Box<Self, Global>> where
T: Any,

fn downcast_move<T>(this: Self) -> Option<T> where
T: Any,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, X> CoerceTo<T> for X where
T: CoerceFrom<X> + ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,