cmake-compile-features(7)

• Введение

• Требования к функциям компиляции

  • Требование к стандартам языка
  • Доступность расширений компилятора
• Необязательные функции компиляции
• Условные параметры компиляции
• Поддерживаемые компиляторы

Введение

Исходный код проекта может зависеть от или быть условным в зависимости от наличия определенных функций компилятора. Возникают три случая использования: Требования к функциям компиляции, Необязательные функции компиляции и Условные параметры компиляции.

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

Глобальные свойства CMAKE_C_KNOWN_FEATURES, CMAKE_CUDA_KNOWN_FEATURES и CMAKE_CXX_KNOWN_FEATURES содержат все функции, известные CMake, независимо от поддержки функции компилятором. Переменные CMAKE_C_COMPILE_FEATURES, CMAKE_CUDA_COMPILE_FEATURES и CMAKE_CXX_COMPILE_FEATURES содержат все функции, о которых CMake знает, что компилятор их знает, независимо от стандарта языка или флагов компиляции, необходимых для их использования.

Функции, известные CMake, обычно имеют ту же конвенцию именования, что и макросы тестирования функций Clang. Есть некоторые исключения, такие как использование CMake cxx_final и cxx_override вместо одного cxx_override_control Clang.

Обратите внимание, что для языков OBJC и OBJCXX нет отдельных свойств или переменных для функций компиляции. Они основаны на C или C++ соответственно, поэтому для использования следует использовать соответствующие свойства и переменные базового языка.

Требования к функциям компиляции

Требования к функциям компиляции могут быть указаны с помощью команды target_compile_features(). Например, если целевой объект должен быть скомпилирован с поддержкой компилятором функции cxx_constexpr:

add_library(mylib requires_constexpr.cpp)
target_compile_features(mylib PRIVATE cxx_constexpr)

При обработке требования к функции cxx_constexpr, cmake(1) гарантирует, что используемый компилятор C++ поддерживает эту функцию, и добавит необходимые флаги, такие как -std=gnu++11, к строкам компиляции файлов C++ в целевом объекте mylib. Если компилятор не поддерживает функцию, выводится сообщение FATAL_ERROR.

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

Эти флаги компиляции добавляются даже если компилятор поддерживает конкретную функцию без флага. Например, GNU компилятор поддерживает вариативные шаблоны (с предупреждением), даже если используется -std=gnu++98 . CMake добавляет флаг -std=gnu++11, если cxx_variadic_templates указан как требование.

В приведенном выше примере mylib требует cxx_constexpr, когда он сам компилируется, но потребителям mylib не требуется использовать компилятор, который поддерживает cxx_constexpr. Если интерфейс mylib требует функции cxx_constexpr (или любой другой известной функции), это может быть указано с помощью подписей PUBLIC или INTERFACE команды target_compile_features():

add_library(mylib requires_constexpr.cpp)
# cxx_constexpr is a usage-requirement
target_compile_features(mylib PUBLIC cxx_constexpr)

# main.cpp will be compiled with -std=gnu++11 on GNU for cxx_constexpr.
add_executable(myexe main.cpp)
target_link_libraries(myexe mylib)

Требования к функциям оцениваются транзитивно, потребляя реализацию ссылки. См. cmake-buildsystem(7) для получения дополнительной информации о транзитивном поведении свойств сборки и требованиях к использованию.

Требование к стандартам языка

В проектах, использующих большое количество распространенных функций из конкретного стандарта языка (например, C++ 11), можно указать метафункцию (например, cxx_std_11), которая требует использования режима компилятора, по крайней мере, знакомого с этим стандартом, но может быть больше. Это проще, чем указать все функции индивидуально, но не гарантирует существование конкретной функции. Диагностика использования неподдерживаемых функций будет отложена до времени компиляции.

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

target_compile_features(mylib PUBLIC cxx_std_11)

В этом примере CMake гарантирует, что компилятор будет вызван в режиме по крайней мере C++ 11 (или C++ 14, C++ 17 и т. д.), добавив флаги, такие как -std=gnu++11, при необходимости. Это относится к исходным файлам в mylib, а также к любым зависимостям (которые могут включать заголовки из mylib).

Доступность расширений компилятора

Поскольку свойство целевого объекта CXX_EXTENSIONS по умолчанию ON, CMake по умолчанию использует расширенные варианты диалектов языка, такие как -std=gnu++11 вместо -std=c++11 . Это свойство целевого объекта можно установить в OFF, чтобы использовать нерасширенный вариант флага диалекта. Обратите внимание, что, поскольку большинство компиляторов по умолчанию включают расширения, это может привести к появлению проблем с кросс-платформенной совместимостью в пользовательском коде или в заголовках зависимостей сторонних разработчиков.

Необязательные функции компиляции

Функции компиляции могут быть предпочтительными, если они доступны, без создания жестких требований. Например, библиотека может предоставлять альтернативные реализации в зависимости от того, доступна ли функция cxx_variadic_templates:

#if Foo_COMPILER_CXX_VARIADIC_TEMPLATES
template<int I, int... Is>
struct Interface;

template<int I>
struct Interface<I>
{
  static int accumulate()
  {
    return I;
  }
};

template<int I, int... Is>
struct Interface
{
  static int accumulate()
  {
    return I + Interface<Is...>::accumulate();
  }
};
#else
template<int I1, int I2 = 0, int I3 = 0, int I4 = 0>
struct Interface
{
  static int accumulate() { return I1 + I2 + I3 + I4; }
};
#endif

Такой интерфейс зависит от использования правильных препроцессорных определений для функций компилятора. CMake может сгенерировать заголовочный файл, содержащий такие определения, с помощью модуля WriteCompilerDetectionHeader. Модуль содержит функцию write_compiler_detection_header, которая принимает параметры для управления содержимым генерируемого заголовочного файла:

write_compiler_detection_header(
  FILE "${CMAKE_CURRENT_BINARY_DIR}/foo_compiler_detection.h"
  PREFIX Foo
  COMPILERS GNU
  FEATURES
    cxx_variadic_templates
)

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

Для каждой функции, перечисленной в FEATURES, в заголовочном файле создается определение препроцессора, определенное как 1 или 0.

Кроме того, некоторые функции требуют дополнительных определений, таких как функции cxx_final и cxx_override. Вместо использования в коде #ifdef, ключевое слово final абстрагируется символом, который определяется как final, эквивалентом для конкретного компилятора, или как пустая строка. Таким образом, код C++ может быть написан для безусловного использования символа, и поддержка компилятора определяет, на что он будет расширен:

struct Interface {
  virtual void Execute() = 0;
};

struct Concrete Foo_FINAL {
  void Execute() Foo_OVERRIDE;
};

В этом случае Foo_FINAL будет расширяться до final, если компилятор поддерживает ключевое слово, или до пустой строки в противном случае.

В этом случае код CMake хотел бы включить определенный стандарт языка, если он доступен от компилятора. Переменная свойства целевого объекта CXX_STANDARD может быть установлена в желаемый стандарт языка для определенной цели, а CMAKE_CXX_STANDARD может быть установлена для влияния на все последующие цели:

write_compiler_detection_header(
  FILE "${CMAKE_CURRENT_BINARY_DIR}/foo_compiler_detection.h"
  PREFIX Foo
  COMPILERS GNU
  FEATURES
    cxx_final cxx_override
)

# Includes foo_compiler_detection.h and uses the Foo_FINAL symbol
# which will expand to 'final' if the compiler supports the requested
# CXX_STANDARD.
add_library(foo foo.cpp)
set_property(TARGET foo PROPERTY CXX_STANDARD 11)

# Includes foo_compiler_detection.h and uses the Foo_FINAL symbol
# which will expand to 'final' if the compiler supports the feature,
# even though CXX_STANDARD is not set explicitly.  The requirement of
# cxx_constexpr causes CMake to set CXX_STANDARD internally, which
# affects the compile flags.
add_library(foo_impl foo_impl.cpp)
target_compile_features(foo_impl PRIVATE cxx_constexpr)

Функция write_compiler_detection_header также создает совместимый код для других функций, имеющих стандартные аналоги. Например, функция cxx_static_assert эмулируется с помощью шаблона и абстрагируется с помощью функций-макросов <PREFIX>_STATIC_ASSERT и <PREFIX>_STATIC_ASSERT_MSG.

Условные параметры компиляции

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

Например, заголовок в with_variadics/interface.h может содержать:

template<int I, int... Is>
struct Interface;

template<int I>
struct Interface<I>
{
  static int accumulate()
  {
    return I;
  }
};

template<int I, int... Is>
struct Interface
{
  static int accumulate()
  {
    return I + Interface<Is...>::accumulate();
  }
};

в то время как заголовок в no_variadics/interface.h может содержать:

template<int I1, int I2 = 0, int I3 = 0, int I4 = 0>
struct Interface
{
  static int accumulate() { return I1 + I2 + I3 + I4; }
};

Возможно написать абстрактный заголовочный файл interface.h, содержащий что-то вроде:

#include "foo_compiler_detection.h"
#if Foo_COMPILER_CXX_VARIADIC_TEMPLATES
#include "with_variadics/interface.h"
#else
#include "no_variadics/interface.h"
#endif

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

CMake предоставляет COMPILE_FEATURES generator expression для реализации таких условий. Это может использоваться с командами свойств сборки, такими как target_include_directories() и target_link_libraries(), для установки соответствующих buildsystem свойств:

add_library(foo INTERFACE)
set(with_variadics ${CMAKE_CURRENT_SOURCE_DIR}/with_variadics)
set(no_variadics ${CMAKE_CURRENT_SOURCE_DIR}/no_variadics)
target_include_directories(foo
  INTERFACE
    "$<$<COMPILE_FEATURES:cxx_variadic_templates>:${with_variadics}>"
    "$<$<NOT:$<COMPILE_FEATURES:cxx_variadic_templates>>:${no_variadics}>"
  )

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

add_executable(consumer_with consumer_with.cpp)
target_link_libraries(consumer_with foo)
set_property(TARGET consumer_with CXX_STANDARD 11)

add_executable(consumer_no consumer_no.cpp)
target_link_libraries(consumer_no foo)

Поддерживаемые компиляторы

В настоящее время CMake поддерживает C++ standards и compile features, доступные в следующих compiler ids версиях:

• AppleClang: Apple Clang для Xcode версий 4.4+.
• Clang: Компилятор Clang версий 2.9+.
• GNU: GNU компилятор версий 4.4+.
• MSVC: Microsoft Visual Studio версий 2010+.
• SunPro: Oracle SolarisStudio версий 12.4+.
• Intel: Intel компилятор версий 12.1+.

В настоящее время CMake поддерживает C standards и compile features, доступные в следующих compiler ids версиях, начиная с указанных:

• все компиляторы и версии, перечисленные выше, для C++.
• GNU: GNU компилятор версий 3.4+.

CMake в настоящее время поддерживает C++ standards и связанные с ними мета-функции (например, cxx_std_11) в следующих compiler ids версиях:

• Cray: Cray Compiler Environment версии 8.1+.
• PGI: PGI версии 12.10+.
• NVHPC: NVIDIA HPC компиляторы версии 11.0+.
• TI: Texas Instruments компилятор.
• XL: IBM XL версии 10.1+.

CMake в настоящее время поддерживает C standards и связанные с ними мета-функции (например, c_std_99) в следующих compiler ids версиях:

• все компиляторы и версии, перечисленные выше, с мета-функциями только для C++.

CMake в настоящее время поддерживает CUDA standards и связанные с ними мета-функции (например, cuda_std_11) в следующих compiler ids версиях:

• Clang: Clang компилятор 5.0+.
• NVIDIA: NVIDIA nvcc компилятор 7.5+.