Rivalry2

HTML Diff

0 added 0 removed

Original 2026-01-01

Modified 2026-03-10

1 Теги: c++, cpp, cmake, cmake_source_dir, cmake_current_source_dir, int, tree, superproject, tests, superproject.so(dll), git submodule, otherproject, cplus

2 Проблема только одна - отсутствие каких бы то ни было стандартных систем сборки. Но нас спасут нестандартные! В данном случае великий и ужасныйCMake, в котором есть две переменные с не совсем очевидными отличиями.

3 - CMAKE_SOURCE_DIR- путь к директории исходников (директория, в которой расположен корневой файлCMakeLists.txt, с которого началась обработка);

4 - CMAKE_CURRENT_SOURCE_DIR- путь к текущей директории исходников (директория, в которой расположенCMakeLists.txt, который обрабатывается в данный момент).

5 <h3>Какую переменную лучше использовать для относительных путей в иерархии проекта?</h3>

6 Предположим, мы написали ещё один велосипед (но на этот раз превзошли всех предшественников в "велосипедостроении") и реализовали свой модуль суммирования переменных типаint. Структура проекта примерно такая:

7 | CMakeLists.txt | +---SuperProject | CMakeLists.txt | Summator.cpp | Summator.h | \---Tests CMakeLists.txt Summator_test.cppЕсли вы, как и подобает нормальному человеку, не сразу воспринимаете вывод командыtree. Поясню: в корне проекта находится файлCMakeLists.txtи две директории -SuperProject(реализация нашего велосипеда) иTests(так сказать, юнит-тесты). Думаю, теперь стало понятно, что где лежит.

8 С корневымCMakeLists.txtвсё очевидно: в нём только добавляем две поддиректории (если уж совсем занудствовать, то было бы неплохо добавить минимальную требуемую версиюCMakeв начало файла, но опустим это во имя простоты восприятия):

9 add_subdirectory(SuperProject) add_subdirectory(Tests)С файломCMakeLists.txtиз директорииSuperProjectтоже всё просто:

10 project(SuperProject) add_library(SuperProjectLib SHARED Summator.cpp)И, наконец, самый смак: директорияTestsи её файлCMakeLists.txt:

11 set(SOURCES ${CMAKE_SOURCE_DIR}/SuperProject/Summator.cpp Summator_test.cpp) include_directories(${CMAKE_SOURCE_DIR}) add_executable(Summator_test ${SOURCES} ${HEADERS})<h2>Заметили?</h2>

12 Мы используемCMAKE_SOURCE_DIR, чтобы собирать исходники проекта вместе с тестами. Обычно так делается для тестирования внутренних модулей продукта (иначе можно было бы просто прилинковать уже собранную библиотекуSuperProject.so(dll)).

13 Вроде, всё работает, проект собирается, тесты собираются (проходят или нет в данном случае неважно), можно на этом и остановиться. Но лучше подумать её разок. А в идеале попробовать использовать наш проект так, как могли бы его использовать другие члены сообщества.

14 Один из возможных вариантов использования - добавить наш репозиторий в свой в качествеgit submoduleи где-то в своём корневомCMakeLists.txtдобавить команду:

15 add_subdirectory(SuperProjectPackage)Иерархия проекта нашего благодарного пользователя будет выглядеть примерно так:

17 Правильно, указывать она будет на директориюOtherProject, потому что именно она теперь и является хранилищем корневого файлаCMakeLists.txt. А наш файлCMakeLists.txtкорневым быть перестал.

18 В итоге на этапеCMakeвозникнет ошибка при выполнении вот этой строчки:

19 ${CMAKE_SOURCE_DIR}/SuperProject/Summator.cppЧто вполне законно, ибо корневая директория проекта теперь не содержит директориюSuperProject.

20 <h2>Что же делать?</h2>

21 Если вы читали эту заметку с начала, вероятно, вы можете заподозрить, что помочь нам призвана переменнаяCMAKE_CURRENT_SOURCE_DIR. И данный вывод совершенно верен!

22 ПеременнаяCMAKE_CURRENT_SOURCE_DIRвсегда указывает на директорию с текущим файломCMakeFiles.txt, который в настоящий момент подвергается обработке. Использование этой переменной вместоCMAKE_SOURCE_DIRубережёт пользователей ваших супер-модулей от нервных расстройств, а вам даст дополнительный повод для гордости.

23 Ведь что может сравниться с ощущением того, что результаты твоей работы не пылятся на жёстком диске, а приносят пользу человечеству?

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

25 <h2>Правильное решение</h2>

26 В файлеTests/CMakeLists.txtследовало написать:

27 project(Tests) set(SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/../SuperProject/Summator.cpp Summator_test.cpp) include_directories(${CMAKE_CURRENT_SOURCE_DIR}/../.) add_executable(Summator_test ${SOURCES} ${HEADERS})Есть вопрос? Напишите в комментариях!