ROS 功能包之间的头文件包含找不到文件问题

参考

CMakeList 生成预编译文件 在评论区看到答案 :)

C/C++程序编译链接过程

环境

系统：ubuntu20

编译器：gcc

问题

功能包 ProjA 使用了另一个功能包 ProjB 中定义的类。ProjB 单独编译是正常的，但是 ProjA 编译时候报错，显示有 ProjB 的头文件找不到。

背景

项目中使用第三方的代码，于是增加了中间类作适配器设计，将第三方代码接入到项目中。

安装目录结构工具：

sudo apt install tree

在 ProjA 工程目录输入指令 tree 查看目录结构（具体目录结构被修改过），大概如下：

.
├── CMakeLists.txt
├── include
│   └── ProjA
│       └── controller_server.h
├── LICENSE
├── package.xml
├── README.md
└── src
    └── controller_server.cpp

controller_server.cpp 是发生错误的最初位置，也是在该文件引用了 ProjB 的头文件。

在 ProjB 工程目录输入指令 tree 查看目录结构，大概如下：

.
├── 3rd_party
│   └── dubins
│       ├── include
│       │   └── dubins.h
│       └── src
│           └── dubins.c
├── CMakeLists.txt
├── include
│   └── ProjB
│       └── local_planner
│           ├── dubins.h
│           └── local_planner.h
├── LICENSE
├── package.xml
├── README.md
├── rviz
│   └── rviz.rviz
└── src
    └── local_planner
        ├── dubins.cpp
        └── local_planner.cpp

其中 3rd_party 存放第三方代码，3rd_party/dubins 是本次使用到的代码。

include 和 src 目录中的 dubins 是新增的适配器类，用于封装第三方代码。

C/C++ 程序编译步骤

1. 预编译处理：对源文件的伪指令(以#开头的指令)和特殊符号进行处理。

2. 编译：语法分析，产生中间文件。

3. 优化：对代码逻辑进行梳理微调，以降低程序运行的 cpu 和内存开销。

4. 汇编：翻译为机器语言，也就是二进制文件。

5. 链接：将汇编文件链接起来，让它们能找到彼此需要的变量，函数符号等，得到可执行文件。

预编译文件检查

问题是头文件找不到，那么就是预编译期间出现的问题。先看看 ProjA 的预编译文件情况。

头文件的包含是在预编译阶段进行的，其实就是将源文件中 #include <xxx.h> 部分代码替换为 xxx.h 的文件内容。xxx.c 源文件经过预编译处理后得到 xxx.i 文件，xxx.c++ 源文件经过预编译处理后得到 xxx.ii 文件。

ProjA 预编译文件检查

在 ProjA 的 CMakeList.txt 中增加下面的指令，可以在 build 文件夹生成相应的预编译文件。

set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -save-temps=obj")

重新编译功能包 A，依旧报头文件找不到的错误（具体路径被修改过）。错误如下：

[100%] Building CXX object ProjA/CMakeFiles/ProjA.dir/src/controller_server.cpp.o
In file included from ProjB/include/ProjB/local_planner/local_planner.h:26,
                 from ProjA/include/ProjA/controller_server.h:28,
                 from ProjA/src/controller_server.cpp:1:
ProjB/include/ProjB/local_planner/dubins.h:12:10: fatal error: dubins/include/dubins.h: No such file or directory
   12 | #include <dubins/include/dubins.h>
      |          ^~~~~~~~~~~~~~~~~~~~~~~~~
compilation terminated.
make[2]: *** [ProjA/CMakeFiles/ProjA.dir/build.make:63: ProjA/CMakeFiles/ProjA.dir/src/controller_server.cpp.o] Error 1
make[1]: *** [CMakeFiles/Makefile2:17534: ProjA/CMakeFiles/ProjA.dir/all] Error 2
make: *** [Makefile:141: all] Error 2
Invoking "make -j8" failed

错误提示在编译 controller_server.cpp.o 文件时候，由 controller_server.cpp 的第 1 行 ---> controller_server.h 的第 28 行 ---> local_planner.h 的第 26 行 ---> .../ProjB/local_planner/dubins.h 的第 12 行发生错误，找不到 <dubins/include/dubins.h> 头文件。

在工作空间的 build 文件夹中搜索报错的预编译文件 controller_server.cpp.ii。

打开 controller_server.cpp.ii 文件，搜索 “dubins/include/dubins.h”，显示找不到字符。

搜索 ProjB/local_planner/dubins.h，直接跳转到了文件底部，说明在对该 dubin.h 文件进行预编译的时候发生了错误终止了处理。

ProjB 预编译文件检查

然而功能包 B 的编译是成功的，在功能包 B 的 CMakeList.txt 中添加生成预编译文件指令，重新编译功能包 B。

ProjB 中是 ProjB/src/local_planner/local_planner.cpp 引用了 <dubins/include/dubins.h>，打开 local_planner.cpp.ii 文件，搜索 “dubins/include/dubins.h”，可以得到 8 处匹配字符，说明ProjB 的源文件头文件包含是正常的。

CMakeList.txt 配置检查

回到 CMakeList.txt 的头文件路径配置部分看看。

头文件路径配置就是在预编译过程的头文件包含过程中，CMake 去搜索的存放头文件的目录。

ProjB 的头文件路径配置如下：

include_directories(
  include/ProjB
  3rd_party
  ${catkin_INCLUDE_DIRS}
  ${EIGEN3_INCLUDE_DIRS}
  ${PCL_INCLUDE_DIRS} 
)

• include/ProjB：项目（本 CMakeList.txt 所在路径）的 include/ProjB 目录。

• 3rd_party：项目的 3rd_party 目录。

• ${catkin_INCLUDE_DIRS}：该变量保存了其他头文件路径，通常是会被其他功能包使用到的头文件。

• ${EIGEN3_INCLUDE_DIRS}：eigen3 库的头文件路径。

• ${PCL_INCLUDE_DIRS}：pcl 库的头文件路径。

<dubins/include/dubins.h> 文件就是在功能包 B 的 3rd_party 目录中，因此 ProjB 编译是能够找到该头文件的。

看看功能包 A 的头文件路径配置：

include_directories(
  include
  ${catkin_INCLUDE_DIRS}
)

可以看到功能包 A 只会在自己功能包的 include 路径和 ${catkin_INCLUDE_DIRS} 变量中的路径去寻找头文件。既然编译失败，那就是说 ${catkin_INCLUDE_DIRS} 变量中没有包含 <dubins/include/dubins.h> 文件所在目录。只要将 ProjB 的 3rd_party 目录添加到 ${catkin_INCLUDE_DIRS} 变量中即可解决问题！

在功能包 B 的 CMakeList.txt 中的 catkin_package() 部分

###################################
## catkin specific configuration ##
###################################
## The catkin_package macro generates cmake config files for your package
## Declare things to be passed to dependent projects
## INCLUDE_DIRS: uncomment this if your package contains header files
## LIBRARIES: libraries you create in this project that dependent projects also need
## CATKIN_DEPENDS: catkin_packages dependent projects also need
## DEPENDS: system dependencies of this project that dependent projects also need
catkin_package(
   INCLUDE_DIRS include include/ProjB
   LIBRARIES ltg_lib mmdd local_planner
#  CATKIN_DEPENDS geometry_msgs roscpp rospy std_msgs
#  DEPENDS system_lib
)

catkin_package() 的注释说明了该宏会生成相关 cmake 配置文件，提供给需要依赖的项目。其中 INCLUDE_DIRS 将路径保存到 ${catkin_INCLUDE_DIRS} 变量中供其他功能包搜索头文件使用。给 INCLUDE_DIRS 添加 3rd_party 目录，如下：

catkin_package(
   INCLUDE_DIRS include include/ProjB 3rd_party
   LIBRARIES ltg_lib mmdd local_planner
#  CATKIN_DEPENDS geometry_msgs roscpp rospy std_msgs
#  DEPENDS system_lib
)

重新编译功能包 B，再编译功能包 A，此时已经没有报错了，再打开 controller_server.cpp.ii 文件搜索 dubins/include/dubins.h，可以得到 8 处匹配字符。

功能包之间头文件包含找不到的问题解决！