Merge pull request #133 from kas-gui/push-zpypnvkvysop

Remove num_glyphs, deprecate `Effect` type tokens and highlighting functions

Author: dhardy

.github/workflows/test.yml

@@ -63,4 +63,4 @@ jobs:
       - name: Test (reduced features)
         run: cargo test --all-targets --features markdown
       - name: Test (all features except GAT)
-        run: cargo test --features markdown,shaping,serde,num_glyphs
+        run: cargo test --features markdown,shaping,serde

Cargo.toml

@@ -20,9 +20,6 @@ all-features = true
 rustdoc-args = ["--cfg", "docsrs"]
 
 [features]
-# Support num_glyphs method
-num_glyphs = []
-
 # Enable shaping with the default dependency.
 shaping = ["rustybuzz"]
 # Enable shaping via rustybuzz.

src/display/glyph_pos.rs

@@ -365,17 +365,6 @@ impl TextDisplay {
         MarkerPosIter { v, a, b }
     }
 
-    /// Get the number of glyphs
-    ///
-    /// [Requires status][Self#status-of-preparation]: lines have been wrapped.
-    ///
-    /// This method is a simple memory-read.
-    #[inline]
-    #[cfg(feature = "num_glyphs")]
-    pub fn num_glyphs(&self) -> usize {
-        to_usize(self.num_glyphs)
-    }
-
     /// Iterate over runs of positioned glyphs
     ///
     /// All glyphs are translated by the given `offset` (this is practically
@@ -390,8 +379,7 @@ impl TextDisplay {
     /// where `i` is the largest value such that `effects[i].0 <= j`, or the
     /// default value of `E` if no such `i` exists.
     ///
-    /// Runs are yielded in undefined order. The total number of
-    /// glyphs yielded will equal [`TextDisplay::num_glyphs`].
+    /// Runs are yielded in undefined order.
     ///
     /// [Requires status][Self#status-of-preparation]:
     /// text is fully prepared for display.
@@ -441,6 +429,10 @@ impl TextDisplay {
     /// text is fully prepared for display.
     ///
     /// Calls `f(top_left, bottom_right)` for each highlighting rectangle.
+    #[deprecated(
+        since = "0.10.0",
+        note = "Since the same result may be achieved using text background colors this will likely be removed in the future."
+    )]
     pub fn highlight_range(&self, range: std::ops::Range<usize>, f: &mut dyn FnMut(Vec2, Vec2)) {
         for line in &self.lines {
             let line_range = line.text_range();
@@ -453,6 +445,7 @@ impl TextDisplay {
                 let br = Vec2(self.r_bound, line.bottom);
                 f(tl, br);
             } else {
+                #[allow(deprecated)]
                 self.highlight_line(line.clone(), range.clone(), f);
             }
         }
@@ -465,6 +458,10 @@ impl TextDisplay {
     ///
     /// Warning: runs are in logical order which does not correspond to display
     /// order. As a result, the order of results (on a line) is not known.
+    #[deprecated(
+        since = "0.10.0",
+        note = "Since the same result may be achieved using text background colors this will likely be removed in the future."
+    )]
     fn highlight_line(
         &self,
         line: Line,

src/display/mod.rs

@@ -114,8 +114,6 @@ pub struct TextDisplay {
     wrapped_runs: TinyVec<[RunPart; 1]>,
     /// Visual (wrapped) lines, in visual and logical order
     lines: TinyVec<[Line; 1]>,
-    #[cfg(feature = "num_glyphs")]
-    num_glyphs: u32,
     l_bound: f32,
     r_bound: f32,
 }
@@ -128,10 +126,7 @@ fn size_of_elts() {
     assert_eq!(size_of::<shaper::GlyphRun>(), 112);
     assert_eq!(size_of::<RunPart>(), 24);
     assert_eq!(size_of::<Line>(), 24);
-    #[cfg(not(feature = "num_glyphs"))]
     assert_eq!(size_of::<TextDisplay>(), 200);
-    #[cfg(feature = "num_glyphs")]
-    assert_eq!(size_of::<TextDisplay>(), 208);
 }
 
 impl Default for TextDisplay {
@@ -140,8 +135,6 @@ impl Default for TextDisplay {
             runs: Default::default(),
             wrapped_runs: Default::default(),
             lines: Default::default(),
-            #[cfg(feature = "num_glyphs")]
-            num_glyphs: 0,
             l_bound: 0.0,
             r_bound: 0.0,
         }

src/display/wrap_lines.rs

@@ -217,10 +217,6 @@ impl TextDisplay {
 
         self.wrapped_runs = adder.wrapped_runs;
         self.lines = adder.lines;
-        #[cfg(feature = "num_glyphs")]
-        {
-            self.num_glyphs = adder.num_glyphs;
-        }
         self.l_bound = adder.l_bound.min(adder.r_bound);
         self.r_bound = adder.r_bound;
         adder.vcaret
@@ -403,8 +399,6 @@ struct LineAdder {
     l_bound: f32,
     r_bound: f32,
     vcaret: f32,
-    #[cfg(feature = "num_glyphs")]
-    num_glyphs: u32,
     h_align: Align,
     width_bound: f32,
 }
@@ -684,11 +678,6 @@ impl PartAccumulator for LineAdder {
         for (i, part) in parts.iter().enumerate() {
             let run = &runs[to_usize(part.run)];
 
-            #[cfg(feature = "num_glyphs")]
-            {
-                self.num_glyphs += to_u32(part.glyph_range.len());
-            }
-
             let mut text_end = run.range.end;
             let mut offset = 0.0;
             if run.level.is_ltr() {

src/format.rs

@@ -5,6 +5,8 @@
 
 //! Parsers for formatted text
 
+#![allow(deprecated)]
+
 use crate::fonts::FontSelector;
 #[allow(unused)]
 use crate::{Text, TextDisplay};
@@ -20,6 +22,10 @@ pub use markdown::{Error as MarkdownError, Markdown};
 /// A possible effect formatting marker
 #[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[deprecated(
+    since = "0.10.0",
+    note = "Since the effects type is generic, a more appropriate type may be defined downstream."
+)]
 pub struct Effect {
     /// User-specified value
     ///
@@ -34,6 +40,10 @@ bitflags::bitflags! {
     /// Text effects
     #[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
     #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+    #[deprecated(
+        since = "0.10.0",
+        note = "Since the effects type is generic, a more appropriate type may be defined downstream."
+    )]
     pub struct EffectFlags: u16 {
         /// Glyph is underlined
         const UNDERLINE = 1 << 0;

src/format/markdown.rs

@@ -45,6 +45,10 @@ pub enum Error {
 /// -   Tables
 /// -   Task lists
 #[derive(Clone, Debug, Default, PartialEq)]
+#[deprecated(
+    since = "0.10.0",
+    note = "Since the effects type is generic and this requires a fixed Effect token it is likely to be removed."
+)]
 pub struct Markdown {
     text: String,
     fmt: Vec<Fmt>,

src/text.rs

@@ -540,24 +540,14 @@ impl<T: FormattableText + ?Sized> Text<T> {
         Ok(self.display()?.text_glyph_pos(index))
     }
 
-    /// Get the number of glyphs
-    ///
-    /// See [`TextDisplay::num_glyphs`].
-    #[inline]
-    #[cfg(feature = "num_glyphs")]
-    pub fn num_glyphs(&self) -> Result<usize, NotReady> {
-        Ok(self.wrapped_display()?.num_glyphs())
-    }
-
     /// Iterate over runs of positioned glyphs
     ///
     /// All glyphs are translated by the given `offset` (this is practically
     /// free).
     ///
     /// Uses effect tokens supplied by [`FormattableText::effect_tokens`].
     ///
-    /// Runs are yielded in undefined order. The total number of
-    /// glyphs yielded will equal [`TextDisplay::num_glyphs`].
+    /// Runs are yielded in undefined order.
     pub fn runs<'a>(
         &'a self,
         offset: Vec2,
@@ -578,8 +568,7 @@ impl<T: FormattableText + ?Sized> Text<T> {
     /// where `i` is the largest value such that `effects[i].0 <= j`, or the
     /// default value of `E` if no such `i` exists.
     ///
-    /// Runs are yielded in undefined order. The total number of
-    /// glyphs yielded will equal [`TextDisplay::num_glyphs`].
+    /// Runs are yielded in undefined order.
     pub fn runs_with_effects<'a, E: Copy + Debug + Default>(
         &'a self,
         offset: Vec2,
@@ -591,6 +580,10 @@ impl<T: FormattableText + ?Sized> Text<T> {
     /// Yield a sequence of rectangles to highlight a given text range
     ///
     /// Calls `f(top_left, bottom_right)` for each highlighting rectangle.
+    #[deprecated(
+        since = "0.10.0",
+        note = "Since the same result may be achieved using text background colors this will likely be removed in the future."
+    )]
     pub fn highlight_range<F>(
         &self,
         range: std::ops::Range<usize>,
@@ -599,6 +592,7 @@ impl<T: FormattableText + ?Sized> Text<T> {
     where
         F: FnMut(Vec2, Vec2),
     {
+        #[allow(deprecated)]
         Ok(self.display()?.highlight_range(range, &mut f))
     }
 }