[IMP] functions: Add ISFORMULA function

closes #8067

Task: 6013888
X-original-commit: 90cb91a
Signed-off-by: Lucas Lefèvre (lul) <lul@odoo.com>
Signed-off-by: Rémi Rahir (rar) <rar@odoo.com>

Author: rrahir

demo/data.js

@@ -1418,6 +1418,7 @@ export const demoData = {
         A231: "ARRAYTOTEXT",
         A232: "FORMULATEXT",
         A233: "TAKE",
+        A234: "ISFORMULA",
         B1: "evaluation",
         B2: "=ABS(-5.5)",
         B3: "=ACOS(1)",
@@ -1651,6 +1652,7 @@ export const demoData = {
         B231: "=ARRAYTOTEXT(A227:B228,1)",
         B232: "=FORMULATEXT(B227)",
         B233: "=TAKE(A227:B228,1,1)",
+        B234: "=ISFORMULA(D228)",
         C1: "expected value",
         C2: "5.5",
         C3: "0",
@@ -1881,6 +1883,7 @@ export const demoData = {
         C231: '{"TEXTBEFORE","Hello there";"REGEXEXTRACT","Kenobi"}',
         C232: '\'=TEXTBEFORE("Hello there; General Kenobi", "; ")',
         C233: "TEXTBEFORE",
+        C234: "TRUE",
         D1: "is it compatible ?",
         D2: "=IF(B2=C2,1, 0)",
         D3: "=IF(B3=C3,1, 0)",
@@ -2114,6 +2117,7 @@ export const demoData = {
         D231: "=IF(B231=C231,1, 0)",
         D232: "=IF(B232=C232,1, 0)",
         D233: "=IF(B233=C233,1, 0)",
+        D234: "=IF(B234=C234,1, 0)",
         G1: "Name",
         G2: "Robot1",
         G3: "Robot2",

packages/o-spreadsheet-engine/src/functions/module_info.ts

@@ -1,9 +1,10 @@
+import { toCartesian } from "../helpers/coordinates";
 import { getFullReference, setXcToFixedReferenceType, splitReference } from "../helpers/references";
 import { _t } from "../translation";
 import { CellValueType } from "../types/cells";
 import { CellErrorType, EvaluationError } from "../types/errors";
 import { AddFunctionDescription } from "../types/functions";
-import { FunctionResultObject, Matrix, Maybe } from "../types/misc";
+import { FunctionResultObject, Matrix, Maybe, UID } from "../types/misc";
 import { arg } from "./arguments";
 import { isEvaluationError, toString } from "./helpers";
 
@@ -196,3 +197,22 @@ export const NA = {
   },
   isExported: true,
 } satisfies AddFunctionDescription;
+
+//--------------------------------------------------------------------------
+// ISFORMULA
+//--------------------------------------------------------------------------
+export const ISFORMULA = {
+  description: _t(
+    "Checks whether there is a reference to a cell that contains a formula, and returns TRUE or FALSE."
+  ),
+  args: [arg("cell_reference (meta)", _t("A reference to a cell."))],
+  compute: function (cellReference: { value: string }) {
+    const { sheetName, xc } = splitReference(cellReference.value);
+    const { col, row } = toCartesian(xc);
+    const sheetId: UID =
+      (sheetName && this.getters.getSheetIdByName(sheetName)) ?? this.__originSheetId;
+    const cell = this.getters.getCell({ sheetId, col, row });
+    return cell?.isFormula ?? false;
+  },
+  isExported: true,
+} satisfies AddFunctionDescription;

tests/functions/module_info.test.ts

@@ -1,7 +1,7 @@
 import { Model } from "../../src";
 import { createSheet, setCellContent, setFormat } from "../test_helpers/commands_helpers";
 import { getCellContent } from "../test_helpers/getters_helpers";
-import { createModelFromGrid, evaluateCell, setGrid } from "../test_helpers/helpers";
+import { createModelFromGrid, evaluateCell, evaluateGrid, setGrid } from "../test_helpers/helpers";
 
 describe("CELL formula", () => {
   test("CELL takes 2 arguments", () => {
@@ -395,3 +395,29 @@ describe("NA formula", () => {
     expect(evaluateCell("A1", { A1: "=NA()" })).toBe("#N/A");
   });
 });
+
+describe("ISFORMULA formula", () => {
+  test("test All different types", () => {
+    //prettier-ignore
+    const grid = {
+      A1: "=SUM(B1:B2)",     B1: "=ISFORMULA(A1)",
+      A2: "",                B2: "=ISFORMULA(A2)",
+      A3: "just text",       B3: "=ISFORMULA(A3)",
+      A4: "42",              B4: "=ISFORMULA(A4)",
+      A5: "=1/0",            B5: "=ISFORMULA(A5)",
+      A6: "=#REF",           B6: "=ISFORMULA(A6)",
+                             B7: "=ISFORMULA(A7, 1)",
+                             B8: "=ISFORMULA(sum(1,2))",
+
+    };
+    const gridResult = evaluateGrid(grid);
+    expect(gridResult.B1).toBe(true);
+    expect(gridResult.B2).toBe(false);
+    expect(gridResult.B3).toBe(false);
+    expect(gridResult.B4).toBe(false);
+    expect(gridResult.B5).toBe(true);
+    expect(gridResult.B6).toBe(true);
+    expect(gridResult.B7).toBe("#BAD_EXPR"); // @compatibility: on google sheets, return #N/A
+    expect(gridResult.B8).toBe("#BAD_EXPR"); // @compatibility: on google sheets, return #N/A
+  });
+});