Cmake 如何在/include和/src目录下自动移动*.pb.h和*.pb.h?
我正在开发一个使用Google协议缓冲区(Cmake 如何在/include和/src目录下自动移动*.pb.h和*.pb.h?,cmake,protocol-buffers,Cmake,Protocol Buffers,我正在开发一个使用Google协议缓冲区(protobuf)和CMake的库。该项目具有以下目录树 MyProject/ MyProject/include/myproject/ MyProject/include/myproject/some_classes.h MyProject/src/ MyProject/src/some_classes.cc MyProject/src/foo.proto MyProject/CMakeList.txt CMakeList.txt有以下几行代码来生成
protobuf
)和CMake的库。该项目具有以下目录树
MyProject/
MyProject/include/myproject/
MyProject/include/myproject/some_classes.h
MyProject/src/
MyProject/src/some_classes.cc
MyProject/src/foo.proto
MyProject/CMakeList.txt
CMakeList.txt
有以下几行代码来生成protobuf源文件和头文件
include_directories(${libCHEC_SOURCE_DIR}/include)
aux_source_directory(${CMAKE_CURRENT_SOURCE_DIR}/src SOURCES)
find_package(Protobuf REQUIRED)
file(GLOB ProtoFiles "${CMAKE_CURRENT_SOURCE_DIR}/src/*.proto")
protobuf_generate_cpp(ProtoSources ProtoHeaders ${ProtoFiles})
list(APPEND EXTLIBS ${PROTOBUF_LIBRARIES})
add_library(MyLibrary SHARED ${SOURCES} ${ProtoSources})
target_link_libraries(MyLibrary ${EXTLIBS})
当我执行cmake
时,foo.pb.h
和foo.pb.cc
在构建目录下生成(即我执行cmake
的目录)。看起来这是默认行为。但是我想把foo.pb.h
和foo.pb.cc
分别放在include/myproject
和src
目录下
如何更改protoc生成的文件的位置?我严格建议不要将生成的文件放在源代码树中
CMake花了很多精力来分离构建树和源树。迫使它放弃这种分离有几个缺点。其中最突出的一个事实是,版本控制将必须处理源代码树中未版本化的生成文件,而且可能不再可能有多个针对共享同一源代码树的不同体系结构的构建
更好的方法是将文件保存在二叉树中,并相应地调整
target\u include\u目录。使用从二叉树生成的文件作为源代码并不丢脸,所以不要犹豫。我添加了MyProject/misc/myprotobuf.cmake
,它有一个修改版本的PROTOBUF\u GENERAGE\u CPP
function(MY_PROTOBUF_GENERATE_CPP PATH SRCS HDRS)
if(NOT ARGN)
message(SEND_ERROR "Error: PROTOBUF_GENERATE_CPP() called without any proto files")
return()
endif()
if(PROTOBUF_GENERATE_CPP_APPEND_PATH)
# Create an include path for each file specified
foreach(FIL ${ARGN})
get_filename_component(ABS_FIL ${FIL} ABSOLUTE)
get_filename_component(ABS_PATH ${ABS_FIL} PATH)
list(FIND _protobuf_include_path ${ABS_PATH} _contains_already)
if(${_contains_already} EQUAL -1)
list(APPEND _protobuf_include_path -I ${ABS_PATH})
endif()
endforeach()
else()
set(_protobuf_include_path -I ${CMAKE_CURRENT_SOURCE_DIR})
endif()
if(DEFINED PROTOBUF_IMPORT_DIRS)
foreach(DIR ${PROTOBUF_IMPORT_DIRS})
get_filename_component(ABS_PATH ${DIR} ABSOLUTE)
list(FIND _protobuf_include_path ${ABS_PATH} _contains_already)
if(${_contains_already} EQUAL -1)
list(APPEND _protobuf_include_path -I ${ABS_PATH})
endif()
endforeach()
endif()
set(${SRCS})
set(${HDRS})
foreach(FIL ${ARGN})
get_filename_component(ABS_FIL ${FIL} ABSOLUTE)
get_filename_component(FIL_WE ${FIL} NAME_WE)
list(APPEND ${SRCS} "${CMAKE_CURRENT_BINARY_DIR}/${PATH}/${FIL_WE}.pb.cc")
list(APPEND ${HDRS} "${CMAKE_CURRENT_BINARY_DIR}/${PATH}/${FIL_WE}.pb.h")
execute_process(COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_CURRENT_BINARY_DIR}/${PATH})
add_custom_command(
OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/${PATH}/${FIL_WE}.pb.cc"
"${CMAKE_CURRENT_BINARY_DIR}/${PATH}/${FIL_WE}.pb.h"
COMMAND ${PROTOBUF_PROTOC_EXECUTABLE}
ARGS --cpp_out ${CMAKE_CURRENT_BINARY_DIR}/${PATH} ${_protobuf_include_path} ${ABS_FIL}
DEPENDS ${ABS_FIL}
COMMENT "Running C++ protocol buffer compiler on ${FIL}"
VERBATIM )
endforeach()
set_source_files_properties(${${SRCS}} ${${HDRS}} PROPERTIES GENERATED TRUE)
set(${SRCS} ${${SRCS}} PARENT_SCOPE)
set(${HDRS} ${${HDRS}} PARENT_SCOPE)
endfunction()
MyProject/CMakeLists.txt
现在有以下两行
include(${CMAKE_CURRENT_SOURCE_DIR}/misc/myprotobuf.cmake)
file(GLOB ProtoFiles "${CMAKE_CURRENT_SOURCE_DIR}/misc/*.proto")
my_protobuf_generate_cpp(generated_files/myproject ProtoSources ProtoHeaders ${ProtoFiles})
include_directories(${CMAKE_CURRENT_BINARY_DIR}/generated_files)
您可以通过以特定方式修改源目录和CmakeList来操纵生成的protobuf源的目录结构
一个例子:
MyProject/
MyProject/src
MyProject/src/CMakeLists.txt (1)
MyProject/src/ProtoProject/CMakeLists.txt (2)
MyProject/src/ProtoProject/MyProject/foo.proto
CMakeLists.txt(1):
CMakeLists.txt(2):
为什么这样做
每次调用add_subdirectory()
都会向$CMAKE_CURRENT_BINARY_目录
变量添加一个目录级别。生成的文件将在MyProject/src/ProtoProject/MyProject/foo.pb.h
处结束,但您的包含目录将是MyProject/src/ProtoProject
,因此您可以将文件作为MyProject/foo.pb.h
Hi@comicsanss感谢您的帮助。我看不到你写的任何“缺点”。当我在这个项目中使用Subversion时,将foo.pb.h和foo.pb.cc放入svn:ignore
可以很容易地阻止它们添加到存储库中。此外,我们从不在其中使用多个目标。由于我希望在单个目录中安装所有头文件,例如/usr/local/include/myproject
,如果我能在MyProject/include/MyProject
@AkiraOkumura下生成foo.pb.h
,那就太好了。是什么阻止了您将生成的头从二进制目录添加到安装集中?我想把\include“myproject/foo.pb.h
在其他头文件中,因为所有头文件稍后都安装在/include/myproject
下。@AkiraOkumura仍能工作。您只需在构建和安装树中维护正确的目录结构即可。请注意,foot.pb.h
始终在CMAKE\u CURRENT\u build\u DIR
中生成。因此,我不能在项目的其他标题中使用#include“myproject/foo.pb.h”
。
add_subdirectory(MyProject)
# generated headers
target_include_directories(ProtoProject PUBLIC ${CMAKE_CURRENT_BINARY_DIR})
set(proto_files "foo.proto")
protobuf_generate_cpp(PROTO_SRCS PROTO_HDRS ${proto_files})
add_library(ProtoProject STATIC ${PROTO_SRCS} ${PROTO_HDRS} ${proto_files})