Баг при работе TextBox.GetLineText в .NET WPF16.08.2018 13:34

Для проведения исследований работы программ и ОС существует очень много различного инструментария. Виртуальные машины, IDE, умные блокноты, IDA, radare, hex-редакторы, pe-редакторы, и даже одних утилит Sysinternals больше сотни — все это сделано для облегчения многих рутинных операций. Но иногда наступает момент, когда ты понимаешь, что среди всего этого многообразия тебе не хватает небольшой утилитки, которая просто сделает банальную и нехитрую работу. Можно написать скрипты на питоне или Powershell на коленке, но нередко на такие поделки без слез не взглянешь и с коллегами не поделишься.

Недавно такая ситуация снова наступила у меня. И я решил, что пора просто взять и написать аккуратную утилиту. О самой утилите я расскажу в одной из ближайших статей, но об одной из проблем во время разработки расскажу сейчас.

Ошибка проявляется так — если в WPF приложении, в стандартный контрол TextBox воткнуть много строк текста, то вызовы функции GetLineText () начиная с некоторого индекса будут возвращать неправильные строки.

Неправильность заключается в том, что хоть строки будут из установленного текста, но расположенные дальше, фактически GetLineText () будет просто пропускать некоторые строки. Ошибка проявляется при очень большом количестве строк. Так я ее и встретил — попытался отобразить в TextBox«е 25 мегабайт текста. Работа с последними строками выявила неожиданный эффект.

Гугл подсказывает, что ошибка существует с 2011 года и Microsoft не особо торопится что-то исправлять.

Пример

Требований к версии .NET особо нет. Создаем стандартный проект WPF и заполняем файлы так:
MainWindow.xaml

MainWindow.cs (пропустив using и namespace)

public partial class MainWindow : Window
{
    public MainWindow()
    {
        InitializeComponent();
    }

    private void btn_OnClick(object sender, RoutedEventArgs e)
    {
        var sb = new StringBuilder();
        for (int i = 0; i < 90009; i++)
            sb.AppendLine($"{i}");
        txt.Text = sb.ToString();
    }

    private void btn2_OnClick(object sender, RoutedEventArgs e)
    {
        var sb = new StringBuilder();
        for (var i = 1; i < 7; i++)
            sb.AppendLine("req: " + 150 * i + ", get: " + txt.GetLineText(150 * i).Trim());
        for (var i = 1; i < 7; i++)
            sb.AppendLine("req: " + 15000 * i + ", get: " + txt.GetLineText(15000 * i).Trim());
        txt.Text = sb.ToString();
    }
}

Приложение состоит из TextBox«а и двух кнопок. Нажимаем сначала «Fire 1!» (заполнит TextBox чиселками), затем «Fire 2!» (запросит строки по номерам и выведет).

Ожидаемый результат:

req: 150, get: 150
req: 300, get: 300
req: 450, get: 450
req: 600, get: 600
req: 750, get: 750
req: 900, get: 900
req: 15000, get: 15000
req: 30000, get: 30000
req: 45000, get: 45000
req: 60000, get: 60000
req: 75000, get: 75000
req: 90000, get: 90000

Реальность:

Видно, что для индексов меньше 1000 — все прекрасно, а для больших 15000 — пошли сдвиги. И чем дальше, тем больше.

Исследуем баг

Расчехляем ту часть решарпера, которая отвечает за просмотр исходного кода .NET и специальный класс «Расширитель возможностей и преодолятор ограничений на базе Reflection».

public static class ReflectionExtensions
{
    public static T GetFieldValue(this object obj, string name)
    {
        var bindingFlags = BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance;
        var field = obj.GetType().GetField(name, bindingFlags);
        if (field == null)
            field = obj.GetType().BaseType.GetField(name, bindingFlags);
        return (T)field?.GetValue(obj);
    }

    public static object InvokeMethod(this object obj, string methodName, params object[] methodParams)
    {
        var methodParamTypes = methodParams?.Select(p => p.GetType()).ToArray() ?? new Type[] { };
        var bindingFlags = BindingFlags.NonPublic | BindingFlags.Public | BindingFlags.Instance | BindingFlags.Static;
        MethodInfo method = null;
        var type = obj.GetType();
        while (method == null && type != null)
        {
            method = type.GetMethod(methodName, bindingFlags, Type.DefaultBinder, methodParamTypes, null);
            var intfs = type.GetInterfaces();
            if (method != null)
                break;
            foreach (var intf in intfs)
            {
                method = intf.GetMethod(methodName, bindingFlags, Type.DefaultBinder, methodParamTypes, null);
                if (method != null)
                    break;
            }
            type = type.BaseType;
        }
        return method?.Invoke(obj, methodParams);
    }
}

Опытным путем устанавливаем, что в конкретно взятом примере проблема начинается в районе 8510 строки. Если запросить txt.GetLineText (8510), то вернется »8510». Для 8511 — 8511, а для 8512 — внезапно, 8513.

Смотрим на реализацию GetLineText () у TextBox:

Пропускаем проверки в первых строчках и видим вызов GetStartPositionOfLine (). Похоже, что проблема должна быть в этой функции, поскольку для неправильной строки должна вернуться неправильная позиция начала строки.

Вызываем в своем коде:

var o00 = txt.InvokeMethod("GetStartPositionOfLine", 8510);
var o01 = txt.InvokeMethod("GetStartPositionOfLine", 8511);
var o02 = txt.InvokeMethod("GetStartPositionOfLine", 8512);

И правда — смещение первого объекта (начало 8510'ой строки) указано как 49950 символов, для второго объекта — 49956, а третьего — 49968. Между первыми двумя 6 символов, а между следующими 12. Непорядок — вот и пропущенная строка.

Идем внутрь GetStartPositionOfLine ():

Снова пропускаем стартовые проверки и смотрим на реальные действия. Сначала высчитывается точка, которая должна попасть на строку с номером lineIndex. Берется высота всех строк и прибавляется половинка высоты строки — для того, чтобы попасть в ее центр. На this.VerticalOffset и this.HorizontalOffset не смотрим — они по нулям.

Считаем в своем коде:

var lineHeight = (double) txt.InvokeMethod("GetLineHeight", null);
var y0 = lineHeight * (double)8510 + lineHeight / 2.0 - txt.VerticalOffset;
var y1 = lineHeight * (double)8511 + lineHeight / 2.0 - txt.VerticalOffset;
var y2 = lineHeight * (double)8512 + lineHeight / 2.0 - txt.VerticalOffset;

Значения разумные, с логикой соотносятся, все в порядке. Идем дальше по коду GetStartPositionOfLine () — нас интересует следующая осмысленная строка (первая внутри условия), которая похожа на крокодила и оканчивается вызовом GetTextPositionFromPoint ().

Раскрываем вызовы и дергаем их через рефлексию. Обратим внимание, что некоторые интерфейсы нам недоступны из-за ограничения видимости, поэтому приходится ссылаться на них, используя все тот же Reflection.

var renderScope = (txt.GetFieldValue("_renderScope") as IServiceProvider);
// 7 - тип интерфейся ITextView
var textView = renderScope.GetService(renderScope.GetType().GetInterfaces()[7]);
var o10 = textView.InvokeMethod("GetTextPositionFromPoint", new Point(-txt.HorizontalOffset, y0), true);
var o11 = textView.InvokeMethod("GetTextPositionFromPoint", new Point(-txt.HorizontalOffset, y1), true);
var o12 = textView.InvokeMethod("GetTextPositionFromPoint", new Point(-txt.HorizontalOffset, y2), true);

Полученные объекты показывают все те же смещения — 49950, 49956, 49568. Идем глубже, в реализацию GetTextPositionFromPoint () внутри TextBoxView.

Во, GetLineIndexFromPoint () выглядит многообещающе. Вызываем в своем коде.

var o20 = textView.InvokeMethod("GetLineIndexFromPoint", new Point(-txt.HorizontalOffset, y0), true);
var o21 = textView.InvokeMethod("GetLineIndexFromPoint", new Point(-txt.HorizontalOffset, y1), true);
var o22 = textView.InvokeMethod("GetLineIndexFromPoint", new Point(-txt.HorizontalOffset, y2), true);

Получаем 8510, 8511 и 8513 — бинго! К реализации:

Даже невооруженным взглядом видно, что это бинарный поиск. _lineMetrics — список характеристик строк (начало, длина, ширина границы). Радостно потираю ручки — я думал, что как это нередко бывает где-то забыли +1 воткнуть или поставили > вместо >=. Копируем функцию в код и отладим. Из-за закрытости типов _lineMetrics вытаскиваем через reflections, _lineHeight же мы уже достали раньше. Итого:

var lm = textView.GetFieldValue