errors: LineReport -> TokenReport

TI-Toolkit · Sep 8, 2024 · 49d75a4 · 49d75a4
1 parent fca75d4
commit 49d75a4
Show file tree

Hide file tree

Showing 28 changed files with 93 additions and 91 deletions.
diff --git a/ti-basic-optimizer/src/error_reporting.rs b/ti-basic-optimizer/src/error_reporting.rs
@@ -4,7 +4,7 @@ use titokens::tokenizer::TokenBoundaries;
 macro_rules! next_or_err {
     ($tokens: ident) => {
         $tokens.next().ok_or_else(|| {
-            (crate::error_reporting::LineReport::new(
+            (crate::error_reporting::TokenReport::new(
                 $tokens.current_position() - 2,
                 "Unexpected end of input.",
                 None,
@@ -15,7 +15,7 @@ macro_rules! next_or_err {
 
     ($tokens: ident, $message: literal) => {
         $tokens.next().ok_or_else(|| {
-            (crate::error_reporting::LineReport::new(
+            (crate::error_reporting::TokenReport::new(
                 $tokens.current_position() - 2,
                 $message,
                 None,
@@ -26,10 +26,10 @@ macro_rules! next_or_err {
 }
 
 macro_rules! expect_tok {
-    ($tokens: ident, $token: expr, $token_name: literal) => {
+    ($tokens: ident, $token: pat, $token_name: literal) => {
         crate::error_reporting::next_or_err!($tokens).and_then(|tok| {
-            if tok != ($token) {
-                Err(crate::error_reporting::LineReport::new(
+            if !matches!(tok, $token) {
+                Err(crate::error_reporting::TokenReport::new(
                     $tokens.current_position() - 1,
                     concat!("Expected token \"", $token_name, "\"."),
                     Some("Add the token."),
@@ -43,7 +43,7 @@ macro_rules! expect_tok {
     ($tokens: ident, $token: expr, $error: literal, $help: literal) => {
         crate::error_reporting::next_or_err!($tokens).and_then(|tok| {
             if tok != ($token) {
-                Err(crate::error_reporting::LineReport::new(
+                Err(crate::error_reporting::TokenReport::new(
                     $tokens.current_position() - 1,
                     $error,
                     Some($help),
@@ -58,7 +58,7 @@ macro_rules! expect_tok {
 macro_rules! expect_some {
     ($option: expr, $tokens: ident, $expected_kind: literal) => {
         $option.ok_or_else(|| {
-            crate::error_reporting::LineReport::new(
+            crate::error_reporting::TokenReport::new(
                 $tokens.current_position() - 1,
                 concat!("Expected to find ", $expected_kind, "."),
                 None,
@@ -72,7 +72,7 @@ macro_rules! expect_some {
 
     ($option: expr, $tokens: ident, $expected_kind: literal, $help: literal) => {
         $option.ok_or_else(|| {
-            crate::error_reporting::LineReport::new(
+            crate::error_reporting::TokenReport::new(
                 $tokens.current_position() - 1,
                 concat!("Expected to find ", $expected_kind, "."),
                 None,
@@ -83,7 +83,7 @@ macro_rules! expect_some {
 
     ($option: expr, $tokens: ident, $ofs: expr, $expected_kind: literal, $help: literal) => {
         $option.ok_or_else(|| {
-            crate::error_reporting::LineReport::new(
+            crate::error_reporting::TokenReport::new(
                 $tokens.current_position() - $ofs,
                 concat!("Expected to find ", $expected_kind, "."),
                 None,
@@ -113,7 +113,7 @@ impl LabelKind {
 }
 
 #[derive(Debug, Clone)]
-pub struct LineReport {
+pub struct TokenReport {
     location: usize,
     message: String,
     suggestion: Option<String>,
@@ -122,10 +122,10 @@ pub struct LineReport {
     labels: Vec<(LabelKind, String)>,
 }
 
-impl LineReport {
+impl TokenReport {
     #[must_use]
     pub fn new(location: usize, message: &str, suggestion: Option<&str>) -> Self {
-        LineReport {
+        TokenReport {
             location,
             message: message.to_string(),
             suggestion: suggestion.map(|x| x.to_string()),

diff --git a/ti-basic-optimizer/src/parse/commands/control_flow.rs b/ti-basic-optimizer/src/parse/commands/control_flow.rs
@@ -4,7 +4,7 @@ mod menu;
 
 pub use {for_loop::ForLoop, isds::IsDs, menu::Menu};
 
-use crate::error_reporting::{expect_some, next_or_err, LineReport};
+use crate::error_reporting::{expect_some, next_or_err, TokenReport};
 use crate::parse::{expression::Expression, Parse, Reconstruct};
 use crate::Config;
 use std::iter::once;
@@ -66,7 +66,7 @@ impl LabelName {
 }
 
 impl Parse for LabelName {
-    fn parse(token: Token, more: &mut Tokens) -> Result<Option<Self>, LineReport> {
+    fn parse(token: Token, more: &mut Tokens) -> Result<Option<Self>, TokenReport> {
         if !token.is_alphanumeric() {
             return Ok(None);
         }
@@ -115,7 +115,7 @@ pub enum ControlFlow {
 
 impl Parse for ControlFlow {
     #[rustfmt::skip]
-    fn parse(token: Token, more: &mut Tokens) -> Result<Option<Self>, LineReport> {
+    fn parse(token: Token, more: &mut Tokens) -> Result<Option<Self>, TokenReport> {
         use ControlFlow as CF;
         use Expression as Expr;
 

diff --git a/ti-basic-optimizer/src/parse/commands/control_flow/for_loop.rs b/ti-basic-optimizer/src/parse/commands/control_flow/for_loop.rs
@@ -1,4 +1,4 @@
-use crate::error_reporting::{expect_some, expect_tok, next_or_err, LineReport};
+use crate::error_reporting::{expect_some, expect_tok, next_or_err, TokenReport};
 use crate::parse::expression::Expression;
 use crate::parse::{Parse, Reconstruct};
 use crate::Config;
@@ -16,7 +16,7 @@ pub struct ForLoop {
 }
 
 impl Parse for ForLoop {
-    fn parse(token: Token, more: &mut Tokens) -> Result<Option<Self>, LineReport> {
+    fn parse(token: Token, more: &mut Tokens) -> Result<Option<Self>, TokenReport> {
         if token != Token::OneByte(0xD3) {
             return Ok(None);
         }

diff --git a/ti-basic-optimizer/src/parse/commands/control_flow/isds.rs b/ti-basic-optimizer/src/parse/commands/control_flow/isds.rs
@@ -1,4 +1,4 @@
-use crate::error_reporting::{expect_some, expect_tok, next_or_err, LineReport};
+use crate::error_reporting::{expect_some, expect_tok, next_or_err, TokenReport};
 use crate::parse::{components::NumericVarName, expression::Expression, Parse, Reconstruct};
 
 use crate::Config;
@@ -12,7 +12,7 @@ pub struct IsDs {
 }
 
 impl Parse for IsDs {
-    fn parse(token: Token, more: &mut Tokens) -> Result<Option<Self>, LineReport> {
+    fn parse(token: Token, more: &mut Tokens) -> Result<Option<Self>, TokenReport> {
         if token == Token::OneByte(0xDA) || token == Token::OneByte(0xDB) {
             let variable = expect_some!(
                 NumericVarName::parse(next_or_err!(more)?, more)?,

diff --git a/ti-basic-optimizer/src/parse/commands/control_flow/menu.rs b/ti-basic-optimizer/src/parse/commands/control_flow/menu.rs
@@ -1,4 +1,4 @@
-use crate::error_reporting::{expect_some, expect_tok, next_or_err, LineReport};
+use crate::error_reporting::{expect_some, expect_tok, next_or_err, TokenReport};
 use crate::parse::{commands::control_flow::LabelName, expression::Expression, Parse, Reconstruct};
 use crate::Config;
 use std::iter::once;
@@ -12,7 +12,7 @@ pub struct Menu {
 }
 
 impl Parse for Menu {
-    fn parse(token: Token, more: &mut Tokens) -> Result<Option<Self>, LineReport> {
+    fn parse(token: Token, more: &mut Tokens) -> Result<Option<Self>, TokenReport> {
         if token != Token::OneByte(0xE6) {
             return Ok(None);
         }
@@ -60,7 +60,7 @@ impl Parse for Menu {
 
                 Some(Token::OneByte(0x3E | 0x3F)) | None => break, // :, \n, EOF
 
-                Some(_) => Err(LineReport::new(
+                Some(_) => Err(TokenReport::new(
                     more.current_position() - 1,
                     "Unexpected character in Menu(",
                     Some("perhaps it's unimplemented?"),

diff --git a/ti-basic-optimizer/src/parse/commands/delvar_chain.rs b/ti-basic-optimizer/src/parse/commands/delvar_chain.rs
@@ -1,17 +1,19 @@
-use crate::error_reporting::{next_or_err, LineReport};
+use crate::error_reporting::{next_or_err, TokenReport};
 use crate::parse::{commands::Command, components::DelVarTarget, Parse, Reconstruct};
 use crate::Config;
 use std::iter::once;
 use titokens::{Token, Tokens};
 
+/// `DelVar` statements do not require a trailing newline, and so a series of `deletions` can be
+/// chained back-to-back.
 #[derive(Clone, Debug)]
 pub struct DelVarChain {
     pub deletions: Vec<DelVarTarget>,
     pub valence: Option<Box<Command>>,
 }
 
 impl Parse for DelVarChain {
-    fn parse(token: Token, more: &mut Tokens) -> Result<Option<Self>, LineReport> {
+    fn parse(token: Token, more: &mut Tokens) -> Result<Option<Self>, TokenReport> {
         if token != Token::TwoByte(0xBB, 0x54) {
             return Ok(None);
         }

diff --git a/ti-basic-optimizer/src/parse/commands/generic.rs b/ti-basic-optimizer/src/parse/commands/generic.rs
@@ -1,6 +1,6 @@
 use itertools::Itertools;
 
-use crate::error_reporting::LineReport;
+use crate::error_reporting::TokenReport;
 use crate::parse::expression::Expression;
 use crate::parse::{Parse, Reconstruct};
 use crate::Config;
@@ -13,7 +13,7 @@ pub struct Generic {
 }
 
 impl Parse for Generic {
-    fn parse(token: Token, more: &mut Tokens) -> Result<Option<Self>, LineReport> {
+    fn parse(token: Token, more: &mut Tokens) -> Result<Option<Self>, TokenReport> {
         if !Generic::recognize(token) {
             return Ok(None);
         }
@@ -44,7 +44,7 @@ impl Parse for Generic {
                     }
                     Some(Token::OneByte(0x3E | 0x3F)) | None => break, // :, \n, EOF
 
-                    Some(_) => Err(LineReport::new(
+                    Some(_) => Err(TokenReport::new(
                         more.current_position() - 1,
                         "Unexpected character in command invocation",
                         Some("perhaps it's unimplemented?"),

diff --git a/ti-basic-optimizer/src/parse/commands/mod.rs b/ti-basic-optimizer/src/parse/commands/mod.rs
@@ -12,7 +12,7 @@ pub use setupeditor::SetUpEditor;
 pub use generic::Generic;
 use std::iter::once;
 
-use crate::error_reporting::{expect_some, next_or_err, LineReport};
+use crate::error_reporting::{expect_some, next_or_err, TokenReport};
 use crate::parse::components::StoreTarget;
 use crate::parse::{expression::Expression, Parse, Reconstruct};
 use crate::Config;
@@ -31,7 +31,7 @@ pub enum Command {
 
 impl Parse for Command {
     #[allow(unused_parens)]
-    fn parse(token: Token, more: &mut Tokens) -> Result<Option<Self>, LineReport> {
+    fn parse(token: Token, more: &mut Tokens) -> Result<Option<Self>, TokenReport> {
         if let Some(cmd) = Generic::parse(token, more)?.map(Command::Generic) {
             Ok(Some(cmd))
         } else if let Some(cmd) = ControlFlow::parse(token, more)?.map(Command::ControlFlow) {

diff --git a/ti-basic-optimizer/src/parse/commands/prgm.rs b/ti-basic-optimizer/src/parse/commands/prgm.rs
@@ -1,4 +1,4 @@
-use crate::error_reporting::LineReport;
+use crate::error_reporting::TokenReport;
 use crate::parse::{Parse, Reconstruct};
 use crate::Config;
 use std::iter::once;
@@ -10,7 +10,7 @@ pub struct ProgramName {
 }
 
 impl Parse for ProgramName {
-    fn parse(token: Token, more: &mut Tokens) -> Result<Option<Self>, LineReport> {
+    fn parse(token: Token, more: &mut Tokens) -> Result<Option<Self>, TokenReport> {
         if token != Token::OneByte(0x5F) {
             return Ok(None);
         }
@@ -23,7 +23,7 @@ impl Parse for ProgramName {
                 || (name.is_empty() && token.is_alphanumeric())
             {
                 if name.len() > 8 {
-                    Err(LineReport::new(
+                    Err(TokenReport::new(
                         start_position,
                         "Program name has too many characters (max 8)",
                         None,
@@ -43,7 +43,7 @@ impl Parse for ProgramName {
         }
 
         if name.is_empty() {
-            Err(LineReport::new(
+            Err(TokenReport::new(
                 start_position,
                 "Expected a program name.",
                 Some("Program names start with a letter A-θ."),

diff --git a/ti-basic-optimizer/src/parse/commands/setupeditor.rs b/ti-basic-optimizer/src/parse/commands/setupeditor.rs
@@ -1,4 +1,4 @@
-use crate::error_reporting::LineReport;
+use crate::error_reporting::TokenReport;
 use crate::parse::components::{ListName, DEFAULT_LISTS};
 use crate::parse::{Parse, Reconstruct};
 use titokens::{Token, Tokens};
@@ -12,7 +12,7 @@ pub struct SetUpEditor {
 }
 
 impl Parse for SetUpEditor {
-    fn parse(token: Token, more: &mut Tokens) -> Result<Option<Self>, LineReport> {
+    fn parse(token: Token, more: &mut Tokens) -> Result<Option<Self>, TokenReport> {
         if token != Token::TwoByte(0xBB, 0x4A) {
             return Ok(None);
         }
@@ -29,7 +29,7 @@ impl Parse for SetUpEditor {
                     if let Some(name) = ListName::parse_custom_name(more)? {
                         lists.push(name);
                     } else {
-                        Err(LineReport::new(
+                        Err(TokenReport::new(
                             more.current_position(),
                             "Expected a list name",
                             None,
@@ -44,7 +44,7 @@ impl Parse for SetUpEditor {
                     }
                     Some(Token::OneByte(0x3E | 0x3F)) | None => break, // :, \n, EOF
 
-                    Some(_) => Err(LineReport::new(
+                    Some(_) => Err(TokenReport::new(
                         more.current_position() - 1,
                         "Unexpected character in SetUpEditor",
                         None,

diff --git a/ti-basic-optimizer/src/parse/components/data_access.rs b/ti-basic-optimizer/src/parse/components/data_access.rs
@@ -1,4 +1,4 @@
-use crate::error_reporting::{expect_some, expect_tok, next_or_err, LineReport};
+use crate::error_reporting::{expect_some, expect_tok, next_or_err, TokenReport};
 use crate::parse::{
     components::{ListName, MatrixName, Operand},
     expression::Expression,
@@ -87,7 +87,7 @@ impl MatrixIndex {
         subject: MatrixIndexable,
         token: Token,
         more: &mut Tokens,
-    ) -> Result<Option<Self>, LineReport> {
+    ) -> Result<Option<Self>, TokenReport> {
         if token != Token::OneByte(0x10) {
             return Ok(None);
         }
@@ -146,7 +146,7 @@ impl ListIndex {
         subject: ListIndexable,
         token: Token,
         more: &mut Tokens,
-    ) -> Result<Option<Self>, LineReport> {
+    ) -> Result<Option<Self>, TokenReport> {
         if token != Token::OneByte(0x10) {
             return Ok(None);
         }

diff --git a/ti-basic-optimizer/src/parse/components/delvar_target.rs b/ti-basic-optimizer/src/parse/components/delvar_target.rs
@@ -1,4 +1,4 @@
-use crate::error_reporting::LineReport;
+use crate::error_reporting::TokenReport;
 use crate::parse::{
     components::{
         EquationName, ImageName, ListIndex, ListName, MatrixIndex, MatrixName, NumericVarName,
@@ -24,7 +24,7 @@ pub enum DelVarTarget {
 }
 
 impl Parse for DelVarTarget {
-    fn parse(token: Token, more: &mut Tokens) -> Result<Option<Self>, LineReport> {
+    fn parse(token: Token, more: &mut Tokens) -> Result<Option<Self>, TokenReport> {
         match token {
             Token::OneByte(0x41..=0x5B) | Token::TwoByte(0x62, 0x21) => {
                 Ok(NumericVarName::parse(token, more)?.map(Self::NumericVar))

diff --git a/ti-basic-optimizer/src/parse/components/equation_name.rs b/ti-basic-optimizer/src/parse/components/equation_name.rs
@@ -1,4 +1,4 @@
-use crate::error_reporting::LineReport;
+use crate::error_reporting::TokenReport;
 use crate::parse::{Parse, Reconstruct};
 use crate::Config;
 use titokens::{Token, Tokens};
@@ -7,7 +7,7 @@ use titokens::{Token, Tokens};
 pub struct EquationName(Token);
 
 impl Parse for EquationName {
-    fn parse(token: Token, _more: &mut Tokens) -> Result<Option<Self>, LineReport> {
+    fn parse(token: Token, _more: &mut Tokens) -> Result<Option<Self>, TokenReport> {
         Ok(match token {
             Token::TwoByte(0x5E, 0x10..=0x2B | 0x40..=0x45 | 0x80..=0x82) => {
                 Some(EquationName(token))

diff --git a/ti-basic-optimizer/src/parse/components/function_call.rs b/ti-basic-optimizer/src/parse/components/function_call.rs
@@ -1,4 +1,4 @@
-use crate::error_reporting::LineReport;
+use crate::error_reporting::TokenReport;
 use crate::parse::expression::Expression;
 use crate::parse::{Parse, Reconstruct};
 use crate::Config;
@@ -12,7 +12,7 @@ pub struct FunctionCall {
 }
 
 impl Parse for FunctionCall {
-    fn parse(token: Token, more: &mut Tokens) -> Result<Option<Self>, LineReport> {
+    fn parse(token: Token, more: &mut Tokens) -> Result<Option<Self>, TokenReport> {
         if !FunctionCall::recognize(token) {
             return Ok(None);
         }
@@ -39,7 +39,7 @@ impl Parse for FunctionCall {
 
                     Some(Token::OneByte(0x3E | 0x3F)) | None => break, // :, \n, EOF
 
-                    Some(_) => Err(LineReport::new(
+                    Some(_) => Err(TokenReport::new(
                         more.current_position() - 1,
                         "Unexpected character in function call",
                         Some("perhaps it's unimplemented?"),

diff --git a/ti-basic-optimizer/src/parse/components/list.rs b/ti-basic-optimizer/src/parse/components/list.rs
@@ -1,4 +1,4 @@
-use crate::error_reporting::{next_or_err, LineReport};
+use crate::error_reporting::{next_or_err, TokenReport};
 use crate::parse::expression::Expression;
 use crate::parse::{Parse, Reconstruct};
 use crate::Config;
@@ -11,7 +11,7 @@ pub struct TIList {
 }
 
 impl Parse for TIList {
-    fn parse(token: Token, more: &mut Tokens) -> Result<Option<Self>, LineReport> {
+    fn parse(token: Token, more: &mut Tokens) -> Result<Option<Self>, TokenReport> {
         // {
         if token != Token::OneByte(0x08) {
             return Ok(None);