1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
use super::internal::LexerInternal;
use super::Logos;
use crate::source::{self, Source};
use core::fmt::{self, Debug};
use core::mem::ManuallyDrop;
use core::ops::{Deref, DerefMut};
/// Byte range in the source.
pub type Span = core::ops::Range<usize>;
/// `Lexer` is the main struct of the crate that allows you to read through a
/// `Source` and produce tokens for enums implementing the `Logos` trait.
pub struct Lexer<'source, Token: Logos<'source>> {
source: &'source Token::Source,
token: ManuallyDrop<Option<Result<Token, Token::Error>>>,
token_start: usize,
token_end: usize,
/// Extras associated with the `Token`.
pub extras: Token::Extras,
}
impl<'source, Token> Debug for Lexer<'source, Token>
where
Token: Logos<'source>,
Token::Source: Debug,
Token::Extras: Debug,
{
fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
fmt.debug_map()
.entry(&"source", &self.source)
.entry(&"extras", &self.extras)
.finish()
}
}
impl<'source, Token: Logos<'source>> Lexer<'source, Token> {
/// Create a new `Lexer`.
///
/// Due to type inference, it might be more ergonomic to construct
/// it by calling [`Token::lexer`](./trait.Logos.html#method.lexer) on any `Token` with derived `Logos`.
pub fn new(source: &'source Token::Source) -> Self
where
Token::Extras: Default,
{
Self::with_extras(source, Default::default())
}
/// Create a new `Lexer` with the provided `Extras`.
///
/// Due to type inference, it might be more ergonomic to construct
/// it by calling [`Token::lexer_with_extras`](./trait.Logos.html#method.lexer_with_extras) on any `Token` with derived `Logos`.
pub fn with_extras(source: &'source Token::Source, extras: Token::Extras) -> Self {
Lexer {
source,
token: ManuallyDrop::new(None),
extras,
token_start: 0,
token_end: 0,
}
}
/// Source from which this Lexer is reading tokens.
#[inline]
pub fn source(&self) -> &'source Token::Source {
self.source
}
/// Wrap the `Lexer` in an [`Iterator`](https://doc.rust-lang.org/std/iter/trait.Iterator.html)
/// that produces tuples of `(Token, `[`Span`](./type.Span.html)`)`.
///
/// # Example
///
/// ```
/// use logos::Logos;
///
/// #[derive(Debug, PartialEq, Clone, Default)]
/// enum LexingError {
/// NumberParseError,
/// #[default]
/// Other
/// }
///
/// impl From<std::num::ParseIntError> for LexingError {
/// fn from(_: std::num::ParseIntError) -> Self {
/// LexingError::NumberParseError
/// }
/// }
///
/// impl From<std::num::ParseFloatError> for LexingError {
/// fn from(_: std::num::ParseFloatError) -> Self {
/// LexingError::NumberParseError
/// }
/// }
///
/// #[derive(Logos, Debug, PartialEq)]
/// #[logos(error = LexingError)]
/// enum Example {
/// #[regex(r"[ \n\t\f]+", logos::skip)]
/// Ignored,
///
/// #[regex("-?[0-9]+", |lex| lex.slice().parse())]
/// Integer(i64),
///
/// #[regex("-?[0-9]+\\.[0-9]+", |lex| lex.slice().parse())]
/// Float(f64),
/// }
///
/// let tokens: Vec<_> = Example::lexer("42 3.14 -5 f").spanned().collect();
///
/// assert_eq!(
/// tokens,
/// &[
/// (Ok(Example::Integer(42)), 0..2),
/// (Ok(Example::Float(3.14)), 3..7),
/// (Ok(Example::Integer(-5)), 8..10),
/// (Err(LexingError::Other), 11..12), // 'f' is not a recognized token
/// ],
/// );
/// ```
#[inline]
pub fn spanned(self) -> SpannedIter<'source, Token> {
SpannedIter { lexer: self }
}
#[inline]
#[doc(hidden)]
#[deprecated(since = "0.11.0", note = "please use `span` instead")]
pub fn range(&self) -> Span {
self.span()
}
/// Get the range for the current token in `Source`.
#[inline]
pub fn span(&self) -> Span {
self.token_start..self.token_end
}
/// Get a string slice of the current token.
#[inline]
pub fn slice(&self) -> <Token::Source as Source>::Slice<'source> {
unsafe { self.source.slice_unchecked(self.span()) }
}
/// Get a slice of remaining source, starting at the end of current token.
#[inline]
pub fn remainder(&self) -> <Token::Source as Source>::Slice<'source> {
unsafe {
self.source
.slice_unchecked(self.token_end..self.source.len())
}
}
/// Turn this lexer into a lexer for a new token type.
///
/// The new lexer continues to point at the same span as the current lexer,
/// and the current token becomes the error token of the new token type.
pub fn morph<Token2>(self) -> Lexer<'source, Token2>
where
Token2: Logos<'source, Source = Token::Source>,
Token::Extras: Into<Token2::Extras>,
{
Lexer {
source: self.source,
token: ManuallyDrop::new(None),
extras: self.extras.into(),
token_start: self.token_start,
token_end: self.token_end,
}
}
/// Bumps the end of currently lexed token by `n` bytes.
///
/// # Panics
///
/// Panics if adding `n` to current offset would place the `Lexer` beyond the last byte,
/// or in the middle of an UTF-8 code point (does not apply when lexing raw `&[u8]`).
pub fn bump(&mut self, n: usize) {
self.token_end += n;
assert!(
self.source.is_boundary(self.token_end),
"Invalid Lexer bump",
)
}
}
impl<'source, Token> Clone for Lexer<'source, Token>
where
Token: Logos<'source> + Clone,
Token::Extras: Clone,
{
fn clone(&self) -> Self {
Lexer {
extras: self.extras.clone(),
token: self.token.clone(),
..*self
}
}
}
impl<'source, Token> Iterator for Lexer<'source, Token>
where
Token: Logos<'source>,
{
type Item = Result<Token, Token::Error>;
#[inline]
fn next(&mut self) -> Option<Result<Token, Token::Error>> {
self.token_start = self.token_end;
Token::lex(self);
// This basically treats self.token as a temporary field.
// Since we always immediately return a newly set token here,
// we don't have to replace it with `None` or manually drop
// it later.
unsafe { ManuallyDrop::take(&mut self.token) }
}
}
/// Iterator that pairs tokens with their position in the source.
///
/// Look at [`Lexer::spanned`](./struct.Lexer.html#method.spanned) for documentation.
pub struct SpannedIter<'source, Token: Logos<'source>> {
lexer: Lexer<'source, Token>,
}
// deriving Clone doesn't infer the necessary `Token::Extras: Clone` bound
impl<'source, Token> Clone for SpannedIter<'source, Token>
where
Token: Logos<'source> + Clone,
Token::Extras: Clone,
{
fn clone(&self) -> Self {
SpannedIter {
lexer: self.lexer.clone(),
}
}
}
impl<'source, Token> Iterator for SpannedIter<'source, Token>
where
Token: Logos<'source>,
{
type Item = (Result<Token, Token::Error>, Span);
fn next(&mut self) -> Option<Self::Item> {
self.lexer.next().map(|token| (token, self.lexer.span()))
}
}
impl<'source, Token> Deref for SpannedIter<'source, Token>
where
Token: Logos<'source>,
{
type Target = Lexer<'source, Token>;
fn deref(&self) -> &Lexer<'source, Token> {
&self.lexer
}
}
impl<'source, Token> DerefMut for SpannedIter<'source, Token>
where
Token: Logos<'source>,
{
fn deref_mut(&mut self) -> &mut Lexer<'source, Token> {
&mut self.lexer
}
}
#[doc(hidden)]
/// # WARNING!
///
/// **This trait, and its methods, are not meant to be used outside of the
/// code produced by `#[derive(Logos)]` macro.**
impl<'source, Token> LexerInternal<'source> for Lexer<'source, Token>
where
Token: Logos<'source>,
{
type Token = Token;
/// Read a `Chunk` at current position of the `Lexer`. If end
/// of the `Source` has been reached, this will return `0`.
#[inline]
fn read<Chunk>(&self) -> Option<Chunk>
where
Chunk: source::Chunk<'source>,
{
self.source.read(self.token_end)
}
/// Read a `Chunk` at a position offset by `n`.
#[inline]
fn read_at<Chunk>(&self, n: usize) -> Option<Chunk>
where
Chunk: source::Chunk<'source>,
{
self.source.read(self.token_end + n)
}
#[inline]
unsafe fn read_unchecked<Chunk>(&self, n: usize) -> Chunk
where
Chunk: source::Chunk<'source>,
{
self.source.read_unchecked(self.token_end + n)
}
/// Test a chunk at current position with a closure.
#[inline]
fn test<T, F>(&self, test: F) -> bool
where
T: source::Chunk<'source>,
F: FnOnce(T) -> bool,
{
match self.source.read::<T>(self.token_end) {
Some(chunk) => test(chunk),
None => false,
}
}
/// Test a chunk at current position offset by `n` with a closure.
#[inline]
fn test_at<T, F>(&self, n: usize, test: F) -> bool
where
T: source::Chunk<'source>,
F: FnOnce(T) -> bool,
{
match self.source.read::<T>(self.token_end + n) {
Some(chunk) => test(chunk),
None => false,
}
}
/// Bump the position `Lexer` is reading from by `size`.
#[inline]
fn bump_unchecked(&mut self, size: usize) {
debug_assert!(
self.token_end + size <= self.source.len(),
"Bumping out of bounds!"
);
self.token_end += size;
}
/// Reset `token_start` to `token_end`.
#[inline]
fn trivia(&mut self) {
self.token_start = self.token_end;
}
/// Set the current token to appropriate `#[error]` variant.
/// Guarantee that `token_end` is at char boundary for `&str`.
#[inline]
fn error(&mut self) {
self.token_end = self.source.find_boundary(self.token_end);
self.token = ManuallyDrop::new(Some(Err(Token::Error::default())));
}
#[inline]
fn end(&mut self) {
self.token = ManuallyDrop::new(None);
}
#[inline]
fn set(
&mut self,
token: Result<
Self::Token,
<<Self as LexerInternal<'source>>::Token as Logos<'source>>::Error,
>,
) {
self.token = ManuallyDrop::new(Some(token));
}
}