Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
70 changes: 69 additions & 1 deletion packages/dev/core/src/Engines/engine.common.ts
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,24 @@ export function _CommonDispose(commonEngine: AbstractEngine, canvas: Nullable<HT
* @returns an object containing ascent, height and descent
*/
export function GetFontOffset(font: string): { ascent: number; height: number; descent: number } {
const domFontOffset = GetFontOffsetFromDom(font);
if (domFontOffset) {
return domFontOffset;
}

const canvasFontOffset = GetFontOffsetFromCanvas(font);
if (canvasFontOffset) {
return canvasFontOffset;
}

return GetFallbackFontOffset(font);
}

function GetFontOffsetFromDom(font: string): Nullable<{ ascent: number; height: number; descent: number }> {
if (!IsDocumentAvailable() || !document.body) {
return null;
}

const text = document.createElement("span");
text.textContent = "Hg";
text.style.font = font;
Expand All @@ -169,7 +187,57 @@ export function GetFontOffset(font: string): { ascent: number; height: number; d
} finally {
document.body.removeChild(div);
}
return { ascent: fontAscent, height: fontHeight, descent: fontHeight - fontAscent };

const offset = { ascent: fontAscent, height: fontHeight, descent: fontHeight - fontAscent };
return IsValidFontOffset(offset) ? offset : null;
}

function GetFontOffsetFromCanvas(font: string): Nullable<{ ascent: number; height: number; descent: number }> {
let canvas: Nullable<OffscreenCanvas | HTMLCanvasElement> = null;
try {
if (typeof OffscreenCanvas !== "undefined") {
canvas = new OffscreenCanvas(64, 64);
} else if (IsDocumentAvailable() && typeof document.createElement === "function") {
canvas = document.createElement("canvas");
canvas.width = 64;
canvas.height = 64;
}

const context = canvas?.getContext("2d") as Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
if (!context) {
return null;
}

context.font = font;
const metrics = context.measureText("Hg");
const ascent = Number(metrics.fontBoundingBoxAscent ?? metrics.actualBoundingBoxAscent);
const descent = Number(metrics.fontBoundingBoxDescent ?? metrics.actualBoundingBoxDescent);
Comment on lines +213 to +214
const offset = { ascent, height: ascent + descent, descent };
return IsValidFontOffset(offset) ? offset : null;
} catch {
return null;
} finally {
const disposableCanvas = canvas as Nullable<{ dispose?: () => void }>;
if (typeof disposableCanvas?.dispose === "function") {
disposableCanvas.dispose();
}
}
}

function GetFallbackFontOffset(font: string): { ascent: number; height: number; descent: number } {
const size = Math.max(1, GetCssPixelFontSize(font));
const ascent = size * 0.8;
const descent = size * 0.2;
return { ascent, height: ascent + descent, descent };
}

function GetCssPixelFontSize(font: string): number {
const match = /(?:^|\s)([0-9]+(?:\.[0-9]+)?)px(?:\/|\s|$)/.exec(String(font || ""));
return match ? Number(match[1]) : 16;
}

function IsValidFontOffset(offset: { ascent: number; height: number; descent: number }): boolean {
return Number.isFinite(offset.ascent) && Number.isFinite(offset.height) && Number.isFinite(offset.descent) && offset.height > 0;
}

/** @internal */
Expand Down
64 changes: 64 additions & 0 deletions packages/dev/core/test/unit/Engines/engine.common.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
/**
* @vitest-environment jsdom
*/

import { GetFontOffset } from "core/Engines/engine.common";
import { afterEach, describe, expect, it, vi } from "vitest";

describe("GetFontOffset", () => {
const originalOffscreenCanvas = globalThis.OffscreenCanvas;

afterEach(() => {
vi.restoreAllMocks();
Object.defineProperty(globalThis, "OffscreenCanvas", {
configurable: true,
writable: true,
value: originalOffscreenCanvas,
});
});

it("falls back to canvas text metrics when DOM layout reports zero font bounds", () => {
Object.defineProperty(globalThis, "OffscreenCanvas", {
configurable: true,
writable: true,
value: undefined,
});

const createElement = document.createElement.bind(document);
vi.spyOn(document, "createElement").mockImplementation(((tagName: string) => {
if (tagName.toLowerCase() === "canvas") {
return {
width: 0,
height: 0,
getContext: () => ({
font: "",
measureText: () => ({
fontBoundingBoxAscent: 17,
fontBoundingBoxDescent: 5,
}),
}),
} as unknown as HTMLElement;
}

const element = createElement(tagName);
vi.spyOn(element, "getBoundingClientRect").mockReturnValue({
x: 0,
y: 0,
top: 0,
left: 0,
right: 0,
bottom: 0,
width: 0,
height: 0,
toJSON: () => ({}),
});
return element;
}) as typeof document.createElement);

expect(GetFontOffset("24px droidsans")).toEqual({
ascent: 17,
height: 22,
descent: 5,
});
});
});
Loading