@next2d/text 1.18.11 → 2.0.0

package/src/TextFormat.js

@@ -0,0 +1,233 @@
+import { $toColorInt } from "./TextUtil";
+/**
+ * @description TextFormat クラスは、文字フォーマット情報を表します。
+ *              TextFormat クラスを使用して、テキストフィールドに特定のテキストフォーマットを作成します。
+ *
+ *              The TextFormat class represents character formatting information.
+ *              Use the TextFormat class to create specific text formatting for text fields.
+ *
+ * @class
+ * @memberOf next2d.text
+ */
+export class TextFormat {
+    /**
+     * @param {string}  [font=null]
+     * @param {number}  [size=null]
+     * @param {number}  [color=null]
+     * @param {boolean} [bold=null]
+     * @param {boolean} [italic=null]
+     * @param {boolean} [underline=null]
+     * @param {string}  [align=null]
+     * @param {number}  [left_margin=null]
+     * @param {number}  [right_margin=null]
+     * @param {number}  [leading=null]
+     *
+     * @constructor
+     * @public
+     */
+    constructor(font = null, size = null, color = null, bold = null, italic = null, underline = null, align = null, left_margin = null, right_margin = null, leading = null, letter_Spacing = null) {
+        /**
+         * @description 段落の行揃えの設定を示します。
+         *              Indicates the alignment of the paragraph.
+         *
+         * @member {string}
+         * @default null
+         * @public
+         */
+        Object.defineProperty(this, "align", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @description テキストをボールドにするかどうかを指定します。
+         *              Specifies whether the text is boldface.
+         *
+         * @member {boolean}
+         * @default null
+         * @public
+         */
+        Object.defineProperty(this, "bold", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @description テキストの色を示します。
+         *              Indicates the color of the text.
+         *
+         * @member {number}
+         * @default null
+         * @public
+         */
+        Object.defineProperty(this, "color", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @description このテキストフォーマットでのテキストフォント名を示すストリングです。
+         *              The name of the font for text in this text format, as a string.
+         *
+         * @member {string}
+         * @default null
+         * @public
+         */
+        Object.defineProperty(this, "font", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @description このテキストフォーマットのテキストをイタリックにするかどうかを示します。
+         *              Indicates whether text in this text format is italicized.
+         *
+         * @member {boolean}
+         * @default null
+         * @public
+         */
+        Object.defineProperty(this, "italic", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @description 行間の垂直の行送りを示す整数です。
+         *              An integer representing the amount
+         *              of vertical space (called leading) between lines.
+         *
+         * @member {number}
+         * @default null
+         * @public
+         */
+        Object.defineProperty(this, "leading", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @description 段落の左インデントをピクセル単位で示します。
+         *              The left margin of the paragraph, in pixels.
+         *
+         * @member {number}
+         * @default null
+         * @public
+         */
+        Object.defineProperty(this, "leftMargin", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @description すべての文字の間に均等に配分されるスペースの量を表す数値です。
+         *              A object representing the amount
+         *              of space that is uniformly distributed between all characters.
+         *
+         * @member {number}
+         * @default null
+         * @public
+         */
+        Object.defineProperty(this, "letterSpacing", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @description 段落の右インデントをピクセル単位で示します。
+         *              The right margin of the paragraph, in pixels.
+         *
+         * @member {number}
+         * @default null
+         * @public
+         */
+        Object.defineProperty(this, "rightMargin", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @description このテキストフォーマットのテキストのサイズ（ピクセル単位）です。
+         *              The size in pixels of text in this text format.
+         *
+         * @member {number}
+         * @default null
+         * @public
+         */
+        Object.defineProperty(this, "size", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @description このテキストフォーマットを使用するテキストに
+         *              アンダーラインを表示する（true）か、表示しない（false）かを示します。
+         *              Indicates whether the text that uses this text format
+         *              is underlined (true) or not (false).
+         *
+         * @member {boolean}
+         * @default null
+         * @public
+         */
+        Object.defineProperty(this, "underline", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.font = font;
+        this.size = size;
+        this.color = color;
+        this.bold = bold;
+        this.italic = italic;
+        this.underline = underline;
+        this.align = align;
+        this.leftMargin = left_margin;
+        this.rightMargin = right_margin;
+        this.leading = leading;
+        this.letterSpacing = letter_Spacing;
+    }
+    /**
+     * @description この TextFormat オブジェクトのコピーを作成して返します。
+     *             Creates a copy of the TextFormat object and returns it.
+     *
+     * @return {next2d.text.TextFormat}
+     * @method
+     * @public
+     */
+    clone() {
+        return new TextFormat(this.font, this.size, this.color, this.bold, this.italic, this.underline, this.align, this.leftMargin, this.rightMargin, this.leading, this.letterSpacing);
+    }
+    /**
+     * @description この TextFormat オブジェクトのプロパティをオブジェクトに変換します。
+     *              Converts the properties of this TextFormat object to an object.
+     *
+     * @return {ITextFormatObject}
+     * @method
+     * @public
+     */
+    toObject() {
+        return {
+            "font": this.font,
+            "size": this.size,
+            "color": $toColorInt(this.color),
+            "bold": this.bold,
+            "italic": this.italic,
+            "underline": this.underline,
+            "align": this.align,
+            "leftMargin": this.leftMargin,
+            "rightMargin": this.rightMargin,
+            "leading": this.leading,
+            "letterSpacing": this.letterSpacing
+        };
+    }
+}

package/src/TextParser/service/TextParserAdjustmentHeightService.d.ts

@@ -0,0 +1,11 @@
+import type { TextData } from "../../TextData";
+/**
+ * @description 改行だけの行の高さを調整
+ *              Adjust the height of a line that contains only line breaks
+ *
+ * @param {TextData} text_data
+ * @return {void}
+ * @method
+ * @protected
+ */
+export declare const execute: (text_data: TextData) => void;

package/src/TextParser/service/TextParserAdjustmentHeightService.js

@@ -0,0 +1,24 @@
+/**
+ * @description 改行だけの行の高さを調整
+ *              Adjust the height of a line that contains only line breaks
+ *
+ * @param {TextData} text_data
+ * @return {void}
+ * @method
+ * @protected
+ */
+export const execute = (text_data) => {
+    const length = text_data.heightTable.length - 1;
+    for (let idx = 1; idx < length; ++idx) {
+        const height = text_data.heightTable[idx];
+        if (height > 0) {
+            continue;
+        }
+        // 改行があって、高さの設定がなければ前の行の高さを設定する
+        const object = text_data.lineTable[idx];
+        if (!object) {
+            continue;
+        }
+        text_data.heightTable[idx] = object.h = text_data.heightTable[idx - 1];
+    }
+};

package/src/TextParser/service/TextParserParseStyleService.d.ts

@@ -0,0 +1,11 @@
+import type { IAttributeObject } from "../../interface/IAttributeObject";
+/**
+ * @description スタイルを解析して属性オブジェクトの配列を返す
+ *              Analyze the style and return an array of attribute objects
+ *
+ * @param  {string} value
+ * @return {IAttributeObject[]}
+ * @method
+ * @protected
+ */
+export declare const execute: (value: string) => IAttributeObject[];

package/src/TextParser/service/TextParserParseStyleService.js

@@ -0,0 +1,80 @@
+/**
+ * @description スタイルを解析して属性オブジェクトの配列を返す
+ *              Analyze the style and return an array of attribute objects
+ *
+ * @param  {string} value
+ * @return {IAttributeObject[]}
+ * @method
+ * @protected
+ */
+export const execute = (value) => {
+    const values = value
+        .trim()
+        .split(";");
+    const attributes = [];
+    for (let idx = 0; idx < values.length; ++idx) {
+        const styleValue = values[idx];
+        if (!styleValue) {
+            continue;
+        }
+        const styles = styleValue.split(":");
+        const name = styles[0].trim();
+        const value = styles[1].trim();
+        switch (name) {
+            case "font-size":
+                attributes.push({
+                    "name": "size",
+                    "value": parseInt(value)
+                });
+                break;
+            case "font-family":
+                attributes.push({
+                    "name": "face",
+                    "value": value.replace(/'|"/g, "")
+                });
+                break;
+            case "letter-spacing":
+                attributes.push({
+                    "name": "letterSpacing",
+                    "value": parseInt(value)
+                });
+                break;
+            case "margin-bottom":
+                attributes.push({
+                    "name": "leading",
+                    "value": parseInt(value)
+                });
+                break;
+            case "margin-left":
+                attributes.push({
+                    "name": "leftMargin",
+                    "value": parseInt(value)
+                });
+                break;
+            case "margin-right":
+                attributes.push({
+                    "name": "rightMargin",
+                    "value": parseInt(value)
+                });
+                break;
+            case "color":
+            case "align":
+                attributes.push({
+                    "name": name,
+                    "value": value
+                });
+                break;
+            case "text-decoration":
+            case "font-weight":
+            case "font-style":
+                attributes.push({
+                    "name": value,
+                    "value": true
+                });
+                break;
+            default:
+                break;
+        }
+    }
+    return attributes;
+};

package/src/TextParser/usecase/TextParserCreateNewLineUseCase.d.ts

@@ -0,0 +1,13 @@
+import type { TextData } from "../../TextData";
+import type { TextFormat } from "../../TextFormat";
+/**
+ * @description 新しい行を作成
+ *              Create a new line
+ *
+ * @param {TextData} text_data
+ * @param {TextFormat} text_format
+ * @return {void}
+ * @method
+ * @protected
+ */
+export declare const execute: (text_data: TextData, text_format: TextFormat) => void;

package/src/TextParser/usecase/TextParserCreateNewLineUseCase.js

@@ -0,0 +1,35 @@
+import { execute as textFormatGenerateFontStyleService } from "../../TextFormat/service/TextFormatGenerateFontStyleService";
+import { $context, $setCurrentWidth } from "../../TextUtil";
+/**
+ * @description 新しい行を作成
+ *              Create a new line
+ *
+ * @param {TextData} text_data
+ * @param {TextFormat} text_format
+ * @return {void}
+ * @method
+ * @protected
+ */
+export const execute = (text_data, text_format) => {
+    $setCurrentWidth(0);
+    const line = text_data.lineTable.length;
+    $context.font = textFormatGenerateFontStyleService(text_format);
+    const mesure = $context.measureText("");
+    const object = {
+        "mode": "break",
+        "text": "",
+        "x": 0,
+        "y": 0,
+        "w": 0,
+        "h": mesure.fontBoundingBoxAscent + mesure.fontBoundingBoxDescent,
+        "line": line,
+        "textFormat": text_format.toObject()
+    };
+    // initialize
+    text_data.heightTable[line] = 0;
+    text_data.ascentTable[line] = 0;
+    text_data.widthTable[line] = 0;
+    // register
+    text_data.lineTable.push(object);
+    text_data.textTable.push(object);
+};

package/src/TextParser/usecase/TextParserParseHtmlTextUseCase.d.ts

@@ -0,0 +1,15 @@
+import type { TextFormat } from "../../TextFormat";
+import type { IOptions } from "../../interface/IOptions";
+import { TextData } from "../../TextData";
+/**
+ * @description HTMLテキストを解析してTextDataを生成
+ *              Analyze HTML text and generate TextData
+ *
+ * @param  {string} html_text
+ * @param  {TextFormat} text_format
+ * @param  {IOptions} options
+ * @return {TextData}
+ * @method
+ * @protected
+ */
+export declare const execute: (html_text: string, text_format: TextFormat, options: IOptions) => TextData;

package/src/TextParser/usecase/TextParserParseHtmlTextUseCase.js

@@ -0,0 +1,37 @@
+import { TextData } from "../../TextData";
+import { parseDocument } from "htmlparser2";
+import { execute as textParserCreateNewLineUseCase } from "./TextParserCreateNewLineUseCase";
+import { execute as textParserAdjustmentHeightService } from "../service/TextParserAdjustmentHeightService";
+import { execute as textParserParseTagUseCase } from "./TextParserParseTagUseCase";
+/**
+ * @description HTMLテキストを解析してTextDataを生成
+ *              Analyze HTML text and generate TextData
+ *
+ * @param  {string} html_text
+ * @param  {TextFormat} text_format
+ * @param  {IOptions} options
+ * @return {TextData}
+ * @method
+ * @protected
+ */
+export const execute = (html_text, text_format, options) => {
+    const textData = new TextData();
+    if (!html_text) {
+        return textData;
+    }
+    const htmlText = html_text
+        .trim()
+        .replace(/\r?\n/g, "")
+        .replace(/\t/g, "");
+    const textFormat = text_format.clone();
+    if (options.subFontSize && options.subFontSize > 0 && textFormat.size) {
+        textFormat.size -= options.subFontSize;
+        if (1 > textFormat.size) {
+            textFormat.size = 1;
+        }
+    }
+    textParserCreateNewLineUseCase(textData, textFormat);
+    textParserParseTagUseCase(parseDocument(htmlText), textFormat, textData, options);
+    textParserAdjustmentHeightService(textData);
+    return textData;
+};

package/src/TextParser/usecase/TextParserParseTagUseCase.d.ts

@@ -0,0 +1,17 @@
+import type { TextFormat } from "../../TextFormat";
+import type { TextData } from "../../TextData";
+import type { IOptions } from "../../interface/IOptions";
+import type { Document } from "domhandler";
+/**
+ * @description タグを解析してTextDataとTextFormatを設定
+ *              Analyze tags and set TextData and TextFormat
+ *
+ * @param  {Document} document
+ * @param  {TextFormat} text_format
+ * @param  {TextData} text_data
+ * @param  {IOptions} options
+ * @return {void}
+ * @method
+ * @protected
+ */
+export declare const execute: (document: Document, text_format: TextFormat, text_data: TextData, options: IOptions) => void;

package/src/TextParser/usecase/TextParserParseTagUseCase.js

@@ -0,0 +1,57 @@
+import { execute as textParserParseTextUseCase } from "./TextParserParseTextUseCase";
+import { execute as textParserCreateNewLineUseCase } from "./TextParserCreateNewLineUseCase";
+import { execute as textParserSetAttributesUseCase } from "./TextParserSetAttributesUseCase";
+/**
+ * @description タグを解析してTextDataとTextFormatを設定
+ *              Analyze tags and set TextData and TextFormat
+ *
+ * @param  {Document} document
+ * @param  {TextFormat} text_format
+ * @param  {TextData} text_data
+ * @param  {IOptions} options
+ * @return {void}
+ * @method
+ * @protected
+ */
+export const execute = (document, text_format, text_data, options) => {
+    for (let idx = 0; idx < document.children.length; ++idx) {
+        const node = document.children[idx];
+        if (node.nodeType === 3) {
+            textParserParseTextUseCase(node.nodeValue || "", text_format, text_data, options);
+            continue;
+        }
+        const textFormat = text_format.clone();
+        switch (node.name.toUpperCase()) {
+            case "DIV": // div tag
+            case "P": // p tag
+                textParserSetAttributesUseCase(node.attributes, textFormat, options);
+                if (options.multiline) {
+                    textParserCreateNewLineUseCase(text_data, textFormat);
+                }
+                execute(node, textFormat, text_data, options);
+                continue;
+            case "U": // underline
+                textFormat.underline = true;
+                break;
+            case "B": // bold
+                textFormat.bold = true;
+                break;
+            case "I": // italic
+                textFormat.italic = true;
+                break;
+            case "FONT": // FONT tag
+            case "SPAN": // SPAN tag
+                textParserSetAttributesUseCase(node.attributes, textFormat, options);
+                break;
+            case "BR":
+                if (!options.multiline) {
+                    continue;
+                }
+                textParserCreateNewLineUseCase(text_data, textFormat);
+                break;
+            default:
+                break;
+        }
+        execute(node, textFormat, text_data, options);
+    }
+};

package/src/TextParser/usecase/TextParserParseTextUseCase.d.ts

@@ -0,0 +1,16 @@
+import type { IOptions } from "../../interface/IOptions";
+import type { TextData } from "../../TextData";
+import type { TextFormat } from "../../TextFormat";
+/**
+ * @description テキストを解析
+ *              Analyze text
+ *
+ * @param  {string} texts
+ * @param  {TextFormat} text_format
+ * @param  {TextData} text_data
+ * @param  {IOptions} options
+ * @return {void}
+ * @method
+ * @protected
+ */
+export declare const execute: (texts: string, text_format: TextFormat, text_data: TextData, options: IOptions) => void;