/
CMakePlugin.kt
227 lines (197 loc) · 7.98 KB
/
CMakePlugin.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
/*
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.prefab.cmake
import com.google.prefab.api.Android
import com.google.prefab.api.BuildSystemInterface
import com.google.prefab.api.LibraryReference
import com.google.prefab.api.Module
import com.google.prefab.api.NoMatchingLibraryException
import com.google.prefab.api.Package
import com.google.prefab.api.PlatformDataInterface
import java.io.File
import java.nio.file.Files
import java.nio.file.Path
/**
* Sanitizes a path for use in a CMake file.
*
* Convert backslash separated paths to forward slash separated paths on
* Windows. Even on Windows, it's the norm to use forward slash separated paths
* for ndk-build.
*
* TODO: Figure out if we should be using split/join instead.
* It's not clear how that will behave with Windows \\?\ paths.
*/
fun Path.sanitize(): String = toString().replace('\\', '/')
/**
* Returns true if the path exists and is not an empty directory.
*/
fun Path.directoryNotEmpty(): Boolean =
toFile().exists() && Files.list(this).count() > 0
/**
* The build plugin for [CMake](https://cmake.org/).
*/
class CMakePlugin(
override val outputDirectory: File,
override val packages: List<Package>
) : BuildSystemInterface {
override fun generate(requirements: Collection<PlatformDataInterface>) {
val requirement = requirements.singleOrNull()
?: throw UnsupportedOperationException(
"CMake cannot generate multiple targets to a single directory"
)
prepareOutputDirectory(outputDirectory)
for (pkg in packages) {
generatePackage(pkg, requirement)
}
}
private fun generatePackage(
pkg: Package,
requirements: PlatformDataInterface
) {
// Until r19 the NDK CMake toolchain file did not properly set
// CMAKE_LIBRARY_ARCHITECTURE, so we can't use the architecture-specific
// layout unless targeting at least r19.
val useArchSpecificLayout =
requirements !is Android || requirements.ndkMajorVersion >= 19
// https://cmake.org/cmake/help/latest/command/find_package.html#search-procedure
// We could also include a version number suffix on the package name
// part of the directory, but since we don't support duplicate package
// names in the same run there's currently no chance of a conflict.
val pkgDirectory = if (useArchSpecificLayout) {
outputDirectory.resolve(
"lib/${requirements.targetTriple}/cmake/${pkg.name}"
).apply { mkdirs() }
} else {
outputDirectory
}
val configFile = pkgDirectory.resolve("${pkg.name}Config.cmake")
for (dep in pkg.dependencies.sorted()) {
emitDependency(dep, configFile)
}
for (module in pkg.modules.sortedBy { it.name }) {
emitModule(pkg, module, requirements, configFile)
}
if (pkg.version != null) {
emitVersionFile(
pkg,
pkgDirectory.resolve("${pkg.name}ConfigVersion.cmake")
)
}
}
private fun emitDependency(dep: String, configFile: File) {
configFile.appendText(
"""
find_package($dep REQUIRED CONFIG)
""".trimIndent()
)
}
private fun emitModule(
pkg: Package,
module: Module,
requirements: PlatformDataInterface,
configFile: File
) {
val ldLibs =
module.linkLibsForPlatform(requirements)
.filterIsInstance<LibraryReference.Literal>().map { it.arg }
val localReferences =
module.linkLibsForPlatform(requirements)
.filterIsInstance<LibraryReference.Local>()
.map { "${pkg.name}::${it.name}" }
val externalReferences =
module.linkLibsForPlatform(requirements)
.filterIsInstance<LibraryReference.External>()
.map { "${it.pkg}::${it.module}" }
// TODO: Can we be more careful about ordering?
val libraries =
(ldLibs + localReferences + externalReferences).joinToString(";")
val target = "${pkg.name}::${module.name}"
if (module.isHeaderOnly) {
// No check for header-only modules without headers because there's
// no point in those existing, so an error is fine.
val escapedHeaders = module.includePath.sanitize()
configFile.appendText(
"""
if(NOT TARGET $target)
add_library($target INTERFACE IMPORTED)
set_target_properties($target PROPERTIES
INTERFACE_INCLUDE_DIRECTORIES "$escapedHeaders"
INTERFACE_LINK_LIBRARIES "$libraries"
)
endif()
""".trimIndent()
)
} else {
try {
val prebuilt = module.getLibraryFor(requirements)
val escapedLibrary = prebuilt.path.sanitize()
val escapedHeaders = prebuilt.includePath.sanitize()
val prebuiltType: String =
when (val extension = prebuilt.path.toFile().extension) {
"so" -> "SHARED"
"a" -> "STATIC"
else -> throw RuntimeException(
"Unrecognized library extension: $extension"
)
}
configFile.appendText(
"""
if(NOT TARGET $target)
add_library($target $prebuiltType IMPORTED)
set_target_properties($target PROPERTIES
IMPORTED_LOCATION "$escapedLibrary"
""".trimIndent())
// Handle cases where an empty include directory is not
// preserved. This happens when we're called by AGP.
// https://issuetracker.google.com/178594838
if (prebuilt.includePath.directoryNotEmpty()) {
configFile.appendText(
" INTERFACE_INCLUDE_DIRECTORIES \"$escapedHeaders\"\n"
)
}
configFile.appendText(
"""
INTERFACE_LINK_LIBRARIES "$libraries"
)
endif()
""".trimIndent()
)
} catch (ex: NoMatchingLibraryException) {
// Libraries that do not match our requirements should be logged
// and ignored.
System.err.println(ex)
}
}
}
private fun emitVersionFile(pkg: Package, versionFile: File) {
// https://cmake.org/cmake/help/latest/manual/cmake-packages.7.html#package-version-file
// Based on example from
// https://gitlab.kitware.com/cmake/community/wikis/doc/tutorials/How-to-create-a-ProjectConfig.cmake-file
versionFile.writeText(
"""
set(PACKAGE_VERSION ${pkg.version})
if("${'$'}{PACKAGE_VERSION}" VERSION_LESS "${'$'}{PACKAGE_FIND_VERSION}")
set(PACKAGE_VERSION_COMPATIBLE FALSE)
else()
set(PACKAGE_VERSION_COMPATIBLE TRUE)
if("${'$'}{PACKAGE_VERSION}" VERSION_EQUAL "${'$'}{PACKAGE_FIND_VERSION}")
set(PACKAGE_VERSION_EXACT TRUE)
endif()
endif()
""".trimIndent()
)
}
}