CMake教程——如何编写FindXXX.cmake

先解答几个关于FindXXX.cmake的常见问题

问:当第三方库并没有采用CMake组织代码并且仅仅提供了编译好当birary库时候为了让find_package(xxx)找到它怎么办?
答:得自己写FindXXX.cmake

问:FindXXX.cmake文件放哪里才能让find_package()识别到呢?
答:将写好的FindXXX.cmake放在cmake软件的Modules目录下即可。

问:cmake软件的Modules目录在哪里?
答:如果是linux下通过apt安装的cmake,则Modules目录一般为/usr/share/cmake-3.xx/Modules,如果你的cmake是基于源码编译安装的,那么Modules目录在/usr/local/cmake里。
如果希望所有的cmake配置跟随项目源码走,也可以将FindXXX.cmake放在指定的目录,比如当前项目的cmake目录下,随后需要在项目的CMakeList.txt里告知FindXXX.cmake所在目录,即:list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/cmake")

下面进入正题——如何编写FindXXX.cmake

1. 以单个头文件和单个库文件为例

# FindLogger
# --------
#
# Find the Logger libraries
#
# Result Variables
# ^^^^^^^^^^^^^^^^
#
# The following variables will be defined:
#
# ``Logger_FOUND`` True if Logger found on the local system
#
# ``Logger_INCLUDE_DIRS`` Location of Logger header files
#
# ``Logger_LIBRARY_DIRS`` Location of Logger libraries
#
# ``Logger_LIBRARIES`` List of the Logger libraries found
#

include(${CMAKE_ROOT}/Modules/FindPackageHandleStandardArgs.cmake)
include(${CMAKE_ROOT}/Modules/SelectLibraryConfigurations.cmake)
include(${CMAKE_ROOT}/Modules/CMakeFindDependencyMacro.cmake)

#include(FindPackageHandleStandardArgs)

find_package(PkgConfig)
set(Baumer_FOUND TRUR)
set(Logger_VERSION "1.0.0")

if (DEFINED ENV{USR_LOCAL})
    set(USR_LOCAL "$ENV{USR_LOCAL}" CACHE STRING "")
else()
    set(USR_LOCAL /usr/local CACHE STRING "")
endif()

set(Logger_INCLUDE_DIRS ${USR_LOCAL}/include/logger.h CACHE STRING "")

set(Logger_LIBRARY_DIRS ${USR_LOCAL}/lib CACHE STRING "")
set(Logger_LIBRARIES ${USR_LOCAL}/lib/logger.so CACHE STRING "")

find_package_handle_standard_args(Logger REQUIRED_VARS Logger_LIBRARIES Logger_LIBRARY_DIRS Logger_INCLUDE_DIRS)
mark_as_advanced(Logger_INCLUDE_DIR Logger_LIBRARY)

2. 以多个头文件和多个库文件为例

# FindBaumer
# --------
#
# Find the Baumer libraries
#
# Result Variables
# ^^^^^^^^^^^^^^^^
#
# The following variables will be defined:
#
# ``Baumer_FOUND`` True if Baumer found on the local system
#
# ``Baumer_INCLUDE_DIRS`` Location of Baumer header files
#
# ``Baumer_LIBRARY_DIRS`` Location of Baumer libraries
#
# ``Baumer_LIBRARIES`` List of the Baumer libraries found
#

include(${CMAKE_ROOT}/Modules/FindPackageHandleStandardArgs.cmake)
include(${CMAKE_ROOT}/Modules/SelectLibraryConfigurations.cmake)
include(${CMAKE_ROOT}/Modules/CMakeFindDependencyMacro.cmake)

find_package(PkgConfig)
set(Baumer_FOUND TRUR)
set(Baumer_VERSION "1.0.0")

if (DEFINED ENV{VCPKG_ROOT} AND DEFINED ENV{VCPKG_DEFAULT_TRIPLET})
    set(Baumer_ROOT_DIR "$ENV{VCPKG_ROOT}/installed/$ENV{VCPKG_DEFAULT_TRIPLET}" CACHE STRING "")
endif()

if (DEFINED ENV{CMAKE_PREFIX_PATH})
  set(Baumer_ROOT_DIR $ENV{CMAKE_PREFIX_PATH})
endif()

# ---------------- find header files ----------------
# define macro func to find headers
macro(Baumer_FIND_INCLUDE varname foldername headername)
  if(NOT Baumer_${varname}_INCLUDE_DIR)
    find_path(
      Baumer_${varname}_INCLUDE_DIR
      NAMES ${foldername}/${headername}
      PATHS ${Baumer_ROOT_DIR}/include /usr/local/include)
    list(APPEND Baumer_INCLUDE_DIRS ${Baumer_${varname}_INCLUDE_DIR})
  endif()
endmacro(Baumer_FIND_INCLUDE)

# call macro func to find headers
Baumer_FIND_INCLUDE(bgapi2_ext            bgapi2_ext      bgapi2_ext.h)
Baumer_FIND_INCLUDE(bgapi2_ext_addons     bgapi2_ext      bgapi2_ext_addons.h)
Baumer_FIND_INCLUDE(bgapi2_ext_sc         bgapi2_ext_sc   bgapi2_ext_sc.h)
Baumer_FIND_INCLUDE(bgapi2_def            bgapi2_genicam  bgapi2_def.h)
Baumer_FIND_INCLUDE(bgapi2_featurenames   bgapi2_genicam  bgapi2_featurenames.h)
Baumer_FIND_INCLUDE(bgapi2_genicam        bgapi2_genicam  bgapi2_genicam.hpp)

if (UNIX)
  Baumer_FIND_INCLUDE(bgapi2_genicam      bgapi2_genicam  bgapi2_genicam.h)
  Baumer_FIND_INCLUDE(bgapi2_types        bgapi2_genicam  bgapi2_types.h)
endif()

set(Baumer_INCLUDE_DIRS ${Baumer_INCLUDE_DIRS} CACHE STRING "")
message("Baumer_INCLUDE_DIRS: " ${Baumer_INCLUDE_DIRS})

# ---------------- find library files----------------
# define macro func to find libs
macro(Baumer_FIND_LIBRARY libname)
  if(NOT Baumer_${varname}_LIBRARY)
     find_library(
       Baumer_${libname}_LIBRARY
       NAMES ${libname}
       PATHS ${Baumer_ROOT_DIR}/lib /usr/local/lib)
     get_filename_component(Baumer_${libname}_LIBRARY_DIR ${Baumer_${libname}_LIBRARY} DIRECTORY)
     list(APPEND Baumer_LIBRARY_DIRS ${Baumer_${libname}_LIBRARY_DIR})
     list(APPEND Baumer_LIBRARIES ${Baumer_${libname}_LIBRARY})
  endif()
endmacro(Baumer_FIND_LIBRARY)

# call macro func to find libs
if(WIN32)
    Baumer_FIND_LIBRARY(bgapi2_ext.lib)
    Baumer_FIND_LIBRARY(bgapi2_ext_sc.lib)
    Baumer_FIND_LIBRARY(bgapi2_genicam.lib)
elseif(UNIX)
    Baumer_FIND_LIBRARY(libbgapi2_ext.so)
    Baumer_FIND_LIBRARY(libbgapi2_ext_sc.so)
    Baumer_FIND_LIBRARY(libbgapi2_genicam.so)
    Baumer_FIND_LIBRARY(libbgapi2_gige.so)
    Baumer_FIND_LIBRARY(libbgapi2_img.so)
    Baumer_FIND_LIBRARY(libbgapi2_usb.so)
    Baumer_FIND_LIBRARY(libGCBase_gcc54_v3_2.so)
    Baumer_FIND_LIBRARY(libGenApi_gcc54_v3_2.so)
    Baumer_FIND_LIBRARY(libLog_gcc54_v3_2.so)
    Baumer_FIND_LIBRARY(liblog4cpp_gcc54_v3_2.so)
    Baumer_FIND_LIBRARY(libMathParser_gcc54_v3_2.so)
    Baumer_FIND_LIBRARY(libNodeMapData_gcc54_v3_2.so)
    Baumer_FIND_LIBRARY(libXmlParser_gcc54_v3_2.so)
endif(WIN32)

message("Baumer_LIBRARY_DIRS: " ${Baumer_LIBRARY_DIRS})
message("Baumer_LIBRARIES: " ${Baumer_LIBRARIES})

set(Baumer_LIBRARY_DIRS ${Baumer_LIBRARY_DIRS} CACHE STRING "")
set(Baumer_LIBRARIES ${Baumer_LIBRARIES} CACHE STRING "")

find_package_handle_standard_args(Baumer REQUIRED_VARS Baumer_LIBRARIES Baumer_LIBRARY_DIRS Baumer_INCLUDE_DIRS)
mark_as_advanced(Baumer_INCLUDE_DIRS Baumer_LIBRARIES)
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,284评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,115评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,614评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,671评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,699评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,562评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,309评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,223评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,668评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,859评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,981评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,705评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,310评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,904评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,023评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,146评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,933评论 2 355