Initial commit from harshadgavali/gnome-gesture-improvements#206 (com…

…ment) which bumps support for 46 on the transpiled version from @joaophi

common/appGestures.js

@@ -0,0 +1,344 @@
+/* exported getAppKeybindingGesturePrefsPage */
+import Gtk from 'gi://Gtk';
+import Gio from 'gi://Gio';
+import GLib from 'gi://GLib';
+import GObject from 'gi://GObject';
+import Adw from 'gi://Adw';
+import { ForwardBackKeyBinds } from './settings.js'
+import { registerClass } from './utils/gobject.js'
+import { printStack } from './utils/logging.js'
+
+/** return icon image for give app */
+function getAppIconImage(app) {
+	var _a, _b;
+	const iconName = (_b = (_a = app.get_icon()) === null || _a === void 0 ? void 0 : _a.to_string()) !== null && _b !== void 0 ? _b : 'icon-missing';
+	return new Gtk.Image({
+		gicon: Gio.icon_new_for_string(iconName),
+		iconSize: Gtk.IconSize.LARGE,
+	});
+}
+
+/** Returns marked escaped text or empty string if text is nullable */
+function markup_escape_text(text) {
+	var _a;
+	text = text !== null && text !== void 0 ? text : '';
+	try {
+		return GLib.markup_escape_text(text, -1);
+		// eslint-disable-next-line @typescript-eslint/no-explicit-any
+	}
+	catch (e) {
+		// TODO: see what exactly is error and fix it
+		// probably errors in different language or app name
+		printStack(`Error: '${(_a = e === null || e === void 0 ? void 0 : e.message) !== null && _a !== void 0 ? _a : e}' while escaping app name for app(${text}))`);
+		return text;
+	}
+}
+
+/** Dialog window used for selecting application from given list of apps
+ *  Emits `app-selected` signal with application id
+ */
+const AppChooserDialog = registerClass({
+	Properties: {},
+	Signals: { 'app-selected': { param_types: [GObject.TYPE_STRING] } },
+}, class GIE_AppChooserDialog extends Adw.PreferencesWindow {
+	/**
+     * @param apps list of apps to display in dialog
+     * @param parent parent window, dialog will be transient for parent
+     */
+	_init(apps, parent) {
+		super._init({
+			modal: true,
+			transientFor: parent,
+			destroyWithParent: false,
+			title: 'Select application',
+		});
+
+		this.set_default_size(0.7 * parent.defaultWidth, 0.7 * parent.defaultHeight);
+		this._group = new Adw.PreferencesGroup();
+		const page = new Adw.PreferencesPage();
+		page.add(this._group);
+		this.add(page);
+		apps.forEach(app => this._addAppRow(app));
+	}
+
+	/** for given app add row to selectable list */
+	_addAppRow(app) {
+		const row = new Adw.ActionRow({
+			title: markup_escape_text(app.get_display_name()),
+			subtitle: markup_escape_text(app.get_description()),
+			activatable: true,
+		});
+
+		row.add_prefix(getAppIconImage(app));
+		this._group.add(row);
+		row.connect('activated', () => {
+			this.emit('app-selected', app.get_id());
+			this.close();
+		});
+	}
+});
+
+/**
+ * Class to create row for application in list to display gesture settings of app
+ * Emits 'value-updated' when any of settings changes
+ * Emits 'remove-request' when remove button is clicked
+ */
+const AppGestureSettingsRow = registerClass({
+	Properties: {},
+	Signals: {
+		'value-updated': { param_types: [GObject.TYPE_UINT, GObject.TYPE_BOOLEAN] },
+		'remove-request': {},
+	},
+}, class GIE_AppGestureSettingsRow extends Adw.ExpanderRow {
+	/**
+     * @param appGestureSettings value of current settings for app
+     * @param model list of choices of keybings for setting
+     */
+	_init(app, appGestureSettings, model) {
+		super._init({ title: markup_escape_text(app.get_display_name()) });
+		this.add_prefix(getAppIconImage(app));
+		const [keyBind, reverse] = appGestureSettings;
+
+		// keybinding combo row
+		this._keyBindCombo = new Adw.ComboRow({
+			title: 'Keybinding',
+			subtitle: 'Keyboard shortcut to emit after gesture is completed',
+			model,
+		});
+
+		this._keyBindCombo.set_selected(keyBind);
+		this.add_row(this._keyBindCombo);
+
+		// reverse switch row
+		this._reverseButton = new Gtk.Switch({
+			active: reverse,
+			valign: Gtk.Align.CENTER,
+		});
+
+		let actionRow = new Adw.ActionRow({ title: 'Reverse gesture direction' });
+		actionRow.add_suffix(this._reverseButton);
+		this.add_row(actionRow);
+
+		// remove setting row
+		const removeButton = new Gtk.Button({
+			label: 'Remove...',
+			valign: Gtk.Align.CENTER,
+			halign: Gtk.Align.END,
+			cssClasses: ['raised'],
+		});
+
+		actionRow = new Adw.ActionRow();
+		actionRow.add_suffix(removeButton);
+		this.add_row(actionRow);
+
+		// remove request signal emitted when remove button is clicked
+		removeButton.connect('clicked', () => this.emit('remove-request'));
+		this._keyBindCombo.connect('notify::selected', this._onValueUpdated.bind(this));
+		this._reverseButton.connect('notify::active', this._onValueUpdated.bind(this));
+	}
+
+	/** function called internally whenever some setting is changed, emits external signal */
+	_onValueUpdated() {
+		this.emit('value-updated', this._keyBindCombo.selected, this._reverseButton.active);
+	}
+});
+
+/**
+ * Class to display list of applications and their gesture settings
+ */
+const AppKeybindingGesturePrefsGroup = registerClass(class GIE_AppKeybindingGesturePrefsGroup extends Adw.PreferencesGroup {
+	/**
+     * @param prefsWindow parent preferences window
+     * @param settings extension settings object
+     */
+	_init(prefsWindow, settings) {
+		super._init({
+			title: 'Enable application specific gestures',
+			description: 'Hold and then swipe to activate the gesture',
+		});
+
+		this._prefsWindow = prefsWindow;
+		this._settings = settings;
+		this._appRows = new Map();
+		this._cachedSettings = this._settings.get_value('forward-back-application-keyboard-shortcuts').deepUnpack();
+		this._appGestureModel = this._getAppGestureModelForComboBox();
+
+		// build ui widgets
+		this.add(new Adw.PreferencesRow({
+			child: new Gtk.Label({
+				label: 'Applications not listed here will have default settings',
+				halign: Gtk.Align.CENTER,
+				hexpand: true,
+			}),
+			cssClasses: ['custom-information-label-row', 'custom-smaller-card'],
+		}));
+
+		this._addAppButtonRow = this._buildAddAppButtonRow();
+		this.add(this._addAppButtonRow);
+		Object.keys(this._cachedSettings).sort().reverse().forEach(appId => this._addAppGestureRow(appId));
+
+		// bind switch to setting value
+		const toggleSwitch = new Gtk.Switch({ valign: Gtk.Align.CENTER });
+		this._settings.bind('enable-forward-back-gesture', toggleSwitch, 'active', Gio.SettingsBindFlags.DEFAULT);
+		this.set_header_suffix(toggleSwitch);
+	}
+
+	/**
+     * Handler function, called when add button is clicked
+     * Displays dialog to select application to add
+     */
+	_onAddAppButtonClicked() {
+		// find list of new apps that can be selected
+		const allApps = Gio.app_info_get_all();
+		const selectableApps = allApps
+			.filter(app => {
+				const appId = app.get_id();
+				return app.should_show() && appId && !this._appRows.has(appId);
+			})
+		// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+			.sort((a, b) => a.get_id().localeCompare(b.get_id()));
+
+		const appChooserDialog = new AppChooserDialog(selectableApps, this._prefsWindow);
+		appChooserDialog.connect('app-selected', (_source, appId) => this._addAppGestureRow(appId));
+		appChooserDialog.present();
+	}
+
+	/**
+     * @returns row for add app button
+     */
+	_buildAddAppButtonRow() {
+		const addButton = new Gtk.Button({
+			iconName: 'list-add-symbolic',
+			cssName: 'card',
+			cssClasses: ['custom-smaller-card'],
+		});
+
+		const addButtonRow = new Adw.PreferencesRow({ child: addButton });
+		addButton.connect('clicked', this._onAddAppButtonClicked.bind(this));
+		return addButtonRow;
+	}
+
+	/**
+     * Adds application specific gesture settings row for given app id
+     * Does nothing if app doesn't exist
+     */
+	_addAppGestureRow(appId) {
+		const app = Gio.DesktopAppInfo.new(appId);
+		if (!app)
+			return;
+		const appRow = new AppGestureSettingsRow(
+			app, 
+			this._getAppGestureSetting(appId), // this function updates extension settings
+			this._appGestureModel
+		);
+
+		this._appRows.set(appId, appRow);
+		this.add(appRow);
+
+		// callbacks for setting updates and remove request
+		appRow.connect('remove-request', () => this._requestRemoveAppGestureRow(appId));
+		appRow.connect('value-updated', (_source, keyBind, reverse) => {
+			this._setAppGestureSetting(appId, [keyBind, reverse]);
+		});
+
+		// re-add add-appbutton at the end
+		this.remove(this._addAppButtonRow);
+		this.add(this._addAppButtonRow);
+	}
+
+	/**
+     * Removes application specific gesture settings row for given app
+     * Does nothing if row for app was not added
+     * Updates extension settings
+     */
+	_removeAppGestureRow(appId) {
+		const appRow = this._appRows.get(appId);
+		if (!appRow)
+			return;
+		this.remove(appRow);
+		this._appRows.delete(appId);
+		delete this._cachedSettings[appId];
+		this._updateExtensionSettings();
+	}
+
+	/**
+     * Signal handler called when removal of app gesture settings is requested
+     * Displays confirmation dialog and removes app row if confirmed
+     */
+	_requestRemoveAppGestureRow(appId) {
+		const app = Gio.DesktopAppInfo.new(appId);
+		const dialog = new Gtk.MessageDialog({
+			transient_for: this._prefsWindow,
+			modal: true,
+			text: `Remove gesture setting for ${app.get_display_name()}?`,
+		});
+
+		dialog.add_button('Cancel', Gtk.ResponseType.CANCEL);
+		dialog
+			.add_button('Remove', Gtk.ResponseType.ACCEPT)
+			.get_style_context()
+			.add_class('destructive-action');
+
+		dialog.connect('response', (_dlg, response) => {
+			if (response === Gtk.ResponseType.ACCEPT) {
+				this._removeAppGestureRow(appId);
+			}
+
+			dialog.destroy();
+		});
+
+		dialog.present();
+	}
+
+	/**
+     * Returns application specific gesture setting
+     * if setting is not set, returns default value and saves extension settings
+    */
+	_getAppGestureSetting(appId) {
+		let val = this._cachedSettings[appId];
+		if (!val) {
+			// this is case when new app was selected for gesture
+			val = [ForwardBackKeyBinds.Default, false];
+			this._setAppGestureSetting(appId, val);
+		}
+
+		return val;
+	}
+
+	/** Saves application specific gesture setting into extension settings */
+	_setAppGestureSetting(appId, appGestureSettings) {
+		this._cachedSettings[appId] = appGestureSettings;
+		this._updateExtensionSettings();
+	}
+
+	/** Updates extension settings */
+	_updateExtensionSettings() {
+		const glibVariant = new GLib.Variant('a{s(ib)}', this._cachedSettings);
+		this._settings.set_value('forward-back-application-keyboard-shortcuts', glibVariant);
+	}
+
+	/** Returns model which contains all possible choices for keybinding setting for app-gesture */
+	_getAppGestureModelForComboBox() {
+		const appGestureModel = new Gtk.StringList();
+		Object.values(ForwardBackKeyBinds).forEach(val => {
+			if (typeof val !== 'number')
+				return;
+			appGestureModel.append(ForwardBackKeyBinds[val]);
+		});
+
+		return appGestureModel;
+	}
+});
+
+/**
+ * @returns preference page for application gestures
+ */
+export function getAppKeybindingGesturePrefsPage(prefsWindow, settings) {
+	const page = new Adw.PreferencesPage({
+		title: 'App Gestures',
+		iconName: 'org.gnome.Settings-applications-symbolic',
+	});
+
+	page.add(new AppKeybindingGesturePrefsGroup(prefsWindow, settings));
+	return page;
+}