[WIP] Windows, macOS, Linux CI (#304)

.gitignore

@@ -15,18 +15,18 @@
 
 /.qmake.cache
 /.qmake.stash
-*.pro.user
-*.pro.user.*
-CMakeLists.txt.user
-CMakeLists.txt.user.*
+/*.pro.user
+/*.pro.user.*
+/CMakeLists.txt.user
+/CMakeLists.txt.user.*
 *.moc
 moc_*.cpp
 qrc_*.cpp
 ui_*.h
 Makefile*
-*build*/
-release/
-debug/
+/*build*/
+/release/
+/debug/
 
 # OSX
 .DS_Store
@@ -43,3 +43,10 @@ debug/
 *.pyc
 *.py~
 
+# CLion
+/.idea/
+/cmake-build*/
+
+# Visual Studio
+/.vs/
+/CMakeSettings.json

.travis.yml

@@ -1,28 +1,72 @@
+# Special thanks to MuseScore
+
 language: cpp
-sudo: required
-dist: trusty
-git:
-  submodules: false
-before_install:
-  - sudo add-apt-repository --yes ppa:beineri/opt-qt571-trusty
-  - sudo add-apt-repository --yes ppa:ubuntu-toolchain-r/test
-  - sudo apt-get update -qq
-  - sudo apt-get install -qq g++-4.8 libsamplerate0-dev libquazip0-dev
-  - sudo apt-get install -qq -y qt57base qt57declarative qt57imageformats qt57location qt57multimedia qt57quickcontrols qt57script qt57svg qt57tools qt57translations libsdl2-dev
-  - sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-4.8 90
-  - wget https://cmake.org/files/v3.7/cmake-3.7.2-Linux-x86_64.sh
-  - chmod +x cmake-3.7.2-Linux-x86_64.sh
-  - mkdir cmake-bin
-  - ./cmake-3.7.2-Linux-x86_64.sh --skip-license --prefix=`pwd`/cmake-bin
-script:
-  - source /opt/qt57/bin/qt57-env.sh
-  - mkdir phoenix-build
-  - cd phoenix-build
-  - ../cmake-bin/bin/cmake ..
-  - make -j2
+sudo: false
+
+env:
+  global:
+    - "ARTIFACTS_AWS_REGION=us-east-1"
+    - secure: "XMKxvHKgJmvcadiENukV02OG5OnUUF7+LmKOTkQk2Fxa1LMNQqSRncIC9G0qqdFQPqjVXhDM3aBFUTxTkTk7rlsT4LO1+XlgZ6B4QBo22GfhPcgjJaUqVMmjoMNINiO32ED4mi+dhLYr7ewnZCEijYxpA0sqRbUiM1l0fUZwiHk="
+    - secure: "gLHgwDamFLrBVbb7LIiPgFhKmnNGLFTvsb0Dk146QS9LBtuYHDJRZbt1sv1ZC/704nCPk6zarqersRifcQAW46IaoW6sn+0UP9owUVvrmKjncKKTYzAkleuHx43pWq93T9bh1llhl/8EX1jOrVTsyTKRJkMgntD2vjPeDrZRGjQ="
+    - secure: "BdRerctcHfM4b3TDWPtkeHTv6WP/GioMO5gw4podQOlEYXMxDhwVrf9wqC+eIDl9KS6+FSvOfrQvTuGKrWWTWoTiP+tBuJaKhfzALXl7PcKlwL3ThVlr+8GSsVA20XHBD2i2Hk0azenzX6cXv+NXtHdkCVoj6sld8tnQ0/8fZbY="
+
+matrix:
+  fast_finish: true
+
+  allow_failures:
+    - env: "JOB=ubuntu_debug"
+    - env: "JOB=macOS_debug"
+
+  include:
+    # 1st parallel build job - debug build on Ubuntu
+    - env: "JOB=ubuntu_debug"
+      dist: trusty
+      sudo: required
+      cache:
+        directories:
+          - $HOME/.ccache
+
+      before_install:
+        - "git fetch --unshallow"
+      install:
+        - "sudo apt update -qq"
+        - "sudo apt install libsamplerate0-dev libkf5archive-dev libsdl2-dev p7zip-full"
+        - "source ./ci/travis/linux-env.sh"
+      script:
+        - chmod +x "./ci/travis/linux-build.sh"
+        - "./ci/travis/linux-build.sh"
+      after_success:
+        - chmod +x "./ci/travis/linux-upload.sh"
+        - "./ci/travis/linux-upload.sh"
+
+    # 2nd parallel build job - debug build on macOS
+    - env: "JOB=macOS_debug"
+      os: osx
+      osx_image: xcode8.3
+      cache:
+        directories:
+          - $HOME/.ccache
+
+      before_install:
+        - "git fetch --unshallow"
+      install:
+        # https://github.com/travis-ci/travis-ci/issues/6307
+        - command curl -sSL https://rvm.io/mpapis.asc | gpg2 --import -
+        - rvm get stable
+        - "source ./ci/travis/mac-env.sh"
+      script:
+        - chmod +x "./ci/travis/mac-build.sh"
+        - "./ci/travis/mac-build.sh"
+      after_success:
+        - chmod +x "./ci/travis/mac-upload.sh"
+        - "./ci/travis/mac-upload.sh"
+
 notifications:
   irc:
     channels:
       - "chat.freenode.net#phoenix-dev"
     use_notice: true
     skip_join: true
+
+git:
+  submodules: false

CMake/DistCommon.cmake

@@ -1,4 +1,4 @@
-option( PORTABLE_MODE "Store all data in the same folder as the binary" ON )
+option( PORTABLE_MODE "Store all data in the same folder as the binary" OFF )
 
 if( PORTABLE_MODE )
 	file( WRITE ${CMAKE_CURRENT_BINARY_DIR}/PHOENIX-PORTABLE "" )
@@ -7,8 +7,10 @@ endif()
 # Embed git tag in file
 include( externals/cmake-modules/GetGitRevisionDescription.cmake REQUIRED )
 git_describe( PHOENIX_VER_STR )
+message( "git_describe: " ${PHOENIX_VER_STR} )
 string( SUBSTRING ${PHOENIX_VER_STR} 1 -1 PHOENIX_VER_TUPLE )
 string( REGEX REPLACE "-[0-9a-z\\-]*" "" PHOENIX_VER_TUPLE ${PHOENIX_VER_TUPLE} )
+set( PHOENIX_VER_DOTS ${PHOENIX_VER_TUPLE} )
 string( REPLACE "." "," PHOENIX_VER_TUPLE ${PHOENIX_VER_TUPLE} )
 configure_file( version.h.in version.h @ONLY )
 

CMake/DistLinux.cmake

@@ -0,0 +1,7 @@
+install( TARGETS Phoenix RUNTIME DESTINATION . )
+install( DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/QML DESTINATION . )
+install( DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/Metadata DESTINATION . )
+
+if( PORTABLE_MODE )
+        install( FILES ${CMAKE_CURRENT_BINARY_DIR}/PHOENIX-PORTABLE DESTINATION . )
+endif()

CMake/DistOSX.cmake

@@ -1,3 +1,14 @@
-set( OSX_ICON_FILES ${CMAKE_CURRENT_SOURCE_DIR}/frontend/phoenix.icns )
+set( OSX_ICON_FILES frontend/phoenix.icns )
 set_source_files_properties( ${OSX_ICON_FILES} PROPERTIES MACOSX_PACKAGE_LOCATION Resources )
-target_sources( ${PROJECT_NAME} PRIVATE ${OSX_ICON_FILES} )
+
+target_sources( ${PROJECT_NAME} PRIVATE ${OSX_ICON_FILES} ${FRONTEND_CONTENT} )
+
+install( TARGETS Phoenix DESTINATION . )
+
+# This tool automatically patches hard-coded dependencies and copies them to the .app bundle
+set(QT5_MACDEPLOYQT ${Qt5_DIR}/../../../bin/macdeployqt)
+install(CODE "
+	message(\"Executing macdeployqt...\")
+	execute_process(COMMAND \"${QT5_MACDEPLOYQT}\" \"${CMAKE_INSTALL_PREFIX}/Phoenix.app\" -no-strip \"-qmldir=${CMAKE_INSTALL_PREFIX}/Phoenix.app/Contents/Resources/QML\")
+	message(\"macdeployqt finished!\")
+	")

CMake/DistWindows.cmake

@@ -6,4 +6,18 @@ install( DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/Metadata DESTINATION . )
 
 if( PORTABLE_MODE )
 	install( FILES ${CMAKE_CURRENT_BINARY_DIR}/PHOENIX-PORTABLE DESTINATION . )
-endif()
+endif()
+
+# This tool automatically gathers Qt dependencies and copies them to the install folder
+set(QT5_WINDEPLOYQT ${Qt5_DIR}/../../../bin/windeployqt)
+#get_filename_component(SDL2_DIR_PARENT "${SDL2_DIR}" DIRECTORY)
+#--pdb
+install(CODE "
+        message(\"Executing windeployqt...\")
+        execute_process(COMMAND \"${QT5_WINDEPLOYQT}\"
+            --compiler-runtime
+            --qmldir \"${CMAKE_INSTALL_PREFIX}/QML\"
+            \"${CMAKE_INSTALL_PREFIX}/Phoenix.exe\"
+        )
+        message(\"windeployqt finished!\")
+        ")

CMake/FindLibsamplerate.cmake

@@ -22,6 +22,13 @@ find_path(LIBSAMPLERATE_INCLUDE_DIR samplerate.h
 if(LIBSAMPLERATE_LIBRARY AND LIBSAMPLERATE_INCLUDE_DIR)
     set(LIBSAMPLERATE_FOUND TRUE)
     message(STATUS "Found libsamplerate ${LIBSAMPLERATE_LIBRARY}")
+    add_library(SRC::samplerate STATIC IMPORTED)
+    set_target_properties(SRC::samplerate PROPERTIES
+        INTERFACE_INCLUDE_DIRECTORIES "${LIBSAMPLERATE_INCLUDE_DIR}"
+    )
+    set_target_properties(SRC::samplerate PROPERTIES
+        IMPORTED_LOCATION ${LIBSAMPLERATE_LIBRARY}
+    )
 else(LIBSAMPLERATE_LIBRARY AND LIBSAMPLERATE_PLUGIN_PATH)
     message(STATUS "Could not find libsamplerate, get it http://www.mega-nerd.com/SRC/")
 endif(LIBSAMPLERATE_LIBRARY AND LIBSAMPLERATE_INCLUDE_DIR)

CMakeLists.txt

@@ -1,77 +1,81 @@
-cmake_minimum_required( VERSION 3.6.0 FATAL_ERROR )
-list( APPEND CMAKE_MODULE_PATH
+cmake_minimum_required(VERSION 3.6.0 FATAL_ERROR)
+list(APPEND CMAKE_MODULE_PATH
 	${CMAKE_CURRENT_LIST_DIR}/CMake
 	${CMAKE_CURRENT_LIST_DIR}/externals/cmake-modules
 	${CMAKE_CURRENT_LIST_DIR}/frontend
 )
 
-project( Phoenix )
-add_executable( ${PROJECT_NAME} "" )
+# A fix for Windows
+if(WIN32)
+	set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_DEBUG "${OUTPUT_DIRECTORY}")
+	set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_RELEASE "${OUTPUT_DIRECTORY}")
+	set(CMAKE_LIBRARY_OUTPUT_DIRECTORY_DEBUG "${OUTPUT_DIRECTORY}")
+	set(CMAKE_LIBRARY_OUTPUT_DIRECTORY_RELEASE "${OUTPUT_DIRECTORY}")
+	set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY_DEBUG "${OUTPUT_DIRECTORY}")
+	set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY_RELEASE "${OUTPUT_DIRECTORY}")
+endif()
 
 ##
-## Phoenix source
+## Phoenix executable
 ##
 
-include( frontend/CMakeLists.txt )
-include( backend/CMakeLists.txt )
+project(Phoenix)
+add_executable(${PROJECT_NAME} MACOSX_BUNDLE "")
 
 ##
-## Externals
+## Phoenix source
 ##
 
-find_package( Libsamplerate REQUIRED )
-if( LIBSAMPLERATE_FOUND )
-	include_directories( ${LIBSAMPLERATE_INCLUDE_DIR} )
-	target_link_libraries( ${PROJECT_NAME} ${LIBSAMPLERATE_LIBRARY} )
-endif()
-
-find_package( Quazip REQUIRED )
-if( QUAZIP_FOUND )
-	include_directories( ${QUAZIP_INCLUDE_DIR} )
-	target_link_libraries( ${PROJECT_NAME} ${QUAZIP_LIBRARIES} )
-endif()
+include(frontend/CMakeLists.txt)
+include(backend/CMakeLists.txt)
 
-find_package( SDL2 REQUIRED )
-if( SDL2_FOUND )
-	include_directories( ${SDL2_INCLUDE_DIR} )
-	target_link_libraries( ${PROJECT_NAME} ${SDL2_LIBRARY} ${SDL2_SDLMAIN_LIBRARY} )
-endif()
-
-find_package( ZLIB REQUIRED )
-if( ZLIB_FOUND )
-	include_directories( ${ZLIB_INCLUDE_DIR} )
-	target_link_libraries( ${PROJECT_NAME} ${ZLIB_LIBRARY_RELEASE} )
-endif()
-
-set( CMAKE_INCLUDE_CURRENT_DIR ON )
-set_target_properties( ${PROJECT_NAME} PROPERTIES AUTOMOC ON AUTORCC ON )
+##
+## Externals
+##
 
-find_package( Qt5 REQUIRED COMPONENTS Concurrent Core Multimedia Network Qml Quick Sql Svg )
-target_link_libraries( ${PROJECT_NAME} Qt5::Concurrent Qt5::Core Qt5::Multimedia Qt5::Network Qt5::Qml Qt5::Quick Qt5::Sql Qt5::Svg )
+find_package(Qt5 REQUIRED COMPONENTS Concurrent Core Multimedia Network Qml Quick Sql Svg)
+target_link_libraries(${PROJECT_NAME} Qt5::Concurrent Qt5::Core Qt5::Multimedia Qt5::Network Qt5::Qml Qt5::Quick Qt5::Sql Qt5::Svg)
+set(CMAKE_INCLUDE_CURRENT_DIR ON)
+set_target_properties(${PROJECT_NAME} PROPERTIES AUTOMOC ON AUTORCC ON)
 
 # On macOS, we must use QtPlatformHeaders to grab the pointer to the main window's native OpenGL context (NSOpenGLContext)
 # http://doc.qt.io/qt-5/qtplatformheaders-index.html
-if( APPLE )
+if(APPLE)
 	# QtPlatformHeaders is a header-only module, leaving us with no choice but to get its location in this hacky way
 	# FIXME: This is not necessary when using qmake, but is when using CMake?
-	set( _qt5_platform_headers ${_qt5_root_dir}/../../include )
-	get_filename_component( _qt5_platform_headers ${_qt5_platform_headers} ABSOLUTE )
-	message( "Found QtPlatformHeaders: " ${_qt5_platform_headers} )
-	target_include_directories( ${PROJECT_NAME} PUBLIC ${_qt5_platform_headers} )
+	set(_qt5_platform_headers ${_qt5_root_dir}/../../include)
+	get_filename_component(_qt5_platform_headers ${_qt5_platform_headers} ABSOLUTE)
+	message("Found QtPlatformHeaders: " ${_qt5_platform_headers})
+	target_include_directories(${PROJECT_NAME} PUBLIC ${_qt5_platform_headers})
 
 	# FIXME: For some reason this is necessary on macOS?
-	find_library( FOUNDATION Foundation REQUIRED )
-	target_link_libraries( ${PROJECT_NAME} ${FOUNDATION} )
+	find_library(FOUNDATION Foundation REQUIRED)
+	target_link_libraries(${PROJECT_NAME} ${FOUNDATION})
+endif()
+
+find_package(libsamplerate REQUIRED)
+target_link_libraries(Phoenix SRC::samplerate)
+
+find_package(ZLIB REQUIRED)
+target_link_libraries(Phoenix ZLIB::ZLIB)
+
+find_package(KF5Archive REQUIRED)
+target_link_libraries(Phoenix KF5::Archive)
+
+find_package(SDL2 REQUIRED)
+target_link_libraries(${PROJECT_NAME} SDL2::SDL2 SDL2::SDL2main)
+if(WIN32)
+	target_link_libraries(${PROJECT_NAME} user32 gdi32 winmm imm32 ole32 oleaut32 version uuid)
 endif()
 
 ##
 ## Compiler
 ##
 
-set_target_properties( ${PROJECT_NAME} PROPERTIES CXX_STANDARD 11 CXX_STANDARD_REQUIRED 11 )
+set_target_properties(${PROJECT_NAME} PROPERTIES CXX_STANDARD 11 CXX_STANDARD_REQUIRED 11)
 
 ##
 ## Distribution
 ##
 
-include( CMake/DistCommon.cmake )
+include(CMake/DistCommon.cmake)

backend/CMakeLists.txt

@@ -2,19 +2,22 @@
 ## Source files
 ##
 
-include( ${CMAKE_CURRENT_LIST_DIR}/consumer/CMakeLists.txt )
-include( ${CMAKE_CURRENT_LIST_DIR}/control/CMakeLists.txt )
-include( ${CMAKE_CURRENT_LIST_DIR}/core/CMakeLists.txt )
-include( ${CMAKE_CURRENT_LIST_DIR}/input/CMakeLists.txt )
-include( ${CMAKE_CURRENT_LIST_DIR}/pipeline/CMakeLists.txt )
-include( ${CMAKE_CURRENT_LIST_DIR}/util/CMakeLists.txt )
+include(${CMAKE_CURRENT_LIST_DIR}/consumer/CMakeLists.txt)
+include(${CMAKE_CURRENT_LIST_DIR}/control/CMakeLists.txt)
+include(${CMAKE_CURRENT_LIST_DIR}/core/CMakeLists.txt)
+include(${CMAKE_CURRENT_LIST_DIR}/input/CMakeLists.txt)
+include(${CMAKE_CURRENT_LIST_DIR}/pipeline/CMakeLists.txt)
+include(${CMAKE_CURRENT_LIST_DIR}/util/CMakeLists.txt)
 
-target_sources( ${PROJECT_NAME}
-	PRIVATE
-	${CMAKE_CURRENT_LIST_DIR}/backendplugin.cpp
+set(SOURCES_PRIVATE
+    ${CMAKE_CURRENT_LIST_DIR}/backendplugin.cpp
+)
 
-	PUBLIC
-	${CMAKE_CURRENT_LIST_DIR}/backendplugin.h
+set(SOURCES_PUBLIC
+    ${CMAKE_CURRENT_LIST_DIR}/backendplugin.h
 )
 
-target_include_directories( ${PROJECT_NAME} PUBLIC "${CMAKE_CURRENT_LIST_DIR}" )
+target_sources(${PROJECT_NAME} PRIVATE ${SOURCES_PRIVATE} PUBLIC ${SOURCES_PUBLIC})
+source_group(TREE "${CMAKE_SOURCE_DIR}" FILES ${SOURCES_PRIVATE} ${SOURCES_PUBLIC})
+
+target_include_directories(${PROJECT_NAME} PUBLIC "${CMAKE_CURRENT_LIST_DIR}")