VSCODE调试RDKit内核 VSCODE调试RDKit内核的方法步骤(C++)
Zealseeker''s Blog 人气:0在研究 RDKit 的一些算法的时候，总希望能够“进入到代码中”看这些变量到底是什么，哪些代码块会被执行。可 RDKit 的编译比较复杂，如果是 Python 的部分，那么可以直接在 VSCode 中进行调试，记得在 launch 中设置 “justMyCode: false"，详见该问题。但如果想要调试 C++ 的部分，则就复杂很多，需要是用调试模式重新编译 RDKit 的源码。对于没有用过VSCode 编译 C++ 项目的小伙伴来说，这里有很多坑需要踩。
这个过程可以分为三个部分：安装 RDKit 所需环境，安装 VSCode 相应插件， 写调试代码编译
安装 RDKit 所需环境
源码安装 RDKit 一直是一件麻烦事，在过去我们不得不自己安装所需依赖，包括 Numpy，Boost，CMake 好在现在有了 Anaconda，让安装依赖变得省心很多。不过 Anaconda 也是把双刃剑，笔者遇到由于不同环境被 CMake 混乱使用导致一些潜在的问题，这个在最后提到。
我们可以参考 RDKit 官方文档进行环境安装 https://www.rdkit.org/docs/Install.html#how-to-build-from-source-with-conda
笔者使用 MacOS 测试，而且已经安装上了 Anaconda，于是想要创建一个新环境
conda create -n rdkit-dev conda activate rdkit-dev conda install numpy matplotlib conda install cmake cairo pillow eigen pkg-config conda install boost-cpp boost py-boost
笔者的 Anazonda 装在 /Users/zealseeker/opt/anaconda 中，所以该环境对应的是：
export PYROOT=/Users/zealseeker/opt/anaconda/env/rdkit-dev
另外注意到新建的环境用的是 python3.9，下面会用到。
然后下载源码到一个目录，笔者一般将所有用 git 下载的项目都放到 Documents/git 这个目录下。
cd /Users/zealseeker/Documents/git git clone https://github.com/rdkit/rdkit.git cd rdkit
到这一步已经可以了，但为了确保 RDKit 的安装一切会顺利，不妨先尝试编译一把。下面写 3.9 就是因为我们装的是 Python 3.9。与官方介绍不同的是，由于我们只需要调试里面的源代码，一些可有可无的功能就不需要激活了。按道理这这样配置编译会顺利通过（如果不并行，可能会编译一个小时…）
mkdir build cd build cmake -DPYTHON_INCLUDE_DIR=$PYROOT/include/python3.9 \ -DRDK_BUILD_AVALON_SUPPORT=OFF \ -DRDK_BUILD_CAIRO_SUPPORT=OFF \ -DRDK_BUILD_INCHI_SUPPORT=OFF \ .. make -j6 # 或着不并行，就用 make，但会慢很多
配置 VSCode 使其能 Debug
首先先要让 VSCode 支持 C++ 和 CMake，需要安装 C++ extension for VS Code 和 CMake Tools extension for VS Code 这两个插件。装完后需要进行一下配置，非常关键：
配置 Intellisense
虽然说这个不配置问题应该不大，但可能发现编辑器到处都是 problem 和波浪线，因为编辑器不知道应该去哪里找头文件，具体可参考这里。
以下是笔者的配置方法：在 .vscode 下创建 c_cpp_properties.json 文件，在里面添加：
{
"configurations": [
{
"name": "Mac",
"includePath": [
"${workspaceFolder}/Code", "/Users/zealseeker/opt/anaconda3/envs/rdkit-dev/include",
"/Users/zealseeker/opt/anaconda3/envs/rdkit-dev/include/python3.9",
"/Users/zealseeker/opt/anaconda3/envs/rdkit-dev/lib/python3.9/site-packages/numpy/core/include"
],
"defines": [],
"macFrameworkPath": [
"/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/System/Library/Frameworks"
],
"compilerPath": "/usr/bin/clang",
"cStandard": "c17",
"cppStandard": "c++17",
"intelliSenseMode": "macos-clang-x64"
}
],
"version": 4
}
主要配置的就是 includePath，这里需要加入 RDKit 源代码目录 （Code），Anaconda 的 include，Anaconda 的 Python 以及 Anaconda 的 Numpy。按理配置完后就能看到所有的错误和波浪号都消失了（可以随便打开个 cpp 文件看下是否有错误），如果还有错误，则需要具体看是什么。（Windows 貌似会复杂点，具体参考官方文档。）
配置 CMake
打开 CMake Tools extension for VS Code 这个插件的配置，点击设置按钮 - 扩展设置，就会进入到 VSCode 的设置界面并已经用 @ext:ms-vscode.cmake-tools 进行筛选了。然后看到有 User 和 Workspace 两个选择，前者可以认为是全局设置，后者为项目设置，我们选择后者。需要修改如下几个选项：
- Cmake: Cmake Path
由于我们用的是 Anaconda 环境下的 CMake，尤其如果像笔者这样通过新增环境得到的，可能 CMake 没有被加入到 Path 环境变量。检查的方法是在 terminal 里输入 which cmake，如果出现 cmake not found，则说明未加入到环境变量，需要手动配置，笔者的 CMake 在：/Users/zealseeker/opt/anaconda3/envs/rdkit-dev/bin/cmake，所以将该路径加入到配置中即可。而如果用的是 base 环境，则可能不需要配置，因为 CMake 已被加入到环境变量。如果发现该 CMake 并非之前在 Anaconda 装的那个，则仍然需要配置，否则可能会出现寻找错误的库的问题，详见最后一节。
- Cmake: Configure Args
这个对应执行 CMake 时的参数，即那些 -DXXXX=xxx 的内容，笔者为了图方便，仅配置了 Python
-DPYTHON_INCLUDE_DIR=/Users/zealseeker/opt/anaconda3/envs/rdkit-dev/include/python3.9
也可以根据需要将诸如 -DRDK_BUILD_CAIRO_SUPPORT=OFF 也加进去，尤其是如果后续发现编译时在 CAIRO 的地方出错了，则可以考虑禁用它。
小贴士，我们可以查看 .vscode 下是否有 settings.json 文件，并且该文件中是否有下面两个配置以判断是否配置成功。
{
"cmake.cmakePath": "/Users/zealseeker/opt/anaconda3/envs/rdkit-dev/bin/cmake",
"cmake.configureArgs": [
"-DPYTHON_INCLUDE_DIR=/Users/zealseeker/opt/anaconda3/envs/rdkit-dev/include/python3.9"
]
}
- 编译（可选）
全都配置完全，可以考虑先 Build 一下，看看有没有问题，按一下底部状态栏的 Build 按钮则会自动开始编译（需要不少时间）。如果未能编译完成，则需要检查其错误，看是哪里出了问题。
新建调试文件进行调试
笔者在根目录下创建了个 debug 文件夹，并在里面创建了 test.cpp 和 CMakeLists.txt 两个文件。test.cpp 自然是用于调试的文件，新建 main 函数，传入苯的 SMILES，将其转化成 RWMol 对象。非常简单的操作，仅仅是用于证明可以进入调试状态。
#include <GraphMol/SmilesParse/SmilesParse.h>
#include <GraphMol/Depictor/RDDepictor.h>
using namespace RDKit;
int main( int argc , char **argv ){
std::cout << "Importing benezene";
std::string smi = "c1ccccc1";
RWMol *newM;
newM = SmilesToMol(smi, 0, true);
return 0
}
CMakeLists 笔者是参考了 RDKit 的例子，个人感觉不是最好，毕竟原例子并不需要我们同时编译 RDKit 源码和测试代码，而是作为“已安装 RDKit 该如何调用其 C++ 接口”的例子，但笔者能力有限，只能很僵硬地照搬。路径基本写死，比如 library 在 $RDBASE/build/lib 里（因为只编译未安装，所以库都会在 build 文件夹下）
cmake_minimum_required( VERSION 3.5 )
project(RDKitSV)
set(RDBASE "/Users/zealseeker/Documents/git/rdkit")
set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${RDBASE}/Code/cmake/Modules")
set(CMAKE_CXX_STANDARD 14)
find_package( Boost COMPONENTS iostreams filesystem system)
include_directories ( ${RDBASE}/Code)
link_directories ( ${RDBASE}/build/lib )
set(RDKit_LIBS RDKitFileParsers RDKitSmilesParse RDKitDepictor
RDKitRDGeometryLib RDKitRDGeneral RDKitSubstructMatch RDKitSubgraphs
RDKitMolDraw2D RDKitGraphMol RDKitDistGeometry RDKitDistGeomHelpers
RDKitMolAlign RDKitOptimizer RDKitForceField RDKitForceFieldHelpers
RDKitAlignment RDKitForceField RDKitMolTransforms RDKitEigenSolvers )
find_package (Threads)
set(RDKit_THREAD_LIBS Threads::Threads)
set( LIBS ${RDKIT_LIBRARIES} Boost::iostreams ${RDKit_THREAD_LIBS} z )
include_directories(${RDKIT_INCLUDE_DIR})
add_executable( TestMol test.cpp )
target_link_libraries( TestMol ${LIBS} ${RDKit_LIBS})
然后在根目录的 CMakeLists.txt 里的最后面增加一行，将 debug 文件夹加入到编译内容中。
add_subdirectory(debug)
此时万事俱备，再次点击状态栏的 Build 按钮即可进行最终的编译，如果之前已经在配置好
VSCode-Cmake 后编译过一次，则这次会很快。编译完后，我们就可以调试了，调试前确定调试目标是否正确：在 Build 的右边分别有 debug（一个虫子）和 run（运行按钮），再右边是运行目标（launch target），要确定其为 TestMol，如果不是，则需要点击选择并输入 TestMol，它应该在 $rdkit/build/debug/TestMol。
最后点击小虫子即可进行调试，并记得加断点，确定可以正常调试。
Anaconda 环境问题
由于笔者电脑里有多个 Anaconda 环境导致 CMake 在寻找库的时候可能会找错地方，因此一定要检查 CMake 是否找对了，尽管理论上找错了问题也不大，但至少当最后编译或者运行时报错时可以有据可循。
笔者在 Anaconda 的 base 环境和 rdkit-dev 环境中都有 Boost，而除了 rdkit-dev 中有 CMake 外，自己也下载了个 CMake。笔者发现如果用自己下载的 CMake 编译，会导致其寻找的是 base 环境下的 Boost （因为 VSCode 编译时并不会激活 rdkit-dev 环境）。因此一定要使用 rdkit-dev 下的 CMake，即确保 Boost 所在 Anaconda 环境和 CMake 是同一个。
另外，笔者在编辑器中还看到下述问题，尽管其不影响编译与调试，但说明 CMake 在寻找库时仍然选择了错误的地方。可惜笔者一直不知如何修复，若有大神还请留言协助。该问题说明 CMake 在寻找 libcairo 时寻找的是 base 环境，而其他库在 rdkit-dev 和 build 中，他们之间可能存在相互依赖关系。解决方法应该是让 libcairo 去 rdkit-dev 中找，而不是 base 环境，可并不知道如何设置这个寻找路径优先级。
CMake Warning at Code/cmake/Modules/RDKitUtils.cmake:49 (add_library):Cannot generate a safe runtime search path for target MolDraw2D because
there is a cycle in the constraint graph:
dir 0 is [/Users/zealseeker/Documents/git/rdkit/build/lib]
dir 1 is [/Users/zealseeker/opt/anaconda3/envs/rdkit-dev/lib]
dir 2 must precede it due to runtime library [libcairo.dylib]
dir 2 is [/Users/zealseeker/opt/anaconda3/lib]
dir 0 must precede it due to runtime library [libRDKitChemReactions.1.dylib]
dir 1 must precede it due to runtime library [libboost_system.dylib]
Some of these libraries may not be found correctly.
参考资料
加载全部内容