🔧 Use dynamic imports for gettext

docs/how-to-create-new-effects.md

@@ -165,8 +165,6 @@ void main() {
 
 "use strict";
 
-const _ = imports.gettext.domain("burn-my-windows").gettext;
-
 import * as utils from "../utils.js";
 
 // We import the ShaderFactory only in the Shell process as it is not required in the
@@ -174,6 +172,8 @@ import * as utils from "../utils.js";
 // only uses the static metadata of the effect.
 const ShaderFactory = await utils.importInShellOnly("./ShaderFactory.js");
 
+const _ = await utils.importGettext();
+
 //////////////////////////////////////////////////////////////////////////////////////////
 // This effect ...                                                                      //
 // <- Please add a description of your effect here ->                                   //

src/effects/Apparition.js

@@ -14,8 +14,6 @@
 
 'use strict';
 
-const _ = imports.gettext.domain('burn-my-windows').gettext;
-
 import * as utils from '../utils.js';
 
 // We import the ShaderFactory only in the Shell process as it is not required in the
@@ -23,6 +21,8 @@ import * as utils from '../utils.js';
 // only uses the static metadata of the effect.
 const ShaderFactory = await utils.importInShellOnly('./ShaderFactory.js');
 
+const _ = await utils.importGettext();
+
 //////////////////////////////////////////////////////////////////////////////////////////
 // This effect hides the actor by violently sucking it into the void of magic.          //
 //////////////////////////////////////////////////////////////////////////////////////////

src/effects/BrokenGlass.js

@@ -14,8 +14,6 @@
 
 'use strict';
 
-const _ = imports.gettext.domain('burn-my-windows').gettext;
-
 import * as utils from '../utils.js';
 
 // We import some modules only in the Shell process as they are not available in the
@@ -26,6 +24,8 @@ const Clutter       = await utils.importInShellOnly('gi://Clutter');
 const GdkPixbuf     = await utils.importInShellOnly('gi://GdkPixbuf');
 const Cogl          = await utils.importInShellOnly('gi://Cogl');
 
+const _ = await utils.importGettext();
+
 //////////////////////////////////////////////////////////////////////////////////////////
 // This effect shatters the window into pieces. For an explanation how this works, look //
 // further down in this file into the documentation of the Shader class. This effect is //

src/effects/Doom.js

@@ -14,8 +14,6 @@
 
 'use strict';
 
-const _ = imports.gettext.domain('burn-my-windows').gettext;
-
 import * as utils from '../utils.js';
 
 // We import the ShaderFactory only in the Shell process as it is not required in the
@@ -23,6 +21,8 @@ import * as utils from '../utils.js';
 // only uses the static metadata of the effect.
 const ShaderFactory = await utils.importInShellOnly('./ShaderFactory.js');
 
+const _ = await utils.importGettext();
+
 //////////////////////////////////////////////////////////////////////////////////////////
 // This effect melts your windows. Inspired by the legendary screen transitions of the  //
 // original Doom.                                                                       //
@@ -32,7 +32,6 @@ const ShaderFactory = await utils.importInShellOnly('./ShaderFactory.js');
 // GNOME Shell versions), to initialize the respective page of the settings dialog, as
 // well as to create the actual shader for the effect.
 export default class Effect {
-
   // The constructor creates a ShaderFactory which will be used by extension.js to create
   // shader instances for this effect. The shaders will be automagically created using the
   // GLSL file in resources/shaders/<nick>.glsl. The callback will be called for each

src/effects/EnergizeA.js

@@ -14,8 +14,6 @@
 
 'use strict';
 
-const _ = imports.gettext.domain('burn-my-windows').gettext;
-
 import * as utils from '../utils.js';
 
 // We import some modules only in the Shell process as they are not available in the
@@ -24,6 +22,8 @@ import * as utils from '../utils.js';
 const ShaderFactory = await utils.importInShellOnly('./ShaderFactory.js');
 const Clutter       = await utils.importInShellOnly('gi://Clutter');
 
+const _ = await utils.importGettext();
+
 //////////////////////////////////////////////////////////////////////////////////////////
 // This effect looks a bit like the transporter effect from TOS.                        //
 //////////////////////////////////////////////////////////////////////////////////////////

src/effects/EnergizeB.js

@@ -14,8 +14,6 @@
 
 'use strict';
 
-const _ = imports.gettext.domain('burn-my-windows').gettext;
-
 import * as utils from '../utils.js';
 
 // We import some modules only in the Shell process as they are not available in the
@@ -24,6 +22,8 @@ import * as utils from '../utils.js';
 const ShaderFactory = await utils.importInShellOnly('./ShaderFactory.js');
 const Clutter       = await utils.importInShellOnly('gi://Clutter');
 
+const _ = await utils.importGettext();
+
 //////////////////////////////////////////////////////////////////////////////////////////
 // This effect looks a bit like the transporter effect from TNG.                        //
 //////////////////////////////////////////////////////////////////////////////////////////

src/effects/Fire.js

@@ -16,8 +16,6 @@
 
 import Gio from 'gi://Gio';
 
-const _ = imports.gettext.domain('burn-my-windows').gettext;
-
 import * as utils from '../utils.js';
 
 // We import some modules only in the Shell process as they are not available in the
@@ -26,6 +24,8 @@ import * as utils from '../utils.js';
 const ShaderFactory = await utils.importInShellOnly('./ShaderFactory.js');
 const Clutter       = await utils.importInShellOnly('gi://Clutter');
 
+const _ = await utils.importGettext();
+
 //////////////////////////////////////////////////////////////////////////////////////////
 // This effect is a homage to the good old Compiz days. However, it is implemented      //
 // quite differently. While Compiz used a particle system, this effect uses a noise     //

src/effects/Glide.js

@@ -14,8 +14,6 @@
 
 'use strict';
 
-const _ = imports.gettext.domain('burn-my-windows').gettext;
-
 import * as utils from '../utils.js';
 
 // We import the ShaderFactory only in the Shell process as it is not required in the
@@ -23,6 +21,8 @@ import * as utils from '../utils.js';
 // only uses the static metadata of the effect.
 const ShaderFactory = await utils.importInShellOnly('./ShaderFactory.js');
 
+const _ = await utils.importGettext();
+
 //////////////////////////////////////////////////////////////////////////////////////////
 // This very simple effect fades the window to transparency with subtle 3D effects.     //
 //////////////////////////////////////////////////////////////////////////////////////////

src/effects/Glitch.js

@@ -14,8 +14,6 @@
 
 'use strict';
 
-const _ = imports.gettext.domain('burn-my-windows').gettext;
-
 import * as utils from '../utils.js';
 
 // We import some modules only in the Shell process as they are not available in the
@@ -24,6 +22,8 @@ import * as utils from '../utils.js';
 const ShaderFactory = await utils.importInShellOnly('./ShaderFactory.js');
 const Clutter       = await utils.importInShellOnly('gi://Clutter');
 
+const _ = await utils.importGettext();
+
 //////////////////////////////////////////////////////////////////////////////////////////
 // This effect applies some intentional graphics issues to your windows.                //
 //////////////////////////////////////////////////////////////////////////////////////////

src/effects/Hexagon.js

@@ -14,8 +14,6 @@
 
 'use strict';
 
-const _ = imports.gettext.domain('burn-my-windows').gettext;
-
 import * as utils from '../utils.js';
 
 // We import some modules only in the Shell process as they are not available in the
@@ -24,6 +22,8 @@ import * as utils from '../utils.js';
 const ShaderFactory = await utils.importInShellOnly('./ShaderFactory.js');
 const Clutter       = await utils.importInShellOnly('gi://Clutter');
 
+const _ = await utils.importGettext();
+
 //////////////////////////////////////////////////////////////////////////////////////////
 // This effect overlays a glowing hexagonal grid over the window. The grid cells then   //
 // gradually shrink until the window is fully dissolved.                                //

src/effects/Incinerate.js

@@ -14,8 +14,6 @@
 
 'use strict';
 
-const _ = imports.gettext.domain('burn-my-windows').gettext;
-
 import * as utils from '../utils.js';
 
 // We import some modules only in the Shell process as they are not available in the
@@ -24,6 +22,8 @@ import * as utils from '../utils.js';
 const ShaderFactory = await utils.importInShellOnly('./ShaderFactory.js');
 const Clutter       = await utils.importInShellOnly('gi://Clutter');
 
+const _ = await utils.importGettext();
+
 //////////////////////////////////////////////////////////////////////////////////////////
 // This effect burns windows to ashes. The fire starts at a random position at the      //
 // window's boundary and then burns through the window in a circular shape.             //

src/effects/Matrix.js

@@ -14,8 +14,6 @@
 
 'use strict';
 
-const _ = imports.gettext.domain('burn-my-windows').gettext;
-
 import * as utils from '../utils.js';
 
 // We import some modules only in the Shell process as they are not available in the
@@ -26,6 +24,8 @@ const Clutter       = await utils.importInShellOnly('gi://Clutter');
 const GdkPixbuf     = await utils.importInShellOnly('gi://GdkPixbuf');
 const Cogl          = await utils.importInShellOnly('gi://Cogl');
 
+const _ = await utils.importGettext();
+
 //////////////////////////////////////////////////////////////////////////////////////////
 // The Matrix shader multiplies a grid of random letters with some gradients which are  //
 // moving from top to bottom. The speed of the moving gradients is chosen randomly.     //

src/effects/PaintBrush.js

@@ -14,8 +14,6 @@
 
 'use strict';
 
-const _ = imports.gettext.domain('burn-my-windows').gettext;
-
 import * as utils from '../utils.js';
 
 // We import some modules only in the Shell process as they are not available in the
@@ -26,6 +24,8 @@ const Clutter       = await utils.importInShellOnly('gi://Clutter');
 const GdkPixbuf     = await utils.importInShellOnly('gi://GdkPixbuf');
 const Cogl          = await utils.importInShellOnly('gi://Cogl');
 
+const _ = await utils.importGettext();
+
 //////////////////////////////////////////////////////////////////////////////////////////
 // This effect paints your windows with a thick paint brush.                            //
 // This effect is not available on GNOME 3.3x, due to the limitation described in the   //

src/effects/PixelWheel.js

@@ -14,8 +14,6 @@
 
 'use strict';
 
-const _ = imports.gettext.domain('burn-my-windows').gettext;
-
 import * as utils from '../utils.js';
 
 // We import the ShaderFactory only in the Shell process as it is not required in the
@@ -23,6 +21,8 @@ import * as utils from '../utils.js';
 // only uses the static metadata of the effect.
 const ShaderFactory = await utils.importInShellOnly('./ShaderFactory.js');
 
+const _ = await utils.importGettext();
+
 //////////////////////////////////////////////////////////////////////////////////////////
 // This simple effect pixelates the window texture and hides the pixels in a wheel-like //
 // fashion.                                                                             //

src/effects/PixelWipe.js

@@ -14,8 +14,6 @@
 
 'use strict';
 
-const _ = imports.gettext.domain('burn-my-windows').gettext;
-
 import * as utils from '../utils.js';
 
 // We import the ShaderFactory only in the Shell process as it is not required in the
@@ -23,6 +21,8 @@ import * as utils from '../utils.js';
 // only uses the static metadata of the effect.
 const ShaderFactory = await utils.importInShellOnly('./ShaderFactory.js');
 
+const _ = await utils.importGettext();
+
 //////////////////////////////////////////////////////////////////////////////////////////
 // This effect pixelates the window texture and hides the pixels radially, starting     //
 // from the pointer position.                                                           //

src/effects/Pixelate.js

@@ -14,8 +14,6 @@
 
 'use strict';
 
-const _ = imports.gettext.domain('burn-my-windows').gettext;
-
 import * as utils from '../utils.js';
 
 // We import the ShaderFactory only in the Shell process as it is not required in the
@@ -23,6 +21,8 @@ import * as utils from '../utils.js';
 // only uses the static metadata of the effect.
 const ShaderFactory = await utils.importInShellOnly('./ShaderFactory.js');
 
+const _ = await utils.importGettext();
+
 //////////////////////////////////////////////////////////////////////////////////////////
 // This very simple effect pixelates the window texture and randomly hides pixels until //
 // the entire window is gone.                                                           //

src/effects/Portal.js

@@ -14,8 +14,6 @@
 
 'use strict';
 
-const _ = imports.gettext.domain('burn-my-windows').gettext;
-
 import * as utils from '../utils.js';
 
 // We import some modules only in the Shell process as they are not available in the
@@ -24,6 +22,8 @@ import * as utils from '../utils.js';
 const ShaderFactory = await utils.importInShellOnly('./ShaderFactory.js');
 const Clutter       = await utils.importInShellOnly('gi://Clutter');
 
+const _ = await utils.importGettext();
+
 //////////////////////////////////////////////////////////////////////////////////////////
 // This ridiculous effect teleports your windows from and to alternative dimensions.    //
 // It may resemble the portal from a well-known cartoon series...                       //

src/effects/SnapOfDisintegration.js

@@ -14,8 +14,6 @@
 
 'use strict';
 
-const _ = imports.gettext.domain('burn-my-windows').gettext;
-
 import * as utils from '../utils.js';
 
 // We import some modules only in the Shell process as they are not available in the
@@ -26,6 +24,8 @@ const Clutter       = await utils.importInShellOnly('gi://Clutter');
 const GdkPixbuf     = await utils.importInShellOnly('gi://GdkPixbuf');
 const Cogl          = await utils.importInShellOnly('gi://Cogl');
 
+const _ = await utils.importGettext();
+
 //////////////////////////////////////////////////////////////////////////////////////////
 // This effects dissolves your windows into a cloud of dust. For this, it uses an       //
 // approach similar to the Broken Glass effect. A dust texture is used to segment the   //

src/effects/TRexAttack.js

@@ -14,8 +14,6 @@
 
 'use strict';
 
-const _ = imports.gettext.domain('burn-my-windows').gettext;
-
 import * as utils from '../utils.js';
 
 // We import some modules only in the Shell process as they are not available in the
@@ -26,6 +24,8 @@ const Clutter       = await utils.importInShellOnly('gi://Clutter');
 const GdkPixbuf     = await utils.importInShellOnly('gi://GdkPixbuf');
 const Cogl          = await utils.importInShellOnly('gi://Cogl');
 
+const _ = await utils.importGettext();
+
 //////////////////////////////////////////////////////////////////////////////////////////
 // This effect tears your windows apart with a series of violent scratches!             //
 // This effect is not available on GNOME 3.3x, due to the limitation described in the   //

src/effects/TVEffect.js

@@ -14,8 +14,6 @@
 
 'use strict';
 
-const _ = imports.gettext.domain('burn-my-windows').gettext;
-
 import * as utils from '../utils.js';
 
 // We import some modules only in the Shell process as they are not available in the
@@ -24,6 +22,8 @@ import * as utils from '../utils.js';
 const ShaderFactory = await utils.importInShellOnly('./ShaderFactory.js');
 const Clutter       = await utils.importInShellOnly('gi://Clutter');
 
+const _ = await utils.importGettext();
+
 //////////////////////////////////////////////////////////////////////////////////////////
 // This effect hides the actor by making it first transparent from top and bottom       //
 // towards the middle and then hiding the resulting line from left and right towards    //

src/effects/TVGlitch.js

@@ -14,8 +14,6 @@
 
 'use strict';
 
-const _ = imports.gettext.domain('burn-my-windows').gettext;
-
 import * as utils from '../utils.js';
 
 // We import some modules only in the Shell process as they are not available in the
@@ -24,6 +22,8 @@ import * as utils from '../utils.js';
 const ShaderFactory = await utils.importInShellOnly('./ShaderFactory.js');
 const Clutter       = await utils.importInShellOnly('gi://Clutter');
 
+const _ = await utils.importGettext();
+
 //////////////////////////////////////////////////////////////////////////////////////////
 // This effect combines the Glitch and the TV Effect. Credits go to Kurt Wilson         //
 // (https://github.com/Kurtoid) for this idea!                                          //

src/effects/Wisps.js

@@ -14,8 +14,6 @@
 
 'use strict';
 
-const _ = imports.gettext.domain('burn-my-windows').gettext;
-
 import * as utils from '../utils.js';
 
 // We import some modules only in the Shell process as they are not available in the
@@ -24,6 +22,8 @@ import * as utils from '../utils.js';
 const ShaderFactory = await utils.importInShellOnly('./ShaderFactory.js');
 const Clutter       = await utils.importInShellOnly('gi://Clutter');
 
+const _ = await utils.importGettext();
+
 //////////////////////////////////////////////////////////////////////////////////////////
 // This effect lets your windows be carried to the realm of dreams by some little       //
 // fairies. It's implemented with several overlaid grids of randomly moving points.     //

src/utils.js

@@ -45,6 +45,26 @@ export async function importInShellOnly(module) {
   return null;
 }
 
+// This method can be used to import a module in the preferences process only. This
+// is useful if you want to use a module in the preferences process, but not in
+// extension.js. This method returns null if it is called in the GNOME Shell process.
+export async function importInPrefsOnly(module) {
+  if (typeof global === 'undefined') {
+    return (await import(module));
+  }
+  return null;
+}
+
+// This method can be used to import gettext. This is done differently in the
+// GNOME Shell process and in the preferences process.
+export async function importGettext() {
+  if (typeof global === 'undefined') {
+    return (await import('resource:///org/gnome/Shell/Extensions/js/extensions/prefs.js'))
+      .gettext;
+  }
+  return (await import('resource:///org/gnome/shell/extensions/extension.js')).gettext;
+}
+
 // Reads the contents of a file contained in the global resources archive. The data
 // is returned as a string.
 export function getStringResource(path) {