TiddlyWiki5/core/modules/parsers/wikiparser/rules/fnprocdef.js

/*\
title: $:/core/modules/parsers/wikiparser/rules/fnprocdef.js
type: application/javascript
module-type: wikirule

Wiki pragma rule for function, procedure and widget definitions

```
\function name(param:"defaultvalue", param2:"defaultvalue")
definition text
\end

\procedure name(param:"defaultvalue", param2:"defaultvalue")
definition text
\end

\widget $mywidget(param:"defaultvalue", param2:"defaultvalue")
definition text
\end
```

\*/

"use strict";

exports.name = "fnprocdef";
exports.types = {pragma: true};

/*
Instantiate parse rule
*/
exports.init = function(parser) {
	this.parser = parser;
	// Regexp to match
	this.matchRegExp = /\\(function|procedure|widget)\s+([^(\s]+)\((\s*([^)]*))?\)(\s*\r?\n)?/mg;
};

/*
Parse the most recent match
*/
exports.parse = function() {
	// Move past the macro name and parameters
	this.parser.pos = this.matchRegExp.lastIndex;
	// Parse the parameters
	var params = [];
	if(this.match[3]) {
		params = $tw.utils.parseParameterDefinition(this.match[4]);
	}
	// Is the remainder of the line blank after the parameter close paren?
	var reEnd;
	if(this.match[5]) {
		// If so, it is a multiline definition and the end of the body is marked with \end
		reEnd = new RegExp("((:?^|\\r?\\n)[^\\S\\n\\r]*\\\\end[^\\S\\n\\r]*(?:" + $tw.utils.escapeRegExp(this.match[2]) + ")?\\s*?(?:$|\\r?\\n))","mg");
	} else {
		// Otherwise, the end of the definition is marked by the end of the line
		reEnd = /($|\r?\n)/mg;
		// Move past any whitespace
		this.parser.pos = $tw.utils.skipWhiteSpace(this.parser.source,this.parser.pos);
	}
	// Find the end of the definition
	reEnd.lastIndex = this.parser.pos;
	var text,
		endMatch = reEnd.exec(this.parser.source);
	if(endMatch) {
		text = this.parser.source.substring(this.parser.pos,endMatch.index);
		this.parser.pos = endMatch.index + endMatch[0].length;
	} else {
		// We didn't find the end of the definition, so we'll make it blank
		text = "";
	}
	// Save the macro definition
	var parseTreeNodes = [{
		type: "set",
		attributes: {},
		children: [],
		params: params
	}];
	$tw.utils.addAttributeToParseTreeNode(parseTreeNodes[0],"name",this.match[2]);
	$tw.utils.addAttributeToParseTreeNode(parseTreeNodes[0],"value",text);
	if(this.match[1] === "function") {
		parseTreeNodes[0].isFunctionDefinition = true;
	} else if(this.match[1] === "procedure") {
		parseTreeNodes[0].isProcedureDefinition = true;
	} else if(this.match[1] === "widget") {
		parseTreeNodes[0].isWidgetDefinition = true;
	}
	if(this.parser.configTrimWhiteSpace) {
		parseTreeNodes[0].configTrimWhiteSpace = true;
	}
	return parseTreeNodes;
};