NEXT WIP

Author: laa-odoo

src/components/composer/composer/cell_composer_store.ts

@@ -1,3 +1,4 @@
+import { prettify } from "../../../formulas/formula_formatter";
 import { parseTokens } from "../../../formulas/parser";
 import { isMultipleElementMatrix, toScalar } from "../../../functions/helper_matrices";
 import { parseLiteral } from "../../../helpers/cells";
@@ -28,7 +29,6 @@ import {
   isMatrix,
 } from "../../../types";
 import { AbstractComposerStore } from "./abstract_composer_store";
-import { prettify } from "./prettifier_content";
 
 const CELL_DELETED_MESSAGE = _t("The cell you are trying to edit has been deleted.");
 
@@ -206,7 +206,7 @@ export class CellComposerStore extends AbstractComposerStore {
     if (cell?.isFormula) {
       const prettifiedContent = cell.compiledFormula.isBadExpression
         ? cell.content
-        : prettify(parseTokens(cell.compiledFormula.tokens));
+        : prettify(parseTokens(cell.compiledFormula.tokens), 80);
       return localizeFormula(prettifiedContent, locale);
     }
     const spreader = this.model.getters.getArrayFormulaSpreadingOn(position);

…/composer/composer/prettifier_content.ts src/formulas/formula_formatter.tssrc/components/composer/composer/prettifier_content.ts renamed to src/formulas/formula_formatter.ts src/components/composer/composer/prettifier_content.ts renamed to src/formulas/formula_formatter.ts

@@ -1,9 +1,7 @@
-import {
-  AST,
-  leftOperandNeedsParenthesis,
-  rightOperandNeedsParenthesis,
-} from "../../../formulas/parser";
-import { memoize } from "../../../helpers";
+import { memoize } from "../helpers";
+import { AST, ASTOperation, ASTUnaryOperation, OP_PRIORITY } from "./parser";
+
+const ASSOCIATIVE_OPERATORS = ["*", "+", "&"];
 
 /**
  * Pretty-prints formula ASTs into readable formulas.
@@ -17,8 +15,8 @@ import { memoize } from "../../../helpers";
  * - https://lik.ai/blog/how-a-pretty-printer-works/
  * - Wadler, "A prettier printer": https://homepages.inf.ed.ac.uk/wadler/papers/prettier/prettier.pdf
  */
-export function prettify(ast: AST): string {
-  return "=" + print(astToDoc(ast), 59); // 59 but 60 with the `=` at the beginning
+export function prettify(ast: AST, width = 60): string {
+  return "=" + print(astToDoc(ast), width - 1); // width-1 because of the leading '='
 }
 
 // ---------------------------------------
@@ -290,3 +288,66 @@ function wrapInParentheses(doc: Doc, functionName: undefined | string = undefine
   }
   return group(concat(docToConcat));
 }
+
+/**
+ * Converts an ast formula to the corresponding string
+ */
+export function astToFormula(ast: AST): string {
+  switch (ast.type) {
+    case "FUNCALL":
+      const args = ast.args.map((arg) => astToFormula(arg));
+      return `${ast.value}(${args.join(",")})`;
+    case "NUMBER":
+      return ast.value.toString();
+    case "REFERENCE":
+      return ast.value;
+    case "STRING":
+      return `"${ast.value}"`;
+    case "BOOLEAN":
+      return ast.value ? "TRUE" : "FALSE";
+    case "UNARY_OPERATION":
+      if (ast.postfix) {
+        const leftOperand = leftOperandNeedsParenthesis(ast)
+          ? `(${astToFormula(ast.operand)})`
+          : astToFormula(ast.operand);
+        return leftOperand + ast.value;
+      }
+      const rightOperand = rightOperandNeedsParenthesis(ast)
+        ? `(${astToFormula(ast.operand)})`
+        : astToFormula(ast.operand);
+      return ast.value + rightOperand;
+    case "BIN_OPERATION":
+      const leftOperation = leftOperandNeedsParenthesis(ast)
+        ? `(${astToFormula(ast.left)})`
+        : astToFormula(ast.left);
+      const rightOperation = rightOperandNeedsParenthesis(ast)
+        ? `(${astToFormula(ast.right)})`
+        : astToFormula(ast.right);
+      return leftOperation + ast.value + rightOperation;
+    default:
+      return ast.value;
+  }
+}
+
+function leftOperandNeedsParenthesis(operationAST: ASTOperation | ASTUnaryOperation): boolean {
+  const mainOperator = operationAST.value;
+  const leftOperation = "left" in operationAST ? operationAST.left : operationAST.operand;
+  const leftOperator = leftOperation.value;
+  return (
+    leftOperation.type === "BIN_OPERATION" && OP_PRIORITY[leftOperator] < OP_PRIORITY[mainOperator]
+  );
+}
+
+function rightOperandNeedsParenthesis(operationAST: ASTOperation | ASTUnaryOperation): boolean {
+  const mainOperator = operationAST.value;
+  const rightOperation = "right" in operationAST ? operationAST.right : operationAST.operand;
+  const rightPriority = OP_PRIORITY[rightOperation.value];
+  const mainPriority = OP_PRIORITY[mainOperator];
+  if (rightOperation.type !== "BIN_OPERATION") {
+    return false;
+  }
+  if (rightPriority < mainPriority) {
+    return true;
+  }
+  return rightPriority === mainPriority && !ASSOCIATIVE_OPERATORS.includes(mainOperator);
+}

src/formulas/parser.ts

@@ -10,8 +10,6 @@ const functionRegex = /[a-zA-Z0-9\_]+(\.[a-zA-Z0-9\_]+)*/;
 const UNARY_OPERATORS_PREFIX = ["-", "+"];
 const UNARY_OPERATORS_POSTFIX = ["%"];
 
-const ASSOCIATIVE_OPERATORS = ["*", "+", "&"];
-
 interface RichToken extends Token {
   tokenIndex: number;
 }
@@ -68,14 +66,14 @@ interface ASTBoolean extends ASTBase {
   value: boolean;
 }
 
-interface ASTUnaryOperation extends ASTBase {
+export interface ASTUnaryOperation extends ASTBase {
   type: "UNARY_OPERATION";
   value: any;
   operand: AST;
   postfix?: boolean; // needed to rebuild string from ast
 }
 
-interface ASTOperation extends ASTBase {
+export interface ASTOperation extends ASTBase {
   type: "BIN_OPERATION";
   value: any;
   left: AST;
@@ -414,70 +412,3 @@ export function mapAst<T extends AST["type"]>(
       return ast;
   }
 }
-
-/**
- * Converts an ast formula to the corresponding string
- */
-export function astToFormula(ast: AST): string {
-  switch (ast.type) {
-    case "FUNCALL":
-      const args = ast.args.map((arg) => astToFormula(arg));
-      return `${ast.value}(${args.join(",")})`;
-    case "NUMBER":
-      return ast.value.toString();
-    case "REFERENCE":
-      return ast.value;
-    case "STRING":
-      return `"${ast.value}"`;
-    case "BOOLEAN":
-      return ast.value ? "TRUE" : "FALSE";
-    case "UNARY_OPERATION":
-      if (ast.postfix) {
-        const leftOperand = leftOperandNeedsParenthesis(ast)
-          ? `(${astToFormula(ast.operand)})`
-          : astToFormula(ast.operand);
-        return leftOperand + ast.value;
-      }
-      const rightOperand = rightOperandNeedsParenthesis(ast)
-        ? `(${astToFormula(ast.operand)})`
-        : astToFormula(ast.operand);
-      return ast.value + rightOperand;
-    case "BIN_OPERATION":
-      const leftOperation = leftOperandNeedsParenthesis(ast)
-        ? `(${astToFormula(ast.left)})`
-        : astToFormula(ast.left);
-      const rightOperation = rightOperandNeedsParenthesis(ast)
-        ? `(${astToFormula(ast.right)})`
-        : astToFormula(ast.right);
-      return leftOperation + ast.value + rightOperation;
-    default:
-      return ast.value;
-  }
-}
-
-export function leftOperandNeedsParenthesis(
-  operationAST: ASTOperation | ASTUnaryOperation
-): boolean {
-  const mainOperator = operationAST.value;
-  const leftOperation = "left" in operationAST ? operationAST.left : operationAST.operand;
-  const leftOperator = leftOperation.value;
-  return (
-    leftOperation.type === "BIN_OPERATION" && OP_PRIORITY[leftOperator] < OP_PRIORITY[mainOperator]
-  );
-}
-
-export function rightOperandNeedsParenthesis(
-  operationAST: ASTOperation | ASTUnaryOperation
-): boolean {
-  const mainOperator = operationAST.value;
-  const rightOperation = "right" in operationAST ? operationAST.right : operationAST.operand;
-  const rightPriority = OP_PRIORITY[rightOperation.value];
-  const mainPriority = OP_PRIORITY[mainOperator];
-  if (rightOperation.type !== "BIN_OPERATION") {
-    return false;
-  }
-  if (rightPriority < mainPriority) {
-    return true;
-  }
-  return rightPriority === mainPriority && !ASSOCIATIVE_OPERATORS.includes(mainOperator);
-}

src/index.ts

@@ -213,13 +213,8 @@ export { tokenColors } from "./components/composer/composer/abstract_composer_st
 export { Spreadsheet } from "./components/index";
 export { setDefaultSheetViewSize } from "./constants";
 export { compile, compileTokens, functionCache } from "./formulas/compiler";
-export {
-  astToFormula,
-  convertAstNodes,
-  iterateAstNodes,
-  parse,
-  parseTokens,
-} from "./formulas/parser";
+export { astToFormula } from "./formulas/formula_formatter";
+export { convertAstNodes, iterateAstNodes, parse, parseTokens } from "./formulas/parser";
 export { tokenize } from "./formulas/tokenizer";
 export { AbstractChart } from "./helpers/figures/charts";
 export { findCellInNewZone } from "./helpers/zones";

src/plugins/ui_core_views/pivot_ui.ts

@@ -1,5 +1,5 @@
 import { Token } from "../../formulas";
-import { astToFormula } from "../../formulas/parser";
+import { astToFormula } from "../../formulas/formula_formatter";
 import { toScalar } from "../../functions/helper_matrices";
 import { toBoolean } from "../../functions/helpers";
 import { getUniqueText } from "../../helpers";

src/xlsx/functions/cells.ts

@@ -1,11 +1,5 @@
-import {
-  AST,
-  ASTFuncall,
-  ASTString,
-  astToFormula,
-  convertAstNodes,
-  parse,
-} from "../../formulas/parser";
+import { astToFormula } from "../../formulas/formula_formatter";
+import { AST, ASTFuncall, ASTString, convertAstNodes, parse } from "../../formulas/parser";
 import { functionRegistry } from "../../functions";
 import { formatValue, isNumber } from "../../helpers";
 import { mdyDateRegexp, parseDateTime, timeRegexp, ymdDateRegexp } from "../../helpers/dates";