├── .gitignore
├── schemas
├── gschemas.compiled
└── org.gnome.shell.extensions.run-on-raise.gschema.xml
├── lib
├── dbus.js
├── static.js
├── mode.js
├── accelerator.js
└── action.js
├── metadata.json
├── Makefile
├── CHANGELOG.md
├── shortcuts.default
├── prefs.js
├── convenience.js
├── extension.js
├── README.md
└── LICENSE
/.gitignore:
--------------------------------------------------------------------------------
1 | build
2 |
--------------------------------------------------------------------------------
/schemas/gschemas.compiled:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/CZ-NIC/run-or-raise/HEAD/schemas/gschemas.compiled
--------------------------------------------------------------------------------
/lib/dbus.js:
--------------------------------------------------------------------------------
1 | export const DBUS = `
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 | `;
--------------------------------------------------------------------------------
/metadata.json:
--------------------------------------------------------------------------------
1 | {
2 | "description": "Launch or focus the window or define custom shortcuts in a text file",
3 | "disable-extension-version-validation": true,
4 | "name": "Run or raise",
5 | "settings-schema": "org.gnome.shell.extensions.run-or-raise",
6 | "shell-version": ["45", "46", "47", "48", "49"],
7 | "url": "https://github.com/CZ-NIC/run-or-raise",
8 | "uuid": "run-or-raise@edvard.cz"
9 | }
10 |
--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
1 | # run simply with `make` to prepare a release
2 | UUID=run-or-raise@edvard.cz
3 |
4 | release:
5 | make compile
6 | make build
7 | xdg-open https://extensions.gnome.org/upload/
8 |
9 | compile:
10 | glib-compile-schemas schemas
11 |
12 | build:
13 | mkdir -p build
14 |
15 | # remove old build file so that we will not left deleted files from the last build
16 | zip -r - * -x Makefile "build/*" > "build/$(UUID)".zip
17 |
18 | .PHONY: release compile build
19 |
--------------------------------------------------------------------------------
/lib/static.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Helper class (simulating Python collections.defaultdict)
3 | */
4 | export class DefaultMap extends Map {
5 | get(key) {
6 | if (!this.has(key)) {
7 | super.set(key, this.default(key))
8 | }
9 | return super.get(key);
10 | }
11 |
12 | constructor(defaultFunction, entries) {
13 | super(entries);
14 | this.default = defaultFunction;
15 | }
16 | }
17 |
18 | export const arraysEqual = function(arr1, arr2) {
19 | if (arr1.length != arr2.length) {
20 | return false
21 | }
22 | for (let i = arr1.length; i--;) {
23 | if (arr1[i] !== arr2[i])
24 | return false
25 | }
26 | return true
27 | }
28 |
--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # CHANGELOG
2 |
3 | ## 34 (2024-01-04)
4 | - fix: layered regex shortcut
5 | - center-mouse-to-focused-window: Don't move pointer if it's already in the window area
6 | - Gio instead of misc/util spawnCommandLine #70 (syslog cleaned up)
7 |
8 | ## 32 (2023-11-03)
9 | - raise-or-register with index #61
10 |
11 | ## 31 (2023-05-16)
12 | - Gnome 44 X11 support (removing Gdk)
13 |
14 | ## 29 (2023-02-20)
15 | - wm_class compared not only to `window.wm_class()` but to the `window.wm_class_instance()` too (which is great news)
16 | - verbose mode
17 |
18 | ## 28 (2023-02-15)
19 | - layered shortcuts #53
20 | - amazing debugging tip
21 |
22 | ## 24 (2022-10-06)
23 | - center mouse fix #45
24 |
25 | ## 13 (2022-02-08)
26 | - added shell version 41 support
27 | - added support for starting applications from .desktop files
28 |
29 | ## 12 (2021-04-30, Gnome 40)
30 | - added shell version 40 support #33 #34
31 |
32 | ## 10 (2021-03-22, Gnome 3.38.2)
33 | - better backwards compatibility for both X11 and Wayland
34 | - `Scroll_Lock` state checking possible deprecation warning
35 |
36 | ## 9 (2021-03-17, Gnome 3.38.2)
37 | - modes
38 | - argument allows quoting
39 | - dropped old non-ES6 support (Debian 9)
40 | - ability to raise a dynamically registered window
41 | - keyboard-lock symbols
42 | - backwards compatibility with (at least) 3.36
43 |
44 | ## 3.38 (2020-12-02)
45 | - isolate workspace option
46 |
47 | ## 3.32 (2019-12-12)
48 | - grab accelerator parameter change
49 | - custom config dir to prevent Gnome wipe the shortcuts.conf on upgrade #19
50 |
51 | ## 3.26 (2019-04-30)
52 | Everything working as expected.
53 |
--------------------------------------------------------------------------------
/lib/mode.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Allow user to cast a specific instruction
3 | */
4 | export class Mode {
5 |
6 | /* Modes. The value should be the same as the one in gschema.xml as we can compare globals and shorcuts.conf keywords at once */
7 | /** both runs the command and raises a window */
8 | static ALWAYS_RUN = "always-run"
9 | /** just runs the command without cycling windows */
10 | static RUN_ONLY = "run-only"
11 | /** Switch windows on the active workspace only */
12 | static ISOLATE_WORKSPACE = "isolate-workspace"
13 | static MINIMIZE_WHEN_UNFOCUSED = "minimize-when-unfocused"
14 | static SWITCH_BACK_WHEN_FOCUSED = "switch-back-when-focused"
15 | static MOVE_WINDOW_TO_ACTIVE_WORKSPACE = "move-window-to-active-workspace"
16 | static CENTER_MOUSE_TO_FOCUSED_WINDOW = "center-mouse-to-focused-window"
17 | /** register current window to be re-raised by Mode.RAISE */
18 | static REGISTER = "register"
19 | /** raise the windows previously registered by Mode.REGISTER */
20 | static RAISE = "raise"
21 | /** if nothing registered yet, register current */
22 | static RAISE_OR_REGISTER = "raise-or-register"
23 | static VERBOSE = "verbose"
24 |
25 | /**
26 | * @param values Ex: [["cmd", true], ["launch": 2]]
27 | */
28 | constructor(values, settings) {
29 | this.values = []
30 | values.forEach(key_val => this.add(key_val[0], key_val[1]))
31 | this.settings = settings
32 | }
33 |
34 | /**
35 | * @param key
36 | * @return Current key value if contained in the current object or true if such key is on in the global settings
37 | */
38 | get(key) {
39 | try {
40 | return this.values[key] || this.settings.get_boolean(key)
41 | } catch (e) { // key does not exist in the global settings
42 | return false
43 | }
44 | }
45 |
46 | /**
47 | * Adds new keyword
48 | * @param key
49 | * @param val
50 | */
51 | add(key, val) {
52 | if (!Object.values(Mode).includes(key)) {
53 | throw new Error(`Unknown mode: ${key}`)
54 | }
55 | this.values[key] = val
56 | }
57 | }
--------------------------------------------------------------------------------
/schemas/org.gnome.shell.extensions.run-on-raise.gschema.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | false
6 | Listen on DBus
7 | Invoke the functionality through the DBus (restart the extension to take effect).
8 | Ex: `gdbus call --session --dest org.gnome.Shell
9 | --object-path /org/gnome/Shell/Extensions/RunOrRaise
10 | --method org.gnome.Shell.Extensions.RunOrRaise.Call ",firefox,,"`
11 |
12 |
13 | false
14 | Switch back to previous window when focused
15 |
16 |
17 |
18 | false
19 | Minimize when unfocusing
20 | Minimizes your target window when unfocusing.
21 |
22 |
23 | false
24 | After focus move mouse to window center
25 |
26 |
27 |
28 | false
29 | Move window to current workspace before focusing
30 | If the window is on a different workspace, moves the window to the workspace you're currently viewing.
31 |
32 |
33 | false
34 | Switch windows on the active workspace only
35 |
36 |
37 |
38 | false
39 | Verbose
40 | Provide debug information. (Highlight layered shortcuts by a yellow rectangle etc.)
41 |
42 |
43 |
44 |
--------------------------------------------------------------------------------
/shortcuts.default:
--------------------------------------------------------------------------------
1 | # Here you list all the shortcuts. To reload, turn the extension off and on.
2 | #
3 | # The shortcuts may be defined in two ways:
4 | #
5 | # 1. Run-or-raise form: shortcut,command,[wm_class],[title]
6 | # * `wm_class` and `title` are optional and case sensitive
7 | # * if none is set, lowercased launch `command` is compared with lowercased windows wm_classes and titles
8 | #
9 | # 2. Run only form: shortcut,command
10 | #
11 | #
12 | # In fact, the full form is `shortcut[ char][:mode],command,[wm_class],[title]`
13 | # while `char` allows you to use layered shortcuts and `mode` to further specify circumstances.
14 | #
15 | # =================
16 | # Run or raise form
17 | # =================
18 | #
19 | #
20 | # This line cycles any firefox window (matched by "firefox" in the window title) OR if not found, launches new firefox instance.
21 | f,firefox,,
22 | # This line cycles any open gnome-terminal (matched by wm_class = Gnome-terminal on Ubuntu 17.10) OR if not found, launches new one.
23 | # If you're using Arch, you may want to match by wm_class = gnome-terminal-server , just check yourself by Alt+F2/lg/Windows
24 | r,gnome-terminal,Gnome-terminal,
25 |
26 |
27 | # You may use regular expression in title or wm_class.
28 | # Just put the regular expression between slashes.
29 | # E.g. to jump to pidgin conversation window you may use this line
30 | # (that means any windows of wm_class Pidgin, not containing the title Buddy List)"
31 | KP_1,pidgin,Pidgin,/^((?!Buddy List).)*$/
32 |
33 |
34 | # Have the mail always at numpad-click.
35 | KP_2,chromium-browser --app=https://mail.google.com/mail/u/0/#inbox,mail.google.com,
36 |
37 |
38 | # =============
39 | # Run only form
40 | # =============
41 | #
42 | # This line will launch the `notify-send` command.
43 | y,notify-send Hello world
44 |
45 | # This layered shortcut will output the text only when you write `hello` after hitting e.
46 | e h e l l o,notify-send Layered hello
47 |
48 | # This layered shortcut will not interfere with the shorcut above that is launching a terminal.
49 | e r,notify-send Layered 'Terminal was not launched.'
50 |
51 | # Blank lines are allowed. Line starting with "#" means a comment.
52 | # Now delete these shortcuts and put here yours.
53 | # How to know wm_class? Using xprop or the looking glass tool, see README.md
54 |
--------------------------------------------------------------------------------
/prefs.js:
--------------------------------------------------------------------------------
1 | import Gtk from 'gi://Gtk?version=4.0';
2 | import GLib from 'gi://GLib';
3 | import * as Convenience from './convenience.js';
4 | import {ExtensionPreferences} from 'resource:///org/gnome/Shell/Extensions/js/extensions/prefs.js';
5 | import Gio from 'gi://Gio';
6 | import Adw from 'gi://Adw';
7 |
8 |
9 | export default class RunOrRaisePreferences extends ExtensionPreferences {
10 |
11 | fillPreferencesWindow(window) {
12 | window._settings = this.getSettings();
13 |
14 | const page = new Adw.PreferencesPage();
15 |
16 | page.add(this.getShortcutConfig());
17 | page.add(this.getBehaviourConfig());
18 |
19 | window.add(page);
20 | }
21 |
22 | getShortcutConfig() {
23 | const group = new Adw.PreferencesGroup({
24 | title: "Shortcuts",
25 | });
26 |
27 | const row = new Adw.ActionRow({
28 | title: 'Open shortcuts.conf file',
29 | subtitle: 'Edit the file to add your shortcuts, then reload this extension (no logout required)',
30 | });
31 | let editorButton = new Gtk.Button({
32 | iconName: "document-open-symbolic",
33 | valign: Gtk.Align.CENTER,
34 | halign: Gtk.Align.CENTER
35 | });
36 | editorButton.connect("clicked", function() {
37 | GLib.spawn_command_line_sync("xdg-open .config/run-or-raise/shortcuts.conf");
38 | });
39 | row.add_suffix(editorButton);
40 | row.set_activatable_widget(editorButton);
41 |
42 | group.add(row);
43 |
44 | return group;
45 | }
46 |
47 | getBehaviourConfig() {
48 | const group = new Adw.PreferencesGroup({
49 | title: "Behaviour",
50 | description: "Configure various behaviours of run or raise"
51 | });
52 | let convData = Convenience.getSchemaData(this.getSettings());
53 |
54 | convData.basicSchema.forEach(function(data) {
55 | group.add(booleanBox(data, convData.settings));
56 | });
57 |
58 | return group;
59 | }
60 | }
61 |
62 | function booleanBox(data, settings) {
63 | const row = new Adw.SwitchRow({
64 | title: data.summary,
65 | subtitle: data.description ? data.description : "",
66 | });
67 | settings.bind(data.name, row, 'active', Gio.SettingsBindFlags.DEFAULT);
68 | return row
69 | }
--------------------------------------------------------------------------------
/convenience.js:
--------------------------------------------------------------------------------
1 | /* -*- mode: js; js-basic-offset: 4; indent-tabs-mode: nil -*- */
2 | /*
3 | Copyright (c) 2011-2012, Giovanni Campagna
4 |
5 | Redistribution and use in source and binary forms, with or without
6 | modification, are permitted provided that the following conditions are met:
7 | * Redistributions of source code must retain the above copyright
8 | notice, this list of conditions and the following disclaimer.
9 | * Redistributions in binary form must reproduce the above copyright
10 | notice, this list of conditions and the following disclaimer in the
11 | documentation and/or other materials provided with the distribution.
12 | * Neither the name of the GNOME nor the
13 | names of its contributors may be used to endorse or promote products
14 | derived from this software without specific prior written permission.
15 |
16 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
17 | ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 | WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
20 | DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 | (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 | LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 | ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 | */
27 | import GLib from 'gi://GLib';
28 |
29 | export function getSchemaData(Settings) {
30 | const schemaObj = Settings["settings_schema"]
31 | const basicTypes = ["b", "y", "n", "q", "i", "u", "x", "t", "h", "d", "s", "o", "g", "?"].map(function(type){return {type: type, vt : new GLib.VariantType(type)}});
32 | const allKeys = schemaObj.list_keys().map(function(keyName) {
33 | const key = schemaObj.get_key(keyName);
34 | const keyType = key.get_value_type();
35 | const keyTypeFound = basicTypes.find(bt=>keyType.equal(bt.vt));
36 | if (!keyTypeFound) {return null;}
37 | const summary = key.get_summary();
38 | const description = key.get_description();
39 | const defaultValue = key.get_default_value().unpack();
40 | const value = Settings.get_value(keyName).unpack();
41 | return {name: keyName, summary: summary, description: description, defaultValue: defaultValue, value: value, type: keyTypeFound.type }
42 |
43 | }).filter(a=>Boolean(a));
44 | return {basicSchema: allKeys, settings: Settings};
45 | }
46 |
47 |
48 |
49 |
50 |
--------------------------------------------------------------------------------
/lib/accelerator.js:
--------------------------------------------------------------------------------
1 | import * as Main from 'resource:///org/gnome/shell/ui/main.js'
2 | import Meta from 'gi://Meta'
3 | import Shell from 'gi://Shell'
4 | import { arraysEqual } from './static.js'
5 |
6 | /**
7 | * @typedef {Action[]} Accelerator Actions in the array have the same shortcut accelerator.
8 | * XX do not know how to document the values of a class extending array properly
9 | */
10 | export class Accelerator extends Array {
11 |
12 | /**
13 | *
14 | * @param {String} shortcut
15 | * @param {App} app
16 | */
17 | constructor(shortcut, app) {
18 | super()
19 | /**
20 | * ID of the grabber accelerator action.
21 | * We may use this ID to ungrab the accelerator.
22 | * All actions in this Accelerator have it in common
23 | * @type {?number}
24 | */
25 | this.action_id = null
26 | this.name = null
27 | this.shortcut = shortcut
28 |
29 | this.app = app
30 |
31 | this.blocked = false
32 | this.connect_on_unblock = null
33 | this.is_layered = false
34 | }
35 |
36 | on_state_changed(last_state) {
37 | const state = this.app.get_state()
38 | let conforms = this.some(action => action.state_conforms(state))
39 |
40 | if (this.action_id !== null && !conforms) { // the shortcut must no more be consumed
41 | this.disconnect()
42 | } else if (this.action_id === null && conforms) { // enable new state shortcuts
43 | this.connect()
44 | } else if (this.action_id !== null && conforms
45 | && !arraysEqual(this.filter_actions(), this.filter_actions(last_state))) {
46 | // re-do the set of the actions performed on accelerator trigger
47 | // ex: Num_Lock state change while having both `i` and `i` defined
48 | this.disconnect()
49 | this.connect()
50 | }
51 | }
52 |
53 | /**
54 | *
55 | * @param {?State} state
56 | * @returns {Action[]}
57 | */
58 | filter_actions(state = null) {
59 | return this.filter(action => action.state_conforms(state || this.app.get_state()))
60 | }
61 |
62 | /**
63 | * Grab the accelerator, start listening.
64 | * @param state Only actions conforming the system keyboard-lock state will be registered
65 | */
66 | connect() {
67 | if (this.blocked) {
68 | return false
69 | }
70 | const state = this.app.get_state()
71 | let action_id = global.display.grab_accelerator(this.shortcut, 0)
72 | if (action_id === Meta.KeyBindingAction.NONE) {
73 | this.app.display(`Unable to grab accelerator: ${this.shortcut}`)
74 | return false;
75 | }
76 | // Grabbed accelerator action, receive its binding name
77 | this.action_id = action_id;
78 | this.name = Meta.external_binding_name_for_action(action_id)
79 |
80 | // Requesting WM to allow binding name
81 | Main.wm.allowKeybinding(this.name, Shell.ActionMode.ALL)
82 | this.app.accelerator_map.set(action_id, this)
83 | }
84 |
85 | /**
86 | * Run the accelerator and all of its actions
87 | * @returns Action[] These actions were not run because they are layered = dependent on following key hits.
88 | */
89 | trigger() {
90 | return this.filter_actions().filter(action => {
91 | try {
92 | if (action.layers.length) {
93 | return action
94 | }
95 | action.trigger()
96 | } catch (e) {
97 | this.app.display(e, this.shortcut)
98 | }
99 | })
100 | }
101 |
102 | disconnect() {
103 | if (this.action_id === null) {
104 | return;
105 | }
106 | try {
107 | global.display.ungrab_accelerator(this.action_id);
108 | Main.wm.allowKeybinding(this.name, Shell.ActionMode.NONE);
109 | this.app.accelerator_map.delete(this.action_id)
110 | this.action_id = null;
111 | } catch (e) {
112 | this.app.display(`Error removing keybinding ${this.name}: ${e}`);
113 | }
114 | }
115 |
116 | /**
117 | * Blocked accelerator cannot be connected.
118 | * Use case: when using a layered shorcut having the same key combination,
119 | * we temporarily disable the original one. However, when a NumLock changes
120 | * (not because of a keyboard which would be registered and ended up layered session
121 | * but because of an external cause),
122 | * we do not want the original accelerator to connect
123 | * (which would fail, cannot grab twice the same combination).
124 | */
125 | block() {
126 | if (!this.blocked) {
127 | this.blocked = true
128 | if ((this.connect_on_unblock = Boolean(this.action_id))) {
129 | this.disconnect()
130 | }
131 | }
132 | return this
133 | }
134 |
135 | unblock() {
136 | if (this.blocked) {
137 | this.blocked = false
138 | if (this.connect_on_unblock) {
139 | this.connect()
140 | }
141 | }
142 | return this
143 | }
144 |
145 | /**
146 | * Pushes the action and at once, mark itself as a layred accelerator.
147 | * @param {Action} action
148 | */
149 | push_layered(action) {
150 | this.push(action)
151 | this.is_layered = true
152 | }
153 | }
154 |
155 |
--------------------------------------------------------------------------------
/lib/action.js:
--------------------------------------------------------------------------------
1 | import Shell from 'gi://Shell'
2 | import { Mode } from './mode.js'
3 | import Gio from 'gi://Gio'
4 | import GLib from 'gi://GLib'
5 | import Mtk from 'gi://Mtk'
6 |
7 | export class Action {
8 |
9 | /**
10 | * Single shortcut binding representation
11 | * @param {Controller} app
12 | * @param {String} command
13 | * @param {?String|RegExp} wm_class // may be undefined when user does not set enough parameters
14 | * @param {?String|RegExp} title // may be undefined when user does not set enough parameters
15 | * @param {Mode} mode
16 | * @param {String} shortcut_bare
17 | * @param {String[]} layers
18 | */
19 | constructor(app, shortcut_bare, layers, mode, command = "", wm_class = "", title = "") {
20 | this.app = app
21 | this.command = command
22 | this.wm_class = wm_class
23 | this.title = title
24 | this.mode = mode
25 | this.wmFn = null
26 | this.titleFn = null; // ; needed
27 | [this.wm_class, this.wmFn] = this._allow_regex(this.wm_class); // ; needed
28 | [this.title, this.titleFn] = this._allow_regex(this.title)
29 | /**
30 | * @type {String[]} `g a b,command` → ["a", "b"]
31 | */
32 | this.layers = layers || []
33 |
34 | /**
35 | * Is the actions depend on the keyboard-lock state
36 | * @type {?boolean}
37 | */
38 | this.num_lock = this.caps_lock = this.scroll_lock = null
39 |
40 | /**
41 | * @type {String}
42 | */
43 | this.shortcut = this._set_shortcut(shortcut_bare)
44 | }
45 |
46 | get_layered_action() {
47 | const shortcut = this.layers[0]
48 | const new_layers = this.layers.slice(1, this.layers.length)
49 | return new Action(this.app, shortcut, new_layers, this.mode, this.command, this.wm_class, this.title)
50 | }
51 |
52 | /**
53 | * Return appropriate method for s, depending if s is a regex (search) or a string (indexOf)
54 | * @param {RegExp|string} s
55 | * @return {[RegExp|string, string]} Tuple
56 | * @private
57 | */
58 | _allow_regex(s) {
59 | if (s instanceof RegExp) {
60 | return [s, "search"]
61 | } else if (s.startsWith("/") && s.endsWith("/")) {
62 | // s is surround with slashes, ex: `/my-program/`, we want to do a regular match when searching
63 | return [new RegExp(s.substring(1, s.length - 1)), "search"]
64 | } else { // s is a classic string (even empty), we just do indexOf match
65 | return [s, "indexOf"]
66 | }
67 | }
68 |
69 | debug() {
70 | if (!this.mode.get(Mode.VERBOSE)) {
71 | return
72 | }
73 | let s = ""
74 | for (let a of arguments) {
75 | s += " " + a
76 | }
77 | this.app.display(s)
78 | }
79 |
80 |
81 | /**
82 | * @return {*} Current windows
83 | */
84 | get_windows() {
85 | // Switch windows on active workspace only
86 | const workspace_manager = global.display.get_workspace_manager()
87 | const active_workspace = this.mode.get(Mode.ISOLATE_WORKSPACE) ? workspace_manager.get_active_workspace() : null
88 |
89 | // fetch windows
90 | return global.display.get_tab_list(0, active_workspace)
91 | }
92 |
93 |
94 | is_conforming(window) {
95 | const [command, wmNeedle, wmFn, title, titleFn] = [this.command, this.wm_class, this.wmFn, this.title, this.titleFn]
96 |
97 | const window_name = window.get_wm_class() || ''
98 | const window_instance = window.get_wm_class_instance() || ''
99 | const window_title = window.get_title() || ''
100 |
101 | // check if the current window is conforming to the search criteria
102 | if (wmNeedle) { // seek by (wm_class_name or wm_class_instance) AND if set, title must match
103 | if (
104 | (window_instance[wmFn](wmNeedle) > -1 ||
105 | window_name[wmFn](wmNeedle) > -1)
106 | && (!title || window_title[titleFn](title) > -1)) {
107 | return true
108 | }
109 | } else if ((title && window_title[titleFn](title) > -1) || // seek by title
110 | (!title && ((window_name.toLowerCase().indexOf(command.toLowerCase()) > -1) || // seek by launch-command in wm_class_name only (I do not see a use-case where command might match wm_class_instance)
111 | (window_title.toLowerCase().indexOf(command.toLowerCase()) > -1))) // seek by launch-command in title
112 | ) {
113 | return true
114 | }
115 | return false
116 | }
117 |
118 | /**
119 | *
120 | * @param window
121 | * @param check if true, we focus only if the window is listed amongst current windows
122 | * @return {boolean}
123 | */
124 | focus_window(window, check = false) {
125 | if (check
126 | && (!window // gnome shell reloaded and window IDs changed (even if window might be still there)
127 | || !this.get_windows().filter(w => w.get_id() == window.get_id()).length // window closed
128 | )) {
129 | this.debug("Window not found")
130 | return false
131 | }
132 |
133 | if (this.mode.get(Mode.MOVE_WINDOW_TO_ACTIVE_WORKSPACE)) {
134 | const activeWorkspace = global.workspaceManager.get_active_workspace();
135 | window.change_workspace(activeWorkspace);
136 | }
137 | window.get_workspace().activate_with_focus(window, true)
138 | window.activate(0)
139 | if (this.mode.get(Mode.CENTER_MOUSE_TO_FOCUSED_WINDOW)) {
140 | const win_rect = window.get_frame_rect()
141 | const [x, y] = global.get_pointer()
142 | const pointer_rect = new Mtk.Rectangle({ x, y, width: 1, height: 1 })
143 | if (!pointer_rect.intersect(win_rect)[0]) {
144 | const { x, y, width, height } = win_rect
145 | this.app.seat.warp_pointer(x + width / 2, y + height / 2)
146 | }
147 | }
148 | this.debug("Window activated")
149 | return true
150 | }
151 |
152 | /**
153 | * Trigger the shortcut (system does it)
154 | * @return {boolean|*}
155 | */
156 | trigger() {
157 | let mode = this.mode
158 |
159 | // Debug info
160 | this.debug(`trigger title: ${this.title}, titleFn: ${this.titleFn}, wm_class: ${this.wm_class}, wmFn: ${this.wmFn}`);
161 |
162 | // Check raising keywords
163 | let i
164 | if ((i = mode.get(Mode.RAISE_OR_REGISTER))) {
165 | if (i === true) {
166 | // Shortcuts remembers the windows it is bind to, does not need global extension register
167 | // `:raise-or-register` used, not `:raise-or-register(int)`
168 | i = this
169 | }
170 | if (!this.app.register[i] || !this.focus_window(this.app.register[i], true)) {
171 | this.app.register[i] = this.get_windows()[0]
172 | }
173 | return
174 | }
175 | if ((i = mode.get(Mode.REGISTER))) {
176 | return this.app.register[i] = this.get_windows()[0] // will stay undefined if there is no such window
177 | }
178 | if ((i = mode.get(Mode.RAISE))) {
179 | return this.focus_window(this.app.register[i], true)
180 | }
181 |
182 | // Check if the shortcut should just run without raising a window
183 | if (mode.get(Mode.RUN_ONLY)) {
184 | return this.run()
185 | }
186 |
187 | /**
188 | * @type {window}
189 | */
190 | let seen = null;
191 | const windows = this.get_windows()
192 | // if window conforms, let's focus the oldest windows of the group
193 | // (otherwise we find the youngest conforming one)
194 | const ordered = (windows.length && this.is_conforming(windows[0])) ?
195 | windows.slice(0).reverse() : windows
196 | let window
197 | for (window of ordered) {
198 | if (this.is_conforming(window)) {
199 | seen = window;
200 | if (!seen.has_focus()) {
201 | break; // there might exist another window having the same parameters
202 | }
203 | }
204 | }
205 | if (seen) {
206 | if (!seen.has_focus()) {
207 | this.focus_window(seen);
208 | } else {
209 | if (mode.get(Mode.MINIMIZE_WHEN_UNFOCUSED)) {
210 | seen.minimize();
211 | }
212 | if (mode.get(Mode.SWITCH_BACK_WHEN_FOCUSED)) {
213 | const window_monitor = window.get_monitor();
214 | const window_list = windows.filter(w => w.get_monitor() === window_monitor && w !== window)
215 | const last_window = window_list[0];
216 | if (last_window) {
217 | this.focus_window(last_window);
218 | }
219 | }
220 | }
221 | }
222 | if (!seen || mode.get(Mode.ALWAYS_RUN)) {
223 | this.run();
224 | }
225 | }
226 |
227 | run() {
228 | if (this.mode.get(Mode.VERBOSE)) {
229 | this.debug("running:", this.command)
230 | }
231 | const app = Shell.AppSystem.get_default().lookup_app(this.command)
232 | if (app !== null) {
233 | return app.activate()
234 | }
235 | const [, argv] = GLib.shell_parse_argv(this.command)
236 | return Gio.Subprocess.new(argv, Gio.SubprocessFlags.NONE)
237 | }
238 |
239 | /**
240 | * Parse non-standard modifiers
241 | * @param shortcut
242 | * @return {*} Return the shortcut with the non-standard modifiers removed
243 | */
244 | _set_shortcut(shortcut) {
245 |
246 | const included = (sym) => {
247 | if (shortcut.includes(`<${sym}>`)) {
248 | shortcut = shortcut.replace(`<${sym}>`, "")
249 | return true
250 | }
251 | if (shortcut.includes(`<${sym}_OFF>`)) {
252 | shortcut = shortcut.replace(`<${sym}_OFF>`, "")
253 | return false
254 | }
255 | return null
256 | }
257 |
258 | this.num_lock = included("Num_Lock")
259 | this.caps_lock = included("Caps_Lock")
260 | this.scroll_lock = included("Scroll_Lock")
261 |
262 | return shortcut.trim()
263 | }
264 |
265 | /**
266 | *
267 | * @return {*[]} Array of true/false/null
268 | */
269 | get_state() {
270 | return [this.num_lock, this.caps_lock, this.scroll_lock]
271 | }
272 |
273 |
274 | /**
275 | * Is the shortcut valid in the current keyboard state?
276 | * @param {State} state_system Array of true/false
277 | * @return {boolean} True if all boolean values matches whereas null values in this.get_state() are ignored.
278 | */
279 | state_conforms(state_system) {
280 | const state_action = this.get_state()
281 | for (let i = 0; i < state_action.length; i++) {
282 | if (state_action[i] === null) {
283 | continue
284 | }
285 | if (state_action[i] !== state_system[i]) {
286 | return false
287 | }
288 | }
289 | return true
290 | }
291 |
292 | }
293 |
294 | export function parseLine(line, app) {
295 | // Optional argument quoting in the format: `shortcut[:mode][:mode],[command],[wm_class],[title]`
296 | // ', b, c, "d, e,\" " f", g, h' -> ["", "b", "c", "d, e,\" \" f", "g", "h"]
297 | const args = line.split(/,(?![^"]*"(?:(?:[^"]*"){2})*[^"]*$)/)
298 | .map(s => s.trim())
299 | .map(s => (s[0] === '"' && s.slice(-1) === '"') ? s.slice(1, -1).trim() : s) // remove quotes
300 | const [shortcut_layer_mode, command, wm_class, title] = args
301 |
302 | // Split shortcut[:mode][:mode] -> shortcut, mode
303 | const [shortcut_layer, ...modes] = shortcut_layer_mode.split(":")
304 | const [shortcut_bare, ...layers] = shortcut_layer.split(" ")
305 | // Store to "shortcut:cmd:launch(2)" → new Mode([["cmd", true], ["launch": 2]])
306 | const mode = new Mode(modes
307 | .map(m => m.match(/(?[^(]*)(\((?.*?)\))?/)) // "launch" -> key=launch, arg=undefined
308 | .filter(m => m) // "launch" must be a valid mode string
309 | .map(m => [m.groups.key, m.groups.arg || true]) // ["launch", true]
310 | , app.settings
311 | )
312 | if (args.length <= 2) { // Run only mode, we never try to raise a window
313 | mode.add(Mode.RUN_ONLY, true)
314 | }
315 | return new Action(app, shortcut_bare, layers, mode, command, wm_class, title)
316 | }
317 |
--------------------------------------------------------------------------------
/extension.js:
--------------------------------------------------------------------------------
1 | import * as Main from 'resource:///org/gnome/shell/ui/main.js'
2 | import Shell from 'gi://Shell'
3 | import St from 'gi://St'
4 | import Gio from 'gi://Gio'
5 | import Clutter from 'gi://Clutter'
6 | import { Extension } from 'resource:///org/gnome/shell/extensions/extension.js'
7 |
8 | // Local imports
9 | import { parseLine, Action } from './lib/action.js'
10 | import { Accelerator } from './lib/accelerator.js'
11 | import { arraysEqual, DefaultMap } from './lib/static.js'
12 | import { DBUS } from './lib/dbus.js'
13 |
14 | // Typedef
15 | /**
16 | * @typedef {boolean[]} State Array of true/false
17 | */
18 | let conf_path, default_conf_path
19 |
20 |
21 | /**
22 | * All known modifiers needed to allow layered shortcut to bear another modifiered shortcuts
23 | * without being cancelled.
24 | */
25 | const MODIFIERS = [Clutter.KEY_Alt_L, Clutter.KEY_Alt_R,
26 | Clutter.KEY_Control_L, Clutter.KEY_Control_R,
27 | Clutter.KEY_Super_L, Clutter.KEY_Super_R,
28 | Clutter.KEY_Hyper_L, Clutter.KEY_Hyper_R,
29 | Clutter.KEY_Shift_L, Clutter.KEY_Shift_R,
30 | Clutter.KEY_Meta_L, Clutter.KEY_Meta_R,
31 | ]
32 |
33 | /**
34 | * Main controller to de/register shortcuts
35 | */
36 | class App {
37 |
38 | display(text, title = "") {
39 | Main.notify("Run-or-raise " + title, String(text))
40 | }
41 |
42 | error(text, title = "") {
43 | this.display(text, title || "Error")
44 | throw new Error("Run-or-raise> " + text)
45 | }
46 |
47 | constructor(settings, seat, keymap) {
48 | this.settings = settings
49 | this.verbose = this.settings.get_boolean("verbose")
50 | this.seat = seat
51 | this.keymap = keymap
52 |
53 | /**
54 | * Registered windows to be raised
55 | * @type {{}}
56 | */
57 | this.register = []
58 | /**
59 | * Accelerators currently connected to the WM.
60 | * @type {Map} [accelerator.action_id] => accelerator
61 | */
62 | this.accelerator_map = new Map()
63 |
64 | this.handler_accelerator_activated = null
65 | this.handler_layered = null
66 | this.handler_state_changed = null
67 |
68 | /**
69 | *
70 | * @type {DefaultMap} {shortcut => [action, ...]}
71 | */
72 | this.accelerators = new DefaultMap((shortcut) => new Accelerator(shortcut, this))
73 |
74 | /**
75 | *
76 | * @type {DefaultMap} {shortcut => [action, ...]}
77 | */
78 | this.layered_accelerators = new DefaultMap((shortcut) => new Accelerator(shortcut, this))
79 |
80 | /**
81 | * @type {Set}
82 | */
83 | this.unblock_later = new Set
84 | }
85 |
86 | enable() {
87 | /* XX Note Ubuntu 20.10: Using modifiers – worked well for me, (xmodmap shows a numlock)
88 | consumed the shortcut when Num_Lock (nothing printed out) but it seems nothing was triggered here.
89 |
90 | Keymap.get_modifier_state() returns an int 2^x where x is 8 positions of xmodmap*/
91 | const shortcuts = this._fetch_shortcuts()
92 | if (!shortcuts) {
93 | return
94 | }
95 |
96 | // Catch the signal that one of system-defined accelerators has been triggered
97 | this.handler_accelerator_activated = global.display.connect(
98 | 'accelerator-activated',
99 | (display_, action, deviceId, timestamp) => {
100 | try {
101 | const accelerator = this.accelerator_map.get(action)
102 | if (!accelerator) {
103 | // ex: Fn+volume_up for an unknown reason ends up here
104 | return
105 | }
106 | if (this.handler_layered) {
107 | this.layer_finished()
108 |
109 | if (!accelerator.is_layered) {
110 | // another accelerator activated while handling a layered shortcut → ignore
111 | return false
112 | }
113 | }
114 | const layered = accelerator.trigger()
115 | if (layered.length) { // start layered mode
116 | this.layered_mode_start(layered)
117 | } else {
118 | this.layered_mode_stop()
119 | }
120 | } catch (e) {
121 | this.error(e, "Accelerator failed")
122 | }
123 | }
124 | )
125 |
126 | // parse shortcut file
127 | for (const line of shortcuts) {
128 | try {
129 | if (line[0] === "#" || line.trim() === "") { // skip empty lines and comments
130 | continue
131 | }
132 | const action = parseLine(line, this)
133 | this.accelerators.get(action.shortcut).push(action)
134 | } catch (e) {
135 | this.display(`Cannot parse line: ${line}.${e}`)
136 | }
137 | }
138 |
139 | // XX Note: If I register both Hyper and Super (both on the same mod4), the first listener makes it impossible
140 | // for the second to register. I may distinguish that they are on the same mode and to put them
141 | // on the same index in `actions`.
142 | // XX I may manually distinguish Super_L and Super_R if I get the key that was just hit.
143 |
144 | /**
145 | * Subset of accelerators that includes only lock-dependent actions. (No action requires to be on always.)
146 | * These should be disabled if the keyboard is in a different state to not consume the shortcut.
147 | * Ex: Release i when Num_Lock is on
148 | * otherwise `i` would be consumed by the extension.
149 | * (However, if generic i exists, the grabber must stay.)
150 | */
151 | const lock_dependent_accelerators = []
152 | this.accelerators.forEach(accelerator => {
153 | // Launch only generic shortcuts (not lock-dependent) (group having no no-lock shortcuts amongst)
154 | if (accelerator.some(action => action.get_state().every(lock => lock === null))) { // these are always on
155 | accelerator.connect()
156 | } else { // these are lock-dependent, on only if keyboard-locks match
157 | lock_dependent_accelerators.push(accelerator)
158 | }
159 | })
160 |
161 | // De/register accelerators depending on the keyboard state
162 | let last_state = []
163 | const on_state_changed = () => {
164 | const state = this.get_state()
165 | if (!arraysEqual(state, last_state)) {
166 | lock_dependent_accelerators.forEach(acc => acc.on_state_changed(last_state))
167 | last_state = state
168 | }
169 | }
170 |
171 | this.handler_state_changed = this.keymap.connect('state-changed', on_state_changed)
172 | on_state_changed()
173 |
174 | }
175 |
176 | _fetch_shortcuts() {
177 | let s;
178 | try {
179 | s = Shell.get_file_contents_utf8_sync(conf_path);
180 | } catch (e) {
181 | this.display(`Cannot load confpath ${conf_path}, creating new file from default`)
182 | // instead of using `mkdir -p` and `cp`,
183 | // the GNOME team required me to use this dark and cumbersome methods to copy a single file
184 | const target_dir = Gio.File.new_for_path(conf_path.substr(0, conf_path.lastIndexOf("/")))
185 | const target = Gio.File.new_for_path(conf_path)
186 | const source = Gio.File.new_for_path(default_conf_path)
187 | try {
188 | target_dir.make_directory_with_parents(null)
189 | } catch (e) {
190 | ; // directory already exists
191 | }
192 | source.copy(target, null, null, null)
193 |
194 | try {
195 | s = Shell.get_file_contents_utf8_sync(default_conf_path); // it seems confpath file is not ready yet, reading defaultconfpath
196 | } catch (e) {
197 | this.display("Failed to create the default file")
198 | return
199 | }
200 | }
201 | return s.split("\n")
202 | }
203 |
204 |
205 | disable() {
206 | this.accelerators.forEach(actions => actions.disconnect()) // ungrab the accelerators
207 | global.display.disconnect(this.handler_accelerator_activated) // stop listening to the accelerators, none left
208 | this.layered_mode_stop()
209 | this.keymap.disconnect(this.handler_state_changed) // stop listening to keyboard-locks changes
210 | }
211 |
212 | get_state() {
213 | // XX scroll_lock_state is not available via Clutter in Gnome 3.36.
214 | // It was available via Gdm which does not work in Wayland.
215 | // Check in the further version of Gnome whether scroll_lock state was restored or get rid of it.
216 | return [this.keymap.get_num_lock_state(), this.keymap.get_caps_lock_state(),
217 | this.keymap.get_scroll_lock_state ? this.keymap.get_scroll_lock_state() : 0
218 | ]
219 | }
220 |
221 | /**
222 | * We have launched a layered shortcut.
223 | * Start a key press listener to identify which one should be triggered.
224 | * @param {Action[]} candidates
225 | */
226 | layered_mode_start(candidates) {
227 | candidates.map(action => {
228 | const new_action = action.get_layered_action()
229 | if (this.accelerators.has(new_action.shortcut)) {
230 | this.unblock_later.add(this.accelerators.get(new_action.shortcut).block())
231 | }
232 | this.layered_accelerators.get(new_action.shortcut).push_layered(new_action)
233 | })
234 |
235 | this.layered_accelerators.forEach(acc => acc.connect())
236 | this._handler_layered_init(this.verbose)
237 | }
238 |
239 | /**
240 | * A key press listener, invisible in GUI. Used when a layered shortcut has been triggered.
241 | * @param {boolean} debug Visually display listenered. So that we can see it disappears (stop listening).
242 | */
243 | _handler_layered_init(debug = false) {
244 | if (this.handler_layered) {
245 | return // handler already present from the last layer
246 | }
247 | this.handler_layered = new St.Bin({
248 | reactive: true,
249 | can_focus: true
250 | })
251 | if (debug) {
252 | this.handler_layered.width = 100
253 | this.handler_layered.height = 100
254 | this.handler_layered.style = 'background-color: gold'
255 | this.handler_layered.set_position(0, 0)
256 | }
257 | Main.layoutManager.addChrome(this.handler_layered, {
258 | affectsInputRegion: true,
259 | trackFullscreen: true,
260 | })
261 | this.handler_layered.grab_key_focus()
262 |
263 | // When listeren gets a key (which is not a modifier) this means
264 | // the user has written a key was not grabbed as a layered accelerator.
265 | // → Stop listening to layered accelerators.
266 | this.handler_layered.connect_after(
267 | 'key-press-event',
268 | (_, event) => MODIFIERS.includes(event.get_key_symbol()) ? null : this.layered_mode_stop()
269 | )
270 | this.handler_layered.connect(
271 | 'key-focus-out',
272 | () => this.layered_mode_stop()
273 | )
274 | }
275 |
276 | /**
277 | * Next layer, wipe accelerators of the previous layer
278 | */
279 | layer_finished() {
280 | this.layered_accelerators.forEach(temp_accelerator => temp_accelerator.disconnect())
281 | this.layered_accelerators.clear()
282 | }
283 |
284 | layered_mode_stop() {
285 | this.layer_finished()
286 | this.unblock_later.forEach(acc => acc.unblock())
287 | this.unblock_later.clear()
288 |
289 | if (this.handler_layered) {
290 | this.handler_layered.destroy()
291 | this.handler_layered = null
292 | }
293 | }
294 | }
295 |
296 | export default class RunOrRaiseExtension extends Extension {
297 | constructor(metadata) {
298 | super(metadata)
299 | conf_path = ".config/run-or-raise/shortcuts.conf" // CWD is be HOME
300 | default_conf_path = this.metadata.path + "/shortcuts.default"
301 | }
302 |
303 | enable() {
304 | const seat = Clutter.get_default_backend().get_default_seat()
305 | const keymap = seat.get_keymap()
306 | this.app = new App(this.getSettings(), seat, keymap)
307 | this.app.enable()
308 |
309 | if (this.app.settings.get_boolean("dbus")) {
310 | this._dbus = Gio.DBusExportedObject.wrapJSObject(DBUS, this)
311 | this._dbus.export(Gio.DBus.session, '/org/gnome/Shell/Extensions/RunOrRaise')
312 | }
313 | }
314 |
315 | disable() {
316 | this.app?.disable()
317 | this.app = null
318 |
319 | this._dbus?.flush()
320 | this._dbus?.unexport()
321 | this._dbus = null
322 | }
323 |
324 | /**
325 | * Invoke with
326 | * gdbus call --session --dest org.gnome.Shell
327 | * --object-path /org/gnome/Shell/Extensions/RunOrRaise
328 | * --method org.gnome.Shell.Extensions.RunOrRaise.Call ",firefox,,"
329 | * @param {string} line Ex: ",firefox,," will run or raise a firefox window
330 | */
331 | Call(line) {
332 | parseLine(line, this.app).trigger()
333 | return "Success"
334 | }
335 | }
336 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Run-or-raise
2 |
3 | https://extensions.gnome.org/extension/1336/run-or-raise/
4 |
5 | # About project
6 |
7 | I assume the run-or-raise style as the most efficient way of handling windows. No more searching for your favourite program in a long menu, no more clicking on the icons. If the program already runs it will get the focus, else we launch it.
8 |
9 | Several years ago, OS creators finally realized that efficiency and let the users run-or-raise programs on the taskbar or dock by Super+number shortcuts. But what if you use more programs than nine? What if you do not want the unnecessary taskbar to occupy the precious place on the screen?
10 |
11 | With the emergence of Wayland over X.org, we can't reliably use good old [`xbindkeys`](https://wiki.archlinux.org/index.php/Xbindkeys) and [`jumpapp`](https://github.com/mkropat/jumpapp) to master shortcuts. Here is a gnome-shell extension that let you migrate your favourite shortcuts to the `shortcuts.conf` file.
12 |
13 | # Contents
14 | - [Installation](#installation)
15 | - [Configuration](#configuration)
16 | * [How to create a shortcut](#how-to-create-a-shortcut)
17 | + [Shortcut](#shortcut)
18 | + [Action: `command`, `wm_class` and `title`](#action-command-wm_class-and-title)
19 | - [Understanding `title` and `wm_class`](#understanding-title-and-wm_class)
20 | - [Comparison of different matching approaches](#comparison-of-different-matching-approaches)
21 | + [Modes](#modes)
22 | * [DBus](#dbus)
23 | * [Examples](#examples)
24 | - [Tips](#tips)
25 | * [Barebones “GNOME Shell native” alternative](#barebones-gnome-shell-native-alternative)
26 | * [Developer guide](#developer-guide)
27 | + [Debugging](#debugging)
28 |
29 | # Installation
30 |
31 | * through GNOME3 [extensions](https://extensions.gnome.org/extension/1336/run-or-raise/
32 | ) (official, easy, not always up to date)
33 |
34 | OR
35 | * clone this repo to `/home/$USER/.local/share/gnome-shell/extensions/run-or-raise@edvard.cz`
36 | * reload extensions (e.g. log out in wayland - [details here](https://gjs.guide/extensions/development/creating.html#testing-the-extension))
37 | * enable run-or-raise in `gnome-extensions-app` panel
38 | * in the extension preferences, you may edit `shortcuts.conf` file to use your own shortcuts
39 | * you may load new shortcuts without restarting, just change the file `shortcuts.conf`, and disable and enable.
40 |
41 | # Configuration
42 |
43 | On the first run, `~/.config/run-or-raise/shortcuts.conf` gets created from [`shortcuts.default`](shortcuts.default) if not exists. There you define your own shortcuts.
44 |
45 | Note that if an argument should contain a comma, use double quotes around.
46 | ```
47 | i,"/usr/bin/cmd comma, needed",,application_title
48 | ```
49 |
50 | ## How to create a shortcut
51 |
52 | When you trigger a shortcut it lets you cycle amongst open instances of the application or if not found, launches a new instance. The file consists of shortcuts in the following form:
53 |
54 | `shortcut[ shortcut][:mode],command,[wm_class],[title]`
55 |
56 | ### Shortcut
57 |
58 | Shortcut consists of an arbitrary number of modifiers (angle brackets) and a character, like `a`, `a`, simple `a` or `slash`. Character might be either a keysym (`a`, `acute`) or a keycode in the hex format, ex: letter *a* with the keycode 38 is noted `0x26`.
59 |
60 | For custom shortcuts, I recommended using mostly combinations containing the modifier `` as this normally indicates global shortcuts. In the opposition to `` which is semantically reserved for letter case `a/A`, `` for underlined letters and `` for various application-defined actions.
61 |
62 | Possible modifiers:
63 | * basic
64 | * ``, ``, ``, `` (``), `` known as Win, ``
65 | * you may not have all of them on your keyboard by default
66 | * `` (I really recommend mapping this modifier instead of Caps Lock)
67 | * mods
68 | * ``, ``, ``, ``, ``
69 | * consult `xmodmap` to see the overview of the keys that are mapped to mods
70 | * consult `xev`/`wev` to determine key symbols you have mapped
71 | * ex: if the key Alt Gr corresponds with the key symbol `` that is bound to **mod5**, you would use `` to create its shortcuts
72 | * ex: imagine you have both `` and `` on **mod4**. You bind them all by `i`, `i`, `i` shortcuts. As they are the same on the internal Gnome-level, only the first shortcut grabs the accelerator, the latter defined will not work. For more information, consult [Gnome/Mutter/core/meta-accel-parse.c](https://gitlab.gnome.org/GNOME/mutter/-/blob/main/src/core/meta-accel-parse.c) source code.
73 | * non-standard locks: Not proper Gnome shortcuts implemented by the extension allow to control the accelerators being listened to depending on the keyboard locks state.
74 | * ``, ``
75 | * ``, ``
76 | * ``, `` (`Scroll_Lock` might not be available in Wayland session, hence might be removed in the future)
77 |
78 | Multiple actions may be registered to the same shortcut (a shortcut appears on multiple lines). They get lauched sequentionally.
79 | ```
80 | e,notify-send appears first
81 | e,notify-send appears second
82 | ```
83 |
84 | Layered shortcuts are possible. After the shortcut is hit, you may specify one or more shortcuts to be hit in order to trigger the action.
85 | ```
86 | e a,notify-send Launched a
87 | e b,notify-send Launched b
88 | e c d,notify-send Launched cd
89 | e c e,notify-send Launched ce
90 | g,notify-send Launched "g"
91 | e g,notify-send Launched "e and then g"
92 | e e e,notify-send Launched "e e"
93 | ```
94 |
95 | If you need to discover a [keysym](https://wiki.linuxquestions.org/wiki/List_of_keysyms) (or at [xkbcommon.org](https://xkbcommon.org/doc/current/xkbcommon-keysyms_8h.html)), I recommend the `xev`/`wev` program again.
96 |
97 | ```
98 | grave,notify-send "Using backtick in the shortcut: `"
99 | ```
100 |
101 | When in trouble, use keycode in hex form instead of a keysym. In this example, we recognize 49 is the keycode of the backtick (31 in hex).
102 |
103 | ```bash
104 | $ wev # type backtick key
105 | [14: wl_keyboard] key: serial: 23425; time: 8592750; key: 49; state: 0 (released) sym: grave (96), utf8: ''
106 | ```
107 |
108 | Hence the hex form is `0x31`:
109 |
110 | ```
111 | 0x31,notify-send "Using backtick keycode in the shortcut: `"
112 | ```
113 |
114 | ### Action: `command`, `wm_class` and `title`
115 | * `command` can be either:
116 | * a command line instruction to be spawned in a new process
117 | * the name of an application's .desktop file to be activated
118 | * `wm_class` and `title` arguments are optional and case-sensitive
119 | * if neither `wm_class` nor `title` is set, lower-cased `command` is compared with lower-cased windows' wm_classes and titles
120 |
121 | #### Understanding `title` and `wm_class`
122 | The `title` is shown in the header area. Since the title tends to be dynamically changed by the application, you can use `wm_class` which compares to both parts (both `WM_CLASS_NAME` and `WM_CLASS_INSTANCE`) of this window property.
123 |
124 | How to know the `wm_class`?
125 | Just use the `xprop` program and filter the `WM_CLASS` line:
126 |
127 | ```bash
128 | $ xprop
129 | # hit the mail window with the mouse cursor and get:
130 | WM_CLASS(STRING) = "mail.google.com__mail_u_0", "Google-chrome"
131 | ```
132 |
133 | The first string `mail.google.com__mail_u_0` is more specific `WM_CLASS_INSTANCE`, the second `Google-chrome` is more stable `WM_CLASS_NAME`.
134 |
135 | Alternatively, you can use the looking glass tool (at least on Ubuntu 17.10+) by launching Alt+f2 / `lg` / "Windows" tab. There, you see `WM_CLASS_NAME` listed as `wmclass`. To get the `WM_CLASS_INSTANCE`, click on a window title / button "Insert" / go back to the "Evaluator" tab and refer the window via the inserted value `r` like: `r(0).get_wm_class_instance()`.
136 | I found no easier solution for the moment.
137 |
138 | #### Comparison of different matching approaches
139 |
140 | Following shortcut will firstly launch mail window in an application mode. Later on, it will cycle all windows that have `mail.google.com` in the `wm_class`. (Which is what we want here.)
141 |
142 | ```
143 | e,/opt/google/chrome/google-chrome --app=https://mail.google.com/mail/u/0,mail.google.com,
144 | ```
145 |
146 | In an opposite manner, this would cycle all Chrome windows. (Which is not what we want.)
147 |
148 | ```
149 | e,/opt/google/chrome/google-chrome --app=https://mail.google.com/mail/u/0,Google-chrome,
150 | ```
151 |
152 | And finally, using the `title` part rather than the `wm_class` part, this would cycle all windows that have Gmail in the title. On one side this would include windows just mentioning Gmail (bad). On the other side when somebody writes you to the chat, the window title changes and the shortcut would open another Gmail instance (even worse).
153 |
154 | ```
155 | e,/opt/google/chrome/google-chrome --app=https://mail.google.com/mail/u/0,,Gmail
156 | ```
157 |
158 | ### Modes
159 |
160 | Modes are special instructions that let you change the triggered behaviour. Some of them can be turned on globally in the extension preferences (so you do not have to specify them for every single shortcut if you need them everywhere).
161 |
162 | You can combine multiple modes by appending a colon. On the first hit, we register a window. On the second, we raise it while bringing to the active workspace.
163 | ```
164 | i:raise-or-register:move-window-to-active-workspace
165 | ```
166 |
167 | #### `isolate-workspace`
168 | Switch windows on the active workspace only
169 | ```
170 | # cycles Firefox instances in the current workspace
171 | KP_1:isolate-workspace,firefox,
172 | ```
173 | #### `minimize-when-unfocused`
174 | Minimizes your target when unfocusing
175 | #### `switch-back-when-focused`
176 | Switch back to the previous window when focused. If a shortcut has no but a single window to cycle, it focuses last used window instead of doing nothing.
177 | #### `move-window-to-active-workspace`
178 | Move window to current workspace before focusing. If the window is on a different workspace, moves the window to the workspace you're currently viewing.
179 | #### `center-mouse-to-focused-window`
180 | Moves mouse to the center of the newly focused window (unless cursor is not in the window area already).
181 | #### `always-run`
182 | Both runs the command and raises a window
183 | ```
184 | # Runs a command whether a window with wm_class 'kitty' is already open or not
185 | t:always-run,my_tmux_script.sh,kitty
186 | ```
187 | #### `run-only`
188 | Since it is very convenient to use a single file for all of your shortcuts (backup, migration to another system...), you can define standard shortcuts as well. These commands just get launched whenever the keys are hit and never raises a window. The keyword is implicit if no superfluous commas are noted in the line: `shortcut,command`
189 |
190 | ```
191 | # this line will launch the notify-send command.
192 | y,notify-send Hello world
193 |
194 | # this line WILL raise a Firefox window or launches a command (note a trailing comma)
195 | f,firefox,
196 |
197 | # these equivalent lines will always launch a new Firefox instance, never raising a window
198 | f,firefox
199 | f:run-only,firefox,
200 | ```
201 | #### `register(0)`
202 | Register the current window dynamically to be re-raised by using `raise` mode with the same number in the argument
203 | ```
204 | KP_0:register(1)
205 | KP_0:raise(1)
206 | KP_Delete:register(2)
207 | KP_Delete:raise(2)
208 | ```
209 | #### `raise(0)`
210 | Raise the windows previously registered by the `register` keyword
211 | #### `raise-or-register`
212 | If nothing registered yet, register the current window. Next time raise it unless the window is closed. In the example, we set Super+i and Super+o to bind a window each.
213 | ```
214 | i:raise-or-register
215 | o:raise-or-register
216 | ```
217 | #### `raise-or-register(0)`
218 | If nothing has been registered yet, register the current window. Next time, raise it, unless the window is closed or has been remapped with `register(the same number)`. Thus, it is a combination of `register`, `raise`, and `raise-or-register`.
219 | #### `verbose`
220 | Popups debug details via `notify-send`. (Normally it seems launched commands pipe the output to the `/var/log/syslog`.)
221 |
222 | ## DBus
223 |
224 | In the extension settings, you may allow listening on DBus. Then, you can invoke the commands from the shell. The following example would start a firefox instance. Note there is no shortcut mentioned as the shortcuts are ignored.
225 |
226 | ```bash
227 | $ gdbus call --session --dest org.gnome.Shell --object-path /org/gnome/Shell/Extensions/RunOrRaise --method org.gnome.Shell.Extensions.RunOrRaise.Call ",firefox"
228 | ('Success',)
229 | ```
230 |
231 | ## Examples
232 |
233 | This line cycles any firefox window (matched by "firefox" in the window title) OR if not found, launches a new firefox instance:
234 |
235 | ```
236 | f,firefox,,
237 | ```
238 |
239 | This line starts gnome-terminal using it's .desktop file:
240 |
241 | ```
242 | f,org.gnome.Terminal.desktop,,
243 | ```
244 |
245 | This line cycles any open gnome-terminal OR if not found, launches a new one.
246 |
247 | ```
248 | r,gnome-terminal,,
249 | ```
250 |
251 | If you want to be sure that your browser won't be focused when you're on the page having "gnome-terminal" in the title, you may want to match running application by `wm_class = Gnome-terminal` (Ubuntu on Xorg) or by `wm_class = gnome-terminal-server` (Ubuntu on Wayland or Arch)... just check yourself by Alt+F2/lg/Windows everytime `wm_class` is needed.
252 |
253 | ```
254 | r,gnome-terminal,Gnome-terminal,
255 | ```
256 |
257 |
258 | You may use **regular expressions** in `title` or `wm_class`. Just put the expression between slashes.
259 | E.g. to jump to pidgin conversation window you may use this line
260 | (that mean any windows of `wm_class` Pidgin, not containing the title Buddy List)"
261 |
262 | ```
263 | KP_1,pidgin,Pidgin,/^((?!Buddy List).)*$/
264 | ```
265 |
266 | To match `Google-chrome` and not `Google-chrome-beta`, help yourself with `$` sign to mark the end of matched text.
267 | ```
268 | KP_3,gtk-launch google-chrome.desktop,/Google-chrome$/,
269 | KP_3,gtk-launch google-chrome-beta.desktop,Google-chrome-beta,
270 | ```
271 |
272 | Another occasion you'd use regulars would be the case when you'd like to have multiple applications on single keystroke. In the following example, shortcut `Super+Ctrl+(Numpad)4` focuses an IDE editor, either NetBeans or PyCharm. Because I'm mainly using NetBeans but for Python language I prefer PyCharm, I was wrong too often till I set single keystroke for both. (However, when no IDE is open, for launching NetBeans I use numpad and for PyCharm the 4 on the 4th row of keyboard.)
273 |
274 | ```
275 | 4,/opt/pycharm-community-2017.2.4/bin/pycharm.sh,,/(NetBeans IDE|PyCharm)/
276 | KP_4,/opt/netbeans/bin/netbeans,,/(NetBeans IDE|PyCharm)/
277 | ```
278 |
279 | To run a command as a sudo, try simple `pkexec` program that raises the password dialogue. For a repetitive task, familiarise yourself with the system sudoers file.
280 | ```
281 | r,bash -c 'notify-send "Root folder" "`pkexec ls /root/`"'
282 | ```
283 |
284 | # Tips
285 | * For the examples, see [shortcuts.default](shortcuts.default) file.
286 | * You may change the configuration file on the fly. Just disable & enable the extension, shortcuts load again from scratch. Ex: `gnome-extensions disable run-or-raise@edvard.cz && gnome-extensions enable run-or-raise@edvard.cz`
287 | * In the case of segfault, check no conflicting key binding [is present](https://github.com/CZ-NIC/run-or-raise/pull/1#issuecomment-350951994), then submit an issue.
288 |
289 | ## Barebones “GNOME Shell native” alternative
290 |
291 | Note that GNOME Shell supports a _basic_ run-or-raise workflow out of the box! To enjoy a basic run-or-raise with no extension:
292 |
293 | 1. Pin your favorite apps to the Dash (`Activities` → `Right click` on open app → `Pin to Dash`).
294 | 2. Don’t let the default bindings cause you a left thumb [RSI](https://en.wikipedia.org/wiki/Repetitive_strain_injury)! To re-bind them, set dconf values to your desired keyboard shortcut (where `N` is `1..9`): `gsettings set "org.gnome.shell.keybindings" "switch-to-application-N" "['']"`.
295 | 3. Never re-order your pinned apps.
296 |
297 | Caveats: Limited to 9 apps; no wmclass, regex, layered shortcuts, or [modes](#modes) support. Limited to static `StartupWMClass` in XDG `.desktop` files.
298 |
299 | ## Developer guide
300 |
301 | How to implement a new mode?
302 |
303 | * create new static keyword in the `Mode` class in the [mode.js](lib/mode.js) file
304 | * create the same in [gschema.xml](schemas/org.gnome.shell.extensions.run-on-raise.gschema.xml) if the keyword should be available globally for all the shortcuts and run `make compile`
305 | * put the logics into `Action.trigger` method, by checking if the settings is on (either locally per shortcut or globally) by `this.mode.get(Mode.KEYWORD)`
306 | * you may need [gjs.guide](https://gjs.guide/extensions), [gnome-shell source](https://gitlab.gnome.org/GNOME/gnome-shell/-/tree/main/js/) or [gjs-docs.gnome.org](https://gjs-docs.gnome.org)
307 | * document here in the [README.md](README.md)
308 | * put a description into [CHANGELOG.md](CHANGELOG.md) file
309 | * ~~raise a version in [metadata.json](metadata.json)~~
310 | * create a pull request with (preferably) a single commit
311 |
312 | ### Debugging
313 | When tired of logging out to refresh the code, launch a new wayland session ex by:
314 |
315 | ```
316 | (sleep 1 && gnome-extensions disable run-or-raise@edvard.cz & ) && dbus-run-session -- gnome-shell --nested --wayland && gnome-extensions enable run-or-raise@edvard.cz
317 | ```
318 |
319 | What does this command do? Note that the extension must be running in the main session in order to be started in the nested session too. So after a second, we disable it in the main session to not interfere with the nested instance of the extension: They share the same shortcuts and the main would prevail. When the nested session is over, enable it in the main session again.
320 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------