Свои функции в скетче: раскладываем код по полочкам

Полгода я собирал светящиеся штуки одним способом: скопировать блок «включить — подождать — выключить — подождать» и вставить в loop() нужное число раз. Четыре светодиода на ёлочной звезде — четыре копии. Сменить темп — четыре правки. А потом была ночь перед выставкой, когда я поправил задержку в трёх местах из четырёх: первые три светодиода замигали вразвалочку, четвёртый продолжал жить в старом ритме, и вся конструкция выглядела сломанной, хотя в каждой отдельной строке ошибок не было. Ошибка была в самом подходе: одна и та же операция лежала в коде четырьмя экземплярами.

С массивами мы уже выгребли половину этой беды: массив пинов из урока про массивы и журнал показаний заменил пять переменных led1..led5 одной полкой. Но массив лечит дубли данных, а не дубли действий: цикл по массиву всё равно тащит внутри себя одни и те же четыре строки digitalWrite-delay-digitalWrite-delay. Вторая половина лечения — функция: один блок кода с именем, который вызывается по имени сколько угодно раз и принимает значения — пин, длительность, что угодно. Дальше по скетчу вместо стенографии из строк появляется глагол: blinkLed(3, 150) — и читающему не надо разворачивать в голове, что там внутри.

План такой. Сначала анатомия: имя, параметры, возвращаемое значение, локальные переменные — и грабля со столкновением имён. Потом рефакторинг на живом скетче: три светодиода с копипастой ужимаются в функцию blinkLed(pin, ms), с честным подсчётом строк. Дальше — функции с ответом: readPercent() переводит показания потенциометра в проценты, а среднее по журналу из прошлого урока становится функцией averageOf. И обязательно тупики: что функцией сделать не получится и во что это обходится.

Свои функции вы уже писали, не зная об этом: setup() и loop() из первого урока — те же функции, просто их вызывает сама плата. У любой функции три части: заголовок с типом и именем, параметры в круглых скобках, тело в фигурных. Строка void blinkLed(int pin, int ms) читается как договор: «зови меня blinkLed, дай два целых числа — номер пина и миллисекунды, отвечать я ничего не буду». Слово void и означает «ответа нет»: функция делает работу и молчит.

Второй вид — функции-вопросы: они считают и отвечают. Вместо void пишется тип ответа — int, float — и в теле появляется return: return sum / count; одновременно отдаёт значение и завершает функцию, строки после return не исполняются. Ответ кладут в переменную — int pct = readPercent(); — или сразу печатают, а дальше с ним работают как с обычным числом. Тип ответа — не украшение: компилятор сверяет, что return действительно отдаёт int, и ругается, если функция обещала число, а молчит.

Теперь локальные переменные и грабля, на которую я наступал дважды. Переменная, объявленная внутри функции, рождается при входе и умирает при выходе: int sum внутри averageOf снаружи не существует, и это хорошо — функция не рассыпает мусор по скетчу. Плохое начинается при столкновении имён. Пусть глобально объявлен int flashes = 0, а внутри функции вы пишете своё int flashes = 0 — это две разные ячейки: внутри функции слово flashes означает локальную, глобальная затенена и стоит нетронутой. Я однажды полчаса смотрел на мигающий ночник и не понимал, почему счётчик вспышек на экране не двигается: функция честно прибавляла к своей локальной копии. Отсюда правило, к которому я пришёл: функция не правит глобальные данные, а отвечает return-ом — тогда за данными следит одно место.

Считаем в редакторе: было 27 строк — setup с тремя pinMode и loop с тремя копиями блока по шесть строк плюс разделители. Стало 18: функция из шести строк, setup без изменений, loop из трёх вызовов. На этой мини-задаче экономия смешная, минус восемь строк, и если бы дело было только в строках, функцию не стоило бы трогать. Но меняются другие вещи. Темп мигания правится одним числом: сменить 150 на 300 — это одна правка вместо шести, а раньше я пропускал одну из шести, и четвёртый светодиод жил в старом ритме. Шестой светодиод — плюс одна строка вызова вместо семи. А опечатка в digitalWrite, размноженная копипастой на три места, теперь размножиться не может: тело функции существует в одном экземпляре.

Параметры в скобках — заполнители. При вызове blinkLed(3, 150) число 3 попадает в pin, 150 — в ms, и тело исполняется с этими значениями; три вызова — три прохода с разными числами. Имена pin и ms выбраны не для красоты: ms подсказывает, что число в миллисекундах, и через полгода в чужом коде вы не будете гадать, секунды это или вольты. Внутри тела работают привычные инструменты из урока про циклы: захотите мигнуть трижды — добавите третий параметр int times и обернёте тело в цикл for. По-моему, главная награда — чтение: loop() превращается в список дел, «мигнуть вторым, мигнуть третьим, мигнуть четвёртым», и ни одна строка не зависит от соседней.

Отдельно про цену. Функция не бесплатна: каждый вызов кладёт параметры и адрес возврата на стек — для blinkLed это считанные байты из тех же 2048, что и у глобальных переменных, а процессор при 16 МГц тратит на сам переход такты, которых на мигании не разглядеть. Настоящая цена другая: плохо названная функция прячет код так же надёжно, как размноженная копипаста его размножала. Мне не нравятся имена вроде f1 или doWork: через месяц вы сами не вспомните, что там происходило. Если имя не отвечает на вопрос «что делает», сначала переименуйте, потом наслаждайтесь компактностью.

Мигнуть — действие без ответа: мигнул, и всё. Совсем другая работа — посчитать и ответить. Возьмём аналоговый вход из урока про потенциометр: analogRead(A0) отдаёт 0..1023, а шкале и человеку нужны проценты. Заводим функцию int readPercent() { int raw = analogRead(A0); int pct = map(raw, 0, 1023, 0, 100); return pct; } — и по всему скетчу вместо трёх строк формулы остаётся одно слово readPercent(). Пересчёт теперь живёт в одном месте: когда шкале понадобится диапазон 0..50, правка случится в одной функции, а не в пяти местах скетча.

С массивами функции работают через параметры. В уроке про зуммер массив нот кормил tone() — идеальный кандидат вынести исполнение в функцию playNote(int freq, int ms): одно действие, одно имя. А среднее по журналу из прошлого урока становится функцией int averageOf(int values[], int count): параметр values[] — сам массив, count — сколько ячеек брать. Вызов averageOf(journal, 8) заменяет цикл суммирования из пяти строк, и та же функция честно посчитает журнал из шестнадцати ячеек — count подставите при вызове. Заметьте: массив при таком вызове не копируется, функция ходит по оригиналу; на Uno с его 2048 байтами RAM это не лирика, а экономия настоящих ячеек.

Ответ функции — полноценное значение, и его можно кормить другим функциям и условиям: if (readPercent() > 50) зажигает ночник — функция-вопрос работает прямо внутри условия. Функции срастаются и друг с другом: заведите blinkPattern(), которая трижды вызывает blinkLed(), — большие скетчи растут именно так, из мелких глаголов, а не из копипасты. Я перестал бояться дробить: функция из трёх строк с честным именем читается быстрее, чем те же три строки, встроенные в чужой поток.