From a6a184a412282d896e6cda80e0f7098dea402d7f Mon Sep 17 00:00:00 2001 From: Andrea Ciliberti Date: Fri, 31 Mar 2023 16:20:31 +0200 Subject: [PATCH] SWKBD adheres to Rust standards --- ctru-rs/examples/software-keyboard.rs | 11 ++++------- ctru-rs/src/applets/swkbd.rs | 18 +++++++----------- 2 files changed, 11 insertions(+), 18 deletions(-) diff --git a/ctru-rs/examples/software-keyboard.rs b/ctru-rs/examples/software-keyboard.rs index ffa096c..51bb29e 100644 --- a/ctru-rs/examples/software-keyboard.rs +++ b/ctru-rs/examples/software-keyboard.rs @@ -24,15 +24,12 @@ fn main() { // configurations. let mut keyboard = Swkbd::default(); - // String used to store text received from the keyboard - let mut text = String::new(); - // Raise the software keyboard. You can perform different actions depending on which // software button the user pressed - match keyboard.get_utf8(&mut text) { - Ok(Button::Right) => println!("You entered: {text}"), - Ok(Button::Left) => println!("Cancelled"), - Ok(Button::Middle) => println!("How did you even press this?"), + match keyboard.write_to_string() { + Ok((text, Button::Right)) => println!("You entered: {text}"), + Ok((_, Button::Left)) => println!("Cancelled"), + Ok((_, Button::Middle)) => println!("How did you even press this?"), Err(_) => println!("Oh noes, an error happened!"), } } diff --git a/ctru-rs/src/applets/swkbd.rs b/ctru-rs/src/applets/swkbd.rs index 1566c5a..e29defe 100644 --- a/ctru-rs/src/applets/swkbd.rs +++ b/ctru-rs/src/applets/swkbd.rs @@ -2,7 +2,6 @@ use bitflags::bitflags; use ctru_sys::{ self, swkbdInit, swkbdInputText, swkbdSetButton, swkbdSetFeatures, swkbdSetHintText, SwkbdState, }; -use libc; use std::iter::once; use std::str; @@ -101,24 +100,21 @@ impl Swkbd { /// /// The text received from the keyboard will be truncated if it is greater than 2048 bytes /// in length. - pub fn get_utf8(&mut self, buf: &mut String) -> Result { + pub fn write_to_string(&mut self) -> Result<(String, Button), Error> { // Unfortunately the libctru API doesn't really provide a way to get the exact length // of the string that it receieves from the software keyboard. Instead it expects you // to pass in a buffer and hope that it's big enough to fit the entire string, so // you have to set some upper limit on the potential size of the user's input. const MAX_BYTES: usize = 2048; - let mut tmp = [0u8; MAX_BYTES]; - let button = self.get_bytes(&mut tmp)?; + let mut buf = vec![0u8; MAX_BYTES]; + let button = self.write_bytes(&mut buf)?; // libctru does, however, seem to ensure that the buffer will always contain a properly - // terminated UTF-8 sequence even if the input has to be truncated, so these operations + // terminated UTF-8 sequence even if the input has to be truncated, so this operation // should be safe. - let len = unsafe { libc::strlen(tmp.as_ptr()) }; - let utf8 = unsafe { str::from_utf8_unchecked(&tmp[..len]) }; + let res = String::from_utf8(buf).unwrap(); - // Copy the input into the user's `String` - *buf += utf8; - Ok(button) + Ok((res, button)) } /// Fills the provided buffer with a UTF-8 encoded, NUL-terminated sequence of bytes from @@ -126,7 +122,7 @@ impl Swkbd { /// /// If the buffer is too small to contain the entire sequence received from the keyboard, /// the output will be truncated but should still be well-formed UTF-8. - pub fn get_bytes(&mut self, buf: &mut [u8]) -> Result { + pub fn write_bytes(&mut self, buf: &mut [u8]) -> Result { unsafe { match swkbdInputText(self.state.as_mut(), buf.as_mut_ptr(), buf.len()) { ctru_sys::SWKBD_BUTTON_NONE => Err(self.parse_swkbd_error()),