FindProtobuf.cmake 8.15 KB
Newer Older
1 2 3 4 5 6
#.rst:
# FindProtobuf
# ------------
#
#
#
7
# Locate and configure the Google Protocol Buffers library.
8 9 10
#
# The following variables can be set and are optional:
#
11 12 13 14 15 16 17 18 19 20 21 22 23 24
# ::
#
#    PROTOBUF_SRC_ROOT_FOLDER - When compiling with MSVC, if this cache variable is set
#                               the protobuf-default VS project build locations
#                               (vsprojects/Debug & vsprojects/Release) will be searched
#                               for libraries and binaries.
#
#
#
# ::
#
#    PROTOBUF_IMPORT_DIRS     - List of additional directories to be searched for
#                               imported .proto files. (New in CMake 2.8.8)
#
25
#
26
#
27 28
# Defines the following variables:
#
29 30 31 32 33 34
# ::
#
#    PROTOBUF_FOUND - Found the Google Protocol Buffers library (libprotobuf & header files)
#    PROTOBUF_INCLUDE_DIRS - Include directories for Google Protocol Buffers
#    PROTOBUF_LIBRARIES - The protobuf libraries
#
35
# [New in CMake 2.8.5]
36 37 38 39 40 41 42
#
# ::
#
#    PROTOBUF_PROTOC_LIBRARIES - The protoc libraries
#    PROTOBUF_LITE_LIBRARIES - The protobuf-lite libraries
#
#
43
#
44
# The following cache variables are also available to set or use:
45 46 47 48 49 50 51 52
#
# ::
#
#    PROTOBUF_LIBRARY - The protobuf library
#    PROTOBUF_PROTOC_LIBRARY   - The protoc library
#    PROTOBUF_INCLUDE_DIR - The include directory for protocol buffers
#    PROTOBUF_PROTOC_EXECUTABLE - The protoc compiler
#
53
# [New in CMake 2.8.5]
54
#
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
# ::
#
#    PROTOBUF_LIBRARY_DEBUG - The protobuf library (debug)
#    PROTOBUF_PROTOC_LIBRARY_DEBUG   - The protoc library (debug)
#    PROTOBUF_LITE_LIBRARY - The protobuf lite library
#    PROTOBUF_LITE_LIBRARY_DEBUG - The protobuf lite library (debug)
#
#
#
# ::
#
#   ====================================================================
#   Example:
#
#
#
# ::
#
#    find_package(Protobuf REQUIRED)
#    include_directories(${PROTOBUF_INCLUDE_DIRS})
#
#
#
# ::
#
#    include_directories(${CMAKE_CURRENT_BINARY_DIR})
#    PROTOBUF_GENERATE_CPP(PROTO_SRCS PROTO_HDRS foo.proto)
#    add_executable(bar bar.cc ${PROTO_SRCS} ${PROTO_HDRS})
#    target_link_libraries(bar ${PROTOBUF_LIBRARIES})
84 85 86
#
#
#
87
# NOTE: You may need to link against pthreads, depending
88
#
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
# ::
#
#        on the platform.
#
#
#
# NOTE: The PROTOBUF_GENERATE_CPP macro & add_executable() or
# add_library()
#
# ::
#
#        calls only work properly within the same directory.
#
#
#
# ::
#
#   ====================================================================
#
108
#
109
#
110
# PROTOBUF_GENERATE_CPP (public function)
111
#
112 113 114 115 116 117 118 119 120 121 122 123 124
# ::
#
#    SRCS = Variable to define with autogenerated
#           source files
#    HDRS = Variable to define with autogenerated
#           header files
#    ARGN = proto files
#
#
#
# ::
#
#   ====================================================================
125

126 127 128

#=============================================================================
# Copyright 2009 Kitware, Inc.
129
# Copyright 2009-2011 Philip Lowman <philip@yhbt.com>
130 131 132 133 134 135 136 137 138
# 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.
#=============================================================================
139
# (To distribute this file outside of CMake, substitute the full
140
#  License text for the above reference.)
141

142 143 144 145
function(PROTOBUF_GENERATE_CPP SRCS HDRS)
  if(NOT ARGN)
    message(SEND_ERROR "Error: PROTOBUF_GENERATE_CPP() called without any proto files")
    return()
146
  endif()
147

148 149 150 151 152 153 154 155 156 157 158 159 160 161
  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()

162 163 164 165 166 167 168 169 170 171
  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()

172 173 174 175 176
  set(${SRCS})
  set(${HDRS})
  foreach(FIL ${ARGN})
    get_filename_component(ABS_FIL ${FIL} ABSOLUTE)
    get_filename_component(FIL_WE ${FIL} NAME_WE)
177

178 179 180 181 182 183 184
    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"
      COMMAND  ${PROTOBUF_PROTOC_EXECUTABLE}
185
      ARGS --cpp_out  ${CMAKE_CURRENT_BINARY_DIR} ${_protobuf_include_path} ${ABS_FIL}
186
      DEPENDS ${ABS_FIL} ${PROTOBUF_PROTOC_EXECUTABLE}
187 188 189 190 191 192 193 194 195
      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()

196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
# 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)
   find_library(${name}_LIBRARY
       NAMES ${filename}
       PATHS ${PROTOBUF_SRC_ROOT_FOLDER}/vsprojects/Release)
   mark_as_advanced(${name}_LIBRARY)

   find_library(${name}_LIBRARY_DEBUG
       NAMES ${filename}
       PATHS ${PROTOBUF_SRC_ROOT_FOLDER}/vsprojects/Debug)
   mark_as_advanced(${name}_LIBRARY_DEBUG)

   if(NOT ${name}_LIBRARY_DEBUG)
      # There is no debug library
      set(${name}_LIBRARY_DEBUG ${${name}_LIBRARY} PARENT_SCOPE)
      set(${name}_LIBRARIES     ${${name}_LIBRARY} PARENT_SCOPE)
   else()
      # There IS a debug library
      set(${name}_LIBRARIES
          optimized ${${name}_LIBRARY}
          debug     ${${name}_LIBRARY_DEBUG}
          PARENT_SCOPE
      )
   endif()
endfunction()

224 225 226 227 228 229 230 231 232 233
# Internal function: find threads library
function(_protobuf_find_threads)
    set(CMAKE_THREAD_PREFER_PTHREAD TRUE)
    find_package(Threads)
    if(Threads_FOUND)
        list(APPEND PROTOBUF_LIBRARIES ${CMAKE_THREAD_LIBS_INIT})
        set(PROTOBUF_LIBRARIES "${PROTOBUF_LIBRARIES}" PARENT_SCOPE)
    endif()
endfunction()

234 235 236
#
# Main.
#
237

238 239 240 241 242 243 244
# 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()


245 246
# Google's provided vcproj files generate libraries with a "lib"
# prefix on Windows
247
if(MSVC)
248 249
    set(PROTOBUF_ORIG_FIND_LIBRARY_PREFIXES "${CMAKE_FIND_LIBRARY_PREFIXES}")
    set(CMAKE_FIND_LIBRARY_PREFIXES "lib" "")
250 251

    find_path(PROTOBUF_SRC_ROOT_FOLDER protobuf.pc.in)
252 253
endif()

254 255 256
# The Protobuf library
_protobuf_find_libraries(PROTOBUF protobuf)
#DOC "The Google Protocol Buffers RELEASE Library"
257

258 259 260 261
_protobuf_find_libraries(PROTOBUF_LITE protobuf-lite)

# The Protobuf Protoc Library
_protobuf_find_libraries(PROTOBUF_PROTOC protoc)
262

263
# Restore original find library prefixes
264
if(MSVC)
265
    set(CMAKE_FIND_LIBRARY_PREFIXES "${PROTOBUF_ORIG_FIND_LIBRARY_PREFIXES}")
266 267
endif()

268 269 270
if(UNIX)
    _protobuf_find_threads()
endif()
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289

# Find the include directory
find_path(PROTOBUF_INCLUDE_DIR
    google/protobuf/service.h
    PATHS ${PROTOBUF_SRC_ROOT_FOLDER}/src
)
mark_as_advanced(PROTOBUF_INCLUDE_DIR)

# Find the protoc Executable
find_program(PROTOBUF_PROTOC_EXECUTABLE
    NAMES protoc
    DOC "The Google Protocol Buffers Compiler"
    PATHS
    ${PROTOBUF_SRC_ROOT_FOLDER}/vsprojects/Release
    ${PROTOBUF_SRC_ROOT_FOLDER}/vsprojects/Debug
)
mark_as_advanced(PROTOBUF_PROTOC_EXECUTABLE)


290
include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake)
291 292 293 294 295 296
FIND_PACKAGE_HANDLE_STANDARD_ARGS(PROTOBUF DEFAULT_MSG
    PROTOBUF_LIBRARY PROTOBUF_INCLUDE_DIR)

if(PROTOBUF_FOUND)
    set(PROTOBUF_INCLUDE_DIRS ${PROTOBUF_INCLUDE_DIR})
endif()