Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(formula): support lambda in function register #4298

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,10 @@ export class FunctionNode extends BaseAstNode {
return (variant as ArrayValueObject).toValue();
}

if (variant.isLambda()) {
return variant;
}

return variant.getValue();
})
);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,12 @@ import type { BaseAstNode } from '../ast-node/base-ast-node';
import type { LambdaParameterNode } from '../ast-node/lambda-parameter-node';
import type { Interpreter } from '../interpreter/interpreter';
import type { BaseReferenceObject, FunctionVariantType } from '../reference-object/base-reference-object';
import type { PrimitiveValueType } from './primitive-object';
import { ErrorType } from '../../basics/error-type';
import { DEFAULT_TOKEN_TYPE_LAMBDA_RUNTIME_PARAMETER } from '../../basics/token-type';
import { AsyncObject } from '../reference-object/base-reference-object';
import { generateExecuteAstNodeData } from '../utils/ast-node-tool';
import { ValueObjectFactory } from './array-value-object';
import { BaseValueObject, ErrorValueObject } from './base-value-object';

function getRootLexerHasValueNode(node: Nullable<BaseAstNode>): Nullable<BaseAstNode> {
Expand Down Expand Up @@ -110,6 +112,16 @@ export class LambdaValueObjectObject extends BaseValueObject {
return value;
}

/**
* Execute custom lambda function, handle basic types
* @param variants
*/
executeCustom(...variants: PrimitiveValueType[]) {
// Create base value object from primitive value, then execute
const baseValueObjects = variants.map((variant) => ValueObjectFactory.create(variant));
return this.execute(...baseValueObjects);
}

private _setLambdaNodeValue(node: Nullable<BaseAstNode>) {
if (!node) {
return;
Expand Down
2 changes: 1 addition & 1 deletion packages/engine-formula/src/functions/base-function.ts
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ export class BaseFunction {
}

calculateCustom(
...arg: Array<PrimitiveValueType | PrimitiveValueType[][]>
...arg: Array<PrimitiveValueType | PrimitiveValueType[][] | BaseValueObject>
): PrimitiveValueType | PrimitiveValueType[][] {
return null;
}
Expand Down
1 change: 1 addition & 0 deletions packages/engine-formula/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -167,3 +167,4 @@ export { ENGINE_FORMULA_CYCLE_REFERENCE_COUNT, ENGINE_FORMULA_PLUGIN_CONFIG_KEY,

export { generateRandomDependencyTreeId } from './engine/dependency/formula-dependency';
export { DependencyManagerBaseService } from './services/dependency-manager.service';
export { LambdaValueObjectObject } from './engine/value-object/lambda-value-object';
14 changes: 13 additions & 1 deletion packages/facade/src/apis/__tests__/facade.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
*/

import type { ICellData, Injector, Nullable } from '@univerjs/core';
import type { LambdaValueObjectObject, PrimitiveValueType } from '@univerjs/engine-formula';
import type {
ColumnHeaderLayout,
RenderComponentType,
Expand All @@ -24,8 +25,8 @@ import type {
SpreadsheetRowHeader,
} from '@univerjs/engine-render';
import type { FUniver } from '../everything';
import { ICommandService, IUniverInstanceService } from '@univerjs/core';

import { ICommandService, IUniverInstanceService } from '@univerjs/core';
import { RegisterFunctionMutation, SetFormulaCalculationStartMutation } from '@univerjs/engine-formula';
import { IRenderManagerService } from '@univerjs/engine-render';
import { SetRangeValuesCommand, SetRangeValuesMutation, SetStyleCommand } from '@univerjs/sheets';
Expand Down Expand Up @@ -178,11 +179,22 @@ describe('Test FUniver', () => {

it('Function registerFunction', () => {
const funcionName = 'CUSTOMSUM';

const functionsDisposable = univerAPI.registerFunction({
calculate: [
[function (...variants) {
let sum = 0;

const last = variants[variants.length - 1] as LambdaValueObjectObject;

if (last.isLambda()) {
variants.pop();

const variantsList = variants.map((variant) => Array.isArray(variant) ? variant[0][0] : variant) as PrimitiveValueType[];

sum += +last.executeCustom(...variantsList).getValue();
}

for (const variant of variants) {
sum += Number(variant) || 0;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@
*/

import type { IDisposable, ILocales } from '@univerjs/core';
import type { IFunctionInfo, PrimitiveValueType } from '@univerjs/engine-formula';
import type { BaseValueObject, IFunctionInfo, PrimitiveValueType } from '@univerjs/engine-formula';
import { createIdentifier, Disposable, DisposableCollection, Inject, LocaleService, Optional, toDisposable } from '@univerjs/core';
import { CustomFunction, FunctionType, IFunctionService } from '@univerjs/engine-formula';
import { IDescriptionService } from './description.service';
import { IRemoteRegisterFunctionService } from './remote/remote-register-function.service';

export type IRegisterFunction = (
...arg: Array<PrimitiveValueType | PrimitiveValueType[][]>
...arg: Array<PrimitiveValueType | PrimitiveValueType[][] | BaseValueObject>
) => PrimitiveValueType | PrimitiveValueType[][];

// [[Function, FunctionName, Description]]
Expand Down
Loading