Remove deprecated ft2font API

QuLogic · QuLogic · commit d3da65f5d10e · 2024-08-22T21:49:42.000-04:00
diff --git a/doc/api/next_api_changes/removals/27891-ES.rst b/doc/api/next_api_changes/removals/27891-ES.rst
@@ -0,0 +1,4 @@
+``ft2font.FT2Image.draw_rect`` and ``ft2font.FT2Font.get_xys``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+... have been removed as they are unused.
diff --git a/lib/matplotlib/ft2font.pyi b/lib/matplotlib/ft2font.pyi
@@ -224,7 +224,6 @@ class FT2Font:
     @overload
     def get_sfnt_table(self, name: Literal["pclt"]) -> _SfntPcltDict | None: ...
     def get_width_height(self) -> tuple[int, int]: ...
-    def get_xys(self, antialiased: bool = ...) -> NDArray[np.float64]: ...
     def load_char(self, charcode: int, flags: int = ...) -> Glyph: ...
     def load_glyph(self, glyphindex: int, flags: int = ...) -> Glyph: ...
     def select_charmap(self, i: int) -> None: ...
@@ -237,7 +236,6 @@ class FT2Font:
 @final
 class FT2Image:  # TODO: When updating mypy>=1.4, subclass from Buffer.
     def __init__(self, width: float, height: float) -> None: ...
-    def draw_rect(self, x0: float, y0: float, x1: float, y1: float) -> None: ...
     def draw_rect_filled(self, x0: float, y0: float, x1: float, y1: float) -> None: ...
 
 @final
diff --git a/src/ft2font.cpp b/src/ft2font.cpp
@@ -145,27 +145,6 @@ void FT2Image::draw_bitmap(FT_Bitmap *bitmap, FT_Int x, FT_Int y)
     m_dirty = true;
 }
 
-void FT2Image::draw_rect(unsigned long x0, unsigned long y0, unsigned long x1, unsigned long y1)
-{
-    if (x0 > m_width || x1 > m_width || y0 > m_height || y1 > m_height) {
-        throw std::runtime_error("Rect coords outside image bounds");
-    }
-
-    size_t top = y0 * m_width;
-    size_t bottom = y1 * m_width;
-    for (size_t i = x0; i < x1 + 1; ++i) {
-        m_buffer[i + top] = 255;
-        m_buffer[i + bottom] = 255;
-    }
-
-    for (size_t j = y0 + 1; j < y1; ++j) {
-        m_buffer[x0 + j * m_width] = 255;
-        m_buffer[x1 + j * m_width] = 255;
-    }
-
-    m_dirty = true;
-}
-
 void
 FT2Image::draw_rect_filled(unsigned long x0, unsigned long y0, unsigned long x1, unsigned long y1)
 {
@@ -716,29 +695,6 @@ void FT2Font::draw_glyphs_to_bitmap(bool antialiased)
     }
 }
 
-void FT2Font::get_xys(bool antialiased, std::vector<double> &xys)
-{
-    for (size_t n = 0; n < glyphs.size(); n++) {
-
-        FT_Error error = FT_Glyph_To_Bitmap(
-            &glyphs[n], antialiased ? FT_RENDER_MODE_NORMAL : FT_RENDER_MODE_MONO, 0, 1);
-        if (error) {
-            throw_ft_error("Could not convert glyph to bitmap", error);
-        }
-
-        FT_BitmapGlyph bitmap = (FT_BitmapGlyph)glyphs[n];
-
-        // bitmap left and top in pixel, string bbox in subpixel
-        FT_Int x = (FT_Int)(bitmap->left - bbox.xMin * (1. / 64.));
-        FT_Int y = (FT_Int)(bbox.yMax * (1. / 64.) - bitmap->top + 1);
-        // make sure the index is non-neg
-        x = x < 0 ? 0 : x;
-        y = y < 0 ? 0 : y;
-        xys.push_back(x);
-        xys.push_back(y);
-    }
-}
-
 void FT2Font::draw_glyph_to_bitmap(FT2Image &im, int x, int y, size_t glyphInd, bool antialiased)
 {
     FT_Vector sub_offset;
diff --git a/src/ft2font.h b/src/ft2font.h
@@ -41,7 +41,6 @@ class FT2Image
 
     void resize(long width, long height);
     void draw_bitmap(FT_Bitmap *bitmap, FT_Int x, FT_Int y);
-    void draw_rect(unsigned long x0, unsigned long y0, unsigned long x1, unsigned long y1);
     void draw_rect_filled(unsigned long x0, unsigned long y0, unsigned long x1, unsigned long y1);
 
     unsigned char *get_buffer()
@@ -104,9 +103,6 @@ class FT2Font
     void get_width_height(long *width, long *height);
     void get_bitmap_offset(long *x, long *y);
     long get_descent();
-    // TODO: Since we know the size of the array upfront, we probably don't
-    // need to dynamically allocate like this
-    void get_xys(bool antialiased, std::vector<double> &xys);
     void draw_glyphs_to_bitmap(bool antialiased);
     void draw_glyph_to_bitmap(FT2Image &im, int x, int y, size_t glyphInd, bool antialiased);
     void get_glyph_name(unsigned int glyph_number, std::string &buffer, bool fallback);
diff --git a/src/ft2font_wrapper.cpp b/src/ft2font_wrapper.cpp
@@ -63,35 +63,6 @@ static void PyFT2Image_dealloc(PyFT2Image *self)
     Py_TYPE(self)->tp_free((PyObject *)self);
 }
 
-const char *PyFT2Image_draw_rect__doc__ =
-    "draw_rect(self, x0, y0, x1, y1)\n"
-    "--\n\n"
-    "Draw an empty rectangle to the image.\n"
-    "\n"
-    ".. deprecated:: 3.8\n";
-;
-
-static PyObject *PyFT2Image_draw_rect(PyFT2Image *self, PyObject *args)
-{
-    char const* msg =
-        "FT2Image.draw_rect is deprecated since Matplotlib 3.8 and will be removed "
-        "in Matplotlib 3.10 as it is not used in the library. If you rely on it, "
-        "please let us know.";
-    if (PyErr_WarnEx(PyExc_DeprecationWarning, msg, 1)) {
-        return NULL;
-    }
-
-    double x0, y0, x1, y1;
-
-    if (!PyArg_ParseTuple(args, "dddd:draw_rect", &x0, &y0, &x1, &y1)) {
-        return NULL;
-    }
-
-    CALL_CPP("draw_rect", (self->x->draw_rect(x0, y0, x1, y1)));
-
-    Py_RETURN_NONE;
-}
-
 const char *PyFT2Image_draw_rect_filled__doc__ =
     "draw_rect_filled(self, x0, y0, x1, y1)\n"
     "--\n\n"
@@ -137,7 +108,6 @@ static int PyFT2Image_get_buffer(PyFT2Image *self, Py_buffer *buf, int flags)
 static PyTypeObject* PyFT2Image_init_type()
 {
     static PyMethodDef methods[] = {
-        {"draw_rect", (PyCFunction)PyFT2Image_draw_rect, METH_VARARGS, PyFT2Image_draw_rect__doc__},
         {"draw_rect_filled", (PyCFunction)PyFT2Image_draw_rect_filled, METH_VARARGS, PyFT2Image_draw_rect_filled__doc__},
         {NULL}
     };
@@ -856,37 +826,6 @@ static PyObject *PyFT2Font_draw_glyphs_to_bitmap(PyFT2Font *self, PyObject *args
     Py_RETURN_NONE;
 }
 
-const char *PyFT2Font_get_xys__doc__ =
-    "get_xys(self, antialiased=True)\n"
-    "--\n\n"
-    "Get the xy locations of the current glyphs.\n"
-    "\n"
-    ".. deprecated:: 3.8\n";
-
-static PyObject *PyFT2Font_get_xys(PyFT2Font *self, PyObject *args, PyObject *kwds)
-{
-    char const* msg =
-        "FT2Font.get_xys is deprecated since Matplotlib 3.8 and will be removed in "
-        "Matplotlib 3.10 as it is not used in the library. If you rely on it, "
-        "please let us know.";
-    if (PyErr_WarnEx(PyExc_DeprecationWarning, msg, 1)) {
-        return NULL;
-    }
-
-    bool antialiased = true;
-    std::vector<double> xys;
-    const char *names[] = { "antialiased", NULL };
-
-    if (!PyArg_ParseTupleAndKeywords(args, kwds, "|O&:get_xys",
-                                     (char **)names, &convert_bool, &antialiased)) {
-        return NULL;
-    }
-
-    CALL_CPP("get_xys", (self->x->get_xys(antialiased, xys)));
-
-    return convert_xys_to_array(xys);
-}
-
 const char *PyFT2Font_draw_glyph_to_bitmap__doc__ =
     "draw_glyph_to_bitmap(self, image, x, y, glyph, antialiased=True)\n"
     "--\n\n"
@@ -1517,7 +1456,6 @@ static PyTypeObject *PyFT2Font_init_type()
         {"get_bitmap_offset", (PyCFunction)PyFT2Font_get_bitmap_offset, METH_NOARGS, PyFT2Font_get_bitmap_offset__doc__},
         {"get_descent", (PyCFunction)PyFT2Font_get_descent, METH_NOARGS, PyFT2Font_get_descent__doc__},
         {"draw_glyphs_to_bitmap", (PyCFunction)PyFT2Font_draw_glyphs_to_bitmap, METH_VARARGS|METH_KEYWORDS, PyFT2Font_draw_glyphs_to_bitmap__doc__},
-        {"get_xys", (PyCFunction)PyFT2Font_get_xys, METH_VARARGS|METH_KEYWORDS, PyFT2Font_get_xys__doc__},
         {"draw_glyph_to_bitmap", (PyCFunction)PyFT2Font_draw_glyph_to_bitmap, METH_VARARGS|METH_KEYWORDS, PyFT2Font_draw_glyph_to_bitmap__doc__},
         {"get_glyph_name", (PyCFunction)PyFT2Font_get_glyph_name, METH_VARARGS, PyFT2Font_get_glyph_name__doc__},
         {"get_charmap", (PyCFunction)PyFT2Font_get_charmap, METH_NOARGS, PyFT2Font_get_charmap__doc__},
