FindGDAL.cmake 6.46 KB
Newer Older
1
2
3
# Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
# file Copyright.txt or https://cmake.org/licensing for details.

4
5
6
7
#[=======================================================================[.rst:
FindGDAL
--------

8
Find Geospatial Data Abstraction Library (GDAL).
9

Ben Boeckel's avatar
Ben Boeckel committed
10
11
12
IMPORTED Targets
^^^^^^^^^^^^^^^^

13
14
.. versionadded:: 3.14

Ben Boeckel's avatar
Ben Boeckel committed
15
16
17
This module defines :prop_tgt:`IMPORTED` target ``GDAL::GDAL``
if GDAL has been found.

18
19
Result Variables
^^^^^^^^^^^^^^^^
20

21
This module will set the following variables in your project:
22

23
24
25
26
27
28
``GDAL_FOUND``
  True if GDAL is found.
``GDAL_INCLUDE_DIRS``
  Include directories for GDAL headers.
``GDAL_LIBRARIES``
  Libraries to link to GDAL.
Ben Boeckel's avatar
Ben Boeckel committed
29
``GDAL_VERSION``
30
31
  .. versionadded:: 3.14
    The version of GDAL found.
32

33
34
Cache variables
^^^^^^^^^^^^^^^
35

36
The following cache variables may also be set:
37

38
39
40
41
``GDAL_LIBRARY``
  The libgdal library file.
``GDAL_INCLUDE_DIR``
  The directory containing ``gdal.h``.
42

43
44
Hints
^^^^^
45

46
47
Set ``GDAL_DIR`` or ``GDAL_ROOT`` in the environment to specify the
GDAL installation prefix.
48
49
50
51
52
53
54

The following variables may be set to modify the search strategy:

``FindGDAL_SKIP_GDAL_CONFIG``
  If set, ``gdal-config`` will not be used. This can be useful if there are
  GDAL libraries built with autotools (which provide the tool) and CMake (which
  do not) in the same environment.
55
56
``GDAL_ADDITIONAL_LIBRARY_VERSIONS``
  Extra versions of library names to search for.
57
#]=======================================================================]
58

59
60
61
62
# $GDALDIR is an environment variable that would
# correspond to the ./configure --prefix=$GDAL_DIR
# used in building gdal.
#
63
# Created by Eric Wing. I'm not a gdal user, but OpenSceneGraph uses it
64
65
66
67
# for osgTerrain so I whipped this module together for completeness.
# I actually don't know the conventions or where files are typically
# placed in distros.
# Any real gdal users are encouraged to correct this (but please don't
68
# break the OS X framework stuff when doing so which is what usually seems
69
70
71
# to happen).

# This makes the presumption that you are include gdal.h like
72
73
#
#include "gdal.h"
74

75
find_path(GDAL_INCLUDE_DIR gdal.h
76
  HINTS
77
78
    ENV GDAL_DIR
    ENV GDAL_ROOT
79
  PATH_SUFFIXES
Ben Boeckel's avatar
Ben Boeckel committed
80
81
82
    include/gdal
    include/GDAL
    include
83
  DOC "Path to the GDAL include directory"
84
)
85
mark_as_advanced(GDAL_INCLUDE_DIR)
86

87
if(UNIX AND NOT FindGDAL_SKIP_GDAL_CONFIG)
88
89
90
91
    # Use gdal-config to obtain the library version (this should hopefully
    # allow us to -lgdal1.x.y where x.y are correct version)
    # For some reason, libgdal development packages do not contain
    # libgdal.so...
92
    find_program(GDAL_CONFIG gdal-config
93
        HINTS
94
95
          ENV GDAL_DIR
          ENV GDAL_ROOT
96
        PATH_SUFFIXES bin
97
        DOC "Path to the gdal-config tool"
98
    )
99
    mark_as_advanced(GDAL_CONFIG)
100
101

    if(GDAL_CONFIG)
102
        execute_process(COMMAND ${GDAL_CONFIG} --libs OUTPUT_VARIABLE GDAL_CONFIG_LIBS)
103

104
        if(GDAL_CONFIG_LIBS)
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
            # treat the output as a command line and split it up
            separate_arguments(args NATIVE_COMMAND "${GDAL_CONFIG_LIBS}")

            # only consider libraries whose name matches this pattern
            set(name_pattern "[gG][dD][aA][lL]")

            # consider each entry as a possible library path, name, or parent directory
            foreach(arg IN LISTS args)
                # library name
                if("${arg}" MATCHES "^-l(.*)$")
                    set(lib "${CMAKE_MATCH_1}")

                    # only consider libraries whose name matches the expected pattern
                    if("${lib}" MATCHES "${name_pattern}")
                        list(APPEND _gdal_lib "${lib}")
                    endif()
                # library search path
                elseif("${arg}" MATCHES "^-L(.*)$")
                    list(APPEND _gdal_libpath "${CMAKE_MATCH_1}")
                # assume this is a full path to a library
                elseif(IS_ABSOLUTE "${arg}" AND EXISTS "${arg}")
                    # extract the file name
                    get_filename_component(lib "${arg}" NAME)

                    # only consider libraries whose name matches the expected pattern
                    if(NOT "${lib}" MATCHES "${name_pattern}")
                        continue()
                    endif()

                    # extract the file directory
                    get_filename_component(dir "${arg}" DIRECTORY)

                    # remove library prefixes/suffixes
                    string(REGEX REPLACE "^(${CMAKE_SHARED_LIBRARY_PREFIX}|${CMAKE_STATIC_LIBRARY_PREFIX})" "" lib "${lib}")
                    string(REGEX REPLACE "(${CMAKE_SHARED_LIBRARY_SUFFIX}|${CMAKE_STATIC_LIBRARY_SUFFIX})$" "" lib "${lib}")

                    # use the file name and directory as hints
                    list(APPEND _gdal_libpath "${dir}")
                    list(APPEND _gdal_lib "${lib}")
                endif()
            endforeach()
146
147
148
149
        endif()
    endif()
endif()

150
151
152
153
154
155
156
157
158
159
160
161
# GDAL name its library when built with CMake as `gdal${major}${minor}`.
set(_gdal_versions
    ${GDAL_ADDITIONAL_LIBRARY_VERSIONS} 3.0 2.4 2.3 2.2 2.1 2.0 1.11 1.10 1.9 1.8 1.7 1.6 1.5 1.4 1.3 1.2)

set(_gdal_libnames)
foreach (_gdal_version IN LISTS _gdal_versions)
    string(REPLACE "." "" _gdal_version "${_gdal_version}")
    list(APPEND _gdal_libnames "gdal${_gdal_version}" "GDAL${_gdal_version}")
endforeach ()
unset(_gdal_version)
unset(_gdal_versions)

162
find_library(GDAL_LIBRARY
163
  NAMES ${_gdal_lib} ${_gdal_libnames} gdal gdal_i gdal1.5.0 gdal1.4.0 gdal1.3.2 GDAL
164
  HINTS
165
166
     ENV GDAL_DIR
     ENV GDAL_ROOT
167
     ${_gdal_libpath}
168
  PATH_SUFFIXES lib
169
  DOC "Path to the GDAL library"
170
)
171
mark_as_advanced(GDAL_LIBRARY)
172
173
unset(_gdal_libnames)
unset(_gdal_lib)
174

Ben Boeckel's avatar
Ben Boeckel committed
175
176
177
178
179
180
181
182
183
if (EXISTS "${GDAL_INCLUDE_DIR}/gdal_version.h")
    file(STRINGS "${GDAL_INCLUDE_DIR}/gdal_version.h" _gdal_version
        REGEX "GDAL_RELEASE_NAME")
    string(REGEX REPLACE ".*\"\(.*\)\"" "\\1" GDAL_VERSION "${_gdal_version}")
    unset(_gdal_version)
else ()
    set(GDAL_VERSION GDAL_VERSION-NOTFOUND)
endif ()

184
include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake)
Ben Boeckel's avatar
Ben Boeckel committed
185
186
187
FIND_PACKAGE_HANDLE_STANDARD_ARGS(GDAL
    VERSION_VAR GDAL_VERSION
    REQUIRED_VARS GDAL_LIBRARY GDAL_INCLUDE_DIR)
188

189
190
191
192
193
194
195
196
197
198
if (GDAL_FOUND)
    set(GDAL_LIBRARIES ${GDAL_LIBRARY})
    set(GDAL_INCLUDE_DIRS ${GDAL_INCLUDE_DIR})

    if (NOT TARGET GDAL::GDAL)
        add_library(GDAL::GDAL UNKNOWN IMPORTED)
        set_target_properties(GDAL::GDAL PROPERTIES
            IMPORTED_LOCATION "${GDAL_LIBRARY}"
            INTERFACE_INCLUDE_DIRECTORIES "${GDAL_INCLUDE_DIR}")
    endif ()
Ben Boeckel's avatar
Ben Boeckel committed
199
endif ()