build(cmake): detect and use SDL2 include path correctly (#193)

Not all distros/packages place the SDL2 installation into a
directory named SDL2. Just to name a prominent example: Homebrew.

cmake's find_package will correctly identify SDL2 and provide the
required include/lib paths.

Author: muesli

CMakeLists.txt

@@ -113,6 +113,8 @@ target_include_directories(sim-base PUBLIC "lv_drivers")
 
 target_include_directories(sim-base PUBLIC "${InfiniTime_DIR}/src") # InfiniTime drivers, components and all
 
+find_package(SDL2 REQUIRED)
+target_link_libraries(sim-base PUBLIC SDL2::SDL2)
 
 set(MONITOR_ZOOM 1 CACHE STRING "Scale simulator window by this factor")
 if(MONITOR_ZOOM MATCHES "^[0-9]\.?[0-9]*")
@@ -319,13 +321,6 @@ if(NOT alarmControllerFileSystemEntries STREQUAL "")
 endif()
 
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
-# Special case for SDL2 dependency, goal is to find a config that exports SDL2::SDL2 target
-# libsdl2-dev has a `sdl2-config.cmake` that doesn't export this, but vcpkg does..
-find_package(SDL2 CONFIG QUIET)
-if(NOT TARGET SDL2::SDL2)
-  find_package(SDL2 MODULE REQUIRED)
-endif()
-target_link_libraries(infinisim PRIVATE SDL2::SDL2)
 
 # Some toolchains (e.g. g++-8) require to explicitly link with the standard filesystem library
 # See https://github.com/InfiniTimeOrg/InfiniSim/issues/57#issuecomment-1386889378
@@ -352,7 +347,7 @@ endif()
 
 target_include_directories(infinisim PRIVATE "${CMAKE_CURRENT_SOURCE_DIR}/external/gif-h")
 
-# embedd background image for the status window to use
+# embed background image for the status window to use
 add_subdirectory(img)
 add_dependencies(infinisim infinisim_img_background)
 
@@ -380,7 +375,6 @@ add_executable(littlefs-do
 target_link_libraries(littlefs-do PUBLIC sim-base)
 target_link_libraries(littlefs-do PUBLIC littlefs)
 
-target_link_libraries(littlefs-do PRIVATE SDL2::SDL2)
 target_link_libraries(littlefs-do PRIVATE infinitime_fonts)
 
 add_subdirectory(external/miniz)

cmake/FindSDL2.cmake

@@ -107,7 +107,7 @@
       #define MONITOR_DOUBLE_BUFFERED 0
 
       /*Eclipse: <SDL2/SDL.h>    Visual Studio: <SDL.h>*/
-      #define MONITOR_SDL_INCLUDE_PATH <SDL2/SDL.h>
+      #define MONITOR_SDL_INCLUDE_PATH <SDL.h>
 
       /*Different rendering might be used if running in a Virtual machine*/
       #define MONITOR_VIRTUAL_MACHINE 0

lv_drv_conf.h

@@ -11,7 +11,7 @@
 #include <stdlib.h>
 #include <unistd.h>
 #define SDL_MAIN_HANDLED /*To fix SDL's "undefined reference to WinMain" issue*/
-#include <SDL2/SDL.h>
+#include <SDL.h>
 #include "lvgl/lvgl.h"
 // #include "lvgl/examples/lv_examples.h"
 // #include "lv_demos/lv_demo.h"

main.cpp

@@ -11,7 +11,7 @@
 // lv-sim monitor display driver for monitor_flush() function
 #include "lv_drivers/display/monitor.h"
 
-#include <SDL2/SDL.h>
+#include <SDL.h>
 #include <array>
 
 using namespace Pinetime::Components;

sim/displayapp/LittleVgl.cpp

@@ -1,6 +1,6 @@
 #include "drivers/Cst816s.h"
 #include "lv_drv_conf.h" // MONITOR_ZOOM
-#include <SDL2/SDL.h>
+#include <SDL.h>
 #include <libraries/log/nrf_log.h>
 #include <cmath>
 

sim/drivers/Cst816s.cpp

@@ -1,5 +1,5 @@
 #include "libraries/delay/nrf_delay.h"
-#include <SDL2/SDL.h>
+#include <SDL.h>
 
 void nrf_delay_ms(uint32_t ms_time)
 {

sim/libraries/delay/nrf_delay.cpp

@@ -2,7 +2,7 @@
 
 #include "drivers/PinMap.h"
 
-#include <SDL2/SDL.h>
+#include <SDL.h>
 #include <stdexcept>
 #include <string> // std::to_string
 

sim/nrfx/hal/nrf_gpio.cpp

@@ -1,7 +1,7 @@
 #include "FreeRTOS.h"
 #include "queue.h"
 #include <stdexcept>
-#include <SDL2/SDL.h>
+#include <SDL.h>
 
 QueueHandle_t xQueueCreate(const UBaseType_t uxQueueLength, const UBaseType_t uxItemSize) {
   Queue_t* xQueue = new Queue_t;

sim/queue.cpp

@@ -1,5 +1,5 @@
 #include "semphr.h"
-#include <SDL2/SDL.h>
+#include <SDL.h>
 #include <stdexcept>
 
 QueueHandle_t xSemaphoreCreateMutex() {