FindSDL.cmake 7.55 KB
Newer Older
1 2 3 4 5 6
#.rst:
# FindSDL
# -------
#
# Locate SDL library
#
Ken Martin's avatar
Ken Martin committed
7
# This module defines
8 9 10 11 12 13 14 15 16
#
# ::
#
#   SDL_LIBRARY, the name of the library to link against
#   SDL_FOUND, if false, do not try to link to SDL
#   SDL_INCLUDE_DIR, where to find SDL.h
#   SDL_VERSION_STRING, human-readable string containing the version of SDL
#
#
17
#
18
# This module responds to the flag:
19 20 21 22 23 24 25
#
# ::
#
#   SDL_BUILDING_LIBRARY
#     If this is defined, then no SDL_main will be linked in because
#     only applications need main().
#     Otherwise, it is assumed you are building an application and this
26
#     module will attempt to locate and set the proper link flags
27 28 29
#     as part of the returned SDL_LIBRARY variable.
#
#
30
#
31
# Don't forget to include SDLmain.h and SDLmain.m your project for the
32
# OS X framework based version.  (Other versions link to -lSDLmain which
33
# this module will try to find on your behalf.) Also for OS X, this
34
# module will automatically add the -framework Cocoa on your behalf.
35 36
#
#
37 38 39 40 41 42 43 44 45 46
#
# Additional Note: If you see an empty SDL_LIBRARY_TEMP in your
# configuration and no SDL_LIBRARY, it means CMake did not find your SDL
# library (SDL.dll, libsdl.so, SDL.framework, etc).  Set
# SDL_LIBRARY_TEMP to point to your SDL library, and configure again.
# Similarly, if you see an empty SDLMAIN_LIBRARY, you should set this
# value as appropriate.  These values are used to generate the final
# SDL_LIBRARY variable, but when these values are unset, SDL_LIBRARY
# does not get created.
#
47 48
#
#
49 50
# $SDLDIR is an environment variable that would correspond to the
# ./configure --prefix=$SDLDIR used in building SDL.  l.e.galup 9-20-02
51
#
52 53 54 55 56 57 58 59
# Modified by Eric Wing.  Added code to assist with automated building
# by using environmental variables and providing a more
# controlled/consistent search behavior.  Added new modifications to
# recognize OS X frameworks and additional Unix paths (FreeBSD, etc).
# Also corrected the header search path to follow "proper" SDL
# guidelines.  Added a search for SDLmain which is needed by some
# platforms.  Added a search for threads which is needed by some
# platforms.  Added needed compile switches for MinGW.
60 61
#
# On OSX, this will prefer the Framework version (if found) over others.
62 63
# People will have to manually change the cache values of SDL_LIBRARY to
# override this selection or set the CMake environment
64
# CMAKE_INCLUDE_PATH to modify the search paths.
65 66
#
# Note that the header path has changed from SDL/SDL.h to just SDL.h
67 68 69
# This needed to change because "proper" SDL convention is #include
# "SDL.h", not <SDL/SDL.h>.  This is done for portability reasons
# because not all systems place things in SDL/ (see FreeBSD).
70

71 72
#=============================================================================
# Copyright 2003-2009 Kitware, Inc.
73
# Copyright 2012 Benjamin Eikel
74 75 76 77 78 79 80 81
#
# Distributed under the OSI-approved BSD License (the "License");
# see accompanying file Copyright.txt for details.
#
# This software is distributed WITHOUT ANY WARRANTY; without even the
# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# See the License for more information.
#=============================================================================
82
# (To distribute this file outside of CMake, substitute the full
83 84
#  License text for the above reference.)

85
find_path(SDL_INCLUDE_DIR SDL.h
86
  HINTS
87
    ENV SDLDIR
88 89 90
  PATH_SUFFIXES SDL SDL12 SDL11
                # path suffixes to search inside ENV{SDLDIR}
                include/SDL include/SDL12 include/SDL11 include
91 92
)

93 94 95 96 97 98
if(CMAKE_SIZEOF_VOID_P EQUAL 8)
  set(VC_LIB_PATH_SUFFIX lib/x64)
else()
  set(VC_LIB_PATH_SUFFIX lib/x86)
endif()

99 100
# SDL-1.1 is the name used by FreeBSD ports...
# don't confuse it for the version number.
101
find_library(SDL_LIBRARY_TEMP
102
  NAMES SDL SDL-1.1
103
  HINTS
104
    ENV SDLDIR
105
  PATH_SUFFIXES lib ${VC_LIB_PATH_SUFFIX}
106
)
107

108
if(NOT SDL_BUILDING_LIBRARY)
109
  if(NOT SDL_INCLUDE_DIR MATCHES ".framework")
110 111
    # Non-OS X framework versions expect you to also dynamically link to
    # SDLmain. This is mainly for Windows and OS X. Other (Unix) platforms
112 113
    # seem to provide SDLmain for compatibility even though they don't
    # necessarily need it.
114
    find_library(SDLMAIN_LIBRARY
115
      NAMES SDLmain SDLmain-1.1
116
      HINTS
117
        ENV SDLDIR
118
      PATH_SUFFIXES lib ${VC_LIB_PATH_SUFFIX}
119 120 121 122 123
      PATHS
      /sw
      /opt/local
      /opt/csw
      /opt
124
    )
125 126
  endif()
endif()
Ken Martin's avatar
Ken Martin committed
127

128
# SDL may require threads on your system.
129 130
# The Apple build may not need an explicit flag because one of the
# frameworks may already provide it.
131
# But for non-OSX systems, I will use the CMake Threads package.
132 133
if(NOT APPLE)
  find_package(Threads)
134
endif()
Ken Martin's avatar
Ken Martin committed
135

136 137 138
# MinGW needs an additional library, mwindows
# It's total link flags should look like -lmingw32 -lSDLmain -lSDL -lmwindows
# (Actually on second look, I think it only needs one of the m* libraries.)
139 140
if(MINGW)
  set(MINGW32_LIBRARY mingw32 CACHE STRING "mwindows for MinGW")
141
endif()
Ken Martin's avatar
Ken Martin committed
142

143
if(SDL_LIBRARY_TEMP)
144
  # For SDLmain
145 146 147
  if(SDLMAIN_LIBRARY AND NOT SDL_BUILDING_LIBRARY)
    list(FIND SDL_LIBRARY_TEMP "${SDLMAIN_LIBRARY}" _SDL_MAIN_INDEX)
    if(_SDL_MAIN_INDEX EQUAL -1)
148
      set(SDL_LIBRARY_TEMP "${SDLMAIN_LIBRARY}" ${SDL_LIBRARY_TEMP})
149
    endif()
150
    unset(_SDL_MAIN_INDEX)
151
  endif()
152 153

  # For OS X, SDL uses Cocoa as a backend so it must link to Cocoa.
154
  # CMake doesn't display the -framework Cocoa string in the UI even
155 156
  # though it actually is there if I modify a pre-used variable.
  # I think it has something to do with the CACHE STRING.
157
  # So I use a temporary variable until the end so I can set the
158
  # "real" variable in one-shot.
159 160
  if(APPLE)
    set(SDL_LIBRARY_TEMP ${SDL_LIBRARY_TEMP} "-framework Cocoa")
161
  endif()
162

163
  # For threads, as mentioned Apple doesn't need this.
164
  # In fact, there seems to be a problem if I used the Threads package
165
  # and try using this line, so I'm just skipping it entirely for OS X.
166 167
  if(NOT APPLE)
    set(SDL_LIBRARY_TEMP ${SDL_LIBRARY_TEMP} ${CMAKE_THREAD_LIBS_INIT})
168
  endif()
169 170

  # For MinGW library
171 172
  if(MINGW)
    set(SDL_LIBRARY_TEMP ${MINGW32_LIBRARY} ${SDL_LIBRARY_TEMP})
173
  endif()
174

175
  # Set the final string here so the GUI reflects the final state.
176
  set(SDL_LIBRARY ${SDL_LIBRARY_TEMP} CACHE STRING "Where the SDL Library can be found")
177
  # Set the temp variable to INTERNAL so it is not seen in the CMake GUI
178
  set(SDL_LIBRARY_TEMP "${SDL_LIBRARY_TEMP}" CACHE INTERNAL "")
179
endif()
180

181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
if(SDL_INCLUDE_DIR AND EXISTS "${SDL_INCLUDE_DIR}/SDL_version.h")
  file(STRINGS "${SDL_INCLUDE_DIR}/SDL_version.h" SDL_VERSION_MAJOR_LINE REGEX "^#define[ \t]+SDL_MAJOR_VERSION[ \t]+[0-9]+$")
  file(STRINGS "${SDL_INCLUDE_DIR}/SDL_version.h" SDL_VERSION_MINOR_LINE REGEX "^#define[ \t]+SDL_MINOR_VERSION[ \t]+[0-9]+$")
  file(STRINGS "${SDL_INCLUDE_DIR}/SDL_version.h" SDL_VERSION_PATCH_LINE REGEX "^#define[ \t]+SDL_PATCHLEVEL[ \t]+[0-9]+$")
  string(REGEX REPLACE "^#define[ \t]+SDL_MAJOR_VERSION[ \t]+([0-9]+)$" "\\1" SDL_VERSION_MAJOR "${SDL_VERSION_MAJOR_LINE}")
  string(REGEX REPLACE "^#define[ \t]+SDL_MINOR_VERSION[ \t]+([0-9]+)$" "\\1" SDL_VERSION_MINOR "${SDL_VERSION_MINOR_LINE}")
  string(REGEX REPLACE "^#define[ \t]+SDL_PATCHLEVEL[ \t]+([0-9]+)$" "\\1" SDL_VERSION_PATCH "${SDL_VERSION_PATCH_LINE}")
  set(SDL_VERSION_STRING ${SDL_VERSION_MAJOR}.${SDL_VERSION_MINOR}.${SDL_VERSION_PATCH})
  unset(SDL_VERSION_MAJOR_LINE)
  unset(SDL_VERSION_MINOR_LINE)
  unset(SDL_VERSION_PATCH_LINE)
  unset(SDL_VERSION_MAJOR)
  unset(SDL_VERSION_MINOR)
  unset(SDL_VERSION_PATCH)
endif()

197
include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake)
198

199
FIND_PACKAGE_HANDLE_STANDARD_ARGS(SDL
200 201
                                  REQUIRED_VARS SDL_LIBRARY SDL_INCLUDE_DIR
                                  VERSION_VAR SDL_VERSION_STRING)