1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
const lazy = {};
ChromeUtils.defineESModuleGetters(lazy, {
TranslationsParent: "resource://gre/actors/TranslationsParent.sys.mjs",
});
/**
* A class containing static functionality that is shared by both
* the FullPageTranslationsPanel and SelectTranslationsPanel classes.
*
* It is recommended to read the documentation above the TranslationsParent class
* definition to understand the scope of the Translations architecture throughout
* Firefox.
*
* @see TranslationsParent
*
* The static instance of this class is a singleton in the parent process, and is
* available throughout all windows and tabs, just like the static instance of
* the TranslationsParent class.
*
* Unlike the TranslationsParent, this class is never instantiated as an actor
* outside of the static-context functionality defined below.
*/
export class TranslationsPanelShared {
/**
* A map from Translations Panel instances to their initialized states.
* There is one instance of each panel per top ChromeWindow in Firefox.
*
* See the documentation above the TranslationsParent class for a detailed
* explanation of the translations architecture throughout Firefox.
*
* @see TranslationsParent
*
* @type {Map<FullPageTranslationsPanel | SelectTranslationsPanel, string>}
*/
static #langListsInitState = new WeakMap();
/**
* True if the next language-list initialization to fail for testing.
*
* @see TranslationsPanelShared.ensureLangListsBuilt
*
* @type {boolean}
*/
static #simulateLangListError = false;
/**
* Clears cached data regarding the initialization state of the
* FullPageTranslationsPanel or the SelectTranslationsPanel.
*
* This is only needed for test runners to ensure that each test
* starts from a clean slate.
*/
static clearCache() {
this.#langListsInitState = new WeakMap();
}
/**
* Defines lazy getters for accessing elements in the document based on provided entries.
*
* @param {Document} document - The document object.
* @param {object} lazyElements - An object where lazy getters will be defined.
* @param {object} entries - An object of key/value pairs for which to define lazy getters.
*/
static defineLazyElements(document, lazyElements, entries) {
for (const [name, discriminator] of Object.entries(entries)) {
let element;
Object.defineProperty(lazyElements, name, {
get: () => {
if (!element) {
if (discriminator[0] === ".") {
// Lookup by class
element = document.querySelector(discriminator);
} else {
// Lookup by id
element = document.getElementById(discriminator);
}
}
if (!element) {
throw new Error(`Could not find "${name}" at "#${discriminator}".`);
}
return element;
},
});
}
}
/**
* Ensures that the next call to ensureLangListBuilt wil fail
* for the purpose of testing the error state.
*
* @see TranslationsPanelShared.ensureLangListsBuilt
*
* @type {boolean}
*/
static simulateLangListError() {
this.#simulateLangListError = true;
}
/**
* Retrieves the initialization state of language lists for the specified panel.
*
* @param {FullPageTranslationsPanel | SelectTranslationsPanel} panel
* - The panel for which to look up the state.
*/
static getLangListsInitState(panel) {
return TranslationsPanelShared.#langListsInitState.get(panel);
}
/**
* Builds the <menulist> of languages for both the "from" and "to". This can be
* called every time the popup is shown, as it will retry when there is an error
* (such as a network error) or be a noop if it's already initialized.
*
* @param {Document} document - The document object.
* @param {FullPageTranslationsPanel | SelectTranslationsPanel} panel
* - The panel for which to ensure language lists are built.
*/
static async ensureLangListsBuilt(document, panel) {
const { panel: panelElement } = panel.elements;
switch (TranslationsPanelShared.#langListsInitState.get(panel)) {
case "initialized":
// This has already been initialized.
return;
case "error":
case undefined:
// Set the error state in case there is an early exit at any point.
// This will be set to "initialized" if everything succeeds.
TranslationsPanelShared.#langListsInitState.set(panel, "error");
break;
default:
throw new Error(
`Unknown langList phase ${
TranslationsPanelShared.#langListsInitState
}`
);
}
/** @type {SupportedLanguages} */
const { languagePairs, fromLanguages, toLanguages } =
await lazy.TranslationsParent.getSupportedLanguages();
// Verify that we are in a proper state.
if (languagePairs.length === 0 || this.#simulateLangListError) {
this.#simulateLangListError = false;
throw new Error("No translation languages were retrieved.");
}
const fromPopups = panelElement.querySelectorAll(
".translations-panel-language-menupopup-from"
);
const toPopups = panelElement.querySelectorAll(
".translations-panel-language-menupopup-to"
);
for (const popup of fromPopups) {
// For the moment, the FullPageTranslationsPanel includes its own
// menu item for "Choose another language" as the first item in the list
// with an empty-string for its value. The SelectTranslationsPanel has
// only languages in its list with BCP-47 tags for values. As such,
// this loop works for both panels, to remove all of the languages
// from the list, but ensuring that any empty-string items are retained.
while (popup.lastChild?.value) {
popup.lastChild.remove();
}
for (const { langTag, displayName } of fromLanguages) {
const fromMenuItem = document.createXULElement("menuitem");
fromMenuItem.setAttribute("value", langTag);
fromMenuItem.setAttribute("label", displayName);
popup.appendChild(fromMenuItem);
}
}
for (const popup of toPopups) {
while (popup.lastChild?.value) {
popup.lastChild.remove();
}
for (const { langTag, displayName } of toLanguages) {
const toMenuItem = document.createXULElement("menuitem");
toMenuItem.setAttribute("value", langTag);
toMenuItem.setAttribute("label", displayName);
popup.appendChild(toMenuItem);
}
}
TranslationsPanelShared.#langListsInitState.set(panel, "initialized");
}
}
|
