impl pretty printing for ByIndex and add out of bounds error test;

ergoplatform · Aug 14, 2023 · 60e25a6 · 60e25a6
1 parent f851f47
commit 60e25a6
Show file tree

Hide file tree

Showing 7 changed files with 79 additions and 8 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -77,7 +77,7 @@ proptest = { version = "=1.0", default-features = false, features = ["std"] }
 proptest-derive = "0.3"
 pretty_assertions = "1.3"
 wasm-bindgen-test = "0.3.10"
-expect-test = "1.0.1"
+expect-test = "1.4.1"
 
 [profile.release]
 # Tell `rustc` to optimize for small code size.

diff --git a/ergotree-interpreter/src/eval/error.rs b/ergotree-interpreter/src/eval/error.rs
@@ -172,6 +172,8 @@ impl<T> ExtResultEvalError<T> for Result<T, EvalError> {
 mod tests {
     use std::rc::Rc;
 
+    use ergotree_ir::mir::coll_by_index::ByIndex;
+    use ergotree_ir::mir::global_vars::GlobalVars;
     use ergotree_ir::source_span::SourceSpan;
     use expect_test::expect;
 
@@ -352,4 +354,52 @@ mod tests {
             }
         );
     }
+
+    #[ignore = "expect test fails on self-generated string"]
+    #[test]
+    fn pretty_out_of_bounds() {
+        // OUTPUTS(1) should be out of bounds error in:
+        // {
+        //   val v1 = 1
+        //   OUPUTS(v1)
+        // }
+        let v1_id = 1.into();
+        let expr = Expr::BlockValue(
+            BlockValue {
+                items: vec![ValDef {
+                    id: v1_id,
+                    rhs: Box::new(Expr::Const(99999999i32.into())),
+                }
+                .into()],
+                result: Box::new(Expr::ByIndex(
+                    ByIndex::new(
+                        Expr::GlobalVars(GlobalVars::Outputs),
+                        ValUse {
+                            val_id: v1_id,
+                            tpe: SType::SInt,
+                        }
+                        .into(),
+                        None,
+                    )
+                    .unwrap()
+                    .into(),
+                )),
+            }
+            .into(),
+        );
+        check(
+            expr,
+            expect![[r#"
+                  x Evaluation error
+                   ,-[1:1]
+                 1 | {
+                 2 |   val v1 = 99999999
+                 3 |   OUTPUTS(v1)
+                   :          ^^|^
+                   :            `-- error: ByIndex: index Int(99999999) out of bounds for collection size 1
+                 4 | }
+                   `----
+            "#]],
+        )
+    }
 }
diff --git a/ergotree-interpreter/src/eval/expr.rs b/ergotree-interpreter/src/eval/expr.rs
@@ -3,11 +3,11 @@
 use ergotree_ir::mir::expr::Expr;
 use ergotree_ir::mir::value::Value;
 
-use super::error::ExtResultEvalError;
 use super::Env;
 use super::EvalContext;
 use super::EvalError;
 use super::Evaluable;
+use super::error::ExtResultEvalError;
 
 impl Evaluable for Expr {
     fn eval(&self, env: &mut Env, ctx: &mut EvalContext) -> Result<Value, EvalError> {
@@ -54,7 +54,7 @@ impl Evaluable for Expr {
             Expr::Downcast(op) => op.eval(env, ctx),
             Expr::If(op) => op.eval(env, ctx),
             Expr::Append(op) => op.expr().eval(env, ctx),
-            Expr::ByIndex(op) => op.eval(env, ctx),
+            Expr::ByIndex(op) => op.expr().eval(env, ctx),
             Expr::ExtractScriptBytes(op) => op.eval(env, ctx),
             Expr::SizeOf(op) => op.eval(env, ctx),
             Expr::Slice(op) => op.eval(env, ctx),

diff --git a/ergotree-ir/src/mir/expr.rs b/ergotree-ir/src/mir/expr.rs
@@ -167,7 +167,7 @@ pub enum Expr {
     /// Box id, Blake2b256 hash of this box's content, basically equals to `blake2b256(bytes)`
     ExtractId(ExtractId),
     /// Collection, get element by index
-    ByIndex(ByIndex),
+    ByIndex(Spanned<ByIndex>),
     /// Collection size
     SizeOf(SizeOf),
     /// Collection slice
@@ -265,7 +265,7 @@ impl Expr {
             Expr::Upcast(v) => v.tpe(),
             Expr::Downcast(v) => v.tpe(),
             Expr::If(v) => v.tpe(),
-            Expr::ByIndex(v) => v.tpe(),
+            Expr::ByIndex(v) => v.expr().tpe(),
             Expr::ExtractScriptBytes(v) => v.tpe(),
             Expr::SizeOf(v) => v.tpe(),
             Expr::Slice(v) => v.tpe(),

diff --git a/ergotree-ir/src/pretty_printer.rs b/ergotree-ir/src/pretty_printer.rs
@@ -7,6 +7,7 @@ use thiserror::Error;
 use crate::mir::bin_op::BinOp;
 use crate::mir::block::BlockValue;
 use crate::mir::coll_append::Append;
+use crate::mir::coll_by_index::ByIndex;
 use crate::mir::constant::Constant;
 use crate::mir::expr::Expr;
 use crate::mir::global_vars::GlobalVars;
@@ -136,6 +137,23 @@ impl Print for GlobalVars {
     }
 }
 
+impl Print for ByIndex {
+    fn print(&self, w: &mut dyn Printer) -> Result<Expr, PrintError> {
+        let input = self.input.print(w)?;
+        let offset = w.current_pos();
+        write!(w, "(")?;
+        let index = self.index.print(w)?;
+        write!(w, ")")?;
+        let length = w.current_pos() - offset;
+        #[allow(clippy::unwrap_used)] // we only added spans
+        Ok(Spanned {
+            source_span: SourceSpan { offset, length },
+            expr: ByIndex::new(input, index, self.default.clone()).unwrap(),
+        }
+        .into())
+    }
+}
+
 #[allow(clippy::panic)]
 impl Print for Expr {
     fn print(&self, w: &mut dyn Printer) -> Result<Expr, PrintError> {
@@ -147,6 +165,7 @@ impl Print for Expr {
             Expr::Const(v) => v.print(w),
             Expr::BinOp(v) => v.expr().print(w),
             Expr::GlobalVars(v) => v.print(w),
+            Expr::ByIndex(v) => v.expr().print(w),
             e => panic!("Not implemented: {:?}", e),
         }
     }

diff --git a/ergotree-ir/src/serialization/expr.rs b/ergotree-ir/src/serialization/expr.rs
@@ -264,7 +264,7 @@ impl SigmaSerializable for Expr {
             Expr::Upcast(op) => op.sigma_serialize_w_opcode(w),
             Expr::Downcast(op) => op.sigma_serialize_w_opcode(w),
             Expr::If(op) => op.sigma_serialize_w_opcode(w),
-            Expr::ByIndex(op) => op.sigma_serialize_w_opcode(w),
+            Expr::ByIndex(op) => op.expr().sigma_serialize_w_opcode(w),
             Expr::ExtractScriptBytes(op) => op.sigma_serialize_w_opcode(w),
             Expr::SizeOf(op) => op.sigma_serialize_w_opcode(w),
             Expr::Slice(op) => op.sigma_serialize_w_opcode(w),

diff --git a/ergotree-ir/src/source_span.rs b/ergotree-ir/src/source_span.rs
@@ -3,6 +3,7 @@
 use crate::mir::bin_op::BinOp;
 use crate::mir::block::BlockValue;
 use crate::mir::coll_append::Append;
+use crate::mir::coll_by_index::ByIndex;
 use crate::mir::expr::Expr;
 use crate::mir::val_def::ValDef;
 
@@ -64,6 +65,7 @@ into_expr!(Append);
 into_expr!(BlockValue);
 into_expr!(ValDef);
 into_expr!(BinOp);
+into_expr!(ByIndex);
 
 impl<T> From<T> for Spanned<T> {
     fn from(v: T) -> Self {
@@ -92,7 +94,7 @@ impl Expr {
             Expr::CalcSha256(_) => todo!(),
             Expr::Context => todo!(),
             Expr::Global => todo!(),
-            Expr::GlobalVars(_) => todo!(),
+            Expr::GlobalVars(_) => SourceSpan::empty(),
             Expr::FuncValue(_) => todo!(),
             Expr::Apply(_) => todo!(),
             Expr::MethodCall(_) => todo!(),
@@ -119,7 +121,7 @@ impl Expr {
             Expr::ExtractScriptBytes(_) => todo!(),
             Expr::ExtractCreationInfo(_) => todo!(),
             Expr::ExtractId(_) => todo!(),
-            Expr::ByIndex(_) => todo!(),
+            Expr::ByIndex(op) => op.source_span,
             Expr::SizeOf(_) => todo!(),
             Expr::Slice(_) => todo!(),
             Expr::Fold(_) => todo!(),