Cmake/install refactor

.appveyor.yml

@@ -19,5 +19,9 @@ build_script:
   - cmake -DUSE_COMPILE_CACHE=ON -DCACHE_TOOL=%APPVEYOR_BUILD_FOLDER%/clcache.4.1.0/clcache-4.1.0/clcache.exe -DCMAKE_BUILD_TYPE=RelWithDebInfo -DCMAKE_PREFIX_PATH=c:/Qt/5.12/msvc2017%QT_SUFFIX%;c:/tools/vcpkg/installed/%PLATFORM%-windows -DCMAKE_GENERATOR_PLATFORM="%CMAKE_PLATFORM%" ..
   - cmake --build . -- /maxcpucount:4
   - cmake --build . --target tests
+  - cmake --build . --target package
+artifacts:
+  - path: 'build\lmms-*.exe'
+    name: Installer
 cache:
   - c:/tools/vcpkg/installed

.circleci/config.yml

@@ -59,6 +59,15 @@ jobs:
       - run:
           name: Build tests
           command: cd build && make tests
+      - run:
+          name: Build installer
+          command: |
+            cd build
+            make package
+            cp ./lmms-*.exe /tmp/artifacts/
+      - store_artifacts:
+          path: /tmp/artifacts/
+          destination: /
       - *ccache_stats
       - *save_cache
   mingw64:
@@ -79,6 +88,15 @@ jobs:
       - run:
           name: Build tests
           command: cd build && make tests
+      - run:
+          name: Build installer
+          command: |
+            cd build
+            make package
+            cp ./lmms-*.exe /tmp/artifacts/
+      - store_artifacts:
+          path: /tmp/artifacts/
+          destination: /
       - *ccache_stats
       - *save_cache
   linux.gcc:

CMakeLists.txt

@@ -3,6 +3,8 @@ CMAKE_MINIMUM_REQUIRED(VERSION 3.3)
 PROJECT(lmms)
 
 SET(CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake/modules" ${CMAKE_MODULE_PATH})
+SET(LMMS_BINARY_DIR ${CMAKE_BINARY_DIR})
+SET(LMMS_SOURCE_DIR ${CMAKE_SOURCE_DIR})
 
 IF(COMMAND CMAKE_POLICY)
 	CMAKE_POLICY(SET CMP0005 NEW)
@@ -13,6 +15,7 @@ IF(COMMAND CMAKE_POLICY)
 		CMAKE_POLICY(SET CMP0050 OLD)
 	ENDIF()
 	CMAKE_POLICY(SET CMP0020 NEW)
+	CMAKE_POLICY(SET CMP0057 NEW)
 ENDIF(COMMAND CMAKE_POLICY)
 
 INCLUDE(CheckSubmodules)
@@ -565,8 +568,8 @@ ADD_SUBDIRECTORY(tests)
 ADD_SUBDIRECTORY(data)
 ADD_SUBDIRECTORY(doc)
 
-# post-install tasks
-ADD_SUBDIRECTORY(cmake/postinstall)
+# install tasks
+ADD_SUBDIRECTORY(cmake/install)
 
 ADD_CUSTOM_COMMAND(OUTPUT "${CMAKE_BINARY_DIR}/lmms.1.gz"
 				COMMAND gzip -c ${CMAKE_SOURCE_DIR}/doc/lmms.1 > ${CMAKE_BINARY_DIR}/lmms.1.gz
@@ -706,4 +709,9 @@ MESSAGE(
 "\n\n")
 
 SET(CMAKE_INSTALL_SYSTEM_RUNTIME_DESTINATION "${BIN_DIR}")
+if(MSVC)
+	# We can't set this on the install time according to the configuration
+	SET(CMAKE_INSTALL_DEBUG_LIBRARIES TRUE)
+	SET(CMAKE_INSTALL_UCRT_LIBRARIES TRUE)
+endif()
 INCLUDE(InstallRequiredSystemLibraries)

cmake/install/CMakeLists.txt

@@ -0,0 +1,41 @@
+SET(PLUGIN_FILES "")
+IF(LMMS_BUILD_WIN32)
+	INSTALL(FILES $<TARGET_FILE:Qt5::QWindowsIntegrationPlugin> DESTINATION platforms)
+ENDIF()
+
+IF(LMMS_BUILD_WIN32 OR LMMS_INSTALL_DEPENDENCIES)
+	include(InstallTargetDependencies)
+
+	# Collect directories to search for DLLs
+	GET_FILENAME_COMPONENT(QTBIN_DIR "${QT_QMAKE_EXECUTABLE}" PATH)
+	set(LIB_DIRS "${QTBIN_DIR}")
+
+	GET_PROPERTY(PLUGINS_BUILT GLOBAL PROPERTY PLUGINS_BUILT)
+
+	IF(LMMS_BUILD_WIN32)
+		SET(LMMS_DEP_DESTINATION ${BIN_DIR})
+		SET(PLUGIN_DEP_DESTINATION ${BIN_DIR})
+	ELSE()
+		SET(LMMS_DEP_DESTINATION ${LIB_DIR})
+		SET(PLUGIN_DEP_DESTINATION ${LIB_DIR})
+	ENDIF()
+
+	INSTALL_TARGET_DEPENDENCIES(
+			NAME "main_binary"
+			TARGETS lmms
+			DESTINATION "${LMMS_DEP_DESTINATION}"
+			LIB_DIRS  ${LIB_DIRS}
+	)
+
+	INSTALL_TARGET_DEPENDENCIES(
+			NAME "plugins"
+			TARGETS ${PLUGINS_BUILT}
+			DESTINATION ${PLUGIN_DEP_DESTINATION}
+			LIB_DIRS ${LIB_DIRS} "${PLUGIN_DIR}"
+	)
+ENDIF()
+
+IF(LMMS_BUILD_APPLE)
+	INSTALL(CODE "EXECUTE_PROCESS(COMMAND chmod u+x ${CMAKE_BINARY_DIR}/install_apple.sh)")
+	INSTALL(CODE "EXECUTE_PROCESS(COMMAND ${CMAKE_BINARY_DIR}/install_apple.sh)")
+ENDIF()

cmake/install/excludelist-win

@@ -0,0 +1,23 @@
+# List of DLLs considered to be system libraries.
+# This is needed when cross-compiling for Windows.
+ADVAPI32.dll
+COMCTL32.dll
+comdlg32.dll
+dwmapi.dll
+GDI32.dll
+IMM32.dll
+KERNEL32.dll
+MPR.DLL
+msvcrt.dll
+ole32.dll
+OLEAUT32.dll
+OPENGL32.DLL
+SHELL32.dll
+USER32.dll
+UxTheme.dll
+VERSION.dll
+WINMM.DLL
+WS2_32.dll
+RPCRT4.dll
+dsound.dll
+SETUPAPI.dll

cmake/modules/BuildPlugin.cmake

@@ -62,7 +62,10 @@ MACRO(BUILD_PLUGIN PLUGIN_NAME)
 		TARGET_LINK_LIBRARIES(${PLUGIN_NAME} lmms)
 	ENDIF(LMMS_BUILD_WIN32)
 
-	INSTALL(TARGETS ${PLUGIN_NAME} DESTINATION "${PLUGIN_DIR}")
+	INSTALL(TARGETS ${PLUGIN_NAME}
+		LIBRARY DESTINATION "${PLUGIN_DIR}"
+		RUNTIME DESTINATION "${PLUGIN_DIR}"
+	)
 
 	IF(LMMS_BUILD_APPLE)
 		IF ("${PLUGIN_LINK}" STREQUAL "SHARED")
@@ -72,9 +75,11 @@ MACRO(BUILD_PLUGIN PLUGIN_NAME)
 		ENDIF()
 		ADD_DEPENDENCIES(${PLUGIN_NAME} lmms)
 	ENDIF(LMMS_BUILD_APPLE)
-	IF(LMMS_BUILD_WIN32 AND STRIP)
+	IF(LMMS_BUILD_WIN32)
+		IF(STRIP)
+			ADD_CUSTOM_COMMAND(TARGET ${PLUGIN_NAME} POST_BUILD COMMAND ${STRIP} "$<TARGET_FILE:${PLUGIN_NAME}>")
+		ENDIF()
 		SET_TARGET_PROPERTIES(${PLUGIN_NAME} PROPERTIES PREFIX "")
-		ADD_CUSTOM_COMMAND(TARGET ${PLUGIN_NAME} POST_BUILD COMMAND ${STRIP} "$<TARGET_FILE:${PLUGIN_NAME}>")
 	ENDIF()
 
 	SET_DIRECTORY_PROPERTIES(PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES "${RCC_OUT} ${plugin_MOC_out}")
@@ -89,5 +94,8 @@ MACRO(BUILD_PLUGIN PLUGIN_NAME)
 	TARGET_INCLUDE_DIRECTORIES(${PLUGIN_NAME}
 		PUBLIC $<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}>
 	)
+
+	SET_PROPERTY(GLOBAL APPEND PROPERTY PLUGINS_BUILT ${PLUGIN_NAME})
+	GET_PROPERTY(PLUGINS_BUILT GLOBAL PROPERTY PLUGINS_BUILT)
 ENDMACRO(BUILD_PLUGIN)
 

cmake/modules/CreateTempFile.cmake

@@ -0,0 +1,21 @@
+function(CreateTempFilePath)
+    set(options CONFIG_SUFFIX)
+    set(oneValueArgs OUTPUT_VAR TAG)
+    set(multiValueArgs CONTENT)
+    cmake_parse_arguments(TEMP "${options}" "${oneValueArgs}"
+            "${multiValueArgs}" ${ARGN} )
+
+    # Use hash to create a unique identifier
+    # for this file.
+    string(SHA1 hashed_content "${TEMP_CONTENT}")
+
+    set(file_name "${CMAKE_BINARY_DIR}/${TEMP_TAG}_${hashed_content}")
+    set(${TEMP_OUTPUT_VAR} "${file_name}" PARENT_SCOPE)
+    if(CONFIG_SUFFIX)
+        set(file_name "${file_name}_$<CONFIG>")
+    endif()
+
+    file(GENERATE OUTPUT "${file_name}"
+            CONTENT "${TEMP_CONTENT}")
+
+endfunction()

cmake/modules/DefineInstallVar.cmake

@@ -0,0 +1,31 @@
+# This functions forwards a variable to
+# the install stage.
+# Parameters:
+#   CONTENT: Variable content.
+#   NAME: Variable name.
+# Options:
+#   GENERATOR_EXPRESSION: Support generator expression for CONTENT.
+function(DEFINE_INSTALL_VAR)
+    set(options GENERATOR_EXPRESSION)
+    set(oneValueArgs NAME )
+    set(multiValueArgs CONTENT)
+    cmake_parse_arguments(VAR "${options}" "${oneValueArgs}"
+            "${multiValueArgs}" ${ARGN} )
+
+    # install(CODE) does not support generator expression in ver<3.14
+    if(VAR_GENERATOR_EXPRESSION AND ${CMAKE_VERSION} VERSION_LESS "3.14.0")
+        include(CreateTempFile)
+        if(CMAKE_CONFIGURATION_TYPES) # in case of multi-config generators like MSVC generators
+            CreateTempFilePath(OUTPUT_VAR file_path TAG "${VAR_NAME}" CONTENT "${VAR_CONTENT}" CONFIG_SUFFIX)
+            install(CODE "file(READ \"${file_path}_\${CMAKE_INSTALL_CONFIG_NAME}\" \"${VAR_NAME}\")")
+        else()
+            CreateTempFilePath(OUTPUT_VAR file_path TAG "${VAR_NAME}" CONTENT "${VAR_CONTENT}")
+            install(CODE "file(READ \"${file_path}\" \"${VAR_NAME}\")")
+        endif()
+    else()
+        if(VAR_GENERATOR_EXPRESSION)
+            cmake_policy(SET CMP0087 NEW)
+        endif()
+        install(CODE "set(\"${VAR_NAME}\" \"${VAR_CONTENT}\")")
+    endif()
+endfunction()