Руководство по интеграции с IDE

• Введение
• Связывание
• Пресеты
• Настройка
• Компиляция
• Тестирование
• IDE с интеграцией CMake

Введение

Интегрированные среды разработки (IDE) могут захотеть интегрироваться с CMake для улучшения опыта разработки для пользователей CMake. Данный документ описывает рекомендуемые лучшие практики для такой интеграции.

Связывание

Многие поставщики IDE захотят связывать копию CMake со своей IDE. IDE, связывающие CMake, должны предоставить пользователю возможность использовать внешнюю установку CMake вместо встроенной, на случай, если встроенная копия устареет, и пользователь захочет использовать более новую версию.

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

В качестве предложения, IDE также могут поставлять копию системы сборки Ninja вместе с CMake. Ninja обладает высокой производительностью и хорошо поддерживается на всех платформах, поддерживающих CMake. IDE, связывающие Ninja, должны использовать Ninja 1.10 или более поздние версии, содержащие функции, необходимые для поддержки сборки Fortran.

Пресеты

CMake поддерживает формат файла CMakePresets.json, и его аналог для пользовательских настроек, CMakeUserPresets.json. Этот файл содержит информацию о различных пресетах конфигурации, которые может захотеть пользователь. Каждый пресет может иметь другой компилятор, флаги сборки и т. д. Подробности этого формата описаны в cmake(1) руководстве.

Поставщикам IDE рекомендуется читать и оценивать этот файл аналогично тому, как это делает CMake, и представлять пользователю пресеты, перечисленные в файле. Пользователи должны иметь возможность видеть (и, возможно, редактировать) переменные кэша CMake, переменные среды и параметры командной строки, определённые для данного пресета. Затем IDE должна сформировать список соответствующих cmake(1) аргументов командной строки на основе этих настроек, а не использовать параметр --preset= напрямую. Параметр --preset= предназначен только как удобный интерфейс для пользователей командной строки и не должен использоваться IDE.

Например, если пресет с именем ninja указывает Ninja в качестве генератора и ${sourceDir}/build в качестве каталога сборки, вместо запуска:

cmake -S /path/to/source --preset=ninja

IDE должна вместо этого рассчитать настройки пресета ninja и затем запустить:

cmake -S /path/to/source -B /path/to/source/build -G Ninja

В случаях, когда пресет содержит множество переменных кэша, и передача всех их как флагов -D приведет к превышению ограничения длины командной строки платформы, IDE должна вместо этого создать временный скрипт кэша и передать его с флагом -C.

Хотя чтение, разбор и оценка содержимого CMakePresets.json просты, это не тривиально. В дополнение к документации, поставщики IDE также могут обратиться к исходному коду CMake и тест-кейсам для лучшего понимания того, как реализовать этот формат. This file предоставляет удобочитаемую JSON-схему для формата CMakePresets.json, которая может быть полезна поставщикам IDE для проверки и предоставления помощи по редактированию.

Настройка

IDE, которые вызывают cmake(1) для выполнения шага конфигурации, могут захотеть получить информацию о создаваемых артефактах, а также о директориях включения, определениях компиляции и т. д., используемых для построения артефактов. Такую информацию можно получить, используя File API. В справочной странице по API файлов содержится дополнительная информация об API и о том, как его вызывать. Server mode был удален начиная с CMake 3.20 и не должен использоваться в CMake 3.14 или более поздних версиях.

IDE должны избегать создания дополнительных деревьев сборки, чем необходимо, и создавать несколько деревьев сборки только в том случае, если пользователь хочет переключиться на другой компилятор, использовать другие флаги компиляции и т. д. В частности, IDE НЕ должны создавать несколько деревьев сборки с одной конфигурацией, которые все имеют одинаковые свойства, за исключением отличающегося CMAKE_BUILD_TYPE, фактически создавая многоконфигурационную среду. Вместо этого следует использовать генератор Ninja Multi-Config в сочетании с File API для получения списка конфигураций сборки.

IDE не должны использовать «дополнительные генераторы» с генераторами Makefile или Ninja, которые генерируют файлы проектов IDE помимо файлов Makefile или Ninja. Вместо этого следует использовать File API для получения списка артефактов сборки.

Компиляция

Если для генерации дерева сборки используется генератор Makefile или Ninja, не рекомендуется вызывать make или ninja напрямую. Вместо этого рекомендуется, чтобы IDE вызывала cmake(1) с аргументом --build, что в свою очередь вызовет соответствующий инструмент сборки.

Если используется генератор проектов IDE, такой как Xcode или один из генераторов Visual Studio, и IDE понимает используемый формат проекта, IDE должна прочитать файл проекта и скомпилировать его таким же образом, как и в противном случае.

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

Тестирование

ctest(1) поддерживает вывод JSON-формата с информацией о доступных тестах и конфигурациях тестов. IDE, которые хотят запускать CTest, должны получить эту информацию и использовать ее для представления пользователю списка тестов.

IDE не должны вызывать цель test сгенерированной системы сборки. Вместо этого они должны вызывать ctest(1) напрямую.

IDE с интеграцией CMake

Следующие IDE поддерживают CMake напрямую:

• CLion
• KDevelop
• QtCreator
• Vim (через плагин)
• Visual Studio
• VSCode (через плагин)

Кроме того, CMake имеет встроенную поддержку некоторых IDE:

• Генераторы IDE-сред сборки: генерируют собственные системы сборки IDE, такие как Visual Studio или Xcode.
• Дополнительные генераторы: расширяют Генераторы инструментов сборки командной строки для генерации файлов проектов IDE, которые подключаются к системе сборки командной строки. Заменён на File API.