]> git.openstreetmap.org Git - nominatim.git/blob - CMakeLists.txt
0b2d7b11ec291528a62d2b45b518227ac63a7661
[nominatim.git] / CMakeLists.txt
1 #-----------------------------------------------------------------------------
2 #
3 #  CMake Config
4 #
5 #  Nominatim
6 #
7 #-----------------------------------------------------------------------------
8
9 cmake_minimum_required(VERSION 3.0 FATAL_ERROR)
10 list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake")
11
12
13 #-----------------------------------------------------------------------------
14 #
15 #  Project version
16 #
17 #-----------------------------------------------------------------------------
18
19 project(nominatim)
20
21 set(NOMINATIM_VERSION_MAJOR 3)
22 set(NOMINATIM_VERSION_MINOR 7)
23 set(NOMINATIM_VERSION_PATCH 0)
24
25 set(NOMINATIM_VERSION "${NOMINATIM_VERSION_MAJOR}.${NOMINATIM_VERSION_MINOR}.${NOMINATIM_VERSION_PATCH}")
26
27 add_definitions(-DNOMINATIM_VERSION="${NOMINATIM_VERSION}")
28
29
30 #-----------------------------------------------------------------------------
31 #  Configuration
32 #-----------------------------------------------------------------------------
33
34 set(BUILD_IMPORTER on CACHE BOOL "Build everything for importing/updating the database")
35 set(BUILD_API on CACHE BOOL "Build everything for the API server")
36 set(BUILD_MODULE on CACHE BOOL "Build PostgreSQL module")
37 set(BUILD_TESTS on CACHE BOOL "Build test suite")
38 set(BUILD_DOCS on CACHE BOOL "Build documentation")
39 set(BUILD_MANPAGE on CACHE BOOL "Build Manual Page")
40 set(BUILD_OSM2PGSQL on CACHE BOOL "Build osm2pgsql (expert only)")
41
42 #-----------------------------------------------------------------------------
43 #  osm2pgsql (imports/updates only)
44 #-----------------------------------------------------------------------------
45
46 if (BUILD_IMPORTER AND BUILD_OSM2PGSQL)
47     if (NOT EXISTS "${CMAKE_SOURCE_DIR}/osm2pgsql/CMakeLists.txt")
48         message(FATAL_ERROR "The osm2pgsql directory is empty.\
49         Did you forget to check out Nominatim recursively?\
50         \nTry updating submodules with: git submodule update --init")
51     endif()
52     set(BUILD_TESTS_SAVED "${BUILD_TESTS}")
53     set(BUILD_TESTS off)
54     set(WITH_LUA off CACHE BOOL "")
55     add_subdirectory(osm2pgsql)
56     set(BUILD_TESTS ${BUILD_TESTS_SAVED})
57 endif()
58
59
60 #-----------------------------------------------------------------------------
61 #  python (imports/updates only)
62 #-----------------------------------------------------------------------------
63
64 if (BUILD_IMPORTER)
65     find_package(PythonInterp 3.6 REQUIRED)
66 endif()
67
68 #-----------------------------------------------------------------------------
69 # PHP
70 #-----------------------------------------------------------------------------
71
72 # Setting PHP binary variable as to command line (prevailing) or auto detect
73
74 if (BUILD_API OR BUILD_IMPORTER)
75     if (NOT PHP_BIN)
76          find_program (PHP_BIN php)
77     endif()
78     # sanity check if PHP binary exists
79     if (NOT EXISTS ${PHP_BIN})
80         message(FATAL_ERROR "PHP binary not found. Install php or provide location with -DPHP_BIN=/path/php ")
81     else()
82         message (STATUS "Using PHP binary " ${PHP_BIN})
83     endif()
84     if (NOT PHPCGI_BIN)
85         find_program (PHPCGI_BIN php-cgi)
86     endif()
87     # sanity check if PHP binary exists
88     if (NOT EXISTS ${PHPCGI_BIN})
89         message(WARNING "php-cgi binary not found. nominatim tool will not provide query functions.")
90         set (PHPCGI_BIN "")
91     else()
92         message (STATUS "Using php-cgi binary " ${PHPCGI_BIN})
93     endif()
94 endif()
95
96 #-----------------------------------------------------------------------------
97 # import scripts and utilities (importer only)
98 #-----------------------------------------------------------------------------
99
100 if (BUILD_IMPORTER)
101    find_file(COUNTRY_GRID_FILE country_osm_grid.sql.gz
102              PATHS ${PROJECT_SOURCE_DIR}/data
103              NO_DEFAULT_PATH
104              DOC "Location of the country grid file."
105             )
106
107    if (NOT COUNTRY_GRID_FILE)
108        message(FATAL_ERROR "\nYou need to download the country_osm_grid first:\n"
109                            "    wget -O ${PROJECT_SOURCE_DIR}/data/country_osm_grid.sql.gz https://www.nominatim.org/data/country_grid.sql.gz")
110    endif()
111
112    configure_file(${PROJECT_SOURCE_DIR}/cmake/tool.tmpl
113                   ${PROJECT_BINARY_DIR}/nominatim)
114 endif()
115
116 #-----------------------------------------------------------------------------
117 # Tests
118 #-----------------------------------------------------------------------------
119
120 if (BUILD_TESTS)
121     include(CTest)
122
123     set(TEST_BDD db osm2pgsql api)
124
125     find_program(PYTHON_BEHAVE behave)
126     find_program(PYLINT NAMES pylint3 pylint)
127     find_program(PYTEST NAMES pytest py.test-3 py.test)
128     find_program(PHPCS phpcs)
129     find_program(PHPUNIT phpunit)
130
131     if (PYTHON_BEHAVE)
132         message(STATUS "Using Python behave binary ${PYTHON_BEHAVE}")
133         foreach (test ${TEST_BDD})
134             add_test(NAME bdd_${test}
135                      COMMAND ${PYTHON_BEHAVE} ${test}
136                      WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/test/bdd)
137             set_tests_properties(bdd_${test}
138                 PROPERTIES ENVIRONMENT "NOMINATIM_DIR=${PROJECT_BINARY_DIR}")
139         endforeach()
140     else()
141         message(WARNING "behave not found. BDD tests disabled." )
142     endif()
143
144     if (PHPUNIT)
145         message(STATUS "Using phpunit binary ${PHPUNIT}")
146         add_test(NAME php
147                  COMMAND ${PHPUNIT} ./
148                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/test/php)
149     else()
150         message(WARNING "phpunit not found. PHP unit tests disabled." )
151     endif()
152
153     if (PHPCS)
154         message(STATUS "Using phpcs binary ${PHPCS}")
155         add_test(NAME phpcs
156                  COMMAND ${PHPCS} --report-width=120 --colors lib-php
157                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
158     else()
159         message(WARNING "phpcs not found. PHP linting tests disabled." )
160     endif()
161
162     if (PYLINT)
163         message(STATUS "Using pylint binary ${PYLINT}")
164         add_test(NAME pylint
165                  COMMAND ${PYLINT} nominatim
166                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
167     else()
168         message(WARNING "pylint not found. Python linting tests disabled.")
169     endif()
170
171     if (PYTEST)
172         message(STATUS "Using pytest binary ${PYTEST}")
173         add_test(NAME pytest
174                  COMMAND ${PYTEST} test/python
175                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
176     else()
177         message(WARNING "pytest not found. Python tests disabled." )
178     endif()
179 endif()
180
181 #-----------------------------------------------------------------------------
182 # Postgres module
183 #-----------------------------------------------------------------------------
184
185 if (BUILD_MODULE)
186     add_subdirectory(module)
187 endif()
188
189 #-----------------------------------------------------------------------------
190 # Documentation
191 #-----------------------------------------------------------------------------
192
193 if (BUILD_DOCS)
194    add_subdirectory(docs)
195 endif()
196
197 #-----------------------------------------------------------------------------
198 # Manual page
199 #-----------------------------------------------------------------------------
200
201 if (BUILD_MANPAGE)
202    add_subdirectory(manual)
203 endif()
204
205 #-----------------------------------------------------------------------------
206 # Installation
207 #-----------------------------------------------------------------------------
208
209
210 include(GNUInstallDirs)
211 set(NOMINATIM_DATADIR ${CMAKE_INSTALL_FULL_DATADIR}/${PROJECT_NAME})
212 set(NOMINATIM_LIBDIR ${CMAKE_INSTALL_FULL_LIBDIR}/${PROJECT_NAME})
213 set(NOMINATIM_CONFIGDIR ${CMAKE_INSTALL_FULL_SYSCONFDIR}/${PROJECT_NAME})
214
215 if (BUILD_IMPORTER)
216     configure_file(${PROJECT_SOURCE_DIR}/cmake/tool-installed.tmpl installed.bin)
217     install(PROGRAMS ${PROJECT_BINARY_DIR}/installed.bin
218             DESTINATION ${CMAKE_INSTALL_BINDIR}
219             RENAME nominatim)
220
221     install(DIRECTORY nominatim
222             DESTINATION ${NOMINATIM_LIBDIR}/lib-python
223             FILES_MATCHING PATTERN "*.py"
224             PATTERN __pycache__ EXCLUDE)
225     install(DIRECTORY lib-sql DESTINATION ${NOMINATIM_LIBDIR})
226
227     install(FILES data/country_name.sql
228                   ${COUNTRY_GRID_FILE}
229                   data/words.sql
230             DESTINATION ${NOMINATIM_DATADIR})
231 endif()
232
233 if (BUILD_OSM2PGSQL)
234     if (${CMAKE_VERSION} VERSION_LESS 3.13)
235         # Installation of subdirectory targets was only introduced in 3.13.
236         # So just copy the osm2pgsql file for older versions.
237         install(PROGRAMS ${PROJECT_BINARY_DIR}/osm2pgsql/osm2pgsql
238                 DESTINATION ${NOMINATIM_LIBDIR})
239     else()
240         install(TARGETS osm2pgsql RUNTIME DESTINATION ${NOMINATIM_LIBDIR})
241     endif()
242 endif()
243
244 if (BUILD_MODULE)
245     install(PROGRAMS ${PROJECT_BINARY_DIR}/module/nominatim.so
246             DESTINATION ${NOMINATIM_LIBDIR}/module)
247 endif()
248
249 if (BUILD_API)
250     install(DIRECTORY lib-php DESTINATION ${NOMINATIM_LIBDIR})
251 endif()
252
253 install(FILES settings/env.defaults
254               settings/address-levels.json
255               settings/phrase-settings.json
256               settings/import-admin.style
257               settings/import-street.style
258               settings/import-address.style
259               settings/import-full.style
260               settings/import-extratags.style
261               settings/legacy_icu_tokenizer.yaml
262               settings/icu-rules/extended-unicode-to-asccii.yaml
263         DESTINATION ${NOMINATIM_CONFIGDIR})