Updated formatting of documentation plus a little reorganization.
[cmake.git] / Modules / FindProtobuf.cmake
blob2f8aa5da8e7b14dafe28b08dfd1936b9e0758905
1 # Locate and configure the Google Protocol Buffers library.
2 # Defines the following variables:
4 #   PROTOBUF_FOUND - Found the Google Protocol Buffers library
5 #   PROTOBUF_INCLUDE_DIRS - Include directories for Google Protocol Buffers
6 #   PROTOBUF_LIBRARIES - The protobuf library
8 # The following cache variables are also defined:
9 #   PROTOBUF_LIBRARY - The protobuf library
10 #   PROTOBUF_PROTOC_LIBRARY   - The protoc library
11 #   PROTOBUF_INCLUDE_DIR - The include directory for protocol buffers
12 #   PROTOBUF_PROTOC_EXECUTABLE - The protoc compiler
14 #====================================================================
15 # Example:
17 # find_package(Protobuf REQUIRED)
18 # include_directories(${PROTOBUF_INCLUDE_DIRS})
20 # include_directories(${CMAKE_CURRENT_BINARY_DIR})
21 # PROTOBUF_GENERATE_CPP(PROTO_SRCS PROTO_HDRS foo.proto)
22 # add_executable(bar bar.cc ${PROTO_SRCS} ${PROTO_HDRS})
23 # target_link_libraries(bar ${PROTOBUF_LIBRARY})
25 # NOTE: You may need to link against pthreads, depending
26 # on the platform.
27 #====================================================================
29 # PROTOBUF_GENERATE_CPP (public function)
30 #   SRCS = Variable to define with autogenerated
31 #          source files
32 #   HDRS = Variable to define with autogenerated
33 #          header files
34 #   ARGN = proto files
36 #====================================================================
38 # Esben Mose Hansen <[EMAIL PROTECTED]>, (c) Ange Optimization ApS 2008
39 # Adapted by Philip Lowman <philip@yhbt.com> (c) 2009
41 # Redistribution and use is allowed according to the terms of the BSD license.
42 # For details see the accompanying COPYING-CMAKE-SCRIPTS file.
44 function(PROTOBUF_GENERATE_CPP SRCS HDRS)
45   if(NOT ARGN)
46     message(SEND_ERROR "Error: PROTOBUF_GENERATE_CPP() called without any proto files")
47     return()
48   endif(NOT ARGN)
50   set(${SRCS})
51   set(${HDRS})
52   foreach(FIL ${ARGN})
53     get_filename_component(ABS_FIL ${FIL} ABSOLUTE)
54     get_filename_component(FIL_WE ${FIL} NAME_WE)
55     
56     list(APPEND ${SRCS} "${CMAKE_CURRENT_BINARY_DIR}/${FIL_WE}.pb.cc")
57     list(APPEND ${HDRS} "${CMAKE_CURRENT_BINARY_DIR}/${FIL_WE}.pb.h")
59     add_custom_command(
60       OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/${FIL_WE}.pb.cc"
61              "${CMAKE_CURRENT_BINARY_DIR}/${FIL_WE}.pb.h"
62       COMMAND  ${PROTOBUF_PROTOC_EXECUTABLE}
63       ARGS --cpp_out  ${CMAKE_CURRENT_BINARY_DIR} --proto_path ${CMAKE_CURRENT_SOURCE_DIR} ${ABS_FIL}
64       DEPENDS ${ABS_FIL}
65       COMMENT "Running C++ protocol buffer compiler on ${FIL}"
66       VERBATIM )
67   endforeach()
69   set_source_files_properties(${${SRCS}} ${${HDRS}} PROPERTIES GENERATED TRUE)
70   set(${SRCS} ${${SRCS}} PARENT_SCOPE)
71   set(${HDRS} ${${HDRS}} PARENT_SCOPE)
72 endfunction()
75 find_path(PROTOBUF_INCLUDE_DIR google/protobuf/service.h)
77 # Google's provided vcproj files generate libraries with a "lib"
78 # prefix on Windows
79 if(WIN32)
80     set(PROTOBUF_ORIG_FIND_LIBRARY_PREFIXES "${CMAKE_FIND_LIBRARY_PREFIXES}")
81     set(CMAKE_FIND_LIBRARY_PREFIXES "lib" "")
82 endif()
84 find_library(PROTOBUF_LIBRARY NAMES protobuf
85              DOC "The Google Protocol Buffers Library"
87 find_library(PROTOBUF_PROTOC_LIBRARY NAMES protoc
88              DOC "The Google Protocol Buffers Compiler Library"
90 find_program(PROTOBUF_PROTOC_EXECUTABLE NAMES protoc
91              DOC "The Google Protocol Buffers Compiler"
94 mark_as_advanced(PROTOBUF_INCLUDE_DIR
95                  PROTOBUF_LIBRARY
96                  PROTOBUF_PROTOC_LIBRARY
97                  PROTOBUF_PROTOC_EXECUTABLE)
99 # Restore original find library prefixes
100 if(WIN32)
101     set(CMAKE_FIND_LIBRARY_PREFIXES "${PROTOBUF_ORIG_FIND_LIBRARY_PREFIXES}")
102 endif()
104 include(FindPackageHandleStandardArgs)
105 FIND_PACKAGE_HANDLE_STANDARD_ARGS(PROTOBUF DEFAULT_MSG
106     PROTOBUF_LIBRARY PROTOBUF_INCLUDE_DIR)
108 if(PROTOBUF_FOUND)
109     set(PROTOBUF_INCLUDE_DIRS ${PROTOBUF_INCLUDE_DIR})
110     set(PROTOBUF_LIBRARIES    ${PROTOBUF_LIBRARY})
111 endif()