Fix return value of FT2Font.set_text and add tests for it

QuLogic · QuLogic · commit 833a2593b694 · 2024-08-29T04:22:43.000-04:00
`PyArray_SimpleNewFromData` does not copy its input data, and the
`std::vector` is a local variable that disappears after the C++ method
returns.
diff --git a/lib/matplotlib/tests/test_ft2font.py b/lib/matplotlib/tests/test_ft2font.py
@@ -706,6 +706,27 @@ def test_ft2font_get_kerning(left, right, unscaled, unfitted, default):
                             ft2font.KERNING_DEFAULT) == default
 
 
+def test_ft2font_set_text():
+    file = fm.findfont('DejaVu Sans')
+    font = ft2font.FT2Font(file, hinting_factor=1, _kerning_factor=0)
+    xys = font.set_text('')
+    np.testing.assert_array_equal(xys, np.empty((0, 2)))
+    assert font.get_width_height() == (0, 0)
+    assert font.get_num_glyphs() == 0
+    assert font.get_descent() == 0
+    assert font.get_bitmap_offset() == (0, 0)
+    # This string uses all the kerning pairs defined for test_ft2font_get_kerning.
+    xys = font.set_text('AADAT.XC-J')
+    np.testing.assert_array_equal(
+        xys,
+        [(0, 0), (512, 0), (1024, 0), (1600, 0), (2112, 0), (2496, 0), (2688, 0),
+         (3200, 0), (3712, 0), (4032, 0)])
+    assert font.get_width_height() == (4288, 768)
+    assert font.get_num_glyphs() == 10
+    assert font.get_descent() == 192
+    assert font.get_bitmap_offset() == (6, 0)
+
+
 @pytest.mark.parametrize('family_name, file_name',
                           [("WenQuanYi Zen Hei",  "wqy-zenhei.ttc"),
                            ("Noto Sans CJK JP", "NotoSansCJK.ttc"),
diff --git a/src/ft2font_wrapper.cpp b/src/ft2font_wrapper.cpp
@@ -14,7 +14,10 @@ static PyObject *convert_xys_to_array(std::vector<double> &xys)
 {
     npy_intp dims[] = {(npy_intp)xys.size() / 2, 2 };
     if (dims[0] > 0) {
-        return PyArray_SimpleNewFromData(2, dims, NPY_DOUBLE, &xys[0]);
+        auto obj = PyArray_SimpleNew(2, dims, NPY_DOUBLE);
+        auto array = reinterpret_cast<PyArrayObject *>(obj);
+        memcpy(PyArray_DATA(array), xys.data(), PyArray_NBYTES(array));
+        return obj;
     } else {
         return PyArray_SimpleNew(2, dims, NPY_DOUBLE);
     }
@@ -631,7 +634,7 @@ const char *PyFT2Font_set_text__doc__ =
     "*flags* can be a bitwise-or of the LOAD_XXX constants;\n"
     "the default value is LOAD_FORCE_AUTOHINT.\n"
     "You must call this before `.draw_glyphs_to_bitmap`.\n"
-    "A sequence of x,y positions is returned.\n";
+    "A sequence of x,y positions in 26.6 subpixels is returned; divide by 64 for pixels.\n";
 
 static PyObject *PyFT2Font_set_text(PyFT2Font *self, PyObject *args, PyObject *kwds)
 {

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,10 @@ static PyObject *convert_xys_to_array(std::vector<double> &xys)`
`14`	`14`	`{`
`15`	`15`	`npy_intp dims[] = {(npy_intp)xys.size() / 2, 2 };`
`16`	`16`	`if (dims[0] > 0) {`
`17`		`- return PyArray_SimpleNewFromData(2, dims, NPY_DOUBLE, &xys[0]);`
	`17`	`+ auto obj = PyArray_SimpleNew(2, dims, NPY_DOUBLE);`
	`18`	`+ auto array = reinterpret_cast<PyArrayObject *>(obj);`
	`19`	`+ memcpy(PyArray_DATA(array), xys.data(), PyArray_NBYTES(array));`
	`20`	`+ return obj;`
`18`	`21`	`} else {`
`19`	`22`	`return PyArray_SimpleNew(2, dims, NPY_DOUBLE);`
`20`	`23`	`}`
`@@ -631,7 +634,7 @@ const char *PyFT2Font_set_text__doc__ =`
`631`	`634`	`"flags can be a bitwise-or of the LOAD_XXX constants;\n"`
`632`	`635`	`"the default value is LOAD_FORCE_AUTOHINT.\n"`
`633`	`636`	"You must call this before `.draw_glyphs_to_bitmap`.\n"
`634`		`- "A sequence of x,y positions is returned.\n";`
	`637`	`+ "A sequence of x,y positions in 26.6 subpixels is returned; divide by 64 for pixels.\n";`
`635`	`638`
`636`	`639`	`static PyObject PyFT2Font_set_text(PyFT2Font self, PyObject args, PyObject kwds)`
`637`	`640`	`{`