Re-factor the various ExternalServices, used in the default viewer, to classes with static methods

This seems nicer overall, since it's now a bit clearer that the various build targets *extend* the default implementation.
This commit is contained in:
Jonas Jenwald 2020-01-15 14:26:47 +01:00
parent 40f531ee87
commit 1b87b1c384
4 changed files with 108 additions and 78 deletions

View File

@ -84,29 +84,52 @@ const ViewOnLoad = {
INITIAL: 1, INITIAL: 1,
}; };
const DefaultExternalServices = { class DefaultExternalServices {
updateFindControlState(data) {}, constructor() {
updateFindMatchesCount(data) {}, throw new Error("Cannot initialize DefaultExternalServices.");
initPassiveLoading(callbacks) {}, }
fallback(data, callback) {},
reportTelemetry(data) {}, static updateFindControlState(data) {}
createDownloadManager(options) {
static updateFindMatchesCount(data) {}
static initPassiveLoading(callbacks) {}
static fallback(data, callback) {}
static reportTelemetry(data) {}
static createDownloadManager(options) {
throw new Error("Not implemented: createDownloadManager"); throw new Error("Not implemented: createDownloadManager");
}, }
createPreferences() {
static createPreferences() {
throw new Error("Not implemented: createPreferences"); throw new Error("Not implemented: createPreferences");
}, }
createL10n(options) {
static createL10n(options) {
throw new Error("Not implemented: createL10n"); throw new Error("Not implemented: createL10n");
}, }
supportsIntegratedFind: false,
supportsDocumentFonts: true, static get supportsIntegratedFind() {
supportsDocumentColors: true, return shadow(this, "supportsIntegratedFind", false);
supportedMouseWheelZoomModifierKeys: { }
ctrlKey: true,
metaKey: true, static get supportsDocumentFonts() {
}, return shadow(this, "supportsDocumentFonts", true);
}; }
static get supportsDocumentColors() {
return shadow(this, "supportsDocumentColors", true);
}
static get supportedMouseWheelZoomModifierKeys() {
return shadow(this, "supportedMouseWheelZoomModifierKeys", {
ctrlKey: true,
metaKey: true,
});
}
}
const PDFViewerApplication = { const PDFViewerApplication = {
initialBookmark: document.location.hash.substring(1), initialBookmark: document.location.hash.substring(1),

View File

@ -404,27 +404,30 @@ class ChromePreferences extends BasePreferences {
} }
} }
const ChromeExternalServices = Object.create(DefaultExternalServices); class ChromeExternalServices extends DefaultExternalServices {
ChromeExternalServices.initPassiveLoading = function(callbacks) { static initPassiveLoading(callbacks) {
const { overlayManager } = PDFViewerApplication; // defaultUrl is set in viewer.js
// defaultUrl is set in viewer.js ChromeCom.resolvePDFFile(
ChromeCom.resolvePDFFile( AppOptions.get("defaultUrl"),
AppOptions.get("defaultUrl"), PDFViewerApplication.overlayManager,
overlayManager, function(url, length, originalUrl) {
function(url, length, originalUrl) { callbacks.onOpenWithURL(url, length, originalUrl);
callbacks.onOpenWithURL(url, length, originalUrl); }
} );
); }
};
ChromeExternalServices.createDownloadManager = function(options) { static createDownloadManager(options) {
return new DownloadManager(options); return new DownloadManager(options);
}; }
ChromeExternalServices.createPreferences = function() {
return new ChromePreferences(); static createPreferences() {
}; return new ChromePreferences();
ChromeExternalServices.createL10n = function(options) { }
return new GenericL10n(navigator.language);
}; static createL10n(options) {
return new GenericL10n(navigator.language);
}
}
PDFViewerApplication.externalServices = ChromeExternalServices; PDFViewerApplication.externalServices = ChromeExternalServices;
export { ChromeCom }; export { ChromeCom };

View File

@ -15,9 +15,9 @@
import "../extensions/firefox/tools/l10n"; import "../extensions/firefox/tools/l10n";
import { createObjectURL, PDFDataRangeTransport, shadow } from "pdfjs-lib"; import { createObjectURL, PDFDataRangeTransport, shadow } from "pdfjs-lib";
import { DefaultExternalServices, PDFViewerApplication } from "./app.js";
import { BasePreferences } from "./preferences.js"; import { BasePreferences } from "./preferences.js";
import { DEFAULT_SCALE_VALUE } from "./ui_utils.js"; import { DEFAULT_SCALE_VALUE } from "./ui_utils.js";
import { PDFViewerApplication } from "./app.js";
if ( if (
typeof PDFJSDev === "undefined" || typeof PDFJSDev === "undefined" ||
@ -241,16 +241,16 @@ class FirefoxComDataRangeTransport extends PDFDataRangeTransport {
} }
} }
PDFViewerApplication.externalServices = { class FirefoxExternalServices extends DefaultExternalServices {
updateFindControlState(data) { static updateFindControlState(data) {
FirefoxCom.request("updateFindControlState", data); FirefoxCom.request("updateFindControlState", data);
}, }
updateFindMatchesCount(data) { static updateFindMatchesCount(data) {
FirefoxCom.request("updateFindMatchesCount", data); FirefoxCom.request("updateFindMatchesCount", data);
}, }
initPassiveLoading(callbacks) { static initPassiveLoading(callbacks) {
let pdfDataRangeTransport; let pdfDataRangeTransport;
window.addEventListener("message", function windowMessage(e) { window.addEventListener("message", function windowMessage(e) {
@ -309,52 +309,53 @@ PDFViewerApplication.externalServices = {
} }
}); });
FirefoxCom.requestSync("initPassiveLoading", null); FirefoxCom.requestSync("initPassiveLoading", null);
}, }
fallback(data, callback) { static fallback(data, callback) {
FirefoxCom.request("fallback", data, callback); FirefoxCom.request("fallback", data, callback);
}, }
reportTelemetry(data) { static reportTelemetry(data) {
FirefoxCom.request("reportTelemetry", JSON.stringify(data)); FirefoxCom.request("reportTelemetry", JSON.stringify(data));
}, }
createDownloadManager(options) { static createDownloadManager(options) {
return new DownloadManager(options); return new DownloadManager(options);
}, }
createPreferences() { static createPreferences() {
return new FirefoxPreferences(); return new FirefoxPreferences();
}, }
createL10n(options) { static createL10n(options) {
const mozL10n = document.mozL10n; const mozL10n = document.mozL10n;
// TODO refactor mozL10n.setExternalLocalizerServices // TODO refactor mozL10n.setExternalLocalizerServices
return new MozL10n(mozL10n); return new MozL10n(mozL10n);
}, }
get supportsIntegratedFind() { static get supportsIntegratedFind() {
const support = FirefoxCom.requestSync("supportsIntegratedFind"); const support = FirefoxCom.requestSync("supportsIntegratedFind");
return shadow(this, "supportsIntegratedFind", support); return shadow(this, "supportsIntegratedFind", support);
}, }
get supportsDocumentFonts() { static get supportsDocumentFonts() {
const support = FirefoxCom.requestSync("supportsDocumentFonts"); const support = FirefoxCom.requestSync("supportsDocumentFonts");
return shadow(this, "supportsDocumentFonts", support); return shadow(this, "supportsDocumentFonts", support);
}, }
get supportsDocumentColors() { static get supportsDocumentColors() {
const support = FirefoxCom.requestSync("supportsDocumentColors"); const support = FirefoxCom.requestSync("supportsDocumentColors");
return shadow(this, "supportsDocumentColors", support); return shadow(this, "supportsDocumentColors", support);
}, }
get supportedMouseWheelZoomModifierKeys() { static get supportedMouseWheelZoomModifierKeys() {
const support = FirefoxCom.requestSync( const support = FirefoxCom.requestSync(
"supportedMouseWheelZoomModifierKeys" "supportedMouseWheelZoomModifierKeys"
); );
return shadow(this, "supportedMouseWheelZoomModifierKeys", support); return shadow(this, "supportedMouseWheelZoomModifierKeys", support);
}, }
}; }
PDFViewerApplication.externalServices = FirefoxExternalServices;
// l10n.js for Firefox extension expects services to be set. // l10n.js for Firefox extension expects services to be set.
document.mozL10n.setExternalLocalizerServices({ document.mozL10n.setExternalLocalizerServices({

View File

@ -37,16 +37,19 @@ class GenericPreferences extends BasePreferences {
} }
} }
const GenericExternalServices = Object.create(DefaultExternalServices); class GenericExternalServices extends DefaultExternalServices {
GenericExternalServices.createDownloadManager = function(options) { static createDownloadManager(options) {
return new DownloadManager(options); return new DownloadManager(options);
}; }
GenericExternalServices.createPreferences = function() {
return new GenericPreferences(); static createPreferences() {
}; return new GenericPreferences();
GenericExternalServices.createL10n = function({ locale = "en-US" }) { }
return new GenericL10n(locale);
}; static createL10n({ locale = "en-US" }) {
return new GenericL10n(locale);
}
}
PDFViewerApplication.externalServices = GenericExternalServices; PDFViewerApplication.externalServices = GenericExternalServices;
export { GenericCom }; export { GenericCom };