Sakurai/pdf.js
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Prefer instanceof Name rather than calling isName() with one argument

Browse Source 
Unless you actually need to check that something is both a `Name` and also of the *correct* type, using `instanceof Name` directly should be a tiny bit more efficient since it avoids one function call and an unnecessary `undefined` check.

This patch uses ESLint to enforce this, since we obviously still want to keep the `isName` helper function for where it makes sense.
This commit is contained in:
Jonas Jenwald 2022-02-21 12:45:00 +01:00
parent 4df82ad31e
commit b282814e38
13 changed files with 85 additions and 73 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.eslintrc
View File

@ -187,6 +187,10 @@
"selector": "CallExpression[callee.name='isDict'][arguments.length<2]",
"message": "Use `instanceof Dict` rather than `isDict()` with one argument.",
},
{
"selector": "CallExpression[callee.name='isName'][arguments.length<2]",
"message": "Use `instanceof Name` rather than `isName()` with one argument.",
},
{
"selector": "NewExpression[callee.name='Cmd']",
"message": "Use `Cmd.get()` rather than `new Cmd()`.",

22
src/core/annotation.js
View File

@ -104,7 +104,7 @@ class AnnotationFactory {
// Determine the annotation's subtype.
let subtype = dict.get("Subtype");
subtype = isName(subtype) ? subtype.name : null;
subtype = subtype instanceof Name ? subtype.name : null;
// Return the right annotation object based on the subtype and field type.
const parameters = {
@ -128,7 +128,7 @@ class AnnotationFactory {
case "Widget":
let fieldType = getInheritableProperty({ dict, key: "FT" });
fieldType = isName(fieldType) ? fieldType.name : null;
fieldType = fieldType instanceof Name ? fieldType.name : null;
switch (fieldType) {
case "Tx":
@ -698,7 +698,7 @@ class Annotation {
// In case the normal appearance is a dictionary, the `AS` entry provides
// the key of the stream in this dictionary.
const as = dict.get("AS");
if (!isName(as) || !normalAppearanceState.has(as.name)) {
if (!(as instanceof Name) || !normalAppearanceState.has(as.name)) {
return;
}
this.appearance = normalAppearanceState.get(as.name);
@ -912,7 +912,7 @@ class AnnotationBorderStyle {
// Some corrupt PDF generators may provide the width as a `Name`,
// rather than as a number (fixes issue 10385).
if (isName(width)) {
if (width instanceof Name) {
this.width = 0; // This is consistent with the behaviour in Adobe Reader.
return;
}
@ -946,7 +946,7 @@ class AnnotationBorderStyle {
* @see {@link shared/util.js}
*/
setStyle(style) {
if (!isName(style)) {
if (!(style instanceof Name)) {
return;
}
switch (style.name) {
@ -1055,7 +1055,8 @@ class MarkupAnnotation extends Annotation {
this.data.inReplyTo = rawIRT instanceof Ref ? rawIRT.toString() : null;
const rt = dict.get("RT");
this.data.replyType = isName(rt) ? rt.name : AnnotationReplyType.REPLY;
this.data.replyType =
rt instanceof Name ? rt.name : AnnotationReplyType.REPLY;
}
if (this.data.replyType === AnnotationReplyType.GROUP) {
@ -1265,7 +1266,7 @@ class WidgetAnnotation extends Annotation {
);
const fieldType = getInheritableProperty({ dict, key: "FT" });
data.fieldType = isName(fieldType) ? fieldType.name : null;
data.fieldType = fieldType instanceof Name ? fieldType.name : null;
const localResources = getInheritableProperty({ dict, key: "DR" });
const acroFormResources = params.acroForm.get("DR");
@ -1306,7 +1307,7 @@ class WidgetAnnotation extends Annotation {
return formValue
.filter(item => isString(item))
.map(item => stringToPDFString(item));
} else if (isName(formValue)) {
} else if (formValue instanceof Name) {
return stringToPDFString(formValue.name);
} else if (isString(formValue)) {
return stringToPDFString(formValue);
@ -2321,7 +2322,7 @@ class ButtonWidgetAnnotation extends WidgetAnnotation {
if (fieldParent instanceof Dict) {
this.parent = params.dict.getRaw("Parent");
const fieldParentValue = fieldParent.get("V");
if (isName(fieldParentValue)) {
if (fieldParentValue instanceof Name) {
this.data.fieldValue = this._decodeFormValue(fieldParentValue);
}
}
@ -2566,7 +2567,8 @@ class PopupAnnotation extends Annotation {
}
const parentSubtype = parentItem.get("Subtype");
this.data.parentType = isName(parentSubtype) ? parentSubtype.name : null;
this.data.parentType =
parentSubtype instanceof Name ? parentSubtype.name : null;
const rawParent = parameters.dict.getRaw("Parent");
this.data.parentId = rawParent instanceof Ref ? rawParent.toString() : null;

21
src/core/catalog.js
View File

@ -529,9 +529,10 @@ class Catalog {
creator: isString(config.get("Creator"))
? stringToPDFString(config.get("Creator"))
: null,
baseState: isName(config.get("BaseState"))
? config.get("BaseState").name
: null,
baseState:
config.get("BaseState") instanceof Name
? config.get("BaseState").name
: null,
on: parseOnOff(config.get("ON")),
off: parseOnOff(config.get("OFF")),
order: parseOrder(config.get("Order")),
@ -667,7 +668,7 @@ class Catalog {
if (labelDict.has("S")) {
const s = labelDict.get("S");
if (!isName(s)) {
if (!(s instanceof Name)) {
throw new FormatError("Invalid style in PageLabel dictionary.");
}
style = s.name;
@ -743,7 +744,7 @@ class Catalog {
// affect the Scroll mode (continuous/non-continuous) used in Adobe Reader.
let pageLayout = "";
if (isName(obj)) {
if (obj instanceof Name) {
switch (obj.name) {
case "SinglePage":
case "OneColumn":
@ -761,7 +762,7 @@ class Catalog {
const obj = this._catDict.get("PageMode");
let pageMode = "UseNone"; // Default value.
if (isName(obj)) {
if (obj instanceof Name) {
switch (obj.name) {
case "UseNone":
case "UseOutlines":
@ -1465,7 +1466,7 @@ class Catalog {
if (action instanceof Dict) {
const actionType = action.get("S");
if (!isName(actionType)) {
if (!(actionType instanceof Name)) {
warn("parseDestDictionary: Invalid type in Action dictionary.");
return;
}
@ -1519,7 +1520,7 @@ class Catalog {
// NOTE: the destination is relative to the *remote* document.
let remoteDest = action.get("D");
if (remoteDest) {
if (isName(remoteDest)) {
if (remoteDest instanceof Name) {
remoteDest = remoteDest.name;
}
if (isString(url)) {
@ -1540,7 +1541,7 @@ class Catalog {
case "Named":
const namedAction = action.get("N");
if (isName(namedAction)) {
if (namedAction instanceof Name) {
resultObj.action = namedAction.name;
}
break;
@ -1587,7 +1588,7 @@ class Catalog {
resultObj.unsafeUrl = url;
}
if (dest) {
if (isName(dest)) {
if (dest instanceof Name) {
dest = dest.name;
}
if (isString(dest) || Array.isArray(dest)) {

10
src/core/cmap.js
View File

@ -20,7 +20,7 @@ import {
unreachable,
warn,
} from "../shared/util.js";
import { Cmd, EOF, isCmd, isName } from "./primitives.js";
import { Cmd, EOF, isCmd, Name } from "./primitives.js";
import { BaseStream } from "./base_stream.js";
import { Lexer } from "./parser.js";
import { MissingDataException } from "./core_utils.js";
@ -901,7 +901,7 @@ const CMapFactory = (function CMapFactoryClosure() {
function parseCMapName(cMap, lexer) {
const obj = lexer.getObj();
if (isName(obj) && isString(obj.name)) {
if (obj instanceof Name && isString(obj.name)) {
cMap.name = obj.name;
}
}
@ -913,7 +913,7 @@ const CMapFactory = (function CMapFactoryClosure() {
const obj = lexer.getObj();
if (obj === EOF) {
break;
} else if (isName(obj)) {
} else if (obj instanceof Name) {
if (obj.name === "WMode") {
parseWMode(cMap, lexer);
} else if (obj.name === "CMapName") {
@ -925,7 +925,7 @@ const CMapFactory = (function CMapFactoryClosure() {
case "endcmap":
break objLoop;
case "usecmap":
if (isName(previous)) {
if (previous instanceof Name) {
embeddedUseCMap = previous.name;
}
break;
@ -1024,7 +1024,7 @@ const CMapFactory = (function CMapFactoryClosure() {
const fetchBuiltInCMap = params.fetchBuiltInCMap;
const useCMap = params.useCMap;
if (isName(encoding)) {
if (encoding instanceof Name) {
return createBuiltInCMap(encoding.name, fetchBuiltInCMap);
} else if (encoding instanceof BaseStream) {
const parsedCMap = await parseCMap(

6
src/core/colorspace.js
View File

@ -21,7 +21,7 @@ import {
unreachable,
warn,
} from "../shared/util.js";
import { Dict, isName, Name, Ref } from "./primitives.js";
import { Dict, Name, Ref } from "./primitives.js";
import { BaseStream } from "./base_stream.js";
import { MissingDataException } from "./core_utils.js";
@ -378,7 +378,7 @@ class ColorSpace {
*/
static _parse(cs, xref, resources = null, pdfFunctionFactory) {
cs = xref.fetchIfRef(cs);
if (isName(cs)) {
if (cs instanceof Name) {
switch (cs.name) {
case "G":
case "DeviceGray":
@ -397,7 +397,7 @@ class ColorSpace {
if (colorSpaces instanceof Dict) {
const resourcesCS = colorSpaces.get(cs.name);
if (resourcesCS) {
if (isName(resourcesCS)) {
if (resourcesCS instanceof Name) {
return this._parse(
resourcesCS,
xref,

4
src/core/crypto.js
View File

@ -1647,7 +1647,7 @@ const CipherTransformFactory = (function CipherTransformFactoryClosure() {
}
function buildCipherConstructor(cf, name, num, gen, key) {
if (!isName(name)) {
if (!(name instanceof Name)) {
throw new FormatError("Invalid crypt filter name.");
}
const cryptFilter = cf.get(name.name);
@ -1713,7 +1713,7 @@ const CipherTransformFactory = (function CipherTransformFactoryClosure() {
// Trying to find default handler -- it usually has Length.
const cfDict = dict.get("CF");
const streamCryptoName = dict.get("StmF");
if (cfDict instanceof Dict && isName(streamCryptoName)) {
if (cfDict instanceof Dict && streamCryptoName instanceof Name) {
cfDict.suppressEncryption = true; // See comment below.
const handlerDict = cfDict.get(streamCryptoName.name);
keyLength = (handlerDict && handlerDict.get("Length")) || 128;

2
src/core/document.js
View File

@ -1196,7 +1196,7 @@ class PDFDocument {
let customValue;
if (isString(value)) {
customValue = stringToPDFString(value);
} else if (isName(value) || isNum(value) || isBool(value)) {
} else if (value instanceof Name || isNum(value) || isBool(value)) {
customValue = value;
} else {
info(`Unsupported value in document info for (custom) "${key}".`);

54
src/core/evaluator.js
View File

@ -124,7 +124,7 @@ function normalizeBlendMode(value, parsingArray = false) {
return "source-over";
}
if (!isName(value)) {
if (!(value instanceof Name)) {
if (parsingArray) {
return null;
}
@ -1450,7 +1450,7 @@ class PartialEvaluator {
}
const length = array.length;
const operator = this.xref.fetchIfRef(array[0]);
if (length < 2 || !isName(operator)) {
if (length < 2 || !(operator instanceof Name)) {
warn("Invalid visibility expression");
return;
}
@ -1481,7 +1481,7 @@ class PartialEvaluator {
async parseMarkedContentProps(contentProperties, resources) {
let optionalContent;
if (isName(contentProperties)) {
if (contentProperties instanceof Name) {
const properties = resources.get("Properties");
optionalContent = properties.get(contentProperties.name);
} else if (contentProperties instanceof Dict) {
@ -1527,9 +1527,10 @@ class PartialEvaluator {
return {
type: optionalContentType,
ids: groupIds,
policy: isName(optionalContent.get("P"))
? optionalContent.get("P").name
: null,
policy:
optionalContent.get("P") instanceof Name
? optionalContent.get("P").name
: null,
expression: null,
};
} else if (optionalContentGroups instanceof Ref) {
@ -1658,7 +1659,7 @@ class PartialEvaluator {
}
const type = xobj.dict.get("Subtype");
if (!isName(type)) {
if (!(type instanceof Name)) {
throw new FormatError("XObject should have a Name subtype");
}
@ -2058,7 +2059,7 @@ class PartialEvaluator {
// but doing so is meaningless without knowing the semantics.
continue;
case OPS.beginMarkedContentProps:
if (!isName(args[0])) {
if (!(args[0] instanceof Name)) {
warn(`Expected name for beginMarkedContentProps arg0=${args[0]}`);
continue;
}
@ -2980,7 +2981,7 @@ class PartialEvaluator {
}
const type = xobj.dict.get("Subtype");
if (!isName(type)) {
if (!(type instanceof Name)) {
throw new FormatError("XObject should have a Name subtype");
}
@ -3116,7 +3117,7 @@ class PartialEvaluator {
if (includeMarkedContent) {
textContent.items.push({
type: "beginMarkedContent",
tag: isName(args[0]) ? args[0].name : null,
tag: args[0] instanceof Name ? args[0].name : null,
});
}
break;
@ -3132,7 +3133,7 @@ class PartialEvaluator {
id: Number.isInteger(mcid)
? `${self.idFactory.getPageObjId()}_mcid${mcid}`
: null,
tag: isName(args[0]) ? args[0].name : null,
tag: args[0] instanceof Name ? args[0].name : null,
});
}
break;
@ -3215,9 +3216,8 @@ class PartialEvaluator {
encoding = dict.get("Encoding");
if (encoding instanceof Dict) {
baseEncodingName = encoding.get("BaseEncoding");
baseEncodingName = isName(baseEncodingName)
? baseEncodingName.name
: null;
baseEncodingName =
baseEncodingName instanceof Name ? baseEncodingName.name : null;
// Load the differences between the base and original
if (encoding.has("Differences")) {
const diffEncoding = encoding.get("Differences");
@ -3226,7 +3226,7 @@ class PartialEvaluator {
const data = xref.fetchIfRef(diffEncoding[j]);
if (isNum(data)) {
index = data;
} else if (isName(data)) {
} else if (data instanceof Name) {
differences[index++] = data.name;
} else {
throw new FormatError(
@ -3235,7 +3235,7 @@ class PartialEvaluator {
}
}
}
} else if (isName(encoding)) {
} else if (encoding instanceof Name) {
baseEncodingName = encoding.name;
} else {
throw new FormatError("Encoding is not a Name nor a Dict");
@ -3487,7 +3487,7 @@ class PartialEvaluator {
if (!cmapObj) {
return Promise.resolve(null);
}
if (isName(cmapObj)) {
if (cmapObj instanceof Name) {
return CMapFactory.create({
encoding: cmapObj,
fetchBuiltInCMap: this._fetchBuiltInCMapBound,
@ -3639,7 +3639,7 @@ class PartialEvaluator {
} else {
// Trying get the BaseFont metrics (see comment above).
const baseFontName = dict.get("BaseFont");
if (isName(baseFontName)) {
if (baseFontName instanceof Name) {
const metrics = this.getBaseFontMetrics(baseFontName.name);
glyphsWidths = this.buildCharCodeToWidth(metrics.widths, properties);
@ -3737,7 +3737,7 @@ class PartialEvaluator {
preEvaluateFont(dict) {
const baseDict = dict;
let type = dict.get("Subtype");
if (!isName(type)) {
if (!(type instanceof Name)) {
throw new FormatError("invalid font Subtype");
}
@ -3758,7 +3758,7 @@ class PartialEvaluator {
throw new FormatError("Descendant font is not a dictionary.");
}
type = dict.get("Subtype");
if (!isName(type)) {
if (!(type instanceof Name)) {
throw new FormatError("invalid font Subtype");
}
composite = true;
@ -3771,13 +3771,13 @@ class PartialEvaluator {
hash = new MurmurHash3_64();
const encoding = baseDict.getRaw("Encoding");
if (isName(encoding)) {
if (encoding instanceof Name) {
hash.update(encoding.name);
} else if (encoding instanceof Ref) {
hash.update(encoding.toString());
} else if (encoding instanceof Dict) {
for (const entry of encoding.getRawValues()) {
if (isName(entry)) {
if (entry instanceof Name) {
hash.update(entry.name);
} else if (entry instanceof Ref) {
hash.update(entry.toString());
@ -3788,7 +3788,7 @@ class PartialEvaluator {
for (let j = 0; j < diffLength; j++) {
const diffEntry = entry[j];
if (isName(diffEntry)) {
if (diffEntry instanceof Name) {
diffBuf[j] = diffEntry.name;
} else if (isNum(diffEntry) || diffEntry instanceof Ref) {
diffBuf[j] = diffEntry.toString();
@ -3812,7 +3812,7 @@ class PartialEvaluator {
stream.end - stream.start
);
hash.update(uint8array);
} else if (isName(toUnicode)) {
} else if (toUnicode instanceof Name) {
hash.update(toUnicode.name);
}
@ -3900,7 +3900,7 @@ class PartialEvaluator {
// FontDescriptor was not required.
// This case is here for compatibility.
let baseFontName = dict.get("BaseFont");
if (!isName(baseFontName)) {
if (!(baseFontName instanceof Name)) {
throw new FormatError("Base font is not specified");
}
@ -3996,7 +3996,7 @@ class PartialEvaluator {
}
fontName = fontName || baseFont;
if (!isName(fontName)) {
if (!(fontName instanceof Name)) {
throw new FormatError("invalid font name");
}
@ -4080,7 +4080,7 @@ class PartialEvaluator {
if (composite) {
const cidEncoding = baseDict.get("Encoding");
if (isName(cidEncoding)) {
if (cidEncoding instanceof Name) {
properties.cidEncoding = cidEncoding.name;
}
const cMap = await CMapFactory.create({

4
src/core/image.js
View File

@ -14,12 +14,12 @@
*/
import { assert, FormatError, ImageKind, info, warn } from "../shared/util.js";
import { isName, Name } from "./primitives.js";
import { BaseStream } from "./base_stream.js";
import { ColorSpace } from "./colorspace.js";
import { DecodeStream } from "./decode_stream.js";
import { JpegStream } from "./jpeg_stream.js";
import { JpxImage } from "./jpx.js";
import { Name } from "./primitives.js";
/**
* Decode and clamp a value. The formula is different from the spec because we
@ -95,7 +95,7 @@ class PDFImage {
const dict = image.dict;
const filter = dict.get("F", "Filter");
if (isName(filter)) {
if (filter instanceof Name) {
switch (filter.name) {
case "JPXDecode":
const jpxImage = new JpxImage();

14
src/core/parser.js
View File

@ -22,7 +22,7 @@ import {
StreamType,
warn,
} from "../shared/util.js";
import { Cmd, Dict, EOF, isCmd, isName, Name, Ref } from "./primitives.js";
import { Cmd, Dict, EOF, isCmd, Name, Ref } from "./primitives.js";
import {
isWhiteSpace,
MissingDataException,
@ -128,7 +128,7 @@ class Parser {
case "<<": // dictionary or stream
const dict = new Dict(this.xref);
while (!isCmd(this.buf1, ">>") && this.buf1 !== EOF) {
if (!isName(this.buf1)) {
if (!(this.buf1 instanceof Name)) {
info("Malformed dictionary: key must be a name object");
this.shift();
continue;
@ -489,7 +489,7 @@ class Parser {
const dict = new Dict(this.xref);
let dictLength;
while (!isCmd(this.buf1, "ID") && this.buf1 !== EOF) {
if (!isName(this.buf1)) {
if (!(this.buf1 instanceof Name)) {
throw new FormatError("Dictionary key must be a name object");
}
const key = this.buf1.name;
@ -506,11 +506,11 @@ class Parser {
// Extract the name of the first (i.e. the current) image filter.
const filter = dict.get("F", "Filter");
let filterName;
if (isName(filter)) {
if (filter instanceof Name) {
filterName = filter.name;
} else if (Array.isArray(filter)) {
const filterZero = this.xref.fetchIfRef(filter[0]);
if (isName(filterZero)) {
if (filterZero instanceof Name) {
filterName = filterZero.name;
}
}
@ -695,7 +695,7 @@ class Parser {
let filter = dict.get("F", "Filter");
let params = dict.get("DP", "DecodeParms");
if (isName(filter)) {
if (filter instanceof Name) {
if (Array.isArray(params)) {
warn("/DecodeParms should not be an Array, when /Filter is a Name.");
}
@ -708,7 +708,7 @@ class Parser {
const paramsArray = params;
for (let i = 0, ii = filterArray.length; i < ii; ++i) {
filter = this.xref.fetchIfRef(filterArray[i]);
if (!isName(filter)) {
if (!(filter instanceof Name)) {
throw new FormatError(`Bad filter name "${filter}"`);
}

9
src/core/struct_tree.js
View File

@ -13,7 +13,7 @@
* limitations under the License.
*/
import { Dict, isName, Ref } from "./primitives.js";
import { Dict, isName, Name, Ref } from "./primitives.js";
import { isString, stringToPDFString, warn } from "../shared/util.js";
import { NumberTree } from "./name_number_tree.js";
@ -42,7 +42,7 @@ class StructTreeRoot {
return;
}
roleMapDict.forEach((key, value) => {
if (!isName(value)) {
if (!(value instanceof Name)) {
return;
}
this.roleMap.set(key, value.name);
@ -64,7 +64,7 @@ class StructElementNode {
get role() {
const nameObj = this.dict.get("S");
const name = isName(nameObj) ? nameObj.name : "";
const name = nameObj instanceof Name ? nameObj.name : "";
const { root } = this.tree;
if (root.roleMap.has(name)) {
return root.roleMap.get(name);
@ -123,7 +123,8 @@ class StructElementNode {
pageObjId = pageRef.toString();
}
const type = isName(kidDict.get("Type")) ? kidDict.get("Type").name : null;
const type =
kidDict.get("Type") instanceof Name ? kidDict.get("Type").name : null;
if (type === "MCR") {
if (this.tree.pageDict.objId !== pageObjId) {
return null;

4
src/core/writer.js
View File

@ -14,7 +14,7 @@
*/
import { bytesToString, escapeString, warn } from "../shared/util.js";
import { Dict, isName, Name, Ref } from "./primitives.js";
import { Dict, Name, Ref } from "./primitives.js";
import { escapePDFName, parseXFAPath } from "./core_utils.js";
import { SimpleDOMNode, SimpleXMLParser } from "./xml_parser.js";
import { BaseStream } from "./base_stream.js";
@ -71,7 +71,7 @@ function numberToString(value) {
}
function writeValue(value, buffer, transform) {
if (isName(value)) {
if (value instanceof Name) {
buffer.push(`/${escapePDFName(value.name)}`);
} else if (value instanceof Ref) {
buffer.push(`${value.num} ${value.gen} R`);

4
test/unit/primitives_spec.js
View File

@ -470,6 +470,8 @@ describe("primitives", function () {
});
describe("isName", function () {
/* eslint-disable no-restricted-syntax */
it("handles non-names", function () {
const nonName = {};
expect(isName(nonName)).toEqual(false);
@ -493,6 +495,8 @@ describe("primitives", function () {
expect(isName(emptyName, "")).toEqual(true);
expect(isName(emptyName, "string")).toEqual(false);
});
/* eslint-enable no-restricted-syntax */
});
describe("isCmd", function () {