xmppftw/xmpp-rs
Watch
1
0
Fork
You've already forked xmpp-rs
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

xmpp-parsers: Simplify RTT implementation using more xso

Browse source 
Especially exhaustive enums are super useful for this kind of pattern.
This commit is contained in:
Emmanuel Gil Peyrot 2024-08-04 17:06:00 +02:00 • committed by Jonas Schäfer
commit 95d08e3c1e
2 changed files with 76 additions and 208 deletions
Download patch file Download diff file Expand all files Collapse all files

6
parsers/ChangeLog
View file

@ -9,6 +9,12 @@ XXXX-YY-ZZ RELEASER <admin@example.com>
are now of type `BareJid` (instead of `String`), as they should always are now of type `BareJid` (instead of `String`), as they should always
have been. This influences various other places, such as these have been. This influences various other places, such as these
struct's constructors. struct's constructors.
- The rtt module has been changed to make use of xso on enums. This
allows us to simplify the `Action` type to include all three possible
variants directly in the enum, rather than as separate types which are
then included in `Action`. Also `Action::Erase::num` is now a wrapper
type around u32, which lets us implement a custom Default on it.
(!416)
* New parsers/serialisers: * New parsers/serialisers:
- Stream Features (RFC 6120) (!400) - Stream Features (RFC 6120) (!400)

244
parsers/src/rtt.rs
View file

@ -7,8 +7,6 @@
use xso::{text::EmptyAsNone, AsXml, FromXml}; use xso::{text::EmptyAsNone, AsXml, FromXml};
use crate::ns; use crate::ns;
use minidom::Element;
use xso::error::{Error, FromElementError};
generate_attribute!( generate_attribute!(
/// Events for real-time text. /// Events for real-time text.
@ -30,228 +28,87 @@ generate_attribute!(
}, Default = Edit }, Default = Edit
); );
generate_attribute!(
/// The number of codepoints to erase.
Num, "n", u32, Default = 1
);
/// Choice between the three possible actions.
#[derive(FromXml, AsXml, Debug, Clone, PartialEq)]
#[xml(namespace = ns::RTT, exhaustive)]
pub enum Action {
/// Supports the transmission of text, including key presses, and text block inserts. /// Supports the transmission of text, including key presses, and text block inserts.
#[derive(FromXml, AsXml, PartialEq, Debug, Clone)] #[xml(name = "t")]
#[xml(namespace = ns::RTT, name = "t")] Insert {
pub struct Insert {
/// Position in the message to start inserting from. If None, this means to start from the /// Position in the message to start inserting from. If None, this means to start from the
/// end of the message. /// end of the message.
#[xml(attribute(default, name = "p"))] #[xml(attribute(default, name = "p"))]
pub pos: Option<u32>, pos: Option<u32>,
/// Text to insert. /// Text to insert.
#[xml(text = EmptyAsNone)] #[xml(text = EmptyAsNone)]
pub text: Option<String>, text: Option<String>,
} },
impl TryFrom<Action> for Insert {
type Error = Error;
fn try_from(action: Action) -> Result<Insert, Error> {
match action {
Action::Insert(insert) => Ok(insert),
_ => Err(Error::Other("This is not an insert action.")),
}
}
}
// TODO: add a way in the macro to set a default value.
/*
generate_element!(
Erase, "e", RTT,
attributes: [
pos: Option<u32> = "p",
num: Default<u32> = "n",
]
);
*/
/// Supports the behavior of backspace key presses. Text is removed towards beginning of the /// Supports the behavior of backspace key presses. Text is removed towards beginning of the
/// message. This element is also used for all delete operations, including the backspace key, the /// message. This element is also used for all delete operations, including the backspace key,
/// delete key, and text block deletes. /// the delete key, and text block deletes.
#[derive(Debug, Clone, PartialEq)] #[xml(name = "e")]
pub struct Erase { Erase {
/// Position in the message to start erasing from. If None, this means to start from the end /// Position in the message to start erasing from. If None, this means to start from the end
/// of the message. /// of the message.
pub pos: Option<u32>, #[xml(attribute(default))]
pos: Option<u32>,
/// Amount of characters to erase, to the left. /// Amount of characters to erase, to the left.
pub num: u32, #[xml(attribute(default))]
} num: Num,
},
impl TryFrom<Element> for Erase {
type Error = FromElementError;
fn try_from(elem: Element) -> Result<Erase, FromElementError> {
check_self!(elem, "e", RTT);
check_no_unknown_attributes!(elem, "e", ["p", "n"]);
let pos = get_attr!(elem, "p", Option);
let num = get_attr!(elem, "n", Option).unwrap_or(1);
check_no_children!(elem, "e");
Ok(Erase { pos, num })
}
}
impl From<Erase> for Element {
fn from(elem: Erase) -> Element {
Element::builder("e", ns::RTT)
.attr("p", elem.pos)
.attr("n", elem.num)
.build()
}
}
impl TryFrom<Action> for Erase {
type Error = Error;
fn try_from(action: Action) -> Result<Erase, Error> {
match action {
Action::Erase(erase) => Ok(erase),
_ => Err(Error::Other("This is not an erase action.")),
}
}
}
/// Allow for the transmission of intervals, between real-time text actions, to recreate the /// Allow for the transmission of intervals, between real-time text actions, to recreate the
/// pauses between key presses. /// pauses between key presses.
#[derive(FromXml, AsXml, PartialEq, Debug, Clone)] #[xml(name = "w")]
#[xml(namespace = ns::RTT, name = "w")] Wait {
pub struct Wait {
/// Amount of milliseconds to wait before the next action. /// Amount of milliseconds to wait before the next action.
#[xml(attribute = "n")] #[xml(attribute = "n")]
pub time: u32, time: u32,
},
} }
impl TryFrom<Action> for Wait {
type Error = Error;
fn try_from(action: Action) -> Result<Wait, Error> {
match action {
Action::Wait(wait) => Ok(wait),
_ => Err(Error::Other("This is not a wait action.")),
}
}
}
/// Choice between the three possible actions.
#[derive(Debug, Clone, PartialEq)]
pub enum Action {
/// Insert text action.
Insert(Insert),
/// Erase text action.
Erase(Erase),
/// Wait action.
Wait(Wait),
}
impl TryFrom<Element> for Action {
type Error = FromElementError;
fn try_from(elem: Element) -> Result<Action, FromElementError> {
match elem.name() {
"t" => Insert::try_from(elem).map(Action::Insert),
"e" => Erase::try_from(elem).map(Action::Erase),
"w" => Wait::try_from(elem).map(Action::Wait),
_ => Err(FromElementError::Mismatch(elem)),
}
}
}
impl From<Action> for Element {
fn from(action: Action) -> Element {
match action {
Action::Insert(insert) => Element::from(insert),
Action::Erase(erase) => Element::from(erase),
Action::Wait(wait) => Element::from(wait),
}
}
}
// TODO: Allow a wildcard name to the macro, to simplify the following code:
/*
generate_element!(
Rtt, "rtt", RTT,
attributes: [
seq: Required<u32> = "seq",
event: Default<Event> = "event",
id: Option<String> = "id",
],
children: [
actions: Vec<Action> = (*, RTT) => Action,
]
);
*/
/// Element transmitted at regular interval by the sender client while a message is being composed. /// Element transmitted at regular interval by the sender client while a message is being composed.
#[derive(Debug, Clone, PartialEq)] #[derive(FromXml, AsXml, Debug, Clone, PartialEq)]
#[xml(namespace = ns::RTT, name = "rtt")]
pub struct Rtt { pub struct Rtt {
/// Counter to maintain synchronisation of real-time text. Senders MUST increment this value /// Counter to maintain synchronisation of real-time text. Senders MUST increment this value
/// by 1 for each subsequent edit to the same real-time message, including when appending new /// by 1 for each subsequent edit to the same real-time message, including when appending new
/// text. Receiving clients MUST monitor this 'seq' value as a lightweight verification on the /// text. Receiving clients MUST monitor this 'seq' value as a lightweight verification on the
/// synchronization of real-time text messages. The bounds of 'seq' is 31-bits, the range of /// synchronization of real-time text messages. The bounds of 'seq' is 31-bits, the range of
/// positive values for a signed 32-bit integer. /// positive values for a signed 32-bit integer.
#[xml(attribute)]
pub seq: u32, pub seq: u32,
/// This attribute signals events for real-time text. /// This attribute signals events for real-time text.
#[xml(attribute(default))]
pub event: Event, pub event: Event,
/// When editing a message using XEP-0308, this references the id of the message being edited. /// When editing a message using XEP-0308, this references the id of the message being edited.
#[xml(attribute(default))]
pub id: Option<String>, pub id: Option<String>,
/// Vector of actions being transmitted by this element. /// Vector of actions being transmitted by this element.
#[xml(child(n = ..))]
pub actions: Vec<Action>, pub actions: Vec<Action>,
} }
impl TryFrom<Element> for Rtt {
type Error = FromElementError;
fn try_from(elem: Element) -> Result<Rtt, FromElementError> {
check_self!(elem, "rtt", RTT);
check_no_unknown_attributes!(elem, "rtt", ["seq", "event", "id"]);
let seq = get_attr!(elem, "seq", Required);
let event = get_attr!(elem, "event", Default);
let id = get_attr!(elem, "id", Option);
let mut actions = Vec::new();
for child in elem.children() {
if child.ns() != ns::RTT {
return Err(Error::Other("Unknown child in rtt element.").into());
}
actions.push(Action::try_from(child.clone())?);
}
Ok(Rtt {
seq,
event,
id,
actions,
})
}
}
impl From<Rtt> for Element {
fn from(elem: Rtt) -> Element {
Element::builder("rtt", ns::RTT)
.attr("seq", elem.seq)
.attr("event", elem.event)
.attr("id", elem.id)
.append_all(elem.actions)
.build()
}
}
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use super::*; use super::*;
use minidom::Element;
#[cfg(target_pointer_width = "32")] #[cfg(target_pointer_width = "32")]
#[test] #[test]
fn test_size() { fn test_size() {
assert_size!(Event, 1); assert_size!(Event, 1);
assert_size!(Insert, 20);
assert_size!(Erase, 12);
assert_size!(Wait, 4);
assert_size!(Action, 20); assert_size!(Action, 20);
assert_size!(Rtt, 32); assert_size!(Rtt, 32);
} }
@ -260,9 +117,6 @@ mod tests {
#[test] #[test]
fn test_size() { fn test_size() {
assert_size!(Event, 1); assert_size!(Event, 1);
assert_size!(Insert, 32);
assert_size!(Erase, 12);
assert_size!(Wait, 4);
assert_size!(Action, 32); assert_size!(Action, 32);
assert_size!(Rtt, 56); assert_size!(Rtt, 56);
} }
@ -291,19 +145,27 @@ mod tests {
let mut actions = rtt.actions.into_iter(); let mut actions = rtt.actions.into_iter();
assert_eq!(actions.len(), 4); assert_eq!(actions.len(), 4);
let t: Insert = actions.next().unwrap().try_into().unwrap(); let Action::Insert { pos, text } = actions.next().unwrap() else {
assert_eq!(t.pos, None); panic!()
assert_eq!(t.text, Some(String::from("Hello,"))); };
assert_eq!(pos, None);
assert_eq!(text.unwrap(), "Hello,");
let w: Wait = actions.next().unwrap().try_into().unwrap(); let Action::Wait { time } = actions.next().unwrap() else {
assert_eq!(w.time, 50); panic!()
};
assert_eq!(time, 50);
let e: Erase = actions.next().unwrap().try_into().unwrap(); let Action::Erase { pos, num } = actions.next().unwrap() else {
assert_eq!(e.pos, None); panic!()
assert_eq!(e.num, 1); };
assert_eq!(pos, None);
assert_eq!(num, Num(1));
let t: Insert = actions.next().unwrap().try_into().unwrap(); let Action::Insert { pos, text } = actions.next().unwrap() else {
assert_eq!(t.pos, None); panic!()
assert_eq!(t.text, Some(String::from("!"))); };
assert_eq!(pos, None);
assert_eq!(text.unwrap(), "!");
} }
} }