@univerjs/engine-render 0.1.6 → 0.1.8

package/lib/types/basics/const.d.ts

@@ -55,7 +55,6 @@ export declare const DEFAULT_SKELETON_FOOTER: {
     ed: number;
     marginLeft: number;
 };
-export declare const DEFAULT_MEASURE_TEXT = "0";
 export declare const DEFAULT_OFFSET_SPACING = 1;
 export declare const DEFAULT_DOCUMENT_FONTSIZE = 14;
 /**

package/lib/types/basics/i-document-skeleton-cached.d.ts

@@ -156,7 +156,9 @@ export interface IDocumentSkeletonDrawing {
 export interface IDocumentSkeletonFontStyle {
     fontString: string;
     fontSize: number;
+    originFontSize: number;
     fontFamily: string;
+    fontCache: string;
 }
 export interface IDocumentSkeletonBoundingBox {
     width: number;

package/lib/types/basics/index.d.ts

@@ -17,7 +17,7 @@ export * from './cell-data';
 export * from './const';
 export * from './document-node-tools';
 export * from './draw';
-export * from './font-cache';
+export * from '../components/docs/layout/shaping-engine/font-cache';
 export * from './i-document-skeleton-cached';
 export * from './i-events';
 export * from './interfaces';

package/lib/types/basics/interfaces.d.ts

@@ -38,13 +38,6 @@ export interface IFontLocale {
     fontList: string[];
     defaultFontSize: number;
 }
-export interface IMeasureTextCache {
-    fontBoundingBoxAscent: number;
-    fontBoundingBoxDescent: number;
-    actualBoundingBoxAscent: number;
-    actualBoundingBoxDescent: number;
-    width: number;
-}
 export interface IDocsConfig extends IReferenceSource, IDocumentLayout {
     localeService: LocaleService;
     documentTextStyle?: ITextStyle;
@@ -80,8 +73,8 @@ export interface IFontCreateConfig {
     fontStyle: IDocumentSkeletonFontStyle;
     textStyle: ITextStyle;
     charSpace: number;
-    gridType?: GridType;
     snapToGrid: BooleanNumber;
+    gridType?: GridType;
     pageWidth?: number;
 }
 export interface INodeInfo {

package/lib/types/basics/tools.d.ts

@@ -1,3 +1,4 @@
+import { IDocumentSkeletonFontStyle } from './i-document-skeleton-cached';
 import { IBoundRectNoAngle } from './vector2';
 import { IRange, IRangeWithCoord, IScale, ISelectionCell, ISelectionCellWithCoord, IStyleBase, LocaleService, Nullable } from '@univerjs/core';
 
@@ -44,12 +45,7 @@ export declare function precisionTo(num: number, accurate: number): number;
 export declare function fixLineWidthByScale(num: number, scale: number): number;
 export declare const UNIVER_GLOBAL_DEFAULT_FONT_SIZE = 11;
 export declare const UNIVER_GLOBAL_DEFAULT_FONT_FAMILY = "Arial";
-export declare function getFontStyleString(textStyle?: IStyleBase, localeService?: LocaleService): {
-    fontCache: string;
-    fontString: string;
-    fontSize: number;
-    fontFamily: string;
-};
+export declare function getFontStyleString(textStyle?: IStyleBase, _localeService?: LocaleService): IDocumentSkeletonFontStyle;
 export declare function hasCJKText(text: string): boolean;
 export declare function hasCJK(text: string): boolean;
 export declare function hasCJKPunctuation(text: string): boolean;

package/lib/types/components/docs/layout/block/paragraph/shaping.d.ts

@@ -8,4 +8,4 @@ export interface IShapedText {
     text: string;
     glyphs: IDocumentSkeletonGlyph[];
 }
-export declare function shaping(content: string, bodyModel: DocumentViewModel, paragraphNode: DataStreamTreeNode, sectionBreakConfig: ISectionBreakConfig, paragraphStyle: IParagraphStyle): IShapedText[];
+export declare function shaping(content: string, bodyModel: DocumentViewModel, paragraphNode: DataStreamTreeNode, sectionBreakConfig: ISectionBreakConfig, paragraphStyle: IParagraphStyle, useOpenType?: boolean): IShapedText[];

package/lib/types/components/docs/layout/model/glyph.d.ts

@@ -1,3 +1,4 @@
+import { IOpenTypeGlyphInfo } from '../shaping-engine/text-shaping';
 import { IFontCreateConfig } from '../../../../basics/interfaces';
 import { IAdjustability, IDocumentSkeletonBullet, IDocumentSkeletonDivide, IDocumentSkeletonGlyph, GlyphType } from '../../../../basics/i-document-skeleton-cached';
 
@@ -5,9 +6,9 @@ export declare function isSpace(char: string): boolean;
 export declare function isJustifiable(content: string): boolean;
 export declare function baseAdjustability(content: string, width: number): IAdjustability;
 export declare function createSkeletonWordGlyph(content: string, config: IFontCreateConfig, glyphWidth?: number): IDocumentSkeletonGlyph;
-export declare function createSkeletonLetterGlyph(content: string, config: IFontCreateConfig, glyphWidth?: number): IDocumentSkeletonGlyph;
+export declare function createSkeletonLetterGlyph(content: string, config: IFontCreateConfig, glyphWidth?: number, glyphInfo?: IOpenTypeGlyphInfo): IDocumentSkeletonGlyph;
 export declare function createSkeletonTabGlyph(config: IFontCreateConfig, glyphWidth?: number): IDocumentSkeletonGlyph;
-export declare function _createSkeletonWordOrLetter(glyphType: GlyphType, content: string, config: IFontCreateConfig, glyphWidth?: number): IDocumentSkeletonGlyph;
+export declare function _createSkeletonWordOrLetter(glyphType: GlyphType, content: string, config: IFontCreateConfig, glyphWidth?: number, glyphInfo?: IOpenTypeGlyphInfo): IDocumentSkeletonGlyph;
 export declare function createSkeletonBulletGlyph(glyph: IDocumentSkeletonGlyph, bulletSkeleton: IDocumentSkeletonBullet, charSpaceApply: number): IDocumentSkeletonGlyph;
 export declare function setGlyphGroupLeft(glyphGroup: IDocumentSkeletonGlyph[], left?: number): void;
 export declare function setGlyphLeft(glyph: IDocumentSkeletonGlyph, left?: number): void;

package/lib/types/components/docs/layout/shaping-engine/__tests__/text-shaping.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};

package/lib/types/{basics → components/docs/layout/shaping-engine}/font-cache.d.ts

@@ -1,7 +1,15 @@
-import { IMeasureTextCache } from './interfaces';
-import { IDocumentSkeletonBoundingBox, IDocumentSkeletonFontStyle } from './i-document-skeleton-cached';
+import { IOpenTypeGlyphInfo } from './text-shaping';
+import { IDocumentSkeletonBoundingBox, IDocumentSkeletonFontStyle } from '../../../../basics/i-document-skeleton-cached';
 import { Nullable } from '@univerjs/core';
 
+export declare const DEFAULT_MEASURE_TEXT = "0";
+export interface IMeasureTextCache {
+    fontBoundingBoxAscent: number;
+    fontBoundingBoxDescent: number;
+    actualBoundingBoxAscent: number;
+    actualBoundingBoxDescent: number;
+    width: number;
+}
 export declare class FontCache {
     private static _getTextHeightCache;
     private static _context;
@@ -23,6 +31,18 @@ export declare class FontCache {
         height: number;
     };
     static getTextSize(content: string, fontStyle: IDocumentSkeletonFontStyle): IDocumentSkeletonBoundingBox;
+    static getBBoxFromGlyphInfo(glyphInfo: IOpenTypeGlyphInfo, fontStyle: IDocumentSkeletonFontStyle): {
+        width: number;
+        ba: number;
+        bd: number;
+        aba: number;
+        abd: number;
+        sp: number;
+        sbr: number;
+        spr: number;
+        sbo: number;
+        spo: number;
+    };
     static getMeasureText(content: string, fontString: string): IMeasureTextCache;
     private static _clearMeasureCache;
     /**

package/lib/types/components/docs/layout/shaping-engine/font-library.d.ts

@@ -0,0 +1,46 @@
+import { IStyleBase, Nullable } from '@univerjs/core';
+
+interface IFontData {
+    readonly family: string;
+    readonly fullName: string;
+    readonly postscriptName: string;
+    readonly style: string;
+}
+interface IFontWithBuffer {
+    readonly font: IFontData;
+    readonly buffer: ArrayBuffer;
+}
+declare enum FontStyle {
+    Normal = 0,
+    Italic = 1,
+    Oblique = 2
+}
+declare enum FontWeight {
+    THIN = 100,
+    EXTRALIGHT = 200,
+    LIGHT = 300,
+    REGULAR = 400,
+    MEDIUM = 500,
+    SEMIBOLD = 600,
+    BOLD = 700,
+    EXTRABOLD = 800,
+    BLACK = 900
+}
+interface IFontVariant {
+    style: FontStyle;
+    weight: FontWeight;
+}
+export interface IFontInfo {
+    family: string;
+    variant: IFontVariant;
+}
+declare class FontLibrary {
+    isReady: boolean;
+    private _fontBook;
+    constructor();
+    private _loadFontsToBook;
+    findBestMatchFontByStyle(style: IStyleBase): Nullable<IFontWithBuffer>;
+    getValidFontFamilies(families: string[]): string[];
+}
+export declare const fontLibrary: FontLibrary;
+export {};

package/lib/types/components/docs/layout/shaping-engine/text-shaping.d.ts

@@ -0,0 +1,21 @@
+import { Nullable } from 'vitest';
+import { default as Opentype } from 'opentype.js';
+import { IDocumentBody } from '@univerjs/core';
+
+interface IBoundingBox {
+    x1: number;
+    y1: number;
+    x2: number;
+    y2: number;
+}
+export interface IOpenTypeGlyphInfo {
+    char: string;
+    start: number;
+    end: number;
+    glyph: Nullable<Opentype.Glyph>;
+    font: Nullable<Opentype.Font>;
+    kerning: number;
+    boundingBox: Nullable<IBoundingBox>;
+}
+export declare function textShape(body: IDocumentBody): IOpenTypeGlyphInfo[];
+export {};

package/lib/types/components/docs/layout/shaping-engine/utils.d.ts

@@ -0,0 +1,9 @@
+import { IDocumentBody, IStyleBase } from '@univerjs/core';
+
+interface ITextChunk {
+    content: string;
+    style?: IStyleBase;
+}
+export declare function prepareParagraphBody(body: IDocumentBody, paragraphIndex: number): IDocumentBody;
+export declare function prepareTextChunks(body: IDocumentBody): ITextChunk[];
+export {};

package/lib/types/components/docs/layout/tools.d.ts

@@ -1,7 +1,7 @@
 import { DocumentViewModel } from '../view-model/document-view-model';
 import { DataStreamTreeNode } from '../view-model/data-stream-tree-node';
 import { IParagraphConfig, ISectionBreakConfig } from '../../../basics/interfaces';
-import { IDocumentSkeletonColumn, IDocumentSkeletonDivide, IDocumentSkeletonGlyph, IDocumentSkeletonLine, IDocumentSkeletonPage } from '../../../basics/i-document-skeleton-cached';
+import { IDocumentSkeletonColumn, IDocumentSkeletonDivide, IDocumentSkeletonFontStyle, IDocumentSkeletonGlyph, IDocumentSkeletonLine, IDocumentSkeletonPage } from '../../../basics/i-document-skeleton-cached';
 import { INumberUnit, IParagraphStyle, ITextStyle, ObjectPositionH, ObjectPositionV, BooleanNumber, GridType, SpacingRule } from '@univerjs/core';
 
 export declare function getLastPage(pages: IDocumentSkeletonPage[]): IDocumentSkeletonPage;
@@ -54,11 +54,7 @@ export declare function getPositionHorizon(positionH: ObjectPositionH, column: I
 export declare function getPositionVertical(positionV: ObjectPositionV, page: IDocumentSkeletonPage, lineTop: number, lineHeight: number, objectHeight: number, blockAnchorTop?: number, isPageBreak?: boolean): number | undefined;
 export declare function getGlyphGroupWidth(divide: IDocumentSkeletonDivide): number;
 interface IFontCreateConfig {
-    fontStyle: {
-        fontString: string;
-        fontSize: number;
-        fontFamily: string;
-    };
+    fontStyle: IDocumentSkeletonFontStyle;
     textStyle: ITextStyle;
     charSpace: number;
     gridType: GridType;

package/lib/types/components/sheets/sheet-skeleton.d.ts

@@ -2,7 +2,7 @@ import { IStylesCache } from './interfaces';
 import { Skeleton } from '../skeleton';
 import { DocumentSkeleton } from '../docs/layout/doc-skeleton';
 import { IBoundRectNoAngle, IViewportBound } from '../../basics/vector2';
-import { ICellData, IPaddingData, IRange, ISelectionCellWithCoord, ITextRotation, IWorksheetData, Nullable, Styles, Worksheet, BooleanNumber, DocumentDataModel, HorizontalAlign, IContextService, LocaleService, ObjectMatrix, VerticalAlign, WrapStrategy } from '@univerjs/core';
+import { BooleanNumber, DocumentDataModel, HorizontalAlign, IContextService, LocaleService, ObjectMatrix, VerticalAlign, WrapStrategy, ICellData, IPaddingData, IRange, ISelectionCellWithCoord, ITextRotation, IWorksheetData, Nullable, Styles, Worksheet } from '@univerjs/core';
 
 /**
  * Obtain the height and width of a cell's text, taking into account scenarios with rotated text.
@@ -36,7 +36,11 @@ export interface IDocumentLayoutObject {
 export declare const RENDER_RAW_FORMULA_KEY = "RENDER_RAW_FORMULA";
 export declare class SpreadsheetSkeleton extends Skeleton {
     private _worksheet;
-    private _config;
+    /**
+     * @deprecated avoid use `IWorksheetData` directly, use API provided by `Worksheet`, otherwise
+     * `ViewModel` will be not working.
+     */
+    private _worksheetData;
     private _cellData;
     private _styles;
     private readonly _contextService;
@@ -56,7 +60,12 @@ export declare class SpreadsheetSkeleton extends Skeleton {
     private _marginTop;
     private _marginLeft;
     private _renderRawFormula;
-    constructor(_worksheet: Worksheet | undefined, _config: IWorksheetData, _cellData: ObjectMatrix<Nullable<ICellData>>, _styles: Styles, _localeService: LocaleService, _contextService: IContextService);
+    constructor(_worksheet: Worksheet | undefined, 
+    /**
+     * @deprecated avoid use `IWorksheetData` directly, use API provided by `Worksheet`, otherwise
+     * `ViewModel` will be not working.
+     */
+    _worksheetData: IWorksheetData, _cellData: ObjectMatrix<Nullable<ICellData>>, _styles: Styles, _localeService: LocaleService, _contextService: IContextService);
     get rowHeightAccumulation(): number[];
     get rowTotalHeight(): number;
     get columnWidthAccumulation(): number[];

package/lib/types/index.d.ts

@@ -23,7 +23,8 @@ export * from './engine';
 export * from './group';
 export * from './layer';
 export { IRenderingEngine, UniverRenderEnginePlugin } from './render-engine';
-export * from './render-manager.service';
+export { type RenderComponentType, IRenderManagerService, RenderManagerService } from './render-manager/render-manager.service';
+export { RenderUnit, type IRender, type IRenderControllerCtor, type IRenderController, type IRenderContext } from './render-manager/render-unit';
 export * from './scene';
 export * from './scene-viewer';
 export * from './scroll-timer';
@@ -39,3 +40,4 @@ export { Documents } from './components/docs/document';
 export type { IPageRenderConfig } from './components/docs/document';
 export { DocumentSkeleton } from './components/docs/layout/doc-skeleton';
 export { ThinEngine } from './thin-engine';
+export { getCharSpaceApply, getNumberUnitValue } from './components/docs/layout/tools';

package/lib/types/render-engine.d.ts

@@ -1,6 +1,6 @@
 import { Engine } from './engine';
 import { Injector } from '@wendellhu/redi';
-import { Plugin, PluginType } from '@univerjs/core';
+import { Plugin } from '@univerjs/core';
 
 /**
  * The global rendering engine.
@@ -8,6 +8,6 @@ import { Plugin, PluginType } from '@univerjs/core';
 export declare const IRenderingEngine: import('@wendellhu/redi').IdentifierDecorator<Engine>;
 export declare class UniverRenderEnginePlugin extends Plugin {
     readonly _injector: Injector;
-    static type: PluginType;
+    static pluginName: string;
     constructor(_config: undefined, _injector: Injector);
 }

package/lib/types/{render-manager.service.d.ts → render-manager/render-manager.service.d.ts}

@@ -1,20 +1,21 @@
-import { Scene } from './scene';
-import { Engine } from './engine';
-import { Slide } from './components/slides/slide';
-import { SheetComponent } from './components/sheets/sheet-component';
-import { DocComponent } from './components/docs/doc-component';
-import { BaseObject } from './base-object';
+import { IRender, IRenderControllerCtor } from './render-unit';
+import { Engine } from '../engine';
+import { Slide } from '../components/slides/slide';
+import { SheetComponent } from '../components/sheets/sheet-component';
+import { DocComponent } from '../components/docs/doc-component';
+import { BaseObject } from '../base-object';
 import { Observable } from 'rxjs';
-import { Nullable } from '@univerjs/core';
+import { IDisposable, Injector } from '@wendellhu/redi';
+import { Nullable, UnitModel, UnitType, Disposable, IUniverInstanceService } from '@univerjs/core';
 
-export interface IRenderManagerService {
+export type RenderComponentType = SheetComponent | DocComponent | Slide | BaseObject;
+export interface IRenderManagerService extends IDisposable {
     currentRender$: Observable<Nullable<string>>;
     createRender$: Observable<Nullable<string>>;
-    dispose(): void;
     createRenderWithParent(unitId: string, parentUnitId: string): IRender;
     createRender(unitId: string): IRender;
-    addItem(unitId: string, item: IRender): void;
-    removeItem(unitId: string): void;
+    addRenderItem(unitId: string, item: IRender): void;
+    removeRender(unitId: string): void;
     setCurrent(unitId: string): void;
     getRenderById(unitId: string): Nullable<IRender>;
     getRenderAll(): Map<string, IRender>;
@@ -23,17 +24,11 @@ export interface IRenderManagerService {
     getCurrent(): Nullable<IRender>;
     getFirst(): Nullable<IRender>;
     has(unitId: string): boolean;
+    registerRenderControllers<T extends UnitModel>(type: UnitType, ctor: IRenderControllerCtor<T>): IDisposable;
 }
-export type RenderComponentType = SheetComponent | DocComponent | Slide | BaseObject;
-export interface IRender {
-    unitId: string;
-    engine: Engine;
-    scene: Scene;
-    mainComponent: Nullable<RenderComponentType>;
-    components: Map<string, RenderComponentType>;
-    isMainScene: boolean;
-}
-export declare class RenderManagerService implements IRenderManagerService {
+export declare class RenderManagerService extends Disposable implements IRenderManagerService {
+    private readonly _injector;
+    private readonly _univerInstanceService;
     private _defaultEngine;
     private _currentUnitId;
     private _renderMap;
@@ -42,14 +37,18 @@ export declare class RenderManagerService implements IRenderManagerService {
     private readonly _createRender$;
     readonly createRender$: Observable<Nullable<string>>;
     get defaultEngine(): Engine;
+    private readonly _renderControllers;
+    constructor(_injector: Injector, _univerInstanceService: IUniverInstanceService);
     dispose(): void;
+    registerRenderControllers(type: UnitType, ctor: IRenderControllerCtor): IDisposable;
+    private _getRenderControllersForType;
     createRenderWithParent(unitId: string, parentUnitId: string): IRender;
     createRenderWithEngine(unitId: string, engine: Engine): IRender;
     create(unitId: Nullable<string>): void;
     createRender(unitId: string): IRender;
     private _createRender;
-    addItem(unitId: string, item: IRender): void;
-    removeItem(unitId: string): void;
+    addRenderItem(unitId: string, item: IRender): void;
+    removeRender(unitId: string): void;
     has(unitId: string): boolean;
     setCurrent(unitId: string): void;
     getCurrent(): IRender | undefined;

package/lib/types/render-manager/render-unit.d.ts

@@ -0,0 +1,50 @@
+import { RenderComponentType } from './render-manager.service';
+import { Scene } from '../scene';
+import { Engine } from '../engine';
+import { IDisposable, Injector } from '@wendellhu/redi';
+import { Nullable, UnitModel, UnitType, Disposable } from '@univerjs/core';
+
+export interface IRender {
+    unitId: string;
+    engine: Engine;
+    scene: Scene;
+    mainComponent: Nullable<RenderComponentType>;
+    components: Map<string, RenderComponentType>;
+    isMainScene: boolean;
+}
+export interface IRenderControllerCtor<T extends UnitModel = UnitModel> {
+    new (unit: IRenderContext<T>, ...args: any[]): IRenderController;
+}
+export interface IRenderController extends IDisposable {
+}
+/**
+ * This object encapsulates methods or properties to render each element.
+ */
+export interface IRenderContext<T extends UnitModel = UnitModel> extends IRender {
+    unit: T;
+    type: UnitType;
+}
+/**
+ * This class is responsible
+ */
+export declare class RenderUnit extends Disposable implements IRender {
+    readonly isRenderUnit: true;
+    get unitId(): string;
+    get type(): UnitType;
+    private readonly _injector;
+    private readonly _renderControllers;
+    private _renderContext;
+    set isMainScene(is: boolean);
+    get isMainScene(): boolean;
+    set engine(engine: Engine);
+    get engine(): Engine;
+    set mainComponent(component: Nullable<RenderComponentType>);
+    get mainComponent(): Nullable<RenderComponentType>;
+    set scene(scene: Scene);
+    get scene(): Scene;
+    get components(): Map<string, RenderComponentType>;
+    constructor(parentInjector: Injector, init: Pick<IRenderContext, 'engine' | 'scene' | 'isMainScene' | 'unit'>);
+    dispose(): void;
+    addRenderControllers(ctors: IRenderControllerCtor[]): void;
+    private _initControllers;
+}

package/lib/types/viewport.d.ts

@@ -168,7 +168,7 @@ export declare class Viewport {
     getAbsoluteVector(coord: Vector2): Vector2;
     onMouseWheel(evt: IWheelEvent, state: EventState): void;
     isHit(coord: Vector2): boolean | undefined;
-    pickScrollBar(coord: Vector2): import('./shape').Rect<import("./shape").IRectProps> | null | undefined;
+    pickScrollBar(coord: Vector2): import('./shape').Rect<import('./shape').IRectProps> | null | undefined;
     openClip(): void;
     closeClip(): void;
     dispose(): void;