成为CMake砖家(2): macOS创建CMake本地文档的app

大家好，我是白鱼。使用 CMake 的小伙伴，有的是在 Windows 上，还有的是在 macOS 上。之前咱们讲了 windows 上查看 cmake 本地 html 文档的方式，这篇讲讲 macOS 上查看 cmake 本地 html 文档的方法。

1. 问题描述

当使用 CMake 做一些进阶的事情时，需要查看文档。之前尝试过一些方案，都不理想。

举例： CMAKE_INSTALL_PREFIX 变量是我熟悉的，但它是否被设定为了默认值，文档里有专门的描述，但我现在忘记了具体写法要查看文档。或者 add_library() 的某个特性是 cmake 某个版本引入的，我忘记了，需要查询确认。

尝试过的方案：

cmake 官方在线文档，有时候网络不好打不开
Dash 印象中是收费的，于是尝试了 ZealDocs
Zeal Docs 和 Dash 的 CMake 文档是共用的，全文检索关键字找不到，搜索框也有一些编辑方面的小问题

2. 解决方案

类似于 ubuntu 上安装 matlab/clion/smartgit 等软件后，没提供 .desktop 文件的情况，用户可以手动创建 xxx.desktop 文件，从而在应用中可以搜索到。

在 macOS 上，创建 /Application/CMakeDocs.app 目录，里面最关键的是 Info.plist 文件，和 .desktop 文件作用类似。

首先通过 .dmg 文件安装 CMake, 会安装到 /Application/CMake.app 目录。提供的 html 文件、 icns 文件都被 CMakeDocs.app 依赖。

然后执行 CMakeDoc.sh 文件，内容如下：

#!/bin/bash

# This script generates /Application/CMakeDoc.app, which can be searched in launchpad
# You should have CMake installed in /Application/CMake.app already

mkdir -p ~/Applications/CMakeDoc.app/Contents/MacOS  
mkdir -p ~/Applications/CMakeDoc.app/Contents/Resources  

cat <<EOF > ~/Applications/CMakeDoc.app/Contents/MacOS/CMakeDoc  
#!/bin/bash  
open /Applications/CMake.app/Contents/doc/cmake/html/index.html
EOF

chmod +x ~/Applications/CMakeDoc.app/Contents/MacOS/CMakeDoc  


cat <<EOF > ~/Applications/CMakeDoc.app/Contents/Info.plist  
<?xml version="1.0" encoding="UTF-8"?>  
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">  
<plist version="1.0">  
<dict>  
    <key>CFBundleExecutable</key>  
    <string>CMakeDoc</string>  
    <key>CFBundleIdentifier</key>  
    <string>org.cmake.doc</string>  
    <key>CFBundleName</key>  
    <string>CMakeDoc</string>  
    <key>CFBundleVersion</key>  
    <string>1.0</string>  
    <key>CFBundlePackageType</key>  
    <string>APPL</string>  
    <key>CFBundleIconFile</key>
    <string>CMakeSetup.icns</string>
</dict>  
</plist>  
EOF

cp /Applications/CMake.app/Contents/Resources/CMakeSetup.icns ~/Applications/CMakeDoc.app/Contents/Resources/  
mv ~/Applications/CMakeDoc.app /Applications/