'use strict'; var latex = require('../../utils/latex'); function factory (type, config, load, typed) { var Node = load(require('./Node')); var ArrayNode = load(require('./ArrayNode')); var keywords = require('../keywords'); var operators = require('../operators'); /** * @constructor AssignmentNode * @extends {Node} * * Define a symbol, like `a=3.2`, update a property like `a.b=3.2`, or * replace a subset of a matrix like `A[2,2]=42`. * * Syntax: * * new AssignmentNode(symbol, value) * new AssignmentNode(object, index, value) * * Usage: * * new AssignmentNode(new SymbolNode('a'), new ConstantNode(2)); // a=2 * new AssignmentNode(new SymbolNode('a'), new IndexNode('b'), new ConstantNode(2)) // a.b=2 * new AssignmentNode(new SymbolNode('a'), new IndexNode(1, 2), new ConstantNode(3)) // a[1,2]=3 * * @param {SymbolNode | AccessorNode} object Object on which to assign a value * @param {IndexNode} [index=null] Index, property name or matrix * index. Optional. If not provided * and `object` is a SymbolNode, * the property is assigned to the * global scope. * @param {Node} value The value to be assigned */ function AssignmentNode(object, index, value) { if (!(this instanceof AssignmentNode)) { throw new SyntaxError('Constructor must be called with the new operator'); } this.object = object; this.index = value ? index : null; this.value = value ? value : index; // validate input if (!object || !(object.isSymbolNode || object.isAccessorNode)) { throw new TypeError('SymbolNode or AccessorNode expected as "object"'); } if (object && object.isSymbolNode && object.name === 'end') { throw new Error('Cannot assign to symbol "end"'); } if (this.index && !this.index.isIndexNode) { throw new TypeError('IndexNode expected as "index"'); } if (!this.value || !this.value.isNode) { throw new TypeError('Node expected as "value"'); } } AssignmentNode.prototype = new Node(); AssignmentNode.prototype.type = 'AssignmentNode'; AssignmentNode.prototype.isAssignmentNode = true; /** * Compile the node to javascript code * @param {Object} defs Object which can be used to define functions * or constants globally available for the compiled * expression * @param {Object} args Object with local function arguments, the key is * the name of the argument, and the value is `true`. * The object may not be mutated, but must be * extended instead. * @private */ AssignmentNode.prototype._compile = function (defs, args) { var object = this.object._compile(defs, args); var index = this.index ? this.index._compile(defs, args) : null; var value = this.value._compile(defs, args); if (!this.index) { // apply a variable to the scope, for example `a=2` if (!this.object.isSymbolNode) { throw new TypeError('SymbolNode expected as object'); } return 'scope["' + this.object.name + '"] = ' + value; } else if (this.index.isProperty()) { // apply an object property for example `a.b=2` return object + index + ' = ' + value; } else { // update a matrix subset, for example `a[2]=3` var size = this.index.needsSize() ? ' var size = math.size(object).valueOf();' : ''; return '(function () {' + ' var object = ' + object + ';' + size + ' return math.subset(object, ' + index + ', ' + value + ');' + '})()'; } }; /** * Execute a callback for each of the child nodes of this node * @param {function(child: Node, path: string, parent: Node)} callback */ AssignmentNode.prototype.forEach = function (callback) { callback(this.object, 'object', this); if (this.index) { callback(this.index, 'index', this); } callback(this.value, 'value', this); }; /** * Create a new AssignmentNode having it's childs be the results of calling * the provided callback function for each of the childs of the original node. * @param {function(child: Node, path: string, parent: Node): Node} callback * @returns {AssignmentNode} Returns a transformed copy of the node */ AssignmentNode.prototype.map = function (callback) { var object = this._ifNode(callback(this.object, 'object', this)); var index = this.index ? this._ifNode(callback(this.index, 'index', this)) : null; var value = this._ifNode(callback(this.value, 'value', this)); return new AssignmentNode(object, index, value); }; /** * Create a clone of this node, a shallow copy * @return {AssignmentNode} */ AssignmentNode.prototype.clone = function() { return new AssignmentNode(this.object, this.index, this.value); }; /* * Is parenthesis needed? * @param {node} node * @param {string} [parenthesis='keep'] * @private */ function needParenthesis(node, parenthesis) { if (!parenthesis) { parenthesis = 'keep'; } var precedence = operators.getPrecedence(node, parenthesis); var exprPrecedence = operators.getPrecedence(node.value, parenthesis); return (parenthesis === 'all') || ((exprPrecedence !== null) && (exprPrecedence <= precedence)); } /** * Get string representation * @param {Object} options * @return {string} */ AssignmentNode.prototype._toString = function(options) { var object = this.object.toString(options); var index = this.index ? this.index.toString(options) : ''; var value = this.value.toString(options); if (needParenthesis(this, options && options.parenthesis)) { value = '(' + value + ')'; } return object + index + ' = ' + value; }; /** * Get LaTeX representation * @param {Object} options * @return {string} */ AssignmentNode.prototype._toTex = function(options) { var object = this.object.toTex(options); var index = this.index ? this.index.toTex(options) : ''; var value = this.value.toTex(options); if (needParenthesis(this, options && options.parenthesis)) { value = '\\left(' + value + '\\right)'; } return object + index + ':=' + value; }; return AssignmentNode; } exports.name = 'AssignmentNode'; exports.path = 'expression.node'; exports.factory = factory;