@syncfusion/ej2-calculate 35.1.37

package/src/base/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Calculate engine core: {@link Calculate} evaluator and {@link Parser}.
+ *
+ * @packageDocumentation
+ */
+export * from './calculate';
+export * from './calculate-model';
+export * from './parser';

package/src/base/index.js

@@ -0,0 +1,7 @@
+/**
+ * Calculate engine core: {@link Calculate} evaluator and {@link Parser}.
+ *
+ * @packageDocumentation
+ */
+export * from './calculate';
+export * from './parser';

package/src/base/parser.d.ts

@@ -0,0 +1,208 @@
+/**
+ * Formula tokenizer and parser for the Calculate engine.
+ *
+ * Converts Excel-style formula text into an internal token string consumed by
+ * {@link Calculate.computeFormula}. Handles operators, library function markers,
+ * named ranges, and sheet references.
+ *
+ * @remarks
+ * Prefer {@link Calculate.computeFormula} or {@link Calculate.computeExpression}
+ * for evaluation. Use {@link Parser.parseFormula} when you need the parsed token
+ * form without computing a result.
+ *
+ * @hidden
+ */
+import { Calculate } from './index';
+export declare class Parser {
+    private parent;
+    /**
+     * @param {Object} parent - Owning {@link Calculate} engine instance.
+     */
+    constructor(parent?: Calculate);
+    private emptyStr;
+    private storedStringText;
+    private sheetToken;
+    /** @hidden */
+    tokenAdd: string;
+    /** @hidden */
+    tokenSubtract: string;
+    /** @hidden */
+    tokenMultiply: string;
+    /** @hidden */
+    tokenDivide: string;
+    /** @hidden */
+    tokenLess: string;
+    private charEm;
+    private charEp;
+    /** @hidden */
+    tokenGreater: string;
+    /** @hidden */
+    tokenEqual: string;
+    /** @hidden */
+    tokenLessEq: string;
+    /** @hidden */
+    tokenGreaterEq: string;
+    /** @hidden */
+    tokenNotEqual: string;
+    /** @hidden */
+    tokenAnd: string;
+    private tokenEm;
+    private tokenEp;
+    /** @hidden */
+    tokenOr: string;
+    private charAnd;
+    private charLess;
+    private charGreater;
+    private charEqual;
+    private charLessEq;
+    private charGreaterEq;
+    private charNoEqual;
+    private stringGreaterEq;
+    private stringLessEq;
+    private stringNoEqual;
+    private stringAnd;
+    private stringOr;
+    private charOr;
+    private charAdd;
+    private charSubtract;
+    private charMultiply;
+    private charDivide;
+    private fixedReference;
+    private spaceString;
+    private ignoreBracet;
+    /**
+     * When `true`, the last parse attempt failed.
+     *
+     * @internal
+     */
+    isError: boolean;
+    /**
+     * When `true`, formula text passed to compute is already a parsed token string.
+     *
+     * @internal
+     */
+    isFormulaParsed: boolean;
+    private findNamedRange;
+    private stringsColl;
+    private tokens;
+    private charNOTop;
+    private specialSym;
+    private isFailureTriggered;
+    /**
+     * Parses formula text into the engine's internal token representation.
+     *
+     * Performs named-range substitution, string literal extraction, operator
+     * collapsing, and library-formula marking.
+     *
+     * @param {string} text - Formula text (leading `=` is optional).
+     * @param {string} fkey - Optional formula cell key for named-range / failure context.
+     * @returns {string} - Parsed token string, or an error token when parsing fails.
+     */
+    parse(text: string, fkey?: string): string;
+    private exceptionArgs;
+    private formulaAutoCorrection;
+    private checkScopedRange;
+    private storeStrings;
+    private setStrings;
+    /**
+     * Parses a simple (non-library) expression after library formulas are marked.
+     *
+     * @param {string} formulaText - Partially processed formula text.
+     * @returns {string} - Token string with arithmetic markers applied.
+     */
+    parseSimple(formulaText: string): string;
+    /**
+     * Replaces operator characters with single-character tokens for evaluation.
+     *
+     * @param {string} formulaText - Formula text containing operator markers.
+     * @param {string | number | Object} markers - Replacement token characters.
+     * @param {string} operators - Operator strings to replace.
+     * @returns {string} - Formula text with operators tokenized.
+     */
+    parseSimpleOperators(formulaText: string, markers: string[], operators: string[]): string;
+    /**
+     * Returns the index of the first character in `text` that appears in `operators`.
+     *
+     * @param {string} text - Text to search.
+     * @param {string | number | Object} operators - Characters to find.
+     * @returns {string | number} - Index of the first match, or `-1`.
+     */
+    indexOfAny(text: string, operators: string[]): number;
+    /**
+     * Finds the matching left arithmetic marker for a right-marker position.
+     *
+     * @param {string} text - Tokenized formula text.
+     * @returns {string | number} - Index of the left marker.
+     */
+    findLeftMarker(text: string): number;
+    /**
+     * Finds the matching right arithmetic marker for a left-marker position.
+     *
+     * @param {string} text - Tokenized formula text.
+     * @returns {string | number} - Index of the right marker.
+     */
+    findRightMarker(text: string): number;
+    /**
+     * Entry point that resets parser state and returns {@link parse} output.
+     *
+     * @param {string} formula - Formula text to parse.
+     * @param {string} fKey - Optional formula cell key.
+     * @returns {string} - Parsed token string.
+     */
+    parseFormula(formula: string, fKey?: string): string;
+    /**
+     * Wraps recognized library function calls with `q` markers and bracket tokens.
+     *
+     * @param {string} formula - Formula text.
+     * @returns {string} - Formula text with library calls marked for evaluation.
+     */
+    markLibraryFormulas(formula: string): string;
+    /**
+     * Swaps nested parentheses inside a library-formula substring for token safety.
+     *
+     * @hidden
+     * @param {string} fSubstr - Library formula substring.
+     * @returns {string} - Substring with inner parentheses rewritten.
+     */
+    swapInnerParens(fSubstr: string): string;
+    /**
+     * Ensures library-formula arguments are wrapped for nested parsing.
+     *
+     * @hidden
+     * @param {string} fSubstr - Library formula substring.
+     * @returns {string} - Substring with argument parentheses normalized.
+     */
+    addParensToArgs(fSubstr: string): string;
+    /**
+     * @hidden
+     * @param {string} text - specify the text
+     * @param {string[]} operators - specify the operators
+     * @returns {number} - returns last Index Of Any.
+     */
+    private lastIndexOfAny;
+    /**
+     * Substitutes named ranges in formula text with their defined addresses.
+     *
+     * @param {string} formula - Formula text that may contain named ranges.
+     * @returns {string} - Formula text with names expanded.
+     */
+    markNamedRanges(formula: string): string;
+    /**
+     * Resolves named ranges and standalone key values embedded in formula text.
+     *
+     * @param {string} text - Formula text.
+     * @returns {string} - Text with names/keys replaced by their values or addresses.
+     */
+    checkForNamedRangeAndKeyValue(text: string): string;
+    private getTableRange;
+    private findNextEndIndex;
+    private processIndexArg;
+    private isValidDotFormulaName;
+    private isOtherLangChar;
+    /**
+     * Clears parser scratch state and detaches from the owning Calculate engine.
+     * @internal
+     * @returns {void}
+     */
+    destroy(): void;
+}