@vivliostyle/core 2.24.3 → 2.25.1

package/lib/vivliostyle/plugin.d.ts

@@ -1,172 +1,172 @@
-/**
- * Copyright 2016 Trim-marks Inc.
- * Copyright 2019 Vivliostyle Foundation
- *
- * Vivliostyle.js is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * Vivliostyle.js is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with Vivliostyle.js.  If not, see <http://www.gnu.org/licenses/>.
- *
- * @fileoverview Plugin - Plugin mechanism
- */
-import * as Base from "./base";
-import * as Css from "./css";
-import * as LayoutProcessor from "./layout-processor";
-import * as Task from "./task";
-import { Layout, Vtree } from "./types";
-/**
- * Type of implemented hooks.
- * @enum {string}
- */
-export declare enum HOOKS {
-    /**
-     * Called when a single property declaration is parsed.
-     *
-     * The hook is called with an object with the following properties:
-     *   {string} name: Property name
-     *   {!Css.Val} value: Property value
-     *   {boolean} important: Whether '!important' flag is present or not
-     * Functions called by this hook are expected to return a value with the same
-     * type as the above. The declaration is then replaced by the returned value.
-     *
-     * Note that a shorthand declaration is not directly passed to this hook.
-     * After the shorthand declaration is interpreted and broken into
-     * non-shorthand declarations, the hook is called for each of the
-     * non-shorthand declarations.
-     */
-    SIMPLE_PROPERTY = "SIMPLE_PROPERTY",
-    /**
-     * Called when a single document (i.e. a single spine item) has been fetched,
-     * before parsing.
-     *
-     * The hook is called with the Document object.
-     */
-    PREPROCESS_SINGLE_DOCUMENT = "PREPROCESS_SINGLE_DOCUMENT",
-    /**
-     * Called before creating a text node for modifying a text content.
-     *
-     * The hook is called with an object with the following properties:
-     *   {Vtree.NodeContext} nodeContext
-     *   {string} sourceTextContent
-     *
-     * Functions called by this hook are expected to return a
-     * Task.Result.<string>. The text content is then replaced by the
-     * returned value.
-     */
-    PREPROCESS_TEXT_CONTENT = "PREPROCESS_TEXT_CONTENT",
-    /**
-     * Called before creating a element for modifying a element style.
-     *
-     * The hook is called with an object with the following properties:
-     *   {Vtree.NodeContext} nodeContext
-     *   {!Object} style
-     */
-    PREPROCESS_ELEMENT_STYLE = "PREPROCESS_ELEMENT_STYLE",
-    /**
-     * Called before geting CssCascade.polyfilledInheritedProps.
-     *
-     * The hook return a array of polyfilled inherited property name.
-     */
-    POLYFILLED_INHERITED_PROPS = "POLYFILLED_INHERITED_PROPS",
-    /**
-     * Called when a Viewer is configured.
-     *
-     * The hook is called with an object with the following properties:
-     *  {Base.JSON} command
-     */
-    CONFIGURATION = "CONFIGURATION",
-    /**
-     * Called when resolving a text node breaker
-     * which detects an acceptable breakpoint and break text node at this point.
-     *
-     * The hook is called with an object with the following properties:
-     *  {Vtree.NodeContext} nodeContext
-     *
-     * Functions called by this hook are expected to
-     * return an instnce of {Layout.TextNodeBreaker} or null.
-     */
-    RESOLVE_TEXT_NODE_BREAKER = "RESOLVE_TEXT_NODE_BREAKER",
-    /**
-     * Called when resolving a formatting context.
-     *
-     * The hook is called with the following parameters:
-     *   nodeContext: a NodeContext object
-     *   firstTime: a boolean flag representing whether this node is encountered
-     * for the first time or not display: an Css.Ident value representing
-     * 'display' value of the node position: an Css.Ident value representing
-     * 'position' value of the node float: an Css.Ident value representing
-     * 'float' value of the node isRoot: a boolean flag representing whether this
-     * node is a root (of a flow) or not Functions called by this hook are
-     * expected to return a formatting context for the NodeContext.
-     */
-    RESOLVE_FORMATTING_CONTEXT = "RESOLVE_FORMATTING_CONTEXT",
-    /**
-     * Called when resolving a layout processor (LayoutProcessor) for
-     * a formatting context.
-     *
-     * The hook is called with a formatting context
-     * (Vtree.FormattingContext). Functions called by this hook are expected
-     * to return a layout processor corresponding to the formatting context.
-     */
-    RESOLVE_LAYOUT_PROCESSOR = "RESOLVE_LAYOUT_PROCESSOR",
-    /**
-     * Called after laid out a block contents.
-     *
-     * The hook is called with an object with the following properties:
-     *  {Vtree.NodeContext} nodeContext
-     *  {Array.<Vtree.NodeContext>} checkPoints
-     *  {Layout.Column} column
-     */
-    POST_LAYOUT_BLOCK = "POST_LAYOUT_BLOCK"
-}
-export type PreProcessSingleDocumentHook = (p1: Document) => any;
-export type PreProcessTextContentHook = (p1: Vtree.NodeContext, p2: string) => Task.Result<string>;
-export type PreProcessElementStyleHook = (p1: Vtree.NodeContext, p2: object) => void;
-export type PolyfilledInheritedPropsHook = () => string[];
-export type ConfigurationHook = (p1: Base.JSON) => {
-    needResize: boolean | null | undefined;
-    needRefresh: boolean | null | undefined;
-};
-export type ResolveTextNodeBreakerHook = (p1: Vtree.NodeContext) => Layout.TextNodeBreaker;
-export type ResolveFormattingContextHook = (p1: Vtree.NodeContext, p2: boolean, p3: Css.Ident, p4: Css.Ident, p5: Css.Ident, p6: boolean) => Vtree.FormattingContext;
-export type ResolveLayoutProcessorHook = (p1: Vtree.FormattingContext) => LayoutProcessor.LayoutProcessor;
-export type PostLayoutBlockHook = (p1: Vtree.NodeContext, p2: Vtree.NodeContext[], p3: Layout.Column) => void;
-/**
- * Register a function to a hook with the specified name.
- * The registered function is called at appropriate timings by the core code.
- * Arguments passed to the function depend on the hook.
- * When multiple functions are registered, they are called by the order in which
- * they are registered.
- * @param name Name of the hook.
- * @param fn Function to be registered to the hook.
- * @param atFirst If true, the function is registered at the first of the hook array.
- */
-export declare function registerHook(name: string, fn: (...p1: any[]) => any, atFirst?: boolean): void;
-/**
- * Remove a function already registered to the specified name.
- * Note that even if the same function are registered multiple times, this
- * method removes only the first one.
- * @param name Name of the hook.
- * @param fn Function to be removed from the hook.
- */
-export declare function removeHook(name: string, fn: (...p1: any[]) => any): void;
-/**
- * Get all hooks registered to the specified name.
- * This method is for internal use (from the core code).
- */
-export declare function getHooksForName(name: string): ((...p1: any[]) => any)[];
-/**
- * Pubilc members of the bundled library.
- */
-export declare const plugin: {
-    registerHook: typeof registerHook;
-    removeHook: typeof removeHook;
-};
+/**
+ * Copyright 2016 Trim-marks Inc.
+ * Copyright 2019 Vivliostyle Foundation
+ *
+ * Vivliostyle.js is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Vivliostyle.js is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with Vivliostyle.js.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @fileoverview Plugin - Plugin mechanism
+ */
+import * as Base from "./base";
+import * as Css from "./css";
+import * as LayoutProcessor from "./layout-processor";
+import * as Task from "./task";
+import { Layout, Vtree } from "./types";
+/**
+ * Type of implemented hooks.
+ * @enum {string}
+ */
+export declare enum HOOKS {
+    /**
+     * Called when a single property declaration is parsed.
+     *
+     * The hook is called with an object with the following properties:
+     *   {string} name: Property name
+     *   {!Css.Val} value: Property value
+     *   {boolean} important: Whether '!important' flag is present or not
+     * Functions called by this hook are expected to return a value with the same
+     * type as the above. The declaration is then replaced by the returned value.
+     *
+     * Note that a shorthand declaration is not directly passed to this hook.
+     * After the shorthand declaration is interpreted and broken into
+     * non-shorthand declarations, the hook is called for each of the
+     * non-shorthand declarations.
+     */
+    SIMPLE_PROPERTY = "SIMPLE_PROPERTY",
+    /**
+     * Called when a single document (i.e. a single spine item) has been fetched,
+     * before parsing.
+     *
+     * The hook is called with the Document object.
+     */
+    PREPROCESS_SINGLE_DOCUMENT = "PREPROCESS_SINGLE_DOCUMENT",
+    /**
+     * Called before creating a text node for modifying a text content.
+     *
+     * The hook is called with an object with the following properties:
+     *   {Vtree.NodeContext} nodeContext
+     *   {string} sourceTextContent
+     *
+     * Functions called by this hook are expected to return a
+     * Task.Result.<string>. The text content is then replaced by the
+     * returned value.
+     */
+    PREPROCESS_TEXT_CONTENT = "PREPROCESS_TEXT_CONTENT",
+    /**
+     * Called before creating a element for modifying a element style.
+     *
+     * The hook is called with an object with the following properties:
+     *   {Vtree.NodeContext} nodeContext
+     *   {!Object} style
+     */
+    PREPROCESS_ELEMENT_STYLE = "PREPROCESS_ELEMENT_STYLE",
+    /**
+     * Called before geting CssCascade.polyfilledInheritedProps.
+     *
+     * The hook return a array of polyfilled inherited property name.
+     */
+    POLYFILLED_INHERITED_PROPS = "POLYFILLED_INHERITED_PROPS",
+    /**
+     * Called when a Viewer is configured.
+     *
+     * The hook is called with an object with the following properties:
+     *  {Base.JSON} command
+     */
+    CONFIGURATION = "CONFIGURATION",
+    /**
+     * Called when resolving a text node breaker
+     * which detects an acceptable breakpoint and break text node at this point.
+     *
+     * The hook is called with an object with the following properties:
+     *  {Vtree.NodeContext} nodeContext
+     *
+     * Functions called by this hook are expected to
+     * return an instnce of {Layout.TextNodeBreaker} or null.
+     */
+    RESOLVE_TEXT_NODE_BREAKER = "RESOLVE_TEXT_NODE_BREAKER",
+    /**
+     * Called when resolving a formatting context.
+     *
+     * The hook is called with the following parameters:
+     *   nodeContext: a NodeContext object
+     *   firstTime: a boolean flag representing whether this node is encountered
+     * for the first time or not display: an Css.Ident value representing
+     * 'display' value of the node position: an Css.Ident value representing
+     * 'position' value of the node float: an Css.Ident value representing
+     * 'float' value of the node isRoot: a boolean flag representing whether this
+     * node is a root (of a flow) or not Functions called by this hook are
+     * expected to return a formatting context for the NodeContext.
+     */
+    RESOLVE_FORMATTING_CONTEXT = "RESOLVE_FORMATTING_CONTEXT",
+    /**
+     * Called when resolving a layout processor (LayoutProcessor) for
+     * a formatting context.
+     *
+     * The hook is called with a formatting context
+     * (Vtree.FormattingContext). Functions called by this hook are expected
+     * to return a layout processor corresponding to the formatting context.
+     */
+    RESOLVE_LAYOUT_PROCESSOR = "RESOLVE_LAYOUT_PROCESSOR",
+    /**
+     * Called after laid out a block contents.
+     *
+     * The hook is called with an object with the following properties:
+     *  {Vtree.NodeContext} nodeContext
+     *  {Array.<Vtree.NodeContext>} checkPoints
+     *  {Layout.Column} column
+     */
+    POST_LAYOUT_BLOCK = "POST_LAYOUT_BLOCK"
+}
+export type PreProcessSingleDocumentHook = (p1: Document) => any;
+export type PreProcessTextContentHook = (p1: Vtree.NodeContext, p2: string) => Task.Result<string>;
+export type PreProcessElementStyleHook = (p1: Vtree.NodeContext, p2: object) => void;
+export type PolyfilledInheritedPropsHook = () => string[];
+export type ConfigurationHook = (p1: Base.JSON) => {
+    needResize: boolean | null | undefined;
+    needRefresh: boolean | null | undefined;
+};
+export type ResolveTextNodeBreakerHook = (p1: Vtree.NodeContext) => Layout.TextNodeBreaker;
+export type ResolveFormattingContextHook = (p1: Vtree.NodeContext, p2: boolean, p3: Css.Ident, p4: Css.Ident, p5: Css.Ident, p6: boolean) => Vtree.FormattingContext;
+export type ResolveLayoutProcessorHook = (p1: Vtree.FormattingContext) => LayoutProcessor.LayoutProcessor;
+export type PostLayoutBlockHook = (p1: Vtree.NodeContext, p2: Vtree.NodeContext[], p3: Layout.Column) => void;
+/**
+ * Register a function to a hook with the specified name.
+ * The registered function is called at appropriate timings by the core code.
+ * Arguments passed to the function depend on the hook.
+ * When multiple functions are registered, they are called by the order in which
+ * they are registered.
+ * @param name Name of the hook.
+ * @param fn Function to be registered to the hook.
+ * @param atFirst If true, the function is registered at the first of the hook array.
+ */
+export declare function registerHook(name: string, fn: (...p1: any[]) => any, atFirst?: boolean): void;
+/**
+ * Remove a function already registered to the specified name.
+ * Note that even if the same function are registered multiple times, this
+ * method removes only the first one.
+ * @param name Name of the hook.
+ * @param fn Function to be removed from the hook.
+ */
+export declare function removeHook(name: string, fn: (...p1: any[]) => any): void;
+/**
+ * Get all hooks registered to the specified name.
+ * This method is for internal use (from the core code).
+ */
+export declare function getHooksForName(name: string): ((...p1: any[]) => any)[];
+/**
+ * Pubilc members of the bundled library.
+ */
+export declare const plugin: {
+    registerHook: typeof registerHook;
+    removeHook: typeof removeHook;
+};

package/lib/vivliostyle/print.d.ts

@@ -1,7 +1,7 @@
-export interface PrintConfig {
-    title: string;
-    printCallback: (iframeWin: Window) => void;
-    hideIframe: boolean;
-    removeIframe: boolean;
-}
-export declare function printHTML(htmlDoc: string, config: PrintConfig): void;
+export interface PrintConfig {
+    title: string;
+    printCallback: (iframeWin: Window) => void;
+    hideIframe: boolean;
+    removeIframe: boolean;
+}
+export declare function printHTML(htmlDoc: string, config: PrintConfig): void;

package/lib/vivliostyle/profile.d.ts

@@ -1,59 +1,59 @@
-/**
- * Performance profiler measuring execution time of the script.
- */
-export declare class Profiler {
-    readonly performanceInstance: Performance;
-    timestamps: {
-        [key: string]: {
-            [key: string]: number;
-        };
-    };
-    private registerTiming;
-    registerStartTiming: (name: string, timestamp?: number) => any;
-    registerEndTiming: (name: string, timestamp?: number) => any;
-    constructor(performanceInstance: Performance);
-    /**
-     * Registers start timing of some event, even if profile is disabled.
-     * @param name Name of event
-     * @param timestamp Used as the actual timestamp of the event if specified,
-     *     instead of "now"
-     */
-    forceRegisterStartTiming(name: string, timestamp?: number): void;
-    /**
-     * Registers end timing of some event, even if profile is disabled.
-     * @param name Name of event
-     * @param timestamp Used as the actual timestamp of the event if specified,
-     *     instead of "now"
-     */
-    forceRegisterEndTiming(name: string, timestamp?: number): void;
-    /**
-     * Log registered timings (start/end/duration).
-     * All values are printed in ms unit.
-     */
-    printTimings(): void;
-    /**
-     * Disable profiling.
-     */
-    disable(): void;
-    /**
-     * Enable profiling.
-     */
-    enable(): void;
-    /**
-     * Returns if profiling is enabled or not.
-     */
-    isEnabled(): boolean;
-}
-export declare const profiler: Profiler;
-/**
- * Pubilc members of the bundled library.
- */
-export declare const profile: {
-    profiler: {
-        registerStartTiming: (name: string, timestamp?: number) => any;
-        registerEndTiming: (name: string, timestamp?: number) => any;
-        printTimings: () => void;
-        disable: () => void;
-        enable: () => void;
-    };
-};
+/**
+ * Performance profiler measuring execution time of the script.
+ */
+export declare class Profiler {
+    readonly performanceInstance: Performance;
+    timestamps: {
+        [key: string]: {
+            [key: string]: number;
+        };
+    };
+    private registerTiming;
+    registerStartTiming: (name: string, timestamp?: number) => any;
+    registerEndTiming: (name: string, timestamp?: number) => any;
+    constructor(performanceInstance: Performance);
+    /**
+     * Registers start timing of some event, even if profile is disabled.
+     * @param name Name of event
+     * @param timestamp Used as the actual timestamp of the event if specified,
+     *     instead of "now"
+     */
+    forceRegisterStartTiming(name: string, timestamp?: number): void;
+    /**
+     * Registers end timing of some event, even if profile is disabled.
+     * @param name Name of event
+     * @param timestamp Used as the actual timestamp of the event if specified,
+     *     instead of "now"
+     */
+    forceRegisterEndTiming(name: string, timestamp?: number): void;
+    /**
+     * Log registered timings (start/end/duration).
+     * All values are printed in ms unit.
+     */
+    printTimings(): void;
+    /**
+     * Disable profiling.
+     */
+    disable(): void;
+    /**
+     * Enable profiling.
+     */
+    enable(): void;
+    /**
+     * Returns if profiling is enabled or not.
+     */
+    isEnabled(): boolean;
+}
+export declare const profiler: Profiler;
+/**
+ * Pubilc members of the bundled library.
+ */
+export declare const profile: {
+    profiler: {
+        registerStartTiming: (name: string, timestamp?: number) => any;
+        registerEndTiming: (name: string, timestamp?: number) => any;
+        printTimings: () => void;
+        disable: () => void;
+        enable: () => void;
+    };
+};

package/lib/vivliostyle/pseudo-element.d.ts

@@ -1,32 +1,32 @@
-import * as Css from "./css";
-import * as CssCascade from "./css-cascade";
-import * as CssStyler from "./css-styler";
-import * as Exprs from "./exprs";
-import * as Vtree from "./vtree";
-import { PseudoElement } from "./types";
-export declare const document: Document;
-/**
- * Pseudoelement names in the order they should be inserted in the shadow DOM,
- * empty string is the place where the element's DOM children are processed.
- */
-export declare const pseudoNames: string[];
-export declare const PSEUDO_ATTR = "data-adapt-pseudo";
-export declare function getPseudoName(element: Element): string;
-export declare function setPseudoName(element: Element, name: string): void;
-export declare class PseudoelementStyler implements PseudoElement.PseudoelementStyler {
-    readonly element: Element;
-    style: CssCascade.ElementStyle;
-    styler: CssStyler.AbstractStyler;
-    readonly context: Exprs.Context;
-    readonly exprContentListener: Vtree.ExprContentListener;
-    contentProcessed: {
-        [key: string]: boolean;
-    };
-    constructor(element: Element, style: CssCascade.ElementStyle, styler: CssStyler.AbstractStyler, context: Exprs.Context, exprContentListener: Vtree.ExprContentListener);
-    /** @override */
-    getStyle(element: Element, deep: boolean): CssCascade.ElementStyle;
-    /** @override */
-    processContent(element: Element, styles: {
-        [key: string]: Css.Val;
-    }, viewNode: Node): void;
-}
+import * as Css from "./css";
+import * as CssCascade from "./css-cascade";
+import * as CssStyler from "./css-styler";
+import * as Exprs from "./exprs";
+import * as Vtree from "./vtree";
+import { PseudoElement } from "./types";
+export declare const document: Document;
+/**
+ * Pseudoelement names in the order they should be inserted in the shadow DOM,
+ * empty string is the place where the element's DOM children are processed.
+ */
+export declare const pseudoNames: string[];
+export declare const PSEUDO_ATTR = "data-adapt-pseudo";
+export declare function getPseudoName(element: Element): string;
+export declare function setPseudoName(element: Element, name: string): void;
+export declare class PseudoelementStyler implements PseudoElement.PseudoelementStyler {
+    readonly element: Element;
+    style: CssCascade.ElementStyle;
+    styler: CssStyler.AbstractStyler;
+    readonly context: Exprs.Context;
+    readonly exprContentListener: Vtree.ExprContentListener;
+    contentProcessed: {
+        [key: string]: boolean;
+    };
+    constructor(element: Element, style: CssCascade.ElementStyle, styler: CssStyler.AbstractStyler, context: Exprs.Context, exprContentListener: Vtree.ExprContentListener);
+    /** @override */
+    getStyle(element: Element, deep: boolean): CssCascade.ElementStyle;
+    /** @override */
+    processContent(element: Element, styles: {
+        [key: string]: Css.Val;
+    }, viewNode: Node): void;
+}