Merge branch 'release/0.5'

Author: jahnf

.gitignore

@@ -1,2 +1,3 @@
-CMakeLists.txt.user
+CMakeLists.txt.user*
+.vscode
 

.travis.yml

@@ -1,48 +1,49 @@
-language: generic
+language: cpp
 matrix:
   include:
-    - os: linux
-      dist: trusty
-      env: COMPILER_NAME=gcc CXX=g++-5 CC=gcc-5
-      addons:
-        apt:
-          sources: &sources
-            - llvm-toolchain-trusty-5.0
-            - ubuntu-toolchain-r-test
-            - sourceline: 'ppa:beineri/opt-qt596-trusty'
-          packages:
-            - g++-5
-            - qt59base
-            - qt59declarative
-            - qt59x11extras
-            - libx11-xcb-dev
-    - os: linux
-      dist: trusty
-      env: COMPILER_NAME=gcc CXX=g++-6 CC=gcc-6
-      addons:
-        apt:
-          packages:
-            - g++-6
-            - qt59base
-            - qt59declarative
-            - qt59x11extras
-            - libx11-xcb-dev
-          sources: *sources
-    - os: linux
-      dist: trusty
-      env: COMPILER_NAME=clang CXX=clang++ CC=clang
-      addons:
-        apt:
-          packages:
-            - clang-5.0
-            - qt59base
-            - qt59declarative
-            - qt59x11extras
-            - libx11-xcb-dev
-          sources: *sources
-          
-script: 
-  - mkdir build && cd build
-  - . /opt/qt59/bin/qt59-env.sh && cmake ..
-  - make
-  - ./projecteur -v
+  - os: linux
+    dist: xenial
+    env: DOCKER_IMG=jahnf/projecteur:debian-stretch
+  - os: linux
+    dist: xenial
+    env: DOCKER_IMG=jahnf/projecteur:ubuntu-16.04
+  - os: linux
+    dist: xenial
+    env: 
+      - DOCKER_IMG=jahnf/projecteur:ubuntu-18.04
+      - BUILD_SOURCE_PKG=1
+  - os: linux
+    dist: xenial
+    env: DOCKER_IMG=jahnf/projecteur:opensuse-15.0
+  - os: linux
+    dist: xenial
+    env: DOCKER_IMG=jahnf/projecteur:opensuse-42.3
+script:
+- git fetch --tags
+- "[ -f $(git rev-parse --git-dir)/shallow ] && git fetch --unshallow || echo No need to unshallow..."
+- docker pull ${DOCKER_IMG}
+- docker run --name build --env TRAVIS_BRANCH=${TRAVIS_BRANCH} -d -v `pwd`:/source:ro -ti ${DOCKER_IMG}
+- docker exec -it build /bin/bash -c "mkdir -p /build/dist-pkg && cd /build && cmake /source"
+- docker exec -it build /bin/bash -c "cd /build && cmake --build ."
+- docker exec -it build /bin/bash -c "cd /build && cmake --build . --target dist-package"
+- docker exec -it build /bin/bash -c "cd /build && ./projecteur --version"
+- docker exec -it build /bin/bash -c "mv /build/*.deb /build/dist-pkg || true"
+- docker exec -it build /bin/bash -c "mv /build/*.rpm /build/dist-pkg || true"
+- docker exec -it build /bin/bash -c "mv /build/*.tgz /build/dist-pkg || true"
+- docker exec -it build /bin/bash -c "mv /build/*.tar.gz /build/dist-pkg || true"
+- "[ \"${BUILD_SOURCE_PKG}\" = 1 ] && docker exec -it build /bin/bash -c \"cd /build && cmake --build . --target source-archive\" || true"
+- "[ \"${BUILD_SOURCE_PKG}\" = 1 ] && docker exec -it build /bin/bash -c \"mv /build/archive_output/* /build/dist-pkg\" || true"
+- docker cp build:/build/dist-pkg .
+- docker cp build:/build/travis-ci-bintray-deploy.json .
+- ls -alh dist-pkg
+deploy:
+  provider: bintray
+  skip_cleanup: true
+  on:
+    all_branches: true
+    condition: "$TRAVIS_BRANCH =~ ^develop|master$"
+  file: travis-ci-bintray-deploy.json
+  user:
+    secure: IiLPERfNp3JOj4kLgAaHFWNhYh8ZEMNwbnToo+eg69QsdKOq4gDyPjVA2pjqNjxkHVC8mP846c4RMdx7B3d78cejS+nN8NgwRkGky6pe15ZW6eZ2Ncn4aIaZ35+yL/VIDei+laJv/LWehYypw5qK8hj3kL22VwwzbenMUHUdL6InmB4dVUFnr16BvdNLDPlulgAmeDxgOMYIieiiIPXpQlkHQfZhu9XyFECOunwPRUtipZ0HOck2Q8kJuXeD8Wg0iVVIJbWmXq2BFVexnDMyxvz0WNL2ExK+Nd2wjkccQqQNO2TZVKdW1vt96lataHjfruacWwtFQ95CNLsSJXmmDaTbF6+qG5vKWAPwqe3+kvgyqbYQFt7hAK0YgUHHHgYpZzpQ4EsrvHdld/SACRIr94jX0262FPPb/d7rmCBrmECBHSqKnz+KkIbzdTS/dW5gk+EuInZhef9yfibBjxFHTX7NpCSzrm/jOgQHTnBEoBTzSgeqw1sxdKZ1oPgOmm6FpxvF83B/kfgf1++er4b04BL8tberEgXnTqWQoZNUjhCq8Sx1LIQnT0ySemY1JsnmJMHD79jHSg0wv30EFPhD/TeRoGbbKc+P9ZU+3qle+EAwT33ey34JlRgO9RqHDm2m4jW8snfPgUKWIQazAvwUuilae7VPYPWMMu4a+PR9mjc=
+  key:
+    secure: Qggdx4BL+0iB+lU8maLQw1VzGS/015rdUFeIobTje8P+kEmVkSXAA4IS48zX0Ls0JjotzwYjZyzs+lAk7RYYlj0RMexodPXaiMgN01RygKtpg3g4ZFlDgnWB/gK7dhGhjEryUq4K1mMBJBAu5rO7JUqbpWB2hX8TpwuE1IPuE3vEylGCBbfJn8IBDDJ+1qG1pMMSOvCvg4exBVsYdCUHWnQRYHo+luw9G+jqNB0NHp4ASIYcdGwULejTXvDZ5U+FEL4ftv8v3n4gj8ZFVvgfpXrzrmWCf5SlBAoIXCrpCdirz5k4IuW76vOPufjb+2LfWR4Yoou6tVmZe1tqPKEo9cl4OIzYabNyCaeKznw7vLswh1eY3uG5xdbfdSTdlHBmhq8no2IsMyvqCPWYjrLR20uKOE80tAayMDHeDKZI9UluIRgXiXF0OMP6Yz34mo7VwQZF511GBJa5DxngD64Fc+84YP4GqRqYgKVTL0Rd6fyTHzVTlM63yPYxpzBE5IpU8LtPUgbMR9JU2CNNZx39nuqBde74x6/7yiMMqoDv3AkMSydqzKyMFfzR3EmPC7ZCFoalwkIkK4aVmpRw/EbmjaQ2NOc/N6TNraR5W8JcOhBZNfAQ8gpVXZtQnhxyxdqkrEIO0Glg4IPWonUO2025dq0eycfXyf38NovDz6+weBE=

55-spotlight.rules renamed to 55-spotlight.rules.in

@@ -1,17 +1,22 @@
 # Set up permissions for non root users to open the Logitech Spotlight USB Receiver
 # Enables the Projecteur application to access the device.
 
-# Copy this file to /etc/udev/rules.d/55-spotlight.rules and update the 'plugdev' group in the
-# file to a group you are a member in. (plugdev exists on Ubuntu, other distributions have
-# other groups)
+# Copy this file to /etc/udev/rules.d/55-spotlight.rules and replace '@DEVICE_USER_GROUP@'
+# with a group your user is a member in. 
+#
+# Existing groups like 'plugdev' and 'dialout' can be used, but the `install` target
+# uses a group called 'spotlight-device' by default. 
+# Linux packages created with the 'dist-package' target will create this group if not
+# present during installation.
+#
 # Run `sudo udevadm control --reload-rules` and `sudo udevadm trigger`
 # to load rules without rebooting.
 
 # Note that for kernels before 2.6.24, you will need to substitute "usb" with "usb_device".
 
 # Rule for USB Receiver
-SUBSYSTEMS=="usb", ATTRS{idVendor}=="046d", ATTRS{idProduct}=="c53e", MODE="660", GROUP="plugdev", ENV{USB_HUB_TYPE}="046d:c53e"
+SUBSYSTEMS=="usb", ATTRS{idVendor}=="046d", ATTRS{idProduct}=="c53e", MODE="660", GROUP="@DEVICE_USER_GROUP@", ENV{USB_HUB_TYPE}="046d:c53e"
 
 # Rule when connected via Bluetooth
 # Updated rule, thanks to Torsten Maehne (https://github.com/maehne)
-SUBSYSTEMS=="input", ATTRS{name}=="SPOTLIGHT*", MODE="660", GROUP="plugdev"
+SUBSYSTEMS=="input", ATTRS{name}=="SPOTLIGHT*", MODE="660", GROUP="@DEVICE_USER_GROUP@"

CMakeLists.txt

@@ -26,32 +26,43 @@ set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
 set(CMAKE_AUTOMOC ON)
 set(CMAKE_AUTORCC ON)
-find_package(Qt5 COMPONENTS Core Gui Quick Widgets X11Extras REQUIRED)
-find_package(X11 REQUIRED)
+find_package(Qt5 COMPONENTS Core Gui Quick Widgets REQUIRED)
 
 add_executable(projecteur
   main.cc
   aboutdlg.cc           aboutdlg.h
   colorselector.cc      colorselector.h
   preferencesdlg.cc     preferencesdlg.h
   projecteurapp.cc      projecteurapp.h
-  qglobalshortcutx11.cc qglobalshortcutx11.h
   runguard.cc           runguard.h
   settings.cc           settings.h
   spotlight.cc          spotlight.h
+  spotshapes.cc         spotshapes.h
   resources.qrc         qml/qml.qrc)
 
 target_link_libraries(projecteur
-  Qt5::Core Qt5::Quick Qt5::Widgets Qt5::X11Extras
-  ${X11_LIBRARIES} xcb)
+  Qt5::Core Qt5::Quick Qt5::Widgets
+)
 
+# Set version project properties for builds not from a git repository (e.g. created with git archive)
+# If creating the version number via git information fails, the following target properties
+# will be used. IMPORTANT - when creating a release tag with git flow: 
+#  Update this information - the version numbers and the version type.
+#  VERSION_TYPE must be either 'release' or 'develop'
+set_target_properties(projecteur PROPERTIES 
+  VERSION_MAJOR 0
+  VERSION_MINOR 5
+  VERSION_PATCH 0
+  VERSION_TYPE release
+)
 add_version_info(projecteur "${CMAKE_CURRENT_SOURCE_DIR}")
 
 # Add target with non-source files for convenience when using IDEs like QtCreator and others
-add_custom_target(non-sources SOURCES README.md LICENSE.md 55-spotlight.rules)
+add_custom_target(non-sources SOURCES README.md LICENSE.md)
 
 # Install
 install(TARGETS projecteur DESTINATION bin)
+set(PROJECTEUR_INSTALL_PATH "${CMAKE_INSTALL_PREFIX}/bin/projecteur")
 
 # Use udev.pc pkg-config file to set the dir path
 if (NOT CMAKE_INSTALL_UDEVRULESDIR)
@@ -74,4 +85,41 @@ endif(NOT CMAKE_INSTALL_UDEVRULESDIR)
 set (CMAKE_INSTALL_UDEVRULESDIR ${UDEVDIR}/rules.d CACHE PATH "Where to install udev rules")
 mark_as_advanced(CMAKE_INSTALL_UDEVRULESDIR)
 
-install(FILES 55-spotlight.rules DESTINATION ${CMAKE_INSTALL_UDEVRULESDIR}/)
+# Configure and install files
+set(DEVICE_USER_GROUP spotlight-device)
+set(OUTDIR "${CMAKE_CURRENT_BINARY_DIR}")
+set(TMPLDIR "${CMAKE_CURRENT_SOURCE_DIR}/cmake/templates")
+
+configure_file("55-spotlight.rules.in" "55-spotlight.rules" @ONLY)
+install(FILES "${OUTDIR}/55-spotlight.rules" DESTINATION ${CMAKE_INSTALL_UDEVRULESDIR}/)
+
+install(FILES icons/projecteur-tray.svg DESTINATION /usr/share/icons/hicolor/48x48/apps/ RENAME projecteur.svg)
+install(FILES icons/projecteur-tray.svg DESTINATION /usr/share/icons/hicolor/64x64/apps/ RENAME projecteur.svg)
+install(FILES icons/projecteur-tray.svg DESTINATION /usr/share/icons/hicolor/128x128/apps/ RENAME projecteur.svg)
+install(FILES icons/projecteur-tray.svg DESTINATION /usr/share/icons/hicolor/256x256/apps/ RENAME projecteur.svg)
+
+configure_file("${TMPLDIR}/Projecteur.desktop.in" "projecteur.desktop" @ONLY)
+install(FILES "${OUTDIR}/projecteur.desktop" DESTINATION /usr/share/applications/)
+
+configure_file("${TMPLDIR}/preinst.in" "pkg/scripts/preinst" @ONLY)
+configure_file("${TMPLDIR}/postinst.in" "pkg/scripts/postinst" @ONLY)
+
+set(HOMEPAGE "https://github.com/jahnf/Projecteur")
+
+# Add 'dist-package' target: Creates a deb/rpm/tgz package depending on the current Linux distribution
+include(LinuxPackaging)
+add_dist_package_target(
+  PROJECT "${CMAKE_PROJECT_NAME}" 
+  TARGET projecteur
+  DESCRIPTION_BRIEF "Linux/X11 application for the Logitech Spotlight device."
+  DESCRIPTION_FULL "Linux/X11 application for the Logitech Spotlight device.\nHomepage: ${HOMEPAGE}"
+  CONTACT "Jahn Fuchs <[email protected]>"
+  HOMEPAGE "${HOMEPAGE}"
+  DEBIAN_SECTION "utils"
+  PREINST_SCRIPT "${OUTDIR}/pkg/scripts/preinst"
+  POSTINST_SCRIPT "${OUTDIR}/pkg/scripts/postinst"
+)
+
+# Add 'source-archive' target
+add_source_archive_target(projecteur)
+

LICENSE.md

@@ -1,4 +1,4 @@
-Copyright 2018, Jahn Fuchs
+Copyright 2018-2019, Jahn Fuchs
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
 associated documentation files (the "Software"), to deal in the Software without restriction,

README.md

@@ -3,22 +3,23 @@
 develop: [![Build Status develop](https://travis-ci.org/jahnf/Projecteur.svg?branch=develop)](https://travis-ci.org/jahnf/Projecteur)
 master: [![Build Status master](https://travis-ci.org/jahnf/Projecteur.svg?branch=master)](https://travis-ci.org/jahnf/Projecteur)
 
-Linux/X11 application for the Logitech Spotlight device.
+Linux/X11 application for the Logitech Spotlight device. \
+See [Download](#download) section for binary packages.
 
 Copyright 2018-2019 [Jahn Fuchs](mailto:[email protected])
 
 ## Motivation
 
 I saw the Logitech Spotlight device in action at a conference and liked it
-immediately. Unfortenately as in a lot of cases software is only provided for Windows
+immediately. Unfortunately as in a lot of cases software is only provided for Windows
 and Mac. The device itself works just fine on Linux, but the cool spot feature
 is done by additional software.
 
 So here it is: a Linux application for the Logitech Spotlight.
 
 ## Features
 
-* Configurable desktop spotlight. Configure color, opacity, cursor, center dot.
+* Configurable desktop spotlight. Configure color, opacity, cursor, center dot and shape.
 * Multiple screen support
 
 ![Settings](./doc/screenshot-settings.png)
@@ -38,24 +39,41 @@ The mouse input device sends relative cursor coordinates and left button presses
 The keyboard device basically just sends left and right arrow key events when
 forward or back on the device is pressed.
 
-The dectected mouse input device is what we are interested in. Since it's
+The detected mouse input device is what we are interested in. Since it's
 already detected as a mouse input device and able to move the cursor, we will
 simply detect if it is the Spotlight device which is sending mouse events.
 If it is sending mouse events, we will 'turn on' the desktop spot.
 
 For more details: Have a look at the source code ;)
 
+## Download
+
+The latest automatically built binary packages for some Linux distributions
+can be downloaded from bintray:
+
+Make sure to add the user running the application to the `spotlight-device` group
+after package installation. This group is created during installation of the binary packages.
+_Note_: When adding your user to a new group you will need to login and logout again
+for the change to take full effect.
+
+Latest develop:
+[ ![Download](https://api.bintray.com/packages/jahnf/Projecteur/projecteur-develop/images/download.svg) ](https://bintray.com/jahnf/Projecteur/projecteur-develop/_latestVersion#files)
+
+Latest release:
+[ ![Download](https://api.bintray.com/packages/jahnf/Projecteur/projecteur-master/images/download.svg) ](https://bintray.com/jahnf/Projecteur/projecteur-master/_latestVersion#files)
+
 ## Building
 
 ### Requirements
 
 * C++11 compiler
 * CMake 3.6 or later
-* Qt 5.9 and later
+* Qt 5.6 and later
 
 ### Build Example
 
-Note: You can ommit setting the `QTDIR` variable, CMake will then usually find the Qt versin that comes with the distribution's packacke management.
+Note: You can omit setting the `QTDIR` variable, CMake will then usually find
+the Qt version that comes with the distribution's package management.
 
       > git clone https://github.com/jahnf/projecteur
       > cd projecteur
@@ -67,18 +85,87 @@ Note: You can ommit setting the `QTDIR` variable, CMake will then usually find t
 
 ### Pre-requisites
 
+#### When using pre-built binary packages
+
+Make sure to add the user running the application to the `spotlight-device` group
+after package installation. This group is created during installation of the binary packages. \
+_Note_: When adding your user to a new group you will need to login and logout again
+for the change to take full effect.
+
+#### When building Projecteur yourself
+
 The input devices detected from the Spotlight device must be readable to the
 user running the application. To make this easier there is a udev rule template
-file in this repository: `55-spotlight.rules`
+file in this repository: `55-spotlight.rules.in`
 
-* Copy this file to /etc/udev/rules.d/55-spotlight.rules and update the
-  'plugdev' group in the file to a group you are a member in
+* Copy that file to `/etc/udev/rules.d/55-spotlight.rules` and replace the
+  '@DEVICE_USER_GROUP@' in the file with a group your user is a member in
 * Run `sudo udevadm control --reload-rules` and `sudo udevadm trigger` to load
   the rules without a reboot.
 * After that the two input devices from the Logitech USB Receiver in /dev/input
-  should have the group 'plugdev', i.e. the group you configure in the rules file.
+  should have the group you used, i.e. the group you configured in the rules file.
+* When building against the Qt version that comes with your distribution's packages
+  you might need to install some  additional QML module packages. For example this
+  is the case for Ubuntu, where you need to install the packages
+  `qml-module-qtgraphicaleffrects`, `qml-module-qtquick-window2` and `qml-modules-qtquick2`
+  to satisfy the application's runtime dependencies.
 
 ### Application Menu
 
 The application menu is accessable via the system tray icon. There you will find
 the preferences and the menu entry to exit the application.
+
+### Command Line Interface
+
+Additional to the standard `--help` and `--version` options, there is an option to send
+commands to a running instance of _Projecteur_.
+
+```
+Usage: projecteur [option]
+
+<Options>
+  -h, --help             Show command line usage.
+  -v, --version          Print application version.
+  -c COMMAND             Send command to a running instance.
+
+<Commands>
+  spot=[on|off]          Turn spotlight on/off.
+  settings=[show|hide]   Show/hide preferences dialog.
+  quit                   Quit the running instance.
+```
+
+### Troubleshooting
+
+#### Missing System Tray
+
+_Projecteur_ was developed and tested on GNOME and KDE Desktop environments, but should
+work on most other desktop environments. If the system tray with the _Application Menu_
+is not showing, commands can be send to the application to bring up the preferences
+dialog, to test the spotlight or quit the application.
+See [Command Line Interface](#command-line-interface).
+
+#### Wayland
+
+While not developed with Wayland in mind, some users reported _Projecteur_ works with
+Wayland. If you experience problems, you can try to set the `QT_QPA_PLATFORM` environment
+variable to `wayland`:
+
+```
+user@ubuntu1904:~/Projecteur/build$ QT_QPA_PLATFORM=wayland ./projecteur
+Using Wayland-EGL
+```
+
+#### Device shows as not connected
+
+If the device shows as not connected, there are some things you can do:
+
+* Make sure the device is detected by the Linux system: Run 
+  `cat /proc/bus/input/devices | grep -A 3 "Vendor=046d"` \
+  This should show one or multiple spotlight devices (among other Logitech devices)
+* Make sure the detected devices have the correct user/group asssigned. \ 
+  Run `ls -al /dev/input/event* | grep spotlight` 
+  (or replace `spotlight` by a string that matches the group you put into the 
+   udev rule file in case you edited it yourself). \
+* Make sure you don't have conflicting udev rules installed, e.g. first you installed
+  the udev rule yourself and later you used the automatically built Linux packages to
+  install _Projecteur_.