tiddlywiki 5.3.8 → 5.4.0

package/core/modules/filters/x-listops.js

@@ -7,224 +7,224 @@ Extended filter operators to manipulate the current list.
 
 \*/
 
-	"use strict";
+"use strict";
 
-	/*
+/*
 	Fetch titles from the current list
 	*/
-	var prepare_results = function (source) {
+var prepare_results = function (source) {
 	var results = [];
-		source(function (tiddler, title) {
-			results.push(title);
-		});
-		return results;
-	};
+	source(function (tiddler, title) {
+		results.push(title);
+	});
+	return results;
+};
 
-	/*
+/*
 	Moves a number of items from the tail of the current list before the item named in the operand
 	*/
-	exports.putbefore = function (source, operator) {
-		var results = prepare_results(source),
-			index = results.indexOf(operator.operand),
-			count = $tw.utils.getInt(operator.suffix,1);
-		return (index === -1) ?
-			results.slice(0, -1) :
-			results.slice(0, index).concat(results.slice(-count)).concat(results.slice(index, -count));
-	};
-
-	/*
+exports.putbefore = function (source, operator) {
+	var results = prepare_results(source),
+		index = results.indexOf(operator.operand),
+		count = $tw.utils.getInt(operator.suffix,1);
+	return (index === -1) ?
+		results.slice(0, -1) :
+		results.slice(0, index).concat(results.slice(-count)).concat(results.slice(index, -count));
+};
+
+/*
 	Moves a number of items from the tail of the current list after the item named in the operand
 	*/
-	exports.putafter = function (source, operator) {
-		var results = prepare_results(source),
-			index = results.indexOf(operator.operand),
-			count = $tw.utils.getInt(operator.suffix,1);
-		return (index === -1) ?
-			results.slice(0, -1) :
-			results.slice(0, index + 1).concat(results.slice(-count)).concat(results.slice(index + 1, -count));
-	};
-
-	/*
+exports.putafter = function (source, operator) {
+	var results = prepare_results(source),
+		index = results.indexOf(operator.operand),
+		count = $tw.utils.getInt(operator.suffix,1);
+	return (index === -1) ?
+		results.slice(0, -1) :
+		results.slice(0, index + 1).concat(results.slice(-count)).concat(results.slice(index + 1, -count));
+};
+
+/*
 	Replaces the item named in the operand with a number of items from the tail of the current list
 	*/
-	exports.replace = function (source, operator) {
-		var results = prepare_results(source),
-			index = results.indexOf(operator.operand),
-			count = $tw.utils.getInt(operator.suffix,1);
-		return (index === -1) ?
-			results.slice(0, -count) :
-			results.slice(0, index).concat(results.slice(-count)).concat(results.slice(index + 1, -count));
-	};
-
-	/*
+exports.replace = function (source, operator) {
+	var results = prepare_results(source),
+		index = results.indexOf(operator.operand),
+		count = $tw.utils.getInt(operator.suffix,1);
+	return (index === -1) ?
+		results.slice(0, -count) :
+		results.slice(0, index).concat(results.slice(-count)).concat(results.slice(index + 1, -count));
+};
+
+/*
 	Moves a number of items from the tail of the current list to the head of the list
 	*/
-	exports.putfirst = function (source, operator) {
-		var results = prepare_results(source),
-			count = $tw.utils.getInt(operator.suffix,1);
-		return results.slice(-count).concat(results.slice(0, -count));
-	};
+exports.putfirst = function (source, operator) {
+	var results = prepare_results(source),
+		count = $tw.utils.getInt(operator.suffix,1);
+	return results.slice(-count).concat(results.slice(0, -count));
+};
 
-	/*
+/*
 	Moves a number of items from the head of the current list to the tail of the list
 	*/
-	exports.putlast = function (source, operator) {
-		var results = prepare_results(source),
-			count = $tw.utils.getInt(operator.suffix,1);
-		return results.slice(count).concat(results.slice(0, count));
-	};
+exports.putlast = function (source, operator) {
+	var results = prepare_results(source),
+		count = $tw.utils.getInt(operator.suffix,1);
+	return results.slice(count).concat(results.slice(0, count));
+};
 
-	/*
+/*
 	Moves the item named in the operand a number of places forward or backward in the list
 	*/
-	exports.move = function (source, operator) {
-		var results = prepare_results(source),
-			index = results.indexOf(operator.operand),
-			count = $tw.utils.getInt(operator.suffix,1),
-			marker = results.splice(index, 1),
-			offset =  (index + count) > 0 ? index + count : 0;
-		return results.slice(0, offset).concat(marker).concat(results.slice(offset));
-	};
-
-	/*
+exports.move = function (source, operator) {
+	var results = prepare_results(source),
+		index = results.indexOf(operator.operand),
+		count = $tw.utils.getInt(operator.suffix,1),
+		marker = results.splice(index, 1),
+		offset =  (index + count) > 0 ? index + count : 0;
+	return results.slice(0, offset).concat(marker).concat(results.slice(offset));
+};
+
+/*
 	Returns the items from the current list that are after the item named in the operand
 	*/
-	exports.allafter = function (source, operator) {
-		var results = prepare_results(source),
-			index = results.indexOf(operator.operand);
-		return (index === -1) ? [] :
-			(operator.suffix) ? results.slice(index) :
+exports.allafter = function (source, operator) {
+	var results = prepare_results(source),
+		index = results.indexOf(operator.operand);
+	return (index === -1) ? [] :
+		(operator.suffix) ? results.slice(index) :
 			results.slice(index + 1);
-	};
+};
 
-	/*
+/*
 	Returns the items from the current list that are before the item named in the operand
 	*/
-	exports.allbefore = function (source, operator) {
-		var results = prepare_results(source),
-			index = results.indexOf(operator.operand);
-		return (index === -1) ? [] :
-			(operator.suffix) ? results.slice(0, index + 1) :
+exports.allbefore = function (source, operator) {
+	var results = prepare_results(source),
+		index = results.indexOf(operator.operand);
+	return (index === -1) ? [] :
+		(operator.suffix) ? results.slice(0, index + 1) :
 			results.slice(0, index);
-	};
+};
 
-	/*
+/*
 	Appends the items listed in the operand array to the tail of the current list
 	*/
-	exports.append = function (source, operator) {
-		var append = $tw.utils.parseStringArray(operator.operand, "true"),
-			results = prepare_results(source),
-			count = parseInt(operator.suffix) || append.length;
-		return (append.length === 0) ? results :
-			(operator.prefix) ? results.concat(append.slice(-count)) :
+exports.append = function (source, operator) {
+	var append = $tw.utils.parseStringArray(operator.operand, "true"),
+		results = prepare_results(source),
+		count = parseInt(operator.suffix) || append.length;
+	return (append.length === 0) ? results :
+		(operator.prefix) ? results.concat(append.slice(-count)) :
 			results.concat(append.slice(0, count));
-	};
+};
 
-	/*
+/*
 	Prepends the items listed in the operand array to the head of the current list
 	*/
-	exports.prepend = function (source, operator) {
-		var prepend = $tw.utils.parseStringArray(operator.operand, "true"),
-			results = prepare_results(source),
-			count = $tw.utils.getInt(operator.suffix,prepend.length);
-		return (prepend.length === 0) ? results :
-			(operator.prefix) ? prepend.slice(-count).concat(results) :
+exports.prepend = function (source, operator) {
+	var prepend = $tw.utils.parseStringArray(operator.operand, "true"),
+		results = prepare_results(source),
+		count = $tw.utils.getInt(operator.suffix,prepend.length);
+	return (prepend.length === 0) ? results :
+		(operator.prefix) ? prepend.slice(-count).concat(results) :
 			prepend.slice(0, count).concat(results);
-	};
+};
 
-	/*
+/*
 	Returns all items from the current list except the items listed in the operand array
 	*/
-	exports.remove = function (source, operator) {
-		var array = $tw.utils.parseStringArray(operator.operand, "true"),
-			results = prepare_results(source),
-			count = parseInt(operator.suffix) || array.length,
-			p,
-			len,
-			index;
-		len = array.length - 1;
-		for (p = 0; p < count; ++p) {
-			if (operator.prefix) {
-				index = results.indexOf(array[len - p]);
-			} else {
-				index = results.indexOf(array[p]);
-			}
-			if (index !== -1) {
-				results.splice(index, 1);
-			}
+exports.remove = function (source, operator) {
+	var array = $tw.utils.parseStringArray(operator.operand, "true"),
+		results = prepare_results(source),
+		count = parseInt(operator.suffix) || array.length,
+		p,
+		len,
+		index;
+	len = array.length - 1;
+	for(p = 0; p < count; ++p) {
+		if(operator.prefix) {
+			index = results.indexOf(array[len - p]);
+		} else {
+			index = results.indexOf(array[p]);
 		}
-		return results;
-	};
+		if(index !== -1) {
+			results.splice(index, 1);
+		}
+	}
+	return results;
+};
 
-	/*
+/*
 	Returns all items from the current list sorted in the order of the items in the operand array
 	*/
-	exports.sortby = function (source, operator) {
-		var results = prepare_results(source);
-		if (!results || results.length < 2) {
-			return results;
-		}
-		var lookup = $tw.utils.parseStringArray(operator.operand, "true");
-		results.sort(function (a, b) {
-			return lookup.indexOf(a) - lookup.indexOf(b);
-		});
+exports.sortby = function (source, operator) {
+	var results = prepare_results(source);
+	if(!results || results.length < 2) {
 		return results;
-	};
-
-	/*
+	}
+	var lookup = $tw.utils.parseStringArray(operator.operand, "true");
+	results.sort(function (a, b) {
+		return lookup.indexOf(a) - lookup.indexOf(b);
+	});
+	return results;
+};
+
+/*
 	Removes all duplicate items from the current list
 	*/
-	exports.unique = function (source, operator) {
-		var results = prepare_results(source);
-		var set = results.reduce(function (a, b) {
-			if (a.indexOf(b) < 0) {
-				a.push(b);
-			}
-			return a;
-		}, []);
-		return set;
-	};
-
-	var cycleValueInArray = function(results,operands,stepSize) {
-		var resultsIndex,
-			step = stepSize || 1,
-			i = 0,
-			opLength = operands.length,
-			nextOperandIndex;
-		for(i; i < opLength; i++) {
-			resultsIndex = results.indexOf(operands[i]);
-			if(resultsIndex !== -1) {
-				break;
-			}
+exports.unique = function (source, operator) {
+	var results = prepare_results(source);
+	var set = results.reduce(function (a, b) {
+		if(a.indexOf(b) < 0) {
+			a.push(b);
 		}
+		return a;
+	}, []);
+	return set;
+};
+
+var cycleValueInArray = function(results,operands,stepSize) {
+	var resultsIndex,
+		step = stepSize || 1,
+		i = 0,
+		opLength = operands.length,
+		nextOperandIndex;
+	for(i; i < opLength; i++) {
+		resultsIndex = results.indexOf(operands[i]);
 		if(resultsIndex !== -1) {
-			i = i + step;
-			nextOperandIndex = (i < opLength ? i : i % opLength);
-			if(operands.length > 1) {
-				results.splice(resultsIndex,1,operands[nextOperandIndex]);
-			} else {
-				results.splice(resultsIndex,1);
-			}
+			break;
+		}
+	}
+	if(resultsIndex !== -1) {
+		i = i + step;
+		nextOperandIndex = (i < opLength ? i : i % opLength);
+		if(operands.length > 1) {
+			results.splice(resultsIndex,1,operands[nextOperandIndex]);
 		} else {
-			results.push(operands[0]);
+			results.splice(resultsIndex,1);
 		}
-		return results;
+	} else {
+		results.push(operands[0]);
 	}
+	return results;
+};
 
-	/*
+/*
 	Toggles an item in the current list.
 	*/
-	exports.toggle = function(source,operator) {
-		return cycleValueInArray(prepare_results(source),operator.operands);
-	}
-
-	exports.cycle = function(source,operator) {
-		var results = prepare_results(source),
-			operands = (operator.operand.length ? $tw.utils.parseStringArray(operator.operand, "true") : [""]),
-			step = $tw.utils.getInt(operator.operands[1]||"",1);
-		if(step < 0) {
-			operands.reverse();
-			step = Math.abs(step);
-		}
-		return cycleValueInArray(results,operands,step);
+exports.toggle = function(source,operator) {
+	return cycleValueInArray(prepare_results(source),operator.operands);
+};
+
+exports.cycle = function(source,operator) {
+	var results = prepare_results(source),
+		operands = (operator.operand.length ? $tw.utils.parseStringArray(operator.operand, "true") : [""]),
+		step = $tw.utils.getInt(operator.operands[1]||"",1);
+	if(step < 0) {
+		operands.reverse();
+		step = Math.abs(step);
 	}
+	return cycleValueInArray(results,operands,step);
+};

package/core/modules/filters.js

@@ -35,7 +35,7 @@ function parseFilterOperation(operators,filterString,p) {
 			operator.prefix = filterString.charAt(p++);
 		}
 		// Get the operator name
-		nextBracketPos = filterString.substring(p).search(/[\[\{<\/]/);
+		nextBracketPos = filterString.substring(p).search(/[\[\{<\/\(]/);
 		if(nextBracketPos === -1) {
 			throw "Missing [ in filter expression";
 		}
@@ -43,7 +43,7 @@ function parseFilterOperation(operators,filterString,p) {
 		var bracket = filterString.charAt(nextBracketPos);
 		operator.operator = filterString.substring(p,nextBracketPos);
 		// Any suffix?
-		var colon = operator.operator.indexOf(':');
+		var colon = operator.operator.indexOf(":");
 		if(colon > -1) {
 			// The raw suffix for older filters
 			operator.suffix = operator.operator.substring(colon + 1);
@@ -67,7 +67,7 @@ function parseFilterOperation(operators,filterString,p) {
 		operator.operands = [];
 		var parseOperand = function(bracketType) {
 			var operand = {};
-			switch (bracketType) {
+			switch(bracketType) {
 				case "{": // Curly brackets
 					operand.indirect = true;
 					nextBracketPos = filterString.indexOf("}",p);
@@ -79,13 +79,17 @@ function parseFilterOperation(operators,filterString,p) {
 					operand.variable = true;
 					nextBracketPos = filterString.indexOf(">",p);
 					break;
+				case "(": // Round brackets
+					operand.multiValuedVariable = true;
+					nextBracketPos = filterString.indexOf(")",p);
+					break;
 				case "/": // regexp brackets
 					var rex = /^((?:[^\\\/]|\\.)*)\/(?:\(([mygi]+)\))?/g,
 						rexMatch = rex.exec(filterString.substring(p));
 					if(rexMatch) {
 						operator.regexp = new RegExp(rexMatch[1], rexMatch[2]);
-	// DEPRECATION WARNING
-	console.log("WARNING: Filter",operator.operator,"has a deprecated regexp operand",operator.regexp);
+						// DEPRECATION WARNING
+						console.log("WARNING: Filter",operator.operator,"has a deprecated regexp operand",operator.regexp);
 						nextBracketPos = p + rex.lastIndex - 1;
 					}
 					else {
@@ -104,7 +108,7 @@ function parseFilterOperation(operators,filterString,p) {
 			}
 			operator.operands.push(operand);
 			p = nextBracketPos + 1;
-		}
+		};
 
 		p = nextBracketPos + 1;
 		parseOperand(bracket);
@@ -112,7 +116,7 @@ function parseFilterOperation(operators,filterString,p) {
 		// Check for multiple operands
 		while(filterString.charAt(p) === ",") {
 			p++;
-			if(/^[\[\{<\/]/.test(filterString.substring(p))) {
+			if(/^[\[\{<\/\(]/.test(filterString.substring(p))) {
 				nextBracketPos = p;
 				p++;
 				parseOperand(filterString.charAt(nextBracketPos));
@@ -141,7 +145,15 @@ exports.parseFilter = function(filterString) {
 		p = 0, // Current position in the filter string
 		match;
 	var whitespaceRegExp = /(\s+)/mg,
-		operandRegExp = /((?:\+|\-|~|=|\:(\w+)(?:\:([\w\:, ]*))?)?)(?:(\[)|(?:"([^"]*)")|(?:'([^']*)')|([^\s\[\]]+))/mg;
+		// Groups:
+		// 1 - entire filter run prefix
+		// 2 - filter run prefix itself
+		// 3 - filter run prefix suffixes
+		// 4 - opening square bracket following filter run prefix
+		// 5 - double quoted string following filter run prefix
+		// 6 - single quoted string following filter run prefix
+		// 7 - anything except for whitespace and square brackets
+		operandRegExp = /((?:\+|\-|~|(?:=>?)|\:(\w+)(?:\:([\w\:, ]*))?)?)(?:(\[)|(?:"([^"]*)")|(?:'([^']*)')|([^\s\[\]]+))/mg;
 	while(p < filterString.length) {
 		// Skip any whitespace
 		whitespaceRegExp.lastIndex = p;
@@ -152,38 +164,45 @@ exports.parseFilter = function(filterString) {
 		// Match the start of the operation
 		if(p < filterString.length) {
 			operandRegExp.lastIndex = p;
-			match = operandRegExp.exec(filterString);
-			if(!match || match.index !== p) {
-				throw $tw.language.getString("Error/FilterSyntax");
-			}
 			var operation = {
 				prefix: "",
 				operators: []
 			};
-			if(match[1]) {
-				operation.prefix = match[1];
-				p = p + operation.prefix.length;
-				if(match[2]) {
-					operation.namedPrefix = match[2];
-				}
-				if(match[3]) {
-					operation.suffixes = [];
-					 $tw.utils.each(match[3].split(":"),function(subsuffix) {
-						operation.suffixes.push([]);
-						$tw.utils.each(subsuffix.split(","),function(entry) {
-							entry = $tw.utils.trim(entry);
-							if(entry) {
-								operation.suffixes[operation.suffixes.length -1].push(entry);
-							}
+			match = operandRegExp.exec(filterString);
+			if(match && match.index === p) {
+				// If there is a filter run prefix
+				if(match[1]) {
+					operation.prefix = match[1];
+					p = p + operation.prefix.length;
+					// Name for named prefixes
+					if(match[2]) {
+						operation.namedPrefix = match[2];
+					}
+					// Suffixes for filter run prefix
+					if(match[3]) {
+						operation.suffixes = [];
+						$tw.utils.each(match[3].split(":"),function(subsuffix) {
+							operation.suffixes.push([]);
+							$tw.utils.each(subsuffix.split(","),function(entry) {
+								entry = $tw.utils.trim(entry);
+								if(entry) {
+									operation.suffixes[operation.suffixes.length -1].push(entry);
+								}
+							});
 						});
-					 });
+					}
+				}
+				// Opening square bracket
+				if(match[4]) {
+					p = parseFilterOperation(operation.operators,filterString,p);
+				} else {
+					p = match.index + match[0].length;
 				}
-			}
-			if(match[4]) { // Opening square bracket
-				p = parseFilterOperation(operation.operators,filterString,p);
 			} else {
-				p = match.index + match[0].length;
+				// No filter run prefix
+				p = parseFilterOperation(operation.operators,filterString,p);
 			}
+			// Quoted strings and unquoted title
 			if(match[5] || match[6] || match[7]) { // Double quoted string, single quoted string or unquoted title
 				operation.operators.push(
 					{operator: "title", operands: [{text: match[5] || match[6] || match[7]}]}
@@ -209,7 +228,7 @@ exports.getFilterRunPrefixes = function() {
 		$tw.modules.applyMethods("filterrunprefix",this.filterRunPrefixes);
 	}
 	return this.filterRunPrefixes;
-}
+};
 
 exports.filterTiddlers = function(filterString,widget,source) {
 	var fn = this.compileFilter(filterString);
@@ -251,6 +270,8 @@ exports.compileFilter = function(filterString) {
 				results = [];
 			$tw.utils.each(operation.operators,function(operator) {
 				var operands = [],
+					multiValueOperands = [],
+					isMultiValueOperand = [],
 					operatorFunction;
 				if(!operator.operator) {
 					// Use the "title" operator if no operator is specified
@@ -266,28 +287,46 @@ exports.compileFilter = function(filterString) {
 					if(operand.indirect) {
 						var currTiddlerTitle = widget && widget.getVariable("currentTiddler");
 						operand.value = self.getTextReference(operand.text,"",currTiddlerTitle);
+						operand.multiValue = [operand.value];
 					} else if(operand.variable) {
 						var varTree = $tw.utils.parseFilterVariable(operand.text);
 						operand.value = widgetClass.evaluateVariable(widget,varTree.name,{params: varTree.params, source: source})[0] || "";
+						operand.multiValue = [operand.value];
+					} else if(operand.multiValuedVariable) {
+						var varTree = $tw.utils.parseFilterVariable(operand.text);
+						var resultList = widgetClass.evaluateVariable(widget,varTree.name,{params: varTree.params, source: source});
+						if((resultList.length > 0 && resultList[0] !== undefined) || resultList.length === 0) {
+							operand.multiValue = widgetClass.evaluateVariable(widget,varTree.name,{params: varTree.params, source: source}) || [];
+							operand.value = operand.multiValue[0] || "";
+						} else {
+							operand.value = "";
+							operand.multiValue = [];
+						}
+						operand.isMultiValueOperand = true;	
 					} else {
 						operand.value = operand.text;
+						operand.multiValue = [operand.value];
 					}
 					operands.push(operand.value);
+					multiValueOperands.push(operand.multiValue);
+					isMultiValueOperand.push(!!operand.isMultiValueOperand);
 				});
 
 				// Invoke the appropriate filteroperator module
 				results = operatorFunction(accumulator,{
-							operator: operator.operator,
-							operand: operands.length > 0 ? operands[0] : undefined,
-							operands: operands,
-							prefix: operator.prefix,
-							suffix: operator.suffix,
-							suffixes: operator.suffixes,
-							regexp: operator.regexp
-						},{
-							wiki: self,
-							widget: widget
-						});
+					operator: operator.operator,
+					operand: operands.length > 0 ? operands[0] : undefined,
+					operands: operands,
+					multiValueOperands: multiValueOperands,
+					isMultiValueOperand: isMultiValueOperand,
+					prefix: operator.prefix,
+					suffix: operator.suffix,
+					suffixes: operator.suffixes,
+					regexp: operator.regexp
+				},{
+					wiki: self,
+					widget: widget
+				});
 				if($tw.utils.isArray(results)) {
 					accumulator = self.makeTiddlerIterator(results);
 				} else {
@@ -319,6 +358,8 @@ exports.compileFilter = function(filterString) {
 					return filterRunPrefixes["and"](operationSubFunction, options);
 				case "~": // This operation is unioned into the result only if the main result so far is empty
 					return filterRunPrefixes["else"](operationSubFunction, options);
+				case "=>": // This operation is applied to the main results so far, and the results are assigned to a variable
+					return filterRunPrefixes["let"](operationSubFunction, options);
 				default: 
 					if(operation.namedPrefix && filterRunPrefixes[operation.namedPrefix]) {
 						return filterRunPrefixes[operation.namedPrefix](operationSubFunction, options);
@@ -345,7 +386,13 @@ exports.compileFilter = function(filterString) {
 		self.filterRecursionCount = (self.filterRecursionCount || 0) + 1;
 		if(self.filterRecursionCount < MAX_FILTER_DEPTH) {
 			$tw.utils.each(operationFunctions,function(operationFunction) {
-				operationFunction(results,source,widget);
+				var operationResult = operationFunction(results,source,widget);
+				if(operationResult) {
+					if(operationResult.variables) {
+						// If the filter run prefix has returned variables, create a new fake widget with those variables
+						widget = widget.makeFakeWidgetWithVariables(operationResult.variables);
+					}
+				}
 			});
 		} else {
 			results.push("/**-- Excessive filter recursion --**/");