8.9.4 Протокол быстрого перечисления

Если вы хотите, чтобы ваш собственный объект коллекции можно было использовать с быстрым перечислением, вам необходимо реализовать метод

- (unsigned long) countByEnumeratingWithState: (NSFastEnumerationState *)state
                                      objects: (id *)objects
                                        count: (unsigned long)len;

где NSFastEnumerationState должен быть определён в вашем коде следующим образом:

typedef struct
{
  unsigned long state;
  id            *itemsPtr;
  unsigned long *mutationsPtr;
  unsigned long extra[5];
} NSFastEnumerationState;

Если NSFastEnumerationState не определён в вашем коде, компилятор автоматически заменит NSFastEnumerationState * на struct __objcFastEnumerationState *, где этот тип неявно определяется компилятором аналогичным образом. Это может быть запутанно, и мы рекомендуем определить NSFastEnumerationState (как показано выше) вместо этого.

Метод вызывается многократно во время быстрого перечисления для получения партий объектов. Каждый вызов метода должен возвращать следующую партию объектов.

Значение возвращаемого методом является количеством объектов в текущей партии; оно не должно превышать len, что является максимальным размером партии, запрошенным вызывающим методом. Сама партия возвращается в поле itemsPtr структуры NSFastEnumerationState.

Для помощи в возвращении объектов массив objects является предопределённым вызывающим методом массивом C (в стеке) размером len. Во многих случаях вы можете поместить возвращаемые объекты в этот массив objects, а затем выполнить itemsPtr = objects. Но вам не обязательно; если ваша коллекция уже содержит объекты для возвращения в виде массива C, она может вернуть их оттуда вместо этого.

Поля state и extra структуры NSFastEnumerationState позволяют вашему объекту коллекции отслеживать состояние перечисления. В реализации простого массива state может отслеживать индекс последнего возвращённого объекта, а extra может быть неиспользуемым.

Поле mutationsPtr структуры NSFastEnumerationState используется для отслеживания мутаций. Оно должно указывать на число; перед обработкой каждого объекта цикл быстрого перечисления проверяет, не изменилось ли это число. Если изменилось, произошла мутация, и быстрое перечисление прервётся. Таким образом, mutationsPtr можно установить на указание на некий номер версии вашей коллекции, который увеличивается на единицу каждый раз, когда происходит изменение (например, при добавлении или удалении объекта). Или, если вас устраивают менее строгие проверки на мутации, оно может указывать на количество объектов в вашей коллекции или какое-то другое значение, которое можно проверить, чтобы приблизительно убедиться, что коллекция не была изменена.

Наконец, обратите внимание, как мы объявили аргумент len и возвращаемое значение как тип unsigned long. Их также можно объявить как тип unsigned int и всё равно всё будет работать.

Предыдущий: Подробности быстрого перечисления, Вверх: Быстрое перечисление [Оглавление][Индекс]