mirror of
https://github.com/mozilla/pdf.js.git
synced 2025-04-20 15:18:08 +02:00
Move the EventBus, and related functionality, into its own file
The size of the `web/ui_utils.js` file has increased over time, as more code has been added to (or moved into) that file. To reduce its size slightly, this patch moves the event-related functionality into a separate file.
This commit is contained in:
Jonas Jenwald
parent
a425c9cfa5
commit
0a19ef6864
10 changed files with 489 additions and 456 deletions
|
|
@ -18,10 +18,8 @@ import {
|
|||
animationStarted,
|
||||
apiPageLayoutToViewerModes,
|
||||
apiPageModeToSidebarView,
|
||||
AutomationEventBus,
|
||||
AutoPrintRegExp,
|
||||
DEFAULT_SCALE_VALUE,
|
||||
EventBus,
|
||||
getActiveOrFocusedElement,
|
||||
isValidRotation,
|
||||
isValidScrollMode,
|
||||
|
|
@ -37,6 +35,7 @@ import {
|
|||
TextLayerMode,
|
||||
} from "./ui_utils.js";
|
||||
import { AppOptions, compatibilityParams, OptionKind } from "./app_options.js";
|
||||
import { AutomationEventBus, EventBus } from "./event_utils.js";
|
||||
import {
|
||||
build,
|
||||
createPromiseCapability,
|
||||
|
|
|
|||
196
web/event_utils.js
Normal file
196
web/event_utils.js
Normal file
|
|
@ -0,0 +1,196 @@
|
|||
/* Copyright 2012 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.
|
||||
*/
|
||||
|
||||
const WaitOnType = {
|
||||
EVENT: "event",
|
||||
TIMEOUT: "timeout",
|
||||
};
|
||||
|
||||
/**
|
||||
* @typedef {Object} WaitOnEventOrTimeoutParameters
|
||||
* @property {Object} target - The event target, can for example be:
|
||||
* `window`, `document`, a DOM element, or an {EventBus} instance.
|
||||
* @property {string} name - The name of the event.
|
||||
* @property {number} delay - The delay, in milliseconds, after which the
|
||||
* timeout occurs (if the event wasn't already dispatched).
|
||||
*/
|
||||
|
||||
/**
|
||||
* Allows waiting for an event or a timeout, whichever occurs first.
|
||||
* Can be used to ensure that an action always occurs, even when an event
|
||||
* arrives late or not at all.
|
||||
*
|
||||
* @param {WaitOnEventOrTimeoutParameters}
|
||||
* @returns {Promise} A promise that is resolved with a {WaitOnType} value.
|
||||
*/
|
||||
function waitOnEventOrTimeout({ target, name, delay = 0 }) {
|
||||
return new Promise(function (resolve, reject) {
|
||||
if (
|
||||
typeof target !== "object" ||
|
||||
!(name && typeof name === "string") ||
|
||||
!(Number.isInteger(delay) && delay >= 0)
|
||||
) {
|
||||
throw new Error("waitOnEventOrTimeout - invalid parameters.");
|
||||
}
|
||||
|
||||
function handler(type) {
|
||||
if (target instanceof EventBus) {
|
||||
target._off(name, eventHandler);
|
||||
} else {
|
||||
target.removeEventListener(name, eventHandler);
|
||||
}
|
||||
|
||||
if (timeout) {
|
||||
clearTimeout(timeout);
|
||||
}
|
||||
resolve(type);
|
||||
}
|
||||
|
||||
const eventHandler = handler.bind(null, WaitOnType.EVENT);
|
||||
if (target instanceof EventBus) {
|
||||
target._on(name, eventHandler);
|
||||
} else {
|
||||
target.addEventListener(name, eventHandler);
|
||||
}
|
||||
|
||||
const timeoutHandler = handler.bind(null, WaitOnType.TIMEOUT);
|
||||
const timeout = setTimeout(timeoutHandler, delay);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Simple event bus for an application. Listeners are attached using the `on`
|
||||
* and `off` methods. To raise an event, the `dispatch` method shall be used.
|
||||
*/
|
||||
class EventBus {
|
||||
constructor() {
|
||||
this._listeners = Object.create(null);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {string} eventName
|
||||
* @param {function} listener
|
||||
* @param {Object} [options]
|
||||
*/
|
||||
on(eventName, listener, options = null) {
|
||||
this._on(eventName, listener, {
|
||||
external: true,
|
||||
once: options?.once,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {string} eventName
|
||||
* @param {function} listener
|
||||
* @param {Object} [options]
|
||||
*/
|
||||
off(eventName, listener, options = null) {
|
||||
this._off(eventName, listener, {
|
||||
external: true,
|
||||
once: options?.once,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {string} eventName
|
||||
* @param {Object} data
|
||||
*/
|
||||
dispatch(eventName, data) {
|
||||
const eventListeners = this._listeners[eventName];
|
||||
if (!eventListeners || eventListeners.length === 0) {
|
||||
return;
|
||||
}
|
||||
let externalListeners;
|
||||
// Making copy of the listeners array in case if it will be modified
|
||||
// during dispatch.
|
||||
for (const { listener, external, once } of eventListeners.slice(0)) {
|
||||
if (once) {
|
||||
this._off(eventName, listener);
|
||||
}
|
||||
if (external) {
|
||||
(externalListeners ||= []).push(listener);
|
||||
continue;
|
||||
}
|
||||
listener(data);
|
||||
}
|
||||
// Dispatch any "external" listeners *after* the internal ones, to give the
|
||||
// viewer components time to handle events and update their state first.
|
||||
if (externalListeners) {
|
||||
for (const listener of externalListeners) {
|
||||
listener(data);
|
||||
}
|
||||
externalListeners = null;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @ignore
|
||||
*/
|
||||
_on(eventName, listener, options = null) {
|
||||
const eventListeners = (this._listeners[eventName] ||= []);
|
||||
eventListeners.push({
|
||||
listener,
|
||||
external: options?.external === true,
|
||||
once: options?.once === true,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* @ignore
|
||||
*/
|
||||
_off(eventName, listener, options = null) {
|
||||
const eventListeners = this._listeners[eventName];
|
||||
if (!eventListeners) {
|
||||
return;
|
||||
}
|
||||
for (let i = 0, ii = eventListeners.length; i < ii; i++) {
|
||||
if (eventListeners[i].listener === listener) {
|
||||
eventListeners.splice(i, 1);
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* NOTE: Only used to support various PDF viewer tests in `mozilla-central`.
|
||||
*/
|
||||
class AutomationEventBus extends EventBus {
|
||||
dispatch(eventName, data) {
|
||||
if (typeof PDFJSDev !== "undefined" && !PDFJSDev.test("MOZCENTRAL")) {
|
||||
throw new Error("Not implemented: AutomationEventBus.dispatch");
|
||||
}
|
||||
super.dispatch(eventName, data);
|
||||
|
||||
const details = Object.create(null);
|
||||
if (data) {
|
||||
for (const key in data) {
|
||||
const value = data[key];
|
||||
if (key === "source") {
|
||||
if (value === window || value === document) {
|
||||
return; // No need to re-dispatch (already) global events.
|
||||
}
|
||||
continue; // Ignore the `source` property.
|
||||
}
|
||||
details[key] = value;
|
||||
}
|
||||
}
|
||||
const event = document.createEvent("CustomEvent");
|
||||
event.initCustomEvent(eventName, true, true, details);
|
||||
document.dispatchEvent(event);
|
||||
}
|
||||
}
|
||||
|
||||
export { AutomationEventBus, EventBus, waitOnEventOrTimeout, WaitOnType };
|
||||
|
|
@ -17,8 +17,8 @@ import {
|
|||
isValidRotation,
|
||||
parseQueryString,
|
||||
PresentationModeState,
|
||||
waitOnEventOrTimeout,
|
||||
} from "./ui_utils.js";
|
||||
import { waitOnEventOrTimeout } from "./event_utils.js";
|
||||
|
||||
// Heuristic value used when force-resetting `this._blockHashChange`.
|
||||
const HASH_CHANGE_TIMEOUT = 1000; // milliseconds
|
||||
|
|
|
|||
|
|
@ -29,16 +29,17 @@ import {
|
|||
DefaultXfaLayerFactory,
|
||||
XfaLayerBuilder,
|
||||
} from "./xfa_layer_builder.js";
|
||||
import { EventBus, ProgressBar } from "./ui_utils.js";
|
||||
import { PDFLinkService, SimpleLinkService } from "./pdf_link_service.js";
|
||||
import { PDFSinglePageViewer, PDFViewer } from "./pdf_viewer.js";
|
||||
import { DownloadManager } from "./download_manager.js";
|
||||
import { EventBus } from "./event_utils.js";
|
||||
import { GenericL10n } from "./genericl10n.js";
|
||||
import { NullL10n } from "./l10n_utils.js";
|
||||
import { PDFFindController } from "./pdf_find_controller.js";
|
||||
import { PDFHistory } from "./pdf_history.js";
|
||||
import { PDFPageView } from "./pdf_page_view.js";
|
||||
import { PDFScriptingManager } from "./pdf_scripting_manager.js";
|
||||
import { ProgressBar } from "./ui_utils.js";
|
||||
|
||||
// eslint-disable-next-line no-unused-vars
|
||||
const pdfjsVersion = PDFJSDev.eval("BUNDLE_VERSION");
|
||||
|
|
|
|||
184
web/ui_utils.js
184
web/ui_utils.js
|
|
@ -632,63 +632,6 @@ function isPortraitOrientation(size) {
|
|||
return size.width <= size.height;
|
||||
}
|
||||
|
||||
const WaitOnType = {
|
||||
EVENT: "event",
|
||||
TIMEOUT: "timeout",
|
||||
};
|
||||
|
||||
/**
|
||||
* @typedef {Object} WaitOnEventOrTimeoutParameters
|
||||
* @property {Object} target - The event target, can for example be:
|
||||
* `window`, `document`, a DOM element, or an {EventBus} instance.
|
||||
* @property {string} name - The name of the event.
|
||||
* @property {number} delay - The delay, in milliseconds, after which the
|
||||
* timeout occurs (if the event wasn't already dispatched).
|
||||
*/
|
||||
|
||||
/**
|
||||
* Allows waiting for an event or a timeout, whichever occurs first.
|
||||
* Can be used to ensure that an action always occurs, even when an event
|
||||
* arrives late or not at all.
|
||||
*
|
||||
* @param {WaitOnEventOrTimeoutParameters}
|
||||
* @returns {Promise} A promise that is resolved with a {WaitOnType} value.
|
||||
*/
|
||||
function waitOnEventOrTimeout({ target, name, delay = 0 }) {
|
||||
return new Promise(function (resolve, reject) {
|
||||
if (
|
||||
typeof target !== "object" ||
|
||||
!(name && typeof name === "string") ||
|
||||
!(Number.isInteger(delay) && delay >= 0)
|
||||
) {
|
||||
throw new Error("waitOnEventOrTimeout - invalid parameters.");
|
||||
}
|
||||
|
||||
function handler(type) {
|
||||
if (target instanceof EventBus) {
|
||||
target._off(name, eventHandler);
|
||||
} else {
|
||||
target.removeEventListener(name, eventHandler);
|
||||
}
|
||||
|
||||
if (timeout) {
|
||||
clearTimeout(timeout);
|
||||
}
|
||||
resolve(type);
|
||||
}
|
||||
|
||||
const eventHandler = handler.bind(null, WaitOnType.EVENT);
|
||||
if (target instanceof EventBus) {
|
||||
target._on(name, eventHandler);
|
||||
} else {
|
||||
target.addEventListener(name, eventHandler);
|
||||
}
|
||||
|
||||
const timeoutHandler = handler.bind(null, WaitOnType.TIMEOUT);
|
||||
const timeout = setTimeout(timeoutHandler, delay);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Promise that is resolved when DOM window becomes visible.
|
||||
*/
|
||||
|
|
@ -706,129 +649,6 @@ const animationStarted = new Promise(function (resolve) {
|
|||
window.requestAnimationFrame(resolve);
|
||||
});
|
||||
|
||||
/**
|
||||
* Simple event bus for an application. Listeners are attached using the `on`
|
||||
* and `off` methods. To raise an event, the `dispatch` method shall be used.
|
||||
*/
|
||||
class EventBus {
|
||||
constructor() {
|
||||
this._listeners = Object.create(null);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {string} eventName
|
||||
* @param {function} listener
|
||||
* @param {Object} [options]
|
||||
*/
|
||||
on(eventName, listener, options = null) {
|
||||
this._on(eventName, listener, {
|
||||
external: true,
|
||||
once: options?.once,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {string} eventName
|
||||
* @param {function} listener
|
||||
* @param {Object} [options]
|
||||
*/
|
||||
off(eventName, listener, options = null) {
|
||||
this._off(eventName, listener, {
|
||||
external: true,
|
||||
once: options?.once,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {string} eventName
|
||||
* @param {Object} data
|
||||
*/
|
||||
dispatch(eventName, data) {
|
||||
const eventListeners = this._listeners[eventName];
|
||||
if (!eventListeners || eventListeners.length === 0) {
|
||||
return;
|
||||
}
|
||||
let externalListeners;
|
||||
// Making copy of the listeners array in case if it will be modified
|
||||
// during dispatch.
|
||||
for (const { listener, external, once } of eventListeners.slice(0)) {
|
||||
if (once) {
|
||||
this._off(eventName, listener);
|
||||
}
|
||||
if (external) {
|
||||
(externalListeners ||= []).push(listener);
|
||||
continue;
|
||||
}
|
||||
listener(data);
|
||||
}
|
||||
// Dispatch any "external" listeners *after* the internal ones, to give the
|
||||
// viewer components time to handle events and update their state first.
|
||||
if (externalListeners) {
|
||||
for (const listener of externalListeners) {
|
||||
listener(data);
|
||||
}
|
||||
externalListeners = null;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @ignore
|
||||
*/
|
||||
_on(eventName, listener, options = null) {
|
||||
const eventListeners = (this._listeners[eventName] ||= []);
|
||||
eventListeners.push({
|
||||
listener,
|
||||
external: options?.external === true,
|
||||
once: options?.once === true,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* @ignore
|
||||
*/
|
||||
_off(eventName, listener, options = null) {
|
||||
const eventListeners = this._listeners[eventName];
|
||||
if (!eventListeners) {
|
||||
return;
|
||||
}
|
||||
for (let i = 0, ii = eventListeners.length; i < ii; i++) {
|
||||
if (eventListeners[i].listener === listener) {
|
||||
eventListeners.splice(i, 1);
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* NOTE: Only used to support various PDF viewer tests in `mozilla-central`.
|
||||
*/
|
||||
class AutomationEventBus extends EventBus {
|
||||
dispatch(eventName, data) {
|
||||
if (typeof PDFJSDev !== "undefined" && !PDFJSDev.test("MOZCENTRAL")) {
|
||||
throw new Error("Not implemented: AutomationEventBus.dispatch");
|
||||
}
|
||||
super.dispatch(eventName, data);
|
||||
|
||||
const details = Object.create(null);
|
||||
if (data) {
|
||||
for (const key in data) {
|
||||
const value = data[key];
|
||||
if (key === "source") {
|
||||
if (value === window || value === document) {
|
||||
return; // No need to re-dispatch (already) global events.
|
||||
}
|
||||
continue; // Ignore the `source` property.
|
||||
}
|
||||
details[key] = value;
|
||||
}
|
||||
}
|
||||
const event = document.createEvent("CustomEvent");
|
||||
event.initCustomEvent(eventName, true, true, details);
|
||||
document.dispatchEvent(event);
|
||||
}
|
||||
}
|
||||
|
||||
function clamp(v, min, max) {
|
||||
return Math.min(Math.max(v, min), max);
|
||||
}
|
||||
|
|
@ -988,14 +808,12 @@ export {
|
|||
apiPageLayoutToViewerModes,
|
||||
apiPageModeToSidebarView,
|
||||
approximateFraction,
|
||||
AutomationEventBus,
|
||||
AutoPrintRegExp,
|
||||
backtrackBeforeAllVisibleElements, // only exported for testing
|
||||
binarySearchFirstItem,
|
||||
DEFAULT_SCALE,
|
||||
DEFAULT_SCALE_DELTA,
|
||||
DEFAULT_SCALE_VALUE,
|
||||
EventBus,
|
||||
getActiveOrFocusedElement,
|
||||
getOutputScale,
|
||||
getPageSizeInches,
|
||||
|
|
@ -1023,7 +841,5 @@ export {
|
|||
TextLayerMode,
|
||||
UNKNOWN_SCALE,
|
||||
VERTICAL_PADDING,
|
||||
waitOnEventOrTimeout,
|
||||
WaitOnType,
|
||||
watchScroll,
|
||||
};
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue