use iced_widget::graphics::text::Paragraph;
use crate::core::alignment;
use crate::core::clipboard;
use crate::core::keyboard;
use crate::core::keyboard::key;
use crate::core::layout;
use crate::core::mouse;
use crate::core::renderer;
use crate::core::text::{Paragraph as _, Span};
use crate::core::touch;
use crate::core::widget::text::{Alignment, LineHeight, Shaping, Wrapping};
use crate::core::widget::tree::{self, Tree};
use crate::core::{
self, Clipboard, Element, Event, Font, Layout, Length, Pixels, Point,
Rectangle, Shell, Size, Vector, Widget,
};
use crate::selection::{Selection, SelectionEnd};
use crate::text::{Catalog, Dragging, Style, StyleFn};
pub struct Rich<
'a,
Link,
Message,
Theme = iced_widget::Theme,
Renderer = iced_widget::Renderer,
> where
Link: Clone + 'static,
Theme: Catalog,
Renderer: core::text::Renderer,
{
spans: Box<dyn AsRef<[Span<'a, Link, Renderer::Font>]> + 'a>,
size: Option<Pixels>,
line_height: LineHeight,
width: Length,
height: Length,
font: Option<Renderer::Font>,
align_x: Alignment,
align_y: alignment::Vertical,
wrapping: Wrapping,
class: Theme::Class<'a>,
on_link_click: Option<Box<dyn Fn(Link) -> Message + 'a>>,
on_link_hover: Option<Box<dyn Fn(Link) -> Message + 'a>>,
on_hover_lost: Option<Box<dyn Fn() -> Message + 'a>>,
}
impl<'a, Link, Message, Theme, Renderer>
Rich<'a, Link, Message, Theme, Renderer>
where
Link: Clone + 'static,
Theme: Catalog,
Renderer: core::text::Renderer,
Renderer::Font: 'a,
{
pub fn new() -> Self {
Self {
spans: Box::new([]),
size: None,
line_height: LineHeight::default(),
width: Length::Shrink,
height: Length::Shrink,
font: None,
align_x: Alignment::Default,
align_y: alignment::Vertical::Top,
wrapping: Wrapping::default(),
class: Theme::default(),
on_link_click: None,
on_link_hover: None,
on_hover_lost: None,
}
}
pub fn with_spans(
spans: impl AsRef<[Span<'a, Link, Renderer::Font>]> + 'a,
) -> Self {
Self {
spans: Box::new(spans),
..Self::new()
}
}
pub fn size(mut self, size: impl Into<Pixels>) -> Self {
self.size = Some(size.into());
self
}
pub fn line_height(mut self, line_height: impl Into<LineHeight>) -> Self {
self.line_height = line_height.into();
self
}
pub fn font(mut self, font: impl Into<Renderer::Font>) -> Self {
self.font = Some(font.into());
self
}
pub fn width(mut self, width: impl Into<Length>) -> Self {
self.width = width.into();
self
}
pub fn height(mut self, height: impl Into<Length>) -> Self {
self.height = height.into();
self
}
pub fn center(self) -> Self {
self.align_x(alignment::Horizontal::Center)
.align_y(alignment::Vertical::Center)
}
pub fn align_x(mut self, alignment: impl Into<Alignment>) -> Self {
self.align_x = alignment.into();
self
}
pub fn align_y(
mut self,
alignment: impl Into<alignment::Vertical>,
) -> Self {
self.align_y = alignment.into();
self
}
pub fn wrapping(mut self, wrapping: Wrapping) -> Self {
self.wrapping = wrapping;
self
}
pub fn on_link_click(
mut self,
on_link_clicked: impl Fn(Link) -> Message + 'a,
) -> Self {
self.on_link_click = Some(Box::new(on_link_clicked));
self
}
pub fn on_link_hover(
mut self,
on_link_hovered: impl Fn(Link) -> Message + 'a,
) -> Self {
self.on_link_hover = Some(Box::new(on_link_hovered));
self
}
pub fn on_hover_lost(mut self, on_hover_lost: Message) -> Self
where
Message: Clone + 'a,
{
self.on_hover_lost = Some(Box::new(move || on_hover_lost.clone()));
self
}
pub fn on_hover_lost_with(
mut self,
on_hover_lost: impl Fn() -> Message + 'a,
) -> Self {
self.on_hover_lost = Some(Box::new(on_hover_lost));
self
}
#[must_use]
pub fn style(mut self, style: impl Fn(&Theme) -> Style + 'a) -> Self
where
Theme::Class<'a>: From<StyleFn<'a, Theme>>,
{
self.class = (Box::new(style) as StyleFn<'a, Theme>).into();
self
}
#[must_use]
pub fn class(mut self, class: impl Into<Theme::Class<'a>>) -> Self {
self.class = class.into();
self
}
}
impl<'a, Link, Message, Theme, Renderer> Default
for Rich<'a, Link, Message, Theme, Renderer>
where
Link: Clone + 'a,
Theme: Catalog,
Renderer: core::text::Renderer<Paragraph = Paragraph, Font = Font>,
Renderer::Font: 'a,
{
fn default() -> Self {
Self::new()
}
}
struct State<Link> {
spans: Vec<Span<'static, Link, Font>>,
span_pressed: Option<usize>,
hovered_link: Option<usize>,
paragraph: Paragraph,
is_hovered: bool,
selection: Selection,
dragging: Option<Dragging>,
last_click: Option<mouse::Click>,
keyboard_modifiers: keyboard::Modifiers,
}
impl<Link> State<Link> {
fn grapheme_line_and_index(&self, point: Point) -> Option<(usize, usize)> {
let cursor = self.paragraph.buffer().hit(point.x, point.y)?;
let value = self.paragraph.buffer().lines[cursor.line].text();
Some((
cursor.line,
unicode_segmentation::UnicodeSegmentation::graphemes(
&value[..cursor.index.min(value.len())],
true,
)
.count(),
))
}
fn selection_end_points(&self) -> (usize, Point, Point) {
let Selection { start, end, .. } = self.selection;
let (start_row, start_position) = self
.grapheme_position(start.line, start.index)
.unwrap_or_default();
let (end_row, end_position) = self
.grapheme_position(end.line, end.index)
.unwrap_or_default();
(
end_row.saturating_sub(start_row) + 1,
start_position,
end_position,
)
}
fn grapheme_position(
&self,
line: usize,
index: usize,
) -> Option<(usize, Point)> {
use unicode_segmentation::UnicodeSegmentation;
let mut first_run_index = None;
let mut last_run_index = None;
let mut last_start = None;
let mut last_grapheme_count = 0;
let mut last_run_graphemes = 0;
let mut real_index = 0;
let mut graphemes_seen = 0;
let mut glyphs = self
.paragraph
.buffer()
.layout_runs()
.enumerate()
.filter(|(_, run)| run.line_i == line)
.flat_map(|(run_idx, run)| {
let line_top = run.line_top;
if first_run_index.is_none() {
first_run_index = Some(run_idx);
}
run.glyphs.iter().map(move |glyph| {
let mut glyph = glyph.clone();
glyph.y += line_top;
(run_idx, glyph, run.text)
})
});
let (_, glyph, _) = glyphs
.find(|(run_idx, glyph, text)| {
if Some(glyph.start) != last_start {
last_grapheme_count =
text[glyph.start..glyph.end].graphemes(false).count();
last_start = Some(glyph.start);
graphemes_seen += last_grapheme_count;
last_run_graphemes += last_grapheme_count;
real_index += last_grapheme_count;
if Some(*run_idx) != last_run_index
&& graphemes_seen < index
{
real_index = last_grapheme_count;
last_run_graphemes = last_grapheme_count;
}
} else if Some(*run_idx) != last_run_index
&& graphemes_seen < index
{
real_index = 0;
last_run_graphemes = 0;
}
last_run_index = Some(*run_idx);
graphemes_seen >= index
})
.or_else(|| glyphs.last())?;
real_index -= graphemes_seen.saturating_sub(index);
real_index =
real_index.saturating_sub(last_run_index? - first_run_index?);
last_run_graphemes = last_run_graphemes
.saturating_sub(last_run_index? - first_run_index?);
let advance = if last_run_index? - first_run_index? <= 1 {
if real_index == 0 {
0.0
} else {
glyph.w
* (1.0
- last_run_graphemes.saturating_sub(real_index) as f32
/ last_grapheme_count.max(1) as f32)
- glyph.w * (last_run_index? - first_run_index?) as f32
}
} else {
-(glyph.w
* (1.0
+ last_run_graphemes.saturating_sub(real_index) as f32
/ last_grapheme_count.max(1) as f32))
};
Some((
last_run_index?,
Point::new(
glyph.x + glyph.x_offset * glyph.font_size + advance,
glyph.y - glyph.y_offset * glyph.font_size,
),
))
}
}
impl<Link, Message, Theme, Renderer> Widget<Message, Theme, Renderer>
for Rich<'_, Link, Message, Theme, Renderer>
where
Link: Clone + 'static,
Theme: Catalog,
Renderer: core::text::Renderer<Paragraph = Paragraph, Font = Font>,
{
fn tag(&self) -> tree::Tag {
tree::Tag::of::<State<Link>>()
}
fn state(&self) -> tree::State {
tree::State::new(State::<Link> {
spans: Vec::new(),
span_pressed: None,
hovered_link: None,
paragraph: Paragraph::default(),
is_hovered: false,
selection: Selection::default(),
dragging: None,
last_click: None,
keyboard_modifiers: keyboard::Modifiers::default(),
})
}
fn size(&self) -> Size<Length> {
Size {
width: self.width,
height: self.height,
}
}
fn layout(
&mut self,
tree: &mut Tree,
renderer: &Renderer,
limits: &layout::Limits,
) -> layout::Node {
layout(
tree.state.downcast_mut::<State<Link>>(),
renderer,
limits,
self.width,
self.height,
self.spans.as_ref().as_ref(),
self.line_height,
self.size,
self.font,
self.align_x,
self.align_y,
self.wrapping,
)
}
fn draw(
&self,
tree: &Tree,
renderer: &mut Renderer,
theme: &Theme,
defaults: &renderer::Style,
layout: Layout<'_>,
_cursor: mouse::Cursor,
viewport: &Rectangle,
) {
if !layout.bounds().intersects(viewport) {
return;
}
let state = tree.state.downcast_ref::<State<Link>>();
let style = theme.style(&self.class);
for (index, span) in self.spans.as_ref().as_ref().iter().enumerate() {
let is_hovered_link = self.on_link_click.is_some()
&& Some(index) == state.hovered_link;
if span.highlight.is_some()
|| span.underline
|| span.strikethrough
|| is_hovered_link
{
let translation = layout.position() - Point::ORIGIN;
let regions = state.paragraph.span_bounds(index);
if let Some(highlight) = span.highlight {
for bounds in ®ions {
let bounds = Rectangle::new(
bounds.position()
- Vector::new(
span.padding.left,
span.padding.top,
),
bounds.size()
+ Size::new(span.padding.x(), span.padding.y()),
);
renderer.fill_quad(
renderer::Quad {
bounds: bounds + translation,
border: highlight.border,
..Default::default()
},
highlight.background,
);
}
}
if span.underline || span.strikethrough || is_hovered_link {
let size = span
.size
.or(self.size)
.unwrap_or(renderer.default_size());
let line_height = span
.line_height
.unwrap_or(self.line_height)
.to_absolute(size);
let color = span
.color
.or(style.color)
.unwrap_or(defaults.text_color);
let baseline = translation
+ Vector::new(
0.0,
size.0 + (line_height.0 - size.0) / 2.0,
);
if span.underline || is_hovered_link {
for bounds in ®ions {
renderer.fill_quad(
renderer::Quad {
bounds: Rectangle::new(
bounds.position() + baseline
- Vector::new(0.0, size.0 * 0.08),
Size::new(bounds.width, 1.0),
),
..Default::default()
},
color,
);
}
}
if span.strikethrough {
for bounds in ®ions {
renderer.fill_quad(
renderer::Quad {
bounds: Rectangle::new(
bounds.position() + baseline
- Vector::new(0.0, size.0 / 2.0),
Size::new(bounds.width, 1.0),
),
..Default::default()
},
color,
);
}
}
}
}
}
if !state.selection.is_empty() {
let bounds = layout.bounds();
let (rows, mut start, mut end) = state.selection_end_points();
start += core::Vector::new(bounds.x, bounds.y);
end += core::Vector::new(bounds.x, bounds.y);
let line_height = self
.line_height
.to_absolute(
self.size.unwrap_or_else(|| renderer.default_size()),
)
.0;
let baseline_y = bounds.y
+ (((start.y - bounds.y) * 10.0).ceil() / 10.0 / line_height)
.floor()
* line_height;
for row in 0..rows {
let (x, width) = if row == 0 {
(
start.x,
if rows == 1 {
end.x.min(bounds.x + bounds.width) - start.x
} else {
bounds.x + bounds.width - start.x
},
)
} else if row == rows - 1 {
(bounds.x, end.x - bounds.x)
} else {
(bounds.x, bounds.width)
};
let y = baseline_y + row as f32 * line_height;
renderer.fill_quad(
renderer::Quad {
bounds: Rectangle {
x,
y,
width,
height: line_height,
},
snap: true,
..Default::default()
},
style.selection,
);
}
}
crate::text::draw(
renderer,
defaults,
layout.bounds(),
&state.paragraph,
style,
viewport,
);
}
fn update(
&mut self,
tree: &mut Tree,
event: &Event,
layout: Layout<'_>,
cursor: mouse::Cursor,
_renderer: &Renderer,
clipboard: &mut dyn Clipboard,
shell: &mut Shell<'_, Message>,
viewport: &Rectangle,
) {
let state = tree.state.downcast_mut::<State<Link>>();
let bounds = layout.bounds();
let click_position = cursor.position_in(bounds);
if viewport.intersection(&bounds).is_none()
&& state.selection.is_empty()
&& state.dragging.is_none()
{
return;
}
let was_hovered = state.is_hovered;
let hovered_link_before = state.hovered_link;
let selection_before = state.selection;
state.is_hovered = click_position.is_some();
if let Some(position) = click_position {
state.hovered_link =
state.paragraph.hit_span(position).and_then(|span| {
if self.spans.as_ref().as_ref().get(span)?.link.is_some() {
Some(span)
} else {
None
}
});
} else {
state.hovered_link = None;
}
match event {
Event::Mouse(mouse::Event::ButtonPressed(mouse::Button::Left))
| Event::Touch(touch::Event::FingerPressed { .. }) => {
if state.hovered_link.is_some() {
state.span_pressed = state.hovered_link;
shell.capture_event();
}
if let Some(position) = click_position {
let click = mouse::Click::new(
position,
mouse::Button::Left,
state.last_click,
);
let (line, index) = state
.grapheme_line_and_index(position)
.unwrap_or((0, 0));
match click.kind() {
mouse::click::Kind::Single => {
let new_end = SelectionEnd { line, index };
if state.keyboard_modifiers.shift() {
state.selection.change_selection(new_end);
} else {
state.selection.select_range(new_end, new_end);
}
state.dragging = Some(Dragging::Grapheme);
}
mouse::click::Kind::Double => {
state.selection.select_word(
line,
index,
&state.paragraph,
);
state.dragging = Some(Dragging::Word);
}
mouse::click::Kind::Triple => {
state.selection.select_line(line, &state.paragraph);
state.dragging = Some(Dragging::Line);
}
}
state.last_click = Some(click);
shell.capture_event();
} else {
state.selection = Selection::default();
}
}
Event::Mouse(mouse::Event::ButtonReleased(mouse::Button::Left))
| Event::Touch(touch::Event::FingerLifted { .. })
| Event::Touch(touch::Event::FingerLost { .. }) => {
state.dragging = None;
if !matches!(
event,
Event::Touch(touch::Event::FingerLost { .. })
) && state.selection.is_empty()
{
match state.span_pressed {
Some(span) if Some(span) == state.hovered_link => {
if let Some((link, on_link_clicked)) = self
.spans
.as_ref()
.as_ref()
.get(span)
.and_then(|span| span.link.clone())
.zip(self.on_link_click.as_deref())
{
shell.publish(on_link_clicked(link));
}
}
_ => {}
}
state.span_pressed = None;
}
}
Event::Mouse(mouse::Event::CursorMoved { .. })
| Event::Touch(touch::Event::FingerMoved { .. }) => {
if let Some(position) = click_position
&& let Some(dragging) = state.dragging
{
let (line, index) = state
.grapheme_line_and_index(position)
.unwrap_or((0, 0));
match dragging {
Dragging::Grapheme => {
let new_end = SelectionEnd { line, index };
state.selection.change_selection(new_end);
}
Dragging::Word => {
let new_end = SelectionEnd { line, index };
state.selection.change_selection_by_word(
new_end,
&state.paragraph,
);
}
Dragging::Line => {
state.selection.change_selection_by_line(
line,
&state.paragraph,
);
}
};
}
}
Event::Keyboard(keyboard::Event::KeyPressed { key, .. }) => {
match key.as_ref() {
keyboard::Key::Character("c")
if state.keyboard_modifiers.command()
&& !state.selection.is_empty() =>
{
clipboard.write(
clipboard::Kind::Standard,
state.selection.text(&state.paragraph),
);
shell.capture_event();
}
keyboard::Key::Character("a")
if state.keyboard_modifiers.command()
&& !state.selection.is_empty() =>
{
state.selection.select_all(&state.paragraph);
shell.capture_event();
}
keyboard::Key::Named(key::Named::Home)
if state.keyboard_modifiers.shift()
&& !state.selection.is_empty() =>
{
if state.keyboard_modifiers.jump() {
state.selection.select_beginning();
} else {
state.selection.select_line_beginning();
}
shell.capture_event();
}
keyboard::Key::Named(key::Named::End)
if state.keyboard_modifiers.shift()
&& !state.selection.is_empty() =>
{
if state.keyboard_modifiers.jump() {
state.selection.select_end(&state.paragraph);
} else {
state.selection.select_line_end(&state.paragraph);
}
shell.capture_event();
}
keyboard::Key::Named(key::Named::ArrowLeft)
if state.keyboard_modifiers.shift()
&& !state.selection.is_empty() =>
{
if state.keyboard_modifiers.macos_command() {
state.selection.select_line_beginning();
} else if state.keyboard_modifiers.jump() {
state
.selection
.select_left_by_words(&state.paragraph);
} else {
state.selection.select_left(&state.paragraph);
}
shell.capture_event();
}
keyboard::Key::Named(key::Named::ArrowRight)
if state.keyboard_modifiers.shift()
&& !state.selection.is_empty() =>
{
if state.keyboard_modifiers.macos_command() {
state.selection.select_line_end(&state.paragraph);
} else if state.keyboard_modifiers.jump() {
state
.selection
.select_right_by_words(&state.paragraph);
} else {
state.selection.select_right(&state.paragraph);
}
shell.capture_event();
}
keyboard::Key::Named(key::Named::ArrowUp)
if state.keyboard_modifiers.shift()
&& !state.selection.is_empty() =>
{
if state.keyboard_modifiers.macos_command() {
state.selection.select_beginning();
} else if state.keyboard_modifiers.jump() {
state.selection.select_line_beginning();
} else {
state.selection.select_up(&state.paragraph);
}
shell.capture_event();
}
keyboard::Key::Named(key::Named::ArrowDown)
if state.keyboard_modifiers.shift()
&& !state.selection.is_empty() =>
{
if state.keyboard_modifiers.macos_command() {
state.selection.select_end(&state.paragraph);
} else if state.keyboard_modifiers.jump() {
state.selection.select_line_end(&state.paragraph);
} else {
state.selection.select_down(&state.paragraph);
}
shell.capture_event();
}
keyboard::Key::Named(key::Named::Escape) => {
state.dragging = None;
state.selection = Selection::default();
state.keyboard_modifiers =
keyboard::Modifiers::default();
if state.selection != selection_before {
shell.capture_event();
}
}
_ => {}
}
}
Event::Keyboard(keyboard::Event::ModifiersChanged(modifiers)) => {
state.keyboard_modifiers = *modifiers;
}
_ => {}
}
if state.is_hovered != was_hovered
|| state.selection != selection_before
|| state.hovered_link != hovered_link_before
{
if let Some(span) = state.hovered_link {
if let Some((link, on_link_hovered)) = self
.spans
.as_ref()
.as_ref()
.get(span)
.and_then(|span| span.link.clone())
.zip(self.on_link_hover.as_deref())
{
shell.publish(on_link_hovered(link));
}
} else if let Some(on_hover_lost) = self.on_hover_lost.as_deref() {
shell.publish(on_hover_lost());
}
shell.request_redraw();
}
}
fn mouse_interaction(
&self,
tree: &Tree,
layout: Layout<'_>,
cursor: mouse::Cursor,
_viewport: &Rectangle,
_renderer: &Renderer,
) -> mouse::Interaction {
let state = tree.state.downcast_ref::<State<Link>>();
if state.hovered_link.is_some() {
mouse::Interaction::Pointer
} else if cursor.is_over(layout.bounds()) {
mouse::Interaction::Text
} else {
mouse::Interaction::None
}
}
}
#[allow(clippy::too_many_arguments)]
fn layout<Link, Renderer>(
state: &mut State<Link>,
renderer: &Renderer,
limits: &layout::Limits,
width: Length,
height: Length,
spans: &[Span<'_, Link, Renderer::Font>],
line_height: LineHeight,
size: Option<Pixels>,
font: Option<Renderer::Font>,
align_x: Alignment,
align_y: alignment::Vertical,
wrapping: Wrapping,
) -> layout::Node
where
Link: Clone,
Renderer: core::text::Renderer<Paragraph = Paragraph, Font = Font>,
{
layout::sized(limits, width, height, |limits| {
let bounds = limits.max();
let size = size.unwrap_or_else(|| renderer.default_size());
let font = font.unwrap_or_else(|| renderer.default_font());
let text_with_spans = || core::Text {
content: spans,
bounds,
size,
line_height,
font,
align_x,
align_y,
shaping: Shaping::Advanced,
wrapping,
};
if state.spans != spans {
state.paragraph =
Renderer::Paragraph::with_spans(text_with_spans());
state.spans = spans.iter().cloned().map(Span::to_static).collect();
} else {
match state.paragraph.compare(core::Text {
content: (),
bounds,
size,
line_height,
font,
align_x,
align_y,
shaping: Shaping::Advanced,
wrapping,
}) {
core::text::Difference::None => {}
core::text::Difference::Bounds => {
state.paragraph.resize(bounds);
}
core::text::Difference::Shape => {
state.paragraph =
Renderer::Paragraph::with_spans(text_with_spans());
}
}
}
state.paragraph.min_bounds()
})
}
impl<'a, Link, Message, Theme, Renderer>
FromIterator<Span<'a, Link, Renderer::Font>>
for Rich<'a, Link, Message, Theme, Renderer>
where
Link: Clone + 'a,
Theme: Catalog,
Renderer: core::text::Renderer<Paragraph = Paragraph, Font = Font>,
Renderer::Font: 'a,
{
fn from_iter<T: IntoIterator<Item = Span<'a, Link, Renderer::Font>>>(
spans: T,
) -> Self {
Self::with_spans(spans.into_iter().collect::<Vec<_>>())
}
}
impl<'a, Link, Message, Theme, Renderer>
From<Rich<'a, Link, Message, Theme, Renderer>>
for Element<'a, Message, Theme, Renderer>
where
Message: 'a,
Link: Clone + 'a,
Theme: Catalog + 'a,
Renderer: core::text::Renderer<Paragraph = Paragraph, Font = Font> + 'a,
{
fn from(
text: Rich<'a, Link, Message, Theme, Renderer>,
) -> Element<'a, Message, Theme, Renderer> {
Element::new(text)
}
}