mirror of
https://github.com/mozilla/pdf.js.git
synced 2026-04-09 23:04:02 +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.
262 lines
8.4 KiB
JavaScript
262 lines
8.4 KiB
JavaScript
/* Copyright 2017 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 { CMap, CMapFactory, IdentityCMap } from "../../src/core/cmap.js";
|
|
import {
|
|
CMAP_URL,
|
|
DefaultBinaryDataFactory,
|
|
fetchBuiltInCMapHelper,
|
|
} from "./test_utils.js";
|
|
import { Name } from "../../src/core/primitives.js";
|
|
import { StringStream } from "../../src/core/stream.js";
|
|
|
|
describe("cmap", function () {
|
|
let fetchBuiltInCMap;
|
|
|
|
beforeAll(function () {
|
|
const binaryDataFactory = new DefaultBinaryDataFactory({
|
|
cMapUrl: CMAP_URL,
|
|
});
|
|
|
|
fetchBuiltInCMap = name =>
|
|
fetchBuiltInCMapHelper(binaryDataFactory, /* cMapPacked = */ true, name);
|
|
});
|
|
|
|
afterAll(function () {
|
|
fetchBuiltInCMap = null;
|
|
});
|
|
|
|
it("parses beginbfchar", async function () {
|
|
// prettier-ignore
|
|
const str = "2 beginbfchar\n" +
|
|
"<03> <00>\n" +
|
|
"<04> <01>\n" +
|
|
"endbfchar\n";
|
|
const stream = new StringStream(str);
|
|
const cmap = await CMapFactory.create({ encoding: stream });
|
|
expect(cmap.lookup(0x03)).toEqual(String.fromCharCode(0x00));
|
|
expect(cmap.lookup(0x04)).toEqual(String.fromCharCode(0x01));
|
|
expect(cmap.lookup(0x05)).toBeUndefined();
|
|
});
|
|
|
|
it("parses beginbfrange with range", async function () {
|
|
// prettier-ignore
|
|
const str = "1 beginbfrange\n" +
|
|
"<06> <0B> 0\n" +
|
|
"endbfrange\n";
|
|
const stream = new StringStream(str);
|
|
const cmap = await CMapFactory.create({ encoding: stream });
|
|
expect(cmap.lookup(0x05)).toBeUndefined();
|
|
expect(cmap.lookup(0x06)).toEqual(String.fromCharCode(0x00));
|
|
expect(cmap.lookup(0x0b)).toEqual(String.fromCharCode(0x05));
|
|
expect(cmap.lookup(0x0c)).toBeUndefined();
|
|
});
|
|
|
|
it("parses beginbfrange with array", async function () {
|
|
// prettier-ignore
|
|
const str = "1 beginbfrange\n" +
|
|
"<0D> <12> [ 0 1 2 3 4 5 ]\n" +
|
|
"endbfrange\n";
|
|
const stream = new StringStream(str);
|
|
const cmap = await CMapFactory.create({ encoding: stream });
|
|
expect(cmap.lookup(0x0c)).toBeUndefined();
|
|
expect(cmap.lookup(0x0d)).toEqual(0x00);
|
|
expect(cmap.lookup(0x12)).toEqual(0x05);
|
|
expect(cmap.lookup(0x13)).toBeUndefined();
|
|
});
|
|
|
|
it("parses begincidchar", async function () {
|
|
// prettier-ignore
|
|
const str = "1 begincidchar\n" +
|
|
"<14> 0\n" +
|
|
"endcidchar\n";
|
|
const stream = new StringStream(str);
|
|
const cmap = await CMapFactory.create({ encoding: stream });
|
|
expect(cmap.lookup(0x14)).toEqual(0x00);
|
|
expect(cmap.lookup(0x15)).toBeUndefined();
|
|
});
|
|
|
|
it("parses begincidrange", async function () {
|
|
// prettier-ignore
|
|
const str = "1 begincidrange\n" +
|
|
"<0016> <001B> 0\n" +
|
|
"endcidrange\n";
|
|
const stream = new StringStream(str);
|
|
const cmap = await CMapFactory.create({ encoding: stream });
|
|
expect(cmap.lookup(0x15)).toBeUndefined();
|
|
expect(cmap.lookup(0x16)).toEqual(0x00);
|
|
expect(cmap.lookup(0x1b)).toEqual(0x05);
|
|
expect(cmap.lookup(0x1c)).toBeUndefined();
|
|
});
|
|
|
|
it("decodes codespace ranges", async function () {
|
|
// prettier-ignore
|
|
const str = "1 begincodespacerange\n" +
|
|
"<01> <02>\n" +
|
|
"<00000003> <00000004>\n" +
|
|
"endcodespacerange\n";
|
|
const stream = new StringStream(str);
|
|
const cmap = await CMapFactory.create({ encoding: stream });
|
|
const c = {};
|
|
cmap.readCharCode(String.fromCharCode(1), 0, c);
|
|
expect(c.charcode).toEqual(1);
|
|
expect(c.length).toEqual(1);
|
|
cmap.readCharCode(String.fromCharCode(0, 0, 0, 3), 0, c);
|
|
expect(c.charcode).toEqual(3);
|
|
expect(c.length).toEqual(4);
|
|
});
|
|
|
|
it("decodes 4 byte codespace ranges", async function () {
|
|
// prettier-ignore
|
|
const str = "1 begincodespacerange\n" +
|
|
"<8EA1A1A1> <8EA1FEFE>\n" +
|
|
"endcodespacerange\n";
|
|
const stream = new StringStream(str);
|
|
const cmap = await CMapFactory.create({ encoding: stream });
|
|
const c = {};
|
|
cmap.readCharCode(String.fromCharCode(0x8e, 0xa1, 0xa1, 0xa1), 0, c);
|
|
expect(c.charcode).toEqual(0x8ea1a1a1);
|
|
expect(c.length).toEqual(4);
|
|
});
|
|
|
|
it("read usecmap", async function () {
|
|
const str = "/Adobe-Japan1-1 usecmap\n";
|
|
const stream = new StringStream(str);
|
|
const cmap = await CMapFactory.create({
|
|
encoding: stream,
|
|
fetchBuiltInCMap,
|
|
useCMap: null,
|
|
});
|
|
expect(cmap).toBeInstanceOf(CMap);
|
|
expect(cmap.useCMap).not.toBeNull();
|
|
expect(cmap.builtInCMap).toBeFalsy();
|
|
expect(cmap.length).toEqual(0x20a7);
|
|
expect(cmap.isIdentityCMap).toEqual(false);
|
|
});
|
|
|
|
it("parses cmapname", async function () {
|
|
const str = "/CMapName /Identity-H def\n";
|
|
const stream = new StringStream(str);
|
|
const cmap = await CMapFactory.create({ encoding: stream });
|
|
expect(cmap.name).toEqual("Identity-H");
|
|
});
|
|
|
|
it("parses wmode", async function () {
|
|
const str = "/WMode 1 def\n";
|
|
const stream = new StringStream(str);
|
|
const cmap = await CMapFactory.create({ encoding: stream });
|
|
expect(cmap.vertical).toEqual(true);
|
|
});
|
|
|
|
it("loads built in cmap", async function () {
|
|
const cmap = await CMapFactory.create({
|
|
encoding: Name.get("Adobe-Japan1-1"),
|
|
fetchBuiltInCMap,
|
|
useCMap: null,
|
|
});
|
|
expect(cmap).toBeInstanceOf(CMap);
|
|
expect(cmap.useCMap).toBeNull();
|
|
expect(cmap.builtInCMap).toBeTruthy();
|
|
expect(cmap.length).toEqual(0x20a7);
|
|
expect(cmap.isIdentityCMap).toEqual(false);
|
|
});
|
|
|
|
it("loads built in identity cmap", async function () {
|
|
const cmap = await CMapFactory.create({
|
|
encoding: Name.get("Identity-H"),
|
|
fetchBuiltInCMap,
|
|
useCMap: null,
|
|
});
|
|
expect(cmap).toBeInstanceOf(IdentityCMap);
|
|
expect(cmap.vertical).toEqual(false);
|
|
expect(cmap.length).toEqual(0x10000);
|
|
expect(function () {
|
|
return cmap.isIdentityCMap;
|
|
}).toThrow(new Error("should not access .isIdentityCMap"));
|
|
});
|
|
|
|
it("attempts to load a non-existent built-in CMap", async function () {
|
|
try {
|
|
await CMapFactory.create({
|
|
encoding: Name.get("null"),
|
|
fetchBuiltInCMap,
|
|
useCMap: null,
|
|
});
|
|
|
|
// Shouldn't get here.
|
|
expect(false).toEqual(true);
|
|
} catch (reason) {
|
|
expect(reason).toBeInstanceOf(Error);
|
|
expect(reason.message).toEqual("Unknown CMap name: null");
|
|
}
|
|
});
|
|
|
|
it("attempts to load a built-in CMap without the necessary API parameters", async function () {
|
|
function tmpFetchBuiltInCMap(name) {
|
|
const binaryDataFactory = new DefaultBinaryDataFactory({});
|
|
return fetchBuiltInCMapHelper(
|
|
binaryDataFactory,
|
|
/* cMapPacked = */ true,
|
|
name
|
|
);
|
|
}
|
|
|
|
try {
|
|
await CMapFactory.create({
|
|
encoding: Name.get("Adobe-Japan1-1"),
|
|
fetchBuiltInCMap: tmpFetchBuiltInCMap,
|
|
useCMap: null,
|
|
});
|
|
|
|
// Shouldn't get here.
|
|
expect(false).toEqual(true);
|
|
} catch (reason) {
|
|
expect(reason).toBeInstanceOf(Error);
|
|
expect(reason.message).toEqual(
|
|
"Ensure that the `cMapUrl` API parameter is provided."
|
|
);
|
|
}
|
|
});
|
|
|
|
it("attempts to load a built-in CMap with inconsistent API parameters", async function () {
|
|
function tmpFetchBuiltInCMap(name) {
|
|
const binaryDataFactory = new DefaultBinaryDataFactory({
|
|
cMapUrl: CMAP_URL,
|
|
});
|
|
return fetchBuiltInCMapHelper(
|
|
binaryDataFactory,
|
|
/* cMapPacked = */ false,
|
|
name
|
|
);
|
|
}
|
|
|
|
try {
|
|
await CMapFactory.create({
|
|
encoding: Name.get("Adobe-Japan1-1"),
|
|
fetchBuiltInCMap: tmpFetchBuiltInCMap,
|
|
useCMap: null,
|
|
});
|
|
|
|
// Shouldn't get here.
|
|
expect(false).toEqual(true);
|
|
} catch (reason) {
|
|
expect(reason).toBeInstanceOf(Error);
|
|
const message = reason.message;
|
|
expect(message.startsWith("Unable to load CMap data at: ")).toEqual(true);
|
|
expect(message.endsWith("/external/bcmaps/Adobe-Japan1-1")).toEqual(true);
|
|
}
|
|
});
|
|
});
|