ZenBrowserMirrors/components
1
0
Fork 0
mirror of https://github.com/zen-browser/components.git synced 2025-07-08 16:59:59 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Refactor ZenWorkspaces shortcutSwitchTo method to handle out of bounds index gracefully

Browse source
This commit is contained in:
mauro-balades 2024-09-24 16:47:42 +02:00
parent c65b4aef13
commit 53b7f6eecc
2 changed files with 296 additions and 196 deletions
Download patch file Download diff file Expand all files Collapse all files

485
src/ZenKeyboardShortcuts.mjs
View file

@ -95,41 +95,50 @@ const VALID_SHORTCUT_GROUPS = [
]; ];
class KeyShortcutModifiers { class KeyShortcutModifiers {
#ctrl = false; #control = false;
#alt = false; #alt = false;
#shift = false; #shift = false;
#meta = false; #meta = false;
#accel = false;
constructor(ctrl, alt, shift, meta) { constructor(ctrl, alt, shift, meta, accel) {
this.#ctrl = ctrl; this.#control = ctrl;
this.#alt = alt; this.#alt = alt;
this.#shift = shift; this.#shift = shift;
this.#meta = meta; this.#meta = meta;
this.#accel = accel;
if (AppConstants.platform != 'macosx') {
// Replace control with accel, to make it more consistent
this.#accel = ctrl || accel;
this.#control = false;
}
} }
static parseFromJSON(modifiers) { static parseFromJSON(modifiers) {
if (!modifiers) { if (!modifiers) {
return new KeyShortcutModifiers(false, false, false, false); return new KeyShortcutModifiers(false, false, false, false, false);
} }
return new KeyShortcutModifiers( return new KeyShortcutModifiers(
modifiers['ctrl'] == true, modifiers['control'] == true,
modifiers['alt'] == true, modifiers['alt'] == true,
modifiers['shift'] == true, modifiers['shift'] == true,
modifiers['meta'] == true || modifiers['accel'] == true modifiers['meta'] == true,
modifiers['accel'] == true
); );
} }
static parseFromXHTMLAttribute(modifiers) { static parseFromXHTMLAttribute(modifiers) {
if (!modifiers) { if (!modifiers) {
return new KeyShortcutModifiers(false, false, false, false); return new KeyShortcutModifiers(false, false, false, false, false);
} }
return new KeyShortcutModifiers( return new KeyShortcutModifiers(
modifiers.includes('control') || modifiers.includes('accel'), modifiers.includes('control'),
modifiers.includes('alt'), modifiers.includes('alt'),
modifiers.includes('shift'), modifiers.includes('shift'),
modifiers.includes('meta') modifiers.includes('meta'),
modifiers.includes('accel')
); );
} }
@ -140,7 +149,7 @@ class KeyShortcutModifiers {
toUserString() { toUserString() {
let str = ''; let str = '';
if (this.#ctrl) { if (this.#control) {
str += 'Ctrl+'; str += 'Ctrl+';
} }
if (this.#alt) { if (this.#alt) {
@ -152,6 +161,13 @@ class KeyShortcutModifiers {
if (this.#meta) { if (this.#meta) {
str += AppConstants.platform == 'macosx' ? 'Cmd+' : 'Win+'; str += AppConstants.platform == 'macosx' ? 'Cmd+' : 'Win+';
} }
if (this.#accel) {
if (AppConstants.platform == 'macosx') {
str += 'Cmd+';
} else {
str += 'Ctrl+';
}
}
return str; return str;
} }
@ -160,17 +176,18 @@ class KeyShortcutModifiers {
return false; return false;
} }
return ( return (
this.#ctrl == other.#ctrl &&
this.#alt == other.#alt && this.#alt == other.#alt &&
this.#shift == other.#shift && this.#shift == other.#shift &&
this.#meta == other.#meta this.#meta == other.#meta &&
this.#accel == other.#accel &&
this.#control == other.#control
); );
} }
toString() { toString() {
let str = ''; let str = '';
if (this.#ctrl) { if (this.#control) {
str += 'accel,'; str += 'control,';
} }
if (this.#alt) { if (this.#alt) {
str += 'alt,'; str += 'alt,';
@ -178,23 +195,27 @@ class KeyShortcutModifiers {
if (this.#shift) { if (this.#shift) {
str += 'shift,'; str += 'shift,';
} }
if (this.#meta) { if (this.#accel) {
str += 'meta'; str += 'accel,';
} }
return str; if (this.#meta) {
str += 'meta,';
}
return str.slice(0, -1);
} }
toJSONString() { toJSONString() {
return { return {
ctrl: this.#ctrl, control: this.#control,
alt: this.#alt, alt: this.#alt,
shift: this.#shift, shift: this.#shift,
meta: this.#meta, meta: this.#meta,
accel: this.#accel,
}; };
} }
areAnyActive() { areAnyActive() {
return this.#ctrl || this.#alt || this.#shift || this.#meta; return this.#control || this.#alt || this.#shift || this.#meta || this.#accel;
} }
} }
@ -203,7 +224,7 @@ class KeyShortcut {
#key = ''; #key = '';
#keycode = ''; #keycode = '';
#group = FIREFOX_SHORTCUTS_GROUP; #group = FIREFOX_SHORTCUTS_GROUP;
#modifiers = new KeyShortcutModifiers(false, false, false, false); #modifiers = new KeyShortcutModifiers(false, false, false, false, false);
#action = ''; #action = '';
#l10nId = ''; #l10nId = '';
#disabled = false; #disabled = false;
@ -440,35 +461,260 @@ class KeyShortcut {
} }
} }
var gZenKeyboardShortcutsStorage = new class { class ZenKeyboardShortcutsLoader {
init() {} #shortcutsDirtyCache = {};
constructor() {
this.#shortcutsDirtyCache = {};
}
get shortcutsFile() { get shortcutsFile() {
return PathUtils.join(PathUtils.profileDir, 'zen-keyboard-shortcuts.json'); return PathUtils.join(PathUtils.profileDir, 'zen-keyboard-shortcuts.json');
} }
async save(data) { async save(data) {
await IOUtils.writeJSON(this.shortcutsFile, {shortcuts: data}); await IOUtils.writeJSON(this.shortcutsFile, data);
this.#shortcutsDirtyCache = data;
} }
async load() { async loadObject(withoutCache = false) {
if (this.#shortcutsDirtyCache && !withoutCache) {
return this.#shortcutsDirtyCache;
}
try { try {
return (await IOUtils.readJSON(this.shortcutsFile)).shortcuts; this.#shortcutsDirtyCache = await IOUtils.readJSON(this.shortcutsFile);
return this.#shortcutsDirtyCache;
} catch (e) { } catch (e) {
console.error('Error loading shortcuts file', e); console.error('Error loading shortcuts file', e);
return null; return null;
} }
} }
async load(withoutCache = false) {
return (await this.loadObject(withoutCache))?.shortcuts;
}
}
function zenGetDefaultShortcuts() {
// DO NOT CHANGE ANYTHING HERE
// For adding new default shortcuts, add them to inside the migration function
// and increment the version number.
console.info('Zen CKS: Loading default shortcuts...');
let keySet = document.getElementById('mainKeyset');
let newShortcutList = [];
// Firefox's standard keyset
for (let key of keySet.children) {
let parsed = KeyShortcut.parseFromXHTML(key);
newShortcutList.push(parsed);
}
// Compact mode's keyset
newShortcutList.push(
new KeyShortcut(
'zen-compact-mode-toggle',
'C',
'',
ZEN_COMPACT_MODE_SHORTCUTS_GROUP,
KeyShortcutModifiers.fromObject({ctrl: true, alt: true}),
'code:gZenCompactModeManager.toggle()',
'zen-compact-mode-shortcut-toggle'
)
);
newShortcutList.push(
new KeyShortcut(
'zen-compact-mode-show-sidebar',
'S',
'',
ZEN_COMPACT_MODE_SHORTCUTS_GROUP,
KeyShortcutModifiers.fromObject({ctrl: true, alt: true}),
'code:gZenCompactModeManager.toggleSidebar()',
'zen-compact-mode-shortcut-show-sidebar'
)
);
newShortcutList.push(
new KeyShortcut(
'zen-compact-mode-show-toolbar',
'T',
'',
ZEN_COMPACT_MODE_SHORTCUTS_GROUP,
KeyShortcutModifiers.fromObject({ctrl: true, alt: true}),
'code:gZenCompactModeManager.toggleToolbar()',
'zen-compact-mode-shortcut-show-toolbar'
)
);
// Workspace's keyset
for (let i = 10; i > 0; i--) {
newShortcutList.push(
new KeyShortcut(
`zen-workspace-switch-${i}`,
'',
'',
ZEN_WORKSPACE_SHORTCUTS_GROUP,
KeyShortcutModifiers.fromObject({}),
`code:ZenWorkspaces.shortcutSwitchTo(${i - 1})`,
`zen-workspace-shortcut-switch-${i}`
)
);
}
newShortcutList.push(
new KeyShortcut(
'zen-workspace-forward',
'E',
'',
ZEN_WORKSPACE_SHORTCUTS_GROUP,
KeyShortcutModifiers.fromObject({ctrl: true, alt: true}),
'code:ZenWorkspaces.changeWorkspaceShortcut()',
'zen-workspace-shortcut-forward'
)
);
newShortcutList.push(
new KeyShortcut(
'zen-workspace-backward',
'Q',
'',
ZEN_WORKSPACE_SHORTCUTS_GROUP,
KeyShortcutModifiers.fromObject({ctrl: true, alt: true}),
'code:ZenWorkspaces.changeWorkspaceShortcut(-1)',
'zen-workspace-shortcut-backward'
)
);
// Other keyset
newShortcutList.push(
new KeyShortcut(
'zen-toggle-web-panel',
'P',
'',
ZEN_OTHER_SHORTCUTS_GROUP,
KeyShortcutModifiers.fromObject({alt: true}),
'code:gZenBrowserManagerSidebar.toggle()',
'zen-web-panel-shortcut-toggle'
)
);
newShortcutList.push(
new KeyShortcut(
'zen-toggle-sidebar',
'B',
'',
ZEN_OTHER_SHORTCUTS_GROUP,
KeyShortcutModifiers.fromObject({alt: true}),
'code:gZenVerticalTabsManager.toggleExpand()',
'zen-sidebar-shortcut-toggle'
)
);
// Split view
newShortcutList.push(
new KeyShortcut(
'zen-split-view-grid',
'G',
'',
ZEN_SPLIT_VIEW_SHORTCUTS_GROUP,
KeyShortcutModifiers.fromObject({ctrl: true, alt: true}),
'code:gZenViewSplitter.toggleShortcut(\'grid\')',
'zen-split-view-shortcut-grid'
)
);
newShortcutList.push(
new KeyShortcut(
'zen-split-view-vertical',
'V',
'',
ZEN_SPLIT_VIEW_SHORTCUTS_GROUP,
KeyShortcutModifiers.fromObject({ctrl: true, alt: true}),
'code:gZenViewSplitter.toggleShortcut(\'vsep\')',
'zen-split-view-shortcut-vertical'
)
);
newShortcutList.push(
new KeyShortcut(
'zen-split-view-horizontal',
'H',
'',
ZEN_SPLIT_VIEW_SHORTCUTS_GROUP,
KeyShortcutModifiers.fromObject({ctrl: true, alt: true}),
'code:gZenViewSplitter.toggleShortcut(\'hsep\')',
'zen-split-view-shortcut-horizontal'
)
);
newShortcutList.push(
new KeyShortcut(
'zen-split-view-unsplit',
'U',
'',
ZEN_SPLIT_VIEW_SHORTCUTS_GROUP,
KeyShortcutModifiers.fromObject({ctrl: true, alt: true}),
'code:gZenViewSplitter.toggleShortcut(\'unsplit\')',
'zen-split-view-shortcut-unsplit'
)
);
return newShortcutList;
}
class ZenKeyboardShortcutsVersioner {
static LATEST_KBS_VERSION = 1.0;
#loadedVersion = 0.0;
constructor(versionedData) {
this.#loadedVersion = versionedData.version ?? 0.0;
}
getVersionedData(data) {
return {
version: this.#loadedVersion,
shortcuts: data,
};
}
isVersionUpToDate() {
return this.#loadedVersion == ZenKeyboardShortcutsVersioner.LATEST_KBS_VERSION;
}
isVersionOutdated() {
return this.#loadedVersion < ZenKeyboardShortcutsVersioner.LATEST_KBS_VERSION;
}
migrateIfNeeded(data) {
if (this.isVersionUpToDate()) {
return data;
}
if (this.isVersionOutdated()) {
console.info('Zen CKS: Migrating shortcuts from version', this.#loadedVersion, 'to', ZenKeyboardShortcutsVersioner.LATEST_KBS_VERSION);
const newData = this.migrate(data);
this.#loadedVersion = ZenKeyboardShortcutsVersioner.LATEST_KBS_VERSION;
return newData;
}
throw new Error('Unknown keyboar shortcuts version');
}
migrate(data) {
if (this.#loadedVersion < 1.0) {
// Migrate from 0.0 to 1.0
// Here, we do a complet reset of the shortcuts,
// since nothing seems to work properly.
return zenGetDefaultShortcuts();
}
return data;
}
} }
var gZenKeyboardShortcutsManager = { var gZenKeyboardShortcutsManager = {
loader: new ZenKeyboardShortcutsLoader(),
async init() { async init() {
if (window.location.href == 'chrome://browser/content/browser.xhtml') { if (window.location.href == 'chrome://browser/content/browser.xhtml') {
await SessionStore.promiseInitialized; await SessionStore.promiseInitialized;
console.info('Zen CKS: Initializing shortcuts'); console.info('Zen CKS: Initializing shortcuts');
this._currentShortcutList = await this._loadSaved(); const loadedShortcuts = await this._loadSaved();
this._currentShortcutList = this.versioner.migrateIfNeeded(loadedShortcuts);
this._applyShortcuts(); this._applyShortcuts();
await this._saveShortcuts(); await this._saveShortcuts();
@ -477,175 +723,26 @@ var gZenKeyboardShortcutsManager = {
} }
}, },
async _loadSaved() { async _loadSaved(withoutCache = false) {
let data = await gZenKeyboardShortcutsStorage.load(); var innerLoad = async() => {
if (!data || data.length == 0) { let data = await this.loader.load(withoutCache);
return this._loadDefaults(); if (!data || data.length == 0) {
return zenGetDefaultShortcuts();
}
try {
return KeyShortcut.parseFromSaved(data);
} catch (e) {
console.error('Zen CKS: Error parsing saved shortcuts. Resetting to defaults...', e);
return zenGetDefaultShortcuts();
}
} }
try { const loadedShortcuts = await innerLoad();
return KeyShortcut.parseFromSaved(data); this.versioner = new ZenKeyboardShortcutsVersioner(
} catch (e) { loadedShortcuts,
console.error('Zen CKS: Error parsing saved shortcuts. Resetting to defaults...', e);
return this._loadDefaults();
}
},
_loadDefaults() {
console.info('Zen CKS: Loading default shortcuts...');
let keySet = document.getElementById('mainKeyset');
let newShortcutList = [];
// Firefox's standard keyset
for (let key of keySet.children) {
let parsed = KeyShortcut.parseFromXHTML(key);
newShortcutList.push(parsed);
}
// Compact mode's keyset
newShortcutList.push(
new KeyShortcut(
'zen-compact-mode-toggle',
'C',
'',
ZEN_COMPACT_MODE_SHORTCUTS_GROUP,
KeyShortcutModifiers.fromObject({ctrl: true, alt: true}),
'code:gZenCompactModeManager.toggle()',
'zen-compact-mode-shortcut-toggle'
)
); );
newShortcutList.push( return loadedShortcuts;
new KeyShortcut(
'zen-compact-mode-show-sidebar',
'S',
'',
ZEN_COMPACT_MODE_SHORTCUTS_GROUP,
KeyShortcutModifiers.fromObject({ctrl: true, alt: true}),
'code:gZenCompactModeManager.toggleSidebar()',
'zen-compact-mode-shortcut-show-sidebar'
)
);
newShortcutList.push(
new KeyShortcut(
'zen-compact-mode-show-toolbar',
'T',
'',
ZEN_COMPACT_MODE_SHORTCUTS_GROUP,
KeyShortcutModifiers.fromObject({ctrl: true, alt: true}),
'code:gZenCompactModeManager.toggleToolbar()',
'zen-compact-mode-shortcut-show-toolbar'
)
);
// Workspace's keyset
// TODO:
for (let i = 10; i > 0; i--) {
newShortcutList.push(
new KeyShortcut(
`zen-workspace-switch-${i}`,
'',
'',
ZEN_WORKSPACE_SHORTCUTS_GROUP,
KeyShortcutModifiers.fromObject({}),
`code:ZenWorkspaces.shortcutSwitchTo(${i - 1})`,
`zen-workspace-shortcut-switch-${i}`
)
);
}
newShortcutList.push(
new KeyShortcut(
'zen-workspace-forward',
'E',
'',
ZEN_WORKSPACE_SHORTCUTS_GROUP,
KeyShortcutModifiers.fromObject({ctrl: true, alt: true}),
'code:ZenWorkspaces.changeWorkspaceShortcut()',
'zen-workspace-shortcut-forward'
)
);
newShortcutList.push(
new KeyShortcut(
'zen-workspace-backward',
'Q',
'',
ZEN_WORKSPACE_SHORTCUTS_GROUP,
KeyShortcutModifiers.fromObject({ctrl: true, alt: true}),
'code:ZenWorkspaces.changeWorkspaceShortcut(-1)',
'zen-workspace-shortcut-backward'
)
);
// Other keyset
newShortcutList.push(
new KeyShortcut(
'zen-toggle-web-panel',
'P',
'',
ZEN_OTHER_SHORTCUTS_GROUP,
KeyShortcutModifiers.fromObject({alt: true}),
'code:gZenBrowserManagerSidebar.toggle()',
'zen-web-panel-shortcut-toggle'
)
);
newShortcutList.push(
new KeyShortcut(
'zen-toggle-sidebar',
'B',
'',
ZEN_OTHER_SHORTCUTS_GROUP,
KeyShortcutModifiers.fromObject({alt: true}),
'code:gZenVerticalTabsManager.toggleExpand()',
'zen-sidebar-shortcut-toggle'
)
);
// Split view
newShortcutList.push(
new KeyShortcut(
'zen-split-view-grid',
'G',
'',
ZEN_SPLIT_VIEW_SHORTCUTS_GROUP,
KeyShortcutModifiers.fromObject({ctrl: true, alt: true}),
'code:gZenViewSplitter.toggleShortcut(\'grid\')',
'zen-split-view-shortcut-grid'
)
);
newShortcutList.push(
new KeyShortcut(
'zen-split-view-vertical',
'V',
'',
ZEN_SPLIT_VIEW_SHORTCUTS_GROUP,
KeyShortcutModifiers.fromObject({ctrl: true, alt: true}),
'code:gZenViewSplitter.toggleShortcut(\'vsep\')',
'zen-split-view-shortcut-vertical'
)
);
newShortcutList.push(
new KeyShortcut(
'zen-split-view-horizontal',
'H',
'',
ZEN_SPLIT_VIEW_SHORTCUTS_GROUP,
KeyShortcutModifiers.fromObject({ctrl: true, alt: true}),
'code:gZenViewSplitter.toggleShortcut(\'hsep\')',
'zen-split-view-shortcut-horizontal'
)
);
newShortcutList.push(
new KeyShortcut(
'zen-split-view-unsplit',
'U',
'',
ZEN_SPLIT_VIEW_SHORTCUTS_GROUP,
KeyShortcutModifiers.fromObject({ctrl: true, alt: true}),
'code:gZenViewSplitter.toggleShortcut(\'unsplit\')',
'zen-split-view-shortcut-unsplit'
)
);
return newShortcutList;
}, },
_applyShortcuts() { _applyShortcuts() {
@ -686,7 +783,7 @@ var gZenKeyboardShortcutsManager = {
json.push(shortcut.toJSONForm()); json.push(shortcut.toJSONForm());
} }
await gZenKeyboardShortcutsStorage.save(json); await this.loader.save(this.versioner.getVersionedData(json));
}, },
triggerShortcutRebuild() { triggerShortcutRebuild() {
@ -719,7 +816,7 @@ var gZenKeyboardShortcutsManager = {
let rv = []; let rv = [];
if (!this._currentShortcutList) { if (!this._currentShortcutList) {
this._currentShortcutList = await this._loadSaved(); this._currentShortcutList = await this._loadSaved(true);
} }
for (let shortcut of this._currentShortcutList) { for (let shortcut of this._currentShortcutList) {

7
src/ZenWorkspaces.mjs
View file

@ -832,8 +832,11 @@ var ZenWorkspaces = {
async shortcutSwitchTo(index) { async shortcutSwitchTo(index) {
const workspaces = await this._workspaces(); const workspaces = await this._workspaces();
// The index may be out of bounds, so we need to wrap it around // The index may be out of bounds, if it doesnt exist, don't do anything
const workspaceToSwitch = workspaces.workspaces[(index + workspaces.workspaces.length) % workspaces.workspaces.length]; if (index >= workspaces.workspaces.length || index < 0) {
return;
}
const workspaceToSwitch = workspaces.workspaces[index];
await this.changeWorkspace(workspaceToSwitch); await this.changeWorkspace(workspaceToSwitch);
} }
}; };