mirrors/pdf.js
1
0
Fork 0
mirror of https://github.com/mozilla/pdf.js.git synced 2025-04-19 14:48:08 +02:00
Code Activity

Merge pull request #18480 from Snuffleupagus/AppOptions-optional-type

Browse source 
Add better support for AppOptions with multiple types (PR 18465 follow-up)
This commit is contained in:
Tim van der Meij 2024-07-22 18:10:29 +02:00 • committed by GitHub
commit 5184a38e3d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 18 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

29
web/app_options.js
View file

@ -55,10 +55,18 @@ const OptionKind = {
API: 0x04,
WORKER: 0x08,
EVENT_DISPATCH: 0x10,
UNDEF_ALLOWED: 0x20,
PREFERENCE: 0x80,
};
// Should only be used with options that allow multiple types.
const Type = {
BOOLEAN: 0x01,
NUMBER: 0x02,
OBJECT: 0x04,
STRING: 0x08,
UNDEFINED: 0x10,
};
/**
* NOTE: These options are used to generate the `default_preferences.json` file,
* see `OptionKind.PREFERENCE`, hence the values below must use only
@ -405,7 +413,8 @@ const defaultOptions = {
)
? false
: undefined,
kind: OptionKind.API + OptionKind.UNDEF_ALLOWED,
kind: OptionKind.API,
type: Type.BOOLEAN + Type.UNDEFINED,
},
verbosity: {
/** @type {number} */
@ -484,7 +493,7 @@ if (typeof PDFJSDev === "undefined" || PDFJSDev.test("GENERIC")) {
if (typeof PDFJSDev === "undefined" || PDFJSDev.test("TESTING || LIB")) {
// Ensure that the `defaultOptions` are correctly specified.
for (const name in defaultOptions) {
const { value, kind } = defaultOptions[name];
const { value, kind, type } = defaultOptions[name];
if (kind & OptionKind.PREFERENCE) {
if (kind === OptionKind.PREFERENCE) {
@ -493,9 +502,9 @@ if (typeof PDFJSDev === "undefined" || PDFJSDev.test("TESTING || LIB")) {
if (kind & OptionKind.BROWSER) {
throw new Error(`Cannot mix "PREFERENCE" and "BROWSER" kind: ${name}`);
}
if (kind & OptionKind.UNDEF_ALLOWED) {
if (type !== undefined) {
throw new Error(
`Cannot allow \`undefined\` value for "PREFERENCE" kind: ${name}`
`Cannot have \`type\`-field for "PREFERENCE" kind: ${name}`
);
}
if (typeof compatParams === "object" && compatParams.has(name)) {
@ -512,9 +521,9 @@ if (typeof PDFJSDev === "undefined" || PDFJSDev.test("TESTING || LIB")) {
throw new Error(`Invalid value for "PREFERENCE" kind: ${name}`);
}
} else if (kind & OptionKind.BROWSER) {
if (kind & OptionKind.UNDEF_ALLOWED) {
if (type !== undefined) {
throw new Error(
`Cannot allow \`undefined\` value for "BROWSER" kind: ${name}`
`Cannot have \`type\`-field for "BROWSER" kind: ${name}`
);
}
if (typeof compatParams === "object" && compatParams.has(name)) {
@ -565,8 +574,7 @@ class AppOptions {
!defaultOpt ||
!(
typeof value === typeof defaultOpt.value ||
(defaultOpt.kind & OptionKind.UNDEF_ALLOWED &&
(value === undefined || defaultOpt.value === undefined))
Type[(typeof value).toUpperCase()] & defaultOpt.type
)
) {
return;
@ -585,8 +593,7 @@ class AppOptions {
!defaultOpt ||
!(
typeof userOpt === typeof defaultOpt.value ||
(defaultOpt.kind & OptionKind.UNDEF_ALLOWED &&
(userOpt === undefined || defaultOpt.value === undefined))
Type[(typeof userOpt).toUpperCase()] & defaultOpt.type
)
) {
continue;