core: Implement handling of text control input #11059

n0samu · 2023-05-15T11:45:53Z

This is a rebase and update of #2081. The same TODO items still apply, but those would be for a possible future PR. I've moved the left/right arrow key handling into the same code path as the rest of the text control events. ~~I'm marking this PR as a draft because I plan to implement pasting from the clipboard on web - that's the main feature still missing. In the meantime, please provide your reviews/feedback!~~ I've implemented clipboard pasting on web!

supermarioflash_clipboard_demo.mp4

Fixes the save/load menus in #4817, Fixes part of #1891.

core/src/events.rs

core/src/backend/ui.rs

core/src/display_object/edit_text.rs

iwannabethedev · 2023-05-15T14:09:53Z

core/src/display_object/edit_text.rs

+        }
+    }
+
+    pub fn text_control_input(


(Nit: Would a (maybe one-line) comment to document this function be helpful?).

iwannabethedev · 2023-05-15T14:10:04Z

core/src/display_object/edit_text.rs

+        }
+    }
+
+    pub fn text_input(self, character: char, context: &mut UpdateContext<'_, 'gc>) {


(Nit: Would a (maybe one-line) comment to document this function be helpful?).

core/src/display_object/edit_text.rs

iwannabethedev · 2023-05-15T14:52:12Z

core/src/display_object/edit_text.rs

+                            );
+                        } else {
+                            self.set_selection(
+                                Some(TextSelection::for_position(self.text().len())),


(Nit: I am not certain about the value being self.text().len(), but I also do not know what else it should be, and it might be a decent or correct value).

iwannabethedev · 2023-05-15T15:08:35Z

core/src/display_object/edit_text.rs

+                _ => {}
+            }
+            if changed {
+                let mut activation = Avm1Activation::from_nothing(


(Nit: I do not know or understand this part of the codebase, but, would this also work for AVM2?).

I'm just doing exactly the same thing that's already done in the existing text_input function:

ruffle/core/src/display_object/edit_text.rs

Lines 1248 to 1256 in 1065662

if changed {

let mut activation = Avm1Activation::from_nothing(

context.reborrow(),

ActivationIdentifier::root("[Propagate Text Binding]"),

self.into(),

);

self.propagate_text_binding(&mut activation);

self.on_changed(&mut activation);

}

I don't know too much about this but I think if it's fine there it's fine here. And well, implementing whatever AVM2 feature/event may rely on this could be done in a separate PR, if that's indeed something that's missing (I have no idea)

core/src/events.rs

web/src/lib.rs

iwannabethedev · 2023-05-15T15:27:28Z

I have only done a fairly light or superficial code, since I only have a little bit of knowledge and understanding of Rust and this part of the codebase, but at a glance the changes look good to me. I think that someone else should review it as well, but apart from one non-nitpick question, I only have nitpicks. And I think after one more reviewer and after the non-nitpick question has been answered, that this would be ready for merging.

iwannabethedev · 2023-05-15T15:29:43Z

(For some reason two Linux builds failed to install dependencies in the continuous integration actions, which is unrelated to this PR - if that is just spurious failures, I imagine it could make sense to restart those jobs - or just wait until reruns of tests are triggered).

desktop/src/main.rs

n0samu · 2023-05-16T07:33:50Z

Thanks for catching the maxChars issue, that was pretty important! Fixed now. And I tried to improve the comments. I don't feel really confident in writing documentation for those functions you suggested, since I didn't really write them, plus it takes a surprisingly long time to come up with good wording. So I think I'll leave those out of this PR.

iwannabethedev · 2023-05-16T15:48:58Z

I have only done a fairly light or superficial code, since I only have a little bit of knowledge and understanding of Rust and this part of the codebase, but at a glance the changes look very good to me, and I think this is ready to be merged after another reviewer has reviewed the changes.

relrelb · 2023-05-16T18:03:45Z

.cargo/config.toml

@@ -6,6 +6,8 @@ rustflags = [
    # See: https://github.com/rust-lang/cargo/issues/5034
    #      https://github.com/EmbarkStudios/rust-ecosystem/issues/22#issuecomment-947011395

+    "--cfg=web_sys_unstable_apis",


For sanity, I suggest this flag to take effect just for Web builds, like it were on df11cd6:

[target.wasm32-unknown-unknown] rustflags=["--cfg=web_sys_unstable_apis"]

I wonder if this addition means that $RUSTFLAGS can be removed from here:

ruffle/web/packages/core/package.json

Line 22 in 1065662

"build:wasm-vanilla": "cross-env OUT_NAME=ruffle_web CARGO_PROFILE=web-vanilla-wasm RUSTFLAGS=\"$RUSTFLAGS --cfg=web_sys_unstable_apis -Aunknown_lints\" npm run build:wasm",

For number 2, it does not. These flags are overridden in package.json, and need to be until rust-lang/cargo#10271 lands.

I don't know how to apply that condition for just one flag while keeping the others for all targets. Can you tell me how?

Doesn't seem possible without duplicating the other flags: rust-lang/cargo#5376

Ok, I'll leave it as-is then

Since rust-lang/cargo#12148 exists now, perhaps you can add a TODO that once it stabilizes, the clippy lints can be moved to Cargo.toml and this, as the one remaining rustflag, can be specified as [target.wasm32-unknown-unknown]

I just checked and actually Clippy seems to try to compile our web code with all targets enabled, not just wasm. So we need the flag enabled for all targets unless we can tell Clippy not to do that. I've added the note about that new PR though.

core/src/backend/ui.rs

desktop/src/ui.rs

iwannabethedev · 2023-05-20T19:31:39Z

I would guess that this is ready to be merged once rebased given adrian17's approval.

Co-authored-by: jmckiern <[email protected]>

allancoding · 2023-05-22T02:25:56Z

Yay this was the exact game I was looking at that needed this, that is why I tried to do so in #9557 & #9521. I just don't know much about Rust I am still learning it.

Thanks for doing it for me!

n0samu · 2023-05-22T02:51:10Z

Glad to help 😄

Fixup for ruffle-rs#11059, which broke left/right arrows on desktop

Fixup for #11059, which broke left/right arrows on desktop