Skip to content

Build your own AI office with Univer Office SDK. Bring editing, calculation, collaboration, and file processing into your product for people and AI agents. Built on an extensible open-source core.

5.2 KB
Raw Blame
/**
 * Copyright 2023-present DreamNum Co., Ltd.
 *
 * 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.
 */

import type { IDisposable, Nullable } from '@univerjs/core';
import type { IFunctionInfo, IFunctionNames } from '../basics/function';
import type { BaseFunction } from '../functions/base-function';
import { createIdentifier, Disposable, Inject, toDisposable } from '@univerjs/core';
import { FormulaCacheService } from './formula-cache.service';

export interface IFunctionService {
    /**
     * Use register to register a function, new CustomFunction(inject, name)
     */
    registerExecutors(...functions: BaseFunction[]): void;

    getExecutors(): Map<IFunctionNames, BaseFunction>;

    /**
     * Obtain the operator of the function to reuse the calculation logic.
     * The argument type accepted by the function is: FunctionVariantType.
     * For instance, the sum formula capability is needed for the statistics bar.
     * You can obtain the calculation result by using
     * const sum = formulaService.getExecutor(FUNCTION_NAMES_MATH.SUM);
     * sum.calculate(new RangeReferenceObject(range, sheetId, unitId), ref2, re3).
     * @param functionName Function name, which can be obtained through the FUNCTION_NAMES enumeration.
     * @returns
     */
    getExecutor(functionToken: IFunctionNames): Nullable<BaseFunction>;

    hasExecutor(functionToken: IFunctionNames): boolean;

    unregisterExecutors(...functionTokens: IFunctionNames[]): void;

    registerDescriptions(...functions: IFunctionInfo[]): IDisposable;

    getDescriptions(): Map<IFunctionNames, IFunctionInfo>;

    getDescription(functionToken: IFunctionNames): IFunctionInfo | undefined;

    hasDescription(functionToken: IFunctionNames): boolean;

    unregisterDescriptions(...functionTokens: IFunctionNames[]): void;

    clearDescriptions(): void;

    deleteFormulaAstCacheKey(...functionToken: IFunctionNames[]): void;
}
export const IFunctionService = createIdentifier<IFunctionService>('univer.formula-function.service');

export class FunctionService extends Disposable implements IFunctionService {
    private _functionExecutors: Map<IFunctionNames, BaseFunction> = new Map();

    private _functionDescriptions: Map<IFunctionNames, IFunctionInfo> = new Map();

    constructor(@Inject(FormulaCacheService) private readonly _cacheService: FormulaCacheService) {
        super();
    }

    override dispose(): void {
        super.dispose();
        this._functionExecutors.clear();
        this._functionDescriptions.clear();
    }

    registerExecutors(...functions: BaseFunction[]) {
        this._cacheService.clearFunctions(functions.map((executor) => executor.name));
        for (let i = 0; i < functions.length; i++) {
            const func = functions[i];
            this._functionExecutors.set(func.name, func);
        }
    }

    getExecutors() {
        return this._functionExecutors;
    }

    getExecutor(functionToken: IFunctionNames) {
        return this._functionExecutors.get(functionToken);
    }

    hasExecutor(functionToken: IFunctionNames) {
        return this._functionExecutors.has(functionToken);
    }

    unregisterExecutors(...functionTokens: IFunctionNames[]) {
        this._cacheService.clearFunctions(functionTokens);
        for (let i = 0; i < functionTokens.length; i++) {
            const functionToken = functionTokens[i];
            this._functionExecutors.delete(functionToken);
        }
    }

    registerDescriptions(...descriptions: IFunctionInfo[]): IDisposable {
        for (let i = 0; i < descriptions.length; i++) {
            const description = descriptions[i];
            this._functionDescriptions.set(description.functionName, description);
        }

        return toDisposable(() => {
            for (let i = 0; i < descriptions.length; i++) {
                const description = descriptions[i];
                this._functionDescriptions.delete(description.functionName);
            }
        });
    }

    getDescriptions() {
        return this._functionDescriptions;
    }

    getDescription(functionToken: IFunctionNames) {
        return this._functionDescriptions.get(functionToken);
    }

    hasDescription(functionToken: IFunctionNames) {
        return this._functionDescriptions.has(functionToken);
    }

    unregisterDescriptions(...functionTokens: IFunctionNames[]) {
        for (let i = 0; i < functionTokens.length; i++) {
            const functionToken = functionTokens[i];
            this._functionDescriptions.delete(functionToken);
        }
    }

    clearDescriptions() {
        this._functionDescriptions.clear();
    }

    deleteFormulaAstCacheKey(...functionToken: IFunctionNames[]) {
        this._cacheService.clearFunctions(functionToken);
    }
}