Merge pull request #236 from d235j/sdl2-finder

Adjust FindSDL2 to hopefully be able to find the framework on Mac (take two)
OSVR · Oct 12, 2015 · d9e05ed · d9e05ed
2 parents 054608e + bd0139d
commit d9e05ed
Showing 1 changed file with 112 additions and 52 deletions.
diff --git a/cmake/FindSDL2.cmake b/cmake/FindSDL2.cmake
@@ -56,24 +56,51 @@ endif()
 
 include(FindPackageHandleStandardArgs)
 
-find_path(SDL2_INCLUDE_DIR
+find_library(SDL2_LIBRARY
 	NAMES
-	SDL_haptic.h # this file was introduced with SDL2
+	SDL2
 	HINTS
-	${SDL2_INCLUDE_HINTS}
+	${SDL2_LIB_HINTS}
 	PATHS
 	${SDL2_ROOT_DIR}
 	ENV SDL2DIR
-	PATH_SUFFIXES include include/sdl2)
-find_library(SDL2_LIBRARY
+	PATH_SUFFIXES lib SDL2 ${SDL2_LIB_PATH_SUFFIX})
+
+set(_sdl2_framework FALSE)
+# Some special-casing if we've found/been given a framework.
+# Handles whether we're given the library inside the framework or the framework itself.
+if(APPLE AND "${SDL2_LIBRARY}" MATCHES "(/[^/]+)*.framework(/.*)?$")
+	set(_sdl2_framework TRUE)
+	set(SDL2_FRAMEWORK "${SDL2_LIBRARY}")
+	# Move up in the directory tree as required to get the framework directory.
+	while("${SDL2_FRAMEWORK}" MATCHES "(/[^/]+)*.framework(/.*)$" AND NOT "${SDL2_FRAMEWORK}" MATCHES "(/[^/]+)*.framework$")
+		get_filename_component(SDL2_FRAMEWORK "${SDL2_FRAMEWORK}" DIRECTORY)
+	endwhile()
+	if("${SDL2_FRAMEWORK}" MATCHES "(/[^/]+)*.framework$")
+		set(SDL2_FRAMEWORK_NAME ${CMAKE_MATCH_1})
+		# If we found a framework, do a search for the header ahead of time that will be more likely to get the framework header.
+		find_path(SDL2_INCLUDE_DIR
+			NAMES
+			SDL_haptic.h # this file was introduced with SDL2
+			HINTS
+			"${SDL2_FRAMEWORK}/Headers/")
+	else()
+		# For some reason we couldn't get the framework directory itself.
+		# Shouldn't happen, but might if something is weird.
+		unset(SDL2_FRAMEWORK)
+	endif()
+endif()
+
+find_path(SDL2_INCLUDE_DIR
 	NAMES
-	SDL2
+	SDL_haptic.h # this file was introduced with SDL2
 	HINTS
-	${SDL2_LIB_HINTS}
+	${SDL2_INCLUDE_HINTS}
 	PATHS
 	${SDL2_ROOT_DIR}
 	ENV SDL2DIR
-	PATH_SUFFIXES lib ${SDL2_LIB_PATH_SUFFIX})
+	PATH_SUFFIXES include include/sdl2 include/SDL2 SDL2)
+
 if(WIN32 AND SDL2_LIBRARY)
 	find_file(SDL2_RUNTIME_LIBRARY
 		NAMES
@@ -87,7 +114,8 @@ if(WIN32 AND SDL2_LIBRARY)
 		PATH_SUFFIXES bin lib ${SDL2_LIB_PATH_SUFFIX})
 endif()
 
-if(WIN32 OR ANDROID OR IOS)
+
+if(WIN32 OR ANDROID OR IOS OR (APPLE AND NOT _sdl2_framework))
 	set(SDL2_EXTRA_REQUIRED SDL2_SDLMAIN_LIBRARY)
 	find_library(SDL2_SDLMAIN_LIBRARY
 		NAMES
@@ -98,7 +126,6 @@ if(WIN32 OR ANDROID OR IOS)
 		PATH_SUFFIXES lib ${SDL2_LIB_PATH_SUFFIX})
 endif()
 
-
 if(MINGW AND NOT SDL2PC_FOUND)
 	find_library(SDL2_MINGW_LIBRARY mingw32)
 	find_library(SDL2_MWINDOWS_LIBRARY mwindows)
@@ -119,61 +146,94 @@ find_package_handle_standard_args(SDL2
 	${SDL2_EXTRA_REQUIRED})
 
 if(SDL2_FOUND)
-	if(WIN32 AND SDL2_RUNTIME_LIBRARY)
-		set(SDL2_DYNAMIC TRUE)
-		add_library(SDL2::SDL2 SHARED IMPORTED)
-		set_target_properties(SDL2::SDL2
-			PROPERTIES
-			IMPORTED_IMPLIB "${SDL2_LIBRARY}"
-			IMPORTED_LOCATION "${SDL2_RUNTIME_LIBRARY}"
-			INTERFACE_INCLUDE_DIRECTORIES "${SDL2_INCLUDE_DIR}"
-		)
-	else()
-		add_library(SDL2::SDL2 STATIC IMPORTED)
-		set_target_properties(SDL2::SDL2
-			PROPERTIES
-			IMPORTED_LOCATION "${SDL2_LIBRARY}"
-			INTERFACE_INCLUDE_DIRECTORIES "${SDL2_INCLUDE_DIR}"
-		)
-	endif()
-	add_library(SDL2::SDL2main INTERFACE IMPORTED)
-	set(SDL2MAIN_LIBRARIES SDL2::SDL2)
-	if(SDL2_SDLMAIN_LIBRARY)
-		add_library(SDL2::SDL2main_real STATIC IMPORTED)
-		set_target_properties(SDL2::SDL2main_real
-			PROPERTIES
-			IMPORTED_LOCATION "${SDL2_SDLMAIN_LIBRARY}")
-		list(APPEND SDL2MAIN_LIBRARIES SDL2::SDL2main_real)
-	endif()
-	if(MINGW)
-		# MinGW requires some additional libraries to appear earlier in the link line.
-		if(SDL2PC_LIBRARIES)
-			# Use pkgconfig-suggested extra libraries if available.
-			list(REMOVE_ITEM SDL2PC_LIBRARIES SDL2main SDL2)
-			set(SDL2MAIN_LIBRARIES ${SDL2PC_LIBRARIES} ${SDL2MAIN_LIBRARIES})
+	if(NOT TARGET SDL2::SDL2)
+		# Create SDL2::SDL2
+		if(WIN32 AND SDL2_RUNTIME_LIBRARY)
+			set(SDL2_DYNAMIC TRUE)
+			add_library(SDL2::SDL2 SHARED IMPORTED)
+			set_target_properties(SDL2::SDL2
+				PROPERTIES
+				IMPORTED_IMPLIB "${SDL2_LIBRARY}"
+				IMPORTED_LOCATION "${SDL2_RUNTIME_LIBRARY}"
+				INTERFACE_INCLUDE_DIRECTORIES "${SDL2_INCLUDE_DIR}"
+			)
 		else()
-			# fall back to extra libraries specified in pkg-config in
-			# an official binary distro of SDL2 for MinGW I downloaded
-			if(SDL2_MINGW_LIBRARY)
-				set(SDL2MAIN_LIBRARIES ${SDL2_MINGW_LIBRARY} ${SDL2MAIN_LIBRARIES})
+			add_library(SDL2::SDL2 UNKNOWN IMPORTED)
+			if(SDL2_FRAMEWORK AND SDL2_FRAMEWORK_NAME)
+				# Handle the case that SDL2 is a framework and we were able to decompose it above.
+				set_target_properties(SDL2::SDL2 PROPERTIES
+					IMPORTED_LOCATION "${SDL2_FRAMEWORK}/${SDL2_FRAMEWORK_NAME}")
+			elseif(_sdl2_framework AND SDL2_LIBRARY MATCHES "(/[^/]+)*.framework$")
+				# Handle the case that SDL2 is a framework and SDL_LIBRARY is just the framework itself.
+
+				# This takes the basename of the framework, without the extension,
+				# and sets it (as a child of the framework) as the imported location for the target.
+				# This is the library symlink inside of the framework.
+				set_target_properties(SDL2::SDL2 PROPERTIES
+					IMPORTED_LOCATION "${SDL2_LIBRARY}/${CMAKE_MATCH_1}")
+			else()
+				# Handle non-frameworks (including non-Mac), as well as the case that we're given the library inside of the framework
+				set_target_properties(SDL2::SDL2 PROPERTIES
+					IMPORTED_LOCATION "${SDL2_LIBRARY}")
 			endif()
-			if(SDL2_MWINDOWS_LIBRARY)
-				set(SDL2MAIN_LIBRARIES ${SDL2_MWINDOWS_LIBRARY} ${SDL2MAIN_LIBRARIES})
+			set_target_properties(SDL2::SDL2
+				PROPERTIES
+				INTERFACE_INCLUDE_DIRECTORIES "${SDL2_INCLUDE_DIR}"
+			)
+		endif()
+
+        if(APPLE)
+            # Need Cocoa here, is always a framework
+            find_library(SDL2_COCOA_LIBRARY Cocoa)
+            list(APPEND SDL2_EXTRA_REQUIRED SDL2_COCOA_LIBRARY)
+            if(SDL2_COCOA_LIBRARY)
+                set_target_properties(SDL2::SDL2 PROPERTIES
+                        IMPORTED_LINK_INTERFACE_LIBRARIES ${SDL2_COCOA_LIBRARY})
+            endif()
+        endif()
+
+
+		# Compute what to do with SDL2main
+		set(SDL2MAIN_LIBRARIES SDL2::SDL2)
+		add_library(SDL2::SDL2main INTERFACE IMPORTED)
+		if(SDL2_SDLMAIN_LIBRARY)
+			add_library(SDL2::SDL2main_real STATIC IMPORTED)
+			set_target_properties(SDL2::SDL2main_real
+				PROPERTIES
+				IMPORTED_LOCATION "${SDL2_SDLMAIN_LIBRARY}")
+			list(APPEND SDL2MAIN_LIBRARIES SDL2::SDL2main_real)
+		endif()
+		if(MINGW)
+			# MinGW requires some additional libraries to appear earlier in the link line.
+			if(SDL2PC_LIBRARIES)
+				# Use pkgconfig-suggested extra libraries if available.
+				list(REMOVE_ITEM SDL2PC_LIBRARIES SDL2main SDL2)
+				set(SDL2MAIN_LIBRARIES ${SDL2PC_LIBRARIES} ${SDL2MAIN_LIBRARIES})
+			else()
+				# fall back to extra libraries specified in pkg-config in
+				# an official binary distro of SDL2 for MinGW I downloaded
+				if(SDL2_MINGW_LIBRARY)
+					set(SDL2MAIN_LIBRARIES ${SDL2_MINGW_LIBRARY} ${SDL2MAIN_LIBRARIES})
+				endif()
+				if(SDL2_MWINDOWS_LIBRARY)
+					set(SDL2MAIN_LIBRARIES ${SDL2_MWINDOWS_LIBRARY} ${SDL2MAIN_LIBRARIES})
+				endif()
 			endif()
+			set_target_properties(SDL2::SDL2main
+				PROPERTIES
+				INTERFACE_COMPILE_DEFINITIONS "main=SDL_main")
 		endif()
 		set_target_properties(SDL2::SDL2main
 			PROPERTIES
-			INTERFACE_COMPILE_DEFINITIONS "main=SDL_main")
+			INTERFACE_LINK_LIBRARIES "${SDL2MAIN_LIBRARIES}")
 	endif()
-	set_target_properties(SDL2::SDL2main
-		PROPERTIES
-		INTERFACE_LINK_LIBRARIES "${SDL2MAIN_LIBRARIES}")
 	mark_as_advanced(SDL2_ROOT_DIR)
 endif()
 
 mark_as_advanced(SDL2_LIBRARY
 	SDL2_RUNTIME_LIBRARY
 	SDL2_INCLUDE_DIR
 	SDL2_SDLMAIN_LIBRARY
+	SDL2_COCOA_LIBRARY
 	SDL2_MINGW_LIBRARY
 	SDL2_MWINDOWS_LIBRARY)