Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Expanded TextBuffer interface to allow borrowed values. #444

Merged
merged 3 commits into from
Jun 12, 2021
Merged

Expanded TextBuffer interface to allow borrowed values. #444

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
978bc05
Expanded `TextBuffer` interface to allow borrowed values.
Zenithsiz Jun 12, 2021
900fac2
Removed superfluous `PartialEq` requirement on `TextBuffer`.
Zenithsiz Jun 12, 2021
934da56
Removed `std::fmt::Display` requirement for `TextBuffer`.
Zenithsiz Jun 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 53 additions & 18 deletions egui/src/widgets/text_edit.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ use std::ops::Range;
#[derive(Clone, Debug, Default)]
#[cfg_attr(feature = "persistence", derive(serde::Deserialize, serde::Serialize))]
#[cfg_attr(feature = "persistence", serde(default))]
pub(crate) struct State<S: TextBuffer> {
pub(crate) struct State {
cursorp: Option<CursorPair>,

#[cfg_attr(feature = "persistence", serde(skip))]
undoer: Undoer<(CCursorPair, S)>,
undoer: Undoer<(CCursorPair, String)>,

// If IME candidate window is shown on this text edit.
#[cfg_attr(feature = "persistence", serde(skip))]
Expand Down Expand Up @@ -113,9 +113,7 @@ impl CCursorPair {
/// an underlying buffer.
///
/// Most likely you will use a `String` which implements `TextBuffer`.
pub trait TextBuffer:
AsRef<str> + Into<String> + PartialEq + Clone + Default + Send + Sync + 'static + std::fmt::Display
{
pub trait TextBuffer: AsRef<str> + Into<String> {
/// Inserts text `text` into this buffer at character index `ch_idx`.
///
/// # Notes
Expand All @@ -131,9 +129,31 @@ pub trait TextBuffer:
/// `ch_range` is a *character range*, not a byte range.
fn delete_char_range(&mut self, ch_range: Range<usize>);

/// Returns this buffer as a `str`.
///
/// This is an utility method, as it simply relies on the `AsRef<str>`
/// implementation.
fn as_str(&self) -> &str {
self.as_ref()
}

/// Clears all characters in this buffer
fn clear(&mut self) {
self.delete_char_range(0..self.as_ref().len());
}

/// Replaces all contents of this string with `text`
fn replace(&mut self, text: &str) {
self.clear();
self.insert_text(text, 0);
}

/// Clears all characters in this buffer and returns a string of the contents.
fn take(&mut self) -> String {
let s = self.as_ref().to_owned();
self.clear();
s
}
}

impl TextBuffer for String {
Expand All @@ -157,6 +177,18 @@ impl TextBuffer for String {
// Then drain all characters within this range
self.drain(byte_start..byte_end);
}

fn clear(&mut self) {
self.clear();
}

fn replace(&mut self, text: &str) {
*self = text.to_owned();
}

fn take(&mut self) -> String {
std::mem::take(self)
}
}

/// A text region that the user can edit the contents of.
Expand Down Expand Up @@ -206,7 +238,7 @@ impl<'t, S: TextBuffer> TextEdit<'t, S> {
pub fn cursor(ui: &Ui, id: Id) -> Option<CursorPair> {
ui.memory()
.id_data
.get::<State<S>>(&id)
.get::<State>(&id)
.and_then(|state| state.cursorp)
}
}
Expand Down Expand Up @@ -411,7 +443,7 @@ impl<'t, S: TextBuffer> TextEdit<'t, S> {
}
};

let prev_text = text.clone();
let prev_text = text.as_ref().to_owned();
let text_style = text_style
.or(ui.style().override_text_style)
.unwrap_or_else(|| ui.style().body_text_style);
Expand Down Expand Up @@ -451,7 +483,7 @@ impl<'t, S: TextBuffer> TextEdit<'t, S> {
auto_id // Since we are only storing the cursor a persistent Id is not super important
}
});
let mut state = ui.memory().id_data.get_or_default::<State<S>>(id).clone();
let mut state = ui.memory().id_data.get_or_default::<State>(id).clone();

let sense = if enabled {
Sense::click_and_drag()
Expand Down Expand Up @@ -530,9 +562,10 @@ impl<'t, S: TextBuffer> TextEdit<'t, S> {

// We feed state to the undoer both before and after handling input
// so that the undoer creates automatic saves even when there are no events for a while.
state
.undoer
.feed_state(ui.input().time, &(cursorp.as_ccursorp(), text.clone()));
state.undoer.feed_state(
ui.input().time,
&(cursorp.as_ccursorp(), text.as_ref().to_owned()),
);

for event in &ui.input().events {
let did_mutate_text = match event {
Expand All @@ -549,7 +582,7 @@ impl<'t, S: TextBuffer> TextEdit<'t, S> {
}
Event::Cut => {
if cursorp.is_empty() {
copy_if_not_password(ui, std::mem::take(text).into());
copy_if_not_password(ui, text.take());
Some(CCursorPair::default())
} else {
copy_if_not_password(
Expand Down Expand Up @@ -610,10 +643,11 @@ impl<'t, S: TextBuffer> TextEdit<'t, S> {
modifiers,
} if modifiers.command && !modifiers.shift => {
// TODO: redo
if let Some((undo_ccursorp, undo_txt)) =
state.undoer.undo(&(cursorp.as_ccursorp(), text.clone()))
if let Some((undo_ccursorp, undo_txt)) = state
.undoer
.undo(&(cursorp.as_ccursorp(), text.as_ref().to_owned()))
{
*text = undo_txt.clone();
text.replace(undo_txt);
Some(*undo_ccursorp)
} else {
None
Expand Down Expand Up @@ -680,9 +714,10 @@ impl<'t, S: TextBuffer> TextEdit<'t, S> {
state.cursorp = Some(cursorp);
text_cursor = Some(cursorp);

state
.undoer
.feed_state(ui.input().time, &(cursorp.as_ccursorp(), text.clone()));
state.undoer.feed_state(
ui.input().time,
&(cursorp.as_ccursorp(), text.as_ref().to_owned()),
);
}

if ui.memory().has_focus(id) {
Expand Down