Функции


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

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

<тип данных> <имя функции> (<набор параметров>) {
  <тело функции>
}

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

<имя функции>(<набор параметров>);

Если параметры не передаются, нужно указать пустые скобки в любом случае!

<имя функции>();

Функция может принимать параметры, может не принимать, может возвращать какое-то значение, может не возвращать. Давайте рассмотрим эти варианты.

“Типы” функций


Функция, которая ничего не принимает и ничего не возвращает


Самый простой для понимания вариант, с него и начнём. Помимо типов данных, которые я перечислял в уроке о типах данных, есть ещё один – void, который переводится с английского как “пустота”. Создавая функцию типа void мы указываем компилятору, что никаких значений возвращаться не будет (точнее будет – функция вернёт “ничего”). Давайте напишем функцию, которая найдёт сумму двух чисел и присвоит её третьему числу. Так как функция у нас без параметров и ничего не возвращает, переменные придётся объявить заранее и сделать их глобальными, иначе функция не будет иметь к ним доступ и мы получим ошибку:

byte a, b;
int c;

void setup() {
  a = 10;
  b = 20;
  sumFunction();
  // после вызова функции
  // с имеет значение 30
}

void loop() {
}

void sumFunction() {
  c = a + b;
}

Это очень плохой пример с точки зрения оптимальности кода, но далее мы будем этот пример улучшать и в итоге получим конфетку. Чем он плох на данном этапе: у нас используются глобальные переменные, и они же участвуют внутри функции, а одним из главных принципов программирования на C++ является разделение данных и действий, а также минимизация количества глобальных переменных. Будучи новичком, не стоит об этом сильно задумываться, позже вы сами к этому придёте.

Разделяя данные и действия можно создавать универсальные инструменты, рассмотренная выше функция не является универсальной: она складывает глобальную а с глобальной b и записывает результат в глобальную же c. Сделаем следующий шаг к оптимизации: пусть функция возвращает значение.

Функция, которая ничего не принимает и возвращает результат


Чтобы функция могла вернуть численное значение, она должна быть описана с типом данных, который будет возвращаться. Нужно заранее подумать, какой тип будет возвращён, чтобы избежать ошибок. Например я знаю, что моя суммирующая функция работает с типом данных byte, она складывает два таких числа. Это означает, что результат вполне может превысить лимит на тип данных byte (сложили 100 и 200 и вот, уже 300), значит функции следовало бы возвращать например тип данных int. Собственно поэтому у переменной c тип данных тоже int.

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

Один момент: функция типа void вроде бы ничего не возвращает, но использование return позволит завершить выполнение функции по условию или как-то ещё. Это очень удобно!

Давайте перепишем наш код так, чтобы числа a и b складывались и результат возвращался функцией, и этот результат мы уже “ручками” приравняем к c

byte a, b;
int c;

void setup() {
  a = 10;
  b = 20;
  c = sumFunction();
  // с имеет значение 30
}

void loop() {
}

int sumFunction() {
  return (a + b);
}

Ну вот, функция стала чуть более универсальной. Теперь результат сложения a и b как функцию можно использовать в других местах и приравнивать к другим переменным. Чтобы сделать код ещё более универсальным, давайте передавать величины для сложения в виде параметров

Функция, которая принимает параметры и возвращает результат


Что касается параметров, то они перечисляются в скобках через запятую с указанием типа данных. При вызове функции указанные параметры превращаются в локальные переменные, с которыми можно работать внутри функции. При вызове функции эти переменные получают значения, которые мы указываем при вызове. Смотрим:

byte a, b;
int c;

void setup() {
  a = 10;
  b = 20;
  c = sumFunction(a, b);
  // с имеет значение 30
}

void loop() {
}

int sumFunction(byte paramA, byte paramB) {
  return (paramA + paramB);
}

И вот так мы получили универсальную функцию sumFunction, которая принимает две величины типа byte, складывает их и возвращает. Это и есть выполнение концепции “отделение кода от данных”, функция живёт сама по себе и не зависит от других переменных!

Казалось бы, можно использовать функцию как sumFunction(100, 200), и она вернёт значение 300. Но не так всё просто, потому что целое число по умолчанию имеет тип данных int, и при попытке передать такой вот int в нашу функцию, которая принимает byte, мы получим ошибку, в которой будет написано, что нельзя передать int вместо byte. В этом случае можно привести тип числа к byte вручную, вот так это будет выглядеть:

int c;

void setup() {
  c = sumFunction((byte)100, (byte)200);
  // с = 300
}

void loop() {
}

int sumFunction(byte paramA, byte paramB) {
  return (paramA + paramB);
}

А как быть, если мы хотим складывать уже имеющийся функцией другие типы данных? Например float. Можно преобразовать типы данных при передаче параметров, но функция всё равно вернёт целое число. Сделать нашу функцию ещё более универсальной сможет такая штука C++ как перегруженная функция.

Перегруженные функции


Перегруженная функция это такая функция, которая определена несколько раз с одинаковым именем, но разным возвращаемым типом данных и разным набором параметров

int c;
float d;

void setup() {
  float af = 5.5;
  float bf = 0.25;
  Serial.begin(9600);
  c = sumFunction(10, 20);      // результат 30
  c = sumFunction(10, 20, 30);  // результат 60
  d = sumFunction(af, bf);      // результат 5.75
  Serial.println(c);
  Serial.println(d);
}

void loop() {
}

int sumFunction(int paramA, int paramB) {
  return (paramA + paramB);
}

int sumFunction(int paramA, int paramB, int paramC) {
  return (paramA + paramB + paramC);
}

float sumFunction(float paramA, float paramB) {
  return (paramA + paramB);
}

Итак, у нас теперь целых три функции с одинаковым именем, но разными наборами параметров и типов возвращаемого значения. Программа сама разберётся, какую из функций использовать, на основе передаваемых параметров. Передали два float – работает третья функция, вернёт float. Передали три int – получили их сумму при помощи второй по счёту функции. Передали два int – получили их сумму при помощи первой функции. Вот такая удобная штука!

Шаблонные функции


Шаблон – ещё один мощный инструмент языка C++, позволяющий создавать алгоритмы без привязки к типам данных. Тема очень обширная, мы рассмотрим её только применительно к “универсальным” функциям, полностью про шаблоны можно почитать тут, и тут продолжение.

Итак, шаблонные функции. В примере выше мы использовали перегруженные функции для создания функций с одинаковым именем, но разным типом передаваемых параметров. При помощи шаблонов можно сделать одну функцию, которая будет работать для всех типов данных! Компилятор сам выберет, какие типы данных подставить в функцию на этапе компиляции. Синтаксис выглядит так:

template <параметры_шаблона> описание_функции

Описание функции можно раскрыть:

template <параметры_шаблона> тип_данных (аргументы) {
  тело_функции
}

Сделаем функцию, которая возвращает квадрат числа любого типа

// шаблонная функция
// принимает данные любого типа
// возвращает в этом же типе
template<typename T>
T squareVal(T val) {
  return val * val;
}

void setup() {
  byte a = 10;
  int b = 125;
  float c = 3.14;
  
  a = squareVal(a);
  b = squareVal(b);
  c = squareVal(c);
  // a == 100
  // b == 15625
  // c == 9.85
}

Можно передать в шаблон больше данных! Вот пример функции, которая перемножает два числа любого типа и возвращает результат:

template<typename T1, typename T2>
uint32_t mult(T1 val1, T2 val2) {
  return val1 * val2;
}

void setup() {
  byte a = 10;
  int b = 125;
  float c = 3.14;

  long val = mult(a, b);
  val = mult(a, c);
}

В некоторых ситуациях шаблоны могут быть очень удобны!

Также при вызове шаблонной функции можно вручную передать тип данных:

mult<byte, float>(a, c);

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

Макро-функции


Вы наверное уже помните такую директиву препроцессору, как #define. Из урока про переменные и константы мы узнали, что при помощи дефайна можно задавать константы. Ключевая особенность работы define заключается в том, что он заменяет последовательность символов чем угодно, что мы там напишем, и это даёт возможность создавать так называемые макро-функции (macro), которые не создаются как функции, а вставляются в код при компиляции. Например вот так будет выглядеть макро, складывающая два числа:

#define sum(x, y) ((x)+(y)) 
“Аргументы” макро-функции нужно обязательно заключать в скобки (как (x)+(y) выше), иначе работа макроса может быть непредсказуемой, если в качестве аргумента подать не одно число, а выражение.

На этапе компиляции в данном документе с кодом все встречающиеся sum(значение1, значение2) будут заменены на значение1 + значение2, таким образом это будет сумма

#define sum(x, y) ((x)+(y))

void setup() {
  byte a = 10;
  byte b = 20;
  byte c = sum(a, b);
  // с получила значение 30
  // на этапе компиляции выражение sum(a, b)
  // превратилось в (a + b)

  int d = sum(500, 900);
  // d получила значение 1400
}

void loop() {
}

Зачем это нужно? Обычная функцию с именем, как разбиралось выше, имеет свой “адрес” в памяти, и при каждом вызове функции ядро обращается к ней по этому адресу, что занимает какое-то время. Макро функция же “встраивается” в код программы и выполняется сразу же. В то же время, если макро-функция вызывается в нескольких местах программы, она займёт больше места, чем отдельная обычная функция, т.к. все вызовы будут заменены на код. Делать макросы имеет смысл на простые функции (как в примере ниже), на редко вызываемые функции, и в тех местах, где важно максимальное быстродействие, т.е. важен каждый такт процессора.

В “языке” Arduino есть несколько готовых инструментов, которые кажутся функциями, но на самом деле являются макро. Заглянем в Arduino.h и увидим следующее:

#define min(a,b) ((a)<(b)?(a):(b))
#define max(a,b) ((a)>(b)?(a):(b))
#define abs(x) ((x)>0?(x):-(x))
#define constrain(amt,low,high) ((amt)<(low)?(low):((amt)>(high)?(high):(amt)))
#define round(x)     ((x)>=0?(long)((x)+0.5):(long)((x)-0.5))
#define radians(deg) ((deg)*DEG_TO_RAD)
#define degrees(rad) ((rad)*RAD_TO_DEG)
#define sq(x) ((x)*(x))

Вот так вот, всем нам знакомые функции оказались макросами!

А ещё можно “переносить строку” для создания макро-функций с большим количеством текста, перенос делается при помощи обратного слэша – \

#define printWords()        \
  Serial.print("Hello, ");  \
  Serial.print("World");    \
  Serial.println("!");

void setup() {
  Serial.begin(9600);
  printWords();
}

void loop() {}

Обратите внимание, на последней строке перенос уже не нужен! Таким образом, во время работы препроцессора все вызовы “функции” printWords будут заменены на указанные строки кода. Можно аргументы таким же образом передавать:

#define printWords(digit)     \
  Serial.print("Digit is ");  \
  Serial.print(digit);

void setup() {
  Serial.begin(9600);
  printWords(10);
}

void loop() {}

Как вы можете видеть, объявлять большую макро-функцию неудобно, и тут на помощь приходят встроенные функции.

Встроенные функции


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

Объявляется встроенная функция очень просто: достаточно дописать ключевое слово inline перед объявлением функции. Компилятор может отказаться встраивать функцию (зависит от его настроек), поэтому можно попросить его принудительно встроить функцию при помощи атрибута __attribute__((always_inline)). Таким образом, для объявления встроенной функции нужно в самом начале написать inline __attribute__((always_inline)). Рассмотрим функцию, которая просто увеличивает значение переменной:

inline __attribute__((always_inline))
int incr(int value) {
  return ++value;
}

Всё! Теперь вызовы incr будут заменены на код.

Если нужно разделить описание и реализацию, то можно записать так:

// прототип
inline __attribute__((always_inline)) int incr(int value);

// реализация (будет встроенной)
int incr(int value) {
  return ++value;
}

Статические функции


В уроке про переменные и типы данных мы обсуждали спецификатор static, который позволяет скрыть глобальную переменную от других файлов программы. С функцией спецификатор static делает то же самое – статическая функция скрыта от вызова из других файлов, т.е. её область определения – файл, в котором она находится. static void printHello();

Передача массива в функцию


Иногда бывает нужно передать в функцию массив (мы о них уже говорили), передать именно массив целиком, а не отдельный его элемент. В этом случае уже не обойтись без указателей (читай урок про указатели). В следующем примере наша функция sumFunction будет суммировать элементы массива, который в неё передаётся. Функция заранее знает, сколько в массиве элементов, потому что я явно цифрой указал количество в цикле for.

int c;
int myArray[] = {100, 30, 890, 645, 251};

void setup() {
  c = sumFunction(myArray);   // результат 1916
}

void loop() {
}

int sumFunction(int *intArray) {
  int sum = 0;   // переменная для сложения
  for (byte i = 0; i < 5; i++) {
    sum += intArray[i];
  }
  return sum;
}

Что из этого нужно запомнить: при описании функции параметр массива указывается со звёздочкой, т.е. <тип данных> *<имя массива> . При вызове массив передаётся как <имя массива> . И в целом всё.

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

int c;
int myArray[] = {100, 30, 890, 645, 251, 645, 821, 325};

void setup() {
  // передаём сам массив и его размер в БАЙТАХ
  c = sumFunction(myArray, sizeof(myArray));
}

void loop() {
}

int sumFunction(int *intArray, int arrSize) {
  // переменная для суммирования
  int sum = 0;  

  // находим размер массива, разделив его вес
  // на вес одного элемента (тут у нас int)
  arrSize = arrSize / sizeof(int);  
  for (byte i = 0; i < arrSize; i++) {
    sum += intArray[i];
  }
  return sum;
}

И вот мы получили функцию, которая суммирует массив типа данных int любой длины и возвращает результат! Второй способ провернуть такое – через шаблонную функцию. Преимущество в том, что передавать размер массива – необязательно, его можно посчитать внутри функции, вычислив размер аргумента шаблона:

int c;
int myArray[] = {100, 30, 890, 645, 251, 645, 821, 325};

void setup() {
  // передаём массив
  c = sumFunction(myArray);
}

template <typename T>
int sumFunction(T &intArray) {
  // переменная для суммирования
  int sum = 0;

  for (byte i = 0; i < sizeof(T); i++) {
    sum += intArray[i];
  }
  return sum;
}

void loop() {}

У – удобно!

Указатель на функцию


Указатели – очень сложная тема, которая практически не пригодится новичку, но некоторые алгоритмы знать нужно. Например передачу указателя на функцию, это полезно при создании своих функций в стиле ардуиновской attachInterrupt, в которой мы указываем свою функцию, которую сами создаём, а она вызывается в другом месте. Сделать это можно так:

void (*p_function)();   // указатель на p_function

void setup() {
  Serial.begin(9600);

  // прикрепляем функцию myFunction к *p_function
  attachFunction(myFunction);

  // вызываем p_function, которая у нас вызывает myFunction
  (*p_function)();
}

void loop() {
}

void attachFunction(void (*function)()) { // передача указателя на функцию
  p_function = *function;
}

void myFunction() {
  Serial.println("lolkek");
}

Описание и реализация


Хорошим тоном считается объявлять функции отдельно от реализации. Что это значит: в начале документа, или в отдельном файле, мы описываем функцию (это будет называться прототип функции), а в другом месте пишем реализацию. Так делают в серьёзных программных проектах, Ардуино-библиотеки – не исключение. Также такое написание позволяет слегка ускорить компиляцию кода, потому что компилятор уже знает, что он в нём найдёт. Алгоритм такой:

Описание (прототип) функции

<тип данных> <имя функции> (<набор параметров>);

Реализация функции

<тип данных> <имя функции> (<набор параметров>) {
  <тело функции>
}

То бишь всё то же самое, но с телом функции и фигурными скобками. Пример:

// описание функций
void lolkek(byte cheburek);
int getMemes();

void setup() {
}

void loop() {
}

// реализация функций
int getMemes() {
  // действия
}

void lolkek(byte cheburek) {
  // действия
}

Примечание: хоть компилятор и позволяет вызывать функцию до её объявления (по порядку написания кода), иногда он может не найти функцию и выведет ошибку “функция не объявлена”. В этом случае достаточно сделать прототип функции и расположить его поближе к началу документа, да и вообще все используемые функции можно сделать в виде прототипов и вынести в начало кода, вместе с глобальными переменными!

Видео


Важные страницы


  • Каталог ссылок на дешёвые Ардуины, датчики, модули и прочие железки с AliExpress у проверенных продавцов
  • Подборка библиотек для Arduino, самых интересных и полезных, официальных и не очень
  • Полная документация по языку Ардуино, все встроенные функции и макро, все доступные типы данных
  • Сборник полезных алгоритмов для написания скетчей: структура кода, таймеры, фильтры, парсинг данных
  • Видео уроки по программированию Arduino с канала “Заметки Ардуинщика” – одни из самых подробных в рунете
Последнее обновление Октябрь 10, 2019