From bab4be1a597226a5fe8a29dcf3848be47e16a5e5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Florian=20M=C3=BCllner?= Date: Wed, 6 Feb 2019 15:35:26 +0100 Subject: [PATCH] extensions: Drop Convenience library Its methods are now provided by gnome-shell itself and can be used as an easy drop-in replacement. https://gitlab.gnome.org/GNOME/gnome-shell-extensions/merge_requests/44 --- extensions/apps-menu/extension.js | 4 +- extensions/auto-move-windows/extension.js | 6 +- extensions/auto-move-windows/prefs.js | 6 +- extensions/drive-menu/extension.js | 4 +- extensions/meson.build | 4 +- .../native-window-placement/extension.js | 4 +- extensions/places-menu/extension.js | 3 +- .../screenshot-window-sizer/extension.js | 6 +- extensions/user-theme/extension.js | 4 +- extensions/window-list/extension.js | 5 +- extensions/window-list/prefs.js | 6 +- extensions/workspace-indicator/extension.js | 4 +- extensions/workspace-indicator/prefs.js | 4 +- lib/convenience.js | 94 ------------------- meson.build | 2 - 15 files changed, 19 insertions(+), 137 deletions(-) delete mode 100644 lib/convenience.js diff --git a/extensions/apps-menu/extension.js b/extensions/apps-menu/extension.js index 946cfcb4..845149af 100644 --- a/extensions/apps-menu/extension.js +++ b/extensions/apps-menu/extension.js @@ -21,8 +21,6 @@ const Gettext = imports.gettext.domain('gnome-shell-extensions'); const _ = Gettext.gettext; const ExtensionUtils = imports.misc.extensionUtils; -const Me = ExtensionUtils.getCurrentExtension(); -const Convenience = Me.imports.convenience; const appSys = Shell.AppSystem.get_default(); @@ -763,5 +761,5 @@ function disable() { } function init() { - Convenience.initTranslations(); + ExtensionUtils.initTranslations(); } diff --git a/extensions/auto-move-windows/extension.js b/extensions/auto-move-windows/extension.js index 0d4c81a7..35979971 100644 --- a/extensions/auto-move-windows/extension.js +++ b/extensions/auto-move-windows/extension.js @@ -7,12 +7,10 @@ const Shell = imports.gi.Shell; const Main = imports.ui.main; const ExtensionUtils = imports.misc.extensionUtils; -const Me = ExtensionUtils.getCurrentExtension(); -const Convenience = Me.imports.convenience; class WindowMover { constructor() { - this._settings = Convenience.getSettings(); + this._settings = ExtensionUtils.getSettings(); this._appSystem = Shell.AppSystem.get_default(); this._appConfigs = new Map(); this._appData = new Map(); @@ -113,7 +111,7 @@ let prevCheckWorkspaces; let winMover; function init() { - Convenience.initTranslations(); + ExtensionUtils.initTranslations(); } function myCheckWorkspaces() { diff --git a/extensions/auto-move-windows/prefs.js b/extensions/auto-move-windows/prefs.js index d14d8802..e0aa3b37 100644 --- a/extensions/auto-move-windows/prefs.js +++ b/extensions/auto-move-windows/prefs.js @@ -11,8 +11,6 @@ const _ = Gettext.gettext; const N_ = e => e; const ExtensionUtils = imports.misc.extensionUtils; -const Me = ExtensionUtils.getCurrentExtension(); -const Convenience = Me.imports.convenience; const SETTINGS_KEY = 'application-list'; @@ -33,7 +31,7 @@ const Widget = GObject.registerClass({ super._init(params); this.set_orientation(Gtk.Orientation.VERTICAL); - this._settings = Convenience.getSettings(); + this._settings = ExtensionUtils.getSettings(); this._settings.connect('changed', this._refresh.bind(this)); this._changedPermitted = false; @@ -249,7 +247,7 @@ const Widget = GObject.registerClass({ function init() { - Convenience.initTranslations(); + ExtensionUtils.initTranslations(); } function buildPrefsWidget() { diff --git a/extensions/drive-menu/extension.js b/extensions/drive-menu/extension.js index c4b96c46..89747ec9 100644 --- a/extensions/drive-menu/extension.js +++ b/extensions/drive-menu/extension.js @@ -14,8 +14,6 @@ const PopupMenu = imports.ui.popupMenu; const ShellMountOperation = imports.ui.shellMountOperation; const ExtensionUtils = imports.misc.extensionUtils; -const Me = ExtensionUtils.getCurrentExtension(); -const Convenience = Me.imports.convenience; class MountMenuItem extends PopupMenu.PopupBaseMenuItem { constructor(mount) { @@ -188,7 +186,7 @@ class DriveMenu extends PanelMenu.Button { }); function init() { - Convenience.initTranslations(); + ExtensionUtils.initTranslations(); } let _indicator; diff --git a/extensions/meson.build b/extensions/meson.build index 2b013fc1..d1bf92c9 100644 --- a/extensions/meson.build +++ b/extensions/meson.build @@ -1,5 +1,5 @@ extension_schemas = [] -js_sources = extensionlib +js_sources = [] metadata_name = 'metadata.json' @@ -22,7 +22,7 @@ foreach e : all_extensions js_sources += extension_sources if (enabled_extensions.contains(e)) - install_data (extension_sources + extension_data + extensionlib, + install_data (extension_sources + extension_data, install_dir: join_paths(extensiondir, uuid) ) endif diff --git a/extensions/native-window-placement/extension.js b/extensions/native-window-placement/extension.js index 56ac6e36..faf7fab5 100644 --- a/extensions/native-window-placement/extension.js +++ b/extensions/native-window-placement/extension.js @@ -3,8 +3,6 @@ const Workspace = imports.ui.workspace; const ExtensionUtils = imports.misc.extensionUtils; -const Me = ExtensionUtils.getCurrentExtension(); -const Convenience = Me.imports.convenience; // testing settings for natural window placement strategy: const WINDOW_PLACEMENT_NATURAL_ACCURACY = 20; // accuracy of window translate moves (KDE-default: 20) @@ -242,7 +240,7 @@ function resetState() { function enable() { resetState(); - let settings = Convenience.getSettings(); + let settings = ExtensionUtils.getSettings(); workspaceInjections['_getBestLayout'] = Workspace.Workspace.prototype._getBestLayout; Workspace.Workspace.prototype._getBestLayout = function(windows) { diff --git a/extensions/places-menu/extension.js b/extensions/places-menu/extension.js index 990fe50e..9fced354 100644 --- a/extensions/places-menu/extension.js +++ b/extensions/places-menu/extension.js @@ -15,7 +15,6 @@ const N_ = x => x; const ExtensionUtils = imports.misc.extensionUtils; const Me = ExtensionUtils.getCurrentExtension(); -const Convenience = Me.imports.convenience; const PlaceDisplay = Me.imports.placeDisplay; const PLACE_ICON_SIZE = 16; @@ -124,7 +123,7 @@ class PlacesMenu extends PanelMenu.Button { }); function init() { - Convenience.initTranslations(); + ExtensionUtils.initTranslations(); } let _indicator; diff --git a/extensions/screenshot-window-sizer/extension.js b/extensions/screenshot-window-sizer/extension.js index 4bd63a18..c00fb994 100644 --- a/extensions/screenshot-window-sizer/extension.js +++ b/extensions/screenshot-window-sizer/extension.js @@ -27,8 +27,6 @@ const Main = imports.ui.main; const Tweener = imports.ui.tweener; const ExtensionUtils = imports.misc.extensionUtils; -const Me = ExtensionUtils.getCurrentExtension(); -const Convenience = Me.imports.convenience; const MESSAGE_FADE_TIME = 2; @@ -139,12 +137,12 @@ function cycleScreenshotSizes(display, window, binding) { function enable() { Main.wm.addKeybinding('cycle-screenshot-sizes', - Convenience.getSettings(), + ExtensionUtils.getSettings(), Meta.KeyBindingFlags.PER_WINDOW, Shell.ActionMode.NORMAL, cycleScreenshotSizes); Main.wm.addKeybinding('cycle-screenshot-sizes-backward', - Convenience.getSettings(), + ExtensionUtils.getSettings(), Meta.KeyBindingFlags.PER_WINDOW | Meta.KeyBindingFlags.IS_REVERSED, Shell.ActionMode.NORMAL, diff --git a/extensions/user-theme/extension.js b/extensions/user-theme/extension.js index 4e36e098..9ffaf6fa 100644 --- a/extensions/user-theme/extension.js +++ b/extensions/user-theme/extension.js @@ -9,12 +9,10 @@ const Main = imports.ui.main; const SETTINGS_KEY = 'name'; const ExtensionUtils = imports.misc.extensionUtils; -const Me = ExtensionUtils.getCurrentExtension(); -const Convenience = Me.imports.convenience; class ThemeManager { constructor() { - this._settings = Convenience.getSettings(); + this._settings = ExtensionUtils.getSettings(); } enable() { diff --git a/extensions/window-list/extension.js b/extensions/window-list/extension.js index 3bbf5bb2..e4633e21 100644 --- a/extensions/window-list/extension.js +++ b/extensions/window-list/extension.js @@ -15,7 +15,6 @@ const PopupMenu = imports.ui.popupMenu; const ExtensionUtils = imports.misc.extensionUtils; const Me = ExtensionUtils.getCurrentExtension(); -const Convenience = Me.imports.convenience; const Gettext = imports.gettext.domain('gnome-shell-extensions'); const _ = Gettext.gettext; @@ -883,7 +882,7 @@ class WindowList { this._dndTimeoutId = 0; this._dndWindow = null; - this._settings = Convenience.getSettings(); + this._settings = ExtensionUtils.getSettings(); this._groupingModeChangedId = this._settings.connect('changed::grouping-mode', this._groupingModeChanged.bind(this)); @@ -1200,7 +1199,7 @@ class Extension { enable() { this._windowLists = []; - this._settings = Convenience.getSettings(); + this._settings = ExtensionUtils.getSettings(); this._showOnAllMonitorsChangedId = this._settings.connect('changed::show-on-all-monitors', this._buildWindowLists.bind(this)); diff --git a/extensions/window-list/prefs.js b/extensions/window-list/prefs.js index c36e9459..639ec56b 100644 --- a/extensions/window-list/prefs.js +++ b/extensions/window-list/prefs.js @@ -9,12 +9,10 @@ const Gettext = imports.gettext.domain('gnome-shell-extensions'); const _ = Gettext.gettext; const ExtensionUtils = imports.misc.extensionUtils; -const Me = ExtensionUtils.getCurrentExtension(); -const Convenience = Me.imports.convenience; function init() { - Convenience.initTranslations(); + ExtensionUtils.initTranslations(); } const WindowListPrefsWidget = GObject.registerClass( @@ -38,7 +36,7 @@ class WindowListPrefsWidget extends Gtk.Grid { column_spacing: 6 }); align.add(grid); - this._settings = Convenience.getSettings(); + this._settings = ExtensionUtils.getSettings(); let currentMode = this._settings.get_string('grouping-mode'); let range = this._settings.get_range('grouping-mode'); let modes = range.deep_unpack()[1].deep_unpack(); diff --git a/extensions/workspace-indicator/extension.js b/extensions/workspace-indicator/extension.js index c4e79987..ea891e07 100644 --- a/extensions/workspace-indicator/extension.js +++ b/extensions/workspace-indicator/extension.js @@ -15,8 +15,6 @@ const _ = Gettext.gettext; const Main = imports.ui.main; const ExtensionUtils = imports.misc.extensionUtils; -const Me = ExtensionUtils.getCurrentExtension(); -const Convenience = Me.imports.convenience; const WORKSPACE_SCHEMA = 'org.gnome.desktop.wm.preferences'; const WORKSPACE_KEY = 'workspace-names'; @@ -136,7 +134,7 @@ class WorkspaceIndicator extends PanelMenu.Button { }); function init() { - Convenience.initTranslations(); + ExtensionUtils.initTranslations(); } let _indicator; diff --git a/extensions/workspace-indicator/prefs.js b/extensions/workspace-indicator/prefs.js index 6dd4761d..dae2e957 100644 --- a/extensions/workspace-indicator/prefs.js +++ b/extensions/workspace-indicator/prefs.js @@ -10,8 +10,6 @@ const _ = Gettext.gettext; const N_ = e => e; const ExtensionUtils = imports.misc.extensionUtils; -const Me = ExtensionUtils.getCurrentExtension(); -const Convenience = Me.imports.convenience; const WORKSPACE_SCHEMA = 'org.gnome.desktop.wm.preferences'; const WORKSPACE_KEY = 'workspace-names'; @@ -199,7 +197,7 @@ class WorkspaceSettingsWidget extends Gtk.Grid { }); function init() { - Convenience.initTranslations(); + ExtensionUtils.initTranslations(); } function buildPrefsWidget() { diff --git a/lib/convenience.js b/lib/convenience.js deleted file mode 100644 index af0343a2..00000000 --- a/lib/convenience.js +++ /dev/null @@ -1,94 +0,0 @@ -/* -*- mode: js; js-basic-offset: 4; indent-tabs-mode: nil -*- */ -/* exported initTranslations getSettings */ -/* - Copyright (c) 2011-2012, Giovanni Campagna - - Redistribution and use in source and binary forms, with or without - modification, are permitted provided that the following conditions are met: - * Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in the - documentation and/or other materials provided with the distribution. - * Neither the name of the GNOME nor the - names of its contributors may be used to endorse or promote products - derived from this software without specific prior written permission. - - THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND - ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED - WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE - DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY - DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES - (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; - LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND - ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS - SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -*/ - -const Gettext = imports.gettext; -const Gio = imports.gi.Gio; - -const Config = imports.misc.config; -const ExtensionUtils = imports.misc.extensionUtils; - -/** - * initTranslations: - * @domain: (optional): the gettext domain to use - * - * Initialize Gettext to load translations from extensionsdir/locale. - * If @domain is not provided, it will be taken from metadata['gettext-domain'] - */ -function initTranslations(domain) { - let extension = ExtensionUtils.getCurrentExtension(); - - domain = domain || extension.metadata['gettext-domain']; - - // check if this extension was built with "make zip-file", and thus - // has the locale files in a subfolder - // otherwise assume that extension has been installed in the - // same prefix as gnome-shell - let localeDir = extension.dir.get_child('locale'); - if (localeDir.query_exists(null)) - Gettext.bindtextdomain(domain, localeDir.get_path()); - else - Gettext.bindtextdomain(domain, Config.LOCALEDIR); -} - -/** - * getSettings: - * @schema: (optional): the GSettings schema id - * - * Builds and return a GSettings schema for @schema, using schema files - * in extensionsdir/schemas. If @schema is not provided, it is taken from - * metadata['settings-schema']. - */ -function getSettings(schema) { - let extension = ExtensionUtils.getCurrentExtension(); - - schema = schema || extension.metadata['settings-schema']; - - const GioSSS = Gio.SettingsSchemaSource; - - // check if this extension was built with "make zip-file", and thus - // has the schema files in a subfolder - // otherwise assume that extension has been installed in the - // same prefix as gnome-shell (and therefore schemas are available - // in the standard folders) - let schemaDir = extension.dir.get_child('schemas'); - let schemaSource; - if (schemaDir.query_exists(null)) - schemaSource = GioSSS.new_from_directory(schemaDir.get_path(), - GioSSS.get_default(), - false); - else - schemaSource = GioSSS.get_default(); - - let schemaObj = schemaSource.lookup(schema, true); - if (!schemaObj) - throw new Error( - `Schema ${schema} could not be found for extension ${extension.metadata.uuid}. Please check your installation.` - ); - - return new Gio.Settings({ settings_schema: schemaObj }); -} diff --git a/meson.build b/meson.build index 36464b6a..c320bc6b 100644 --- a/meson.build +++ b/meson.build @@ -20,8 +20,6 @@ schemadir = join_paths(datadir, 'glib-2.0', 'schemas') sessiondir = join_paths(datadir, 'gnome-session', 'sessions') xsessiondir = join_paths(datadir, 'xsessions') -extensionlib = files('lib/convenience.js') - js60 = find_program('js60', required: false) ver_arr = meson.project_version().split('.')