project

Установите имя проекта.

Синопсис

project(<PROJECT-NAME> [<language-name>...])
project(<PROJECT-NAME>
        [VERSION <major>[.<minor>[.<patch>[.<tweak>]]]]
        [DESCRIPTION <project-description-string>]
        [HOMEPAGE_URL <url-string>]
        [LANGUAGES <language-name>...])

Устанавливает имя проекта и сохраняет его в переменной PROJECT_NAME. При вызове из верхнего уровня CMakeLists.txt также сохраняет имя проекта в переменной CMAKE_PROJECT_NAME.

Также устанавливаются переменные:

PROJECT_SOURCE_DIR, <PROJECT-NAME>_SOURCE_DIR

Абсолютный путь к каталогу исходных файлов проекта.

PROJECT_BINARY_DIR, <PROJECT-NAME>_BINARY_DIR

Абсолютный путь к каталогу бинарных файлов проекта.

PROJECT_IS_TOP_LEVEL, <PROJECT-NAME>_IS_TOP_LEVEL

Новое в версии 3.21.

Булево значение, указывающее, является ли проект верхнего уровня.

Дополнительные переменные устанавливаются с помощью необязательных аргументов, описанных ниже. Если ни один из этих аргументов не используется, соответствующие переменные устанавливаются в пустую строку.

Параметры

Параметры:

VERSION <version>

Необязательно; может не использоваться, если политика CMP0048 не установлена в NEW.

Принимает аргумент <version>, состоящий из целочисленных компонентов не меньше нуля, т.е. <major>[.<minor>[.<patch>[.<tweak>]]], и устанавливает переменные

• PROJECT_VERSION, <PROJECT-NAME>_VERSION
• PROJECT_VERSION_MAJOR, <PROJECT-NAME>_VERSION_MAJOR
• PROJECT_VERSION_MINOR, <PROJECT-NAME>_VERSION_MINOR
• PROJECT_VERSION_PATCH, <PROJECT-NAME>_VERSION_PATCH
• PROJECT_VERSION_TWEAK, <PROJECT-NAME>_VERSION_TWEAK.

Новое в версии 3.12: При вызове команды project() из верхнего уровня CMakeLists.txt, версия также хранится в переменной CMAKE_PROJECT_VERSION.

DESCRIPTION <project-description-string>

Новое в версии 3.9.

Необязательно. Устанавливает переменные

• PROJECT_DESCRIPTION, <PROJECT-NAME>_DESCRIPTION

в значение <project-description-string>. Рекомендуется, чтобы это описание было относительно коротким, обычно не более нескольких слов.

При вызове команды project() из верхнего уровня CMakeLists.txt, описание также хранится в переменной CMAKE_PROJECT_DESCRIPTION.

Новое в версии 3.12: Добавлена переменная <PROJECT-NAME>_DESCRIPTION.

HOMEPAGE_URL <url-string>

Новое в версии 3.12.

Необязательно. Устанавливает переменные

• PROJECT_HOMEPAGE_URL, <PROJECT-NAME>_HOMEPAGE_URL

в значение <url-string>, которое должно быть канонической домашней ссылкой проекта.

При вызове команды project() из верхнего уровня CMakeLists.txt, URL также сохраняется в переменной CMAKE_PROJECT_HOMEPAGE_URL.

LANGUAGES <language-name>...

Необязательно. Также может быть указано без ключевого слова LANGUAGES в соответствии с первым, кратким определением.

Выбирает языки программирования, необходимые для построения проекта. Поддерживаемые языки включают C, CXX (т.е. C++), CUDA, OBJC (т.е. Objective-C), OBJCXX, Fortran, HIP, ISPC, и ASM. По умолчанию C и CXX включены, если не указаны параметры языка. Укажите язык NONE, или используйте ключевое слово LANGUAGES и не указывайте языки, чтобы отключить включение любых языков.

Новое в версии 3.8: Добавлена поддержка CUDA.

Новое в версии 3.16: Добавлена поддержка OBJC и OBJCXX.

Новое в версии 3.18: Добавлена поддержка ISPC.

Если включаете ASM, укажите его последним, чтобы CMake мог проверить, работают ли компиляторы для других языков, таких как C, и для ассемблера тоже.

Переменные, установленные с помощью параметров VERSION, DESCRIPTION и HOMEPAGE_URL, предназначены для использования в качестве значений по умолчанию в метаданных и документации пакетов.

Вставка кода

Если переменные CMAKE_PROJECT_INCLUDE_BEFORE или CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE_BEFORE установлены, файлы, на которые они указывают, будут включены на первом шаге команды project(). Если оба установлены, то CMAKE_PROJECT_INCLUDE_BEFORE будет включено перед CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE_BEFORE.

Если переменные CMAKE_PROJECT_INCLUDE или CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE установлены, файлы, на которые они указывают, будут включены на последнем шаге команды project(). Если оба установлены, то CMAKE_PROJECT_INCLUDE будет включено перед CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE.

Использование

Файл верхнего уровня CMakeLists.txt для проекта должен содержать прямой вызов команды project(); загрузка через команду include() недостаточно. Если такого вызова нет, CMake выведет предупреждение и предположит, что существует project(Project) вверху, чтобы включить языки по умолчанию (C и CXX).