smart-panel v1.4.4: Does not use Mainloop in code - Increased stability (#827)

Author: claudiux

smart-panel@mohammad-sn/files/smart-panel@mohammad-sn/extension.js

@@ -18,7 +18,6 @@ const Clutter = imports.gi.Clutter;
 const GLib = imports.gi.GLib;
 const Lang = imports.lang;
 const Main = imports.ui.main;
-const Mainloop = imports.mainloop;
 const Meta = imports.gi.Meta
 const Settings = imports.ui.settings;
 const St = imports.gi.St;
@@ -34,6 +33,19 @@ const TimelineSwitcher = imports.ui.appSwitcher.timelineSwitcher;
 const ClassicSwitcher = imports.ui.appSwitcher.classicSwitcher;
 const AppSwitcher = imports.ui.appSwitcher.appSwitcher;
 
+const {
+  _sourceIds,
+  timeout_add_seconds,
+  timeout_add,
+  setTimeout,
+  clearTimeout,
+  setInterval,
+  clearInterval,
+  source_exists,
+  source_remove,
+  remove_all_sources
+} = require("./mainloopTools");
+
 
 let newSmartPanelExt = null;
 
@@ -99,6 +111,7 @@ SmartPanelExt.prototype = {
 
     disable: function() {
         this.is_disabled = true;
+        remove_all_sources();
         // FIXME: These lines make Cinnamon unstable!
         //~ if (this.sr != null) this._panel.disconnect(this.sr);
         //~ if (this.en != null) this._panel.disconnect(this.en);
@@ -110,11 +123,16 @@ SmartPanelExt.prototype = {
     enable: function() {
         this._panel.reactive = true;
         this.is_disabled = false;
-        this.sr = this._panel.connect('scroll-event'        , Lang.bind(this, this._onScroll));
-        this.en = this._panel.connect('enter-event'         , Lang.bind(this, this._onEntered));
-        this.lv = this._panel.connect('leave-event'         , Lang.bind(this, this._onLeave));
-        this.bp = this._panel.connect('button-press-event'  , Lang.bind(this, this._onButtonPress));
-        this.br = this._panel.connect('button-release-event', Lang.bind(this, this._onButtonRelease));
+        //~ this.sr = this._panel.connect('scroll-event'        , Lang.bind(this, this._onScroll));
+        //~ this.en = this._panel.connect('enter-event'         , Lang.bind(this, this._onEntered));
+        //~ this.lv = this._panel.connect('leave-event'         , Lang.bind(this, this._onLeave));
+        //~ this.bp = this._panel.connect('button-press-event'  , Lang.bind(this, this._onButtonPress));
+        //~ this.br = this._panel.connect('button-release-event', Lang.bind(this, this._onButtonRelease));
+        this.sr = this._panel.connect('scroll-event'        , (actor, event) => { this._onScroll(actor, event) });
+        this.en = this._panel.connect('enter-event'         , (actor, event) => { this._onEntered(actor, event) });
+        this.lv = this._panel.connect('leave-event'         , (actor, event) => { this._onLeave(actor, event) });
+        this.bp = this._panel.connect('button-press-event'  , (actor, event) => { this._onButtonPress(actor, event) });
+        this.br = this._panel.connect('button-release-event', (actor, event) => { this._onButtonRelease(actor, event) });
     },
 
     _onEntered : function(actor, event) {
@@ -146,7 +164,7 @@ SmartPanelExt.prototype = {
             }
             else{
                 this.dblb = true;
-                Mainloop.timeout_add(this.dblb_T, Lang.bind(this,function() { this.dblb = false; }));
+                timeout_add(this.dblb_T, () => { this.dblb = false; });
             }
         }
         else if (button == 2) {
@@ -361,13 +379,15 @@ SmartPanelExt.prototype = {
                         if (!this._switcherIsRuning) new myCoverflowSwitcher(this);
                         this._switcherIsRuning = true;
                         let delay = global.settings.get_int("alttab-switcher-delay");
-                        Mainloop.timeout_add(delay, Lang.bind(this, function(){ this._switcherIsRuning = false; }));
+                        //~ timeout_add(delay, Lang.bind(this, function(){ this._switcherIsRuning = false; }));
+                        timeout_add(delay, () => { this._switcherIsRuning = false; });
                     }
                     else if (style == 'timeline'){
                         if (!this._switcherIsRuning) new myTimelineSwitcher(this);
                         this._switcherIsRuning = true;
                         let delay = global.settings.get_int("alttab-switcher-delay");
-                        Mainloop.timeout_add(delay, Lang.bind(this, function(){ this._switcherIsRuning = false; }));
+                        //~ timeout_add(delay, Lang.bind(this, function(){ this._switcherIsRuning = false; }));
+                        timeout_add(delay, () => { this._switcherIsRuning = false; });
                     }
                     else {
                         new myClassicSwitcher(this);
@@ -519,9 +539,12 @@ myClassicSwitcher.prototype = {
 
         this._updateList(0);
 
-        this.actor.connect('get-preferred-width', Lang.bind(this, this._getPreferredWidth));
-        this.actor.connect('get-preferred-height', Lang.bind(this, this._getPreferredHeight));
-        this.actor.connect('allocate', Lang.bind(this, this._allocate));
+        //~ this.actor.connect('get-preferred-width', Lang.bind(this, this._getPreferredWidth));
+        //~ this.actor.connect('get-preferred-height', Lang.bind(this, this._getPreferredHeight));
+        //~ this.actor.connect('allocate', Lang.bind(this, this._allocate));
+        this.actor.connect('get-preferred-width', () => { this._getPreferredWidth() });
+        this.actor.connect('get-preferred-height', () => { this._getPreferredHeight() });
+        this.actor.connect('allocate', () => { this._allocate() });
 
         // Need to force an allocation so we can figure out whether we
         // need to scroll when selecting
@@ -537,12 +560,16 @@ myClassicSwitcher.prototype = {
         else {
             this._disableHover();
 
-            this.actor.connect('key-press-event', Lang.bind(this, this._keyPressEvent));
-            this.actor.connect('key-release-event', Lang.bind(this, this._keyReleaseEvent));
-            this.actor.connect('scroll-event', Lang.bind(this, this._scrollEvent));
-            this.actor.connect('button-press-event', Lang.bind(this, this.owndestroy));
+            //~ this.actor.connect('key-press-event', Lang.bind(this, this._keyPressEvent));
+            //~ this.actor.connect('key-release-event', Lang.bind(this, this._keyReleaseEvent));
+            //~ this.actor.connect('scroll-event', Lang.bind(this, this._scrollEvent));
+            //~ this.actor.connect('button-press-event', Lang.bind(this, this.owndestroy));
+            this.actor.connect('key-press-event', () => { this._keyPressEvent() });
+            this.actor.connect('key-release-event', () => { this._keyReleaseEvent() });
+            this.actor.connect('scroll-event', () => { this._scrollEvent() });
+            this.actor.connect('button-press-event', () => { this.owndestroy() });
             let delay = global.settings.get_int("alttab-switcher-delay");
-            this._initialDelayTimeoutId = Mainloop.timeout_add(delay, Lang.bind(this, this._show));
+            this._initialDelayTimeoutId = timeout_add(delay, () => { this._show() });
             this._currentIndex--;
         }
         return this._haveModal;
@@ -580,12 +607,16 @@ myTimelineSwitcher.prototype = {
         else {
             this._disableHover();
 
-            this.actor.connect('key-press-event', Lang.bind(this, this._keyPressEvent));
-            this.actor.connect('key-release-event', Lang.bind(this, this._keyReleaseEvent));
-            this.actor.connect('scroll-event', Lang.bind(this, this._scrollEvent));
-            this.actor.connect('button-press-event', Lang.bind(this, this.owndestroy));
+            //~ this.actor.connect('key-press-event', Lang.bind(this, this._keyPressEvent));
+            //~ this.actor.connect('key-release-event', Lang.bind(this, this._keyReleaseEvent));
+            //~ this.actor.connect('scroll-event', Lang.bind(this, this._scrollEvent));
+            //~ this.actor.connect('button-press-event', Lang.bind(this, this.owndestroy));
+            this.actor.connect('key-press-event', () => { this._keyPressEvent() });
+            this.actor.connect('key-release-event', () => { this._keyReleaseEvent() });
+            this.actor.connect('scroll-event', () => { this._scrollEvent() });
+            this.actor.connect('button-press-event', () => { this.owndestroy() });
             let delay = global.settings.get_int("alttab-switcher-delay");
-            this._initialDelayTimeoutId = Mainloop.timeout_add(delay, Lang.bind(this, this._show));
+            this._initialDelayTimeoutId = timeout_add(delay, () => { this._show() });
             this._currentIndex--;
         }
         return this._haveModal;
@@ -624,12 +655,16 @@ myCoverflowSwitcher.prototype = {
         else {
             this._disableHover();
 
-            this.actor.connect('key-press-event', Lang.bind(this, this._keyPressEvent));
-            this.actor.connect('key-release-event', Lang.bind(this, this._keyReleaseEvent));
-            this.actor.connect('scroll-event', Lang.bind(this, this._scrollEvent));
-            this.actor.connect('button-press-event', Lang.bind(this, this.owndestroy));
+            //~ this.actor.connect('key-press-event', Lang.bind(this, this._keyPressEvent));
+            //~ this.actor.connect('key-release-event', Lang.bind(this, this._keyReleaseEvent));
+            //~ this.actor.connect('scroll-event', Lang.bind(this, this._scrollEvent));
+            //~ this.actor.connect('button-press-event', Lang.bind(this, this.owndestroy));
+            this.actor.connect('key-press-event', () => { this._keyPressEvent() });
+            this.actor.connect('key-release-event', () => { this._keyReleaseEvent() });
+            this.actor.connect('scroll-event', () => { this._scrollEvent() });
+            this.actor.connect('button-press-event', () => { this.owndestroy() });
             let delay = global.settings.get_int("alttab-switcher-delay");
-            this._initialDelayTimeoutId = Mainloop.timeout_add(delay, Lang.bind(this, this._show));
+            this._initialDelayTimeoutId = timeout_add(delay, () => { this._show() });
             this._currentIndex--;
         }
         return this._haveModal;

smart-panel@mohammad-sn/files/smart-panel@mohammad-sn/mainloopTools.js

@@ -0,0 +1,179 @@
+const  GLib = imports.gi.GLib;
+
+/**
+ * _sourceIds
+ * Array containing IDs of all looping loops.
+ */
+var _sourceIds = [];
+
+/**
+ * timeout_add_seconds
+ *
+ * @callback (function) is executed every @sec (number) seconds
+ * with @params (dictionnary as {'key1': value1, 'key2': value2, ...}).
+ *
+ * @params is often null.
+ *
+ */
+function timeout_add_seconds(sec, callback, params=null) {
+  let id = GLib.timeout_add_seconds(GLib.PRIORITY_DEFAULT, sec, callback);
+  if (id && (_sourceIds.indexOf(id) === -1)) _sourceIds.push(id);
+  return id;
+}
+
+/**
+ * timeout_add_seconds
+ *
+ * @callback (function) is executed every @ms (number) milliseconds
+ * with @params (dictionnary as {'key1': value1, 'key2': value2, ...}).
+ *
+ * @params is often null.
+ *
+ */
+function timeout_add(ms, callback, params=null) {
+  let id = GLib.timeout_add(GLib.PRIORITY_DEFAULT, ms, callback);
+  if (id && (_sourceIds.indexOf(id) === -1)) _sourceIds.push(id);
+  return id;
+}
+
+/**
+ * setTimeout:
+ * @callback (function): Function to call at the end of the timeout.
+ * @ms (number): Milliseconds until the timeout expires.
+ *
+ * Convenience wrapper for a Mainloop.timeout_add loop that
+ * returns false.
+ *
+ * Returns (number): The ID of the loop.
+ */
+function setTimeout(callback, ms) {
+    let args = [];
+    if (arguments.length > 2) {
+        args = args.slice.call(arguments, 2);
+    }
+
+    let id = GLib.timeout_add(GLib.PRIORITY_DEFAULT,
+      ms,
+      () => {
+        callback.call(null, ...args);
+        return false; // Stop repeating
+      }
+    );
+
+    if (id && (_sourceIds.indexOf(id) === -1)) _sourceIds.push(id);
+
+    return id;
+}
+
+/**
+ * clearTimeout:
+ * @id (number): The ID of the loop to remove.
+ *
+ * Convenience wrapper for Mainloop.source_remove.
+ */
+function clearTimeout(id) {
+    if (id) {
+      source_remove(id);
+    }
+}
+
+
+/**
+ * setInterval:
+ * @callback (function): Function to call on every interval.
+ * @ms (number): Milliseconds between invocations.
+ *
+ * Convenience wrapper for a Mainloop.timeout_add loop that
+ * returns true.
+ *
+ * Returns (number): The ID of the loop.
+ */
+function setInterval(callback, ms) {
+    let args = [];
+    if (arguments.length > 2) {
+        args = args.slice.call(arguments, 2);
+    }
+
+    let id = GLib.timeout_add(GLib.PRIORITY_DEFAULT, ms, () => {
+        callback.call(null, ...args);
+        return true; // Repeat
+    });
+
+    if (id && (_sourceIds.indexOf(id) === -1)) _sourceIds.push(id);
+
+    return id;
+}
+
+/**
+ * clearInterval:
+ * @id (number): The ID of the loop to remove.
+ *
+ * Convenience wrapper for Mainloop.source_remove.
+ */
+function clearInterval(id) {
+    if (id) {
+      source_remove(id);
+    }
+};
+
+/**
+ * source_exists
+ *
+ * @id (number, or null)
+ *
+ * Checks if @id is well the ID of a loop.
+ *
+ */
+function source_exists(id) {
+  let _id = id;
+  if (!_id) return false;
+  return (GLib.MainContext.default().find_source_by_id(_id) != null);
+}
+
+/**
+ * source_remove
+ *
+ * @id (number): The ID of the loop to stop.
+ * @remove_from_sourceIds (boolean): *true* (by default) when we want to
+ * remove @id from _sourceIds. May be *false* for internal functionning.
+ *
+ * Convenience wrapper for a Mainloop.source_remove(id) that returns a
+ * boolean.
+ */
+function source_remove(id, remove_from_sourceIds=true) {
+  if (source_exists(id)) {
+    GLib.source_remove(id);
+    if (remove_from_sourceIds) {
+      const pos = _sourceIds.indexOf(id);
+      if (pos > -1) _sourceIds.splice(pos, 1);
+    }
+    return true;
+  }
+  return false;
+}
+
+/**
+ * remove_all_sources
+ *
+ * Execute it when removing the spice.
+ * Tries to delete all remaining sources, in order to remove all loops.
+ */
+function remove_all_sources() {
+  while (_sourceIds.length > 0) {
+    let id = _sourceIds.pop();
+    source_remove(id, false);
+  }
+}
+
+module.exports = {
+  _sourceIds,
+  timeout_add_seconds,
+  timeout_add,
+  setTimeout,
+  clearTimeout,
+  setInterval,
+  clearInterval,
+  source_exists,
+  source_remove,
+  remove_all_sources
+}

smart-panel@mohammad-sn/files/smart-panel@mohammad-sn/metadata.json

@@ -23,7 +23,7 @@
   ],
   "description": "Switch between workspaces, show desktop, activate overview or expo, ... by scrolling, double click, mouse gestures etc on free space of the panel.",
   "name": "Smart Panel",
-  "version": "1.4.3",
+  "version": "1.4.4",
   "uuid": "smart-panel@mohammad-sn",
   "url": "https://cinnamon-spices.linuxmint.com/extensions/view/80",
   "author": "mohammad-sn"