123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470 |
- import _defineProperty from "@babel/runtime/helpers/defineProperty";
- import { isAccessorNode, isFunctionAssignmentNode, isIndexNode, isNode, isSymbolNode } from '../../utils/is.js';
- import { escape, format } from '../../utils/string.js';
- import { hasOwnProperty } from '../../utils/object.js';
- import { getSafeProperty, validateSafeMethod } from '../../utils/customs.js';
- import { createSubScope } from '../../utils/scope.js';
- import { factory } from '../../utils/factory.js';
- import { defaultTemplate, latexFunctions } from '../../utils/latex.js';
- var name = 'FunctionNode';
- var dependencies = ['math', 'Node', 'SymbolNode'];
- export var createFunctionNode = /* #__PURE__ */factory(name, dependencies, _ref => {
- var {
- math,
- Node,
- SymbolNode
- } = _ref;
- /* format to fixed length */
- var strin = entity => format(entity, {
- truncate: 78
- });
- /*
- * Expand a LaTeX template
- *
- * @param {string} template
- * @param {Node} node
- * @param {Object} options
- * @private
- **/
- function expandTemplate(template, node, options) {
- var latex = '';
- // Match everything of the form ${identifier} or ${identifier[2]} or $$
- // while submatching identifier and 2 (in the second case)
- var regex = /\$(?:\{([a-z_][a-z_0-9]*)(?:\[([0-9]+)\])?\}|\$)/gi;
- var inputPos = 0; // position in the input string
- var match;
- while ((match = regex.exec(template)) !== null) {
- // go through all matches
- // add everything in front of the match to the LaTeX string
- latex += template.substring(inputPos, match.index);
- inputPos = match.index;
- if (match[0] === '$$') {
- // escaped dollar sign
- latex += '$';
- inputPos++;
- } else {
- // template parameter
- inputPos += match[0].length;
- var property = node[match[1]];
- if (!property) {
- throw new ReferenceError('Template: Property ' + match[1] + ' does not exist.');
- }
- if (match[2] === undefined) {
- // no square brackets
- switch (typeof property) {
- case 'string':
- latex += property;
- break;
- case 'object':
- if (isNode(property)) {
- latex += property.toTex(options);
- } else if (Array.isArray(property)) {
- // make array of Nodes into comma separated list
- latex += property.map(function (arg, index) {
- if (isNode(arg)) {
- return arg.toTex(options);
- }
- throw new TypeError('Template: ' + match[1] + '[' + index + '] is not a Node.');
- }).join(',');
- } else {
- throw new TypeError('Template: ' + match[1] + ' has to be a Node, String or array of Nodes');
- }
- break;
- default:
- throw new TypeError('Template: ' + match[1] + ' has to be a Node, String or array of Nodes');
- }
- } else {
- // with square brackets
- if (isNode(property[match[2]] && property[match[2]])) {
- latex += property[match[2]].toTex(options);
- } else {
- throw new TypeError('Template: ' + match[1] + '[' + match[2] + '] is not a Node.');
- }
- }
- }
- }
- latex += template.slice(inputPos); // append rest of the template
- return latex;
- }
- class FunctionNode extends Node {
- /**
- * @constructor FunctionNode
- * @extends {./Node}
- * invoke a list with arguments on a node
- * @param {./Node | string} fn
- * Item resolving to a function on which to invoke
- * the arguments, typically a SymboNode or AccessorNode
- * @param {./Node[]} args
- */
- constructor(fn, args) {
- super();
- if (typeof fn === 'string') {
- fn = new SymbolNode(fn);
- }
- // validate input
- if (!isNode(fn)) throw new TypeError('Node expected as parameter "fn"');
- if (!Array.isArray(args) || !args.every(isNode)) {
- throw new TypeError('Array containing Nodes expected for parameter "args"');
- }
- this.fn = fn;
- this.args = args || [];
- }
- // readonly property name
- get name() {
- return this.fn.name || '';
- }
- get type() {
- return name;
- }
- get isFunctionNode() {
- return true;
- }
- /**
- * Compile a node into a JavaScript function.
- * This basically pre-calculates as much as possible and only leaves open
- * calculations which depend on a dynamic scope with variables.
- * @param {Object} math Math.js namespace with functions and constants.
- * @param {Object} argNames An object with argument names as key and `true`
- * as value. Used in the SymbolNode to optimize
- * for arguments from user assigned functions
- * (see FunctionAssignmentNode) or special symbols
- * like `end` (see IndexNode).
- * @return {function} Returns a function which can be called like:
- * evalNode(scope: Object, args: Object, context: *)
- */
- _compile(math, argNames) {
- // compile arguments
- var evalArgs = this.args.map(arg => arg._compile(math, argNames));
- if (isSymbolNode(this.fn)) {
- var _name = this.fn.name;
- if (!argNames[_name]) {
- // we can statically determine whether the function
- // has the rawArgs property
- var fn = _name in math ? getSafeProperty(math, _name) : undefined;
- var isRaw = typeof fn === 'function' && fn.rawArgs === true;
- var resolveFn = scope => {
- var value;
- if (scope.has(_name)) {
- value = scope.get(_name);
- } else if (_name in math) {
- value = getSafeProperty(math, _name);
- } else {
- return FunctionNode.onUndefinedFunction(_name);
- }
- if (typeof value === 'function') {
- return value;
- }
- throw new TypeError("'".concat(_name, "' is not a function; its value is:\n ").concat(strin(value)));
- };
- if (isRaw) {
- // pass unevaluated parameters (nodes) to the function
- // "raw" evaluation
- var rawArgs = this.args;
- return function evalFunctionNode(scope, args, context) {
- var fn = resolveFn(scope);
- return fn(rawArgs, math, createSubScope(scope, args), scope);
- };
- } else {
- // "regular" evaluation
- switch (evalArgs.length) {
- case 0:
- return function evalFunctionNode(scope, args, context) {
- var fn = resolveFn(scope);
- return fn();
- };
- case 1:
- return function evalFunctionNode(scope, args, context) {
- var fn = resolveFn(scope);
- var evalArg0 = evalArgs[0];
- return fn(evalArg0(scope, args, context));
- };
- case 2:
- return function evalFunctionNode(scope, args, context) {
- var fn = resolveFn(scope);
- var evalArg0 = evalArgs[0];
- var evalArg1 = evalArgs[1];
- return fn(evalArg0(scope, args, context), evalArg1(scope, args, context));
- };
- default:
- return function evalFunctionNode(scope, args, context) {
- var fn = resolveFn(scope);
- var values = evalArgs.map(evalArg => evalArg(scope, args, context));
- return fn(...values);
- };
- }
- }
- } else {
- // the function symbol is an argName
- var _rawArgs = this.args;
- return function evalFunctionNode(scope, args, context) {
- var fn = args[_name];
- if (typeof fn !== 'function') {
- throw new TypeError("Argument '".concat(_name, "' was not a function; received: ").concat(strin(fn)));
- }
- if (fn.rawArgs) {
- // "Raw" evaluation
- return fn(_rawArgs, math, createSubScope(scope, args), scope);
- } else {
- var values = evalArgs.map(evalArg => evalArg(scope, args, context));
- return fn.apply(fn, values);
- }
- };
- }
- } else if (isAccessorNode(this.fn) && isIndexNode(this.fn.index) && this.fn.index.isObjectProperty()) {
- // execute the function with the right context:
- // the object of the AccessorNode
- var evalObject = this.fn.object._compile(math, argNames);
- var prop = this.fn.index.getObjectProperty();
- var _rawArgs2 = this.args;
- return function evalFunctionNode(scope, args, context) {
- var object = evalObject(scope, args, context);
- validateSafeMethod(object, prop);
- var isRaw = object[prop] && object[prop].rawArgs;
- if (isRaw) {
- // "Raw" evaluation
- return object[prop](_rawArgs2, math, createSubScope(scope, args), scope);
- } else {
- // "regular" evaluation
- var values = evalArgs.map(evalArg => evalArg(scope, args, context));
- return object[prop].apply(object, values);
- }
- };
- } else {
- // node.fn.isAccessorNode && !node.fn.index.isObjectProperty()
- // we have to dynamically determine whether the function has the
- // rawArgs property
- var fnExpr = this.fn.toString();
- var evalFn = this.fn._compile(math, argNames);
- var _rawArgs3 = this.args;
- return function evalFunctionNode(scope, args, context) {
- var fn = evalFn(scope, args, context);
- if (typeof fn !== 'function') {
- throw new TypeError("Expression '".concat(fnExpr, "' did not evaluate to a function; value is:") + "\n ".concat(strin(fn)));
- }
- if (fn.rawArgs) {
- // "Raw" evaluation
- return fn(_rawArgs3, math, createSubScope(scope, args), scope);
- } else {
- // "regular" evaluation
- var values = evalArgs.map(evalArg => evalArg(scope, args, context));
- return fn.apply(fn, values);
- }
- };
- }
- }
- /**
- * Execute a callback for each of the child nodes of this node
- * @param {function(child: Node, path: string, parent: Node)} callback
- */
- forEach(callback) {
- callback(this.fn, 'fn', this);
- for (var i = 0; i < this.args.length; i++) {
- callback(this.args[i], 'args[' + i + ']', this);
- }
- }
- /**
- * Create a new FunctionNode whose children are the results of calling
- * the provided callback function for each child of the original node.
- * @param {function(child: Node, path: string, parent: Node): Node} callback
- * @returns {FunctionNode} Returns a transformed copy of the node
- */
- map(callback) {
- var fn = this._ifNode(callback(this.fn, 'fn', this));
- var args = [];
- for (var i = 0; i < this.args.length; i++) {
- args[i] = this._ifNode(callback(this.args[i], 'args[' + i + ']', this));
- }
- return new FunctionNode(fn, args);
- }
- /**
- * Create a clone of this node, a shallow copy
- * @return {FunctionNode}
- */
- clone() {
- return new FunctionNode(this.fn, this.args.slice(0));
- }
- /**
- * Throws an error 'Undefined function {name}'
- * @param {string} name
- */
- /**
- * Get string representation. (wrapper function)
- * This overrides parts of Node's toString function.
- * If callback is an object containing callbacks, it
- * calls the correct callback for the current node,
- * otherwise it falls back to calling Node's toString
- * function.
- *
- * @param {Object} options
- * @return {string} str
- * @override
- */
- toString(options) {
- var customString;
- var name = this.fn.toString(options);
- if (options && typeof options.handler === 'object' && hasOwnProperty(options.handler, name)) {
- // callback is a map of callback functions
- customString = options.handler[name](this, options);
- }
- if (typeof customString !== 'undefined') {
- return customString;
- }
- // fall back to Node's toString
- return super.toString(options);
- }
- /**
- * Get string representation
- * @param {Object} options
- * @return {string} str
- */
- _toString(options) {
- var args = this.args.map(function (arg) {
- return arg.toString(options);
- });
- var fn = isFunctionAssignmentNode(this.fn) ? '(' + this.fn.toString(options) + ')' : this.fn.toString(options);
- // format the arguments like "add(2, 4.2)"
- return fn + '(' + args.join(', ') + ')';
- }
- /**
- * Get a JSON representation of the node
- * @returns {Object}
- */
- toJSON() {
- return {
- mathjs: name,
- fn: this.fn,
- args: this.args
- };
- }
- /**
- * Instantiate an AssignmentNode from its JSON representation
- * @param {Object} json An object structured like
- * `{"mathjs": "FunctionNode", fn: ..., args: ...}`,
- * where mathjs is optional
- * @returns {FunctionNode}
- */
- /**
- * Get HTML representation
- * @param {Object} options
- * @return {string} str
- */
- toHTML(options) {
- var args = this.args.map(function (arg) {
- return arg.toHTML(options);
- });
- // format the arguments like "add(2, 4.2)"
- return '<span class="math-function">' + escape(this.fn) + '</span><span class="math-paranthesis math-round-parenthesis">(</span>' + args.join('<span class="math-separator">,</span>') + '<span class="math-paranthesis math-round-parenthesis">)</span>';
- }
- /**
- * Get LaTeX representation. (wrapper function)
- * This overrides parts of Node's toTex function.
- * If callback is an object containing callbacks, it
- * calls the correct callback for the current node,
- * otherwise it falls back to calling Node's toTex
- * function.
- *
- * @param {Object} options
- * @return {string}
- */
- toTex(options) {
- var customTex;
- if (options && typeof options.handler === 'object' && hasOwnProperty(options.handler, this.name)) {
- // callback is a map of callback functions
- customTex = options.handler[this.name](this, options);
- }
- if (typeof customTex !== 'undefined') {
- return customTex;
- }
- // fall back to Node's toTex
- return super.toTex(options);
- }
- /**
- * Get LaTeX representation
- * @param {Object} options
- * @return {string} str
- */
- _toTex(options) {
- var args = this.args.map(function (arg) {
- // get LaTeX of the arguments
- return arg.toTex(options);
- });
- var latexConverter;
- if (latexFunctions[this.name]) {
- latexConverter = latexFunctions[this.name];
- }
- // toTex property on the function itself
- if (math[this.name] && (typeof math[this.name].toTex === 'function' || typeof math[this.name].toTex === 'object' || typeof math[this.name].toTex === 'string')) {
- // .toTex is a callback function
- latexConverter = math[this.name].toTex;
- }
- var customToTex;
- switch (typeof latexConverter) {
- case 'function':
- // a callback function
- customToTex = latexConverter(this, options);
- break;
- case 'string':
- // a template string
- customToTex = expandTemplate(latexConverter, this, options);
- break;
- case 'object':
- // an object with different "converters" for different
- // numbers of arguments
- switch (typeof latexConverter[args.length]) {
- case 'function':
- customToTex = latexConverter[args.length](this, options);
- break;
- case 'string':
- customToTex = expandTemplate(latexConverter[args.length], this, options);
- break;
- }
- }
- if (typeof customToTex !== 'undefined') {
- return customToTex;
- }
- return expandTemplate(defaultTemplate, this, options);
- }
- /**
- * Get identifier.
- * @return {string}
- */
- getIdentifier() {
- return this.type + ':' + this.name;
- }
- }
- _defineProperty(FunctionNode, "name", name);
- _defineProperty(FunctionNode, "onUndefinedFunction", function (name) {
- throw new Error('Undefined function ' + name);
- });
- _defineProperty(FunctionNode, "fromJSON", function (json) {
- return new FunctionNode(json.fn, json.args);
- });
- return FunctionNode;
- }, {
- isClass: true,
- isNode: true
- });
|