j/Conlang
1
1
Fork 0
Code Issues 5 Pull Requests Packages Projects 2 Releases Wiki Activity

lexer: Add documentation blurbs to token-class functions

Browse Source
This commit is contained in:
John 2023-09-28 00:09:47 -05:00
parent b1621f2522
commit d3b1e65e35
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
libconlang/src/lib.rs
View File

@ -96,14 +96,17 @@ pub mod lexer {
&self.text[self.cursor..] &self.text[self.cursor..]
} }
// classifies a single arbitrary token // classifies a single arbitrary token
/// Returns the result of the rule with the highest precedence, if any matches
pub fn any(&mut self) -> Option<Token> { pub fn any(&mut self) -> Option<Token> {
None.or_else(|| self.comment()) None.or_else(|| self.comment())
.or_else(|| self.keyword()) .or_else(|| self.keyword())
.or_else(|| self.identifier()) .or_else(|| self.identifier())
.or_else(|| self.literal()) .or_else(|| self.literal())
.or_else(|| self.delimiter()) .or_else(|| self.delimiter())
.or_else(|| self.punctuation())
.or_else(|| self.invalid()) .or_else(|| self.invalid())
} }
/// Attempts to produce a Keyword
pub fn keyword(&mut self) -> Option<Token> { pub fn keyword(&mut self) -> Option<Token> {
None.or_else(|| self.kw_else()) None.or_else(|| self.kw_else())
.or_else(|| self.kw_for()) .or_else(|| self.kw_for())
@ -113,11 +116,13 @@ pub mod lexer {
.or_else(|| self.kw_let()) .or_else(|| self.kw_let())
.or_else(|| self.kw_while()) .or_else(|| self.kw_while())
} }
/// Attempts to produce a [Type::LitString], [Type::LitFloat], or [Type::LitInteger]
pub fn literal(&mut self) -> Option<Token> { pub fn literal(&mut self) -> Option<Token> {
None.or_else(|| self.lit_string()) None.or_else(|| self.lit_string())
.or_else(|| self.lit_float()) .or_else(|| self.lit_float())
.or_else(|| self.lit_integer()) .or_else(|| self.lit_integer())
} }
/// Evaluates delimiter rules
pub fn delimiter(&mut self) -> Option<Token> { pub fn delimiter(&mut self) -> Option<Token> {
None.or_else(|| self.l_brack()) None.or_else(|| self.l_brack())
.or_else(|| self.r_brack()) .or_else(|| self.r_brack())