mirror of
https://github.com/emilk/egui.git
synced 2026-08-31 05:40:03 -04:00
fe631ff9ea
This change allows `layouter` to use the `TextBuffer` instead of `&str` in the closure. It is necessary when layout decisions depend on more than just the raw string content, such as metadata stored in the concrete type implementing `TextBuffer`. In [our use case](https://github.com/damus-io/notedeck/pull/723), we needed this to support mention highlighting when a user selects a mention. Since mentions can contain spaces, determining mention boundaries from the `&str` alone is impossible. Instead, we use the `TextBuffer` implementation to retrieve the correct bounds. See the video below for a demonstration: https://github.com/user-attachments/assets/3cba2906-5546-4b52-b728-1da9c56a83e1 # Breaking change This PR introduces a breaking change to the `layouter` function in `TextEdit`. Previous API: ```rust pub fn layouter(mut self, layouter: &'t mut dyn FnMut(&Ui, &str, f32) -> Arc<Galley>) -> Self ``` New API: ```rust pub fn layouter(mut self, layouter: &'t mut dyn FnMut(&Ui, &dyn TextBuffer, f32) -> Arc<Galley>) -> Self ``` ## Impact on Existing Code • Any existing usage of `layouter` will **no longer compile**. • Callers must update their closures to use `&dyn TextBuffer` instead of `&str`. ## Migration Guide Before: ```rust let mut layouter = |ui: &Ui, text: &str, wrap_width: f32| { let layout_job = my_highlighter(text); layout_job.wrap.max_width = wrap_width; ui.fonts(|f| f.layout_job(layout_job)) }; ``` After: ```rust let mut layouter = |ui: &Ui, text: &dyn TextBuffer, wrap_width: f32| { let layout_job = my_highlighter(text.as_str()); layout_job.wrap.max_width = wrap_width; ui.fonts(|f| f.layout_job(layout_job)) }; ``` --- * There is not an issue for this change. * [x] I have followed the instructions in the PR template Signed-off-by: kernelkind <kernelkind@gmail.com>
104 lines
3.2 KiB
Rust
104 lines
3.2 KiB
Rust
// ----------------------------------------------------------------------------
|
|
|
|
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
|
|
#[cfg_attr(feature = "serde", serde(default))]
|
|
pub struct CodeEditor {
|
|
language: String,
|
|
code: String,
|
|
}
|
|
|
|
impl Default for CodeEditor {
|
|
fn default() -> Self {
|
|
Self {
|
|
language: "rs".into(),
|
|
code: "// A very simple example\n\
|
|
fn main() {\n\
|
|
\tprintln!(\"Hello world!\");\n\
|
|
}\n\
|
|
"
|
|
.into(),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl crate::Demo for CodeEditor {
|
|
fn name(&self) -> &'static str {
|
|
"🖮 Code Editor"
|
|
}
|
|
|
|
fn show(&mut self, ctx: &egui::Context, open: &mut bool) {
|
|
use crate::View as _;
|
|
egui::Window::new(self.name())
|
|
.open(open)
|
|
.default_height(500.0)
|
|
.show(ctx, |ui| self.ui(ui));
|
|
}
|
|
}
|
|
|
|
impl crate::View for CodeEditor {
|
|
fn ui(&mut self, ui: &mut egui::Ui) {
|
|
let Self { language, code } = self;
|
|
|
|
ui.horizontal(|ui| {
|
|
ui.set_height(0.0);
|
|
ui.label("An example of syntax highlighting in a TextEdit.");
|
|
ui.add(crate::egui_github_link_file!());
|
|
});
|
|
|
|
if cfg!(feature = "syntect") {
|
|
ui.horizontal(|ui| {
|
|
ui.label("Language:");
|
|
ui.text_edit_singleline(language);
|
|
});
|
|
ui.horizontal_wrapped(|ui| {
|
|
ui.spacing_mut().item_spacing.x = 0.0;
|
|
ui.label("Syntax highlighting powered by ");
|
|
ui.hyperlink_to("syntect", "https://github.com/trishume/syntect");
|
|
ui.label(".");
|
|
});
|
|
} else {
|
|
ui.horizontal_wrapped(|ui| {
|
|
ui.spacing_mut().item_spacing.x = 0.0;
|
|
ui.label("Compile the demo with the ");
|
|
ui.code("syntax_highlighting");
|
|
ui.label(" feature to enable more accurate syntax highlighting using ");
|
|
ui.hyperlink_to("syntect", "https://github.com/trishume/syntect");
|
|
ui.label(".");
|
|
});
|
|
}
|
|
|
|
let mut theme =
|
|
egui_extras::syntax_highlighting::CodeTheme::from_memory(ui.ctx(), ui.style());
|
|
ui.collapsing("Theme", |ui| {
|
|
ui.group(|ui| {
|
|
theme.ui(ui);
|
|
theme.clone().store_in_memory(ui.ctx());
|
|
});
|
|
});
|
|
|
|
let mut layouter = |ui: &egui::Ui, buf: &dyn egui::TextBuffer, wrap_width: f32| {
|
|
let mut layout_job = egui_extras::syntax_highlighting::highlight(
|
|
ui.ctx(),
|
|
ui.style(),
|
|
&theme,
|
|
buf.as_str(),
|
|
language,
|
|
);
|
|
layout_job.wrap.max_width = wrap_width;
|
|
ui.fonts(|f| f.layout_job(layout_job))
|
|
};
|
|
|
|
egui::ScrollArea::vertical().show(ui, |ui| {
|
|
ui.add(
|
|
egui::TextEdit::multiline(code)
|
|
.font(egui::TextStyle::Monospace) // for cursor height
|
|
.code_editor()
|
|
.desired_rows(10)
|
|
.lock_focus(true)
|
|
.desired_width(f32::INFINITY)
|
|
.layouter(&mut layouter),
|
|
);
|
|
});
|
|
}
|
|
}
|