summaryrefslogtreecommitdiff
path: root/cmake/modules/FindBerkeleyDB.cmake
blob: 63ffe9dc5841817de90075aaf106a69149555474 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168

# SPDX-FileCopyrightText:  sum01 <sum01@protonmail.com>
# SPDX-License-Identifier: Unlicense

# Git: https://github.com/sum01/FindBerkeleyDB

# NOTE: If Berkeley DB ever gets a Pkg-config ".pc" file, add pkg_check_modules() here

# Checks if environment paths are empty, set them if they aren't
set(_BERKELEYDB_PATHS "")
if(NOT _BERKELEYDB_PATHS AND DEFINED BERKELEYDB_ROOT)
  if($ENV{BERKELEYDB_ROOT} AND NOT "$ENV{BERKELEYDB_ROOT}" STREQUAL "")
    set(_BERKELEYDB_PATHS "$ENV{BERKELEYDB_ROOT}")
  endif()
endif()
if(NOT _BERKELEYDB_PATHS AND DEFINED Berkeleydb_ROOT)
  if($ENV{Berkeleydb_ROOT} AND NOT "$ENV{Berkeleydb_ROOT}" STREQUAL "")
    set(_BERKELEYDB_PATHS "$ENV{Berkeleydb_ROOT}")
  endif()
endif()
if(NOT _BERKELEYDB_PATHS AND DEFINED BERKELEYDBROOT)
  if($ENV{BERKELEYDBROOT} AND NOT "$ENV{BERKELEYDBROOT}" STREQUAL "")
    set(_BERKELEYDB_PATHS "$ENV{BERKELEYDBROOT}")
  endif()
endif()

# Allow user to pass a path instead of guessing
if(BerkeleyDB_ROOT_DIR)
  set(_BERKELEYDB_PATHS "${BerkeleyDB_ROOT_DIR}")
elseif(CMAKE_SYSTEM_NAME MATCHES ".*[wW]indows.*")
  # MATCHES is used to work on any devies with windows in the name
  # Shameless copy-paste from FindOpenSSL.cmake v3.8
  file(TO_CMAKE_PATH "$ENV{PROGRAMFILES}" _programfiles)
  list(APPEND _BERKELEYDB_PATHS "${_programfiles}")

  # There's actually production release and version numbers in the file path.
  # For example, if they're on v6.2.32: C:/Program Files/Oracle/Berkeley DB 12cR1 6.2.32/
  # But this still works to find it, so I'm guessing it can accept partial path matches.

  foreach(_target_berkeleydb_path "Oracle/Berkeley DB" "Berkeley DB")
    list(APPEND _BERKELEYDB_PATHS
      "${_programfiles}/${_target_berkeleydb_path}"
      "C:/Program Files (x86)/${_target_berkeleydb_path}"
      "C:/Program Files/${_target_berkeleydb_path}"
      "C:/${_target_berkeleydb_path}"
    )
  endforeach()
else()
  # Paths for anything other than Windows
  # Cellar/berkeley-db is for macOS from homebrew installation
  list(APPEND _BERKELEYDB_PATHS
    "/usr"
    "/usr/local"
    "/usr/local/Cellar/berkeley-db"
    "/opt"
    "/opt/local"
  )
endif()

# Find includes path
find_path(BerkeleyDB_INCLUDE_DIRS
  NAMES "db.h"
  HINTS ${_BERKELEYDB_PATHS}
  PATH_SUFFIXES "include" "includes"
)

# Checks if the version file exists, save the version file to a var, and fail if there's no version file
if(BerkeleyDB_INCLUDE_DIRS)
  # Read the version file db.h into a variable
  file(READ "${BerkeleyDB_INCLUDE_DIRS}/db.h" _BERKELEYDB_DB_HEADER)
  # Parse the DB version into variables to be used in the lib names
  string(REGEX REPLACE ".*DB_VERSION_MAJOR	([0-9]+).*" "\\1" BerkeleyDB_VERSION_MAJOR "${_BERKELEYDB_DB_HEADER}")
  string(REGEX REPLACE ".*DB_VERSION_MINOR	([0-9]+).*" "\\1" BerkeleyDB_VERSION_MINOR "${_BERKELEYDB_DB_HEADER}")
  # Patch version example on non-crypto installs: x.x.xNC
  string(REGEX REPLACE ".*DB_VERSION_PATCH	([0-9]+(NC)?).*" "\\1" BerkeleyDB_VERSION_PATCH "${_BERKELEYDB_DB_HEADER}")
else()
  if(BerkeleyDB_FIND_REQUIRED)
    # If the find_package(BerkeleyDB REQUIRED) was used, fail since we couldn't find the header
    message(FATAL_ERROR
      "Failed to find Berkeley DB's header file \"db.h\"! Try setting \"BerkeleyDB_ROOT_DIR\" when initiating Cmake.")
  endif()
  # Set some garbage values to the versions since we didn't find a file to read
  set(BerkeleyDB_VERSION_MAJOR "0")
  set(BerkeleyDB_VERSION_MINOR "0")
  set(BerkeleyDB_VERSION_PATCH "0")
endif()

# The actual returned/output version variable (the others can be used if needed)
set(BerkeleyDB_VERSION "${BerkeleyDB_VERSION_MAJOR}.${BerkeleyDB_VERSION_MINOR}.${BerkeleyDB_VERSION_PATCH}")

set(BerkeleyDB_LIBRARIES "")
# Finds the target library for berkeley db, since they all follow the same naming conventions
macro(findpackage_berkeleydb_get_lib _berkeleydb_output_varname _target_berkeleydb_lib)
  # Different systems sometimes have a version in the lib name...
  # and some have a dash or underscore before the versions.
  # CMake recommends to put unversioned names before versioned names
  find_library(${_berkeleydb_output_varname}
    NAMES
    "${_target_berkeleydb_lib}"
    "lib${_target_berkeleydb_lib}"
    "lib${_target_berkeleydb_lib}${BerkeleyDB_VERSION_MAJOR}.${BerkeleyDB_VERSION_MINOR}"
    "lib${_target_berkeleydb_lib}-${BerkeleyDB_VERSION_MAJOR}.${BerkeleyDB_VERSION_MINOR}"
    "lib${_target_berkeleydb_lib}_${BerkeleyDB_VERSION_MAJOR}.${BerkeleyDB_VERSION_MINOR}"
    "lib${_target_berkeleydb_lib}${BerkeleyDB_VERSION_MAJOR}${BerkeleyDB_VERSION_MINOR}"
    "lib${_target_berkeleydb_lib}-${BerkeleyDB_VERSION_MAJOR}${BerkeleyDB_VERSION_MINOR}"
    "lib${_target_berkeleydb_lib}_${BerkeleyDB_VERSION_MAJOR}${BerkeleyDB_VERSION_MINOR}"
    "lib${_target_berkeleydb_lib}${BerkeleyDB_VERSION_MAJOR}"
    "lib${_target_berkeleydb_lib}-${BerkeleyDB_VERSION_MAJOR}"
    "lib${_target_berkeleydb_lib}_${BerkeleyDB_VERSION_MAJOR}"
    HINTS ${_BERKELEYDB_PATHS}
    PATH_SUFFIXES "lib" "lib64" "libs" "libs64"
  )
  # If the library was found, add it to our list of libraries
  if(${_berkeleydb_output_varname})
    # If found, append to our libraries variable
    # The ${{}} is because the first expands to target the real variable, the second expands
    # the variable's contents... and the real variable's contents is the path to the lib. Thus,
    # it appends the path of the lib to BerkeleyDB_LIBRARIES.
    list(APPEND BerkeleyDB_LIBRARIES "${${_berkeleydb_output_varname}}")
  endif()
endmacro()

# Find and set the paths of the specific library to the variable
findpackage_berkeleydb_get_lib(BerkeleyDB_LIBRARY "db")
# NOTE: Windows doesn't have a db_cxx lib, but instead compiles the cxx code into the "db" lib
findpackage_berkeleydb_get_lib(BerkeleyDB_Cxx_LIBRARY "db_cxx")
# NOTE: I don't think Linux/Unix gets an SQL lib
findpackage_berkeleydb_get_lib(BerkeleyDB_Sql_LIBRARY "db_sql")
findpackage_berkeleydb_get_lib(BerkeleyDB_Stl_LIBRARY "db_stl")

# Needed for find_package_handle_standard_args()
include(FindPackageHandleStandardArgs)
# Fails if required vars aren't found, or if the version doesn't meet specifications.
find_package_handle_standard_args(BerkeleyDB
  FOUND_VAR BerkeleyDB_FOUND
  REQUIRED_VARS
    BerkeleyDB_INCLUDE_DIRS
    BerkeleyDB_LIBRARY
  VERSION_VAR BerkeleyDB_VERSION
)

# Create an imported lib for easy linking by external projects
if(BerkeleyDB_FOUND AND BerkeleyDB_LIBRARIES AND NOT TARGET Oracle::BerkeleyDB)
  add_library(Oracle::BerkeleyDB UNKNOWN IMPORTED)
  set_target_properties(Oracle::BerkeleyDB PROPERTIES
    INTERFACE_INCLUDE_DIRECTORIES "${BerkeleyDB_INCLUDE_DIRS}"
    IMPORTED_LOCATION "${BerkeleyDB_LIBRARY}"
    INTERFACE_LINK_LIBRARIES "${BerkeleyDB_LIBRARIES}"
  )
endif()

# Only show the includes path and libraries in the GUI if they click "advanced".
# Does nothing when using the CLI
mark_as_advanced(FORCE
  BerkeleyDB_INCLUDE_DIRS
  BerkeleyDB_LIBRARIES
  BerkeleyDB_LIBRARY
  BerkeleyDB_Cxx_LIBRARY
  BerkeleyDB_Sql_LIBRARY
  BerkeleyDB_Stl_LIBRARY
)

include(FindPackageMessage)
# A message that tells the user what includes/libs were found, and obeys the QUIET command.
find_package_message(BerkeleyDB
  "Found BerkeleyDB libraries: ${BerkeleyDB_LIBRARIES}"
  "[${BerkeleyDB_LIBRARIES}[${BerkeleyDB_INCLUDE_DIRS}]]"
)