Skip to content

Re-factor the Catalog.viewerPreferences method and remove the isBool helper function #14598

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 23, 2022
Merged

Re-factor the Catalog.viewerPreferences method and remove the isBool helper function #14598

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
82f1ee1
Re-factor the `Catalog.viewerPreferences` method
Snuffleupagus Feb 23, 2022
3704283
Remove the `isBool` helper function
Snuffleupagus Feb 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
141 changes: 64 additions & 77 deletions src/core/catalog.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ import {
DocumentActionEventType,
FormatError,
info,
isBool,
isString,
objectSize,
PermissionFlag,
Expand Down Expand Up @@ -221,7 +220,7 @@ class Catalog {
continue;
}
const value = obj.get(key);
if (!isBool(value)) {
if (typeof value !== "boolean") {
continue;
}
markInfo[key] = value;
Expand Down Expand Up @@ -776,44 +775,30 @@ class Catalog {
}

get viewerPreferences() {
const ViewerPreferencesValidators = {
HideToolbar: isBool,
HideMenubar: isBool,
HideWindowUI: isBool,
FitWindow: isBool,
CenterWindow: isBool,
DisplayDocTitle: isBool,
NonFullScreenPageMode: isName,
Direction: isName,
ViewArea: isName,
ViewClip: isName,
PrintArea: isName,
PrintClip: isName,
PrintScaling: isName,
Duplex: isName,
PickTrayByPDFSize: isBool,
PrintPageRange: Array.isArray,
NumCopies: Number.isInteger,
};

const obj = this._catDict.get("ViewerPreferences");
if (!(obj instanceof Dict)) {
return shadow(this, "viewerPreferences", null);
}
let prefs = null;

if (obj instanceof Dict) {
for (const key in ViewerPreferencesValidators) {
if (!obj.has(key)) {
continue;
}
const value = obj.get(key);
// Make sure the (standard) value conforms to the specification.
if (!ViewerPreferencesValidators[key](value)) {
info(`Bad value in ViewerPreferences for "${key}".`);
continue;
}
let prefValue;

switch (key) {
case "NonFullScreenPageMode":
for (const key of obj.getKeys()) {
const value = obj.get(key);
let prefValue;

switch (key) {
case "HideToolbar":
case "HideMenubar":
case "HideWindowUI":
case "FitWindow":
case "CenterWindow":
case "DisplayDocTitle":
case "PickTrayByPDFSize":
if (typeof value === "boolean") {
prefValue = value;
}
break;
case "NonFullScreenPageMode":
if (value instanceof Name) {
switch (value.name) {
case "UseNone":
case "UseOutlines":
Expand All @@ -824,8 +809,10 @@ class Catalog {
default:
prefValue = "UseNone";
}
break;
case "Direction":
}
break;
case "Direction":
if (value instanceof Name) {
switch (value.name) {
case "L2R":
case "R2L":
Expand All @@ -834,11 +821,13 @@ class Catalog {
default:
prefValue = "L2R";
}
break;
case "ViewArea":
case "ViewClip":
case "PrintArea":
case "PrintClip":
}
break;
case "ViewArea":
case "ViewClip":
case "PrintArea":
case "PrintClip":
if (value instanceof Name) {
switch (value.name) {
case "MediaBox":
case "CropBox":
Expand All @@ -850,8 +839,10 @@ class Catalog {
default:
prefValue = "CropBox";
}
break;
case "PrintScaling":
}
break;
case "PrintScaling":
if (value instanceof Name) {
switch (value.name) {
case "None":
case "AppDefault":
Expand All @@ -860,8 +851,10 @@ class Catalog {
default:
prefValue = "AppDefault";
}
break;
case "Duplex":
}
break;
case "Duplex":
if (value instanceof Name) {
switch (value.name) {
case "Simplex":
case "DuplexFlipShortEdge":
Expand All @@ -871,13 +864,11 @@ class Catalog {
default:
prefValue = "None";
}
break;
case "PrintPageRange":
const length = value.length;
if (length % 2 !== 0) {
// The number of elements must be even.
break;
}
}
break;
case "PrintPageRange":
// The number of elements must be even.
if (Array.isArray(value) && value.length % 2 === 0) {
const isValid = value.every((page, i, arr) => {
return (
Number.isInteger(page) &&
Expand All @@ -889,30 +880,26 @@ class Catalog {
if (isValid) {
prefValue = value;
}
break;
case "NumCopies":
if (value > 0) {
prefValue = value;
}
break;
default:
if (typeof value !== "boolean") {
throw new FormatError(
`viewerPreferences - expected a boolean value for: ${key}`
);
}
}
break;
case "NumCopies":
if (Number.isInteger(value) && value > 0) {
prefValue = value;
}

if (prefValue !== undefined) {
if (!prefs) {
prefs = Object.create(null);
}
prefs[key] = prefValue;
} else {
info(`Bad value in ViewerPreferences for "${key}".`);
}
break;
default:
warn(`Ignoring non-standard key in ViewerPreferences: ${key}.`);
continue;
}

if (prefValue === undefined) {
warn(`Bad value, for key "${key}", in ViewerPreferences: ${value}.`);
continue;
}
if (!prefs) {
prefs = Object.create(null);
}
prefs[key] = prefValue;
}
return shadow(this, "viewerPreferences", prefs);
}
Expand Down Expand Up @@ -1533,7 +1520,7 @@ class Catalog {
}
// The 'NewWindow' property, equal to `LinkTarget.BLANK`.
const newWindow = action.get("NewWindow");
if (isBool(newWindow)) {
if (typeof newWindow === "boolean") {
resultObj.newWindow = newWindow;
}
break;
Expand Down
9 changes: 4 additions & 5 deletions src/core/function.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ import { Dict, Ref } from "./primitives.js";
import {
FormatError,
info,
isBool,
IsEvalSupportedCached,
shadow,
unreachable,
Expand Down Expand Up @@ -627,7 +626,7 @@ class PostScriptEvaluator {
case "and":
b = stack.pop();
a = stack.pop();
if (isBool(a) && isBool(b)) {
if (typeof a === "boolean" && typeof b === "boolean") {
stack.push(a && b);
} else {
stack.push(a & b);
Expand Down Expand Up @@ -751,7 +750,7 @@ class PostScriptEvaluator {
break;
case "not":
a = stack.pop();
if (isBool(a)) {
if (typeof a === "boolean") {
stack.push(!a);
} else {
stack.push(~a);
Expand All @@ -760,7 +759,7 @@ class PostScriptEvaluator {
case "or":
b = stack.pop();
a = stack.pop();
if (isBool(a) && isBool(b)) {
if (typeof a === "boolean" && typeof b === "boolean") {
stack.push(a || b);
} else {
stack.push(a | b);
Expand Down Expand Up @@ -802,7 +801,7 @@ class PostScriptEvaluator {
case "xor":
b = stack.pop();
a = stack.pop();
if (isBool(a) && isBool(b)) {
if (typeof a === "boolean" && typeof b === "boolean") {
stack.push(a !== b);
} else {
stack.push(a ^ b);
Expand Down
5 changes: 0 additions & 5 deletions src/shared/util.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1030,10 +1030,6 @@ function utf8StringToString(str) {
return unescape(encodeURIComponent(str));
}

function isBool(v) {
return typeof v === "boolean";
}

function isString(v) {
return typeof v === "string";
}
Expand Down Expand Up @@ -1139,7 +1135,6 @@ export {
isArrayBuffer,
isArrayEqual,
isAscii,
isBool,
IsEvalSupportedCached,
IsLittleEndianCached,
isSameOrigin,
Expand Down
17 changes: 0 additions & 17 deletions test/unit/util_spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ import {
getModificationDate,
isArrayBuffer,
isAscii,
isBool,
isSameOrigin,
isString,
string32,
Expand Down Expand Up @@ -74,22 +73,6 @@ describe("util", function () {
});
});

describe("isBool", function () {
it("handles boolean values", function () {
expect(isBool(true)).toEqual(true);
expect(isBool(false)).toEqual(true);
});

it("handles non-boolean values", function () {
expect(isBool("true")).toEqual(false);
expect(isBool("false")).toEqual(false);
expect(isBool(1)).toEqual(false);
expect(isBool(0)).toEqual(false);
expect(isBool(null)).toEqual(false);
expect(isBool(undefined)).toEqual(false);
});
});

describe("isString", function () {
it("handles string values", function () {
expect(isString("foo")).toEqual(true);
Expand Down