Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build: introduce a CMake based build #70

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

build: introduce a CMake based build #70

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
#[[
This source file is part of the DocC open source project

Copyright (c) 2024 Apple Inc. and the DocC project authors
Licensed under Apache License v2.0 with Runtime Library Exception

See https://swift.org/LICENSE.txt for license information
#]]

cmake_minimum_required(VERSION 3.24)

project(SymbolKit
LANGUAGES Swift)

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)
set(CMAKE_Swift_COMPILE_OPTIONS_MSVC_RUNTIME_LIBRARY MultiThreadedDLL)

add_subdirectory(Sources)
add_subdirectory(cmake/modules)
10 changes: 10 additions & 0 deletions Sources/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
#[[
This source file is part of the DocC open source project

Copyright (c) 2024 Apple Inc. and the DocC project authors
Licensed under Apache License v2.0 with Runtime Library Exception

See https://swift.org/LICENSE.txt for license information
#]]

add_subdirectory(SymbolKit)
69 changes: 69 additions & 0 deletions Sources/SymbolKit/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
#[[
This source file is part of the DocC open source project

Copyright (c) 2024 Apple Inc. and the DocC project authors
Licensed under Apache License v2.0 with Runtime Library Exception

See https://swift.org/LICENSE.txt for license information
compnerd marked this conversation as resolved.
Show resolved Hide resolved
#]]

add_library(SymbolKit
Mixin/Mixin+Equals.swift
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have similar concerns as I raised in swiftlang/swift-docc#818 (review) about the ongoing maintenance burden of this separate file list. It is slightly lessened in this repository because it doesn't get updated as frequently but I like if this was automatically kept up-to-date or at least if there was an easy way for another contributor to regenerate this file list based on find Sources/SymbolKit -type f -name "*.swift" | sort or something similar.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is effectively what the list is - but this should only be run on the CI as you may have other sources which are not yet included in the build in your local tree.

Mixin/Mixin+Hash.swift
Mixin/Mixin.swift
SymbolGraph/AnyScalar.swift
SymbolGraph/LineList/LineList.swift
SymbolGraph/LineList/SourceRange/Position.swift
SymbolGraph/LineList/SourceRange/SourceRange.swift
SymbolGraph/Metadata.swift
SymbolGraph/Module.swift
SymbolGraph/OperatingSystem.swift
SymbolGraph/Platform.swift
SymbolGraph/Relationship/ReferenceLocation.swift
SymbolGraph/Relationship/Relationship.swift
SymbolGraph/Relationship/RelationshipKind.swift
SymbolGraph/Relationship/SourceOrigin.swift
SymbolGraph/Relationship/Swift/GenericConstraints.swift
SymbolGraph/Relationship/Swift/Swift.swift
SymbolGraph/SemanticVersion.swift
SymbolGraph/Symbol/AccessControl.swift
SymbolGraph/Symbol/AlternateDeclarations.swift
SymbolGraph/Symbol/Availability/Availability.swift
SymbolGraph/Symbol/Availability/AvailabilityItem.swift
SymbolGraph/Symbol/Availability/Domain.swift
SymbolGraph/Symbol/DeclarationFragments/DeclarationFragments+Simplify.swift
SymbolGraph/Symbol/DeclarationFragments/DeclarationFragments.swift
SymbolGraph/Symbol/DeclarationFragments/Fragment/Fragment.swift
SymbolGraph/Symbol/DeclarationFragments/Fragment/FragmentKind.swift
SymbolGraph/Symbol/FunctionSignature/FunctionParameter.swift
SymbolGraph/Symbol/FunctionSignature/FunctionSignature.swift
SymbolGraph/Symbol/HTTP/HTTP.swift
SymbolGraph/Symbol/Identifier.swift
SymbolGraph/Symbol/KindIdentifier.swift
SymbolGraph/Symbol/Location.swift
SymbolGraph/Symbol/Mutability.swift
SymbolGraph/Symbol/Names.swift
SymbolGraph/Symbol/OverloadData.swift
SymbolGraph/Symbol/PlistDetails.swift
SymbolGraph/Symbol/SPI.swift
SymbolGraph/Symbol/Snippet.swift
SymbolGraph/Symbol/Swift/Extension.swift
SymbolGraph/Symbol/Swift/GenericConstraint.swift
SymbolGraph/Symbol/Swift/GenericParameter.swift
SymbolGraph/Symbol/Swift/Generics.swift
SymbolGraph/Symbol/Swift/Namespace.swift
SymbolGraph/Symbol/Symbol.swift
SymbolGraph/Symbol/SymbolKind.swift
SymbolGraph/Symbol/ValueConstraints.swift
SymbolGraph/SymbolGraph+Overloads.swift
SymbolGraph/SymbolGraph.swift
UnifiedSymbolGraph/GraphCollector.swift
UnifiedSymbolGraph/UnifiedSymbol+Encodable.swift
UnifiedSymbolGraph/UnifiedSymbol.swift
UnifiedSymbolGraph/UnifiedSymbolGraph+Encodable.swift
UnifiedSymbolGraph/UnifiedSymbolGraph+Overloads.swift
UnifiedSymbolGraph/UnifiedSymbolGraph.swift)
set_target_properties(SymbolKit PROPERTIES
INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY})

set_property(GLOBAL APPEND PROPERTY SYMBOLKIT_EXPORTS SymbolKit)
19 changes: 19 additions & 0 deletions cmake/modules/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
#[[
This source file is part of the DocC open source project

Copyright (c) 2024 Apple Inc. and the DocC project authors
Licensed under Apache License v2.0 with Runtime Library Exception

See https://swift.org/LICENSE.txt for license information
#]]

set(SYMBOLKIT_EXPORTS_FILE
${CMAKE_CURRENT_BINARY_DIR}/SymbolKitExports.cmake)
configure_file(SymbolKitConfig.cmake.in
${CMAKE_CURRENT_BINARY_DIR}/SymbolKitConfig.cmake)

get_property(SYMBOLKIT_EXPORTS GLOBAL PROPERTY SYMBOLKIT_EXPORTS)
export(TARGETS ${SYMBOLKIT_EXPORTS}
NAMESPACE DocC::
FILE ${SYMBOLKIT_EXPORTS_FILE}
EXPORT_LINK_INTERFACE_LIBRARIES)
12 changes: 12 additions & 0 deletions cmake/modules/SymbolKitConfig.cmake.in
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
#[[
This source file is part of the DocC open source project

Copyright (c) 2024 Apple Inc. and the DocC project authors
Licensed under Apache License v2.0 with Runtime Library Exception

See https://swift.org/LICENSE.txt for license information
#]]

if(NOT TARGET DocC::SymbolKit)
include("@SYMBOLKIT_EXPORTS_FILE@")
endif()