Windows portable zip/MSI package builds

.github/workflows/build.yml

@@ -126,59 +126,57 @@ jobs:
 
     steps:
 
+    - run: git config --global core.autocrlf input
+      shell: bash
+
     - uses: actions/checkout@v2
       with:
         submodules: recursive
+        fetch-depth: 0
 
     - uses: msys2/setup-msys2@v2
       with:
         update: true
         msystem: MINGW64
-        install: >-
+        install: |
           git
-          make
-          mingw-w64-x86_64-gcc
-          mingw-w64-x86_64-cmake
-          mingw-w64-x86_64-glm
-          mingw-w64-x86_64-libsigc++
-          mingw-w64-x86_64-gtkmm3
-          mingw-w64-x86_64-yaml-cpp
-          mingw-w64-x86_64-glew
+          mingw-w64-x86_64-toolchain
 
-    - name: Clone and Build FFTS Library
+    - name: Build
       run: |
-        git clone https://github.com/anthonix/ffts.git ../ffts
-        cd ../ffts
-        mkdir build
-        cd build
-        cmake \
-          -G"MSYS Makefiles" \
-          -DCMAKE_INSTALL_PREFIX=$MSYSTEM_PREFIX \
-          -DENABLE_SHARED=ON \
-          ..
-        make -j4
-        make install
+        cd msys2
+        MINGW_ARCH=mingw64 makepkg-mingw --noconfirm --noprogressbar -sCLf
 
-    - name: Build
+    - name: Test
       run: |
-        mkdir build
-        cd build
+        pacman -U --noconfirm msys2/*.zst
+        glscopeclient --help
+
+    - name: Upload Artifacts
+      uses: actions/upload-artifact@v2
+      with:
+        name: glscopeclient-windows
+        path: msys2/*.zst
+
+    - name: Build MSI / portable zip
+      run: |
+        mkdir build_msi
+        cd build_msi
         cmake \
           -G"MSYS Makefiles" \
           -DBUILD_TESTING=OFF \
+          -DWIXPATH="/c/Program Files (x86)/WiX Toolset v3.11/bin" \
           ..
         make -j4
 
-    - name: Upload Artifacts
+    - name: Upload Artifacts (portable zip)
       uses: actions/upload-artifact@v2
       with:
-        name: glscopeclient-windows
-        path: |
-          build/src/glscopeclient/glscopeclient.exe
-          build/src/glscopeclient/gradients/*
-          build/src/glscopeclient/shaders/*
-          build/src/glscopeclient/styles/*
-          build/lib/graphwidget/libgraphwidget.dll
-          build/lib/log/liblog.dll
-          build/lib/scopehal/libscopehal.dll
-          build/lib/scopeprotocols/libscopeprotocols.dll
+        name: glscopeclient-windows-portable
+        path: build_msi/dist/windows_x64
+
+    - name: Upload Artifacts (MSI)
+      uses: actions/upload-artifact@v2
+      with:
+        name: glscopeclient-windows.msi
+        path: build_msi/dist/*.msi

.gitignore

@@ -2,3 +2,4 @@ build
 release-build
 debug-build
 analysis-build
+asan-build

CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.10)
+cmake_minimum_required(VERSION 3.14)
 list(APPEND CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake)
 project(glscopeclient)
 
@@ -8,6 +8,10 @@ include(CTest)
 set(BUILD_DOCS CACHE BOOL "Build the documentation")
 set(ANALYZE CACHE BOOL "Run static analysis on the code, requires cppcheck and clang-analyzer to be installed")
 
+set(CMAKE_CXX_STANDARD 11)
+set(CMAKE_CXX_STANDARD_REQUIRED ON) # error if compiler doesn't support c++11
+set(CMAKE_CXX_EXTENSIONS OFF) # use c++11 instead of gnu++11
+
 # Compiler flags
 set(WARNINGS "-Wall -Wextra -Wuninitialized ")
 set(WARNINGS "${WARNINGS} -Wshadow -Wpedantic -Wcast-align -Wwrite-strings")
@@ -19,7 +23,7 @@ elseif (CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
   set(WARNINGS "${WARNINGS} -Wno-gnu-zero-variadic-macro-arguments")
 endif()
 
-set(CMAKE_CXX_FLAGS "-g ${WARNINGS} --std=c++11 -mtune=native -ffast-math")
+set(CMAKE_CXX_FLAGS "-g ${WARNINGS} -mtune=native -ffast-math")
 set(CMAKE_CXX_FLAGS_RELEASE "-O3")
 
 # clang doesn't properly use the attributes and so requires avx to build

README.md

@@ -6,46 +6,4 @@ Applications for libscopehal
 
 ## Installation
 
-### Linux
-#### Install dependencies. 
-
-On Debian/Ubuntu:
-
-```
-sudo apt-get install build-essential cmake pkg-config libglm-dev libgtkmm-3.0-dev libsigc++-2.0-dev libyaml-cpp-dev liblxi-dev texlive texlive-fonts-extra libglew-dev catch2
-```
-
-If you are using an older stable release (such as Debian Buster), you may need to install catch2 from source (https://github.com/catchorg/Catch2).  Alternatively, you may pass `-DBUILD_TESTING=OFF` to CMake to disable unit testing, which is not necessary if you are not contributing to the codebase. 
-
-#### Install FFTS library.
-
-```
-git clone https://github.com/anthonix/ffts.git
-cd ffts
-mkdir build
-cd build
-cmake .. -DENABLE_SHARED=ON
-make -j4
-sudo make install
-```
-
-#### Build scopehal and scopehal-apps.
-
-```
-git clone https://github.com/azonenberg/scopehal-apps.git --recurse-submodules
-cd scopehal-apps
-mkdir build
-cd build
-cmake ..
-make
-```
-
-The executable is found under `build/src/glscopeclient/glscopeclient` and the manual under `build/doc/glscopeclient-manual.pdf`
-
-#### Install scopehal and scopehal-apps.
-
-There is currently no process for installing `scopehal` or `scopehal-apps`. At this moment, `glscopeclient` is intended to be run from the source directory (`src/glscopeclient`). We welcome your help in setting up a proper install process! 
-
-### Windows (experimental)
-
-Refer to [the manual](https://www.antikernel.net/temp/glscopeclient-manual.pdf) for instructions regarding compilation on Windows systems.
+Refer to the "getting started" chapter of [the manual](https://www.antikernel.net/temp/glscopeclient-manual.pdf).

msys2/PKGBUILD

@@ -0,0 +1,54 @@
+_realname=scopehal-apps
+pkgbase=mingw-w64-${_realname}
+pkgname="${MINGW_PACKAGE_PREFIX}-${_realname}"
+pkgver=ci
+pkgrel=1
+pkgdesc="scopehal-apps: applications for libscopehal (mingw-w64)"
+arch=('any')
+mingw_arch=('mingw64' 'ucrt64' 'clang64')
+url="https://github.com/azonenberg/scopehal-apps"
+license=('BSD-3-Clause')
+groups=("${MINGW_PACKAGE_PREFIX}-eda")
+depends=(
+  "${MINGW_PACKAGE_PREFIX}-glm"
+  "${MINGW_PACKAGE_PREFIX}-libsigc++"
+  "${MINGW_PACKAGE_PREFIX}-gtkmm3"
+  "${MINGW_PACKAGE_PREFIX}-yaml-cpp"
+  "${MINGW_PACKAGE_PREFIX}-glew"
+  "${MINGW_PACKAGE_PREFIX}-ffts"
+)
+makedepends=(
+  "${MINGW_PACKAGE_PREFIX}-gcc"
+  "${MINGW_PACKAGE_PREFIX}-cmake"
+  "make"
+)
+
+pkgver() {
+  cd "${srcdir}"/../..
+  echo '0.0.0.r'"$(git rev-list --count HEAD)"'.g'"$(git describe --all --long | sed 's/^.*-g\(.*\)/\1/')"
+}
+
+build() {
+  cd "${srcdir}"/../..
+
+  git remote set-url origin git://github.com/azonenberg/scopehal-apps
+  git submodule update --init --recursive
+
+  mkdir build
+  cd build
+  MSYS2_ARG_CONV_EXCL=-DCMAKE_INSTALL_PREFIX= cmake \
+    -G "MSYS Makefiles" \
+    -DCMAKE_INSTALL_PREFIX="${MINGW_PREFIX}" \
+    -DBUILD_TESTING=OFF \
+    ../
+  cmake --build .
+}
+
+package() {
+  cd "${srcdir}"/../../build
+  make DESTDIR="${pkgdir}" install
+
+  _licenses="${pkgdir}${MINGW_PREFIX}/share/licenses/${_realname}"
+  mkdir -p "${_licenses}"
+  install -m 644 "${srcdir}"/../../LICENSE "${_licenses}"
+}

src/glscopeclient/CMakeLists.txt

@@ -6,17 +6,19 @@ endif()
 # GLEW and OpenGL are required
 find_package(GLEW REQUIRED)
 find_package(OpenGL REQUIRED)
-find_package(Yaml REQUIRED)
 
 # Git is used for git-describe based version generation if we have it
 find_package(Git)
 
 # Additional libraries on Windows
 if(WIN32)
 	set(WIN_LIBS shlwapi)
-
-	# For some reason, find_package does not manage to find glew32 on Windows. Hardcoding for now.
-	set(GLEW_LIBRARIES "glew32")
+	# The packaging for yaml-cpp on mingw64 seems to be broken, not providing a
+	# libyaml-cpp.dll.a to be found by find_library inside of find_package(YAML)
+	# when using FindYAML.cmake, just set the library directly
+	set(YAML_LIBRARIES yaml-cpp)
+else()
+	find_package(Yaml REQUIRED)
 endif()
 
 #Set up include paths
@@ -39,6 +41,7 @@ configure_file(glscopeclient-version.h.in glscopeclient-version.h)
 ###############################################################################
 #C++ compilation
 add_executable(glscopeclient
+	pthread_compat.cpp
 	ChannelPropertiesDialog.cpp
 	FileProgressDialog.cpp
 	FilterDialog.cpp
@@ -75,6 +78,7 @@ add_executable(glscopeclient
 	WaveformArea_cairo.cpp
 	WaveformGroup.cpp
 	WaveformGroupPropertiesDialog.cpp
+	WaveformProcessingThread.cpp
 
 	main.cpp
 )
@@ -88,7 +92,7 @@ target_link_libraries(glscopeclient
 	${SIGCXX_LIBRARIES}
 	${OPENGL_LIBRARY}
 	${WIN_LIBS}
-	${GLEW_LIBRARIES}
+	GLEW::GLEW
 	${YAML_LIBRARIES}
 	)
 
@@ -124,6 +128,66 @@ add_dependencies(glscopeclient
 	icons
 )
 
+# Windows portable zip/MSI installer build
+if(WIN32)
+	add_custom_target(
+		dist_windows_x64
+		COMMENT "Creating dist/windows_x64..."
+		DEPENDS glscopeclient
+		COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_BINARY_DIR}/dist/windows_x64
+		COMMAND ${CMAKE_COMMAND} -E copy_directory
+				${CMAKE_SOURCE_DIR}/src/glscopeclient/gradients ${CMAKE_BINARY_DIR}/dist/windows_x64/gradients
+		COMMAND ${CMAKE_COMMAND} -E copy_directory
+				${CMAKE_SOURCE_DIR}/lib/scopeprotocols/kernels ${CMAKE_BINARY_DIR}/dist/windows_x64/kernels
+		COMMAND ${CMAKE_COMMAND} -E copy_directory
+				${CMAKE_SOURCE_DIR}/src/glscopeclient/shaders ${CMAKE_BINARY_DIR}/dist/windows_x64/shaders
+		COMMAND ${CMAKE_COMMAND} -E copy_directory
+				${CMAKE_SOURCE_DIR}/src/glscopeclient/styles ${CMAKE_BINARY_DIR}/dist/windows_x64/styles
+		COMMAND ${CMAKE_COMMAND} -E copy_directory
+				${CMAKE_SOURCE_DIR}/src/glscopeclient/icons ${CMAKE_BINARY_DIR}/dist/windows_x64/icons
+		COMMAND ${CMAKE_COMMAND} -E copy
+				${CMAKE_SOURCE_DIR}/src/LICENSE 
+				${CMAKE_BINARY_DIR}/lib/graphwidget/libgraphwidget.dll
+				${CMAKE_BINARY_DIR}/lib/log/liblog.dll
+				${CMAKE_BINARY_DIR}/lib/scopehal/libscopehal.dll
+				${CMAKE_BINARY_DIR}/lib/scopeprotocols/libscopeprotocols.dll
+				${CMAKE_BINARY_DIR}/src/glscopeclient/glscopeclient.exe
+				${CMAKE_BINARY_DIR}/dist/windows_x64
+		COMMAND bash -c \"cp -R /mingw64/share/licenses ${CMAKE_BINARY_DIR}/dist/windows_x64\"
+		COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_BINARY_DIR}/dist/windows_x64/lib
+		COMMAND bash -c \"cp -R /mingw64/lib/gdk-pixbuf-2.0 ${CMAKE_BINARY_DIR}/dist/windows_x64/lib\"
+		COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_BINARY_DIR}/dist/windows_x64/share/icons
+		COMMAND bash -c \"cp -R /mingw64/share/icons/hicolor ${CMAKE_BINARY_DIR}/dist/windows_x64/share/icons\"
+		COMMAND bash -c \"cp -R /mingw64/share/icons/Adwaita ${CMAKE_BINARY_DIR}/dist/windows_x64/share/icons\"
+		COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_BINARY_DIR}/dist/windows_x64/share/glib-2.0
+		COMMAND bash -c \"cp -R /mingw64/share/glib-2.0/schemas ${CMAKE_BINARY_DIR}/dist/windows_x64/share/glib-2.0\"
+		COMMAND bash -c \"cd ${CMAKE_BINARY_DIR}/dist/windows_x64 && glib-compile-schemas ./share/glib-2.0/schemas\" 
+		COMMAND bash -c \"ldd ${CMAKE_BINARY_DIR}/dist/windows_x64/glscopeclient.exe | grep '\/mingw64\/bin\/.*dll' -o  | xargs -I{} cp /mingw64/bin/gdbus.exe \\\"{}\\\" ${CMAKE_BINARY_DIR}/dist/windows_x64\")
+
+	add_custom_target(
+		portable_zip_windows_x64 ALL
+		COMMENT "Creating portable zip from dist/windows_x64..."
+		DEPENDS dist_windows_x64
+		WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/dist/windows_x64
+		COMMAND ${CMAKE_COMMAND} -E tar "cf" "${CMAKE_BINARY_DIR}/dist/glscopeclient-${GLSCOPECLIENT_VERSION}-windows-x64-portable.zip" --format=zip -- .)
+
+    if(WIXPATH)
+		configure_file(wix/glscopeclient.wxs.in ${CMAKE_BINARY_DIR}/glscopeclient.wxs)
+		add_custom_target(
+			msi_windows_x64 ALL
+			COMMENT "Creating Windows x64 MSI..."
+			DEPENDS dist_windows_x64
+			WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+			COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/src/glscopeclient/wix/LICENSE.rtf ${CMAKE_BINARY_DIR}
+			COMMAND ${WIXPATH}/heat dir dist/windows_x64 -gg -ke -scom -sreg -srd -cg AllFiles -dr APPLICATIONFOLDER -sfrag -template fragment -out glscopeclient-files.wxs
+			COMMAND ${WIXPATH}/candle -nologo glscopeclient-files.wxs -arch x64 -out glscopeclient-files.wixobj 
+			COMMAND ${WIXPATH}/candle -nologo glscopeclient.wxs -arch x64 -out glscopeclient.wixobj -ext WixUIExtension -ext WixUtilExtension
+			COMMAND ${WIXPATH}/light -nologo glscopeclient-files.wixobj glscopeclient.wixobj -b dist/windows_x64 -out dist/glscopeclient-${GLSCOPECLIENT_VERSION}-windows-x64.msi -ext WixUIExtension -ext WixUtilExtension)
+	else()
+		message("Skipping MSI package build; define WIXPATH to enable")
+	endif()
+endif()
+
 ###############################################################################
 # Installation