sirtimbly/IronCalc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fixing lexer documentation to not make incorrect formatting.

Browse Source
This commit is contained in:
fosdick.io
2024-02-14 14:47:35 -07:00
parent 03c1044e58
commit ee34b30ef0
2 changed files with 28 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
base/src/expressions/lexer/ranges.rs
View File

@@ -5,9 +5,9 @@ use super::Lexer;
use super::{ParsedRange, ParsedReference, Result}; use super::{ParsedRange, ParsedReference, Result};
impl Lexer { impl Lexer {
// Consumes a reference in A1 style like: /// Consumes a reference in A1 style like:
// AS23, $AS23, AS$23, $AS$23, R12 /// AS23, $AS23, AS$23, $AS$23, R12
// Or returns an error /// Or returns an error
fn consume_reference_a1(&mut self) -> Result<ParsedReference> { fn consume_reference_a1(&mut self) -> Result<ParsedReference> {
let mut absolute_column = false; let mut absolute_column = false;
let mut absolute_row = false; let mut absolute_row = false;
@@ -70,6 +70,9 @@ impl Lexer {
// row -> '$' row_name | row_name // row -> '$' row_name | row_name
// column_name -> 'A'..'XFD' // column_name -> 'A'..'XFD'
// row_name -> 1..1_048_576 // row_name -> 1..1_048_576
//
/// Consumes a range of references in A1 style like:
/// AS23:AS24, $AS23:AS24, AS$23:AS24, $AS$23:AS24, R12:R23, $R12:R23, R$12:R23, $R$12:R23
pub(super) fn consume_range_a1(&mut self) -> Result<ParsedRange> { pub(super) fn consume_range_a1(&mut self) -> Result<ParsedRange> {
// first let's try to parse a cell // first let's try to parse a cell
let mut position = self.position; let mut position = self.position;
@@ -203,6 +206,8 @@ impl Lexer {
} }
} }
/// Consumes a range of references in R1C1 style like:
/// R12C3:R23C4, R[2]C[-2]:R[3]C[6], R3C[6]:R[-3]C4, R[-2]C:R[-2]C
pub(super) fn consume_range_r1c1(&mut self) -> Result<ParsedRange> { pub(super) fn consume_range_r1c1(&mut self) -> Result<ParsedRange> {
// first let's try to parse a cell // first let's try to parse a cell
match self.consume_reference_r1c1() { match self.consume_reference_r1c1() {
@@ -230,6 +235,8 @@ impl Lexer {
} }
} }
/// Consumes a reference in R1C1 style like:
/// R12C3, R[2]C[-2], R3C[6], R[-3]C4, RC1, R[-2]C
pub(super) fn consume_reference_r1c1(&mut self) -> Result<ParsedReference> { pub(super) fn consume_reference_r1c1(&mut self) -> Result<ParsedReference> {
// R12C3, R[2]C[-2], R3C[6], R[-3]C4, RC1, R[-2]C // R12C3, R[2]C[-2], R3C[6], R[-3]C4, RC1, R[-2]C
let absolute_column; let absolute_column;

36
base/src/expressions/lexer/structured_references.rs
View File

@@ -90,24 +90,24 @@ impl Lexer {
.replace("''", "'")) .replace("''", "'"))
} }
// Possibilities: /// Possibilities:
// 1. MyTable[#Totals] or MyTable[#This Row] /// 1. MyTable[#Totals] or MyTable[#This Row]
// 2. MyTable[MyColumn] /// 2. MyTable[MyColumn]
// 3. MyTable[[My Column]] /// 3. MyTable[[My Column]]
// 4. MyTable[[#This Row], [My Column]] /// 4. MyTable[[#This Row], [My Column]]
// 5. MyTable[[#Totals], [MyColumn]] /// 5. MyTable[[#Totals], [MyColumn]]
// 6. MyTable[[#This Row], [Jan]:[Dec]] /// 6. MyTable[[#This Row], [Jan]:[Dec]]
// 7. MyTable[] /// 7. MyTable[]
// ///
// Multiple specifiers are not supported yet: /// Multiple specifiers are not supported yet:
// 1. MyTable[[#Data], [#Totals], [MyColumn]] /// 1. MyTable[[#Data], [#Totals], [MyColumn]]
// ///
// In particular note that names of columns are escaped only when they are in the first argument /// In particular note that names of columns are escaped only when they are in the first argument
// We use '[' and ']' /// We use '[' and ']'
// When there is only a specifier but not a reference the specifier is not in brackets /// When there is only a specifier but not a reference the specifier is not in brackets
// ///
// Invalid: /// Invalid:
// * MyTable[#Totals, [Jan]:[March]] => MyTable[[#Totals], [Jan]:[March]] /// * MyTable[#Totals, [Jan]:[March]] => MyTable[[#Totals], [Jan]:[March]]
// //
// NOTES: // NOTES:
// * MyTable[[#Totals]] is translated into MyTable[#Totals] // * MyTable[[#Totals]] is translated into MyTable[#Totals]