WriteCompilerDetectionHeader

Этот модуль предоставляет функцию write_compiler_detection_header().

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

write_compiler_detection_header(
          FILE <file>
          PREFIX <prefix>
          [OUTPUT_FILES_VAR <output_files_var> OUTPUT_DIR <output_dir>]
          COMPILERS <compiler> [...]
          FEATURES <feature> [...]
          [BARE_FEATURES <feature> [...]]
          [VERSION <version>]
          [PROLOG <prolog>]
          [EPILOG <epilog>]
          [ALLOW_UNKNOWN_COMPILERS]
          [ALLOW_UNKNOWN_COMPILER_VERSIONS]
)

Это генерирует файл <file> с макросами, у которых у всех есть префикс <prefix>.

По умолчанию всё содержимое записывается непосредственно в <file>. OUTPUT_FILES_VAR может быть указано для записи содержимого, специфичного для компилятора, в отдельные файлы. Отдельные файлы затем доступны в <output_files_var> и могут быть использованы вызывающим объектом для установки, например. OUTPUT_DIR указывает относительный путь от основного <file> к файлам, специфичным для компилятора. Например:

write_compiler_detection_header(
  FILE climbingstats_compiler_detection.h
  PREFIX ClimbingStats
  OUTPUT_FILES_VAR support_files
  OUTPUT_DIR compilers
  COMPILERS GNU Clang MSVC Intel
  FEATURES cxx_variadic_templates
)
install(FILES
  ${CMAKE_CURRENT_BINARY_DIR}/climbingstats_compiler_detection.h
  DESTINATION include
)
install(FILES
  ${support_files}
  DESTINATION include/compilers
)

VERSION может быть использовано для указания версии API, которая должна быть сгенерирована. Будущие версии CMake могут ввести альтернативные API. Данный API выбирается любым <version> значением, больше или равным версии CMake, которая представила данный API, и меньше версии CMake, которая представила последующий API. Если явная версия не указана, используется значение переменной CMAKE_MINIMUM_REQUIRED_VERSION. (Начиная с версии CMake 3.19.0-rc3, существует только одна версия API.)

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

Должен быть указан как минимум один <compiler> и один <feature>. Компиляторы, известные CMake, но не указанные, обнаруживаются и для них генерируется препроцессор #error. Для каждого компилятора, известного CMake, генерируется макрос препроцессора, соответствующий <PREFIX>_COMPILER_IS_<compiler>, содержащий значение 0 или 1.

Возможные идентификаторы компиляторов документированы с помощью переменной CMAKE_<LANG>_COMPILER_ID. Доступные функции в этой версии CMake перечислены в глобальных свойствах CMAKE_C_KNOWN_FEATURES и CMAKE_CXX_KNOWN_FEATURES. Мета-функции {c,cxx}_std_* игнорируются, если они запрошены.

См. руководство cmake-compile-features(7) для получения информации о функциях компиляции.

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

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

Макросы проверки функций

Для каждого компилятора генерируется макрос препроцессора, соответствующий <PREFIX>_COMPILER_IS_<compiler>, который содержит либо 0, либо 1, в зависимости от используемого компилятора. Макросы препроцессора для компонентов версии компилятора генерируются, соответствующие <PREFIX>_COMPILER_VERSION_MAJOR <PREFIX>_COMPILER_VERSION_MINOR и <PREFIX>_COMPILER_VERSION_PATCH, содержащие десятичные значения соответствующих компонентов версии компилятора, если они определены.

Генерируется тест препроцессора на основе версии компилятора, определяющий, включена ли каждая функция. Макрос препроцессора, соответствующий <PREFIX>_COMPILER_<FEATURE>, где <FEATURE> - это имя <feature> в верхнем регистре, генерируется для содержания значения 0 или 1, в зависимости от того, поддерживает ли используемый компилятор функцию:

write_compiler_detection_header(
  FILE climbingstats_compiler_detection.h
  PREFIX ClimbingStats
  COMPILERS GNU Clang AppleClang MSVC Intel
  FEATURES cxx_variadic_templates
)

#if ClimbingStats_COMPILER_CXX_VARIADIC_TEMPLATES
template<typename... T>
void someInterface(T t...) { /* ... */ }
#else
// Compatibility versions
template<typename T1>
void someInterface(T1 t1) { /* ... */ }
template<typename T1, typename T2>
void someInterface(T1 t1, T2 t2) { /* ... */ }
template<typename T1, typename T2, typename T3>
void someInterface(T1 t1, T2 t2, T3 t3) { /* ... */ }
#endif

Макросы символов

Для определенных функций создаются дополнительные определения символов, которые могут быть условно определены как пустые:

class MyClass ClimbingStats_FINAL
{
    ClimbingStats_CONSTEXPR int someInterface() { return 42; }
};

Макрос ClimbingStats_FINAL будет раскрываться как final, если компилятор (и его флаги) поддерживает функцию cxx_final, а макрос ClimbingStats_CONSTEXPR будет раскрываться как constexpr, если поддерживается cxx_constexpr.

Если BARE_FEATURES cxx_final было передано в качестве аргумента, ключевое слово final также будет определено для старых компиляторов.

Следующие функции генерируют соответствующие определения символов, если они доступны как BARE_FEATURES:

Макросы реализации совместимости

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

Когда функция cxx_static_assert не предоставляется компилятором, реализация обратной совместимости доступна через функционально-подобные макросы <PREFIX>_STATIC_ASSERT(COND) и <PREFIX>_STATIC_ASSERT_MSG(COND, MSG). Макросы раскрываются как static_assert, если функция компилятора доступна, и к реализации обратной совместимости в противном случае. В первом виде условие строятся в поле сообщения static_assert. Во втором случае сообщение MSG передается в поле сообщения static_assert, или игнорируется, если используется реализация обратной совместимости.

Функция cxx_attribute_deprecated предоставляет определение макроса <PREFIX>_DEPRECATED, которое раскрывается либо как стандартное атрибут [[deprecated]], либо как декоратор, специфичный для компилятора, например, __attribute__((__deprecated__)), используемый компиляторами GNU.

Функция cxx_alignas предоставляет определение макроса <PREFIX>_ALIGNAS, которое раскрывается либо как стандартный декоратор alignas, либо как декоратор, специфичный для компилятора, например, __attribute__ ((__aligned__)), используемый компиляторами GNU.

Функция cxx_alignof предоставляет определение макроса <PREFIX>_ALIGNOF, которое раскрывается либо как стандартный декоратор alignof, либо как декоратор, специфичный для компилятора, например, __alignof__, используемый компиляторами GNU.

Случай использования, который возникает с такими макросами устаревания, — это устаревание всей библиотеки. В этом случае все общедоступные API в библиотеке могут быть помечены макросом <PREFIX>_DEPRECATED. Это приводит к очень шумному выводу сборки при сборке самой библиотеки, поэтому макрос может быть определён как пустой в этом случае при сборке устаревшей библиотеки:

add_library(compat_support ${srcs})
target_compile_definitions(compat_support
  PRIVATE
    CompatSupport_DEPRECATED=
)