Re-factor the PDFScriptingManager
-class for the viewer-components
Currently this class contains a few "special" code-paths for the COMPONENTS build-target, which normally wouldn't be a problem. However, in this particular case that means accessing code that we don't want to include unconditionally in all builds. This is currently implemented using build-time `require`-calls which we nowadays want to avoid, and we should strive to remove all such cases from the code-base. (Generally speaking `import` is the future, and build-tools may not always play well with a mix of both formats.) We can easily improve things here by using sub-classing for the COMPONENTS build-target, and then use the ability to re-name when exporting (to avoid breaking existing code).
This commit is contained in:
parent
337cba736e
commit
86a868189c
@ -33,7 +33,7 @@ import { GenericL10n } from "../../web/genericl10n.js";
|
|||||||
import { NullL10n } from "../../web/l10n_utils.js";
|
import { NullL10n } from "../../web/l10n_utils.js";
|
||||||
import { PDFHistory } from "../../web/pdf_history.js";
|
import { PDFHistory } from "../../web/pdf_history.js";
|
||||||
import { PDFPageView } from "../../web/pdf_page_view.js";
|
import { PDFPageView } from "../../web/pdf_page_view.js";
|
||||||
import { PDFScriptingManager } from "../../web/pdf_scripting_manager.js";
|
import { PDFScriptingManager } from "../../web/pdf_scripting_manager.component.js";
|
||||||
import { PDFSinglePageViewer } from "../../web/pdf_single_page_viewer.js";
|
import { PDFSinglePageViewer } from "../../web/pdf_single_page_viewer.js";
|
||||||
import { PDFViewer } from "../../web/pdf_viewer.js";
|
import { PDFViewer } from "../../web/pdf_viewer.js";
|
||||||
import { StructTreeLayerBuilder } from "../../web/struct_tree_layer_builder.js";
|
import { StructTreeLayerBuilder } from "../../web/struct_tree_layer_builder.js";
|
||||||
|
44
web/pdf_scripting_manager.component.js
Normal file
44
web/pdf_scripting_manager.component.js
Normal file
@ -0,0 +1,44 @@
|
|||||||
|
/* Copyright 2021 Mozilla Foundation
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { docProperties, GenericScripting } from "./generic_scripting.js";
|
||||||
|
import { PDFScriptingManager } from "./pdf_scripting_manager.js";
|
||||||
|
|
||||||
|
class PDFScriptingManagerComponents extends PDFScriptingManager {
|
||||||
|
constructor(options) {
|
||||||
|
// The default viewer already handles adding/removing of DOM events,
|
||||||
|
// hence limit this to only the viewer components.
|
||||||
|
if (!options.externalServices) {
|
||||||
|
window.addEventListener("updatefromsandbox", event => {
|
||||||
|
options.eventBus.dispatch("updatefromsandbox", {
|
||||||
|
source: window,
|
||||||
|
detail: event.detail,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
options.externalServices ||= {
|
||||||
|
createScripting: ({ sandboxBundleSrc }) => {
|
||||||
|
return new GenericScripting(sandboxBundleSrc);
|
||||||
|
},
|
||||||
|
};
|
||||||
|
options.docProperties ||= pdfDocument => {
|
||||||
|
return docProperties(pdfDocument);
|
||||||
|
};
|
||||||
|
super(options);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export { PDFScriptingManagerComponents as PDFScriptingManager };
|
@ -66,30 +66,6 @@ class PDFScriptingManager {
|
|||||||
}
|
}
|
||||||
this.#externalServices = externalServices;
|
this.#externalServices = externalServices;
|
||||||
this.#docProperties = docProperties;
|
this.#docProperties = docProperties;
|
||||||
|
|
||||||
if (typeof PDFJSDev !== "undefined" && PDFJSDev.test("COMPONENTS")) {
|
|
||||||
const gs = require("./generic_scripting.js");
|
|
||||||
|
|
||||||
this.#externalServices ||= {
|
|
||||||
createScripting: options => {
|
|
||||||
return new gs.GenericScripting(options.sandboxBundleSrc);
|
|
||||||
},
|
|
||||||
};
|
|
||||||
this.#docProperties ||= pdfDocument => {
|
|
||||||
return gs.docProperties(pdfDocument);
|
|
||||||
};
|
|
||||||
|
|
||||||
// The default viewer already handles adding/removing of DOM events,
|
|
||||||
// hence limit this to only the viewer components.
|
|
||||||
if (!externalServices) {
|
|
||||||
window.addEventListener("updatefromsandbox", event => {
|
|
||||||
this.#eventBus.dispatch("updatefromsandbox", {
|
|
||||||
source: window,
|
|
||||||
detail: event.detail,
|
|
||||||
});
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
setViewer(pdfViewer) {
|
setViewer(pdfViewer) {
|
||||||
|
@ -33,7 +33,7 @@ import { GenericL10n } from "./genericl10n.js";
|
|||||||
import { NullL10n } from "./l10n_utils.js";
|
import { NullL10n } from "./l10n_utils.js";
|
||||||
import { PDFHistory } from "./pdf_history.js";
|
import { PDFHistory } from "./pdf_history.js";
|
||||||
import { PDFPageView } from "./pdf_page_view.js";
|
import { PDFPageView } from "./pdf_page_view.js";
|
||||||
import { PDFScriptingManager } from "./pdf_scripting_manager.js";
|
import { PDFScriptingManager } from "./pdf_scripting_manager.component.js";
|
||||||
import { PDFSinglePageViewer } from "./pdf_single_page_viewer.js";
|
import { PDFSinglePageViewer } from "./pdf_single_page_viewer.js";
|
||||||
import { PDFViewer } from "./pdf_viewer.js";
|
import { PDFViewer } from "./pdf_viewer.js";
|
||||||
import { StructTreeLayerBuilder } from "./struct_tree_layer_builder.js";
|
import { StructTreeLayerBuilder } from "./struct_tree_layer_builder.js";
|
||||||
|
Loading…
Reference in New Issue
Block a user