Приостановка функции

Добро пожаловать на урок о сопрограммах — последней большой теме Lua. Многие новички никогда не встречали ничего подобного, поэтому начнём не с кода, а с идеи.

Каждая функция, которую вы писали до сих пор, выполняется от начала до конца за один раз: когда вы её вызываете, остальная программа ждёт, пока она закончит. А теперь представьте, что Эмма рассказывает вам о своём дне по частям. Утром она говорит: «Я покормила кур». И уходит работать. Когда вы встречаетесь в полдень, она не начинает заново, а продолжает: «Я полила морковь». Она помнит, где остановилась.

Сопрограмма (coroutine) — это функция, которая умеет то же самое: остановиться посередине, запомнить, где она была (и значения своих локальных переменных), а потом продолжить ровно с этого места. Название означает «подпрограммы, которые работают вместе»: «подпрограмма» — старое слово для функции, а сопрограмма ходит по очереди с остальной программой. Вот день Эммы в виде сопрограммы:

-- День Эммы по шагам
local function emmasDay()
    print("Эмма кормит кур.")
    coroutine.yield()
    print("Эмма поливает морковь.")
    coroutine.yield()
    print("Эмма продаёт яйца на рынке.")
end

local day = coroutine.create(emmasDay)
print(coroutine.status(day))
coroutine.resume(day)
print("(Солнце поднимается выше.)")
coroutine.resume(day)
print(coroutine.status(day))
coroutine.resume(day)
print(coroutine.status(day))

Он выводит:

suspended
Эмма кормит кур.
(Солнце поднимается выше.)
Эмма поливает морковь.
suspended
Эмма продаёт яйца на рынке.
dead

Всю работу делают три функции из библиотеки coroutine языка Lua:

• coroutine.create(emmasDay) создаёт сопрограмму из функции emmasDay. Пока она ничего не запускает. Передавать нужно саму функцию, без скобок.
• coroutine.resume(day) (возобновление) запускает сопрограмму, пока она не дойдёт до coroutine.yield() или до конца функции. Первый resume начинает с начала функции, каждый следующий продолжает сразу после того yield, где сопрограмма остановилась.
• coroutine.yield() внутри функции приостанавливает сопрограмму (передаёт управление), и программа продолжается после того resume, который её запустил. («Yield» по-английски значит «уступать», как машина уступает дорогу на перекрёстке.)

coroutine.status(day) показывает, в каком состоянии сопрограмма: suspended (приостановлена: ещё не запускалась или ждёт на yield), running (её код выполняется прямо сейчас, так что увидеть это может только сама сопрограмма) или dead (она дошла до конца функции и продолжить уже не может).

Чем это полезно? В играх полно дел, которые занимают время: торговец Гуго едет из города в город, дверь медленно открывается, Эмма идёт через поле. Игра рисует новую картинку (кадр) много раз в секунду или, если она пошаговая, даёт каждому персонажу ход, и все эти дела должны двигаться вперёд по одному маленькому шагу. С сопрограммой вы пишете такое дело как одну обычную функцию, от начала до конца, а coroutine.yield() ставите там, где нужно дождаться следующего кадра или хода. Такие сценарии вы напишете позже в этом уроке.

Типичные ошибки:

• Вызвать функцию самому, emmasDay(), или со скобками внутри coroutine.create(emmasDay()). В обоих случаях emmasDay запускается как обычная функция, а не как сопрограмма, и её yield нечего приостанавливать. Программа выведет Эмма кормит кур. и остановится с ошибкой attempt to yield from outside a coroutine. В этом сообщении нет номера строки; нужную строку вы найдёте в stack traceback: под ним.
• Вызвать сопрограмму как функцию, day(). Сопрограмма — не функция, а значение особого типа, thread, поэтому вы получите attempt to call a thread value (local 'day'). Сопрограмма запускается только через coroutine.resume.