@vivliostyle/core 2.24.3 → 2.25.0

package/lib/vivliostyle/font.d.ts

@@ -1,87 +1,87 @@
-import * as Css from "./css";
-import * as CssCascade from "./css-cascade";
-import * as Exprs from "./exprs";
-import * as Task from "./task";
-import * as TaskUtil from "./task-util";
-export declare const traitProps: {
-    [key: string]: Css.Val;
-};
-export declare const bogusFontData: string;
-export declare let bogusFontCounter: number;
-export declare function makeFontTraitKey(properties: {
-    [key: string]: Css.Val;
-}): string;
-export declare function fillDefaults(properties: {
-    [key: string]: Css.Val;
-}): void;
-export declare function prepareProperties(properties: CssCascade.ElementStyle, context: Exprs.Context): {
-    [key: string]: Css.Val;
-};
-/**
- * A font declared in a font-face rule.
- */
-export declare class Face {
-    readonly properties: {
-        [key: string]: Css.Val;
-    };
-    fontTraitKey: string;
-    src: string | null;
-    blobURLs: string[];
-    blobs: Blob[];
-    family: string | null;
-    constructor(properties: {
-        [key: string]: Css.Val;
-    });
-    /**
-     * Check if font traits are the same for two font faces
-     */
-    traitsEqual(other: Face): boolean;
-    /**
-     * Create "at" font-face rule.
-     */
-    makeAtRule(src: string, fontBytes: Blob): string;
-}
-/**
- * Set of the fonts declared in all stylesheets of a document.
- * @param deobfuscator function
- *     that takes url and returns data deobfuscator
- */
-export declare class DocumentFaces {
-    readonly deobfuscator: ((p1: string) => ((p1: Blob) => Task.Result<Blob>) | null) | null;
-    /**
-     * Maps source font family names to the family names used in the HTML view.
-     */
-    familyMap: {
-        [key: string]: string;
-    };
-    constructor(deobfuscator: ((p1: string) => ((p1: Blob) => Task.Result<Blob>) | null) | null);
-    registerFamily(srcFace: Face, viewFace: Face): void;
-    filterFontFamily(val: Css.Val): Css.Val;
-}
-/**
- * Object that loads fonts in a document and allocates font families for them
- * in the view document
- * @param head where to add styles in the view document (normally head element)
- * @param body where to probe text in the view document (normally body element)
- */
-export declare class Mapper {
-    readonly head: Element;
-    readonly body: Element;
-    /**
-     * Maps Face.src to an entry for an already-loaded font.
-     */
-    srcURLMap: {
-        [key: string]: TaskUtil.Fetcher<Face>;
-    };
-    familyPrefix: string;
-    familyCounter: number;
-    constructor(head: Element, body: Element, opt_familyPrefix?: string);
-    getViewFontFamily(srcFace: Face, documentFaces: DocumentFaces): string;
-    /**
-     * @param fontBytes deobfuscated font bytes (if deobfuscation is needed)
-     */
-    private initFont;
-    loadFont(srcFace: Face, documentFaces: DocumentFaces): TaskUtil.Fetcher<Face>;
-    findOrLoadFonts(srcFaces: Face[], documentFaces: DocumentFaces): Task.Result<boolean>;
-    waitFontLoading(): Task.Result<boolean>;
-}
+import * as Css from "./css";
+import * as CssCascade from "./css-cascade";
+import * as Exprs from "./exprs";
+import * as Task from "./task";
+import * as TaskUtil from "./task-util";
+export declare const traitProps: {
+    [key: string]: Css.Val;
+};
+export declare const bogusFontData: string;
+export declare let bogusFontCounter: number;
+export declare function makeFontTraitKey(properties: {
+    [key: string]: Css.Val;
+}): string;
+export declare function fillDefaults(properties: {
+    [key: string]: Css.Val;
+}): void;
+export declare function prepareProperties(properties: CssCascade.ElementStyle, context: Exprs.Context): {
+    [key: string]: Css.Val;
+};
+/**
+ * A font declared in a font-face rule.
+ */
+export declare class Face {
+    readonly properties: {
+        [key: string]: Css.Val;
+    };
+    fontTraitKey: string;
+    src: string | null;
+    blobURLs: string[];
+    blobs: Blob[];
+    family: string | null;
+    constructor(properties: {
+        [key: string]: Css.Val;
+    });
+    /**
+     * Check if font traits are the same for two font faces
+     */
+    traitsEqual(other: Face): boolean;
+    /**
+     * Create "at" font-face rule.
+     */
+    makeAtRule(src: string, fontBytes: Blob): string;
+}
+/**
+ * Set of the fonts declared in all stylesheets of a document.
+ * @param deobfuscator function
+ *     that takes url and returns data deobfuscator
+ */
+export declare class DocumentFaces {
+    readonly deobfuscator: ((p1: string) => ((p1: Blob) => Task.Result<Blob>) | null) | null;
+    /**
+     * Maps source font family names to the family names used in the HTML view.
+     */
+    familyMap: {
+        [key: string]: string;
+    };
+    constructor(deobfuscator: ((p1: string) => ((p1: Blob) => Task.Result<Blob>) | null) | null);
+    registerFamily(srcFace: Face, viewFace: Face): void;
+    filterFontFamily(val: Css.Val): Css.Val;
+}
+/**
+ * Object that loads fonts in a document and allocates font families for them
+ * in the view document
+ * @param head where to add styles in the view document (normally head element)
+ * @param body where to probe text in the view document (normally body element)
+ */
+export declare class Mapper {
+    readonly head: Element;
+    readonly body: Element;
+    /**
+     * Maps Face.src to an entry for an already-loaded font.
+     */
+    srcURLMap: {
+        [key: string]: TaskUtil.Fetcher<Face>;
+    };
+    familyPrefix: string;
+    familyCounter: number;
+    constructor(head: Element, body: Element, opt_familyPrefix?: string);
+    getViewFontFamily(srcFace: Face, documentFaces: DocumentFaces): string;
+    /**
+     * @param fontBytes deobfuscated font bytes (if deobfuscation is needed)
+     */
+    private initFont;
+    loadFont(srcFace: Face, documentFaces: DocumentFaces): TaskUtil.Fetcher<Face>;
+    findOrLoadFonts(srcFaces: Face[], documentFaces: DocumentFaces): Task.Result<boolean>;
+    waitFontLoading(): Task.Result<boolean>;
+}

package/lib/vivliostyle/footnotes.d.ts

@@ -1,41 +1,41 @@
-import * as Css from "./css";
-import * as PageFloats from "./page-floats";
-import * as Task from "./task";
-import * as Vtree from "./vtree";
-import { Layout } from "./types";
-declare const PageFloatFragment: typeof PageFloats.PageFloatFragment;
-export declare class Footnote extends PageFloats.PageFloat {
-    readonly footnotePolicy: Css.Ident | null;
-    constructor(nodePosition: Vtree.NodePosition, floatReference: PageFloats.FloatReference, flowName: string, footnotePolicy: Css.Ident | null, floatMinWrapBlock: Css.Numeric | null);
-    isAllowedToPrecede(other: PageFloats.PageFloat): boolean;
-}
-/**
- * @extends PageFloatFragment
- */
-export declare class FootnoteFragment extends PageFloatFragment {
-    constructor(floatReference: PageFloats.FloatReference, continuations: PageFloats.PageFloatContinuation[], area: Vtree.Container, continues: boolean);
-    getOrder(): number;
-    shouldBeStashedBefore(float: PageFloats.PageFloat): boolean;
-}
-export declare class LineFootnotePolicyLayoutConstraint implements Layout.LayoutConstraint {
-    readonly footnote: Footnote;
-    constructor(footnote: Footnote);
-    allowLayout(nodeContext: Vtree.NodeContext): boolean;
-}
-export declare class FootnoteLayoutStrategy implements PageFloats.PageFloatLayoutStrategy {
-    /** @override */
-    appliesToNodeContext(nodeContext: Vtree.NodeContext): boolean;
-    /** @override */
-    appliesToFloat(float: PageFloats.PageFloat): boolean;
-    /** @override */
-    createPageFloat(nodeContext: Vtree.NodeContext, pageFloatLayoutContext: PageFloats.PageFloatLayoutContext, column: Layout.Column): Task.Result<PageFloats.PageFloat>;
-    /** @override */
-    createPageFloatFragment(continuations: PageFloats.PageFloatContinuation[], floatSide: string, floatArea: Layout.PageFloatArea, continues: boolean): PageFloats.PageFloatFragment;
-    /** @override */
-    findPageFloatFragment(float: PageFloats.PageFloat, pageFloatLayoutContext: PageFloats.PageFloatLayoutContext): PageFloats.PageFloatFragment | null;
-    /** @override */
-    adjustPageFloatArea(floatArea: Layout.PageFloatArea, floatContainer: Vtree.Container, column: Layout.Column): void;
-    /** @override */
-    forbid(float: PageFloats.PageFloat, pageFloatLayoutContext: PageFloats.PageFloatLayoutContext): void;
-}
-export {};
+import * as Css from "./css";
+import * as PageFloats from "./page-floats";
+import * as Task from "./task";
+import * as Vtree from "./vtree";
+import { Layout } from "./types";
+declare const PageFloatFragment: typeof PageFloats.PageFloatFragment;
+export declare class Footnote extends PageFloats.PageFloat {
+    readonly footnotePolicy: Css.Ident | null;
+    constructor(nodePosition: Vtree.NodePosition, floatReference: PageFloats.FloatReference, flowName: string, footnotePolicy: Css.Ident | null, floatMinWrapBlock: Css.Numeric | null);
+    isAllowedToPrecede(other: PageFloats.PageFloat): boolean;
+}
+/**
+ * @extends PageFloatFragment
+ */
+export declare class FootnoteFragment extends PageFloatFragment {
+    constructor(floatReference: PageFloats.FloatReference, continuations: PageFloats.PageFloatContinuation[], area: Vtree.Container, continues: boolean);
+    getOrder(): number;
+    shouldBeStashedBefore(float: PageFloats.PageFloat): boolean;
+}
+export declare class LineFootnotePolicyLayoutConstraint implements Layout.LayoutConstraint {
+    readonly footnote: Footnote;
+    constructor(footnote: Footnote);
+    allowLayout(nodeContext: Vtree.NodeContext): boolean;
+}
+export declare class FootnoteLayoutStrategy implements PageFloats.PageFloatLayoutStrategy {
+    /** @override */
+    appliesToNodeContext(nodeContext: Vtree.NodeContext): boolean;
+    /** @override */
+    appliesToFloat(float: PageFloats.PageFloat): boolean;
+    /** @override */
+    createPageFloat(nodeContext: Vtree.NodeContext, pageFloatLayoutContext: PageFloats.PageFloatLayoutContext, column: Layout.Column): Task.Result<PageFloats.PageFloat>;
+    /** @override */
+    createPageFloatFragment(continuations: PageFloats.PageFloatContinuation[], floatSide: string, floatArea: Layout.PageFloatArea, continues: boolean): PageFloats.PageFloatFragment;
+    /** @override */
+    findPageFloatFragment(float: PageFloats.PageFloat, pageFloatLayoutContext: PageFloats.PageFloatLayoutContext): PageFloats.PageFloatFragment | null;
+    /** @override */
+    adjustPageFloatArea(floatArea: Layout.PageFloatArea, floatContainer: Vtree.Container, column: Layout.Column): void;
+    /** @override */
+    forbid(float: PageFloats.PageFloat, pageFloatLayoutContext: PageFloats.PageFloatLayoutContext): void;
+}
+export {};

package/lib/vivliostyle/geometry-util.d.ts

@@ -1,110 +1,110 @@
-export declare class Rect {
-    x1: number;
-    y1: number;
-    x2: number;
-    y2: number;
-    constructor(x1: number, y1: number, x2: number, y2: number);
-}
-export declare class Point {
-    x: number;
-    y: number;
-    constructor(x: number, y: number);
-}
-export declare class Insets {
-    left: number;
-    top: number;
-    right: number;
-    bottom: number;
-    constructor(left: number, top: number, right: number, bottom: number);
-}
-export declare class Segment {
-    low: Point;
-    high: Point;
-    winding: number;
-    shapeId: number;
-    constructor(low: Point, high: Point, winding: number, shapeId: number);
-}
-/**
- * A single band for exclusion result. Left float is from the left box edge
- * to x1. Right float is from x2 to the right box edge.
- */
-export declare class Band {
-    y1: number;
-    y2: number;
-    x1: number;
-    x2: number;
-    /** Left float. */
-    left: Element | null;
-    /** Right float. */
-    right: Element | null;
-    constructor(y1: number, y2: number, x1: number, x2: number);
-}
-export declare function segmentCompare(s1: Segment, s2: Segment): number;
-export declare class Shape {
-    points: Point[];
-    constructor(points: Point[]);
-    /**
-     * Converts this shape to a sequence of Segments and adds segments to the
-     * given array.
-     * @param arr array to add segments.
-     * @param id shapeId to write into segments.
-     */
-    addSegments(arr: Segment[], id: number): void;
-    withOffset(offsetX: number, offsetY: number): Shape;
-}
-export declare function shapeForEllipse(cx: number, cy: number, rx: number, ry: number): Shape;
-export declare function shapeForRect(x1: number, y1: number, x2: number, y2: number): Shape;
-export declare function shapeForRectObj(r: Rect): Shape;
-export declare class BandIntersection {
-    x: number;
-    winding: number;
-    shapeId: number;
-    lowOrHigh: number;
-    constructor(x: number, winding: number, shapeId: number, lowOrHigh: number);
-}
-export declare function intersectY(s: Segment, y: number): number;
-export declare function addBandIntersections(intersections: BandIntersection[], s: Segment, y1: number, y2: number): void;
-export declare function mergeIntersections(intersections: BandIntersection[], includeCount: number, excludeCount: number): number[];
-/**
- * Round v up to make it a multiple of unit. If unit is zero, return v.
- */
-export declare function ceil(v: number, unit: number): number;
-/**
- * Round v down to make it a multiple of unit. If unit is zero, return v.
- */
-export declare function floor(v: number, unit: number): number;
-export declare function rotatePoint(point: Point): Point;
-/**
- * Vertical box to pseudo-horizontal coords.
- */
-export declare function rotateBox(box: Rect): Rect;
-/**
- * Pseudo-horizontal coords to vertical.
- */
-export declare function unrotateBox(box: Rect): Rect;
-export declare function rotateShape(shape: Shape): Shape;
-export declare function shapesToBands(box: Rect, include: Shape[], exclude: Shape[], granularity: number, snapHeight: number, vertical: boolean): Band[];
-export declare function normalize(box: Rect, bands: Band[]): void;
-/**
- * Find the index of the bottommost band so that y < band.y2
- */
-export declare function findBand(bands: Band[], y: number): number;
-/**
- * Find the uppermost rectangle contained in the specified rect which occupies
- * full width of the rect without overlapping with any band in the specified
- * bands.
- * @returns Returns null if such rectangle does not exist.
- */
-export declare function findUppermostFullyOpenRect(bands: Band[], rect: Rect): Rect | null;
-/**
- * Find the bottommost rectangle contained in the specified rect which occupies
- * full width of the rect without overlapping with any band in the specified
- * bands.
- * @returns Returns null if such rectangle does not exist.
- */
-export declare function findBottommostFullyOpenRect(bands: Band[], rect: Rect): Rect | null;
-/**
- * @param side either "left" or "right"
- */
-export declare function positionFloat(box: Rect, bands: Band[], floatBox: Rect, side: string): boolean;
-export declare function addFloatToBands(box: Rect, bands: Band[], floatBox: Rect, floatBands: Band[], side: string): void;
+export declare class Rect {
+    x1: number;
+    y1: number;
+    x2: number;
+    y2: number;
+    constructor(x1: number, y1: number, x2: number, y2: number);
+}
+export declare class Point {
+    x: number;
+    y: number;
+    constructor(x: number, y: number);
+}
+export declare class Insets {
+    left: number;
+    top: number;
+    right: number;
+    bottom: number;
+    constructor(left: number, top: number, right: number, bottom: number);
+}
+export declare class Segment {
+    low: Point;
+    high: Point;
+    winding: number;
+    shapeId: number;
+    constructor(low: Point, high: Point, winding: number, shapeId: number);
+}
+/**
+ * A single band for exclusion result. Left float is from the left box edge
+ * to x1. Right float is from x2 to the right box edge.
+ */
+export declare class Band {
+    y1: number;
+    y2: number;
+    x1: number;
+    x2: number;
+    /** Left float. */
+    left: Element | null;
+    /** Right float. */
+    right: Element | null;
+    constructor(y1: number, y2: number, x1: number, x2: number);
+}
+export declare function segmentCompare(s1: Segment, s2: Segment): number;
+export declare class Shape {
+    points: Point[];
+    constructor(points: Point[]);
+    /**
+     * Converts this shape to a sequence of Segments and adds segments to the
+     * given array.
+     * @param arr array to add segments.
+     * @param id shapeId to write into segments.
+     */
+    addSegments(arr: Segment[], id: number): void;
+    withOffset(offsetX: number, offsetY: number): Shape;
+}
+export declare function shapeForEllipse(cx: number, cy: number, rx: number, ry: number): Shape;
+export declare function shapeForRect(x1: number, y1: number, x2: number, y2: number): Shape;
+export declare function shapeForRectObj(r: Rect): Shape;
+export declare class BandIntersection {
+    x: number;
+    winding: number;
+    shapeId: number;
+    lowOrHigh: number;
+    constructor(x: number, winding: number, shapeId: number, lowOrHigh: number);
+}
+export declare function intersectY(s: Segment, y: number): number;
+export declare function addBandIntersections(intersections: BandIntersection[], s: Segment, y1: number, y2: number): void;
+export declare function mergeIntersections(intersections: BandIntersection[], includeCount: number, excludeCount: number): number[];
+/**
+ * Round v up to make it a multiple of unit. If unit is zero, return v.
+ */
+export declare function ceil(v: number, unit: number): number;
+/**
+ * Round v down to make it a multiple of unit. If unit is zero, return v.
+ */
+export declare function floor(v: number, unit: number): number;
+export declare function rotatePoint(point: Point): Point;
+/**
+ * Vertical box to pseudo-horizontal coords.
+ */
+export declare function rotateBox(box: Rect): Rect;
+/**
+ * Pseudo-horizontal coords to vertical.
+ */
+export declare function unrotateBox(box: Rect): Rect;
+export declare function rotateShape(shape: Shape): Shape;
+export declare function shapesToBands(box: Rect, include: Shape[], exclude: Shape[], granularity: number, snapHeight: number, vertical: boolean): Band[];
+export declare function normalize(box: Rect, bands: Band[]): void;
+/**
+ * Find the index of the bottommost band so that y < band.y2
+ */
+export declare function findBand(bands: Band[], y: number): number;
+/**
+ * Find the uppermost rectangle contained in the specified rect which occupies
+ * full width of the rect without overlapping with any band in the specified
+ * bands.
+ * @returns Returns null if such rectangle does not exist.
+ */
+export declare function findUppermostFullyOpenRect(bands: Band[], rect: Rect): Rect | null;
+/**
+ * Find the bottommost rectangle contained in the specified rect which occupies
+ * full width of the rect without overlapping with any band in the specified
+ * bands.
+ * @returns Returns null if such rectangle does not exist.
+ */
+export declare function findBottommostFullyOpenRect(bands: Band[], rect: Rect): Rect | null;
+/**
+ * @param side either "left" or "right"
+ */
+export declare function positionFloat(box: Rect, bands: Band[], floatBox: Rect, side: string): boolean;
+export declare function addFloatToBands(box: Rect, bands: Band[], floatBox: Rect, floatBands: Band[], side: string): void;

package/lib/vivliostyle/layout-helper.d.ts

@@ -1,15 +1,16 @@
-import { Layout, Vtree } from "./types";
-/**
- * Calculate the position of the "after" edge in the block-progression
- * dimension. Return 0 if position was determined successfully and return
- * non-zero if position could not be determined and the node should be
- * considered zero-height.
- */
-export declare function calculateEdge(nodeContext: Vtree.NodeContext, clientLayout: Vtree.ClientLayout, extraOffset: number, vertical: boolean): number;
-export declare function getElementHeight(element: Element, column: Layout.Column, vertical: boolean): number;
-export declare function isOrphan(node: Node): boolean;
-export declare function removeFollowingSiblings(parentNode: Node, viewNode: Node): void;
-export declare function isSpecial(e: Element): boolean;
-export declare function isSpecialNodeContext(nodeContext: Vtree.NodeContext): boolean;
-export declare function isSpecialInlineDisplay(display: string): boolean;
-export declare function findAncestorSpecialInlineNodeContext(nodeContext: Vtree.NodeContext): Vtree.NodeContext | null;
+import { Layout, Vtree } from "./types";
+/**
+ * Calculate the position of the "after" edge in the block-progression
+ * dimension. Return 0 if position was determined successfully and return
+ * non-zero if position could not be determined and the node should be
+ * considered zero-height.
+ */
+export declare function calculateEdge(nodeContext: Vtree.NodeContext, clientLayout: Vtree.ClientLayout, extraOffset: number, vertical: boolean): number;
+export declare function getElementHeight(element: Element, column: Layout.Column, vertical: boolean): number;
+export declare function isOrphan(node: Node): boolean;
+export declare function removeFollowingSiblings(parentNode: Node, viewNode: Node): void;
+export declare function isSpecial(e: Element): boolean;
+export declare function isOutOfFlow(node: Node): boolean;
+export declare function isSpecialNodeContext(nodeContext: Vtree.NodeContext): boolean;
+export declare function isSpecialInlineDisplay(display: string): boolean;
+export declare function findAncestorSpecialInlineNodeContext(nodeContext: Vtree.NodeContext): Vtree.NodeContext | null;