use crate::core::interval::Interval; use crate::core::ot_str::OTString; use crate::errors::OTError; use serde::{Deserialize, Serialize, __private::Formatter}; use std::fmt::Display; use std::{ cmp::min, fmt, fmt::Debug, ops::{Deref, DerefMut}, }; pub trait OperationTransform { /// Merges the operation with `other` into one operation while preserving /// the changes of both. /// /// # Arguments /// /// * `other`: The delta gonna to merge. /// /// # Examples /// /// ``` /// use lib_ot::core::{OperationTransform, TextDeltaBuilder}; /// let document = TextDeltaBuilder::new().build(); /// let delta = TextDeltaBuilder::new().insert("abc").build(); /// let new_document = document.compose(&delta).unwrap(); /// assert_eq!(new_document.content_str().unwrap(), "abc".to_owned()); /// ``` fn compose(&self, other: &Self) -> Result where Self: Sized; /// Transforms two operations a and b that happened concurrently and /// produces two operations a' and b'. /// (a', b') = a.transform(b) /// a.compose(b') = b.compose(a') /// fn transform(&self, other: &Self) -> Result<(Self, Self), OTError> where Self: Sized; /// Returns the invert delta from the other. It can be used to do the undo operation. /// /// # Arguments /// /// * `other`: Generate the undo delta for [Other]. [Other] can compose the undo delta to return /// to the previous state. /// /// # Examples /// /// ``` /// use lib_ot::core::{OperationTransform, TextDeltaBuilder}; /// let original_document = TextDeltaBuilder::new().build(); /// let delta = TextDeltaBuilder::new().insert("abc").build(); /// /// let undo_delta = delta.invert(&original_document); /// let new_document = original_document.compose(&delta).unwrap(); /// let document = new_document.compose(&undo_delta).unwrap(); /// /// assert_eq!(original_document, document); /// /// ``` fn invert(&self, other: &Self) -> Self; } /// Each operation can carry attributes. For example, the [RichTextAttributes] has a list of key/value attributes. /// Such as { bold: true, italic: true }. /// ///Because [Operation] is generic over the T, so you must specify the T. For example, the [TextDelta] uses ///[PhantomAttributes] as the T. [PhantomAttributes] does nothing, just a phantom. /// pub trait Attributes: Default + Display + Eq + PartialEq + Clone + Debug + OperationTransform { fn is_empty(&self) -> bool { true } /// Remove the empty attribute which value is None. fn remove_empty(&mut self) { // Do nothing } fn extend_other(&mut self, _other: Self) { // Do nothing } } /// [Operation] consists of three types. /// * Delete /// * Retain /// * Insert /// /// You could check [this](https://appflowy.gitbook.io/docs/essential-documentation/contribute-to-appflowy/architecture/backend/delta) out for more information. /// /// The [T] should support serde if you want to serialize/deserialize the operation /// to json string. You could check out the operation_serde.rs for more information. /// #[derive(Debug, Clone, Eq, PartialEq)] pub enum Operation { Delete(usize), Retain(Retain), Insert(Insert), } impl Operation where T: Attributes, { pub fn delete(n: usize) -> Self { Self::Delete(n) } /// Create a [Retain] operation with the given attributes pub fn retain_with_attributes(n: usize, attributes: T) -> Self { Self::Retain(Retain { n, attributes }) } /// Create a [Retain] operation without attributes pub fn retain(n: usize) -> Self { Self::Retain(Retain { n, attributes: T::default(), }) } /// Create a [Insert] operation with the given attributes pub fn insert_with_attributes(s: &str, attributes: T) -> Self { Self::Insert(Insert { s: OTString::from(s), attributes, }) } /// Create a [Insert] operation without attributes pub fn insert(s: &str) -> Self { Self::Insert(Insert { s: OTString::from(s), attributes: T::default(), }) } /// Return the String if the operation is [Insert] operation, otherwise return the empty string. pub fn get_data(&self) -> &str { match self { Operation::Delete(_) => "", Operation::Retain(_) => "", Operation::Insert(insert) => &insert.s, } } pub fn get_attributes(&self) -> T { match self { Operation::Delete(_) => T::default(), Operation::Retain(retain) => retain.attributes.clone(), Operation::Insert(insert) => insert.attributes.clone(), } } pub fn set_attributes(&mut self, attributes: T) { match self { Operation::Delete(_) => log::error!("Delete should not contains attributes"), Operation::Retain(retain) => retain.attributes = attributes, Operation::Insert(insert) => insert.attributes = attributes, } } pub fn has_attribute(&self) -> bool { !self.get_attributes().is_empty() } pub fn len(&self) -> usize { match self { Operation::Delete(n) => *n, Operation::Retain(r) => r.n, Operation::Insert(i) => i.utf16_size(), } } pub fn is_empty(&self) -> bool { self.len() == 0 } #[allow(dead_code)] pub fn split(&self, index: usize) -> (Option>, Option>) { debug_assert!(index < self.len()); let left; let right; match self { Operation::Delete(n) => { left = Some(Operation::::delete(index)); right = Some(Operation::::delete(*n - index)); } Operation::Retain(retain) => { left = Some(Operation::::delete(index)); right = Some(Operation::::delete(retain.n - index)); } Operation::Insert(insert) => { let attributes = self.get_attributes(); left = Some(Operation::::insert_with_attributes( &insert.s[0..index], attributes.clone(), )); right = Some(Operation::::insert_with_attributes( &insert.s[index..insert.utf16_size()], attributes, )); } } (left, right) } /// Returns an operation with the specified width. /// # Arguments /// /// * `interval`: Specify the shrink width of the operation. /// /// # Examples /// /// ``` /// use lib_ot::core::{Interval, Operation, PhantomAttributes}; /// let operation = Operation::::insert("1234"); /// /// let op1 = operation.shrink(Interval::new(0,3)).unwrap(); /// assert_eq!(op1 , Operation::insert("123")); /// /// let op2= operation.shrink(Interval::new(3,4)).unwrap(); /// assert_eq!(op2, Operation::insert("4")); /// ``` pub fn shrink(&self, interval: Interval) -> Option> { let op = match self { Operation::Delete(n) => Operation::delete(min(*n, interval.size())), Operation::Retain(retain) => { Operation::retain_with_attributes(min(retain.n, interval.size()), retain.attributes.clone()) } Operation::Insert(insert) => { if interval.start > insert.utf16_size() { Operation::insert("") } else { let s = insert.s.sub_str(interval).unwrap_or_else(|| "".to_owned()); Operation::insert_with_attributes(&s, insert.attributes.clone()) } } }; match op.is_empty() { true => None, false => Some(op), } } pub fn is_delete(&self) -> bool { if let Operation::Delete(_) = self { return true; } false } pub fn is_insert(&self) -> bool { if let Operation::Insert(_) = self { return true; } false } pub fn is_retain(&self) -> bool { if let Operation::Retain(_) = self { return true; } false } pub fn is_plain(&self) -> bool { match self { Operation::Delete(_) => true, Operation::Retain(retain) => retain.is_plain(), Operation::Insert(insert) => insert.is_plain(), } } } impl fmt::Display for Operation where T: Attributes, { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { f.write_str("{")?; match self { Operation::Delete(n) => { f.write_fmt(format_args!("delete: {}", n))?; } Operation::Retain(r) => { f.write_fmt(format_args!("{}", r))?; } Operation::Insert(i) => { f.write_fmt(format_args!("{}", i))?; } } f.write_str("}")?; Ok(()) } } #[derive(Clone, Debug, Eq, PartialEq)] pub struct Retain { pub n: usize, pub attributes: T, } impl fmt::Display for Retain where T: Attributes, { fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { if self.attributes.is_empty() { f.write_fmt(format_args!("retain: {}", self.n)) } else { f.write_fmt(format_args!("retain: {}, attributes: {}", self.n, self.attributes)) } } } impl Retain where T: Attributes, { pub fn merge_or_new(&mut self, n: usize, attributes: T) -> Option> { // tracing::trace!( // "merge_retain_or_new_op: len: {:?}, l: {} - r: {}", // n, // self.attributes, // attributes // ); if self.attributes == attributes { self.n += n; None } else { Some(Operation::retain_with_attributes(n, attributes)) } } pub fn is_plain(&self) -> bool { self.attributes.is_empty() } } impl std::convert::From for Retain where T: Attributes, { fn from(n: usize) -> Self { Retain { n, attributes: T::default(), } } } impl Deref for Retain where T: Attributes, { type Target = usize; fn deref(&self) -> &Self::Target { &self.n } } impl DerefMut for Retain where T: Attributes, { fn deref_mut(&mut self) -> &mut Self::Target { &mut self.n } } #[derive(Clone, Debug, Eq, PartialEq)] pub struct Insert { pub s: OTString, pub attributes: T, } impl fmt::Display for Insert where T: Attributes, { fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { let mut s = self.s.clone(); if s.ends_with('\n') { s.pop(); if s.is_empty() { s = "new_line".into(); } } if self.attributes.is_empty() { f.write_fmt(format_args!("insert: {}", s)) } else { f.write_fmt(format_args!("insert: {}, attributes: {}", s, self.attributes)) } } } impl Insert where T: Attributes, { pub fn utf16_size(&self) -> usize { self.s.utf16_len() } pub fn merge_or_new_op(&mut self, s: &str, attributes: T) -> Option> { if self.attributes == attributes { self.s += s; None } else { Some(Operation::::insert_with_attributes(s, attributes)) } } pub fn is_plain(&self) -> bool { self.attributes.is_empty() } } impl std::convert::From for Insert where T: Attributes, { fn from(s: String) -> Self { Insert { s: s.into(), attributes: T::default(), } } } impl std::convert::From<&str> for Insert where T: Attributes, { fn from(s: &str) -> Self { Insert::from(s.to_owned()) } } impl std::convert::From for Insert where T: Attributes, { fn from(s: OTString) -> Self { Insert { s, attributes: T::default(), } } } #[derive(Debug, Clone, Eq, PartialEq, Default, Serialize, Deserialize)] pub struct PhantomAttributes(); impl fmt::Display for PhantomAttributes { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { f.write_str("PhantomAttributes") } } impl Attributes for PhantomAttributes {} impl OperationTransform for PhantomAttributes { fn compose(&self, _other: &Self) -> Result { Ok(self.clone()) } fn transform(&self, other: &Self) -> Result<(Self, Self), OTError> { Ok((self.clone(), other.clone())) } fn invert(&self, _other: &Self) -> Self { self.clone() } }