label.rs

  1use std::{borrow::Cow, ops::Range};
  2
  3use crate::{
  4    fonts::TextStyle,
  5    geometry::{
  6        rect::RectF,
  7        vector::{vec2f, Vector2F},
  8    },
  9    json::{ToJson, Value},
 10    text_layout::{Line, RunStyle},
 11    Element, SizeConstraint, ViewContext,
 12};
 13use schemars::JsonSchema;
 14use serde::Deserialize;
 15use serde_json::json;
 16use smallvec::{smallvec, SmallVec};
 17
 18pub struct Label {
 19    text: Cow<'static, str>,
 20    style: LabelStyle,
 21    highlight_indices: Vec<usize>,
 22}
 23
 24#[derive(Clone, Debug, Deserialize, Default, JsonSchema)]
 25pub struct LabelStyle {
 26    pub text: TextStyle,
 27    pub highlight_text: Option<TextStyle>,
 28}
 29
 30impl From<TextStyle> for LabelStyle {
 31    fn from(text: TextStyle) -> Self {
 32        LabelStyle {
 33            text,
 34            highlight_text: None,
 35        }
 36    }
 37}
 38
 39impl LabelStyle {
 40    pub fn with_font_size(mut self, font_size: f32) -> Self {
 41        self.text.font_size = font_size;
 42        self
 43    }
 44}
 45
 46impl Label {
 47    pub fn new<I: Into<Cow<'static, str>>>(text: I, style: impl Into<LabelStyle>) -> Self {
 48        Self {
 49            text: text.into(),
 50            highlight_indices: Default::default(),
 51            style: style.into(),
 52        }
 53    }
 54
 55    pub fn with_highlights(mut self, indices: Vec<usize>) -> Self {
 56        self.highlight_indices = indices;
 57        self
 58    }
 59
 60    fn compute_runs(&self) -> SmallVec<[(usize, RunStyle); 8]> {
 61        let font_id = self.style.text.font_id;
 62        if self.highlight_indices.is_empty() {
 63            return smallvec![(
 64                self.text.len(),
 65                RunStyle {
 66                    font_id,
 67                    color: self.style.text.color,
 68                    underline: self.style.text.underline,
 69                }
 70            )];
 71        }
 72
 73        let highlight_font_id = self
 74            .style
 75            .highlight_text
 76            .as_ref()
 77            .map_or(font_id, |style| style.font_id);
 78
 79        let mut highlight_indices = self.highlight_indices.iter().copied().peekable();
 80        let mut runs = SmallVec::new();
 81        let highlight_style = self
 82            .style
 83            .highlight_text
 84            .as_ref()
 85            .unwrap_or(&self.style.text);
 86
 87        for (char_ix, c) in self.text.char_indices() {
 88            let mut font_id = font_id;
 89            let mut color = self.style.text.color;
 90            let mut underline = self.style.text.underline;
 91            if let Some(highlight_ix) = highlight_indices.peek() {
 92                if char_ix == *highlight_ix {
 93                    font_id = highlight_font_id;
 94                    color = highlight_style.color;
 95                    underline = highlight_style.underline;
 96                    highlight_indices.next();
 97                }
 98            }
 99
100            let last_run: Option<&mut (usize, RunStyle)> = runs.last_mut();
101            let push_new_run = if let Some((last_len, last_style)) = last_run {
102                if font_id == last_style.font_id
103                    && color == last_style.color
104                    && underline == last_style.underline
105                {
106                    *last_len += c.len_utf8();
107                    false
108                } else {
109                    true
110                }
111            } else {
112                true
113            };
114
115            if push_new_run {
116                runs.push((
117                    c.len_utf8(),
118                    RunStyle {
119                        font_id,
120                        color,
121                        underline,
122                    },
123                ));
124            }
125        }
126
127        runs
128    }
129}
130
131impl<V: 'static> Element<V> for Label {
132    type LayoutState = Line;
133    type PaintState = ();
134
135    fn layout(
136        &mut self,
137        constraint: SizeConstraint,
138        _: &mut V,
139        cx: &mut ViewContext<V>,
140    ) -> (Vector2F, Self::LayoutState) {
141        let runs = self.compute_runs();
142        let line = cx.text_layout_cache().layout_str(
143            &self.text,
144            self.style.text.font_size,
145            runs.as_slice(),
146        );
147
148        let size = vec2f(
149            line.width()
150                .ceil()
151                .max(constraint.min.x())
152                .min(constraint.max.x()),
153            cx.font_cache.line_height(self.style.text.font_size),
154        );
155
156        (size, line)
157    }
158
159    fn paint(
160        &mut self,
161        bounds: RectF,
162        visible_bounds: RectF,
163        line: &mut Self::LayoutState,
164        _: &mut V,
165        cx: &mut ViewContext<V>,
166    ) -> Self::PaintState {
167        let visible_bounds = bounds.intersection(visible_bounds).unwrap_or_default();
168        line.paint(bounds.origin(), visible_bounds, bounds.size().y(), cx)
169    }
170
171    fn rect_for_text_range(
172        &self,
173        _: Range<usize>,
174        _: RectF,
175        _: RectF,
176        _: &Self::LayoutState,
177        _: &Self::PaintState,
178        _: &V,
179        _: &ViewContext<V>,
180    ) -> Option<RectF> {
181        None
182    }
183
184    fn debug(
185        &self,
186        bounds: RectF,
187        _: &Self::LayoutState,
188        _: &Self::PaintState,
189        _: &V,
190        _: &ViewContext<V>,
191    ) -> Value {
192        json!({
193            "type": "Label",
194            "bounds": bounds.to_json(),
195            "text": &self.text,
196            "highlight_indices": self.highlight_indices,
197            "style": self.style.to_json(),
198        })
199    }
200}
201
202impl ToJson for LabelStyle {
203    fn to_json(&self) -> Value {
204        json!({
205            "text": self.text.to_json(),
206            "highlight_text": self.highlight_text
207                .as_ref()
208                .map_or(serde_json::Value::Null, |style| style.to_json())
209        })
210    }
211}
212
213#[cfg(test)]
214mod tests {
215    use super::*;
216    use crate::color::Color;
217    use crate::fonts::{Properties as FontProperties, Weight};
218
219    #[crate::test(self)]
220    fn test_layout_label_with_highlights(cx: &mut crate::AppContext) {
221        let default_style = TextStyle::new(
222            "Menlo",
223            12.,
224            Default::default(),
225            Default::default(),
226            Default::default(),
227            Color::black(),
228            cx.font_cache(),
229        )
230        .unwrap();
231        let highlight_style = TextStyle::new(
232            "Menlo",
233            12.,
234            *FontProperties::new().weight(Weight::BOLD),
235            Default::default(),
236            Default::default(),
237            Color::new(255, 0, 0, 255),
238            cx.font_cache(),
239        )
240        .unwrap();
241        let label = Label::new(
242            ".αβγδε.ⓐⓑⓒⓓⓔ.abcde.".to_string(),
243            LabelStyle {
244                text: default_style.clone(),
245                highlight_text: Some(highlight_style.clone()),
246            },
247        )
248        .with_highlights(vec![
249            "".len(),
250            ".αβ".len(),
251            ".αβγδ".len(),
252            ".αβγδε.ⓐ".len(),
253            ".αβγδε.ⓐⓑ".len(),
254        ]);
255
256        let default_run_style = RunStyle {
257            font_id: default_style.font_id,
258            color: default_style.color,
259            underline: default_style.underline,
260        };
261        let highlight_run_style = RunStyle {
262            font_id: highlight_style.font_id,
263            color: highlight_style.color,
264            underline: highlight_style.underline,
265        };
266        let runs = label.compute_runs();
267        assert_eq!(
268            runs.as_slice(),
269            &[
270                ("".len(), default_run_style),
271                ("βγ".len(), highlight_run_style),
272                ("δ".len(), default_run_style),
273                ("ε".len(), highlight_run_style),
274                (".ⓐ".len(), default_run_style),
275                ("ⓑⓒ".len(), highlight_run_style),
276                ("ⓓⓔ.abcde.".len(), default_run_style),
277            ]
278        );
279    }
280}