CMake: Move lagom target creation helper functions into Meta/CMake

This commit is contained in:
ayeteadoe 2025-06-30 08:02:59 -07:00 committed by Jelle Raaijmakers
commit 100b204a68
Notes: github-actions[bot] 2025-07-03 21:21:35 +00:00
2 changed files with 147 additions and 146 deletions

146
Meta/CMake/targets.cmake Normal file
View file

@ -0,0 +1,146 @@
function(lagom_generate_export_header name fs_name)
# Temporary helper to allow libraries to opt-in to using X_API macros
# to export symbols required by external consumers. This allows the codebase
# to gradually slowly migrate instead of an all-or-nothing approach.
if (NOT WIN32)
target_compile_options(${name} PRIVATE -fvisibility=hidden)
else()
set_target_properties(${name} PROPERTIES WINDOWS_EXPORT_ALL_SYMBOLS OFF)
endif()
include(GenerateExportHeader)
string(TOUPPER ${fs_name} fs_name_upper)
generate_export_header(${name} EXPORT_MACRO_NAME ${fs_name_upper}_API EXPORT_FILE_NAME "Export.h")
endfunction()
function(lagom_lib target_name fs_name)
cmake_parse_arguments(LAGOM_LIBRARY "EXPLICIT_SYMBOL_EXPORT" "LIBRARY_TYPE" "SOURCES;LIBS" ${ARGN})
string(REPLACE "Lib" "" library ${target_name})
if (NOT LAGOM_LIBRARY_LIBRARY_TYPE)
set(LAGOM_LIBRARY_LIBRARY_TYPE "")
endif()
add_library(${target_name} ${LAGOM_LIBRARY_LIBRARY_TYPE} ${LAGOM_LIBRARY_SOURCES})
set_target_properties(
${target_name} PROPERTIES
VERSION "${PROJECT_VERSION}"
SOVERSION "${PROJECT_VERSION_MAJOR}"
EXPORT_NAME ${library}
OUTPUT_NAME lagom-${fs_name}
)
target_link_libraries(${target_name} PRIVATE ${LAGOM_LIBRARY_LIBS})
target_link_libraries(${target_name} PUBLIC GenericClangPlugin)
if (NOT "${target_name}" STREQUAL "AK")
target_link_libraries(${target_name} PRIVATE AK)
endif()
if (WIN32)
target_include_directories(${target_name} PRIVATE ${PTHREAD_INCLUDE_DIR})
target_link_libraries(${target_name} PRIVATE ${PTHREAD_LIBRARY})
target_include_directories(${target_name} PRIVATE ${MMAN_INCLUDE_DIR})
target_link_libraries(${target_name} PRIVATE ${MMAN_LIBRARY})
endif()
# FIXME: Clean these up so that we don't need so many include dirs
if (ENABLE_INSTALL_HEADERS)
target_include_directories(${target_name} INTERFACE
$<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}/Services>
$<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}/Libraries>
$<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}/Services>
)
endif()
add_lagom_library_install_rules(${target_name} ALIAS_NAME ${library})
if (ENABLE_INSTALL_HEADERS)
install(
DIRECTORY "${SERENITY_PROJECT_ROOT}/Libraries/Lib${library}"
COMPONENT Lagom_Development
DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
FILES_MATCHING PATTERN "*.h"
)
endif()
serenity_generated_sources(${target_name})
if (LAGOM_LIBRARY_EXPLICIT_SYMBOL_EXPORT)
lagom_generate_export_header(${target_name} ${fs_name})
endif()
endfunction()
function(lagom_test source)
cmake_parse_arguments(PARSE_ARGV 1 LAGOM_TEST "" "CUSTOM_MAIN;NAME;WORKING_DIRECTORY" "LIBS")
if (NOT LAGOM_TEST_NAME)
get_filename_component(LAGOM_TEST_NAME ${source} NAME_WE)
endif()
if (NOT LAGOM_TEST_CUSTOM_MAIN)
set(LAGOM_TEST_CUSTOM_MAIN "$<TARGET_OBJECTS:LibTestMain>")
endif()
add_executable(${LAGOM_TEST_NAME} ${source})
target_link_libraries(${LAGOM_TEST_NAME} PRIVATE AK LibCore LibFileSystem LibTest ${LAGOM_TEST_CUSTOM_MAIN} ${LAGOM_TEST_LIBS})
if (WIN32)
target_include_directories(${LAGOM_TEST_NAME} PRIVATE ${PTHREAD_INCLUDE_DIR})
target_link_libraries(${LAGOM_TEST_NAME} PRIVATE ${PTHREAD_LIBRARY})
target_include_directories(${LAGOM_TEST_NAME} PRIVATE ${MMAN_INCLUDE_DIR})
target_link_libraries(${LAGOM_TEST_NAME} PRIVATE ${MMAN_LIBRARY})
endif()
add_test(
NAME ${LAGOM_TEST_NAME}
COMMAND ${LAGOM_TEST_NAME}
WORKING_DIRECTORY ${LAGOM_TEST_WORKING_DIRECTORY}
)
endfunction()
function(lagom_utility name)
cmake_parse_arguments(LAGOM_UTILITY "" "" "SOURCES;LIBS" ${ARGN})
add_executable("${name}" ${LAGOM_UTILITY_SOURCES})
target_link_libraries("${name}" PRIVATE AK LibCore ${LAGOM_UTILITY_LIBS})
endfunction()
function(serenity_test test_src sub_dir)
cmake_parse_arguments(PARSE_ARGV 2 SERENITY_TEST "" "CUSTOM_MAIN;NAME" "LIBS")
lagom_test(${test_src}
LIBS ${SERENITY_TEST_LIBS}
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
NAME ${SERENITY_TEST_NAME}
CUSTOM_MAIN ${SERENITY_TEST_CUSTOM_MAIN}
)
endfunction()
function(serenity_bin name)
add_executable(${name} ${SOURCES} ${GENERATED_SOURCES})
add_executable(Lagom::${name} ALIAS ${name})
target_link_libraries(${name} PUBLIC GenericClangPlugin)
install(
TARGETS ${target_name}
EXPORT LagomTargets
RUNTIME #
COMPONENT Lagom_Runtime
LIBRARY #
COMPONENT Lagom_Runtime
NAMELINK_COMPONENT Lagom_Development
ARCHIVE #
COMPONENT Lagom_Development
INCLUDES #
DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
)
serenity_generated_sources(${name})
endfunction()
function(serenity_lib name fs_name)
cmake_parse_arguments(PARSE_ARGV 2 SERENITY_LIB "EXPLICIT_SYMBOL_EXPORT" "TYPE" "")
set(EXPLICIT_SYMBOL_EXPORT "")
if (SERENITY_LIB_EXPLICIT_SYMBOL_EXPORT)
set(EXPLICIT_SYMBOL_EXPORT "EXPLICIT_SYMBOL_EXPORT")
endif()
lagom_lib(${name} ${fs_name} LIBRARY_TYPE ${SERENITY_LIB_TYPE} ${EXPLICIT_SYMBOL_EXPORT} SOURCES ${SOURCES} ${GENERATED_SOURCES})
endfunction()
macro(add_serenity_subdirectory path)
add_subdirectory("${SERENITY_PROJECT_ROOT}/${path}" "${CMAKE_CURRENT_BINARY_DIR}/${path}")
endmacro()
if (NOT TARGET all_generated)
# Meta target to run all code-gen steps in the build.
add_custom_target(all_generated)
endif()

View file

@ -178,152 +178,7 @@ if (WIN32)
find_package(mman REQUIRED)
endif()
function(lagom_generate_export_header name fs_name)
# Temporary helper to allow libraries to opt-in to using X_API macros
# to export symbols required by external consumers. This allows the codebase
# to gradually slowly migrate instead of an all-or-nothing approach.
if (NOT WIN32)
target_compile_options(${name} PRIVATE -fvisibility=hidden)
else()
set_target_properties(${name} PROPERTIES WINDOWS_EXPORT_ALL_SYMBOLS OFF)
endif()
include(GenerateExportHeader)
string(TOUPPER ${fs_name} fs_name_upper)
generate_export_header(${name} EXPORT_MACRO_NAME ${fs_name_upper}_API EXPORT_FILE_NAME "Export.h")
endfunction()
function(lagom_lib target_name fs_name)
cmake_parse_arguments(LAGOM_LIBRARY "EXPLICIT_SYMBOL_EXPORT" "LIBRARY_TYPE" "SOURCES;LIBS" ${ARGN})
string(REPLACE "Lib" "" library ${target_name})
if (NOT LAGOM_LIBRARY_LIBRARY_TYPE)
set(LAGOM_LIBRARY_LIBRARY_TYPE "")
endif()
add_library(${target_name} ${LAGOM_LIBRARY_LIBRARY_TYPE} ${LAGOM_LIBRARY_SOURCES})
set_target_properties(
${target_name} PROPERTIES
VERSION "${PROJECT_VERSION}"
SOVERSION "${PROJECT_VERSION_MAJOR}"
EXPORT_NAME ${library}
OUTPUT_NAME lagom-${fs_name}
)
target_link_libraries(${target_name} PRIVATE ${LAGOM_LIBRARY_LIBS})
target_link_libraries(${target_name} PUBLIC GenericClangPlugin)
if (NOT "${target_name}" STREQUAL "AK")
target_link_libraries(${target_name} PRIVATE AK)
endif()
if (WIN32)
target_include_directories(${target_name} PRIVATE ${PTHREAD_INCLUDE_DIR})
target_link_libraries(${target_name} PRIVATE ${PTHREAD_LIBRARY})
target_include_directories(${target_name} PRIVATE ${MMAN_INCLUDE_DIR})
target_link_libraries(${target_name} PRIVATE ${MMAN_LIBRARY})
endif()
# FIXME: Clean these up so that we don't need so many include dirs
if (ENABLE_INSTALL_HEADERS)
target_include_directories(${target_name} INTERFACE
$<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}/Services>
$<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}/Libraries>
$<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}/Services>
)
endif()
add_lagom_library_install_rules(${target_name} ALIAS_NAME ${library})
if (ENABLE_INSTALL_HEADERS)
install(
DIRECTORY "${SERENITY_PROJECT_ROOT}/Libraries/Lib${library}"
COMPONENT Lagom_Development
DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
FILES_MATCHING PATTERN "*.h"
)
endif()
serenity_generated_sources(${target_name})
if (LAGOM_LIBRARY_EXPLICIT_SYMBOL_EXPORT)
lagom_generate_export_header(${target_name} ${fs_name})
endif()
endfunction()
function(lagom_test source)
cmake_parse_arguments(PARSE_ARGV 1 LAGOM_TEST "" "CUSTOM_MAIN;NAME;WORKING_DIRECTORY" "LIBS")
if (NOT LAGOM_TEST_NAME)
get_filename_component(LAGOM_TEST_NAME ${source} NAME_WE)
endif()
if (NOT LAGOM_TEST_CUSTOM_MAIN)
set(LAGOM_TEST_CUSTOM_MAIN "$<TARGET_OBJECTS:LibTestMain>")
endif()
add_executable(${LAGOM_TEST_NAME} ${source})
target_link_libraries(${LAGOM_TEST_NAME} PRIVATE AK LibCore LibFileSystem LibTest ${LAGOM_TEST_CUSTOM_MAIN} ${LAGOM_TEST_LIBS})
if (WIN32)
target_include_directories(${LAGOM_TEST_NAME} PRIVATE ${PTHREAD_INCLUDE_DIR})
target_link_libraries(${LAGOM_TEST_NAME} PRIVATE ${PTHREAD_LIBRARY})
target_include_directories(${LAGOM_TEST_NAME} PRIVATE ${MMAN_INCLUDE_DIR})
target_link_libraries(${LAGOM_TEST_NAME} PRIVATE ${MMAN_LIBRARY})
endif()
add_test(
NAME ${LAGOM_TEST_NAME}
COMMAND ${LAGOM_TEST_NAME}
WORKING_DIRECTORY ${LAGOM_TEST_WORKING_DIRECTORY}
)
endfunction()
function(lagom_utility name)
cmake_parse_arguments(LAGOM_UTILITY "" "" "SOURCES;LIBS" ${ARGN})
add_executable("${name}" ${LAGOM_UTILITY_SOURCES})
target_link_libraries("${name}" PRIVATE AK LibCore ${LAGOM_UTILITY_LIBS})
endfunction()
function(serenity_test test_src sub_dir)
cmake_parse_arguments(PARSE_ARGV 2 SERENITY_TEST "" "CUSTOM_MAIN;NAME" "LIBS")
lagom_test(${test_src}
LIBS ${SERENITY_TEST_LIBS}
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
NAME ${SERENITY_TEST_NAME}
CUSTOM_MAIN ${SERENITY_TEST_CUSTOM_MAIN}
)
endfunction()
function(serenity_bin name)
add_executable(${name} ${SOURCES} ${GENERATED_SOURCES})
add_executable(Lagom::${name} ALIAS ${name})
target_link_libraries(${name} PUBLIC GenericClangPlugin)
install(
TARGETS ${target_name}
EXPORT LagomTargets
RUNTIME #
COMPONENT Lagom_Runtime
LIBRARY #
COMPONENT Lagom_Runtime
NAMELINK_COMPONENT Lagom_Development
ARCHIVE #
COMPONENT Lagom_Development
INCLUDES #
DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
)
serenity_generated_sources(${name})
endfunction()
function(serenity_lib name fs_name)
cmake_parse_arguments(PARSE_ARGV 2 SERENITY_LIB "EXPLICIT_SYMBOL_EXPORT" "TYPE" "")
set(EXPLICIT_SYMBOL_EXPORT "")
if (SERENITY_LIB_EXPLICIT_SYMBOL_EXPORT)
set(EXPLICIT_SYMBOL_EXPORT "EXPLICIT_SYMBOL_EXPORT")
endif()
lagom_lib(${name} ${fs_name} LIBRARY_TYPE ${SERENITY_LIB_TYPE} ${EXPLICIT_SYMBOL_EXPORT} SOURCES ${SOURCES} ${GENERATED_SOURCES})
endfunction()
macro(add_serenity_subdirectory path)
add_subdirectory("${SERENITY_PROJECT_ROOT}/${path}" "${CMAKE_CURRENT_BINARY_DIR}/${path}")
endmacro()
if (NOT TARGET all_generated)
# Meta target to run all code-gen steps in the build.
add_custom_target(all_generated)
endif()
include(targets)
# Plugins need to be installed in order to be used by non-lagom builds
add_lagom_library_install_rules(GenericClangPlugin)