mirror of
https://github.com/apple/swift-log
synced 2026-11-22 03:40:39 +00:00
Add CMake support for Swift targets and test configurations (#485)
Add CMake build support to the project to enable toolchain integration and bootstrapping compatibility. ### Motivation: Currently, swift-log does not support building with CMake. This addition resolves issue #484, allowing swift-log to be resolved and compiled within CMake-based environments (like the repos swift-certificates and swift-argument-parser which aer mentioned in the issue). ### Modifications: 1. **Project Root Config:** Added [CMakeLists.txt](file:///Users/adityamitra/Developer/swift-log/CMakeLists.txt) configuring the CMake project with Swift 6 and C, alongside setting up compiler flags for MSVC runtime library on Windows. 2. **Helper Modules:** Added the `cmake/` folder: - `SwiftSupport.cmake`: dylib/module installations and triple detection helper. - `SwiftLogConfig.cmake.in`: package config export templates. 3. **Target CMake Configurations:** Created [Sources/Logging/CMakeLists.txt](file:///Users/adityamitra/Developer/swift-log/Sources/Logging/CMakeLists.txt) & [Sources/InMemoryLogging/CMakeLists.txt](file:///Users/adityamitra/Developer/swift-log/Sources/InMemoryLogging/CMakeLists.txt) to define the library targets. Included generator expressions pointing `INTERFACE_INCLUDE_DIRECTORIES` to target output directories for Xcode generator support. 4. **SwiftPM Exclusions:** Excluded the new CMake files from target targets inside [Package.swift](file:///Users/adityamitra/Developer/swift-log/Package.swift) and [Package@swift-6.1.swift](file:///Users/adityamitra/Developer/swift-log/Package@swift-6.1.swift) to keep SwiftPM targets warning-free. 5. **Compile Options Variable:** Consolidates compile options under a single global definition `SWIFT_LOG_COMMON_COMPILE_OPTIONS` in the root configuration, enabling Swift 6 compiler features (`ExistentialAny`, `MemberImportVisibility`, `InternalImportsByDefault`, `NonisolatedNonsendingByDefault`, and explicit Sendable checks) across all targets. 6. **CI Integration & Workflow:** Integrated CMake CI validation in `.github/workflows/pull_request.yml` using the shared workflow from `apple/swift-nio/.github/workflows/cmake_tests.yml@main` running in a `swift:6.1-jammy` container. This job compiles the core libraries and verifies the validity of the CMake files. 7. **License Header Compliance:** Cleaned up license headers across all CMake files ### Result: * **SwiftPM:** All 164 unit tests compile and pass successfully under `swift test` with no warnings. * **CMake:** Successfully compiles (`** BUILD SUCCEEDED **`) under Xcode generator (`cmake -B build -G Xcode && cmake --build build`). ### Issue Tracking: Fixes #484 --------- Co-authored-by: Vladimir Kukushkin <kukushechkin@apple.com>
This commit is contained in:
1 parent
8056dbfb08
commit
e83726cb15
10 files changed
+300
-8
No files matched your search
@@ -87,3 +87,16 @@ jobs:
|
||||
uses: apple/swift-nio/.github/workflows/wasm_swift_sdk.yml@main
|
||||
with:
|
||||
nightly_next_enabled: false
|
||||
|
||||
cmake-lists:
|
||||
name: Check CMake Lists
|
||||
uses: apple/swift-nio/.github/workflows/cmake_tests.yml@main
|
||||
with:
|
||||
image: "swift:6.1-jammy"
|
||||
update_cmake_lists_config: >-
|
||||
{
|
||||
"targets": [
|
||||
{ "name": "Logging", "type": "source", "exceptions": [] },
|
||||
{ "name": "InMemoryLogging", "type": "source", "exceptions": [] }
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,72 @@
|
||||
#===----------------------------------------------------------------------===#
|
||||
#
|
||||
# This source file is part of the Swift Logging API open source project
|
||||
#
|
||||
# Copyright (c) 2018-2026 Apple Inc. and the Swift Logging API project authors
|
||||
# Licensed under Apache License v2.0
|
||||
#
|
||||
# See LICENSE.txt for license information
|
||||
# See CONTRIBUTORS.txt for the list of Swift Logging API project authors
|
||||
#
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
#
|
||||
#===----------------------------------------------------------------------===#
|
||||
|
||||
cmake_minimum_required(VERSION 3.19)
|
||||
|
||||
# Initialize C language first to inspect the compiler environment
|
||||
project(swift-log LANGUAGES C)
|
||||
|
||||
# Set Swift compiler target from C compiler target if not manually set for Windows
|
||||
if(WIN32 AND NOT CMAKE_Swift_COMPILER_TARGET)
|
||||
if(CMAKE_C_COMPILER_ARCHITECTURE_ID MATCHES "(ARM64|arm64|aarch64)")
|
||||
set(CMAKE_Swift_COMPILER_TARGET "aarch64-unknown-windows-msvc" CACHE STRING "Swift compiler target triple")
|
||||
elseif(CMAKE_C_COMPILER_ARCHITECTURE_ID MATCHES "(X86|x64|AMD64|x86_64)")
|
||||
set(CMAKE_Swift_COMPILER_TARGET "x86_64-unknown-windows-msvc" CACHE STRING "Swift compiler target triple")
|
||||
endif()
|
||||
endif()
|
||||
|
||||
# Enable Swift after C defines the architecture
|
||||
enable_language(Swift)
|
||||
|
||||
option(BUILD_SHARED_LIBS "Build shared libraries by default" YES)
|
||||
|
||||
set(CMAKE_Swift_LANGUAGE_VERSION 6)
|
||||
|
||||
if(CMAKE_Swift_COMPILER_VERSION VERSION_LESS "6.1")
|
||||
message(FATAL_ERROR "swift-log requires Swift compiler version 6.1 or newer. Detected version: ${CMAKE_Swift_COMPILER_VERSION}")
|
||||
endif()
|
||||
|
||||
set(SWIFT_LOG_COMMON_COMPILE_OPTIONS
|
||||
"SHELL:-enable-upcoming-feature ExistentialAny"
|
||||
"SHELL:-enable-upcoming-feature MemberImportVisibility"
|
||||
"SHELL:-enable-upcoming-feature InternalImportsByDefault"
|
||||
"SHELL:-enable-upcoming-feature NonisolatedNonsendingByDefault"
|
||||
"SHELL:-Xfrontend -require-explicit-sendable"
|
||||
"SHELL:-package-name swift_log")
|
||||
|
||||
list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules)
|
||||
|
||||
set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
|
||||
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
|
||||
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
|
||||
|
||||
set(CMAKE_Swift_MODULE_DIRECTORY ${CMAKE_BINARY_DIR}/swift)
|
||||
|
||||
if(MSVC)
|
||||
message(STATUS "MSVC condition triggered successfully!")
|
||||
set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>DLL")
|
||||
set(CMAKE_Swift_COMPILE_OPTIONS_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>DLL")
|
||||
endif()
|
||||
|
||||
include(GNUInstallDirs)
|
||||
include(SwiftSupport)
|
||||
|
||||
if(NOT APPLE)
|
||||
find_package(dispatch QUIET)
|
||||
find_package(Foundation QUIET)
|
||||
endif()
|
||||
|
||||
add_subdirectory(Sources)
|
||||
|
||||
add_subdirectory(cmake/modules)
|
||||
+8
-4
@@ -29,19 +29,23 @@ let package = Package(
|
||||
targets: [
|
||||
.target(
|
||||
name: "Logging",
|
||||
dependencies: []
|
||||
dependencies: [],
|
||||
exclude: ["CMakeLists.txt"]
|
||||
),
|
||||
.target(
|
||||
name: "InMemoryLogging",
|
||||
dependencies: ["Logging"]
|
||||
dependencies: ["Logging"],
|
||||
exclude: ["CMakeLists.txt"]
|
||||
),
|
||||
.testTarget(
|
||||
name: "LoggingTests",
|
||||
dependencies: ["Logging"]
|
||||
dependencies: ["Logging"],
|
||||
exclude: ["CMakeLists.txt"]
|
||||
),
|
||||
.testTarget(
|
||||
name: "InMemoryLoggingTests",
|
||||
dependencies: ["InMemoryLogging", "Logging"]
|
||||
dependencies: ["InMemoryLogging", "Logging"],
|
||||
exclude: ["CMakeLists.txt"]
|
||||
),
|
||||
]
|
||||
)
|
||||
|
||||
@@ -29,19 +29,23 @@ let package = Package(
|
||||
targets: [
|
||||
.target(
|
||||
name: "Logging",
|
||||
dependencies: []
|
||||
dependencies: [],
|
||||
exclude: ["CMakeLists.txt"]
|
||||
),
|
||||
.target(
|
||||
name: "InMemoryLogging",
|
||||
dependencies: ["Logging"]
|
||||
dependencies: ["Logging"],
|
||||
exclude: ["CMakeLists.txt"]
|
||||
),
|
||||
.testTarget(
|
||||
name: "LoggingTests",
|
||||
dependencies: ["Logging"]
|
||||
dependencies: ["Logging"],
|
||||
exclude: ["CMakeLists.txt"]
|
||||
),
|
||||
.testTarget(
|
||||
name: "InMemoryLoggingTests",
|
||||
dependencies: ["InMemoryLogging", "Logging"]
|
||||
dependencies: ["InMemoryLogging", "Logging"],
|
||||
exclude: ["CMakeLists.txt"]
|
||||
),
|
||||
]
|
||||
)
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
#===----------------------------------------------------------------------===#
|
||||
#
|
||||
# This source file is part of the Swift Logging API open source project
|
||||
#
|
||||
# Copyright (c) 2018-2026 Apple Inc. and the Swift Logging API project authors
|
||||
# Licensed under Apache License v2.0
|
||||
#
|
||||
# See LICENSE.txt for license information
|
||||
# See CONTRIBUTORS.txt for the list of Swift Logging API project authors
|
||||
#
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
#
|
||||
#===----------------------------------------------------------------------===#
|
||||
|
||||
add_subdirectory(Logging)
|
||||
add_subdirectory(InMemoryLogging)
|
||||
@@ -0,0 +1,28 @@
|
||||
#===----------------------------------------------------------------------===#
|
||||
#
|
||||
# This source file is part of the Swift Logging API open source project
|
||||
#
|
||||
# Copyright (c) 2018-2026 Apple Inc. and the Swift Logging API project authors
|
||||
# Licensed under Apache License v2.0
|
||||
#
|
||||
# See LICENSE.txt for license information
|
||||
# See CONTRIBUTORS.txt for the list of Swift Logging API project authors
|
||||
#
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
#
|
||||
#===----------------------------------------------------------------------===#
|
||||
|
||||
add_library(InMemoryLogging
|
||||
"InMemoryLogHandler.swift"
|
||||
)
|
||||
|
||||
set_target_properties(InMemoryLogging PROPERTIES
|
||||
INTERFACE_INCLUDE_DIRECTORIES "$<BUILD_INTERFACE:$<TARGET_PROPERTY:Swift_MODULE_DIRECTORY>>;$<BUILD_INTERFACE:$<TARGET_FILE_DIR:InMemoryLogging>>")
|
||||
|
||||
target_compile_options(InMemoryLogging PRIVATE
|
||||
${SWIFT_LOG_COMMON_COMPILE_OPTIONS})
|
||||
|
||||
target_link_libraries(InMemoryLogging PRIVATE Logging)
|
||||
|
||||
_install_target(InMemoryLogging)
|
||||
set_property(GLOBAL APPEND PROPERTY SwiftLog_EXPORTS InMemoryLogging)
|
||||
@@ -0,0 +1,36 @@
|
||||
#===----------------------------------------------------------------------===#
|
||||
#
|
||||
# This source file is part of the Swift Logging API open source project
|
||||
#
|
||||
# Copyright (c) 2018-2026 Apple Inc. and the Swift Logging API project authors
|
||||
# Licensed under Apache License v2.0
|
||||
#
|
||||
# See LICENSE.txt for license information
|
||||
# See CONTRIBUTORS.txt for the list of Swift Logging API project authors
|
||||
#
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
#
|
||||
#===----------------------------------------------------------------------===#
|
||||
|
||||
add_library(Logging
|
||||
"Handlers/MultiplexLogHandler.swift"
|
||||
"Handlers/StreamLogHandler.swift"
|
||||
"Handlers/SwiftLogNoOpLogHandler.swift"
|
||||
"Locks.swift"
|
||||
"LogEvent.swift"
|
||||
"LogHandler.swift"
|
||||
"Logger+Attributes.swift"
|
||||
"Logger+With.swift"
|
||||
"Logger.swift"
|
||||
"LoggingSystem.swift"
|
||||
"MetadataProvider.swift"
|
||||
)
|
||||
|
||||
set_target_properties(Logging PROPERTIES
|
||||
INTERFACE_INCLUDE_DIRECTORIES "$<BUILD_INTERFACE:$<TARGET_PROPERTY:Swift_MODULE_DIRECTORY>>;$<BUILD_INTERFACE:$<TARGET_FILE_DIR:Logging>>")
|
||||
|
||||
target_compile_options(Logging PRIVATE
|
||||
${SWIFT_LOG_COMMON_COMPILE_OPTIONS})
|
||||
|
||||
_install_target(Logging)
|
||||
set_property(GLOBAL APPEND PROPERTY SwiftLog_EXPORTS Logging)
|
||||
@@ -0,0 +1,22 @@
|
||||
#===----------------------------------------------------------------------===#
|
||||
#
|
||||
# This source file is part of the Swift Logging API open source project
|
||||
#
|
||||
# Copyright (c) 2018-2026 Apple Inc. and the Swift Logging API project authors
|
||||
# Licensed under Apache License v2.0
|
||||
#
|
||||
# See LICENSE.txt for license information
|
||||
# See CONTRIBUTORS.txt for the list of Swift Logging API project authors
|
||||
#
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
#
|
||||
#===----------------------------------------------------------------------===#
|
||||
|
||||
set(SwiftLog_EXPORTS_FILE ${CMAKE_CURRENT_BINARY_DIR}/SwiftLogExports.cmake)
|
||||
|
||||
configure_file(SwiftLogConfig.cmake.in
|
||||
${CMAKE_CURRENT_BINARY_DIR}/SwiftLogConfig.cmake)
|
||||
|
||||
get_property(SwiftLog_EXPORTS GLOBAL PROPERTY SwiftLog_EXPORTS)
|
||||
export(TARGETS ${SwiftLog_EXPORTS}
|
||||
FILE ${SwiftLog_EXPORTS_FILE})
|
||||
@@ -0,0 +1,17 @@
|
||||
##===----------------------------------------------------------------------===##
|
||||
##
|
||||
## This source file is part of the Swift Logging API open source project
|
||||
##
|
||||
## Copyright (c) 2018-2026 Apple Inc. and the Swift Logging API project authors
|
||||
## Licensed under Apache License v2.0
|
||||
##
|
||||
## See LICENSE.txt for license information
|
||||
## See CONTRIBUTORS.txt for the list of Swift Logging API project authors
|
||||
##
|
||||
## SPDX-License-Identifier: Apache-2.0
|
||||
##
|
||||
##===----------------------------------------------------------------------===##
|
||||
|
||||
if(NOT TARGET Logging)
|
||||
include(@SwiftLog_EXPORTS_FILE@)
|
||||
endif()
|
||||
@@ -0,0 +1,80 @@
|
||||
##===----------------------------------------------------------------------===##
|
||||
##
|
||||
## This source file is part of the Swift Logging API open source project
|
||||
##
|
||||
## Copyright (c) 2018-2026 Apple Inc. and the Swift Logging API project authors
|
||||
## Licensed under Apache License v2.0
|
||||
##
|
||||
## See LICENSE.txt for license information
|
||||
## See CONTRIBUTORS.txt for the list of Swift Logging API project authors
|
||||
##
|
||||
## SPDX-License-Identifier: Apache-2.0
|
||||
##
|
||||
##===----------------------------------------------------------------------===##
|
||||
|
||||
# Returns the os name in a variable
|
||||
#
|
||||
# Usage:
|
||||
# get_swift_host_os(result_var_name)
|
||||
#
|
||||
#
|
||||
# Sets ${result_var_name} with the converted OS name derived from
|
||||
# CMAKE_SYSTEM_NAME.
|
||||
function(get_swift_host_os result_var_name)
|
||||
if(CMAKE_SYSTEM_NAME STREQUAL Darwin)
|
||||
set(${result_var_name} macosx PARENT_SCOPE)
|
||||
else()
|
||||
string(TOLOWER ${CMAKE_SYSTEM_NAME} cmake_system_name_lc)
|
||||
set(${result_var_name} ${cmake_system_name_lc} PARENT_SCOPE)
|
||||
endif()
|
||||
endfunction()
|
||||
|
||||
if(NOT Swift_MODULE_TRIPLE)
|
||||
# Attempt to get the module triple from the Swift compiler.
|
||||
set(module_triple_command "${CMAKE_Swift_COMPILER}" -print-target-info)
|
||||
if(CMAKE_Swift_COMPILER_TARGET)
|
||||
list(APPEND module_triple_command -target ${CMAKE_Swift_COMPILER_TARGET})
|
||||
endif()
|
||||
execute_process(COMMAND ${module_triple_command}
|
||||
OUTPUT_VARIABLE target_info_json)
|
||||
string(JSON module_triple GET "${target_info_json}" "target" "moduleTriple")
|
||||
|
||||
# Exit now if we failed to infer the triple.
|
||||
if(NOT module_triple)
|
||||
message(FATAL_ERROR
|
||||
"Failed to get module triple from Swift compiler. "
|
||||
"Compiler output: ${target_info_json}")
|
||||
endif()
|
||||
|
||||
# Cache the module triple for future use.
|
||||
set(Swift_MODULE_TRIPLE "${module_triple}" CACHE STRING "swift module triple used for installed swiftmodule and swiftinterface files")
|
||||
mark_as_advanced(Swift_MODULE_TRIPLE)
|
||||
endif()
|
||||
|
||||
function(_install_target module)
|
||||
get_swift_host_os(swift_os)
|
||||
get_target_property(type ${module} TYPE)
|
||||
|
||||
if(type STREQUAL STATIC_LIBRARY)
|
||||
set(swift swift_static)
|
||||
else()
|
||||
set(swift swift)
|
||||
endif()
|
||||
|
||||
install(TARGETS ${module})
|
||||
if(type STREQUAL EXECUTABLE)
|
||||
return()
|
||||
endif()
|
||||
|
||||
get_target_property(module_name ${module} Swift_MODULE_NAME)
|
||||
if(NOT module_name)
|
||||
set(module_name ${module})
|
||||
endif()
|
||||
|
||||
install(FILES $<TARGET_PROPERTY:${module},Swift_MODULE_DIRECTORY>/${module_name}.swiftdoc
|
||||
DESTINATION ${CMAKE_INSTALL_LIBDIR}/${swift}/${swift_os}/${module_name}.swiftmodule
|
||||
RENAME ${Swift_MODULE_TRIPLE}.swiftdoc)
|
||||
install(FILES $<TARGET_PROPERTY:${module},Swift_MODULE_DIRECTORY>/${module_name}.swiftmodule
|
||||
DESTINATION ${CMAKE_INSTALL_LIBDIR}/${swift}/${swift_os}/${module_name}.swiftmodule
|
||||
RENAME ${Swift_MODULE_TRIPLE}.swiftmodule)
|
||||
endfunction()
|
||||
Reference in new issue
Block a user