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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
|
# CMake4GDAL project is distributed under MIT license. See accompanying file LICENSE.txt.
if (CMAKE_CXX_FLAGS)
string(REPLACE "-Werror " " " CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ")
string(REPLACE "/WX " " " CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ")
endif ()
# SWIG generates wrapper sources
option(SWIG_REGENERATE_PYTHON "Generate python source with SWIG." OFF)
file(MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/osgeo/")
set(GDAL_PYTHON_CSOURCE_DIR "${CMAKE_CURRENT_BINARY_DIR}/extensions/")
file(MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/extensions/")
set(GDAL_PYTHON_CSOURCES
${GDAL_PYTHON_CSOURCE_DIR}/gdal_wrap.cpp ${GDAL_PYTHON_CSOURCE_DIR}/gdalconst_wrap.c
${GDAL_PYTHON_CSOURCE_DIR}/gnm_wrap.cpp ${GDAL_PYTHON_CSOURCE_DIR}/ogr_wrap.cpp
${GDAL_PYTHON_CSOURCE_DIR}/osr_wrap.cpp)
if (SWIG_REGENERATE_PYTHON)
if ("${CMAKE_BINARY_DIR}" STREQUAL "${CMAKE_SOURCE_DIR}")
message(WARNING "Builds from root directory with SWIG_REGENERATE_PYTHON=ON mostly work, but 'make clean' will remove the swig/python/extensions/* and swig/python/osgeo* generated files")
endif()
list(APPEND GDAL_SWIG_COMMON_INTERFACE_FILES
${PROJECT_SOURCE_DIR}/swig/include/python/callback.i
${PROJECT_SOURCE_DIR}/swig/include/python/gdal_python.i
${PROJECT_SOURCE_DIR}/swig/include/python/gnm_python.i
${PROJECT_SOURCE_DIR}/swig/include/python/ogr_python.i
${PROJECT_SOURCE_DIR}/swig/include/python/osr_python.i
${PROJECT_SOURCE_DIR}/swig/include/python/python_exceptions.i
${PROJECT_SOURCE_DIR}/swig/include/python/python_strings.i
${PROJECT_SOURCE_DIR}/swig/include/python/typemaps_python.i
${PROJECT_SOURCE_DIR}/swig/include/python/docs/ogr_datasource_docs.i
${PROJECT_SOURCE_DIR}/swig/include/python/docs/ogr_driver_docs.i
${PROJECT_SOURCE_DIR}/swig/include/python/docs/ogr_featuredef_docs.i
${PROJECT_SOURCE_DIR}/swig/include/python/docs/ogr_feature_docs.i
${PROJECT_SOURCE_DIR}/swig/include/python/docs/ogr_fielddef_docs.i
${PROJECT_SOURCE_DIR}/swig/include/python/docs/ogr_geometry_docs.i
${PROJECT_SOURCE_DIR}/swig/include/python/docs/ogr_layer_docs.i)
set(GDAL_PYTHON_PYSOURCES
${CMAKE_CURRENT_BINARY_DIR}/osgeo/gdal.py ${CMAKE_CURRENT_BINARY_DIR}/osgeo/gdalconst.py
${CMAKE_CURRENT_BINARY_DIR}/osgeo/gnm.py
${CMAKE_CURRENT_BINARY_DIR}/osgeo/ogr.py ${CMAKE_CURRENT_BINARY_DIR}/osgeo/osr.py)
include(GdalSwigBindings)
gdal_swig_bindings(
BINDING
python
ARGS
-I${PROJECT_SOURCE_DIR}/swig/include/python/docs
-py3
-threads
-relativeimport
-outdir
${CMAKE_CURRENT_BINARY_DIR}/osgeo
OUTPUT
${GDAL_PYTHON_PYSOURCES}
${GDAL_PYTHON_CSOURCES}
DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/modify_cpp_files.cmake)
# gdal_array_wrap.cpp when NumPy exist
if (Python_NumPy_FOUND)
set(ARRAY_INPUT ${PROJECT_SOURCE_DIR}/swig/include/gdal_array.i)
set(ARRAY_OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/extensions/gdal_array_wrap.cpp)
add_custom_command(
OUTPUT ${ARRAY_OUTPUT} "${CMAKE_CURRENT_BINARY_DIR}/osgeo/gdal_array.py"
COMMAND
${SWIG_EXECUTABLE} -Wall -I${PROJECT_SOURCE_DIR}/swig/include -I${PROJECT_SOURCE_DIR}/swig/include/python
-I${PROJECT_SOURCE_DIR}/swig/include/python/docs -py3 -threads -relativeimport -outdir
${CMAKE_CURRENT_BINARY_DIR}/osgeo ${SWIG_DEFINES} -I${PROJECT_SOURCE_DIR}/gdal -c++ -python -o ${ARRAY_OUTPUT}
${ARRAY_INPUT}
DEPENDS ${ARRAY_INPUT}
${PROJECT_SOURCE_DIR}/swig/include/python/typemaps_python.i
${CMAKE_CURRENT_SOURCE_DIR}/modify_cpp_files.cmake
COMMENT "Generate _gdal_array_wrap.so and gdal_array.py by SWiG command")
list(APPEND GDAL_PYTHON_CSOURCES "${GDAL_PYTHON_CSOURCE_DIR}/gdal_array_wrap.cpp")
list(APPEND GDAL_PYTHON_PYSOURCES "${CMAKE_CURRENT_BINARY_DIR}/osgeo/gdal_array.py")
endif ()
if (NOT "${CMAKE_BINARY_DIR}" STREQUAL "${CMAKE_SOURCE_DIR}")
add_custom_command(
OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/osgeo/gdalnumeric.py"
COMMAND ${CMAKE_COMMAND} -E copy "${CMAKE_CURRENT_SOURCE_DIR}/osgeo/gdalnumeric.py"
"${CMAKE_CURRENT_BINARY_DIR}/osgeo"
DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/osgeo/gdalnumeric.py")
list(APPEND GDAL_PYTHON_PYSOURCES "${CMAKE_CURRENT_BINARY_DIR}/osgeo/gdalnumeric.py")
endif()
if (NOT "${CMAKE_BINARY_DIR}" STREQUAL "${CMAKE_SOURCE_DIR}")
add_custom_command(
OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/osgeo/__init__.py"
COMMAND ${CMAKE_COMMAND} -E copy "${CMAKE_CURRENT_SOURCE_DIR}/osgeo/__init__.py" "${CMAKE_CURRENT_BINARY_DIR}/osgeo"
DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/osgeo/__init__.py")
list(APPEND GDAL_PYTHON_PYSOURCES "${CMAKE_CURRENT_BINARY_DIR}/osgeo/__init__.py")
endif()
foreach(_file IN ITEMS ${GDAL_PYTHON_CSOURCES})
add_custom_command(
OUTPUT ${_file}
APPEND
COMMAND ${CMAKE_COMMAND} ${WERROR_DEV_FLAG} "-DFILE=${_file}" -P ${CMAKE_CURRENT_SOURCE_DIR}/modify_cpp_files.cmake)
endforeach()
if (NOT Python_EXECUTABLE)
message(FATAL_ERROR "Python_EXECUTABLE variable not set")
endif()
foreach(_file IN ITEMS ${GDAL_PYTHON_PYSOURCES})
file(TO_NATIVE_PATH "${_file}" _native_file)
add_custom_command(
OUTPUT ${_file}
APPEND
COMMAND
${Python_EXECUTABLE} -m lib2to3 --fix=import --fix=next --fix=renames --fix=unicode --fix=ws_comma --fix=xrange
--write --write-unchanged-files --nobackups ${_native_file})
endforeach()
if (NOT "${CMAKE_BINARY_DIR}" STREQUAL "${CMAKE_SOURCE_DIR}")
option(SWIG_COPY_REGENERATED_PYTHON_IN_SOURCE_DIR "Copy SWIG regenerated Python bindings into source directory." ON)
if(SWIG_COPY_REGENERATED_PYTHON_IN_SOURCE_DIR)
file(TO_NATIVE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/extensions" GDAL_PYTHON_CSOURCE_SRC_DIR_NATIVE_PATH)
foreach(_file IN ITEMS ${GDAL_PYTHON_CSOURCES})
file(TO_NATIVE_PATH "${_file}" _native_file)
add_custom_command(
OUTPUT ${_file}
APPEND
COMMAND
${CMAKE_COMMAND} -E copy_if_different
${_native_file}
${GDAL_PYTHON_CSOURCE_SRC_DIR_NATIVE_PATH})
endforeach()
file(TO_NATIVE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/osgeo" GDAL_PYTHON_PYSOURCE_SRC_DIR_NATIVE_PATH)
foreach(_file IN ITEMS ${GDAL_PYTHON_PYSOURCES})
file(TO_NATIVE_PATH "${_file}" _native_file)
add_custom_command(
OUTPUT ${_file}
APPEND
COMMAND
${CMAKE_COMMAND} -E copy_if_different
${_native_file}
${GDAL_PYTHON_PYSOURCE_SRC_DIR_NATIVE_PATH})
endforeach()
endif()
endif()
elseif (NOT "${CMAKE_BINARY_DIR}" STREQUAL "${CMAKE_SOURCE_DIR}")
set(GDAL_PYTHON_CSOURCES_SRC
${CMAKE_CURRENT_SOURCE_DIR}/extensions/gdal_wrap.cpp ${CMAKE_CURRENT_SOURCE_DIR}/extensions/gdalconst_wrap.c
${CMAKE_CURRENT_SOURCE_DIR}/extensions/gnm_wrap.cpp ${CMAKE_CURRENT_SOURCE_DIR}/extensions/ogr_wrap.cpp
${CMAKE_CURRENT_SOURCE_DIR}/extensions/osr_wrap.cpp)
set(GDAL_PYTHON_PYSOURCES
${CMAKE_CURRENT_BINARY_DIR}/osgeo/__init__.py
${CMAKE_CURRENT_BINARY_DIR}/osgeo/gdal.py
${CMAKE_CURRENT_BINARY_DIR}/osgeo/gdalconst.py
${CMAKE_CURRENT_BINARY_DIR}/osgeo/gdalnumeric.py
${CMAKE_CURRENT_BINARY_DIR}/osgeo/gnm.py
${CMAKE_CURRENT_BINARY_DIR}/osgeo/ogr.py
${CMAKE_CURRENT_BINARY_DIR}/osgeo/osr.py)
set(OSGEO_BINARY_DIR "${CMAKE_CURRENT_BINARY_DIR}/osgeo")
set(OSGEO_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/osgeo/")
if (Python_NumPy_FOUND)
list(APPEND GDAL_PYTHON_CSOURCES "${GDAL_PYTHON_CSOURCE_DIR}/gdal_array_wrap.cpp")
list(APPEND GDAL_PYTHON_CSOURCES_SRC "${CMAKE_CURRENT_SOURCE_DIR}/extensions/gdal_array_wrap.cpp")
list(APPEND GDAL_PYTHON_PYSOURCES "${CMAKE_CURRENT_BINARY_DIR}/osgeo/gdal_array.py")
endif ()
add_custom_command(
OUTPUT ${GDAL_PYTHON_PYSOURCES}
COMMAND
${CMAKE_COMMAND} -E copy ${OSGEO_SOURCE_DIR}__init__.py ${OSGEO_SOURCE_DIR}gdal.py
${OSGEO_SOURCE_DIR}gdalconst.py ${OSGEO_SOURCE_DIR}gdalnumeric.py ${OSGEO_SOURCE_DIR}ogr.py
${OSGEO_SOURCE_DIR}osr.py ${OSGEO_SOURCE_DIR}gnm.py ${OSGEO_SOURCE_DIR}gdal_array.py "${OSGEO_BINARY_DIR}")
set(GDAL_PYTHON_CSOURCE_SRC_DIR "${CMAKE_CURRENT_SOURCE_DIR}/extensions/")
add_custom_command(
OUTPUT ${GDAL_PYTHON_CSOURCES}
COMMAND
${CMAKE_COMMAND} -E copy_if_different ${GDAL_PYTHON_CSOURCE_SRC_DIR}gdal_wrap.cpp
${GDAL_PYTHON_CSOURCE_SRC_DIR}gdalconst_wrap.c ${GDAL_PYTHON_CSOURCE_SRC_DIR}gnm_wrap.cpp
${GDAL_PYTHON_CSOURCE_SRC_DIR}ogr_wrap.cpp ${GDAL_PYTHON_CSOURCE_SRC_DIR}osr_wrap.cpp
${GDAL_PYTHON_CSOURCE_SRC_DIR}gdal_array_wrap.cpp ${GDAL_PYTHON_CSOURCE_DIR}
DEPENDS ${GDAL_PYTHON_CSOURCES_SRC})
endif ()
add_custom_target(python_generated_files
DEPENDS ${GDAL_PYTHON_PYSOURCES} ${GDAL_PYTHON_CSOURCES}
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})
function (symlink_or_copy source destination)
if (CMAKE_VERSION VERSION_GREATER 3.14)
file(
CREATE_LINK ${source} ${destination}
RESULT res
SYMBOLIC)
if (NOT res EQUAL 0)
message(STATUS "Copying content of ${source} to ${destination}")
execute_process(COMMAND ${CMAKE_COMMAND} -E copy_directory ${source} ${destination})
endif ()
else ()
if (NOT CMAKE_HOST_SYSTEM_NAME STREQUAL "Windows")
execute_process(COMMAND ${CMAKE_COMMAND} -E create_symlink ${source} ${destination})
else ()
message(STATUS "Copying content of ${source} to ${destination}")
execute_process(COMMAND ${CMAKE_COMMAND} -E copy_directory ${source} ${destination})
endif ()
endif ()
endfunction ()
if (NOT "${CMAKE_BINARY_DIR}" STREQUAL "${CMAKE_SOURCE_DIR}")
symlink_or_copy(${CMAKE_CURRENT_SOURCE_DIR}/gdal-utils ${CMAKE_CURRENT_BINARY_DIR}/gdal-utils)
endif()
symlink_or_copy(${CMAKE_CURRENT_SOURCE_DIR}/gdal-utils/osgeo_utils ${CMAKE_CURRENT_BINARY_DIR}/osgeo_utils)
get_property(_isMultiConfig GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
if (_isMultiConfig AND WIN32)
set(ONLY_GENERATE_FOR_NON_DEBUG ON)
endif ()
if (Python_Interpreter_FOUND)
if (ENABLE_GNM)
set(GNM_ENABLED "True")
else ()
set(GNM_ENABLED "False")
endif ()
# Use the 'X.Y.Z' numbering scheme from libgdal by default for the gdal python package version number
# And append a ".patch" if the patch is not 0.
set(GDAL_PYTHON_VERSION "${GDAL_VERSION_NO_DEV_SUFFIX}")
if( NOT "${GDAL_VERSION_BUILD}" STREQUAL "0" )
string(APPEND GDAL_PYTHON_VERSION ".${GDAL_VERSION_BUILD}")
endif()
file(TO_NATIVE_PATH "${GDAL_PYTHON_CSOURCE_DIR}" GDAL_PYTHON_EXT_SOURCE_DIR)
if (_isMultiConfig)
set(GDAL_LIB_DIR "os.path.dirname('$<TARGET_FILE:${GDAL_LIB_TARGET_NAME}>')")
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/setup.py.in ${CMAKE_CURRENT_BINARY_DIR}/setup.py.tmp @ONLY)
if (ONLY_GENERATE_FOR_NON_DEBUG)
file(
GENERATE
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/setup.py
INPUT ${CMAKE_CURRENT_BINARY_DIR}/setup.py.tmp
CONDITION "$<CONFIG:Release>")
set(SETUP_PY_FILENAME "${CMAKE_CURRENT_BINARY_DIR}/setup_$<CONFIG>.py")
else ()
set(SETUP_PY_FILENAME "${CMAKE_CURRENT_BINARY_DIR}/setup.py")
endif ()
file(
GENERATE
OUTPUT "${SETUP_PY_FILENAME}"
INPUT ${CMAKE_CURRENT_BINARY_DIR}/setup.py.tmp)
else ()
# Do not use file(GENERATE) as, for some unknown reason, it would cause cmake to be reinvoked every time make is
# involved
get_target_property(_gdal_lib_directory ${GDAL_LIB_TARGET_NAME} LIBRARY_OUTPUT_DIRECTORY)
set(GDAL_LIB_DIR "'${_gdal_lib_directory}'")
set(SETUP_PY_FILENAME "${CMAKE_CURRENT_BINARY_DIR}/setup.py")
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/setup.py.in ${SETUP_PY_FILENAME} @ONLY)
endif ()
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/README.rst ${CMAKE_CURRENT_BINARY_DIR}/README.rst @ONLY)
file(WRITE ${CMAKE_CURRENT_BINARY_DIR}/get_suffix.py
"from importlib.machinery import EXTENSION_SUFFIXES; print(EXTENSION_SUFFIXES[0])\n")
execute_process(
COMMAND ${Python_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/get_suffix.py
OUTPUT_VARIABLE PY_EXT_SUFFIX
OUTPUT_STRIP_TRAILING_WHITESPACE)
set(PY_SO_LIST osgeo/_gdal${PY_EXT_SUFFIX} osgeo/_gdalconst${PY_EXT_SUFFIX} osgeo/_gnm${PY_EXT_SUFFIX}
osgeo/_ogr${PY_EXT_SUFFIX} osgeo/_osr${PY_EXT_SUFFIX})
if (Python_NumPy_FOUND)
set(PY_SO_LIST ${PY_SO_LIST} osgeo/_gdal_array${PY_EXT_SUFFIX})
endif ()
# Generate extension
if (CMAKE_VERSION VERSION_GREATER_EQUAL 3.20 )
cmake_path(CONVERT "${Python_EXECUTABLE}" TO_CMAKE_PATH_LIST Python_EXECUTABLE_CMAKE)
else()
set(Python_EXECUTABLE_CMAKE "${Python_EXECUTABLE}")
endif()
if (ONLY_GENERATE_FOR_NON_DEBUG)
set(BUILD_EXT_FILENAME "${CMAKE_CURRENT_BINARY_DIR}/build_ext_$<CONFIG>.cmake")
file(
GENERATE
OUTPUT "${BUILD_EXT_FILENAME}"
CONTENT
"file(REMOVE_RECURSE ${CMAKE_CURRENT_BINARY_DIR}/build)\n
execute_process(COMMAND $<IF:$<NOT:$<CONFIG:Debug>>,\"${Python_EXECUTABLE_CMAKE}\" \"${SETUP_PY_FILENAME}\" build_ext --inplace,${CMAKE_COMMAND} -E echo \"setup.py build_ext only run in configuration != Debug\">)\n"
)
else ()
set(BUILD_EXT_FILENAME "${CMAKE_CURRENT_BINARY_DIR}/build_ext.cmake")
file(
GENERATE
OUTPUT "${BUILD_EXT_FILENAME}"
CONTENT
"file(REMOVE_RECURSE ${CMAKE_CURRENT_BINARY_DIR}/build)\n
execute_process(COMMAND \"${Python_EXECUTABLE_CMAKE}\" \"${SETUP_PY_FILENAME}\" build_ext --inplace)\n")
endif ()
if((CMAKE_VERSION VERSION_GREATER_EQUAL 3.12) AND CMAKE_NM AND BUILD_SHARED_LIBS AND NOT _isMultiConfig)
# Optimization to avoid rebuilding the .o and .so each time libgdal
# is touched. We only consider the list of exported symbols as the
# dependency rule
set(GDAL_LIB_DEP_FOR_PY_SO "gdal_symbols.txt")
if(WIN32 OR APPLE)
set(NM_OPTIONS "-g")
else()
set(NM_OPTIONS "-gD")
endif()
file(
GENERATE
OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/generate_gdal_symbols_txt.cmake"
CONTENT
"cmake_policy(VERSION 3.12)
execute_process(COMMAND ${CMAKE_NM} ${NM_OPTIONS} $<TARGET_FILE:${GDAL_LIB_TARGET_NAME}>
OUTPUT_VARIABLE symbols
RESULT_VARIABLE res)
if( \${res} EQUAL 0 )
string(REGEX REPLACE \"\\n\" \";\" symbols \"\${symbols}\")
# Match lines like '00000000006dddb0 T GDALAllRegister'
list(FILTER symbols INCLUDE REGEX \"^[0-9a-f]+ T (.*)$\")
list(TRANSFORM symbols REPLACE \"^[0-9a-f]+ T (.*)$\" \"\\\\1\")
if(symbols)
list(SORT symbols)
file(WRITE ${GDAL_LIB_DEP_FOR_PY_SO}.tmp \"$<TARGET_FILE:${GDAL_LIB_TARGET_NAME}>;\${symbols}\")
execute_process(COMMAND ${CMAKE_COMMAND} -E copy_if_different ${GDAL_LIB_DEP_FOR_PY_SO}.tmp ${GDAL_LIB_DEP_FOR_PY_SO})
else()
file(TOUCH ${GDAL_LIB_DEP_FOR_PY_SO})
endif()
else()
file(TOUCH ${GDAL_LIB_DEP_FOR_PY_SO})
endif()")
add_custom_command(
OUTPUT ${GDAL_LIB_DEP_FOR_PY_SO}
COMMAND
${CMAKE_COMMAND} ${WERROR_DEV_FLAG} -P "generate_gdal_symbols_txt.cmake"
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
DEPENDS ${GDAL_LIB_TARGET_NAME})
else()
set(GDAL_LIB_DEP_FOR_PY_SO "${GDAL_LIB_TARGET_NAME}")
endif()
add_custom_command(
OUTPUT ${PY_SO_LIST}
COMMAND ${CMAKE_COMMAND} ${WERROR_DEV_FLAG} -P "${BUILD_EXT_FILENAME}"
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
DEPENDS ${GDAL_LIB_DEP_FOR_PY_SO} ${GDAL_PYTHON_PYSOURCES} ${GDAL_PYTHON_CSOURCES} "${BUILD_EXT_FILENAME}"
${PROJECT_SOURCE_DIR}/gcore/gdal_priv.h)
set(INSTALL_WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}")
set(PY_SO_LIST_WITH_RPATH)
if (NOT ONLY_GENERATE_FOR_NON_DEBUG)
if(${GDAL_SET_INSTALL_RELATIVE_RPATH})
# TODO: we should support that, but that's involved as it requires
# knowing where Python will install the generated .so files
message(WARNING "The Python bindings target does not currently "
"support setting relative RPATH on the Python wrapper "
"shared libraries. "
"Disable GDAL_SET_INSTALL_RELATIVE_RPATH and set "
"an absolute value for CMAKE_INSTALL_RPATH")
elseif(NOT "${CMAKE_INSTALL_RPATH}" STREQUAL "")
# If a CMAKE_INSTALL_RPATH is specified, we need to do a build in a
# dedicated "for_install" subdirectory that adds --rpath to python setup.py build_ext
# and install that one when the "install" target is run
# We cannot set this install rpath to regular build artifacts, to avoid
# inconsistencies.
# This is admittedly quite convoluted because CMake cannot do the usual
# magic of setting/unsetting RPATH on binaries it is not aware of.
set(INSTALL_WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/for_install")
file(MAKE_DIRECTORY "${INSTALL_WORKING_DIRECTORY}")
# We need to copy a few things from the build directory to the for_install one:
# the gdal-utils and extensions subdirectories, README.rst, and osgeo/*.py files
file(MAKE_DIRECTORY "${INSTALL_WORKING_DIRECTORY}/osgeo")
symlink_or_copy("${CMAKE_CURRENT_SOURCE_DIR}/gdal-utils" "${INSTALL_WORKING_DIRECTORY}/gdal-utils")
set(BUILD_EXT_WITH_RPATH_CONTENT)
string(APPEND BUILD_EXT_WITH_RPATH_CONTENT "configure_file(\"${CMAKE_CURRENT_SOURCE_DIR}/README.rst\" \"${INSTALL_WORKING_DIRECTORY}/README.rst\" @ONLY)\n")
string(APPEND BUILD_EXT_WITH_RPATH_CONTENT "file(COPY \"${CMAKE_CURRENT_BINARY_DIR}/extensions\" DESTINATION \"${INSTALL_WORKING_DIRECTORY}\")\n")
string(APPEND BUILD_EXT_WITH_RPATH_CONTENT "file(GLOB PY_FILES \"${CMAKE_CURRENT_BINARY_DIR}/osgeo/*.py\")\n")
string(APPEND BUILD_EXT_WITH_RPATH_CONTENT "foreach(_file IN LISTS PY_FILES)\n")
string(APPEND BUILD_EXT_WITH_RPATH_CONTENT " file(COPY \"\${_file}\" DESTINATION \"${INSTALL_WORKING_DIRECTORY}/osgeo\")\n")
string(APPEND BUILD_EXT_WITH_RPATH_CONTENT "endforeach()\n")
string(APPEND BUILD_EXT_WITH_RPATH_CONTENT "file(REMOVE_RECURSE ${INSTALL_WORKING_DIRECTORY}/build)\n")
string(APPEND BUILD_EXT_WITH_RPATH_CONTENT "execute_process(COMMAND ${Python_EXECUTABLE_CMAKE} ${SETUP_PY_FILENAME} build_ext --rpath=${CMAKE_INSTALL_RPATH} --inplace WORKING_DIRECTORY ${INSTALL_WORKING_DIRECTORY})\n")
foreach (f IN LISTS PY_SO_LIST)
list(APPEND PY_SO_LIST_WITH_RPATH "${INSTALL_WORKING_DIRECTORY}/${f}")
endforeach ()
set(BUILD_EXT_WITH_RPATH_FILENAME ${CMAKE_CURRENT_BINARY_DIR}/build_ext_with_rpath.cmake)
file(
GENERATE
OUTPUT ${BUILD_EXT_WITH_RPATH_FILENAME}
CONTENT "${BUILD_EXT_WITH_RPATH_CONTENT}")
add_custom_command(
OUTPUT ${PY_SO_LIST_WITH_RPATH}
COMMAND ${CMAKE_COMMAND} ${WERROR_DEV_FLAG} -P ${BUILD_EXT_WITH_RPATH_FILENAME}
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
DEPENDS ${GDAL_LIB_DEP_FOR_PY_SO} ${GDAL_PYTHON_PYSOURCES} ${GDAL_PYTHON_CSOURCES} ${BUILD_EXT_WITH_RPATH_FILENAME}
${PROJECT_SOURCE_DIR}/gcore/gdal_priv.h)
endif()
endif()
add_custom_target(python_binding ALL DEPENDS ${PY_SO_LIST} ${PY_SO_LIST_WITH_RPATH} ${GDAL_PYTHON_PYSOURCES} ${GDAL_LIB_TARGET_NAME})
# Generate wheel
if (ONLY_GENERATE_FOR_NON_DEBUG)
set(BUILD_BDIST_WHEEL_FILENAME ${CMAKE_CURRENT_BINARY_DIR}/build_bdist_wheel_$<CONFIG>.cmake)
file(
GENERATE
OUTPUT ${BUILD_BDIST_WHEEL_FILENAME}
CONTENT
"execute_process(COMMAND $<IF:$<NOT:$<CONFIG:Debug>>,${Python_EXECUTABLE_CMAKE} ${SETUP_PY_FILENAME} bdist_wheel,${CMAKE_COMMAND} -E echo \"setup.py bdist_wheel only run in configuration != Debug\">)"
)
else ()
set(BUILD_BDIST_WHEEL_FILENAME ${CMAKE_CURRENT_BINARY_DIR}/build_bdist_wheel.cmake)
file(WRITE ${BUILD_BDIST_WHEEL_FILENAME} "execute_process(COMMAND ${Python_EXECUTABLE_CMAKE} ${SETUP_PY_FILENAME} bdist_wheel)\n")
endif ()
add_custom_target(
python_wheel
COMMAND ${CMAKE_COMMAND} ${WERROR_DEV_FLAG} -P ${BUILD_BDIST_WHEEL_FILENAME}
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
DEPENDS ${PY_SO_LIST})
# Install extension
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/trimmedsysconfig.py ${CMAKE_CURRENT_BINARY_DIR}/trimmedsysconfig.py @ONLY)
file(WRITE ${CMAKE_CURRENT_BINARY_DIR}/get_python_lib.py
"from trimmedsysconfig import get_python_lib;print(get_python_lib(prefix=\"${GDAL_PYTHON_INSTALL_PREFIX}\"))\n")
execute_process(
COMMAND ${Python_EXECUTABLE_CMAKE} ${CMAKE_CURRENT_BINARY_DIR}/get_python_lib.py
OUTPUT_VARIABLE SITE_PACKAGE_DIR
OUTPUT_STRIP_TRAILING_WHITESPACE)
set(INSTALL_ARGS "--single-version-externally-managed --record=record.txt")
if (DEFINED GDAL_PYTHON_INSTALL_PREFIX)
file(TO_NATIVE_PATH "${GDAL_PYTHON_INSTALL_PREFIX}" NATIVE_GDAL_PYTHON_INSTALL_PREFIX)
if (WIN32)
string(REPLACE "\\" "\\\\" NATIVE_GDAL_PYTHON_INSTALL_PREFIX "${NATIVE_GDAL_PYTHON_INSTALL_PREFIX}")
endif ()
set(INSTALL_ARGS "${INSTALL_ARGS} \"--prefix=${NATIVE_GDAL_PYTHON_INSTALL_PREFIX}\"")
elseif (CMAKE_INSTALL_PREFIX)
file(TO_NATIVE_PATH "${CMAKE_INSTALL_PREFIX}" NATIVE_CMAKE_INSTALL_PREFIX)
if (WIN32)
string(REPLACE "\\" "\\\\" NATIVE_CMAKE_INSTALL_PREFIX "${NATIVE_CMAKE_INSTALL_PREFIX}")
endif ()
if (${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
file(WRITE ${CMAKE_CURRENT_BINARY_DIR}/is_std_unix_layout.py
"import sys;print(\"FALSE\" if \"framework\" in sys.prefix.lower() else \"TRUE\")\n")
execute_process(
COMMAND ${Python_EXECUTABLE_CMAKE} ${CMAKE_CURRENT_BINARY_DIR}/is_std_unix_layout.py
OUTPUT_VARIABLE STD_UNIX_LAYOUT
OUTPUT_STRIP_TRAILING_WHITESPACE)
if ("${STD_UNIX_LAYOUT}" STREQUAL "TRUE")
set(INSTALL_ARGS "${INSTALL_ARGS} \"--prefix=${NATIVE_CMAKE_INSTALL_PREFIX}\"")
elseif (DEFINED GDAL_PYTHON_INSTALL_LIB)
set(INSTALL_ARGS "${INSTALL_ARGS} \"--install-lib=${GDAL_PYTHON_INSTALL_LIB}\"")
endif ()
else ()
set(INSTALL_ARGS "${INSTALL_ARGS} \"--prefix=${NATIVE_CMAKE_INSTALL_PREFIX}\"")
endif ()
endif ()
# setuptools 60.0 defaults to SETUPTOOLS_USE_DISTUTILS=local, and thus Debian's specific --install-layout distutils
# option cannot be used
if (DEFINED GDAL_PYTHON_INSTALL_LAYOUT)
set(INSTALL_ARGS "${INSTALL_ARGS} --install-layout=${GDAL_PYTHON_INSTALL_LAYOUT}")
set(SETUPTOOLS_USE_DISTUTILS stdlib)
elseif ("${SITE_PACKAGE_DIR}" MATCHES "dist-packages")
set(INSTALL_ARGS "${INSTALL_ARGS} --install-layout=deb")
set(SETUPTOOLS_USE_DISTUTILS stdlib)
endif ()
if (ONLY_GENERATE_FOR_NON_DEBUG)
if (POLICY CMP0087)
# install(SCRIPT) can use generator expressions, since CMake 3.14
cmake_policy(SET CMP0087 NEW)
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/install_python.cmake.in ${CMAKE_CURRENT_BINARY_DIR}/install_python.cmake.tmp
@ONLY)
file(
GENERATE
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/install_python_$<CONFIG>.cmake
INPUT ${CMAKE_CURRENT_BINARY_DIR}/install_python.cmake.tmp
)
file(
GENERATE
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/install_binding_$<CONFIG>.cmake
CONTENT
"execute_process(COMMAND $<IF:$<NOT:$<CONFIG:Debug>>,${CMAKE_COMMAND} ${WERROR_DEV_FLAG} -P ${CMAKE_CURRENT_BINARY_DIR}/install_python_$<CONFIG>.cmake,${CMAKE_COMMAND} -E echo \"setup.py install only run in configuration != Debug\">
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})")
install(SCRIPT ${CMAKE_CURRENT_BINARY_DIR}/install_binding_$<CONFIG>.cmake)
else ()
message(WARNING "Installing Python bindings with a multi generator requires CMake >= 3.14")
endif ()
else ()
configure_file("${CMAKE_CURRENT_SOURCE_DIR}/install_python.cmake.in" "${CMAKE_CURRENT_BINARY_DIR}/install_python.cmake"
@ONLY)
install(
CODE "execute_process(COMMAND ${CMAKE_COMMAND} ${WERROR_DEV_FLAG} -P \"${CMAKE_CURRENT_BINARY_DIR}/install_python.cmake\"
WORKING_DIRECTORY \"${INSTALL_WORKING_DIRECTORY}\")")
endif ()
elseif (Python_Development_FOUND)
macro (py_ext name v source)
set(GDAL_PYTHON_EXT_SOURCE_DIR "${GDAL_PYTHON_CSOURCE_DIR}")
python_add_library(${name}${v} MODULE ${GDAL_PYTHON_EXT_SOURCE_DIR}/${source})
set_property(TARGET ${name}${v} PROPERTY LIBRARY_OUTPUT_NAME ${name})
if (_isMultiConfig)
set_target_properties(
${name}${v}
PROPERTIES LIBRARY_OUTPUT_NAME ${name}
LIBRARY_OUTPUT_DIRECTORY_DEBUG ${CMAKE_CURRENT_BINARY_DIR}/debug/osgeo
LIBRARY_OUTPUT_DIRECTORY_REL ${CMAKE_CURRENT_BINARY_DIR}/osgeo)
else ()
set_target_properties(${name}${v} PROPERTIES LIBRARY_OUTPUT_NAME ${name} LIBRARY_OUTPUT_DIRECTORY
${CMAKE_CURRENT_BINARY_DIR}/osgeo)
endif ()
gdal_standard_includes(${name}${v})
target_include_directories(${name}${v} PRIVATE $<TARGET_PROPERTY:appslib,SOURCE_DIR>
$<TARGET_PROPERTY:gnm,SOURCE_DIR>)
if (CMAKE_SYSTEM_NAME STREQUAL "Windows")
target_compile_definitions(${name}${v} PRIVATE -D__MSVCRT_VERSION__=0x0601)
endif ()
target_link_libraries(${name}${v} PRIVATE $<TARGET_NAME:${GDAL_LIB_TARGET_NAME}>)
install(
TARGETS ${name}${v}
COMPONENT python
DESTINATION ${Python_SITEARCH}/osgeo)
endmacro ()
set(v ${Python_VERSION_MAJOR})
py_ext(_gdal ${v} gdal_wrap.cpp)
py_ext(_gdalconst ${v} gdalconst_wrap.c)
py_ext(_gnm ${v} gnm_wrap.cpp)
py_ext(_ogr ${v} ogr_wrap.cpp)
py_ext(_osr ${v} osr_wrap.cpp)
set(_py_depends)
if (Python_NumPy_FOUND)
py_ext(_gdal_array ${v} gdal_array_wrap.cpp)
target_include_directories(_gdal_array${v} PRIVATE ${Python_NumPy_INCLUDE_DIRS})
list(APPEND _py_depends _gdal_array${v})
endif ()
if (ENABLE_GNM)
list(APPEND _py_depends _gnm${v})
endif ()
add_custom_target(
python_ext_mod
DEPENDS _gdal${v} _gdalconst${v} _ogr${v} _osr${v} ${_py_depends}
COMMENT "Build python binding modules.")
add_custom_target(
python_binding ALL
DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/osgeo/__init__.py
${CMAKE_CURRENT_BINARY_DIR}/osgeo/gdal.py
${CMAKE_CURRENT_BINARY_DIR}/osgeo/gdalconst.py
${CMAKE_CURRENT_BINARY_DIR}/osgeo/gdalnumeric.py
${CMAKE_CURRENT_BINARY_DIR}/osgeo/gnm.py
${CMAKE_CURRENT_BINARY_DIR}/osgeo/ogr.py
${CMAKE_CURRENT_BINARY_DIR}/osgeo/osr.py
python_ext_mod
COMMENT "Build all python binding files.")
install(
FILES ${CMAKE_CURRENT_BINARY_DIR}/osgeo/__init__.py
${CMAKE_CURRENT_BINARY_DIR}/osgeo/gdal.py
${CMAKE_CURRENT_BINARY_DIR}/osgeo/gdalconst.py
${CMAKE_CURRENT_BINARY_DIR}/osgeo/gdalnumeric.py
${CMAKE_CURRENT_BINARY_DIR}/osgeo/gnm.py
${CMAKE_CURRENT_BINARY_DIR}/osgeo/ogr.py
${CMAKE_CURRENT_BINARY_DIR}/osgeo/osr.py
COMPONENT python
DESTINATION ${Python_SITELIB}/osgeo)
else ()
endif ()
|
