1
0
Fork 0
mirror of https://github.com/mozilla/pdf.js.git synced 2025-04-20 15:18:08 +02:00

[api-minor] Re-factor NullL10n and remove the hard-coded l10n strings (PR 17115 follow-up)

*Please note:* These changes only affect the GENERIC build, since `NullL10n` is only a stub elsewhere (see PR 17135).

After the changes in PR 17115, which modernized and improved l10n-handling, the `NullL10n`-implementation is no longer a good fallback for the "proper" `L10n`-classes.
To improve this situation, especially for the *standalone* viewer-components, this patch makes the following changes:
 - Let the `NullL10n`-implementation extend an actual `L10n`-class, which is constant and lazily initialized, to ensure that it works *exactly* like the "proper" ones.

 - Automatically bundle the "en-US" l10n-strings in the build, via the pre-processor, such that we don't need to remember to manually update them.

 - Ensure that the *standalone* viewer-components register their DOM-elements for translation, similar to the default viewer, since this will allow future code improvements by using "data-l10n-id"/"data-l10n-args" in most (if not all) parts of the viewer.

 - Remove the `NullL10n` from the `AnnotationLayer`, to avoid affecting bundle size too much.
   For third-party users that access the `AnnotationLayer`, as exposed in the main PDF.js library, they'll now need to *manually* register it for translation. (However, the *standalone* viewer-components still works given the point above.)
This commit is contained in:
Jonas Jenwald 2023-10-19 22:12:46 +02:00
parent a4cd2ef1db
commit f07675a6a8
11 changed files with 72 additions and 125 deletions

View file

@ -192,12 +192,12 @@ class IL10n {
* Translates text identified by the key and adds/formats data using the args
* property bag. If the key was not found, translation falls back to the
* fallback text.
* @param {string} key
* @param {Array | string} ids
* @param {Object | null} [args]
* @param {string} [fallback]
* @returns {Promise<string>}
*/
async get(key, args = null, fallback) {}
async get(ids, args = null, fallback) {}
/**
* Translates HTML element.

View file

@ -13,107 +13,46 @@
* limitations under the License.
*/
/**
* PLEASE NOTE: This file is currently imported in both the `web/` and
* `src/display/` folders, hence be EXTREMELY careful about
* introducing any dependencies here since that can lead to an
* unexpected/unnecessary size increase of the *built* files.
*/
/** @typedef {import("./interfaces").IL10n} IL10n */
import { FluentBundle, FluentResource } from "fluent-bundle";
import { DOMLocalization } from "fluent-dom";
import { L10n } from "./l10n.js";
/**
* A subset of the l10n strings in the `l10n/en-US/viewer.ftl` file.
* @implements {IL10n}
*/
const DEFAULT_L10N_STRINGS = {
"pdfjs-of-pages": "of { $pagesCount }",
"pdfjs-page-of-pages": "({ $pageNumber } of { $pagesCount })",
class ConstL10n extends L10n {
static #instance;
"pdfjs-document-properties-kb": "{ $size-kb } KB ({ $size-b } bytes)",
"pdfjs-document-properties-mb": "{ $size-mb } MB ({ $size-b } bytes)",
"pdfjs-document-properties-date-string": "{ $date }, { $time }",
"pdfjs-document-properties-page-size-unit-inches": "in",
"pdfjs-document-properties-page-size-unit-millimeters": "mm",
"pdfjs-document-properties-page-size-orientation-portrait": "portrait",
"pdfjs-document-properties-page-size-orientation-landscape": "landscape",
"pdfjs-document-properties-page-size-name-a3": "A3",
"pdfjs-document-properties-page-size-name-a4": "A4",
"pdfjs-document-properties-page-size-name-letter": "Letter",
"pdfjs-document-properties-page-size-name-legal": "Legal",
"pdfjs-document-properties-page-size-dimension-string":
"{ $width } × { $height } { $unit } ({ $orientation })",
"pdfjs-document-properties-page-size-dimension-name-string":
"{ $width } × { $height } { $unit } ({ $name }, { $orientation })",
"pdfjs-document-properties-linearized-yes": "Yes",
"pdfjs-document-properties-linearized-no": "No",
"pdfjs-additional-layers": "Additional Layers",
"pdfjs-page-landmark": "Page { $page }",
"pdfjs-thumb-page-title": "Page { $page }",
"pdfjs-thumb-page-canvas": "Thumbnail of Page { $page }",
"pdfjs-find-reached-top": "Reached top of document, continued from bottom",
"pdfjs-find-reached-bottom": "Reached end of document, continued from top",
"pdfjs-find-match-count[one]": "{ $current } of { $total } match",
"pdfjs-find-match-count[other]": "{ $current } of { $total } matches",
"pdfjs-find-match-count-limit[one]": "More than { $limit } match",
"pdfjs-find-match-count-limit[other]": "More than { $limit } matches",
"pdfjs-find-not-found": "Phrase not found",
"pdfjs-page-scale-percent": "{ $scale }%",
"pdfjs-loading-error": "An error occurred while loading the PDF.",
"pdfjs-invalid-file-error": "Invalid or corrupted PDF file.",
"pdfjs-missing-file-error": "Missing PDF file.",
"pdfjs-unexpected-response-error": "Unexpected server response.",
"pdfjs-rendering-error": "An error occurred while rendering the page.",
"pdfjs-annotation-date-string": "{ $date }, { $time }",
"pdfjs-printing-not-supported":
"Warning: Printing is not fully supported by this browser.",
"pdfjs-printing-not-ready":
"Warning: The PDF is not fully loaded for printing.",
"pdfjs-web-fonts-disabled":
"Web fonts are disabled: unable to use embedded PDF fonts.",
"pdfjs-free-text-default-content": "Start typing…",
"pdfjs-editor-alt-text-button-label": "Alt text",
"pdfjs-editor-alt-text-edit-button-label": "Edit alt text",
"pdfjs-editor-alt-text-decorative-tooltip": "Marked as decorative",
"pdfjs-editor-resizer-label-top-left": "Top left corner — resize",
"pdfjs-editor-resizer-label-top-middle": "Top middle — resize",
"pdfjs-editor-resizer-label-top-right": "Top right corner — resize",
"pdfjs-editor-resizer-label-middle-right": "Middle right — resize",
"pdfjs-editor-resizer-label-bottom-right": "Bottom right corner — resize",
"pdfjs-editor-resizer-label-bottom-middle": "Bottom middle — resize",
"pdfjs-editor-resizer-label-bottom-left": "Bottom left corner — resize",
"pdfjs-editor-resizer-label-middle-left": "Middle left — resize",
};
if (typeof PDFJSDev === "undefined" || !PDFJSDev.test("MOZCENTRAL")) {
DEFAULT_L10N_STRINGS.print_progress_percent = "{ $progress }%";
}
function getL10nFallback(key, args) {
switch (key) {
case "pdfjs-find-match-count":
key = `pdfjs-find-match-count[${args.total === 1 ? "one" : "other"}]`;
break;
case "pdfjs-find-match-count-limit":
key = `pdfjs-find-match-count-limit[${
args.limit === 1 ? "one" : "other"
}]`;
break;
constructor(lang) {
super({ lang });
this.setL10n(
new DOMLocalization([], ConstL10n.#generateBundles.bind(ConstL10n, lang))
);
}
return DEFAULT_L10N_STRINGS[key] || "";
}
// Replaces { $arguments } with their values.
function formatL10nValue(text, args) {
if (!args) {
return text;
static async *#generateBundles(lang) {
let text;
if (typeof PDFJSDev === "undefined") {
const url = new URL(`./locale/${lang}/viewer.ftl`, window.location.href);
const data = await fetch(url);
text = await data.text();
} else {
text = PDFJSDev.eval("DEFAULT_FTL");
}
const resource = new FluentResource(text);
const bundle = new FluentBundle(lang);
const errors = bundle.addResource(resource);
if (errors.length) {
console.error("L10n errors", errors);
}
yield bundle;
}
static get instance() {
return (this.#instance ||= new ConstL10n("en-US"));
}
return text.replaceAll(/\{\s*$(\w+)\s*\}/g, (all, name) => {
return name in args ? args[name] : "{$" + name + "}";
});
}
/**
@ -122,18 +61,20 @@ function formatL10nValue(text, args) {
*/
const NullL10n = {
getLanguage() {
return "en-us";
return ConstL10n.instance.getLanguage();
},
getDirection() {
return "ltr";
return ConstL10n.instance.getDirection();
},
async get(key, args = null, fallback = getL10nFallback(key, args)) {
return formatL10nValue(fallback, args);
async get(ids, args = null, fallback) {
return ConstL10n.instance.get(ids, args, fallback);
},
async translate(element) {},
async translate(element) {
return ConstL10n.instance.translate(element);
},
};
export { NullL10n };

View file

@ -215,6 +215,11 @@ class PDFPageView {
optionalContentConfig.hasInitialVisibility;
});
}
// Ensure that Fluent is connected in e.g. the COMPONENTS build.
if (this.l10n === NullL10n) {
this.l10n.translate(this.div);
}
}
}

View file

@ -322,6 +322,14 @@ class PDFViewer {
pdfPage?.cleanup();
}
});
if (
(typeof PDFJSDev === "undefined" || PDFJSDev.test("GENERIC")) &&
this.l10n === NullL10n
) {
// Ensure that Fluent is connected in e.g. the COMPONENTS build.
this.l10n.translate(this.container);
}
}
get pagesCount() {

View file

@ -54,7 +54,6 @@ See https://github.com/adobe-type-tools/cmap-resources
"cached-iterable": "../node_modules/cached-iterable/src/index.mjs",
"display-fetch_stream": "../src/display/fetch_stream.js",
"display-l10n_utils": "../src/display/stubs.js",
"display-network": "../src/display/network.js",
"display-node_stream": "../src/display/stubs.js",
"display-node_utils": "../src/display/stubs.js",

View file

@ -63,7 +63,6 @@ See https://github.com/adobe-type-tools/cmap-resources
"cached-iterable": "../node_modules/cached-iterable/src/index.mjs",
"display-fetch_stream": "../src/display/fetch_stream.js",
"display-l10n_utils": "../src/display/stubs.js",
"display-network": "../src/display/network.js",
"display-node_stream": "../src/display/stubs.js",
"display-node_utils": "../src/display/stubs.js",