WriteCompilerDetectionHeader

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

Функция 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> [...]
          [VERSION <version>]
          [PROLOG <prolog>]
          [EPILOG <epilog>]
          [ALLOW_UNKNOWN_COMPILERS]
          [ALLOW_UNKNOWN_COMPILER_VERSIONS]
)

Функция write_compiler_detection_header генерирует файл <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.10.3 существует только одна версия 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) для получения информации о функциях компиляции.

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 поддерживается.

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

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

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

Когда функция 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=
)