mirrors/serenity
1
0
Fork 0
mirror of https://github.com/SerenityOS/serenity.git synced 2025-01-22 09:21:57 -05:00
Code Issues Projects Releases Packages Wiki Activity
serenity/Meta/CMake/utils.cmake
Andrew Kaster e1e44a820d CMake: Enable policy CMP0177 for normalization of install() DESTINATIONs 
This removes a few dozen warnings with CMake 3.31+
2024-12-30 12:56:52 +01:00

324 lines
14 KiB
CMake
Raw Permalink Blame History

include(${CMAKE_CURRENT_LIST_DIR}/serenity_components.cmake)
include(${CMAKE_CURRENT_LIST_DIR}/code_generators.cmake)
find_package(Python3 COMPONENTS Interpreter REQUIRED)
include(GNUInstallDirs)
function(serenity_set_implicit_links target_name)
# Make sure that CMake is aware of the implicit LibC dependency, and ensure
# that we are choosing the correct and updated LibC.
# The latter is a problem with Clang especially, since we might have the
# slightly outdated stub in the sysroot, but have not yet installed the freshly
# built LibC.
target_link_libraries(${target_name} PRIVATE LibC)
endfunction()
function(serenity_install_headers target_name)
file(GLOB_RECURSE headers RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} "*.h")
foreach(header ${headers})
get_filename_component(subdirectory ${header} DIRECTORY)
install(FILES ${header} DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}/${target_name}/${subdirectory}" OPTIONAL)
endforeach()
endfunction()
function(serenity_install_sources)
cmake_path(RELATIVE_PATH CMAKE_CURRENT_SOURCE_DIR BASE_DIRECTORY ${SerenityOS_SOURCE_DIR} OUTPUT_VARIABLE current_source_dir_relative)
file(GLOB_RECURSE sources RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} "*.h" "*.cpp" "*.gml")
foreach(source ${sources})
get_filename_component(subdirectory ${source} DIRECTORY)
install(FILES ${source} DESTINATION usr/src/serenity/${current_source_dir_relative}/${subdirectory} OPTIONAL)
endforeach()
endfunction()
function(serenity_generated_sources target_name)
if(DEFINED GENERATED_SOURCES)
set_source_files_properties(${GENERATED_SOURCES} PROPERTIES GENERATED 1)
foreach(generated ${GENERATED_SOURCES})
get_filename_component(generated_name ${generated} NAME)
add_dependencies(${target_name} generate_${generated_name})
add_dependencies(all_generated generate_${generated_name})
endforeach()
endif()
endfunction()
if (NOT COMMAND serenity_lib)
function(serenity_lib target_name fs_name)
cmake_parse_arguments(PARSE_ARGV 2 SERENITY_LIB "" "TYPE" "")
if ("${SERENITY_LIB_TYPE}" STREQUAL "")
set(SERENITY_LIB_TYPE SHARED)
endif()
serenity_install_headers(${target_name})
serenity_install_sources()
add_library(${target_name} ${SERENITY_LIB_TYPE} ${SOURCES} ${GENERATED_SOURCES})
set_target_properties(${target_name} PROPERTIES EXCLUDE_FROM_ALL TRUE)
set_target_properties(${target_name} PROPERTIES VERSION "serenity")
target_link_libraries(${target_name} PUBLIC GenericClangPlugin)
install(TARGETS ${target_name} DESTINATION ${CMAKE_INSTALL_LIBDIR} OPTIONAL)
set_target_properties(${target_name} PROPERTIES OUTPUT_NAME ${fs_name})
serenity_generated_sources(${target_name})
serenity_set_implicit_links(${target_name})
endfunction()
endif()
function(serenity_libc target_name fs_name)
serenity_install_headers("")
serenity_install_sources()
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -nostdlib -fpic -ftls-model=initial-exec")
add_library(${target_name} SHARED ${SOURCES})
install(TARGETS ${target_name} DESTINATION ${CMAKE_INSTALL_LIBDIR})
set_target_properties(${target_name} PROPERTIES OUTPUT_NAME ${fs_name})
# Avoid creating a dependency cycle between system libraries and the C++ standard library. This is necessary
# to ensure that initialization functions will be called in the right order (libc++ must come after LibPthread).
target_link_options(${target_name} PRIVATE -static-libstdc++)
if (CMAKE_CXX_COMPILER_ID MATCHES "Clang$" AND ENABLE_USERSPACE_COVERAGE_COLLECTION)
target_link_libraries(${target_name} PRIVATE clang_rt.profile)
endif()
target_link_directories(LibC PUBLIC ${CMAKE_CURRENT_BINARY_DIR})
serenity_generated_sources(${target_name})
endfunction()
if (NOT COMMAND serenity_add_executable)
function(serenity_add_executable name)
# if any of the sources are .jakt files, switch to using serenity_jakt_executable()
# and pass the non-jakt sources as extra cpp sources.
set(jakt_source)
set(cpp_sources)
foreach(source ${ARGN})
if (${source} MATCHES "\\.jakt$")
if (jakt_source)
message(FATAL_ERROR "Multiple main jakt files in executable ${name}")
else()
set(jakt_source ${source})
endif()
else()
list(APPEND cpp_sources ${source})
endif()
endforeach()
if (jakt_source)
if (ENABLE_JAKT)
serenity_jakt_executable(${name} MAIN_SOURCE ${jakt_source} CPP_SOURCES ${cpp_sources})
else()
message(STATUS "Skipping ${name} because jakt is disabled")
# Make an empty c++ file:
file(WRITE "${CMAKE_CURRENT_BINARY_DIR}/${name}.cpp" "// This file was generated by CMake to skip a jakt executable\n")
add_executable(${name} "${CMAKE_CURRENT_BINARY_DIR}/${name}.cpp")
set_target_properties(${name} PROPERTIES SERENITY_SKIP_BUILD TRUE)
endif()
else()
add_executable(${name} ${cpp_sources})
endif()
endfunction()
endif()
if (NOT COMMAND serenity_bin)
function(serenity_bin target_name)
serenity_install_sources()
serenity_add_executable(${target_name} ${SOURCES})
target_link_libraries(${target_name} PUBLIC GenericClangPlugin)
set_target_properties(${target_name} PROPERTIES EXCLUDE_FROM_ALL TRUE)
install(TARGETS ${target_name} RUNTIME DESTINATION bin OPTIONAL)
serenity_generated_sources(${target_name})
serenity_set_implicit_links(${target_name})
endfunction()
endif()
if (NOT COMMAND serenity_test)
function(serenity_test test_src sub_dir)
cmake_parse_arguments(PARSE_ARGV 2 SERENITY_TEST "MAIN_ALREADY_DEFINED" "CUSTOM_MAIN" "LIBS")
set(TEST_SOURCES ${test_src})
if ("${SERENITY_TEST_CUSTOM_MAIN}" STREQUAL "")
set(SERENITY_TEST_CUSTOM_MAIN "$<TARGET_OBJECTS:LibTestMain>")
endif()
if (NOT ${SERENITY_TEST_MAIN_ALREADY_DEFINED})
list(PREPEND TEST_SOURCES "${SERENITY_TEST_CUSTOM_MAIN}")
endif()
get_filename_component(test_name ${test_src} NAME_WE)
add_executable(${test_name} ${TEST_SOURCES})
add_dependencies(ComponentTests ${test_name})
set_target_properties(${test_name} PROPERTIES EXCLUDE_FROM_ALL TRUE)
serenity_set_implicit_links(${test_name})
target_link_libraries(${test_name} PRIVATE LibTest LibCore LibFileSystem)
foreach(lib ${SERENITY_TEST_LIBS})
target_link_libraries(${test_name} PRIVATE ${lib})
endforeach()
install(TARGETS ${test_name} RUNTIME DESTINATION usr/Tests/${sub_dir} OPTIONAL)
endfunction()
endif()
function(serenity_testjs_test test_src sub_dir)
cmake_parse_arguments(PARSE_ARGV 2 SERENITY_TEST "" "CUSTOM_MAIN" "LIBS")
if ("${SERENITY_TEST_CUSTOM_MAIN}" STREQUAL "")
set(SERENITY_TEST_CUSTOM_MAIN "$<TARGET_OBJECTS:JavaScriptTestRunnerMain>")
endif()
list(APPEND SERENITY_TEST_LIBS LibJS LibCore LibFileSystem)
serenity_test(${test_src} ${sub_dir}
CUSTOM_MAIN "${SERENITY_TEST_CUSTOM_MAIN}"
LIBS ${SERENITY_TEST_LIBS})
endfunction()
function(serenity_app target_name)
cmake_parse_arguments(PARSE_ARGV 1 SERENITY_APP "" "ICON" "")
set(small_icon "${SerenityOS_SOURCE_DIR}/Base/res/icons/16x16/${SERENITY_APP_ICON}.png")
set(medium_icon "${SerenityOS_SOURCE_DIR}/Base/res/icons/32x32/${SERENITY_APP_ICON}.png")
serenity_bin("${target_name}")
if (EXISTS "${small_icon}")
embed_resource("${target_name}" serenity_icon_s "${small_icon}")
else()
message(FATAL_ERROR "Missing small app icon: ${small_icon}")
endif()
if (EXISTS "${medium_icon}")
embed_resource("${target_name}" serenity_icon_m "${medium_icon}")
else()
# These icons are designed small only for use in applets, and thus are exempt.
list(APPEND allowed_missing_medium_icons "audio-volume-high")
list(APPEND allowed_missing_medium_icons "edit-copy")
if (NOT ${SERENITY_APP_ICON} IN_LIST allowed_missing_medium_icons)
message(FATAL_ERROR "Missing medium app icon: ${medium_icon}")
endif()
endif()
endfunction()
function(embed_resource target section file)
get_filename_component(asm_file "${file}" NAME)
set(asm_file "${CMAKE_CURRENT_BINARY_DIR}/${target}-${section}.s")
get_filename_component(input_file "${file}" ABSOLUTE)
file(SIZE "${input_file}" file_size)
add_custom_command(
OUTPUT "${asm_file}"
COMMAND "${SerenityOS_SOURCE_DIR}/Meta/generate-embedded-resource-assembly.sh" "${asm_file}" "${section}" "${input_file}" "${file_size}"
DEPENDS "${input_file}" "${SerenityOS_SOURCE_DIR}/Meta/generate-embedded-resource-assembly.sh"
COMMENT "Generating ${asm_file}"
)
add_library(
${target}-resources-${section}
OBJECT
"${asm_file}"
)
target_link_libraries(
${target} PRIVATE
-Wl,--whole-archive
${target}-resources-${section}
-Wl,--no-whole-archive
)
endfunction()
function(invoke_generator name generator primary_source header implementation)
cmake_parse_arguments(invoke_generator "" "" "arguments;dependencies" ${ARGN})
add_custom_command(
OUTPUT "${header}" "${implementation}"
COMMAND $<TARGET_FILE:${generator}> -h "${header}.tmp" -c "${implementation}.tmp" ${invoke_generator_arguments}
COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${header}.tmp" "${header}"
COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${implementation}.tmp" "${implementation}"
COMMAND "${CMAKE_COMMAND}" -E remove "${header}.tmp" "${implementation}.tmp"
VERBATIM
DEPENDS ${generator} ${invoke_generator_dependencies} "${primary_source}"
)
add_custom_target("generate_${name}" DEPENDS "${header}" "${implementation}")
add_dependencies(all_generated "generate_${name}")
list(APPEND CURRENT_LIB_GENERATED "${name}")
set(CURRENT_LIB_GENERATED ${CURRENT_LIB_GENERATED} PARENT_SCOPE)
endfunction()
function(invoke_idl_generator cpp_name idl_name generator primary_source header implementation idl)
cmake_parse_arguments(invoke_idl_generator "" "" "arguments;dependencies" ${ARGN})
add_custom_command(
OUTPUT "${header}" "${implementation}" "${idl}"
COMMAND $<TARGET_FILE:${generator}> -h "${header}.tmp" -c "${implementation}.tmp" -i "${idl}.tmp" ${invoke_idl_generator_arguments}
COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${header}.tmp" "${header}"
COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${implementation}.tmp" "${implementation}"
COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${idl}.tmp" "${idl}"
COMMAND "${CMAKE_COMMAND}" -E remove "${header}.tmp" "${implementation}.tmp" "${idl}.tmp"
VERBATIM
DEPENDS ${generator} ${invoke_idl_generator_dependencies} "${primary_source}"
)
add_custom_target("generate_${cpp_name}" DEPENDS "${header}" "${implementation}" "${idl}")
add_custom_target("generate_${idl_name}" DEPENDS "generate_${cpp_name}")
add_dependencies(all_generated "generate_${cpp_name}")
add_dependencies(all_generated "generate_${idl_name}")
list(APPEND CURRENT_LIB_GENERATED "${name}")
set(CURRENT_LIB_GENERATED ${CURRENT_LIB_GENERATED} PARENT_SCOPE)
endfunction()
function(download_file_multisource urls path)
cmake_parse_arguments(DOWNLOAD "" "SHA256;VERSION;VERSION_FILE;CACHE_PATH" "" ${ARGN})
if (NOT ENABLE_NETWORK_DOWNLOADS AND NOT EXISTS "${path}")
message(FATAL_ERROR "${path} does not exist, and unable to download it")
endif()
if (EXISTS "${path}" AND "${DOWNLOAD_VERSION}" STREQUAL "")
return() # Assume the current version is up-to-date.
endif()
foreach(url ${urls})
set(DOWNLOAD_COMMAND "${Python3_EXECUTABLE}" "${SerenityOS_SOURCE_DIR}/Meta/download_file.py" "-o" "${path}" "${url}")
if (NOT "${DOWNLOAD_SHA256}" STREQUAL "")
list(APPEND DOWNLOAD_COMMAND "-s" "${DOWNLOAD_SHA256}")
endif()
if (NOT "${DOWNLOAD_VERSION}" STREQUAL "")
list(APPEND DOWNLOAD_COMMAND "-v" "${DOWNLOAD_VERSION}")
list(APPEND DOWNLOAD_COMMAND "-f" "${DOWNLOAD_VERSION_FILE}")
endif()
if (NOT "${DOWNLOAD_CACHE_PATH}" STREQUAL "")
list(APPEND DOWNLOAD_COMMAND "-c" "${DOWNLOAD_CACHE_PATH}")
endif()
execute_process(COMMAND ${DOWNLOAD_COMMAND} RESULT_VARIABLE status_code)
if(status_code EQUAL 0)
return()
endif()
message(WARNING "Failed to download ${path} from ${url}")
endforeach()
message(FATAL_ERROR "Failed to download ${path} from any source")
endfunction()
function(download_file url path)
cmake_parse_arguments(DOWNLOAD "" "SHA256;VERSION;VERSION_FILE;CACHE_PATH" "" ${ARGN})
# If the timestamp doesn't match exactly, the Web Archive should redirect to the closest archived file automatically.
download_file_multisource("${url};https://web.archive.org/web/99991231235959/${url}" "${path}" SHA256 "${DOWNLOAD_SHA256}" VERSION "${DOWNLOAD_VERSION}" VERSION_FILE "${DOWNLOAD_VERSION_FILE}" CACHE_PATH "${DOWNLOAD_CACHE_PATH}")
endfunction()
function(extract_path dest_dir zip_path source_path dest_path)
if (EXISTS "${zip_path}" AND NOT EXISTS "${dest_path}")
file(ARCHIVE_EXTRACT INPUT "${zip_path}" DESTINATION "${dest_dir}" PATTERNS "${source_path}")
endif()
endfunction()
function(add_lagom_library_install_rules target_name)
cmake_parse_arguments(PARSE_ARGV 1 LAGOM_INSTALL_RULES "" "ALIAS_NAME" "")
if (NOT LAGOM_INSTALL_RULES_ALIAS_NAME)
set(LAGOM_INSTALL_RULES_ALIAS_NAME ${target_name})
endif()
# Don't make alias when we're going to import a previous build for Tools
# FIXME: Is there a better way to write this?
if (NOT ENABLE_FUZZERS AND NOT CMAKE_CROSSCOMPILING)
# alias for parity with exports
add_library(Lagom::${LAGOM_INSTALL_RULES_ALIAS_NAME} ALIAS ${target_name})
endif()
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}
)
endfunction()
Reference in a new issue View git blame Copy permalink