CMake: don't set build type / install prefix unless LSL_COMFY_DEFAULTS is set

Author: tstenner

CHANGELOG

@@ -1,5 +1,6 @@
 # Changes for liblsl 1.14
 
+* **change**: CMake doesn't set `CMAKE_INSTALL_PREFIX`and `CMAKE_BUILD_TYPE` by default unless `LSL_COMFY_DEFAULTS` is set (Tristan Stenner)
 * fix: prevent race condition when two threads modify an overflowing buffer (https://github.com/sccn/liblsl/pull/71, Jérémy Frey)
 * fix: improve latency and CPU usage (https://github.com/sccn/liblsl/pull/71, Jérémy Frey)
 * fix: various build system fixces and improvments (Chadwick Boulay, Tristan Stenner)

cmake/LSLCMake.cmake

@@ -1,11 +1,16 @@
 # Common functions and settings for LSL
 
-# Dummy function that should be called after find_package(LSL)
-# Does nothing at the moment, but the entire code below should be within this
-# function so it's not executed by accident
+option(LSL_DEPLOYAPPLIBS "Copy library dependencies (at the moment Qt + liblsl) to the installation dir" ON)
+option(LSL_COMFY_DEFAULTS "Set some quality of life options, e.g. a sensible 'install' directory" OFF)
+
 macro(LSLAPP_Setup_Boilerplate)
+	message(WARNING "This function is deprecated, set LSL_COMFY_DEFAULTS instead")
+	set(LSL_COMFY_DEFAULTS ON)
 endmacro()
 
+# helper script to determine the target architecture for package naming
+# The code below is compiled with the target compiler so it should work even
+# when cross compiling and doesn't require the executable to be run
 function(LSL_get_target_arch)
 	if(LSL_ARCH)
 		return()
@@ -40,28 +45,25 @@ function(LSL_get_target_arch)
 	set(LSL_ARCH "${ARCH}" CACHE INTERNAL "target architecture")
 endfunction()
 
-message(STATUS "Included LSL CMake helpers, rev. 14, ${CMAKE_CURRENT_LIST_DIR}")
-option(LSL_DEPLOYAPPLIBS "Copy library dependencies (at the moment Qt + liblsl) to the installation dir" ON)
+message(STATUS "Included LSL CMake helpers, rev. 15, ${CMAKE_CURRENT_LIST_DIR}")
 
 # set build type and default install dir if not done already or undesired
-if(NOT CMAKE_BUILD_TYPE)
+if(LSL_COMFY_DEFAULTS AND NOT CMAKE_BUILD_TYPE)
 	message(STATUS "CMAKE_BUILD_TYPE was default initialized to Release")
 	set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Build type" FORCE)
 endif()
-if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT AND NOT LSL_PRESERVE_INSTALL_PREFIX)
+if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT AND COMFY_DEFAULTS)
 	set(CMAKE_INSTALL_PREFIX "${CMAKE_BINARY_DIR}/install" CACHE PATH
 		"Where to put redistributable binaries" FORCE)
-	message(WARNING "CMAKE_INSTALL_PREFIX default initialized to ${CMAKE_INSTALL_PREFIX}. Set LSL_PRESERVE_INSTALL_PREFIX or CMAKE_INSTALL_PREFIX to skip this.")
 endif()
 
-# Generate folders for IDE targets (e.g., VisualStudio solutions)
-set_property(GLOBAL PROPERTY USE_FOLDERS ON)
+if(LSL_COMFY_DEFAULTS)
+	# Generate folders for IDE targets (e.g., VisualStudio solutions)
+	set_property(GLOBAL PROPERTY USE_FOLDERS ON)
 
-
-set(CMAKE_CONFIGURATION_TYPES "Debug;Release" CACHE STRING "limited configs" FORCE)
-
-# Qt5
-set(CMAKE_INCLUDE_CURRENT_DIR ON) # Because the ui_mainwindow.h file.
+	# Qt5, include e.g. "mainwindow.h"
+	set(CMAKE_INCLUDE_CURRENT_DIR ON)
+endif()
 
 # LSL functions, mostly for Apps
 

examples/CMakeLists.txt

@@ -9,7 +9,6 @@ find_package(LSL REQUIRED
 	PATH_SUFFIXES share/LSL)
 get_filename_component(LSL_PATH ${LSL_CONFIG} DIRECTORY)
 message(STATUS "Found LSL lib in ${LSL_PATH}")
-LSLAPP_Setup_Boilerplate()
 message(STATUS "LSL BIN DIR: ${liblsl_BINARY_DIR} & ${LIBLSL_BINARY_DIR}")
 
 # convenience function to add an example file

lslboost/serialization_objects.cpp

@@ -9,5 +9,5 @@
 #include "libs/serialization/src/extended_type_info_typeid.cpp"
 #include "libs/serialization/src/void_cast.cpp"
 #ifdef _WIN32
-#include "lslboost/libs/serialization/src/codecvt_null.cpp"
+#include "libs/serialization/src/codecvt_null.cpp"
 #endif

testing/CMakeLists.txt

@@ -15,6 +15,7 @@ target_compile_definitions(catch_main PRIVATE LSL_VERSION_INFO="${LSL_VERSION_IN
 if(LSL_BENCHMARKS)
 	target_compile_definitions(catch_main PUBLIC CATCH_CONFIG_ENABLE_BENCHMARKING)
 endif()
+target_include_directories(catch_main PUBLIC $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>)
 
 add_executable(lsl_test_exported
 	test_ext_DataType.cpp

testing/internal/serialization_v100.cpp

@@ -1,4 +1,4 @@
-#include "catch.hpp"
+#include <catch.hpp>
 #include "portable_archive/portable_iarchive.hpp"
 #include "portable_archive/portable_oarchive.hpp"
 #include "sample.h"