使用 shell 脚本调用 CMake 编译 C++ 程序

使用效果

在 Ubuntu 中使用 VS Code 编写 C++ 程序时，经常要用 CMake 进行编译。此时可以创建一个 shell 脚本来进行编译，只需要一条指令 runcmake ，即可自动完成多种操作，包括创建 build 文件夹，编译生成可执行文件，运行可执行文件等，降低手动输入的工作量。
实际使用的效果图如下：

1. runcmake 源码

编写一个 shell 脚本，并保存为 runcmake ，注意不需要写文件后缀名。

runcmake 的源码如下：

#!/bin/bash
# 该程序的主要作用，是自动使用 CMake 对 C++ 程序进行编译，具体有如下 2 种用法：
# 1. 终端运行 runcmake ，会创建可执行文件，并直接运行这个可执行文件。
# 2. 终端运行 runcmake install ，进行安装，即它会执行 make install 命令，用于安装库等场景。
# 执行该程序时，先给 runcmake 加上可执行权限，再运行 runcmake 。运行时必须是在 CMakeLists.txt 所在的文件夹。
# 版本：2.0      日期：2025-05-02      作者：drin201312@163.com

function exit_on_error() {
  # 如果上面的运行结果有问题，则终止运行。
  if [ $? -ne 0 ]; then
    echo -e "exited on error\n"
    exit
  fi
}

# 从 CMakeLists.txt 找出可执行程序名字，注意 add_executable 前面不能有空格，必须位于行首，否则会出错。
# awk 先找出 add_executable 这一行，然后用空格和 ( 进行分割，最后输出第 2 个元素。
binary_executable=$(awk -F "[( ]" '/^add_executable/{print $2}' CMakeLists.txt)

echo -e "\npwd"
pwd

# 先删除 build 文件夹，以免 CMake 的缓存文件导致编译错误。
echo -e "\nsudo rm -r build"
sudo rm -r build

echo -e "\nmkdir build"
mkdir build 
exit_on_error

echo -e "\ncd build"
cd build

echo -e "\ncmake .."
cmake .. 
exit_on_error

echo -e "\nmake -j$(nproc)"
make -j$(nproc)  # 使用多核 CPU 进行编译，即多进程并发，以加快速度。
# make   # 如果内存不够无法使用多进程，则改用这一行进行编译。
exit_on_error

if [ "$1"x = installx ]; then
  echo -e "\nsudo make install"
  sudo make install  # 执行安装的命令 

else
  # 把可执行程序移动到 build 的上一层文件夹
  echo -e "\nmv $binary_executable .."
  mv $binary_executable ..

  echo -e "\ncd .."
  cd ..

  echo -e "\nruning binary executable: $binary_executable\n"
  # 运行可执行文件时，尽量在同一个文件夹下运行。以确保使用相对路径生成的文件，
  # 如 foo.txt 能够和可执行文件保持在同一个文件夹下。
  ./$binary_executable  

fi

2. 使用方法

使用前需要进行下面 2 个设置。

1. 加上可执行权限，终端运行如下命令：

sudo chmod 777 runcmake

2. 把脚本放到可执行文件的文件夹 /usr/local/bin ，这样才能在其它任意位置调用该脚本。

sudo mv runcmake /usr/local/bin

设置好就可以使用了。使用时在 CMakeLists.txt 所在的文件夹，终端运行命令即可。具体有如下 2 种用法：

1. 终端运行 runcmake ，会创建可执行文件，并直接运行这个可执行文件。
2. 终端运行 runcmake install ，进行安装，即它会执行 make install 命令，用于安装库等场景。

—————————— 本文结束 ——————————