Сборка с помощью CMake

Пресеты CMake (справка)

В репозитории используются пресеты CMake: схема version 6, cmakeMinimumRequired 3.26 (см. CMakePresets.json в корне).

Типичная цепочка конфигурация → сборка → тесты (Debug):

cmake --preset=dev
cmake --build --preset=dev -j"$(nproc)"
ctest --preset=dev

Release с тестами только из закоммиченных пресетов (как в CI, без CMakeUserPresets.json):

cmake --preset=release-ci
cmake --build --preset=release-ci -j"$(nproc)"
ctest --preset=release-ci

Список доступных пресетов: cmake --list-presets.

Сводка по трем репозиториям: переключатели режима разработчика и примеров отличаются только именами переменных кэша CMake (их выставляет скрытый набор dev-mode, от которого наследуются dev и многие CI-пресеты):

CMake: новые исходники и

Код собирается в библиотеки рядом с файлами; родительские каталоги подключают дочерние через add_subdirectory.

1. Каталог — размещайте файлы под src/ (и публичные заголовки под include/…, если API экспортируется).
2. Регистрация — в родительском CMakeLists.txt добавьте add_subdirectory(<подкаталог>), если создали новую папку.

3. Листовой CMakeLists.txt — типичный каркас внутренней статической библиотеки:

   add_library(myLeaf STATIC MyLeaf.cpp)
   target_include_directories(myLeaf PUBLIC
     $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/src>
   )
   target_link_libraries(myLeaf PUBLIC …)  # нужные уже существующие цели
   add_folders(MyLeaf)  # группировка в IDE (cmake/folders.cmake)

4. Связь наверх — исполняемый файл или «большая» библиотека, использующая ваш код, должны указать myLeaf в target_link_libraries.
5. Переконфигурация — после любого изменения CMakeLists.txt снова запустите CMake (cmake --preset=dev или эквивалент).

Особенности по репозиториям

• Generator: много мелких статических библиотек в src/generators/simple/<имя>/CMakeLists.txt; образец — src/generators/simple/simple/CMakeLists.txt. Родитель src/generators/simple/CMakeLists.txt вызывает цепочку add_subdirectory.
• Graph: основная цель CircuitGenGraph задается в src/CMakeLists.txt списками SOURCES, LIBS и заголовками в include/CircuitGenGraph/ (PUBLIC_HEADER и правила установки). Новые .cpp и заголовки добавляйте туда при расширении библиотеки.
• Parameters: основная библиотека и CLI OpenLane в src/CMakeLists.txt (SOURCES для CircuitGenParameters, цель CircuitGenParameters_exe с именем исполняемого файла CircuitGenParameters — как у CircuitGenGenerator_exe / CircuitGenGenerator; точка входа CircuitGenToOpenLane.cpp; алиасы OptimizationsVerilogLib::…). Подкаталог examples/ включается при -D optimizationsveriloglib_BUILD_EXAMPLES=ON на верхнем уровне; новые модули — через расширение SOURCES или отдельный add_library по аналогии с соседними целями.

Базовые сценарии:

# Простая локальная Debug-сборка
bash scripts/dev/build-debug.sh

# Debug-сборка с тестами
cmake --preset=dev
cmake --build --preset=dev
ctest --preset=dev

# Локальное покрытие
bash scripts/dev/coverage.sh

# Релизная сборка (без тестов)
bash scripts/release/build.sh

# Релизная сборка для CI (с тестами)
bash scripts/release/test.sh

# Сборка с примерами (Debug через пресет dev, Release — release-examples)
bash scripts/dev/build-examples.sh
bash scripts/release/build-examples.sh

# Установка release-артефактов
bash scripts/release/install.sh

Примеры (examples)

Каталог examples/ подключается к сборке только при CircuitGenGenerator_BUILD_EXAMPLES=ON. В пресете dev (см. CMakeUserPresets.json.example) и в ci-examples-dev из CMakePresets.json это уже включено через dev-mode. Для Release примеры по умолчанию выключены; используйте пресет release-examples или передайте -D CircuitGenGenerator_BUILD_EXAMPLES=ON при конфигурации.

Цель run-examples собирает все исполняемые примеры и последовательно их запускает (см. examples/CMakeLists.txt).

Локально — как dev (Debug, пресет dev):

cp CMakeUserPresets.json.example CMakeUserPresets.json   # один раз после клонирования
bash scripts/dev/build-examples.sh

Эквивалентно: bash scripts/dev/build-debug.sh, затем cmake --build build/dev --target run-examples.

Локально — как Release с примерами:

bash scripts/release/build-examples.sh

Эквивалентно вручную:

cmake --preset=release-examples
cmake --build --preset=release-examples -j "$(nproc)"
cmake --build --preset=release-examples --target run-examples -j "$(nproc)"

Без скриптов (только пресеты из CMakePresets.json):

# Debug + examples (аналог dev, удобно в CI и без CMakeUserPresets)
cmake --preset=ci-examples-dev
cmake --build --preset=ci-examples-dev -j "$(nproc)"
cmake --build --preset=ci-examples-dev --target run-examples -j "$(nproc)"

# Release + examples
cmake --preset=release-examples
cmake --build --preset=release-examples -j "$(nproc)"
cmake --build --preset=release-examples --target run-examples -j "$(nproc)"

JSON-файлы в examples/json/ — входные данные для CircuitGenGenerator::runGenerationFromJson. Среди C++-примеров: empty_example (дымовой тест), example_print_version, запуск по JSON — example_run_comparison_json, example_run_truth_table_json, example_run_parity_json (общий исходник example_run_preset_json.cpp, путь к JSON задается на этапе конфигурации CMake через add_json_example), а также example_run_json_for_graph (runGenerationFromJsonForGraph, add_for_graph_example). См. examples/CMakeLists.txt.

Сборка с MSVC

Обратите внимание, что MSVC по умолчанию не включает часть строгих диагностик. В проекте предусмотрен пресет dev-msvc в CMakeUserPresets.json, который наследует flags-msvc из CMakePresets.json:

cmake --preset=dev-msvc
cmake --build build/dev-msvc
ctest --test-dir build/dev-msvc --output-on-failure --no-tests=error

Сборка на Apple Silicon

CMake правильно поддерживает сборку на Apple Silicon, начиная с версии 3.20.1. Убедитесь, что у вас установлена последняя версия.

Пакет CMake

Этот проект экспортирует пакет CMake для использования с CMake командой find_package:

• Package name: CircuitGenGenerator
• Target name: CircuitGenGenerator::CircuitGenGenerator

Пример подгрузки библиотеки:

FetchContent_Declare(
  CircuitGen_Generator
  GIT_REPOSITORY https://github.com/vvzunin/CircuitGen_Generator
  GIT_TAG v1.0.0-alpha
)
FetchContent_MakeAvailable(CircuitGen_Generator)

Пример добавления библиотеки в проект:

target_link_libraries(
    app PRIVATE
    CircuitGenGenerator::CircuitGenGenerator
)

Дальнейшее использование

После подключения библиотеки для использования доступны три различные функции. Для их использования требуется подключить хедер CircuitGenGenerator.hpp

#include <CircuitGenGenerator/CircuitGenGenerator.hpp>

Note to packagers

Для CMAKE_INSTALL_INCLUDEDIR задан путь, отличный от просто include, если проект настроен как проект верхнего уровня, чтобы избежать косвенного включения других библиотек при установке с общим префиксом. Просмотрите файл install-rules.cmake для получения полного набора правил установки.

English: Building with CMake