Fix naming conflicts between libraries and targets by adding 'Lib*'

In some contexts, e.g. INTERFACE_LINK_LIBRARIES, a library name like
'tinygettext' can both refer to the 'tinygettext' target as well as
the library itself, i.e. '-ltinygettext'. This can cause subtle
issues.

Also switch to using 'INTERFACE IMPORTED' conistently for libraries,
this should automatically mark headers as SYSTEM without doing it
manually.

Author: Grumbel

CMakeLists.txt

@@ -205,7 +205,7 @@ target_compile_definitions(supertux2_lib PUBLIC -DGLM_ENABLE_EXPERIMENTAL)
 
 if(WIN32)
   add_executable(supertux2 WIN32 src/main.cpp ${CMAKE_CURRENT_SOURCE_DIR}/data/images/engine/icons/supertux.rc)
-  target_link_libraries(supertux2 SDL2main)
+  target_link_libraries(supertux2 LibSDL2main)
 else()
   add_executable(supertux2 src/main.cpp)
 endif()
@@ -238,32 +238,32 @@ endif()
 
 ## Link supertux binary with squirrel and other libraries
 if(NOT EMSCRIPTEN)
-  target_link_libraries(supertux2_lib PUBLIC SDL2 SDL2_image)
+  target_link_libraries(supertux2_lib PUBLIC LibSDL2 LibSDL2_image)
 endif()
 
-target_link_libraries(supertux2_lib PUBLIC SDL2_ttf)
-target_link_libraries(supertux2_lib PUBLIC squirrel::squirrel)
-target_link_libraries(supertux2_lib PUBLIC squirrel::sqstdlib)
-target_link_libraries(supertux2_lib PUBLIC tinygettext)
-target_link_libraries(supertux2_lib PUBLIC sexp)
-target_link_libraries(supertux2_lib PUBLIC savepng)
-target_link_libraries(supertux2_lib PUBLIC partio_zip_lib)
-target_link_libraries(supertux2_lib PUBLIC OpenAL)
-target_link_libraries(supertux2_lib PUBLIC OggVorbis)
-target_link_libraries(supertux2_lib PUBLIC Boost)
-target_link_libraries(supertux2_lib PUBLIC fmt::fmt)
-target_link_libraries(supertux2_lib PUBLIC physfs)
+target_link_libraries(supertux2_lib PUBLIC LibSDL2_ttf)
+target_link_libraries(supertux2_lib PUBLIC LibSquirrel)
+target_link_libraries(supertux2_lib PUBLIC LibSqstdlib)
+target_link_libraries(supertux2_lib PUBLIC LibTinygettext)
+target_link_libraries(supertux2_lib PUBLIC LibSexp)
+target_link_libraries(supertux2_lib PUBLIC LibSavePNG)
+target_link_libraries(supertux2_lib PUBLIC LibPartioZip)
+target_link_libraries(supertux2_lib PUBLIC LibOpenAL)
+target_link_libraries(supertux2_lib PUBLIC LibOggVorbis)
+target_link_libraries(supertux2_lib PUBLIC LibBoost)
+target_link_libraries(supertux2_lib PUBLIC LibFmt)
+target_link_libraries(supertux2_lib PUBLIC LibPhysfs)
 
 if(HAVE_OPENGL)
-  target_link_libraries(supertux2_lib PUBLIC OpenGL)
+  target_link_libraries(supertux2_lib PUBLIC LibOpenGL)
 endif()
 
 if(ENABLE_DISCORD)
-  target_link_libraries(supertux2_lib PUBLIC discord-rpc)
+  target_link_libraries(supertux2_lib PUBLIC LibDiscord)
 endif()
 
 if(NOT EMSCRIPTEN)
-  target_link_libraries(supertux2_lib PUBLIC CURL::libcurl)
+  target_link_libraries(supertux2_lib PUBLIC LibCurl)
 endif()
 
 ## Install stuff

mk/cmake/SuperTux/ProvideBoost.cmake

@@ -14,21 +14,22 @@ endif()
 
 find_package(Boost REQUIRED COMPONENTS filesystem system date_time locale)
 
-add_library(Boost INTERFACE)
+add_library(LibBoost INTERFACE IMPORTED)
 
 if(WIN32)
-  # Boost_LIBRARIES may contain link-type keywords optimized,debug
-  # that aren't understood by INTERFACE_LINK_DIRECTORIES
-  target_link_libraries(Boost INTERFACE ${Boost_LIBRARIES})
+  # Boost_LIBRARIES may contain link-type keywords "optimized,debug"
+  # that aren't understood by INTERFACE_LINK_DIRECTORIES directly,
+  # meanwhile older cmake on other OSs don't support
+  # target_link_libraries(INTERFACE).
+  target_link_libraries(LibBoost INTERFACE ${Boost_LIBRARIES})
 else()
-  set_target_properties(Boost PROPERTIES
+  set_target_properties(LibBoost PROPERTIES
     INTERFACE_LINK_LIBRARIES "${Boost_LIBRARIES}")
 endif()
 
-set_target_properties(Boost PROPERTIES
+set_target_properties(LibBoost PROPERTIES
   INTERFACE_LINK_DIRECTORIES "${Boost_LIBRARY_DIRS}"
   INTERFACE_INCLUDE_DIRECTORIES "${Boost_INCLUDE_DIR}"
-  INTERFACE_SYSTEM_INCLUDE_DIRECTORIES "${Boost_INCLUDE_DIR}"
   )
 
 mark_as_advanced(

mk/cmake/SuperTux/ProvideCurl.cmake

@@ -19,10 +19,12 @@ if(NOT EMSCRIPTEN)
     endif()
   endif()
 
-  if(NOT TARGET CURL::libcurl)
-    add_library(CURL::libcurl UNKNOWN IMPORTED)
-    set_target_properties(CURL::libcurl PROPERTIES
-      IMPORTED_LOCATION "${CURL_LIBRARY}"
+  if(TARGET CURL::libcurl)
+    add_library(LibCurl ALIAS CURL::libcurl)
+  else()
+    add_library(LibCurl INTERFACE IMPORTED)
+    set_target_properties(LibCurl PROPERTIES
+      INTERFACE_LINK_LIBRARIES "${CURL_LIBRARY}"
       INTERFACE_INCLUDE_DIRECTORIES "${CURL_INCLUDE_DIRS}")
   endif()
 

mk/cmake/SuperTux/ProvideDiscord.cmake

@@ -12,10 +12,11 @@ else()
 
   add_subdirectory(external/discord-sdk EXCLUDE_FROM_ALL)
 
-  # Add missing include directories to discord-rpc
-  set_target_properties(discord-rpc PROPERTIES
-    INTERFACE_INCLUDE_DIRECTORIES "${CMAKE_CURRENT_SOURCE_DIR}/external/discord-sdk/include"
-    INTERFACE_SYSTEM_INCLUDE_DIRECTORIES "${CMAKE_CURRENT_SOURCE_DIR}/external/discord-sdk/include")
+  add_library(LibDiscord INTERFACE IMPORTED)
+  set_target_properties(LibDiscord PROPERTIES
+    INTERFACE_LINK_LIBRARIES "discord-rpc"
+    # discord-rpc doesn't provide includes itself
+    INTERFACE_INCLUDE_DIRECTORIES "${CMAKE_CURRENT_SOURCE_DIR}/external/discord-sdk/include")
 endif()
 
 # EOF #

mk/cmake/SuperTux/ProvideFmt.cmake

@@ -5,16 +5,19 @@ endif()
 
 if(TARGET fmt::fmt)
   message(STATUS "Found fmt")
+
+  add_library(LibFmt ALIAS fmt::fmt)
+
 else()
-  if(USE_SYSTEM_FMT)
-    message(STATUS "Could NOT find fmt, using external/fmt fallback")
-  endif()
+  message(STATUS "Could NOT find fmt, using external/fmt fallback")
 
   add_subdirectory(external/fmt EXCLUDE_FROM_ALL)
 
-  # Mark fmt includes as SYSTEM to avoid warnings
-  set_target_properties(fmt PROPERTIES
-    INTERFACE_SYSTEM_INCLUDE_DIRECTORIES "$<TARGET_PROPERTY:fmt,INTERFACE_INCLUDE_DIRECTORIES>")
+  add_library(LibFmt INTERFACE IMPORTED)
+  set_target_properties(LibFmt PROPERTIES
+    INTERFACE_LINK_LIBRARIES "fmt::fmt"
+    INTERFACE_SYSTEM_INCLUDE_DIRECTORIES "$<TARGET_PROPERTY:fmt::fmt,INTERFACE_INCLUDE_DIRECTORIES>")
+
 endif()
 
 # EOF #

mk/cmake/SuperTux/ProvideGlm.cmake

@@ -1,12 +1,14 @@
 find_package(glm QUIET)
+
 if(glm_FOUND)
   if(TARGET glm::glm)
     message(STATUS "Found glm")
+    add_library(LibGlm ALIAS glm::glm)
   else()
     # fallback for old glm version in EmuELEC and Nix
     message(STATUS "Found glm: ${GLM_INCLUDE_DIR}")
-    add_library(glm::glm INTERFACE IMPORTED)
-    set_target_properties(glm::glm PROPERTIES
+    add_library(LibGlm INTERFACE IMPORTED)
+    set_target_properties(LibGlm PROPERTIES
       INTERFACE_INCLUDE_DIRECTORIES "$<TARGET_PROPERTY:glm,INTERFACE_INCLUDE_DIRECTORIES>")
   endif()
 else()
@@ -19,8 +21,8 @@ else()
   endif()
 
   message(STATUS "Found glm: ${GLM_INCLUDE_DIR}")
-  add_library(glm::glm INTERFACE IMPORTED)
-  set_target_properties(glm::glm PROPERTIES
+  add_library(LibGlm INTERFACE IMPORTED)
+  set_target_properties(LibGlm PROPERTIES
     INTERFACE_INCLUDE_DIRECTORIES ${GLM_INCLUDE_DIR})
 endif()
 

mk/cmake/SuperTux/ProvideOggVorbis.cmake

@@ -1,9 +1,8 @@
 find_package(OggVorbis REQUIRED)
 
-add_library(OggVorbis INTERFACE)
-set_target_properties(OggVorbis PROPERTIES
+add_library(LibOggVorbis INTERFACE IMPORTED)
+set_target_properties(LibOggVorbis PROPERTIES
   INTERFACE_INCLUDE_DIRECTORIES "${VORBIS_INCLUDE_DIR}"
-  INTERFACE_SYSTEM_INCLUDE_DIRECTORIES "${VORBIS_INCLUDE_DIR}"
   INTERFACE_LINK_LIBRARIES "${OGGVORBIS_LIBRARIES}"
   )
 

mk/cmake/SuperTux/ProvideOpenAL.cmake

@@ -1,20 +1,19 @@
 if(NOT EMSCRIPTEN)
   if(VCPKG_BUILD)
     find_package(OpenAL CONFIG REQUIRED)
-    add_library(OpenAL ALIAS OpenAL::OpenAL)
+    add_library(LibOpenAL ALIAS OpenAL::OpenAL)
   else()
     find_package(OpenAL REQUIRED)
 
-    add_library(OpenAL INTERFACE)
-    set_target_properties(OpenAL PROPERTIES
+    add_library(LibOpenAL INTERFACE IMPORTED)
+    set_target_properties(LibOpenAL PROPERTIES
       INTERFACE_LINK_LIBRARIES "${OPENAL_LIBRARY}"
       INTERFACE_INCLUDE_DIRECTORIES "${OPENAL_INCLUDE_DIR}"
-      INTERFACE_SYSTEM_INCLUDE_DIRECTORIES "${OPENAL_INCLUDE_DIR}"
       )
   endif()
 else()
-  add_library(OpenAL INTERFACE)
-  set_target_properties(OpenAL PROPERTIES
+  add_library(LibOpenAL INTERFACE IMPORTED)
+  set_target_properties(LibOpenAL PROPERTIES
     INTERFACE_INCLUDE_DIRECTORIES "${CMAKE_SOURCE_DIR}/mk/emscripten/AL"
     INTERFACE_LINK_LIBRARIES "-lopenal"
     )

mk/cmake/SuperTux/ProvideOpenGL.cmake

@@ -20,6 +20,7 @@ if(ENABLE_OPENGL)
 
     set(OpenGL_GL_PREFERENCE "LEGACY")
     find_package(OpenGL)
+
     if(OPENGL_FOUND)
       set(HAVE_OPENGL TRUE)
 
@@ -51,8 +52,8 @@ if(ENABLE_OPENGL)
   if(NOT HAVE_OPENGL)
     message(STATUS "  OpenGL not found")
   else()
-    add_library(OpenGL INTERFACE)
-    set_target_properties(OpenGL PROPERTIES
+    add_library(LibOpenGL INTERFACE)
+    set_target_properties(LibOpenGL PROPERTIES
       INTERFACE_LINK_LIBRARIES "${OPENGL_LINK_LIBRARIES}"
       INTERFACE_INCLUDE_DIRECTORIES "${OPENGL_INCLUDE_DIRECTORIES}"
       INTERFACE_COMPILE_DEFINITIONS "${OPENGL_COMPILE_DEFINITIONS}"

mk/cmake/SuperTux/ProvidePartioZip.cmake

@@ -1,8 +1,8 @@
 find_package(ZLIB REQUIRED)
 
-add_library(partio_zip_lib STATIC ${CMAKE_CURRENT_SOURCE_DIR}/external/partio_zip/zip_manager.cpp)
-target_link_libraries(partio_zip_lib PUBLIC ${ZLIB_LIBRARIES})
-target_include_directories(partio_zip_lib SYSTEM PRIVATE ${ZLIB_INCLUDE_DIRS})
-target_include_directories(partio_zip_lib SYSTEM PUBLIC external/partio_zip)
+add_library(LibPartioZip ${CMAKE_CURRENT_SOURCE_DIR}/external/partio_zip/zip_manager.cpp)
+target_link_libraries(LibPartioZip PUBLIC ${ZLIB_LIBRARIES})
+target_include_directories(LibPartioZip SYSTEM PRIVATE ${ZLIB_INCLUDE_DIRS})
+target_include_directories(LibPartioZip SYSTEM PUBLIC external/partio_zip)
 
 # EOF #