CMake: Rename SERENITY_* helper variables to LADYBIRD_*

Author: https://github.com/ayeteadoe
Commit: f737ec2570
Pull-request: https://github.com/LadybirdBrowser/ladybird/pull/5249
Reviewed-by: https://github.com/gmta ✅

.github/workflows/nightly-android.yml

@@ -95,7 +95,7 @@ jobs:
         run: ./gradlew connectedAndroidTest
         env:
           GRADLE_OPTS: '-Xmx3072m'
-          SERENITY_CACHE_DIR: ${{ github.workspace }}/Build/caches
+          LADYBIRD_CACHE_DIR: ${{ github.workspace }}/Build/caches
 
       - name: Save Caches
         uses: ./.github/actions/cache-save

CMakePresets.json

@@ -14,7 +14,7 @@
       "binaryDir": "${fileDir}/Build/release",
       "cacheVariables": {
         "CMAKE_BUILD_TYPE": "RelWithDebInfo",
-        "SERENITY_CACHE_DIR": "${fileDir}/Build/caches",
+        "LADYBIRD_CACHE_DIR": "${fileDir}/Build/caches",
         "CMAKE_TOOLCHAIN_FILE": "$env{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake",
         "VCPKG_INSTALL_OPTIONS": "--no-print-usage",
         "VCPKG_OVERLAY_TRIPLETS": "${fileDir}/Meta/CMake/vcpkg/release-triplets"

Documentation/AdvancedBuildInstructions.md

@@ -28,8 +28,8 @@ There are some optional features that can be enabled during compilation that are
 - `LAGOM_TOOLS_ONLY`: Skips building libraries, utiltis and tests for [Lagom](../Meta/Lagom/ReadMe.md). Mostly only useful for cross-compilation.
 - `INCLUDE_WASM_SPEC_TESTS`: downloads and includes the WebAssembly spec testsuite tests. In order to use this option, you will need to install `prettier` and `wabt`. wabt version 1.0.35 or higher is required to pre-process the WebAssembly spec testsuite.
 - `INCLUDE_FLAC_SPEC_TESTS`: downloads and includes the xiph.org FLAC test suite.
-- `SERENITY_CACHE_DIR`: sets the location of a shared cache of downloaded files. Should not need to be set manually unless managing a distribution package.
+- `LADYBIRD_CACHE_DIR`: sets the location of a shared cache of downloaded files. Should not need to be set manually unless managing a distribution package.
-- `ENABLE_NETWORK_DOWNLOADS`: allows downloading files from the internet during the build. Default on, turning off enables offline builds. For offline builds, the structure of the SERENITY_CACHE_DIR must be set up the way that the build expects.
+- `ENABLE_NETWORK_DOWNLOADS`: allows downloading files from the internet during the build. Default on, turning off enables offline builds. For offline builds, the structure of the LADYBIRD_CACHE_DIR must be set up the way that the build expects.
 - `ENABLE_CLANG_PLUGINS`: enables clang plugins which analyze the code for programming mistakes. See [Clang Plugins](#clang-plugins) below.
 
 Many parts of the codebase have debug functionality, mostly consisting of additional messages printed to the debug console. This is done via the `<component_name>_DEBUG` macros, which can be enabled individually at build time. They are listed in [this file](../Meta/CMake/all_the_debug_macros.cmake).

Meta/CMake/ca_certificates_data.cmake

@@ -3,7 +3,7 @@ include(${CMAKE_CURRENT_LIST_DIR}/utils.cmake)
 set(CACERT_VERSION "2025-05-20")
 set(CACERT_SHA256 "ab3ee3651977a4178a702b0b828a4ee7b2bbb9127235b0ab740e2e15974bf5db")
 
-set(CACERT_PATH "${SERENITY_CACHE_DIR}/CACERT" CACHE PATH "Download location for cacert.pem")
+set(CACERT_PATH "${LADYBIRD_CACHE_DIR}/CACERT" CACHE PATH "Download location for cacert.pem")
 set(CACERT_VERSION_FILE "${CACERT_PATH}/version.txt")
 
 set(CACERT_FILE cacert-${CACERT_VERSION}.pem)

Meta/CMake/common_options.cmake

@@ -28,8 +28,8 @@ ladybird_option(INCLUDE_WASM_SPEC_TESTS OFF CACHE BOOL "Download and include the
 ladybird_option(INCLUDE_FLAC_SPEC_TESTS OFF CACHE BOOL "Download and include the FLAC spec testsuite")
 ladybird_option(ENABLE_CACERT_DOWNLOAD ON CACHE BOOL "Enable download of cacert.pem at build time")
 
-ladybird_option(SERENITY_CACHE_DIR "${PROJECT_BINARY_DIR}/../caches" CACHE PATH "Location of shared cache of downloaded files")
+ladybird_option(LADYBIRD_CACHE_DIR "${PROJECT_BINARY_DIR}/../caches" CACHE PATH "Location of shared cache of downloaded files")
-ladybird_option(ENABLE_NETWORK_DOWNLOADS ON CACHE BOOL "Allow downloads of required files. If OFF, required files must already be present in SERENITY_CACHE_DIR")
+ladybird_option(ENABLE_NETWORK_DOWNLOADS ON CACHE BOOL "Allow downloads of required files. If OFF, required files must already be present in LADYBIRD_CACHE_DIR")
 
 ladybird_option(ENABLE_CLANG_PLUGINS OFF CACHE BOOL "Enable building with the Clang plugins")
 ladybird_option(ENABLE_CLANG_PLUGINS_INVALID_FUNCTION_MEMBERS OFF CACHE BOOL "Enable detecting invalid function types as members of GC-allocated objects")

Meta/CMake/public_suffix.cmake

@@ -1,6 +1,6 @@
 include(${CMAKE_CURRENT_LIST_DIR}/utils.cmake)
 
-set(PUBLIC_SUFFIX_PATH "${SERENITY_CACHE_DIR}/PublicSuffix" CACHE PATH "Download location for PublicSuffix files")
+set(PUBLIC_SUFFIX_PATH "${LADYBIRD_CACHE_DIR}/PublicSuffix" CACHE PATH "Download location for PublicSuffix files")
 set(PUBLIC_SUFFIX_DATA_URL "https://raw.githubusercontent.com/publicsuffix/list/master/public_suffix_list.dat")
 set(PUBLIC_SUFFIX_DATA_PATH "${PUBLIC_SUFFIX_PATH}/public_suffix_list.dat")
 set(PUBLIC_SUFFIX_DATA_HEADER PublicSuffixData.h)

Meta/CMake/targets.cmake

@@ -52,7 +52,7 @@ function(lagom_lib target_name fs_name)
     add_lagom_library_install_rules(${target_name} ALIAS_NAME ${library})
     if (ENABLE_INSTALL_HEADERS)
         install(
-                DIRECTORY "${SERENITY_PROJECT_ROOT}/Libraries/Lib${library}"
+                DIRECTORY "${LADYBIRD_PROJECT_ROOT}/Libraries/Lib${library}"
                 COMPONENT Lagom_Development
                 DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
                 FILES_MATCHING PATTERN "*.h"
@@ -98,12 +98,12 @@ function(lagom_utility name)
 endfunction()
 
 function(ladybird_test test_src sub_dir)
-    cmake_parse_arguments(PARSE_ARGV 2 SERENITY_TEST "" "CUSTOM_MAIN;NAME" "LIBS")
+    cmake_parse_arguments(PARSE_ARGV 2 LADYBIRD_TEST "" "CUSTOM_MAIN;NAME" "LIBS")
     lagom_test(${test_src}
-            LIBS ${SERENITY_TEST_LIBS}
+            LIBS ${LADYBIRD_TEST_LIBS}
             WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-            NAME ${SERENITY_TEST_NAME}
+            NAME ${LADYBIRD_TEST_NAME}
-            CUSTOM_MAIN ${SERENITY_TEST_CUSTOM_MAIN}
+            CUSTOM_MAIN ${LADYBIRD_TEST_CUSTOM_MAIN}
     )
 endfunction()
 
@@ -128,16 +128,16 @@ function(ladybird_bin name)
 endfunction()
 
 function(ladybird_lib name fs_name)
-    cmake_parse_arguments(PARSE_ARGV 2 SERENITY_LIB "EXPLICIT_SYMBOL_EXPORT" "TYPE" "")
+    cmake_parse_arguments(PARSE_ARGV 2 LADYBIRD_LIB "EXPLICIT_SYMBOL_EXPORT" "TYPE" "")
     set(EXPLICIT_SYMBOL_EXPORT "")
-    if (SERENITY_LIB_EXPLICIT_SYMBOL_EXPORT)
+    if (LADYBIRD_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})
+    lagom_lib(${name} ${fs_name} LIBRARY_TYPE ${LADYBIRD_LIB_TYPE} ${EXPLICIT_SYMBOL_EXPORT} SOURCES ${SOURCES} ${GENERATED_SOURCES})
 endfunction()
 
 macro(add_ladybird_subdirectory path)
-    add_subdirectory("${SERENITY_PROJECT_ROOT}/${path}" "${CMAKE_CURRENT_BINARY_DIR}/${path}")
+    add_subdirectory("${LADYBIRD_PROJECT_ROOT}/${path}" "${CMAKE_CURRENT_BINARY_DIR}/${path}")
 endmacro()
 
 if (NOT TARGET ladybird_codegen_accumulator)

Meta/CMake/utils.cmake

@@ -13,14 +13,14 @@ function(ladybird_generated_sources target_name)
 endfunction()
 
 function(ladybird_testjs_test test_src sub_dir)
-    cmake_parse_arguments(PARSE_ARGV 2 SERENITY_TEST "" "CUSTOM_MAIN" "LIBS")
+    cmake_parse_arguments(PARSE_ARGV 2 LADYBIRD_TEST "" "CUSTOM_MAIN" "LIBS")
-    if ("${SERENITY_TEST_CUSTOM_MAIN}" STREQUAL "")
+    if ("${LADYBIRD_TEST_CUSTOM_MAIN}" STREQUAL "")
-        set(SERENITY_TEST_CUSTOM_MAIN "$<TARGET_OBJECTS:JavaScriptTestRunnerMain>")
+        set(LADYBIRD_TEST_CUSTOM_MAIN "$<TARGET_OBJECTS:JavaScriptTestRunnerMain>")
     endif()
-    list(APPEND SERENITY_TEST_LIBS LibJS LibCore LibFileSystem)
+    list(APPEND LADYBIRD_TEST_LIBS LibJS LibCore LibFileSystem)
     ladybird_test(${test_src} ${sub_dir}
-        CUSTOM_MAIN "${SERENITY_TEST_CUSTOM_MAIN}"
+        CUSTOM_MAIN "${LADYBIRD_TEST_CUSTOM_MAIN}"
-        LIBS ${SERENITY_TEST_LIBS})
+        LIBS ${LADYBIRD_TEST_LIBS})
 endfunction()
 
 function(remove_path_if_version_changed version version_file cache_path)
@@ -76,7 +76,7 @@ function(invoke_py_generator name script primary_source header implementation)
     find_package(Python3 REQUIRED COMPONENTS Interpreter)
     invoke_generator_impl(
         ${name}
-        "${SerenityOS_SOURCE_DIR}/Meta/${script}"
+        "${LADYBIRD_PROJECT_ROOT}/Meta/${script}"
         ${primary_source}
         ${header}
         ${implementation}

Meta/Lagom/CMakeLists.txt

@@ -35,12 +35,12 @@ if (POLICY CMP0174)
 endif()
 
 get_filename_component(
-    SERENITY_PROJECT_ROOT "${PROJECT_SOURCE_DIR}/../.."
+    LADYBIRD_PROJECT_ROOT "${PROJECT_SOURCE_DIR}/../.."
     ABSOLUTE CACHE
 )
-set(SerenityOS_SOURCE_DIR "${SERENITY_PROJECT_ROOT}" CACHE STRING "")
+set(SerenityOS_SOURCE_DIR "${LADYBIRD_PROJECT_ROOT}" CACHE STRING "")
 
-list(APPEND CMAKE_MODULE_PATH "${SERENITY_PROJECT_ROOT}/Meta/CMake")
+list(APPEND CMAKE_MODULE_PATH "${LADYBIRD_PROJECT_ROOT}/Meta/CMake")
 
 if(NOT COMMAND ladybird_option)
     macro(ladybird_option)
@@ -160,7 +160,7 @@ set(Lagom_INSTALL_CMAKEDIR "${CMAKE_INSTALL_DATADIR}/${package}"
 mark_as_advanced(Lagom_INSTALL_CMAKEDIR)
 
 install(
-    FILES "${SERENITY_PROJECT_ROOT}/Meta/CMake/lagom-install-config.cmake"
+    FILES "${LADYBIRD_PROJECT_ROOT}/Meta/CMake/lagom-install-config.cmake"
     DESTINATION "${Lagom_INSTALL_CMAKEDIR}"
     RENAME "${package}Config.cmake"
     COMPONENT Lagom_Development
@@ -218,14 +218,14 @@ endif()
 # Lagom Libraries
 # FIXME: Move these calls to the relevant client library CMakeLists
 # Note that the Services themselves are only built if ENABLE_GUI_TARGETS, from top level.
-compile_ipc(${SERENITY_PROJECT_ROOT}/Services/RequestServer/RequestClient.ipc Services/RequestServer/RequestClientEndpoint.h)
+compile_ipc(${LADYBIRD_PROJECT_ROOT}/Services/RequestServer/RequestClient.ipc Services/RequestServer/RequestClientEndpoint.h)
-compile_ipc(${SERENITY_PROJECT_ROOT}/Services/RequestServer/RequestServer.ipc Services/RequestServer/RequestServerEndpoint.h)
+compile_ipc(${LADYBIRD_PROJECT_ROOT}/Services/RequestServer/RequestServer.ipc Services/RequestServer/RequestServerEndpoint.h)
-compile_ipc(${SERENITY_PROJECT_ROOT}/Services/WebContent/WebContentServer.ipc Services/WebContent/WebContentServerEndpoint.h)
+compile_ipc(${LADYBIRD_PROJECT_ROOT}/Services/WebContent/WebContentServer.ipc Services/WebContent/WebContentServerEndpoint.h)
-compile_ipc(${SERENITY_PROJECT_ROOT}/Services/WebContent/WebContentClient.ipc Services/WebContent/WebContentClientEndpoint.h)
+compile_ipc(${LADYBIRD_PROJECT_ROOT}/Services/WebContent/WebContentClient.ipc Services/WebContent/WebContentClientEndpoint.h)
-compile_ipc(${SERENITY_PROJECT_ROOT}/Services/WebContent/WebDriverClient.ipc Services/WebContent/WebDriverClientEndpoint.h)
+compile_ipc(${LADYBIRD_PROJECT_ROOT}/Services/WebContent/WebDriverClient.ipc Services/WebContent/WebDriverClientEndpoint.h)
-compile_ipc(${SERENITY_PROJECT_ROOT}/Services/WebContent/WebDriverServer.ipc Services/WebContent/WebDriverServerEndpoint.h)
+compile_ipc(${LADYBIRD_PROJECT_ROOT}/Services/WebContent/WebDriverServer.ipc Services/WebContent/WebDriverServerEndpoint.h)
-compile_ipc(${SERENITY_PROJECT_ROOT}/Services/WebContent/WebUIClient.ipc Services/WebContent/WebUIClientEndpoint.h)
+compile_ipc(${LADYBIRD_PROJECT_ROOT}/Services/WebContent/WebUIClient.ipc Services/WebContent/WebUIClientEndpoint.h)
-compile_ipc(${SERENITY_PROJECT_ROOT}/Services/WebContent/WebUIServer.ipc Services/WebContent/WebUIServerEndpoint.h)
+compile_ipc(${LADYBIRD_PROJECT_ROOT}/Services/WebContent/WebUIServer.ipc Services/WebContent/WebUIServerEndpoint.h)
 
 add_ladybird_subdirectory(Libraries)
 

Tests/LibJS/CMakeLists.txt

@@ -7,4 +7,4 @@ if (WIN32 AND ENABLE_WINDOWS_CI)
 endif()
 
 ladybird_testjs_test(test-js.cpp test-js LIBS LibGC)
-set_tests_properties(test-js PROPERTIES ENVIRONMENT LADYBIRD_SOURCE_DIR=${SERENITY_PROJECT_ROOT})
+set_tests_properties(test-js PROPERTIES ENVIRONMENT LADYBIRD_SOURCE_DIR=${LADYBIRD_PROJECT_ROOT})

Tests/LibWasm/CMakeLists.txt

@@ -1,6 +1,6 @@
 add_executable(test-wasm test-wasm.cpp)
 target_link_libraries(test-wasm AK LibCore LibFileSystem JavaScriptTestRunnerMain LibTest LibWasm LibJS LibCrypto LibGC)
-set(wasm_test_root "${SERENITY_PROJECT_ROOT}")
+set(wasm_test_root "${LADYBIRD_PROJECT_ROOT}")
 if (INCLUDE_WASM_SPEC_TESTS)
     set(wasm_test_root "${Lagom_BINARY_DIR}")
 endif()

Tests/LibWeb/test-web/CMakeLists.txt

@@ -21,5 +21,5 @@ if (BUILD_TESTING)
         COMMAND $<TARGET_FILE:test-web> --python-executable ${Python3_EXECUTABLE} --dump-failed-ref-tests --per-test-timeout 120 --verbose
     )
 
-    set_tests_properties(LibWeb PROPERTIES ENVIRONMENT LADYBIRD_SOURCE_DIR=${SERENITY_PROJECT_ROOT})
+    set_tests_properties(LibWeb PROPERTIES ENVIRONMENT LADYBIRD_SOURCE_DIR=${LADYBIRD_PROJECT_ROOT})
 endif()

UI/Android/BuildLagomTools.sh

@@ -34,7 +34,7 @@ cmake -S "${LADYBIRD_SOURCE_DIR}/Meta/Lagom" -B "$BUILD_DIR/lagom-tools" \
     -DCMAKE_INSTALL_PREFIX="$BUILD_DIR/lagom-tools-install"  \
     -DCMAKE_C_COMPILER="$CC" \
     -DCMAKE_CXX_COMPILER="$CXX" \
-    -DSERENITY_CACHE_DIR="$CACHE_DIR" \
+    -DLADYBIRD_CACHE_DIR="$CACHE_DIR" \
     -DLAGOM_TOOLS_ONLY=ON \
     -DINSTALL_LAGOM_TOOLS=ON \
     -DCMAKE_TOOLCHAIN_FILE="$LADYBIRD_SOURCE_DIR/Build/vcpkg/scripts/buildsystems/vcpkg.cmake" \

UI/Android/build.gradle.kts

@@ -6,7 +6,7 @@ plugins {
 }
 
 var buildDir = layout.buildDirectory.get()
-var cacheDir = System.getenv("SERENITY_CACHE_DIR") ?: "$buildDir/caches"
+var cacheDir = System.getenv("LADYBIRD_CACHE_DIR") ?: "$buildDir/caches"
 var sourceDir = layout.projectDirectory.dir("../../").toString()
 
 task<Exec>("buildLagomTools") {
@@ -39,7 +39,7 @@ android {
                 arguments += listOf(
                     "-DLagomTools_DIR=$buildDir/lagom-tools-install/share/LagomTools",
                     "-DANDROID_STL=c++_shared",
-                    "-DSERENITY_CACHE_DIR=$cacheDir",
+                    "-DLADYBIRD_CACHE_DIR=$cacheDir",
                     "-DVCPKG_ROOT=$sourceDir/Build/vcpkg",
                     "-DVCPKG_TARGET_ANDROID=ON"
                 )