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.

4.5 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 { ArrayValueObject } from '../../../engine/value-object/array-value-object';
import type { BaseValueObject } from '../../../engine/value-object/base-value-object';
import { ErrorType } from '../../../basics/error-type';
import { checkVariantsErrorIsStringToNumber } from '../../../engine/utils/check-variant-error';
import { ErrorValueObject } from '../../../engine/value-object/base-value-object';
import { NumberValueObject, StringValueObject } from '../../../engine/value-object/primitive-object';
import { BaseFunction } from '../../base-function';

export class Arraytotext extends BaseFunction {
    override minParams = 1;

    override maxParams = 2;

    override calculate(array: BaseValueObject, format?: BaseValueObject): BaseValueObject {
        let _format = format ?? NumberValueObject.create(0);

        if (format?.isNull()) {
            _format = NumberValueObject.create(0);
        }

        if (_format.isArray()) {
            const resultArray = (_format as ArrayValueObject).mapValue((formatObject) => this._handleSingleObject(array, formatObject));

            if ((resultArray as ArrayValueObject).getRowCount() === 1 && (resultArray as ArrayValueObject).getColumnCount() === 1) {
                return (resultArray as ArrayValueObject).get(0, 0) as BaseValueObject;
            }

            return resultArray;
        }

        return this._handleSingleObject(array, _format);
    }

    private _handleSingleObject(array: BaseValueObject, format: BaseValueObject): BaseValueObject {
        const _array = this._checkArray(array);

        if (_array.isError()) {
            return _array;
        }

        const { isError, errorObject, variants } = checkVariantsErrorIsStringToNumber(format);

        if (isError) {
            return errorObject as ErrorValueObject;
        }

        const [formatObject] = variants as BaseValueObject[];

        const formatValue = +formatObject.getValue();

        const arrayRowCount = array.isArray() ? (array as ArrayValueObject).getRowCount() : 1;
        const arrayColumnCount = array.isArray() ? (array as ArrayValueObject).getColumnCount() : 1;

        let result = '';

        for (let r = 0; r < arrayRowCount; r++) {
            for (let c = 0; c < arrayColumnCount; c++) {
                const valueObject = array.isArray() ? (array as ArrayValueObject).get(r, c) as BaseValueObject : array;

                let value = `${valueObject.getValue()}`;

                if (valueObject.isNull()) {
                    value = '';
                }

                if (valueObject.isBoolean()) {
                    value = value.toLocaleUpperCase();
                }

                if (valueObject.isString() && formatValue) {
                    result += `"${value}"`;
                } else {
                    result += value;
                }

                if (!(r === arrayRowCount - 1 && c === arrayColumnCount - 1)) {
                    if (formatValue) {
                        if (c === arrayColumnCount - 1) {
                            result += ';';
                        } else {
                            result += ',';
                        }
                    } else {
                        result += ', ';
                    }
                }
            }
        }

        if (formatValue) {
            result = `{${result}}`;
        }

        if (result.length > 32767) {
            return ErrorValueObject.create(ErrorType.CALC);
        }

        return StringValueObject.create(result);
    }

    private _checkArray(array: BaseValueObject): BaseValueObject {
        if (array.isArray()) {
            const arrayRowCount = (array as ArrayValueObject).getRowCount();
            const arrayColumnCount = (array as ArrayValueObject).getColumnCount();

            if (arrayRowCount > 1 || arrayColumnCount > 1) {
                return array;
            }

            return (array as ArrayValueObject).get(0, 0) as BaseValueObject;
        }

        return array;
    }
}