├── .gitignore ├── screenshots └── 1.png ├── schemas ├── gschemas.compiled └── org.gnome.shell.extensions.improvedosk.gschema.xml ├── metadata.json ├── stylesheet.css ├── .github └── ISSUE_TEMPLATE │ └── bug_report.md ├── README.md ├── prefs.js ├── extension.js └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .idea/ -------------------------------------------------------------------------------- /screenshots/1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/KaratekHD/improved-osk-gnome-ext/master/screenshots/1.png -------------------------------------------------------------------------------- /schemas/gschemas.compiled: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/KaratekHD/improved-osk-gnome-ext/master/schemas/gschemas.compiled -------------------------------------------------------------------------------- /metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "description": "Makes Gnome's onscreen keyboard more useable with e.g. more keys.\nThis extension is a fork of https://extensions.gnome.org/extension/3330/improved-onscreen-keyboard/ by SebastianLuebke.", 3 | "name": "Improved OSK", 4 | "shell-version": [ 5 | "3.38", 6 | "40", 7 | "41", 8 | "42" 9 | ], 10 | "url": "https://github.com/nick-shmyrev/improved-osk-gnome-ext", 11 | "uuid": "improvedosk@nick-shmyrev.dev", 12 | "version": 7 13 | } 14 | -------------------------------------------------------------------------------- /schemas/org.gnome.shell.extensions.improvedosk.gschema.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | true 8 | 9 | 10 | false 11 | 12 | 13 | false 14 | 15 | 16 | 33 17 | 18 | 19 | 16 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /stylesheet.css: -------------------------------------------------------------------------------- 1 | /* Removes keyboard background transparency */ 2 | #keyboard { 3 | background-color: #000000; 4 | } 5 | 6 | /* Changes modifier keys bg-color when latched */ 7 | .control-key-latched #keyboard .keyboard-key.default-key.control-key, 8 | .super-key-latched #keyboard .keyboard-key.default-key.super-key, 9 | .alt-key-latched #keyboard .keyboard-key.default-key.alt-key, 10 | #keyboard .keyboard-key.default-key.shift-key-uppercase { 11 | background-color: #55a54c; 12 | } 13 | 14 | #keyboard .keyboard-key.default-key.enter-key { 15 | border-color: #55a54c; 16 | background-color: #55a54c; 17 | } 18 | #keyboard .keyboard-key.default-key.enter-key:active { 19 | border-color: #43823c; 20 | background-color: #43823c; 21 | } 22 | 23 | /* Explicitly sets modifier keys bg-color, see issues #12 & #17 for details */ 24 | #keyboard .keyboard-key.default-key { 25 | color: #fff; 26 | border-color: #2c2c2c; 27 | background-color: #2c2c2c; 28 | } 29 | #keyboard .keyboard-key.default-key:active { 30 | border-color: #121212; 31 | background-color: #121212; 32 | } 33 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **To Reproduce** 14 | Steps to reproduce the behavior: 15 | 1. Go to '...' 16 | 2. Click on '....' 17 | 3. Scroll down to '....' 18 | 4. See error 19 | 20 | **Expected behavior** 21 | A clear and concise description of what you expected to happen. 22 | 23 | **Screenshots** 24 | If applicable, add screenshots to help explain your problem. 25 | 26 | **Environment (please complete the following information):** 27 | - Distro: [e.g. Ubuntu 21.10, Fedora 35, Manjaro, Arch] 28 | - Gnome version: [e.g. 38, 40, 41.1] 29 | 30 | **Additional context** 31 | Have you been running your system for a while, or is it a fresh installation? 32 | Are you running any other extensions that might interfere with on-screen keyboard? 33 | Does `journalctl /usr/bin/gnome-shell -f -o cat` show any errors? 34 | Can you see any errors in looking glass? (Press `Alt + F2`, enter `lg`, switch to "extensions" tab and click "show errors" for Improved OSK extension) 35 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # improved-osk-gnome-ext 2 | 3 | Makes Gnome's onscreen keyboard more useable. 4 | 5 | Features: 6 | * More buttons like CTRL, F-Keys, Arrow Keys... 7 | * Configurable keyboard size (landscape/portrait) 8 | * Toggle auto keyboard popup on touch input 9 | * Works in gnome password modals 10 | * Statusbar indicator to toggle keyboard 11 | 12 | This extension is a fork of [SebastianLuebke/improved-osk-gnome-ext](https://github.com/SebastianLuebke/improved-osk-gnome-ext). 13 | 14 | ![Screenshot](screenshots/1.png) 15 | 16 | ## Installation 17 | 18 | ### From source code 19 | 20 | Clone the git repo 21 | 22 | ```console 23 | git clone https://github.com/nick-shmyrev/improved-osk-gnome-ext.git ~/.local/share/gnome-shell/extensions/improvedosk@nick-shmyrev.dev 24 | ``` 25 | 26 | ### From extensions.gnome.org 27 | 28 | https://extensions.gnome.org/extension/4413/improved-osk/ 29 | 30 | ## Activation 31 | 32 | After installing and enabling extension, reload Gnome Shell. On X11, press `alt + F2` and enter `r`. On Wayland, log out and back in to reload Gnome Shell. 33 | 34 | ## FAQ 35 | 36 | ### Some symbols are missing... 37 | the keyboard uses unicode characters, try install ttf-symbola on archlinux (AUR) or ttf-ancient-fonts-symbola on ubuntu/debian 38 | 39 | ### Do i need to enable the OSK in Gnome accessibility settings? 40 | By default the keyboard will popup on touch input events. Enabling the keyboard in the accessibility settings just allows the OSK to popup on non touch input. 41 | 42 | ### Extension is installed and activated, but keyboard layout doesn't change. 43 | Gnome's default on-screen keyboard, on which this extension is based on, uses `ibus` package, make sure you have it installed. 44 | -------------------------------------------------------------------------------- /prefs.js: -------------------------------------------------------------------------------- 1 | "use strict"; 2 | 3 | const Gio = imports.gi.Gio; 4 | const Gtk = imports.gi.Gtk; 5 | 6 | const ExtensionUtils = imports.misc.extensionUtils; 7 | const Me = ExtensionUtils.getCurrentExtension(); 8 | 9 | function init() {} 10 | 11 | function buildPrefsWidget() { 12 | let gschema = Gio.SettingsSchemaSource.new_from_directory( 13 | Me.dir.get_child("schemas").get_path(), 14 | Gio.SettingsSchemaSource.get_default(), 15 | false 16 | ); 17 | 18 | this.settings = new Gio.Settings({ 19 | settings_schema: gschema.lookup( 20 | "org.gnome.shell.extensions.improvedosk", 21 | true 22 | ), 23 | }); 24 | 25 | // https://gjs-docs.gnome.org/gtk40/gtk.widget#index-properties 26 | let prefsWidget = new Gtk.Grid({ 27 | margin_top: 24, 28 | margin_bottom: 24, 29 | margin_start: 24, 30 | margin_end: 24, 31 | column_spacing: 24, 32 | row_spacing: 12, 33 | visible: true, 34 | }); 35 | 36 | let labelPortraitHeight = new Gtk.Label({ 37 | label: "Portrait Height in Percent:", 38 | halign: Gtk.Align.START, 39 | visible: true, 40 | }); 41 | prefsWidget.attach(labelPortraitHeight, 0, 0, 1, 1); 42 | 43 | let inputPortraitHeight = new Gtk.SpinButton(); 44 | inputPortraitHeight.set_range(0, 100); 45 | inputPortraitHeight.set_sensitive(true); 46 | inputPortraitHeight.set_increments(1, 10); 47 | prefsWidget.attach(inputPortraitHeight, 1, 0, 1, 1); 48 | inputPortraitHeight.set_value(settings.get_int("portrait-height")); 49 | inputPortraitHeight.connect("value-changed", (widget) => { 50 | settings.set_int("portrait-height", widget.get_value_as_int()); 51 | }); 52 | settings.connect("changed::portrait-height", () => { 53 | inputPortraitHeight.set_value(settings.get_int("portrait-height")); 54 | }); 55 | 56 | let labelLandscapeHeight = new Gtk.Label({ 57 | label: "Landscape Height in Percent:", 58 | halign: Gtk.Align.START, 59 | visible: true, 60 | }); 61 | prefsWidget.attach(labelLandscapeHeight, 0, 1, 1, 1); 62 | 63 | let inputLandscapeHeight = new Gtk.SpinButton(); 64 | inputLandscapeHeight.set_range(0, 100); 65 | inputLandscapeHeight.set_sensitive(true); 66 | inputLandscapeHeight.set_increments(1, 10); 67 | prefsWidget.attach(inputLandscapeHeight, 1, 1, 1, 1); 68 | inputLandscapeHeight.set_value(settings.get_int("landscape-height")); 69 | inputLandscapeHeight.connect("value-changed", (widget) => { 70 | settings.set_int("landscape-height", widget.get_value_as_int()); 71 | }); 72 | settings.connect("changed::landscape-height", () => { 73 | inputLandscapeHeight.set_value(settings.get_int("landscape-height")); 74 | }); 75 | 76 | let labelResizeDesktop = new Gtk.Label({ 77 | label: "Resize Desktop (Shell restart required):", 78 | halign: Gtk.Align.START, 79 | visible: true, 80 | }); 81 | 82 | let inputResizeDesktop = new Gtk.CheckButton({ 83 | label: "active", 84 | }); 85 | inputResizeDesktop.set_active(settings.get_boolean("resize-desktop")); 86 | inputResizeDesktop.connect("toggled", (widget) => { 87 | settings.set_boolean("resize-desktop", widget.get_active()); 88 | }); 89 | settings.connect("changed::resize-dekstop", () => { 90 | inputResizeDesktop.set_active(settings.get_boolean("resize-desktop")); 91 | }); 92 | prefsWidget.attach(inputResizeDesktop, 1, 2, 1, 1); 93 | 94 | prefsWidget.attach(labelResizeDesktop, 0, 2, 1, 1); 95 | 96 | let labelIgnoreTouchInput = new Gtk.Label({ 97 | label: "Ignore touch-input", 98 | halign: Gtk.Align.START, 99 | visible: true, 100 | }); 101 | 102 | let inputIgnoreTouchInput = new Gtk.CheckButton({ 103 | label: "active", 104 | }); 105 | inputIgnoreTouchInput.set_active(settings.get_boolean("ignore-touch-input")); 106 | inputIgnoreTouchInput.connect("toggled", (widget) => { 107 | settings.set_boolean("ignore-touch-input", widget.get_active()); 108 | }); 109 | settings.connect("changed::ignore-touch-input", () => { 110 | inputIgnoreTouchInput.set_active( 111 | settings.get_boolean("ignore-touch-input") 112 | ); 113 | }); 114 | prefsWidget.attach(inputIgnoreTouchInput, 1, 3, 1, 1); 115 | prefsWidget.attach(labelIgnoreTouchInput, 0, 3, 1, 1); 116 | 117 | let labelShowStatusbarIcon = new Gtk.Label({ 118 | label: "Show statusbar icon", 119 | halign: Gtk.Align.START, 120 | visible: true, 121 | }); 122 | 123 | let inputShowStatusbarIcon = new Gtk.CheckButton({ 124 | label: "active", 125 | }); 126 | inputShowStatusbarIcon.set_active( 127 | settings.get_boolean("show-statusbar-icon") 128 | ); 129 | inputShowStatusbarIcon.connect("toggled", (widget) => { 130 | settings.set_boolean("show-statusbar-icon", widget.get_active()); 131 | }); 132 | settings.connect("changed::show-statusbar-icon", () => { 133 | inputShowStatusbarIcon.set_active( 134 | settings.get_boolean("show-statusbar-icon") 135 | ); 136 | }); 137 | prefsWidget.attach(inputShowStatusbarIcon, 1, 4, 1, 1); 138 | prefsWidget.attach(labelShowStatusbarIcon, 0, 4, 1, 1); 139 | 140 | if (typeof prefsWidget.show_all === 'function') { 141 | // Adds backward compatibility with Gnome 38 142 | prefsWidget.show_all(); 143 | } else { 144 | // Gnome versions >= 40 145 | // https://gjs-docs.gnome.org/gtk40/gtk.widget#method-show 146 | prefsWidget.show(); 147 | } 148 | 149 | return prefsWidget; 150 | } 151 | -------------------------------------------------------------------------------- /extension.js: -------------------------------------------------------------------------------- 1 | "use strict"; 2 | const { Gio, St, Clutter, GObject } = imports.gi; 3 | const Main = imports.ui.main; 4 | const Keyboard = imports.ui.keyboard; 5 | const PanelMenu = imports.ui.panelMenu; 6 | const ExtensionUtils = imports.misc.extensionUtils; 7 | const Me = ExtensionUtils.getCurrentExtension(); 8 | const InputSourceManager = imports.ui.status.keyboard; 9 | 10 | const A11Y_APPLICATIONS_SCHEMA = "org.gnome.desktop.a11y.applications"; 11 | let _oskA11yApplicationsSettings; 12 | let backup_lastDeviceIsTouchScreen; 13 | let backup_relayout; 14 | let backup_DefaultKeysForRow; 15 | let backup_keyboardControllerConstructor; 16 | let backup_keyvalPress; 17 | let backup_keyvalRelease; 18 | let backup_commitString; 19 | let backup_loadDefaultKeys; 20 | let _indicator; 21 | let settings; 22 | 23 | // Indicator 24 | let OSKIndicator = GObject.registerClass( 25 | { GTypeName: "OSKIndicator" }, 26 | class OSKIndicator extends PanelMenu.Button { 27 | _init() { 28 | super._init(0.0, `${Me.metadata.name} Indicator`, false); 29 | 30 | let icon = new St.Icon({ 31 | icon_name: "input-keyboard-symbolic", 32 | style_class: "system-status-icon", 33 | }); 34 | 35 | this.add_child(icon); 36 | 37 | this.connect("button-press-event", function (actor, event) { 38 | let button = event.get_button(); 39 | 40 | if (button == 1) { 41 | if (Main.keyboard._keyboardVisible) return Main.keyboard.close(); 42 | 43 | Main.keyboard.open(Main.layoutManager.bottomIndex); 44 | } 45 | if (button == 3) { 46 | ExtensionUtils.openPrefs(); 47 | } 48 | }); 49 | 50 | this.connect("touch-event", function () { 51 | if (Main.keyboard._keyboardVisible) return Main.keyboard.close(); 52 | 53 | Main.keyboard.open(Main.layoutManager.bottomIndex); 54 | }); 55 | } 56 | } 57 | ); 58 | 59 | // Overrides 60 | function override_lastDeviceIsTouchScreen() { 61 | if (!this._lastDevice) return false; 62 | 63 | let deviceType = this._lastDevice.get_device_type(); 64 | 65 | return settings.get_boolean("ignore-touch-input") 66 | ? false 67 | : deviceType == Clutter.InputDeviceType.TOUCHSCREEN_DEVICE; 68 | } 69 | 70 | function override_relayout() { 71 | let monitor = Main.layoutManager.keyboardMonitor; 72 | 73 | if (!monitor) return; 74 | 75 | this.width = monitor.width; 76 | 77 | if (monitor.width > monitor.height) { 78 | this.height = (monitor.height * settings.get_int("landscape-height")) / 100; 79 | } else { 80 | this.height = (monitor.height * settings.get_int("portrait-height")) / 100; 81 | } 82 | } 83 | 84 | function override_keyvalPress(keyval) { 85 | // This allows manually releasing a latched ctrl/super/alt keys by tapping on them again 86 | if (keyval == Clutter.KEY_Control_L) { 87 | this._controlActive = !this._controlActive; 88 | 89 | if (this._controlActive) { 90 | this._virtualDevice.notify_keyval( 91 | Clutter.get_current_event_time(), 92 | Clutter.KEY_Control_L, 93 | Clutter.KeyState.PRESSED 94 | ); 95 | Main.layoutManager.keyboardBox.add_style_class_name("control-key-latched"); 96 | } else { 97 | this._virtualDevice.notify_keyval( 98 | Clutter.get_current_event_time(), 99 | Clutter.KEY_Control_L, 100 | Clutter.KeyState.RELEASED 101 | ); 102 | Main.layoutManager.keyboardBox.remove_style_class_name("control-key-latched"); 103 | } 104 | 105 | return; 106 | } 107 | 108 | if (keyval == Clutter.KEY_Super_L) { 109 | this._superActive = !this._superActive; 110 | 111 | if (this._superActive) { 112 | this._virtualDevice.notify_keyval( 113 | Clutter.get_current_event_time(), 114 | Clutter.KEY_Super_L, 115 | Clutter.KeyState.PRESSED 116 | ); 117 | Main.layoutManager.keyboardBox.add_style_class_name("super-key-latched"); 118 | } else { 119 | this._virtualDevice.notify_keyval( 120 | Clutter.get_current_event_time(), 121 | Clutter.KEY_Super_L, 122 | Clutter.KeyState.RELEASED 123 | ); 124 | Main.layoutManager.keyboardBox.remove_style_class_name("super-key-latched"); 125 | } 126 | 127 | return; 128 | } 129 | 130 | if (keyval == Clutter.KEY_Alt_L) { 131 | this._altActive = !this._altActive; 132 | 133 | if (this._altActive) { 134 | this._virtualDevice.notify_keyval( 135 | Clutter.get_current_event_time(), 136 | Clutter.KEY_Alt_L, 137 | Clutter.KeyState.PRESSED 138 | ); 139 | Main.layoutManager.keyboardBox.add_style_class_name("alt-key-latched"); 140 | } else { 141 | this._virtualDevice.notify_keyval( 142 | Clutter.get_current_event_time(), 143 | Clutter.KEY_Alt_L, 144 | Clutter.KeyState.RELEASED 145 | ); 146 | Main.layoutManager.keyboardBox.remove_style_class_name("alt-key-latched"); 147 | } 148 | 149 | return; 150 | } 151 | 152 | // Not a ctrl/super/alt key, continue down original execution path 153 | this._virtualDevice.notify_keyval( 154 | Clutter.get_current_event_time(), 155 | keyval, 156 | Clutter.KeyState.PRESSED 157 | ); 158 | } 159 | 160 | function override_keyvalRelease(keyval) { 161 | // By default each key is released immediately after being pressed. 162 | // Don't release ctrl/alt/super keys to allow them to be latched 163 | // and used in "ctrl/alt/super + key" combinations 164 | if ( 165 | keyval == Clutter.KEY_Control_L 166 | || keyval == Clutter.KEY_Alt_L 167 | || keyval == Clutter.KEY_Super_L 168 | ) { 169 | return; 170 | } 171 | 172 | this._virtualDevice.notify_keyval( 173 | Clutter.get_current_event_time(), 174 | keyval, 175 | Clutter.KeyState.RELEASED 176 | ); 177 | 178 | if (this._controlActive) { 179 | this._virtualDevice.notify_keyval( 180 | Clutter.get_current_event_time(), 181 | Clutter.KEY_Control_L, 182 | Clutter.KeyState.RELEASED 183 | ); 184 | this._controlActive = false; 185 | Main.layoutManager.keyboardBox.remove_style_class_name("control-key-latched"); 186 | } 187 | if (this._superActive) { 188 | this._virtualDevice.notify_keyval( 189 | Clutter.get_current_event_time(), 190 | Clutter.KEY_Super_L, 191 | Clutter.KeyState.RELEASED 192 | ); 193 | this._superActive = false; 194 | Main.layoutManager.keyboardBox.remove_style_class_name("super-key-latched"); 195 | } 196 | if (this._altActive) { 197 | this._virtualDevice.notify_keyval( 198 | Clutter.get_current_event_time(), 199 | Clutter.KEY_Alt_L, 200 | Clutter.KeyState.RELEASED 201 | ); 202 | this._altActive = false; 203 | Main.layoutManager.keyboardBox.remove_style_class_name("alt-key-latched"); 204 | } 205 | } 206 | 207 | function override_getDefaultKeysForRow(row, numRows, level) { 208 | let defaultKeysPreMod = [ 209 | [ 210 | [{ label: "Esc", width: 1, keyval: Clutter.KEY_Escape }], 211 | [{ label: "↹", width: 1.5, keyval: Clutter.KEY_Tab }], 212 | [ 213 | { 214 | label: "⇑", 215 | width: 1.5, 216 | level: 1, 217 | extraClassName: "shift-key-lowercase", 218 | }, 219 | ], 220 | [ 221 | { 222 | label: "Ctrl", 223 | width: 1, 224 | keyval: Clutter.KEY_Control_L, 225 | extraClassName: "control-key", 226 | }, 227 | { 228 | label: "◆", 229 | width: 1, 230 | keyval: Clutter.KEY_Super_L, 231 | extraClassName: "super-key", 232 | }, 233 | { 234 | label: "Alt", 235 | width: 1, 236 | keyval: Clutter.KEY_Alt_L, 237 | extraClassName: "alt-key", 238 | }, 239 | ], 240 | ], 241 | [ 242 | [{ label: "Esc", width: 1, keyval: Clutter.KEY_Escape }], 243 | [{ label: "↹", width: 1.5, keyval: Clutter.KEY_Tab }], 244 | [{ label: "⇑", width: 1.5, level: 0, extraClassName: "shift-key-uppercase" }], 245 | [ 246 | { 247 | label: "Ctrl", 248 | width: 1, 249 | keyval: Clutter.KEY_Control_L, 250 | extraClassName: "control-key", 251 | }, 252 | { 253 | label: "◆", 254 | width: 1, 255 | keyval: Clutter.KEY_Super_L, 256 | extraClassName: "super-key", 257 | }, 258 | { 259 | label: "Alt", 260 | width: 1, 261 | keyval: Clutter.KEY_Alt_L, 262 | extraClassName: "alt-key", 263 | }, 264 | ], 265 | ], 266 | [ 267 | [{ label: "Esc", width: 1, keyval: Clutter.KEY_Escape }], 268 | [{ label: "↹", width: 1.5, keyval: Clutter.KEY_Tab }], 269 | [{ label: "=/= numRows - 2) { 476 | let defaultRow = row - (numRows - 2) + 2; 477 | return [ 478 | defaultKeysPreMod[level][defaultRow], 479 | defaultKeysPostMod[level][defaultRow], 480 | ]; 481 | } else { 482 | return [null, null]; 483 | } 484 | } 485 | 486 | function override_keyboardControllerConstructor() { 487 | let deviceManager = Clutter.DeviceManager.get_default(); 488 | this._virtualDevice = deviceManager.create_virtual_device( 489 | Clutter.InputDeviceType.KEYBOARD_DEVICE 490 | ); 491 | 492 | this._inputSourceManager = InputSourceManager.getInputSourceManager(); 493 | this._sourceChangedId = this._inputSourceManager.connect( 494 | "current-source-changed", 495 | this._onSourceChanged.bind(this) 496 | ); 497 | this._sourcesModifiedId = this._inputSourceManager.connect( 498 | "sources-changed", 499 | this._onSourcesModified.bind(this) 500 | ); 501 | this._currentSource = this._inputSourceManager.currentSource; 502 | 503 | this._controlActive = false; 504 | this._superActive = false; 505 | this._altActive = false; 506 | 507 | Main.inputMethod.connect( 508 | "notify::content-purpose", 509 | this._onContentPurposeHintsChanged.bind(this) 510 | ); 511 | Main.inputMethod.connect( 512 | "notify::content-hints", 513 | this._onContentPurposeHintsChanged.bind(this) 514 | ); 515 | Main.inputMethod.connect("input-panel-state", (o, state) => { 516 | this.emit("panel-state", state); 517 | }); 518 | } 519 | 520 | function override_commitString(string, fromKey) { 521 | // Prevents alpha-numeric key presses from bypassing override_keyvalPress() 522 | // while ctrl/alt/super are latched 523 | if ( 524 | this._controlActive 525 | || this._superActive 526 | || this._altActive 527 | ) { 528 | return false; 529 | } 530 | 531 | if (string == null) return false; 532 | /* Let ibus methods fall through keyval emission */ 533 | if (fromKey && this._currentSource.type == InputSourceManager.INPUT_SOURCE_TYPE_IBUS) return false; 534 | 535 | Main.inputMethod.commit(string); 536 | return true; 537 | } 538 | 539 | // Bulk of this method remains unchanged, except for extraButton.connect('released') event listener. 540 | // Overriding it to ensure latched ctrl/alt/super keys are released before keyboard is hidden 541 | function override_loadDefaultKeys(keys, layout, numLevels, numKeys) { 542 | let extraButton; 543 | for (let i = 0; i < keys.length; i++) { 544 | let key = keys[i]; 545 | let keyval = key.keyval; 546 | let switchToLevel = key.level; 547 | let action = key.action; 548 | let icon = key.icon; 549 | 550 | /* Skip emoji button if necessary */ 551 | if (!this._emojiKeyVisible && action == 'emoji') 552 | continue; 553 | 554 | extraButton = new Keyboard.Key(key.label || '', [], icon); 555 | 556 | extraButton.keyButton.add_style_class_name('default-key'); 557 | if (key.extraClassName != null) 558 | extraButton.keyButton.add_style_class_name(key.extraClassName); 559 | if (key.width != null) 560 | extraButton.setWidth(key.width); 561 | 562 | let actor = extraButton.keyButton; 563 | 564 | extraButton.connect('pressed', () => { 565 | if (switchToLevel != null) { 566 | this._setActiveLayer(switchToLevel); 567 | // Shift only gets latched on long press 568 | this._latched = switchToLevel != 1; 569 | } else if (keyval != null) { 570 | this._keyboardController.keyvalPress(keyval); 571 | } 572 | }); 573 | extraButton.connect('released', () => { 574 | // === Override starts here === 575 | if (keyval != null) return this._keyboardController.keyvalRelease(keyval); 576 | 577 | switch (action) { 578 | case 'hide': 579 | // Press latched ctrl/super/alt keys again to release them before hiding OSK 580 | if (this._keyboardController._controlActive) this._keyboardController.keyvalPress(Clutter.KEY_Control_L); 581 | if (this._keyboardController._superActive) this._keyboardController.keyvalPress(Clutter.KEY_Super_L); 582 | if (this._keyboardController._altActive) this._keyboardController.keyvalPress(Clutter.KEY_Alt_L); 583 | 584 | this.close(); 585 | break; 586 | 587 | case 'languageMenu': 588 | this._popupLanguageMenu(actor); 589 | break; 590 | 591 | case 'emoji': 592 | this._toggleEmoji(); 593 | break; 594 | 595 | // no default 596 | } 597 | // === Override ends here === 598 | }); 599 | 600 | if (switchToLevel == 0) { 601 | layout.shiftKeys.push(extraButton); 602 | } else if (switchToLevel == 1) { 603 | extraButton.connect('long-press', () => { 604 | this._latched = true; 605 | this._setCurrentLevelLatched(this._currentPage, this._latched); 606 | }); 607 | } 608 | 609 | /* Fixup default keys based on the number of levels/keys */ 610 | if (switchToLevel == 1 && numLevels == 3) { 611 | // Hide shift key if the keymap has no uppercase level 612 | if (key.right) { 613 | /* Only hide the key actor, so the container still takes space */ 614 | extraButton.keyButton.hide(); 615 | } else { 616 | extraButton.hide(); 617 | } 618 | extraButton.setWidth(1.5); 619 | } else if (key.right && numKeys > 8) { 620 | extraButton.setWidth(2); 621 | } else if (keyval == Clutter.KEY_Return && numKeys > 9) { 622 | extraButton.setWidth(1.5); 623 | } else if (!this._emojiKeyVisible && (action == 'hide' || action == 'languageMenu')) { 624 | extraButton.setWidth(1.5); 625 | } 626 | 627 | layout.appendKey(extraButton, extraButton.keyButton.keyWidth); 628 | } 629 | } 630 | 631 | function enable_overrides() { 632 | Keyboard.Keyboard.prototype["_relayout"] = override_relayout; 633 | Keyboard.Keyboard.prototype["_loadDefaultKeys"] = override_loadDefaultKeys; 634 | Keyboard.Keyboard.prototype["_getDefaultKeysForRow"] = override_getDefaultKeysForRow; 635 | 636 | Keyboard.KeyboardController.prototype["constructor"] = override_keyboardControllerConstructor; 637 | Keyboard.KeyboardController.prototype["keyvalPress"] = override_keyvalPress; 638 | Keyboard.KeyboardController.prototype["keyvalRelease"] = override_keyvalRelease; 639 | Keyboard.KeyboardController.prototype["commitString"] = override_commitString; 640 | 641 | Keyboard.KeyboardManager.prototype["_lastDeviceIsTouchscreen"] = override_lastDeviceIsTouchScreen; 642 | } 643 | 644 | function disable_overrides() { 645 | Keyboard.Keyboard.prototype["_relayout"] = backup_relayout; 646 | Keyboard.Keyboard.prototype["_loadDefaultKeys"] = backup_loadDefaultKeys; 647 | Keyboard.Keyboard.prototype["_getDefaultKeysForRow"] = backup_DefaultKeysForRow; 648 | 649 | Keyboard.KeyboardController.prototype["constructor"] = backup_keyboardControllerConstructor; 650 | Keyboard.KeyboardController.prototype["keyvalPress"] = backup_keyvalPress; 651 | Keyboard.KeyboardController.prototype["keyvalRelease"] = backup_keyvalRelease; 652 | Keyboard.KeyboardController.prototype["commitString"] = backup_commitString; 653 | 654 | Keyboard.KeyboardManager.prototype["_lastDeviceIsTouchscreen"] = backup_lastDeviceIsTouchScreen; 655 | } 656 | 657 | // Extension 658 | function init() { 659 | backup_relayout = Keyboard.Keyboard.prototype["_relayout"]; 660 | backup_loadDefaultKeys = Keyboard.Keyboard.prototype["_loadDefaultKeys"] 661 | backup_DefaultKeysForRow = Keyboard.Keyboard.prototype["_getDefaultKeysForRow"]; 662 | 663 | backup_keyboardControllerConstructor = Keyboard.KeyboardController.prototype["constructor"]; 664 | backup_keyvalPress = Keyboard.KeyboardController.prototype["keyvalPress"]; 665 | backup_keyvalRelease = Keyboard.KeyboardController.prototype["keyvalRelease"]; 666 | backup_commitString = Keyboard.KeyboardController.prototype["commitString"]; 667 | 668 | backup_lastDeviceIsTouchScreen = Keyboard.KeyboardManager._lastDeviceIsTouchscreen; 669 | } 670 | 671 | function enable() { 672 | settings = ExtensionUtils.getSettings( 673 | "org.gnome.shell.extensions.improvedosk" 674 | ); 675 | _oskA11yApplicationsSettings = new Gio.Settings({ 676 | schema_id: A11Y_APPLICATIONS_SCHEMA, 677 | }); 678 | 679 | Main.layoutManager.removeChrome(Main.layoutManager.keyboardBox); 680 | 681 | // Set up the indicator in the status area 682 | if (settings.get_boolean("show-statusbar-icon")) { 683 | _indicator = new OSKIndicator(); 684 | Main.panel.addToStatusArea("OSKIndicator", _indicator); 685 | } 686 | 687 | let KeyboardIsSetup = true; 688 | try { 689 | Main.keyboard._destroyKeyboard(); 690 | } catch (e) { 691 | if (e instanceof TypeError) { 692 | // In case the keyboard is currently disabled in accessability settings, attempting to _destroyKeyboard() yields a TypeError ("TypeError: this.actor is null") 693 | // This doesn't affect functionality, so proceed as usual. The only difference is that we do not automatically _setupKeyboard at the end of this enable() (let the user enable the keyboard in accessability settings) 694 | KeyboardIsSetup = false; 695 | } else { 696 | // Something different happened 697 | throw e; 698 | } 699 | } 700 | 701 | enable_overrides(); 702 | 703 | settings.connect("changed::show-statusbar-icon", function () { 704 | if (settings.get_boolean("show-statusbar-icon")) { 705 | _indicator = new OSKIndicator(); 706 | Main.panel.addToStatusArea("OSKIndicator", _indicator); 707 | } else if (_indicator !== null) { 708 | _indicator.destroy(); 709 | _indicator = null; 710 | } 711 | }); 712 | 713 | if (KeyboardIsSetup) { 714 | Main.keyboard._setupKeyboard(); 715 | } 716 | 717 | Main.layoutManager.addTopChrome(Main.layoutManager.keyboardBox, { 718 | affectsStruts: settings.get_boolean("resize-desktop"), 719 | trackFullscreen: false, 720 | }); 721 | } 722 | 723 | function disable() { 724 | Main.layoutManager.removeChrome(Main.layoutManager.keyboardBox); 725 | 726 | let KeyboardIsSetup = true; 727 | try { 728 | Main.keyboard._destroyKeyboard(); 729 | } catch (e) { 730 | if (e instanceof TypeError) { 731 | // In case the keyboard is currently disabled in accessability settings, attempting to _destroyKeyboard() yields a TypeError ("TypeError: this.actor is null") 732 | // This doesn't affect functionality, so proceed as usual. The only difference is that we do not automatically _setupKeyboard at the end of this enable() (let the user enable the keyboard in accessability settings) 733 | KeyboardIsSetup = false; 734 | } else { 735 | // Something different happened 736 | throw e; 737 | } 738 | } 739 | 740 | // Remove indicator if it exists 741 | if (_indicator instanceof OSKIndicator) { 742 | _indicator.destroy(); 743 | _indicator = null; 744 | } 745 | 746 | settings = null; 747 | 748 | disable_overrides(); 749 | 750 | if (KeyboardIsSetup) { 751 | Main.keyboard._setupKeyboard(); 752 | } 753 | Main.layoutManager.addTopChrome(Main.layoutManager.keyboardBox); 754 | } 755 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------