RustbotPython icon indicating copy to clipboard operation
RustbotPython copied to clipboard

Handle ?eval code generation differently

Open kangalio opened this issue 5 years ago • 1 comments

Problem

Currently, the code provided to the ?eval command is wrapped like this:

fn main() {
	println!("{:?}", {
		// CODE HERE
	});
}

This has a small issue; when the code evaluates to a value with a lifetime, the code fails to compile, for example:

fn main() {
	println!("{:?}", {
		let a = 42;
		&a
	});
}

That's because &a exits the scope we explicitly declared with {}, but its lifetime is bound to something within that scope (a).

This is slightly confusing for bot users and also a bit annoying.

How to fix

You may be able to prevent this issue by wrapping the code differently. The following ?eval input...

/* line 1 */;
/* line 2 */;
/* line 3 */;
/* line 4 */

...would be translated to the following Rust code...

fn main() {
	/* line 1 */;
	/* line 2 */;
	/* line 3 */;
	println!("{:?}", /* line 4 */);
}

In other words: the code will be split up by semicolons and only the result of the last line is put into the println!(). The rest are top-level statements inside main.

I'm not sure if there are edge cases in which this approach would break

kangalio avatar Dec 31 '20 20:12 kangalio

Naively splitting by semicolons would break quite quickly, for example when putting semicolons in colons or in strings. A more robust way would be to parse the source code using something like syn. This brings plenty problems though:

  • how to exactly preserve the user's code formatting when deserializing from syn data structures to Rust code text?
  • how to handle parse errors? Syn won't display the nice error message we know from rustc, so we'd probably have to run the code through rustc first, just to catch any syntax or parse errors, then through syn to add the proposed issue behavior, then again through rustc to actually compile and run

This all seems quite clunky and error prone. Does someone have an idea how to do it better?

kangalio avatar Feb 09 '21 20:02 kangalio