mirror of
https://github.com/mozilla/pdf.js.git
synced 2026-04-10 15:24:03 +02:00
3a372fde94
Currently we have no less than three different, but very similar, factories for reading built-in CMap files, standard font files, and wasm files on the main-thread.[1] These factories were added at different points in time, since I cannot imagine that we'd add essentially three copies of the same code otherwise. Nowadays these factories are often not even used[2], since worker-thread fetching is used whenever possible to improve performance. In particular, they will *only* be used when either: - The PDF.js library runs in Node.js environments. - The user manually sets `useWorkerFetch = false` when calling `getDocument`. - The user provides custom `CMapReaderFactory`, `StandardFontDataFactory`, and/or `WasmFactory` instances when calling `getDocument`. By replacing these factories with *a single* new `BinaryDataFactory` factory/option the number of `getDocument` options are thus reduced, which cannot hurt. This also reduces the total bundle-size of the Firefox PDF Viewer a little bit, and it slightly reduces the number of import maps that need to be maintained. *Please note:* For users that provide custom `CMapReaderFactory`, `StandardFontDataFactory`, and `WasmFactory` instances when calling `getDocument` this will be a breaking change, however it's unlikely that (many) such users exist. (The *internal* format data-format of `CMapReaderFactory` was changed in PR 18951, and there hasn't been a single question/complaint about it in well over a year.) --- [1] Any new functionality could easily lead to more such factories being added in the future, which wouldn't be great. [2] Note that the Firefox PDF Viewer no longer use these factories, since it "forcibly" sets `useWorkerFetch = true` during building.
80 lines
2.3 KiB
JavaScript
80 lines
2.3 KiB
JavaScript
/* Copyright 2015 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 { stringToBytes, unreachable } from "../shared/util.js";
|
|
import { fetchData } from "./display_utils.js";
|
|
|
|
class BaseBinaryDataFactory {
|
|
#errorStr = Object.freeze({
|
|
cMapUrl: "CMap",
|
|
standardFontDataUrl: "font",
|
|
wasmUrl: "wasm",
|
|
});
|
|
|
|
constructor({ cMapUrl = null, standardFontDataUrl = null, wasmUrl = null }) {
|
|
if (
|
|
(typeof PDFJSDev === "undefined" || PDFJSDev.test("TESTING")) &&
|
|
this.constructor === BaseBinaryDataFactory
|
|
) {
|
|
unreachable("Cannot initialize BaseBinaryDataFactory.");
|
|
}
|
|
this.cMapUrl = cMapUrl;
|
|
this.standardFontDataUrl = standardFontDataUrl;
|
|
this.wasmUrl = wasmUrl;
|
|
}
|
|
|
|
async fetch({ kind, filename }) {
|
|
switch (kind) {
|
|
case "cMapUrl":
|
|
case "standardFontDataUrl":
|
|
case "wasmUrl":
|
|
break;
|
|
default:
|
|
unreachable(`Not implemented: ${kind}`);
|
|
}
|
|
const baseUrl = this[kind];
|
|
if (!baseUrl) {
|
|
throw new Error(`Ensure that the \`${kind}\` API parameter is provided.`);
|
|
}
|
|
const url = `${baseUrl}${filename}`;
|
|
|
|
return this._fetch(url, kind).catch(reason => {
|
|
throw new Error(`Unable to load ${this.#errorStr[kind]} data at: ${url}`);
|
|
});
|
|
}
|
|
|
|
/**
|
|
* @ignore
|
|
* @returns {Promise<Uint8Array>}
|
|
*/
|
|
async _fetch(url, kind) {
|
|
unreachable("Abstract method `_fetch` called.");
|
|
}
|
|
}
|
|
|
|
class DOMBinaryDataFactory extends BaseBinaryDataFactory {
|
|
/**
|
|
* @ignore
|
|
*/
|
|
async _fetch(url, kind) {
|
|
const type =
|
|
kind === "cMapUrl" && !url.endsWith(".bcmap") ? "text" : "bytes";
|
|
const data = await fetchData(url, type);
|
|
return data instanceof Uint8Array ? data : stringToBytes(data);
|
|
}
|
|
}
|
|
|
|
export { BaseBinaryDataFactory, DOMBinaryDataFactory };
|