CMake构建学习笔记24-使用通用脚本构建PROJ和GEOS

1. 通用脚本

在之前的文章《CMake构建学习笔记21-通用的CMake构建脚本》中我们创建了一个通用的cmake构建脚本cmake-build.ps1：

1. param(
2.     [string]$SourceLocalPath,
3.     [string]$BuildDir,
4.     [string]$Generator,
5.     [string]$InstallDir,
6.     [string]$SymbolDir,
7.     [string[]]$PdbFiles,
8.     [hashtable]$CMakeCacheVariables,
9.     [bool]$MultiConfig = $false  # 控制是否使用多配置类型
10. )
12. # 清除旧的构建目录
13. if (Test-Path $BuildDir) {
14.     Remove-Item -Path $BuildDir -Recurse -Force
15. }
16. New-Item -ItemType Directory -Path $BuildDir
18. # 构建CMake命令行参数
19. $CMakeArgs = @(
20.     "-B", "`"$BuildDir`"",
21.     "-G", "`"$Generator`"",
22.     "-A", "x64"
23. )
25. if ($MultiConfig) {
26.     $CMakeArgs += "-DCMAKE_CONFIGURATION_TYPES=RelWithDebInfo"
27. }
28. else {
29.     $CMakeArgs += "-DCMAKE_BUILD_TYPE=RelWithDebInfo"
30. }
32. $CMakeArgs += (
33.     "-DCMAKE_PREFIX_PATH=`"$InstallDir`"",
34.     "-DCMAKE_INSTALL_PREFIX=`"$InstallDir`""
35. )
37. # 添加额外的CMake缓存变量
38. foreach ($key in $CMakeCacheVariables.Keys) {
39.     $CMakeArgs += "-D$key=$($CMakeCacheVariables[$key])"
40. }
42. # 配置CMake
43. cmake $SourceLocalPath $CMakeArgs
45. # 构建阶段，指定构建类型
46. cmake --build $BuildDir --config RelWithDebInfo --parallel
48. # 安装阶段，指定构建类型和安装目标
49. cmake --build $BuildDir --config RelWithDebInfo --target install
51. # 复制符号库
52. foreach ($file in $PdbFiles) {  
53.     Write-Output $file
54.     if (Test-Path $file) {
55.         Copy-Item -Path $file -Destination $SymbolDir
56.     }
57.     else {
58.         Write-Output "Warning: PDB file not found: $file"
59.     }
60. }
62. # 清理构建目录
63. #Remove-Item -Path $BuildDir -Recurse -Force

复制代码

在《CMake构建学习笔记22-libxml2库的构建》这篇文章中使用这个脚本构建了libxml2库：

1. param(   
2.     [string]$Name = "libxml2-v2.14.4",
3.     [string]$SourceDir = "../Source",
4.     [string]$Generator,
5.     [string]$InstallDir,  
6.     [string]$SymbolDir
7. )
9. # 根据 $Name 动态构建路径
10. $zipFilePath = Join-Path -Path $SourceDir -ChildPath "$Name.zip"
11. $SourcePath = Join-Path -Path $SourceDir -ChildPath $Name
12. $BuildDir = Join-Path -Path "." -ChildPath $Name
14. # 解压ZIP文件到指定目录
15. if (!(Test-Path $SourcePath)) {
16.     Expand-Archive -LiteralPath $zipFilePath -DestinationPath $SourceDir -Force
17. }
19. # 检查目标文件是否存在，以判断是否安装
20. $DstFilePath = "$InstallDir/bin/libxml2.dll"
21. if (Test-Path $DstFilePath) {
22.     Write-Output "The current library has been installed."
23.     exit 1
24. }
26. # 复制符号库
27. $PdbFiles = @(
28.     "$BuildDir/RelWithDebInfo/libxml2.pdb"
29. )
31. # 额外构建参数
32. $CMakeCacheVariables = @{
33.     BUILD_SHARED_LIBS = "ON"
34.     LIBXML2_WITH_ZLIB = "ON"
35.     LIBXML2_WITH_ICONV = "ON"
36.     LIBXML2_WITH_HTTP = "ON"
37. }
39. # 调用通用构建脚本
40. . ./cmake-build.ps1 -SourceLocalPath $SourcePath `
41.     -BuildDir $BuildDir `
42.     -Generator $Generator `
43.     -InstallDir $InstallDir `
44.     -SymbolDir $SymbolDir `
45.     -PdbFiles $PdbFiles `
46.     -CMakeCacheVariables $CMakeCacheVariables `
47.     -MultiConfig $true

复制代码

因为提供了cmake构建方式的程序的构建行为是比较统一的，这个构建libxml2库的脚本可以进一步封装，形成一个通用的调用cmake-build.ps1构建程序的脚本。cmake-build.ps1只是包含了调用cmake执行构建的内容，但是其实整个构建过程需要做的事情很多，比如安装符号库、安装程序的依赖库等等，这些过程指的再封装一层构建的脚本。笔者封装的脚本build-common.ps1如下：

1. # build-library.ps1
2. param(
3.     [Parameter(Mandatory=$true)]
4.     [string]$Name,
6.     [Parameter(Mandatory=$true)]
7.     [string]$SourceDir,
9.     [Parameter(Mandatory=$true)]
10.     [string]$InstallDir,
12.     [string]$SymbolDir,
13.     [string]$Generator,
14.     [string]$MSBuild,
16.     [hashtable]$CMakeCacheVariables = @{},
17.     [string[]]$PdbFiles = @(),
18.     [string]$TargetDll,  # 用于判断是否已安装的 DLL 路径
19.     [bool]$MultiConfig = $false,  # 控制是否使用多配置类型
20.     [bool]$Force = $false,        # 是否强制重新构建
21.     [bool]$Cleanup = $true,        # 是否在构建完成后删除源码和构建目录   
22.     [string[]]$Librarys = @()  # 可选的依赖库数组，例如：-Librarys "zlib", "libjpeg"
23. )
25. # 动态路径构建
26. $zipFilePath = Join-Path -Path $SourceDir -ChildPath "$Name.zip"
27. $SourcePath = Join-Path -Path $SourceDir -ChildPath $Name
28. $BuildDir = Join-Path -Path "." -ChildPath $Name
30. # 检查是否已经安装（通过目标 DLL）
31. if (-not $Force -and $TargetDll -and (Test-Path $TargetDll)) {
32.     Write-Output "Library already installed: $TargetDll"
33.     exit 0
34. }
36. # 创建所有依赖库的容器
37. if ($Librarys.Count -gt 0) {
38.     . "./BuildRequired.ps1"
39.     BuildRequired -Librarys $Librarys
40. }
42. # 确保源码目录存在：解压 ZIP
43. if (!(Test-Path $SourcePath)) {
44.     if (!(Test-Path $zipFilePath)) {
45.         Write-Error "Archive not found: $zipFilePath"
46.         exit 1
47.     }
48.     Write-Output "Extracting $zipFilePath to $SourceDir..."
49.     Expand-Archive -LiteralPath $zipFilePath -DestinationPath $SourceDir -Force
50. }
52. # 如果是强制构建，且构建目录已存在，先删除旧的构建目录（确保干净构建）
53. if ($Force -and (Test-Path $BuildDir)) {
54.     Write-Output "Force mode enabled. Removing previous build directory: $BuildDir"
55.     Remove-Item $BuildDir -Recurse -Force -ErrorAction SilentlyContinue
56. }
58. # 遍历并添加前缀
59. $PdbFiles = $PdbFiles | ForEach-Object {
60.     Join-Path -Path $BuildDir -ChildPath $_
61. }
63. # 调用通用 CMake 构建脚本
64. Write-Output "Starting build for $Name..."
65. . ./cmake-build.ps1 -SourceLocalPath $SourcePath `
66.     -BuildDir $BuildDir `
67.     -Generator $Generator `
68.     -InstallDir $InstallDir `
69.     -SymbolDir $SymbolDir `
70.     -PdbFiles $PdbFiles `
71.     -CMakeCacheVariables $CMakeCacheVariables `
72.     -MultiConfig $MultiConfig
74. if ($LASTEXITCODE -ne 0) {
75.     Write-Error "Build failed for $Name."
76.     exit $LASTEXITCODE
77. }
79. # 构建成功后，根据 Cleanup 开关决定是否删除
80. if ($Cleanup) {
81.     Write-Output "Build succeeded. Cleaning up temporary directories..."
82.     if (Test-Path $SourcePath) {
83.         Remove-Item $SourcePath -Recurse -Force -ErrorAction SilentlyContinue
84.         Write-Output "Removed source directory: $SourcePath"
85.     }
86.     if (Test-Path $BuildDir) {
87.         Remove-Item $BuildDir -Recurse -Force -ErrorAction SilentlyContinue
88.         Write-Output "Removed build directory: $BuildDir"
89.     }
90. }
92. Write-Output "Build completed for $Name."

复制代码

这段脚本干了很多零碎的事情，但是对于一个完整的构建系统是必须的，比如判断是否需要强制构建、是否需要清理中间文件、安装程序的依赖库、安装符号库等等。另外，脚本的使用源代码其实是从压缩包解压出来的，这是因为笔者需要将源代码文件也值得放在git中进行管理，使用源代码压缩包更为方便。
2. 构建geos、proj

在实现了通用脚本build-common.ps1之后，构建程序就非常容易了，比如构建geos的脚本如下：

1. # geos.ps1
2. param(   
3.     [string]$Name = "geos-3.12.2",
4.     [string]$SourceDir = "../Source",
5.     [string]$Generator,
6.     [string]$InstallDir,  
7.     [string]$SymbolDir,  
8.     [bool]$Force = $false,        # 是否强制重新构建
9.     [bool]$Cleanup = $true        # 是否在构建完成后删除源码和构建目录
10. )
12. # 目标文件
13. $DllPath = "$InstallDir/bin/geos_c.dll"
15. # 依赖库数组
16. $Librarys = @()  
18. # 符号库文件
19. $PdbFiles = @(
20.     "bin/RelWithDebInfo/geos.pdb",
21.     "bin/RelWithDebInfo/geos_c.pdb"
22. )
24. # 额外构建参数
25. $CMakeCacheVariables = @{
26.     BUILD_TESTING = "OFF"
27. }
29. . ./build-common.ps1 -Name $Name `
30.     -SourceDir $SourceDir `
31.     -InstallDir $InstallDir `
32.     -SymbolDir $SymbolDir `
33.     -Generator $Generator `
34.     -TargetDll $DllPath `
35.     -PdbFiles $PdbFiles `
36.     -CMakeCacheVariables $CMakeCacheVariables `
37.     -MultiConfig $false `
38.     -Force $Force `
39.     -Cleanup $Cleanup `
40.     -Librarys $Librarys

复制代码

在这个脚本中，$SourceDir是源代码压缩包所在的文件夹，$Name是压缩包和压缩包内文件夹的名称。而构建proj的脚本如下：

1. # proj.ps1
2. param(   
3.     [string]$Name = "proj-9.4.1",
4.     [string]$SourceDir = "../Source",
5.     [string]$Generator,
6.     [string]$InstallDir,  
7.     [string]$SymbolDir,  
8.     [bool]$Force = $false,        # 是否强制重新构建
9.     [bool]$Cleanup = $true        # 是否在构建完成后删除源码和构建目录
10. )
12. # 目标文件
13. $DllPath = "$InstallDir/bin/proj_9_4.dll"
15. # 依赖库数组
16. $Librarys = @("nlohmann-json", "sqlite", "libtiff")
18. # 符号库文件
19. $PdbFiles = @(
20.     "bin/RelWithDebInfo/proj_9_4.pdb"      
21. )
23. # 额外构建参数
24. $CMakeCacheVariables = @{  
25.     BUILD_TESTING  = "OFF"
26.     ENABLE_CURL    = "OFF"
27.     BUILD_PROJSYNC = "OFF"
28. }
30. . ./build-common.ps1 -Name $Name `
31.     -SourceDir $SourceDir `
32.     -InstallDir $InstallDir `
33.     -SymbolDir $SymbolDir `
34.     -Generator $Generator `
35.     -TargetDll $DllPath `
36.     -PdbFiles $PdbFiles `
37.     -CMakeCacheVariables $CMakeCacheVariables `
38.     -MultiConfig $false `
39.     -Force $Force `
40.     -Cleanup $Cleanup `
41.     -Librarys $Librarys

复制代码

proj必须依赖于sqlite，具体的构建办法可参看《CMake构建学习笔记23-SQLite库的构建》。因为库程序本身就可能会依赖别的依赖库，所以在这里干脆实现了在构建库之前，也构建该库的依赖库，具体实在build-common.ps1中实现：

1. if ($Librarys.Count -gt 0) {
2.     . "./BuildRequired.ps1"
3.     BuildRequired -Librarys $Librarys
4. }

复制代码

BuildRequired.ps1也是个构建脚本，具体内容非常简单，就是调用依赖库的构建脚本：

1. function BuildRequired {
2.     param (
3.         [string[]]$Librarys
4.     )
6.     Write-Output "------------------------------------------------"  
7.     Write-Output "Start installing all required dependencies..."     
8.     foreach ($item in $Librarys) {
9.         Write-Output "Find the library named $item and start installing..."        
10.         # 动态构建脚本文件名并执行
11.         $BuildScript = "./$item.ps1";           
12.         & $BuildScript -Generator $Generator -InstallDir $InstallDir -SymbolDir $SymbolDir      
13.     }
14.     Write-Output "All required dependencies have been installed."   
15.     Write-Output "------------------------------------------------"  
16. }

复制代码

3. 其他

提供的脚本太多，笔者确实也觉得有点太绕了，反而不如前面的文章的脚本内容直观。不过这也符合编程的基本思路吧，开始的程序都很简单直接，后来随着功能的增多，慢慢就变得越来越抽象难以理解。以上脚本都收录在项目中，可参考使用。

来源：豆瓜网用户自行投稿发布，如果侵权，请联系站长删除