Очистка коллекции в методе TReader.ReadCollection: разбираемся в поведении компонента

Delphi , Компоненты и Классы , TWriter и TReader

Вопрос, поднятый пользователем pyscripter, касается поведения метода TReader.ReadCollection в контексте работы с коллекциями в Delphi. Суть проблемы заключается в том, что при чтении пустой коллекции она не очищается, что может быть неудобно для пользователей, желающих явно очистить коллекцию в свойствах компонента в дизайнере.

Проблема с методом TReader.ReadCollection

Метод TReader.ReadCollection используется для загрузки данных в коллекцию. В его реализации присутствует проверка на конец списка, и если список не пуст, то выполняется очистка коллекции перед загрузкой данных. Это поведение закреплено с времён Delphi 4 и с тех пор не изменялось.

Влияние на наследование форм

Пользователь pyscripter указал на проблемы, связанные с наследованием форм. В частности, если в дочерней форме не изменять коллекцию, то при запуске приложения или при закрытии и повторном открытии формы, коллекция восстанавливается в состояние, заданное в базовой форме.

Необходимость очистки коллекции при создании компонента

Пользователь также отметил, что если компонент инициализирует коллекцию некоторыми элементами при создании, то у пользователя нет возможности очистить эту коллекцию в дизайнере. Примером может служить компонент SynEdit с коллекцией ScrollbarAnnotations, которая инициализируется некоторыми значениями по умолчанию и не может быть очищена в дизайнере.

Возможные решения

Работа с наследованием форм

Для решения проблемы с наследованием форм можно использовать переопределение метода Loaded компонента, в котором проверяется флаг, указывающий на необходимость очистки коллекции, и при необходимости выполняется очистка.

procedure TCustomComponent.Loaded;
begin
  if FClearOnLoad then
  begin
    FCollection.Clear;
    FClearOnLoad := False;
  end;
  inherited;
end;

Инициализация и очистка коллекции

Для компонентов, которые инициализируют коллекцию при создании, можно использовать метод ReadState для контроля состояния коллекции. В этом методе можно добавить проверку на пустоту коллекции и, если она пуста, установить флаг, который будет использоваться для очистки коллекции при следующем вызове ReadState.

procedure TCustomSynEdit.ReadState(Reader: TReader);
begin
  if not FStateRead then
  begin
    FScrollbarAnnotations.Clear; // Очистка только при первом чтении
    FStateRead := True;
  end;
  inherited;
end;

Заключение

Возможные изменения в поведении TReader.ReadCollection могут повлечь за собой нежелательные последствия для обратной совместимости, поэтому рекомендуется использовать предложенные workaround для решения конкретных задач.

Пользователь pyscripter, несмотря на сомнения, всё же отправил отчёт об ошибке в компанию Embarcadero, но, учитывая стабильность и длительное время использования текущей реализации, вероятность изменений в поведении метода TReader.ReadCollection крайне мала.

Создано по материалам из источника по ссылке.

Context: Обсуждается проблема поведения метода TReader.ReadCollection в Delphi, связанная с неочисткой пустых коллекций, что затрудняет управление коллекциями в дизайнере и вызывает проблемы при наследовании форм.

Комментарии и вопросы

Получайте свежие новости и обновления по Object Pascal, Delphi и Lazarus прямо в свой смартфон. Подпишитесь на наш Telegram-канал delphi_kansoftware и будьте в курсе последних тенденций в разработке под Linux, Windows, Android и iOS

:: Главная :: TWriter и TReader ::