inline спецификатор

Спецификатор inline, используемый в последовательности decl-specifier-seq функции, объявляет функцию как встроенную функцию.

Функция, определённая полностью внутри определения класса/структуры/объединения, будь то член-функция или не являющаяся членом функция friend, неявно является встроенной функцией за исключением случаев, когда она прикреплена к именованному модулю(с C++20).

Объяснение

Встроенная функция или встроенная переменная(с C++17) обладает следующими свойствами:

• Определение встроенной функции или переменной(с C++17) должно быть доступно в единице трансляции, где оно используется (не обязательно до точки использования).
• Встроенная функция или переменная(с C++17) с внешней связью (например, не объявленная как static) имеет следующие дополнительные свойства:
• В программе может быть несколько определений встроенной функции или переменной(с C++17), при условии, что каждое определение находится в разных единицах трансляции и (для нестатических встроенных функций и переменных(с C++17)) все определения идентичны. Например, встроенную функцию или встроенную переменную(с C++17) можно определить в заголовочном файле, который подключается в несколько исходных файлов.
• Она должна быть объявлена как inline в каждой единице трансляции.
• Она имеет один и тот же адрес в каждой единице трансляции.

Для встроенной функции,

• Локальные статические объекты во всех определениях функции совместно используются во всех единицах трансляции (они все ссылаются на один и тот же объект, определённый в одной единице трансляции).
• Типы, определённые во всех определениях функции, также одинаковы во всех единицах трансляции.

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

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

Примечания

Если встроенная функция или переменная(с C++17) с внешней связью определена по-разному в разных единицах трансляции, программа считается некорректной, без необходимости диагностики.

Спецификатор inline не может использоваться с объявлением функции или переменной(с C++17) в области блока (внутри другой функции).

Спецификатор inline не может повторно объявить функцию или переменную(с C++17), которая уже была определена в единице трансляции как не встроенная.

Неявные функции-члены и любые функции-члены, объявленные как по умолчанию в своём первом объявлении, являются встроенными, как и любая другая функция, определённая внутри определения класса.

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

В C, встроенные функции не обязательно должны быть объявлены inline в каждой единице трансляции (как максимум одна может быть не inline или extern inline), определения функции не обязательно должны быть идентичны (но поведение программы не определено, если оно зависит от того, какой вызов используется), а локальные статические переменные отличаются между разными определениями одной и той же функции.

Пример

Заголовок "example.h":

#ifndef EXAMPLE_H
#define EXAMPLE_H
 
#include <atomic>
 
// function included in multiple source files must be inline
inline int sum(int a, int b)
{
    return a + b;
}
 
// variable with external linkage included in multiple source files must be inline
inline std::atomic<int> counter(0);
 
#endif

Исходный файл #1:

#include "example.h"
 
int a()
{
    ++counter;
    return sum(1, 2);
}

Исходный файл #2:

#include "example.h"
 
int b()
{
    ++counter;
    return sum(3, 4);
}

Отчёты об ошибках

Следующие отчёты об ошибках, которые изменяли поведение, были применены ретроактивно к ранее опубликованным стандартам C++.

См. также