mirror of
https://github.com/saymrwulf/xous-core.git
synced 2026-11-18 08:52:45 +00:00
modals: add builder-based interface to present alerts with text fields inside
This commit is contained in:
parent
08bbce93f6
commit
89c768625d
2 changed files with 110 additions and 95 deletions
|
|
@ -9,6 +9,103 @@ use num_traits::*;
|
||||||
use xous_ipc::Buffer;
|
use xous_ipc::Buffer;
|
||||||
use core::cell::Cell;
|
use core::cell::Cell;
|
||||||
|
|
||||||
|
pub type TextValidationFn = fn(TextEntryPayload) -> Option<ValidatorErr>;
|
||||||
|
|
||||||
|
pub struct AlertModalBuilder<'a> {
|
||||||
|
prompt: String,
|
||||||
|
validators: Vec<Option<TextValidationFn>>,
|
||||||
|
placeholders: Vec<Option<String>>,
|
||||||
|
fields_amt: u8, // TODO: this can go away, len(validators) and len(placeholders) are equal, which means
|
||||||
|
// fields_amt == len(validators) || len(placeholders)
|
||||||
|
modals: &'a Modals,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<'a> AlertModalBuilder<'a> {
|
||||||
|
pub fn field(&'a mut self, placeholder: Option<String>, validator: Option<TextValidationFn>) -> &'a mut Self {
|
||||||
|
self.validators.push(validator);
|
||||||
|
self.placeholders.push(placeholder);
|
||||||
|
self.fields_amt += 1;
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn build(&self) -> Result<TextEntryPayloads, xous::Error> {
|
||||||
|
self.modals.lock();
|
||||||
|
let mut final_placeholders: Option<[Option<xous_ipc::String<256>>; 10]> = None;
|
||||||
|
|
||||||
|
match self.placeholders.len() {
|
||||||
|
1.. => {
|
||||||
|
let mut pl:[Option<xous_ipc::String<256>>; 10] = Default::default();
|
||||||
|
|
||||||
|
if self.fields_amt != self.placeholders.len() as u8 {
|
||||||
|
log::warn!("can't have more fields than placeholders");
|
||||||
|
return Err(xous::Error::UnknownError);
|
||||||
|
}
|
||||||
|
|
||||||
|
for (index, placeholder) in self.placeholders.iter().enumerate() {
|
||||||
|
if let Some(string) = placeholder {
|
||||||
|
pl[index] = Some(xous_ipc::String::from_str(&string))
|
||||||
|
} else {
|
||||||
|
pl[index] = None
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
final_placeholders = Some(pl)
|
||||||
|
}
|
||||||
|
0 => (),
|
||||||
|
_ => panic!("somehow len of placeholders was neither zero or >= 1...?")
|
||||||
|
}
|
||||||
|
|
||||||
|
let mut spec = ManagedPromptWithTextResponse {
|
||||||
|
token: self.modals.token,
|
||||||
|
prompt: xous_ipc::String::from_str(&self.prompt),
|
||||||
|
fields: self.fields_amt as u32,
|
||||||
|
placeholders: final_placeholders,
|
||||||
|
};
|
||||||
|
|
||||||
|
// question: do we want to add a retry limit?
|
||||||
|
loop {
|
||||||
|
let mut buf = Buffer::into_buf(spec).or(Err(xous::Error::InternalError))?;
|
||||||
|
buf.lend_mut(self.modals.conn, Opcode::PromptWithTextResponse.to_u32().unwrap()).or(Err(xous::Error::InternalError))?;
|
||||||
|
match buf.to_original::<TextEntryPayloads, _>() {
|
||||||
|
Ok(response) => {
|
||||||
|
let mut form_validation_failed = false;
|
||||||
|
for (index, validator) in self.validators.iter().enumerate() {
|
||||||
|
if let Some(validator) = validator {
|
||||||
|
if let Some(err_msg) = validator(response.content()[index]) {
|
||||||
|
spec.prompt.clear();
|
||||||
|
spec.prompt.append(err_msg.as_str().unwrap_or("UTF-8 error")).ok();
|
||||||
|
form_validation_failed = true;
|
||||||
|
break; // one of the validator failed
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if form_validation_failed {
|
||||||
|
continue; // leave the modal as it is
|
||||||
|
}
|
||||||
|
|
||||||
|
// If we're here all non-None validators returned okay, or no validators were specified in the first place at all.
|
||||||
|
send_message(self.modals.conn,
|
||||||
|
Message::new_blocking_scalar(Opcode::TextResponseValid.to_usize().unwrap(),
|
||||||
|
self.modals.token[0] as _, self.modals.token[1] as _, self.modals.token[2] as _, self.modals.token[3] as _,
|
||||||
|
)).expect("couldn't acknowledge text entry");
|
||||||
|
self.modals.unlock();
|
||||||
|
return Ok(response)
|
||||||
|
},
|
||||||
|
_ => {
|
||||||
|
// we send the valid response token even in this case because we want the modals server to move on and not get stuck on this error.
|
||||||
|
send_message(self.modals.conn,
|
||||||
|
Message::new_blocking_scalar(Opcode::TextResponseValid.to_usize().unwrap(),
|
||||||
|
self.modals.token[0] as _, self.modals.token[1] as _, self.modals.token[2] as _, self.modals.token[3] as _,
|
||||||
|
)).expect("couldn't acknowledge text entry");
|
||||||
|
self.modals.unlock();
|
||||||
|
return Err(xous::Error::InternalError);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
pub struct Modals {
|
pub struct Modals {
|
||||||
conn: CID,
|
conn: CID,
|
||||||
token: [u32; 4],
|
token: [u32; 4],
|
||||||
|
|
@ -28,98 +125,13 @@ impl Modals {
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn get_text(&self,
|
pub fn alert_builder(&self, prompt: &str) -> AlertModalBuilder {
|
||||||
prompt: &str,
|
AlertModalBuilder {
|
||||||
maybe_validator: Option<fn(TextEntryPayload, u32) -> Option<ValidatorErr>>,
|
prompt: String::from(prompt),
|
||||||
maybe_validator_op: Option<u32>,
|
validators: vec![],
|
||||||
placeholder: Option<String>
|
placeholders: vec![],
|
||||||
) -> Result<TextEntryPayload, xous::Error> {
|
fields_amt: 0,
|
||||||
match self.get_text_multi(prompt, maybe_validator, maybe_validator_op, 1, Some(vec![placeholder])) {
|
modals: self
|
||||||
Ok(res) => {
|
|
||||||
return Ok(res.first())
|
|
||||||
},
|
|
||||||
Err(error) => return Err(error),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn get_text_multi(&self,
|
|
||||||
prompt: &str,
|
|
||||||
maybe_validator: Option<fn(TextEntryPayload, u32) -> Option<ValidatorErr>>,
|
|
||||||
maybe_validator_op: Option<u32>,
|
|
||||||
fields: u32,
|
|
||||||
placeholders: Option<Vec<Option<String>>>,
|
|
||||||
) -> Result<TextEntryPayloads, xous::Error> {
|
|
||||||
self.lock();
|
|
||||||
let mut final_placeholders: Option<[Option<xous_ipc::String<256>>; 10]> = None;
|
|
||||||
|
|
||||||
match placeholders {
|
|
||||||
Some(placeholders) => {
|
|
||||||
let mut pl:[Option<xous_ipc::String<256>>; 10] = Default::default();
|
|
||||||
//final_placeholders = Some(Default::default());
|
|
||||||
|
|
||||||
if fields != placeholders.len() as u32 {
|
|
||||||
log::warn!("can't have more fields than placeholders");
|
|
||||||
return Err(xous::Error::UnknownError);
|
|
||||||
}
|
|
||||||
|
|
||||||
for (index, placeholder) in placeholders.iter().enumerate() {
|
|
||||||
match placeholder {
|
|
||||||
Some(string) => {
|
|
||||||
pl[index] = Some(xous_ipc::String::from_str(&string))
|
|
||||||
},
|
|
||||||
None => pl[index] = None,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
final_placeholders = Some(pl)
|
|
||||||
}
|
|
||||||
None => (),
|
|
||||||
}
|
|
||||||
|
|
||||||
let mut spec = ManagedPromptWithTextResponse {
|
|
||||||
token: self.token,
|
|
||||||
prompt: xous_ipc::String::from_str(prompt),
|
|
||||||
fields: fields,
|
|
||||||
placeholders: final_placeholders,
|
|
||||||
};
|
|
||||||
|
|
||||||
// question: do we want to add a retry limit?
|
|
||||||
loop {
|
|
||||||
let mut buf = Buffer::into_buf(spec).or(Err(xous::Error::InternalError))?;
|
|
||||||
buf.lend_mut(self.conn, Opcode::PromptWithTextResponse.to_u32().unwrap()).or(Err(xous::Error::InternalError))?;
|
|
||||||
match buf.to_original::<TextEntryPayloads, _>() {
|
|
||||||
Ok(response) => {
|
|
||||||
if let Some(validator) = maybe_validator {
|
|
||||||
if let Some(err_msg) = validator(response.first(), maybe_validator_op.unwrap_or(0)) {
|
|
||||||
spec.prompt.clear();
|
|
||||||
spec.prompt.append(err_msg.as_str().unwrap_or("UTF-8 error")).ok();
|
|
||||||
} else {
|
|
||||||
send_message(self.conn,
|
|
||||||
Message::new_blocking_scalar(Opcode::TextResponseValid.to_usize().unwrap(),
|
|
||||||
self.token[0] as _, self.token[1] as _, self.token[2] as _, self.token[3] as _,
|
|
||||||
)).expect("couldn't acknowledge text entry");
|
|
||||||
self.unlock();
|
|
||||||
return Ok(response)
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
send_message(self.conn,
|
|
||||||
Message::new_blocking_scalar(Opcode::TextResponseValid.to_usize().unwrap(),
|
|
||||||
self.token[0] as _, self.token[1] as _, self.token[2] as _, self.token[3] as _,
|
|
||||||
)).expect("couldn't acknowledge text entry");
|
|
||||||
self.unlock();
|
|
||||||
return Ok(response)
|
|
||||||
}
|
|
||||||
},
|
|
||||||
_ => {
|
|
||||||
// we send the valid response token even in this case because we want the modals server to move on and not get stuck on this error.
|
|
||||||
send_message(self.conn,
|
|
||||||
Message::new_blocking_scalar(Opcode::TextResponseValid.to_usize().unwrap(),
|
|
||||||
self.token[0] as _, self.token[1] as _, self.token[2] as _, self.token[3] as _,
|
|
||||||
)).expect("couldn't acknowledge text entry");
|
|
||||||
self.unlock();
|
|
||||||
return Err(xous::Error::InternalError);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -81,9 +81,12 @@ pub(crate) fn spawn_test() {
|
||||||
|
|
||||||
// 2. test the modal dialog box function
|
// 2. test the modal dialog box function
|
||||||
log::info!("test text input");
|
log::info!("test text input");
|
||||||
match modals.get_text("Test input", Some(test_validator), None, None) {
|
match modals
|
||||||
|
.alert_builder("Test input")
|
||||||
|
.field(None, Some(test_validator))
|
||||||
|
.build() {
|
||||||
Ok(text) => {
|
Ok(text) => {
|
||||||
log::info!("Input: {}", text.content);
|
log::info!("Input: {}", text.content()[0].content);
|
||||||
}
|
}
|
||||||
_ => {
|
_ => {
|
||||||
log::error!("get_text failed");
|
log::error!("get_text failed");
|
||||||
|
|
@ -99,7 +102,7 @@ pub(crate) fn spawn_test() {
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
fn test_validator(input: TextEntryPayload, _opcode: u32) -> Option<xous_ipc::String::<256>> {
|
fn test_validator(input: TextEntryPayload) -> Option<xous_ipc::String::<256>> {
|
||||||
let text_str = input.as_str();
|
let text_str = input.as_str();
|
||||||
match text_str.parse::<u32>() {
|
match text_str.parse::<u32>() {
|
||||||
Ok(_input_int) => None,
|
Ok(_input_int) => None,
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue