Release 2.0.0

This is a major release and includes BREAKING changes!

Breaking Changes:
  * More intuitive switch of focus, next, prev and exchange (#20, 40 in Bugs.md)
    Cagebreak will probably still feel broadly the same though.
  * Remove -r flag - This is replaced by output configuration.
  * Socket disabled by default - The socket is enabled by invoking Cagebreak with the -e flag.
  * Socket permissions restricted to the user of the Cagebreak process (700)
    This may require modification of scripts interacting with the socket with
    different UIDs than the UID of the Cagebreak process.
  * Rename "Current frame" indicator to "Current tile"

Changelog:
  * Move to wlr_scene
  * Add events displaying change over the socket
    * this enables scripting tools
  * Add support for scaling outputs (thanks to Oliver Friedmann)
  * Remove -r flag
  * Add rotation to output configuration
  * Add cursor enable|disable flag
  * Add input keyboard configuration
  * Custom path flag for configuration file
  * Restrict socket permissions to the user running cagebreak (700)
  * Fix Issue #31 (resolve some terminology) 38 in Bugs.md
  * Fix Issue #30 - 39 in Bugs.md
  * Fix Issue #20 - 40 in Bugs.md
  * Fix Issue #12 - 41 in Bugs.md (dump + events over socket)
  * Fix Bugs found via scan-build static analysis (42 - 45 in Bugs.md)
  * Fix Issue #33 - 46 in Bugs.md
  * Fix Issue #32 - 47 in Bugs.md
  * Fix Issue #16 - 48 in Bugs.md
  * Fix Issue #3 - 49 in Bugs.md (disabling keybinding interpretation for specific keyboards is now possible)
  * Fix Issue #26 - 50 in Bugs.md
  * Fix Issue #7 - 51 in Bugs.md (Change cursor to square while Cagebreak is waiting for a key)
  * Fix config bug for some commands - 52 in Bugs.md
  * Fix Issue #35 - 53 in Bugs.md (update to wlroots 0.16.1)
  * Improve FAQ.md (related to some Issues)
  * Disable outputs when unable to set any mode (crashed previously)
  * Add Code of Conduct
  * Print version number on startup

example_scripts/cb_script_header.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+# Copyright 2023, project-repo and the cagebreak contributors
+# SPDX -License-Identifier: MIT
+
+named_pipe_send="$(mktemp -u)"
+named_pipe_recv="$(mktemp -u)"
+mkfifo "${named_pipe_send}"
+mkfifo "${named_pipe_recv}"
+nc -U "${CAGEBREAK_SOCKET}" < "${named_pipe_send}" > "${named_pipe_recv}"&
+# The file descriptor 3 is set up to send commands to cagebreak and file
+# descriptor 4 can be used to read events. Notice that events will pile up in
+# file descriptor 4, so it is a good idea to continuously read from it or to
+# clear it before starting a new transaction.
+exec 3>"${named_pipe_send}"
+exec 4<"${named_pipe_recv}"
+# When the script exits, the os will clean up the pipe
+rm "${named_pipe_recv}"
+rm "${named_pipe_send}"

example_scripts/focus_follows_cursor.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+# Copyright 2023, project-repo and the cagebreak contributors
+# SPDX -License-Identifier: MIT
+
+# This script uses the cagebreak socket to modify the compositor's behaviour in
+# such a way that the currently focussed tile follows the cursor, i.e. that the
+# currently focussed tile is always the one within which the cursor is located.
+
+# Start up the ipc link
+source "$(dirname "${BASH_SOURCE[0]}")/cb_script_header.sh"
+
+while IFS= read -r -d $'\0' event
+do
+	# Remove the cg-ipc header
+	event="${event:6}"
+	if [[ "$(echo "${event}" | jq ".event_name")" = "\"cursor_switch_tile\"" ]]
+	then
+		new_tile="$(echo "${event}"|jq -r ".new_tile")"
+		new_output_id="$(echo "${event}"|jq -r ".new_output_id")"
+		# Send the new tile to focus to cagebreak
+		echo -e "screen ${new_output_id}\nfocus_tile ${new_tile}" >&3
+	fi
+done <&4

example_scripts/show_workspace_views.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+# Copyright 2020 - 2023, project-repo and the cagebreak contributors
+# SPDX -License-Identifier: MIT
+
+# This script displays the process names of the views on the current workspace.
+
+# Start up the ipc link
+source "$(dirname "${BASH_SOURCE[0]}")/cb_script_header.sh"
+
+echo "dump" >&3
+
+while IFS= read -r -d $'\0' event
+do
+	# Remove the cg-ipc header
+	event="${event:6}"
+	if [[ "$(echo "${event}" | jq ".event_name")" = "\"dump\"" ]]
+	then
+		curr_output="$(echo "${event}"|jq ".curr_output")"
+		curr_workspace="$(echo "${event}"|jq -r ".outputs.${curr_output}.curr_workspace")"
+		# Print the process names of the view on the current workspace. jq retrieves
+		# their PID and ps is then used to retrieve the process names.
+		(echo -n "message ";ps -o comm=Command -p $(echo "${event}"|jq -r ".outputs.${curr_output}.workspaces[$((curr_workspace-1))].views[].pid")|tail +2|sed ':a; N; $!ba; s/\n/||/g') >&3
+		break
+	fi
+done <&4