CMake: Add option to build against system-wide Glog
[blender.git] / build_files / cmake / Modules / FindGlog.cmake
1 # Ceres Solver - A fast non-linear least squares minimizer
2 # Copyright 2015 Google Inc. All rights reserved.
3 # http://ceres-solver.org/
4 #
5 # Redistribution and use in source and binary forms, with or without
6 # modification, are permitted provided that the following conditions are met:
7 #
8 # * Redistributions of source code must retain the above copyright notice,
9 #   this list of conditions and the following disclaimer.
10 # * Redistributions in binary form must reproduce the above copyright notice,
11 #   this list of conditions and the following disclaimer in the documentation
12 #   and/or other materials provided with the distribution.
13 # * Neither the name of Google Inc. nor the names of its contributors may be
14 #   used to endorse or promote products derived from this software without
15 #   specific prior written permission.
16 #
17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 # ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21 # LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 # CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 # POSSIBILITY OF SUCH DAMAGE.
28 #
29 # Author: alexs.mac@gmail.com (Alex Stewart)
30 #
31
32 # FindGlog.cmake - Find Google glog logging library.
33 #
34 # This module defines the following variables:
35 #
36 # GLOG_FOUND: TRUE iff glog is found.
37 # GLOG_INCLUDE_DIRS: Include directories for glog.
38 # GLOG_LIBRARIES: Libraries required to link glog.
39 #
40 # The following variables control the behaviour of this module:
41 #
42 # GLOG_INCLUDE_DIR_HINTS: List of additional directories in which to
43 #                         search for glog includes, e.g: /timbuktu/include.
44 # GLOG_LIBRARY_DIR_HINTS: List of additional directories in which to
45 #                         search for glog libraries, e.g: /timbuktu/lib.
46 # GFLOG_ROOT_DIR,         The base directory to search for Glog.
47 #                         This can also be an environment variable.
48 #
49 # The following variables are also defined by this module, but in line with
50 # CMake recommended FindPackage() module style should NOT be referenced directly
51 # by callers (use the plural variables detailed above instead).  These variables
52 # do however affect the behaviour of the module via FIND_[PATH/LIBRARY]() which
53 # are NOT re-called (i.e. search for library is not repeated) if these variables
54 # are set with valid values _in the CMake cache_. This means that if these
55 # variables are set directly in the cache, either by the user in the CMake GUI,
56 # or by the user passing -DVAR=VALUE directives to CMake when called (which
57 # explicitly defines a cache variable), then they will be used verbatim,
58 # bypassing the HINTS variables and other hard-coded search locations.
59 #
60 # GLOG_INCLUDE_DIR: Include directory for glog, not including the
61 #                   include directory of any dependencies.
62 # GLOG_LIBRARY: glog library, not including the libraries of any
63 #               dependencies.
64
65 # If GLOG_ROOT_DIR was defined in the environment, use it.
66 if(NOT GLOG_ROOT_DIR AND NOT $ENV{GLOG_ROOT_DIR} STREQUAL "")
67   set(GLOG_ROOT_DIR $ENV{GLOG_ROOT_DIR})
68 endif()
69
70 if(DEFINED GLOG_ROOT_DIR)
71   set(GLOG_ROOT_DIR_INCLUDE "${GLOG_ROOT_DIR}/include")
72   set(GLOG_ROOT_DIR_LIB "${GLOG_ROOT_DIR}/lib")
73 endif()
74
75 # Reset CALLERS_CMAKE_FIND_LIBRARY_PREFIXES to its value when
76 # FindGlog was invoked.
77 macro(GLOG_RESET_FIND_LIBRARY_PREFIX)
78   if(MSVC)
79     set(CMAKE_FIND_LIBRARY_PREFIXES "${CALLERS_CMAKE_FIND_LIBRARY_PREFIXES}")
80   endif()
81 endmacro()
82
83 # Called if we failed to find glog or any of it's required dependencies,
84 # unsets all public (designed to be used externally) variables and reports
85 # error message at priority depending upon [REQUIRED/QUIET/<NONE>] argument.
86 macro(GLOG_REPORT_NOT_FOUND REASON_MSG)
87   unset(GLOG_FOUND)
88   unset(GLOG_INCLUDE_DIRS)
89   unset(GLOG_LIBRARIES)
90   # Make results of search visible in the CMake GUI if glog has not
91   # been found so that user does not have to toggle to advanced view.
92   mark_as_advanced(CLEAR GLOG_INCLUDE_DIR
93                          GLOG_LIBRARY)
94
95   glog_reset_find_library_prefix()
96
97   # Note <package>_FIND_[REQUIRED/QUIETLY] variables defined by FindPackage()
98   # use the camelcase library name, not uppercase.
99   if(Glog_FIND_QUIETLY)
100     message(STATUS "Failed to find glog - " ${REASON_MSG} ${ARGN})
101   elseif(Glog_FIND_REQUIRED)
102     message(FATAL_ERROR "Failed to find glog - " ${REASON_MSG} ${ARGN})
103   else()
104     # Neither QUIETLY nor REQUIRED, use no priority which emits a message
105     # but continues configuration and allows generation.
106     message("-- Failed to find glog - " ${REASON_MSG} ${ARGN})
107   endif()
108   return()
109 endmacro()
110
111 # Handle possible presence of lib prefix for libraries on MSVC, see
112 # also GLOG_RESET_FIND_LIBRARY_PREFIX().
113 if(MSVC)
114   # Preserve the caller's original values for CMAKE_FIND_LIBRARY_PREFIXES
115   # s/t we can set it back before returning.
116   set(CALLERS_CMAKE_FIND_LIBRARY_PREFIXES "${CMAKE_FIND_LIBRARY_PREFIXES}")
117   # The empty string in this list is important, it represents the case when
118   # the libraries have no prefix (shared libraries / DLLs).
119   set(CMAKE_FIND_LIBRARY_PREFIXES "lib" "" "${CMAKE_FIND_LIBRARY_PREFIXES}")
120 endif()
121
122 # Search user-installed locations first, so that we prefer user installs
123 # to system installs where both exist.
124 list(APPEND GLOG_CHECK_INCLUDE_DIRS
125   ${GLOG_ROOT_DIR_INCLUDE}
126   /usr/local/include
127   /usr/local/homebrew/include # Mac OS X
128   /opt/local/var/macports/software # Mac OS X.
129   /opt/local/include
130   /usr/include
131   /sw/include # Fink
132   /opt/csw/include # Blastwave
133   /opt/lib/glog/include)
134 # Windows (for C:/Program Files prefix).
135 list(APPEND GLOG_CHECK_PATH_SUFFIXES
136   glog/include
137   glog/Include
138   Glog/include
139   Glog/Include)
140
141 list(APPEND GLOG_CHECK_LIBRARY_DIRS
142   ${GLOG_ROOT_DIR_LIB}
143   /usr/local/lib
144   /usr/local/homebrew/lib # Mac OS X.
145   /opt/local/lib
146   /usr/lib
147   /sw/lib # Fink
148   /opt/csw/lib # Blastwave
149   /opt/lib/gflags/lib)
150 # Windows (for C:/Program Files prefix).
151 list(APPEND GLOG_CHECK_LIBRARY_SUFFIXES
152   glog/lib
153   glog/Lib
154   Glog/lib
155   Glog/Lib)
156
157 # Search supplied hint directories first if supplied.
158 find_path(GLOG_INCLUDE_DIR
159   NAMES glog/logging.h
160   PATHS ${GLOG_INCLUDE_DIR_HINTS}
161   ${GLOG_CHECK_INCLUDE_DIRS}
162   PATH_SUFFIXES ${GLOG_CHECK_PATH_SUFFIXES})
163 if(NOT GLOG_INCLUDE_DIR OR
164    NOT EXISTS ${GLOG_INCLUDE_DIR})
165   glog_report_not_found(
166     "Could not find glog include directory, set GLOG_INCLUDE_DIR "
167     "to directory containing glog/logging.h")
168 endif()
169
170 find_library(GLOG_LIBRARY NAMES glog
171   PATHS ${GLOG_LIBRARY_DIR_HINTS}
172   ${GLOG_CHECK_LIBRARY_DIRS}
173   PATH_SUFFIXES ${GLOG_CHECK_LIBRARY_SUFFIXES})
174 if(NOT GLOG_LIBRARY OR
175    NOT EXISTS ${GLOG_LIBRARY})
176   glog_report_not_found(
177     "Could not find glog library, set GLOG_LIBRARY "
178     "to full path to libglog.")
179 endif()
180
181 # Mark internally as found, then verify. GLOG_REPORT_NOT_FOUND() unsets
182 # if called.
183 set(GLOG_FOUND TRUE)
184
185 # Glog does not seem to provide any record of the version in its
186 # source tree, thus cannot extract version.
187
188 # Catch case when caller has set GLOG_INCLUDE_DIR in the cache / GUI and
189 # thus FIND_[PATH/LIBRARY] are not called, but specified locations are
190 # invalid, otherwise we would report the library as found.
191 if(GLOG_INCLUDE_DIR AND
192    NOT EXISTS ${GLOG_INCLUDE_DIR}/glog/logging.h)
193   glog_report_not_found(
194     "Caller defined GLOG_INCLUDE_DIR:"
195     " ${GLOG_INCLUDE_DIR} does not contain glog/logging.h header.")
196 endif()
197 # TODO: This regex for glog library is pretty primitive, we use lowercase
198 #       for comparison to handle Windows using CamelCase library names, could
199 #       this check be better?
200 string(TOLOWER "${GLOG_LIBRARY}" LOWERCASE_GLOG_LIBRARY)
201 if(GLOG_LIBRARY AND
202    NOT "${LOWERCASE_GLOG_LIBRARY}" MATCHES ".*glog[^/]*")
203   glog_report_not_found(
204     "Caller defined GLOG_LIBRARY: "
205     "${GLOG_LIBRARY} does not match glog.")
206 endif()
207
208 # Set standard CMake FindPackage variables if found.
209 if(GLOG_FOUND)
210   set(GLOG_INCLUDE_DIRS ${GLOG_INCLUDE_DIR})
211   set(GLOG_LIBRARIES ${GLOG_LIBRARY})
212 endif()
213
214 glog_reset_find_library_prefix()
215
216 # Handle REQUIRED / QUIET optional arguments.
217 include(FindPackageHandleStandardArgs)
218 find_package_handle_standard_args(GLOG DEFAULT_MSG
219   GLOG_INCLUDE_DIRS GLOG_LIBRARIES)
220
221 # Only mark internal variables as advanced if we found glog, otherwise
222 # leave them visible in the standard GUI for the user to set manually.
223 if(GLOG_FOUND)
224   mark_as_advanced(FORCE GLOG_INCLUDE_DIR
225                          GLOG_LIBRARY)
226 endif()