FindProtobuf.cmake 13.4 KB
Newer Older
1 2 3 4
#.rst:
# FindProtobuf
# ------------
#
5
# Locate and configure the Google Protocol Buffers library.
6 7 8
#
# The following variables can be set and are optional:
#
9
# ``Protobuf_SRC_ROOT_FOLDER``
10 11
#   When compiling with MSVC, if this cache variable is set
#   the protobuf-default VS project build locations
12 13 14
#   (vsprojects/Debug and vsprojects/Release
#   or vsprojects/x64/Debug and vsprojects/x64/Release)
#   will be searched for libraries and binaries.
15
# ``Protobuf_IMPORT_DIRS``
16 17
#   List of additional directories to be searched for
#   imported .proto files.
18
# ``Protobuf_DEBUG``
19
#   Show debug messages.
20
#
21 22
# Defines the following variables:
#
23
# ``Protobuf_FOUND``
24 25
#   Found the Google Protocol Buffers library
#   (libprotobuf & header files)
26
# ``Protobuf_VERSION``
27
#   Version of package found.
28
# ``Protobuf_INCLUDE_DIRS``
29
#   Include directories for Google Protocol Buffers
30
# ``Protobuf_LIBRARIES``
31
#   The protobuf libraries
32
# ``Protobuf_PROTOC_LIBRARIES``
33
#   The protoc libraries
34
# ``Protobuf_LITE_LIBRARIES``
35
#   The protobuf-lite libraries
36
#
37
# The following cache variables are also available to set or use:
38
#
39
# ``Protobuf_LIBRARY``
40
#   The protobuf library
41
# ``Protobuf_PROTOC_LIBRARY``
42
#   The protoc library
43
# ``Protobuf_INCLUDE_DIR``
44
#   The include directory for protocol buffers
45
# ``Protobuf_PROTOC_EXECUTABLE``
46
#   The protoc compiler
47
# ``Protobuf_LIBRARY_DEBUG``
48
#   The protobuf library (debug)
49
# ``Protobuf_PROTOC_LIBRARY_DEBUG``
50
#   The protoc library (debug)
51
# ``Protobuf_LITE_LIBRARY``
52
#   The protobuf lite library
53
# ``Protobuf_LITE_LIBRARY_DEBUG``
54 55 56 57 58 59 60
#   The protobuf lite library (debug)
#
# Example:
#
# .. code-block:: cmake
#
#   find_package(Protobuf REQUIRED)
61
#   include_directories(${Protobuf_INCLUDE_DIRS})
62 63
#   include_directories(${CMAKE_CURRENT_BINARY_DIR})
#   protobuf_generate_cpp(PROTO_SRCS PROTO_HDRS foo.proto)
64
#   protobuf_generate_python(PROTO_PY foo.proto)
65
#   add_executable(bar bar.cc ${PROTO_SRCS} ${PROTO_HDRS})
66
#   target_link_libraries(bar ${Protobuf_LIBRARIES})
67 68
#
# .. note::
69 70 71
#   The ``protobuf_generate_cpp`` and ``protobuf_generate_python``
#   functions and :command:`add_executable` or :command:`add_library`
#   calls only work properly within the same directory.
72 73 74
#
# .. command:: protobuf_generate_cpp
#
75
#   Add custom commands to process ``.proto`` files to C++::
76 77 78 79 80 81 82 83 84
#
#     protobuf_generate_cpp (<SRCS> <HDRS> [<ARGN>...])
#
#   ``SRCS``
#     Variable to define with autogenerated source files
#   ``HDRS``
#     Variable to define with autogenerated header files
#   ``ARGN``
#     ``.proto`` files
85 86 87 88 89 90 91 92 93 94 95
#
# .. command:: protobuf_generate_python
#
#   Add custom commands to process ``.proto`` files to Python::
#
#     protobuf_generate_python (<PY> [<ARGN>...])
#
#   ``PY``
#     Variable to define with autogenerated Python files
#   ``ARGN``
#     ``.proto`` filess
96 97 98

#=============================================================================
# Copyright 2009 Kitware, Inc.
99
# Copyright 2009-2011 Philip Lowman <philip@yhbt.com>
100 101 102 103 104 105 106 107 108
# Copyright 2008 Esben Mose Hansen, Ange Optimization ApS
#
# Distributed under the OSI-approved BSD License (the "License");
# see accompanying file Copyright.txt for details.
#
# This software is distributed WITHOUT ANY WARRANTY; without even the
# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# See the License for more information.
#=============================================================================
109
# (To distribute this file outside of CMake, substitute the full
110
#  License text for the above reference.)
111

112 113 114 115
function(PROTOBUF_GENERATE_CPP SRCS HDRS)
  if(NOT ARGN)
    message(SEND_ERROR "Error: PROTOBUF_GENERATE_CPP() called without any proto files")
    return()
116
  endif()
117

118 119 120 121 122 123 124 125 126 127 128 129 130 131
  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()

132 133
  if(DEFINED Protobuf_IMPORT_DIRS)
    foreach(DIR ${Protobuf_IMPORT_DIRS})
134 135 136 137 138 139 140 141
      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()

142 143 144 145 146
  set(${SRCS})
  set(${HDRS})
  foreach(FIL ${ARGN})
    get_filename_component(ABS_FIL ${FIL} ABSOLUTE)
    get_filename_component(FIL_WE ${FIL} NAME_WE)
147

148 149 150 151 152 153
    list(APPEND ${SRCS} "${CMAKE_CURRENT_BINARY_DIR}/${FIL_WE}.pb.cc")
    list(APPEND ${HDRS} "${CMAKE_CURRENT_BINARY_DIR}/${FIL_WE}.pb.h")

    add_custom_command(
      OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/${FIL_WE}.pb.cc"
             "${CMAKE_CURRENT_BINARY_DIR}/${FIL_WE}.pb.h"
154
      COMMAND  ${Protobuf_PROTOC_EXECUTABLE}
155
      ARGS --cpp_out  ${CMAKE_CURRENT_BINARY_DIR} ${_protobuf_include_path} ${ABS_FIL}
156
      DEPENDS ${ABS_FIL} ${Protobuf_PROTOC_EXECUTABLE}
157 158 159 160 161 162 163 164 165
      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()

166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
function(PROTOBUF_GENERATE_PYTHON SRCS)
  if(NOT ARGN)
    message(SEND_ERROR "Error: PROTOBUF_GENERATE_PYTHON() 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()

186 187
  if(DEFINED Protobuf_IMPORT_DIRS)
    foreach(DIR ${Protobuf_IMPORT_DIRS})
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
      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})
  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}/${FIL_WE}_pb2.py")
    add_custom_command(
      OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/${FIL_WE}_pb2.py"
204 205
      COMMAND  ${Protobuf_PROTOC_EXECUTABLE} --python_out ${CMAKE_CURRENT_BINARY_DIR} ${_protobuf_include_path} ${ABS_FIL}
      DEPENDS ${ABS_FIL} ${Protobuf_PROTOC_EXECUTABLE}
206 207 208 209 210 211 212
      COMMENT "Running Python protocol buffer compiler on ${FIL}"
      VERBATIM )
  endforeach()

  set(${SRCS} ${${SRCS}} PARENT_SCOPE)
endfunction()

213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
# Backwards compatibility
# Define camel case versions of input variables
foreach(UPPER
    PROTOBUF_SRC_ROOT_FOLDER
    PROTOBUF_IMPORT_DIRS
    PROTOBUF_DEBUG
    PROTOBUF_LIBRARY
    PROTOBUF_PROTOC_LIBRARY
    PROTOBUF_INCLUDE_DIR
    PROTOBUF_PROTOC_EXECUTABLE
    PROTOBUF_LIBRARY_DEBUG
    PROTOBUF_PROTOC_LIBRARY_DEBUG
    PROTOBUF_LITE_LIBRARY
    PROTOBUF_LITE_LIBRARY_DEBUG
    )
    if (DEFINED ${UPPER})
        string(REPLACE "PROTOBUF_" "Protobuf_" Camel ${UPPER})
        if (NOT DEFINED ${Camel})
            set(${Camel} ${${UPPER}})
        endif()
    endif()
endforeach()

236 237 238 239
if(CMAKE_SIZEOF_VOID_P EQUAL 8)
  set(_PROTOBUF_ARCH_DIR x64/)
endif()

240 241
include(${CMAKE_CURRENT_LIST_DIR}/SelectLibraryConfigurations.cmake)

242 243 244 245
# Internal function: search for normal library as well as a debug one
#    if the debug one is specified also include debug/optimized keywords
#    in *_LIBRARIES variable
function(_protobuf_find_libraries name filename)
246 247 248 249 250 251 252 253 254
  if(${name}_LIBRARIES)
    # Use result recorded by a previous call.
    return()
  elseif(${name}_LIBRARY)
    # Honor cache entry used by CMake 3.5 and lower.
    set(${name}_LIBRARIES "${${name}_LIBRARY}" PARENT_SCOPE)
  else()
    find_library(${name}_LIBRARY_RELEASE
      NAMES ${filename}
255
      PATHS ${Protobuf_SRC_ROOT_FOLDER}/vsprojects/${_PROTOBUF_ARCH_DIR}Release)
256 257 258 259
    mark_as_advanced(${name}_LIBRARY_RELEASE)

    find_library(${name}_LIBRARY_DEBUG
      NAMES ${filename}
260
      PATHS ${Protobuf_SRC_ROOT_FOLDER}/vsprojects/${_PROTOBUF_ARCH_DIR}Debug)
261 262 263 264 265 266
    mark_as_advanced(${name}_LIBRARY_DEBUG)

    select_library_configurations(${name})
    set(${name}_LIBRARY "${${name}_LIBRARY}" PARENT_SCOPE)
    set(${name}_LIBRARIES "${${name}_LIBRARIES}" PARENT_SCOPE)
  endif()
267 268
endfunction()

269 270 271 272 273
# Internal function: find threads library
function(_protobuf_find_threads)
    set(CMAKE_THREAD_PREFER_PTHREAD TRUE)
    find_package(Threads)
    if(Threads_FOUND)
274 275
        list(APPEND Protobuf_LIBRARIES ${CMAKE_THREAD_LIBS_INIT})
        set(Protobuf_LIBRARIES "${Protobuf_LIBRARIES}" PARENT_SCOPE)
276 277 278
    endif()
endfunction()

279 280 281
#
# Main.
#
282

283 284 285 286 287 288 289
# By default have PROTOBUF_GENERATE_CPP macro pass -I to protoc
# for each directory where a proto file is referenced.
if(NOT DEFINED PROTOBUF_GENERATE_CPP_APPEND_PATH)
  set(PROTOBUF_GENERATE_CPP_APPEND_PATH TRUE)
endif()


290 291
# Google's provided vcproj files generate libraries with a "lib"
# prefix on Windows
292
if(MSVC)
293
    set(Protobuf_ORIG_FIND_LIBRARY_PREFIXES "${CMAKE_FIND_LIBRARY_PREFIXES}")
294
    set(CMAKE_FIND_LIBRARY_PREFIXES "lib" "")
295

296
    find_path(Protobuf_SRC_ROOT_FOLDER protobuf.pc.in)
297 298
endif()

299
# The Protobuf library
300
_protobuf_find_libraries(Protobuf protobuf)
301
#DOC "The Google Protocol Buffers RELEASE Library"
302

303
_protobuf_find_libraries(Protobuf_LITE protobuf-lite)
304 305

# The Protobuf Protoc Library
306
_protobuf_find_libraries(Protobuf_PROTOC protoc)
307

308
# Restore original find library prefixes
309
if(MSVC)
310
    set(CMAKE_FIND_LIBRARY_PREFIXES "${Protobuf_ORIG_FIND_LIBRARY_PREFIXES}")
311 312
endif()

313 314 315
if(UNIX)
    _protobuf_find_threads()
endif()
316 317

# Find the include directory
318
find_path(Protobuf_INCLUDE_DIR
319
    google/protobuf/service.h
320
    PATHS ${Protobuf_SRC_ROOT_FOLDER}/src
321
)
322
mark_as_advanced(Protobuf_INCLUDE_DIR)
323 324

# Find the protoc Executable
325
find_program(Protobuf_PROTOC_EXECUTABLE
326 327 328
    NAMES protoc
    DOC "The Google Protocol Buffers Compiler"
    PATHS
329 330
    ${Protobuf_SRC_ROOT_FOLDER}/vsprojects/${_PROTOBUF_ARCH_DIR}Release
    ${Protobuf_SRC_ROOT_FOLDER}/vsprojects/${_PROTOBUF_ARCH_DIR}Debug
331
)
332
mark_as_advanced(Protobuf_PROTOC_EXECUTABLE)
333

334
if(Protobuf_DEBUG)
335 336 337 338
    message(STATUS "[ ${CMAKE_CURRENT_LIST_FILE}:${CMAKE_CURRENT_LIST_LINE} ] "
        "requested version of Google Protobuf is ${Protobuf_FIND_VERSION}")
endif()

339 340
if(Protobuf_INCLUDE_DIR)
  set(_PROTOBUF_COMMON_HEADER ${Protobuf_INCLUDE_DIR}/google/protobuf/stubs/common.h)
341

342
  if(Protobuf_DEBUG)
343 344 345 346
    message(STATUS "[ ${CMAKE_CURRENT_LIST_FILE}:${CMAKE_CURRENT_LIST_LINE} ] "
                   "location of common.h: ${_PROTOBUF_COMMON_HEADER}")
  endif()

347 348
  set(Protobuf_VERSION "")
  set(Protobuf_LIB_VERSION "")
349 350
  file(STRINGS ${_PROTOBUF_COMMON_HEADER} _PROTOBUF_COMMON_H_CONTENTS REGEX "#define[ \t]+GOOGLE_PROTOBUF_VERSION[ \t]+")
  if(_PROTOBUF_COMMON_H_CONTENTS MATCHES "#define[ \t]+GOOGLE_PROTOBUF_VERSION[ \t]+([0-9]+)")
351
      set(Protobuf_LIB_VERSION "${CMAKE_MATCH_1}")
352 353 354
  endif()
  unset(_PROTOBUF_COMMON_H_CONTENTS)

355 356 357 358
  math(EXPR _PROTOBUF_MAJOR_VERSION "${Protobuf_LIB_VERSION} / 1000000")
  math(EXPR _PROTOBUF_MINOR_VERSION "${Protobuf_LIB_VERSION} / 1000 % 1000")
  math(EXPR _PROTOBUF_SUBMINOR_VERSION "${Protobuf_LIB_VERSION} % 1000")
  set(Protobuf_VERSION "${_PROTOBUF_MAJOR_VERSION}.${_PROTOBUF_MINOR_VERSION}.${_PROTOBUF_SUBMINOR_VERSION}")
359

360
  if(Protobuf_DEBUG)
361
    message(STATUS "[ ${CMAKE_CURRENT_LIST_FILE}:${CMAKE_CURRENT_LIST_LINE} ] "
362
        "${_PROTOBUF_COMMON_HEADER} reveals protobuf ${Protobuf_VERSION}")
363 364 365
  endif()

  # Check Protobuf compiler version to be aligned with libraries version
366
  execute_process(COMMAND ${Protobuf_PROTOC_EXECUTABLE} --version
367 368 369 370 371 372
                  OUTPUT_VARIABLE _PROTOBUF_PROTOC_EXECUTABLE_VERSION)

  if("${_PROTOBUF_PROTOC_EXECUTABLE_VERSION}" MATCHES "libprotoc ([0-9.]+)")
    set(_PROTOBUF_PROTOC_EXECUTABLE_VERSION "${CMAKE_MATCH_1}")
  endif()

373
  if(Protobuf_DEBUG)
374
    message(STATUS "[ ${CMAKE_CURRENT_LIST_FILE}:${CMAKE_CURRENT_LIST_LINE} ] "
375
        "${Protobuf_PROTOC_EXECUTABLE} reveals version ${_PROTOBUF_PROTOC_EXECUTABLE_VERSION}")
376 377
  endif()

378
  if(NOT "${_PROTOBUF_PROTOC_EXECUTABLE_VERSION}" VERSION_EQUAL "${Protobuf_VERSION}")
379
      message(WARNING "Protobuf compiler version ${_PROTOBUF_PROTOC_EXECUTABLE_VERSION}"
380
          " doesn't match library version ${Protobuf_VERSION}")
381 382
  endif()
endif()
383

384
include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake)
385
FIND_PACKAGE_HANDLE_STANDARD_ARGS(Protobuf
386 387
    REQUIRED_VARS Protobuf_LIBRARIES Protobuf_INCLUDE_DIR
    VERSION_VAR Protobuf_VERSION
388
)
389

390 391
if(Protobuf_FOUND)
    set(Protobuf_INCLUDE_DIRS ${Protobuf_INCLUDE_DIR})
392
endif()
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415

# Backwards compatibility
# Define upper case versions of output variables
foreach(Camel
    Protobuf_SRC_ROOT_FOLDER
    Protobuf_IMPORT_DIRS
    Protobuf_DEBUG
    Protobuf_INCLUDE_DIRS
    Protobuf_LIBRARIES
    Protobuf_PROTOC_LIBRARIES
    Protobuf_LITE_LIBRARIES
    Protobuf_LIBRARY
    Protobuf_PROTOC_LIBRARY
    Protobuf_INCLUDE_DIR
    Protobuf_PROTOC_EXECUTABLE
    Protobuf_LIBRARY_DEBUG
    Protobuf_PROTOC_LIBRARY_DEBUG
    Protobuf_LITE_LIBRARY
    Protobuf_LITE_LIBRARY_DEBUG
    )
    string(TOUPPER ${Camel} UPPER)
    set(${UPPER} ${${Camel}})
endforeach()