Fix refreshing transcluded functions (#7755)

We store the previous result of the filter function and recalculate it
when the transclude widget needs to be refreshed, refreshing the widget
if the result is different.

bin/build-site.sh

@@ -104,15 +104,13 @@ node $TW5_BUILD_TIDDLYWIKI \
 	--build favicon static index \
 	|| exit 1
 
-# /empty.html					Empty
-# /empty.hta					For Internet Explorer
-# /empty-external-core.html		External core empty
-# /tiddlywikicore-<version>.js	Core plugin javascript
+# /empty.html			Empty
+# /empty.hta			For Internet Explorer
 node $TW5_BUILD_TIDDLYWIKI \
 	./editions/empty \
 	--verbose \
 	--output $TW5_BUILD_OUTPUT \
-	--build empty emptyexternalcore \
+	--build empty \
 	|| exit 1
 
 

core/modules/editor/engines/framed.js

@@ -60,7 +60,7 @@ function FramedEngine(options) {
 		this.domNode.value = this.value;
 	}
 	// Set the attributes
-	if(this.widget.editType && this.widget.editTag !== "textarea") {
+	if(this.widget.editType) {
 		this.domNode.setAttribute("type",this.widget.editType);
 	}
 	if(this.widget.editPlaceholder) {

core/modules/editor/engines/simple.js

@@ -34,7 +34,7 @@ function SimpleEngine(options) {
 		this.domNode.value = this.value;
 	}
 	// Set the attributes
-	if(this.widget.editType && this.widget.editTag !== "textarea") {
+	if(this.widget.editType) {
 		this.domNode.setAttribute("type",this.widget.editType);
 	}
 	if(this.widget.editPlaceholder) {

core/modules/widgets/transclude.js

@@ -109,6 +109,7 @@ TranscludeWidget.prototype.collectAttributes = function() {
 		this.recursionMarker = this.getAttribute("recursionMarker","yes");
 	} else {
 		this.transcludeVariable = this.getAttribute("$variable");
+		this.transcludeVariableIsFunction = false;
 		this.transcludeType = this.getAttribute("$type");
 		this.transcludeOutput = this.getAttribute("$output","text/html");
 		this.transcludeTitle = this.getAttribute("$tiddler",this.getVariable("currentTiddler"));
@@ -184,7 +185,9 @@ TranscludeWidget.prototype.getTransclusionTarget = function() {
 		if(this.transcludeVariable) {
 			// Transcluding a variable
 			var variableInfo = this.getVariableInfo(this.transcludeVariable,{params: this.getOrderedTransclusionParameters()});
+			this.transcludeVariableIsFunction = variableInfo.srcVariable && variableInfo.srcVariable.isFunctionDefinition;
 			text = variableInfo.text;
+			this.transcludeFunctionResult = text;
 			return {
 				text: variableInfo.text,
 				type: this.transcludeType
@@ -219,21 +222,24 @@ TranscludeWidget.prototype.parseTransclusionTarget = function(parseAsInline) {
 			// Transcluding a variable
 			var variableInfo = this.getVariableInfo(this.transcludeVariable,{params: this.getOrderedTransclusionParameters()}),
 				srcVariable = variableInfo && variableInfo.srcVariable;
+			if(srcVariable && srcVariable.isFunctionDefinition) {
+				this.transcludeVariableIsFunction = true;
+				this.transcludeFunctionResult = (variableInfo.resultList ? variableInfo.resultList[0] : variableInfo.text) || "";
+			}
 			if(variableInfo.text) {
 				if(srcVariable && srcVariable.isFunctionDefinition) {
-					var result = (variableInfo.resultList ? variableInfo.resultList[0] : variableInfo.text) || "";
 					parser = {
 						tree: [{
 							type: "text",
-							text: result
+							text: this.transcludeFunctionResult
 						}],
-						source: result,
+						source: this.transcludeFunctionResult,
 						type: "text/vnd.tiddlywiki"
 					};
 					if(parseAsInline) {
 						parser.tree[0] = {
 							type: "text",
-							text: result
+							text: this.transcludeFunctionResult
 						};
 					} else {
 						parser.tree[0] = {
@@ -241,7 +247,7 @@ TranscludeWidget.prototype.parseTransclusionTarget = function(parseAsInline) {
 							tag: "p",
 							children: [{
 								type: "text",
-								text: result
+								text: this.transcludeFunctionResult
 							}]
 						}
 					}
@@ -430,12 +436,19 @@ TranscludeWidget.prototype.parserNeedsRefresh = function() {
 	return (this.sourceText === undefined || parserInfo.sourceText !== this.sourceText || parserInfo.parserType !== this.parserType)
 };
 
+TranscludeWidget.prototype.functionNeedsRefresh = function() {
+	var oldResult = this.transcludeFunctionResult;
+	var variableInfo = this.getVariableInfo(this.transcludeVariable,{params: this.getOrderedTransclusionParameters()});
+	var newResult = (variableInfo.resultList ? variableInfo.resultList[0] : variableInfo.text) || "";
+	return oldResult !== newResult;
+}
+
 /*
 Selectively refreshes the widget if needed. Returns true if the widget or any of its children needed re-rendering
 */
 TranscludeWidget.prototype.refresh = function(changedTiddlers) {
 	var changedAttributes = this.computeAttributes();
-	if(($tw.utils.count(changedAttributes) > 0) || (!this.transcludeVariable && changedTiddlers[this.transcludeTitle] && this.parserNeedsRefresh())) {
+	if(($tw.utils.count(changedAttributes) > 0) || (this.transcludeVariableIsFunction && this.functionNeedsRefresh()) || (!this.transcludeVariable && changedTiddlers[this.transcludeTitle] && this.parserNeedsRefresh())) {
 		this.refreshSelf();
 		return true;
 	} else {

core/ui/EditTemplate/body/default.tid

@@ -1,9 +1,5 @@
 title: $:/core/ui/EditTemplate/body/default
 
-\function edit-preview-state()
-[{$:/config/ShowEditPreview/PerTiddler}!match[yes]then[$:/state/showeditpreview]] :else[<qualify "$:/state/showeditpreview">] +[get[text]] :else[[no]]
-\end
-
 \define config-visibility-title()
 $:/config/EditorToolbarButtons/Visibility/$(currentTiddler)$
 \end
@@ -14,16 +10,15 @@ $:/config/EditorToolbarButtons/Visibility/$(currentTiddler)$
 
 \whitespace trim
 <$let
+	edit-preview-state={{{ [{$:/config/ShowEditPreview/PerTiddler}!match[yes]then[$:/state/showeditpreview]] :else[<qualify "$:/state/showeditpreview">] }}}
 	importTitle=<<qualify $:/ImportImage>>
 	importState=<<qualify $:/state/ImportImage>> >
 <$dropzone importTitle=<<importTitle>> autoOpenOnImport="no" contentTypesFilter={{$:/config/Editor/ImportContentTypesFilter}} class="tc-dropzone-editor" enable={{{ [{$:/config/DragAndDrop/Enable}match[no]] :else[subfilter{$:/config/Editor/EnableImportFilter}then[yes]else[no]] }}} filesOnly="yes" actions=<<importFileActions>> >
-<div>
-<div class={{{ [function[edit-preview-state]match[yes]then[tc-tiddler-preview]] +[join[ ]] }}}>
+<$reveal stateTitle=<<edit-preview-state>> type="match" text="yes" tag="div">
+<div class="tc-tiddler-preview">
 
 <$transclude tiddler="$:/core/ui/EditTemplate/body/editor" mode="inline"/>
 
-<$list filter="[function[edit-preview-state]match[yes]]" variable="ignore">
-
 <div class="tc-tiddler-preview-preview" data-tiddler-title={{!!draft.title}} data-tags={{!!tags}}>
 
 <$transclude tiddler={{$:/state/editpreviewtype}} mode="inline">
@@ -34,12 +29,13 @@ $:/config/EditorToolbarButtons/Visibility/$(currentTiddler)$
 
 </div>
 
-</$list>
-
 </div>
+</$reveal>
 
-</div>
+<$reveal stateTitle=<<edit-preview-state>> type="nomatch" text="yes" tag="div">
 
+<$transclude tiddler="$:/core/ui/EditTemplate/body/editor" mode="inline"/>
+
+</$reveal>
 </$dropzone>
-
 </$let>

core/ui/EditorToolbar/preview.tid

@@ -9,17 +9,11 @@ button-classes: tc-text-editor-toolbar-item-start-group
 shortcuts: ((preview))
 
 \whitespace trim
-<$let
-	edit-preview-state={{{ [{$:/config/ShowEditPreview/PerTiddler}!match[yes]then[$:/state/showeditpreview]] :else[<qualify "$:/state/showeditpreview">] }}}
->
 <$reveal state=<<edit-preview-state>> type="match" text="yes" tag="span">
 {{$:/core/images/preview-open}}
 <$action-setfield $tiddler=<<edit-preview-state>> $value="no"/>
-<$action-sendmessage $message="tm-edit-text-operation" $param="focus-editor"/>
 </$reveal>
 <$reveal state=<<edit-preview-state>> type="nomatch" text="yes" tag="span">
 {{$:/core/images/preview-closed}}
 <$action-setfield $tiddler=<<edit-preview-state>> $value="yes"/>
-<$action-sendmessage $message="tm-edit-text-operation" $param="focus-editor"/>
 </$reveal>
-</$let>

editions/empty/tiddlywiki.info

@@ -12,9 +12,6 @@
 		"empty": [
 			"--render","$:/core/save/all","empty.html","text/plain",
 			"--render","$:/core/save/all","empty.hta","text/plain"],
-		"emptyexternalcore": [
-			"--render","$:/core/save/offline-external-js","empty-external-core.html","text/plain",
-			"--render","$:/core/templates/tiddlywiki5.js","[[tiddlywikicore-]addsuffix<version>addsuffix[.js]]","text/plain"],
 		"externalimages": [
 			"--savetiddlers","[is[image]]","images",
 			"--setfield","[is[image]]","_canonical_uri","$:/core/templates/canonical-uri-external-image","text/plain",
@@ -23,7 +20,7 @@
 		"static": [
 			"--render","$:/core/templates/static.template.html","static.html","text/plain",
 			"--render","$:/core/templates/alltiddlers.template.html","alltiddlers.html","text/plain",
-			"--render","[!is[system]]","[encodeuricomponent[]addprefix[static/]addsuffix[.html]]","text/plain",
+			"--render","[!is[system]]","[encodeuricomponent[]addprefix[static/]addsuffix[.html]]","text/plain",			
 			"--render","$:/core/templates/static.template.css","static/static.css","text/plain"]
 	}
-}
+}

editions/pluginlibrary/tiddlywiki.info

@@ -17,8 +17,8 @@
 		],
 		"library": [
 			"--makelibrary","$:/UpgradeLibrary",
-			"--savelibrarytiddlers","$:/UpgradeLibrary","[prefix[$:/]] -[[$:/plugins/tiddlywiki/upgrade]] -[[$:/plugins/tiddlywiki/translators]] -[[$:/plugins/tiddlywiki/pluginlibrary]] -[[$:/plugins/tiddlywiki/jasmine]]","recipes/library/tiddlers/","$:/UpgradeLibrary/List",
-			"--savetiddler","$:/UpgradeLibrary/List","recipes/library/tiddlers.json",
+   			"--savelibrarytiddlers","$:/UpgradeLibrary","[prefix[$:/]] -[[$:/plugins/tiddlywiki/upgrade]] -[[$:/plugins/tiddlywiki/translators]] -[[$:/plugins/tiddlywiki/pluginlibrary]] -[[$:/plugins/tiddlywiki/jasmine]]","recipes/library/tiddlers/","$:/UpgradeLibrary/List",
+   			"--savetiddler","$:/UpgradeLibrary/List","recipes/library/tiddlers.json",
 			"--rendertiddler","$:/plugins/tiddlywiki/pluginlibrary/library.template.html","index.html","text/plain"]
 	}
 }

editions/resumebuilder/tiddlywiki.info

@@ -20,4 +20,4 @@
 		"favicon": [
 			"--savetiddler","$:/favicon.ico","favicon.ico"]
 	}
-}
+}

editions/server-external-js/tiddlywiki.info

@@ -17,7 +17,7 @@
 		"static": [
 			"--render","$:/core/templates/static.template.html","static.html","text/plain",
 			"--render","$:/core/templates/alltiddlers.template.html","alltiddlers.html","text/plain",
-			"--render","[!is[system]]","[encodeuricomponent[]addprefix[static/]addsuffix[.html]]","text/plain",
+			"--render","[!is[system]]","[encodeuricomponent[]addprefix[static/]addsuffix[.html]]","text/plain",			
 			"--render","$:/core/templates/static.template.css","static/static.css","text/plain"],
 		"tiddlywikicore": [
 			"--render","$:/core/templates/tiddlywiki5.js","[[tiddlywikicore-]addsuffix<version>addsuffix[.js]]","text/plain"]

editions/test/tiddlers/tests/data/transclude/Variable-Refreshing.tid

@@ -0,0 +1,27 @@
+title: Transclude/Variable/Refreshing
+description: Transcluding and refreshing a function
+type: text/vnd.tiddlywiki-multiple
+tags: [[$:/tags/wiki-test-spec]]
+
+title: Output
+
+\function list-join(filter, sep:", ") [subfilter<filter>join<sep>]
+
+<$tiddler tiddler="TestData">
+
+<<list-join "[enlist{!!items}]">>
+
+</$tiddler>
+
++
+title: TestData
+
+
++
+title: Actions
+
+<$action-setfield $tiddler="TestData" items={{{ [range[10]join[ ]] }}}/>
++
+title: ExpectedResult
+
+<p>1, 2, 3, 4, 5, 6, 7, 8, 9, 10</p>

editions/test/tiddlers/tests/data/transclude/Variable-Static.tid

@@ -0,0 +1,15 @@
+title: Transclude/Variable/Static
+description: Transcluding a function
+type: text/vnd.tiddlywiki-multiple
+tags: [[$:/tags/wiki-test-spec]]
+
+title: Output
+items: 1 2 3 4 5 6 7 8 9 10
+
+\function list-join(filter, sep:", ") [subfilter<filter>join<sep>]
+
+<<list-join "[enlist{!!items}]">>
++
+title: ExpectedResult
+
+<p>1, 2, 3, 4, 5, 6, 7, 8, 9, 10</p>

editions/tw.org/tiddlywiki.info

@@ -21,7 +21,7 @@
 		"static": [
 			"--render","$:/core/templates/static.template.html","static.html","text/plain",
 			"--render","$:/core/templates/alltiddlers.template.html","alltiddlers.html","text/plain",
-			"--render","[!is[system]]","[encodeuricomponent[]addprefix[static/]addsuffix[.html]]","text/plain","$:/core/templates/static.tiddler.html",
+			"--render","[!is[system]]","[encodeuricomponent[]addprefix[static/]addsuffix[.html]]","text/plain","$:/core/templates/static.tiddler.html",				
 			"--render","$:/core/templates/static.template.css","static/static.css","text/plain"]
 	},
 	"config": {

editions/tw5.com/tiddlywiki.info

@@ -49,7 +49,7 @@
 		"static": [
 			"--render","$:/core/templates/static.template.html","static.html","text/plain",
 			"--render","$:/core/templates/alltiddlers.template.html","alltiddlers.html","text/plain",
-			"--render","[!is[system]]","[encodeuricomponent[]addprefix[static/]addsuffix[.html]]","text/plain","$:/core/templates/static.tiddler.html",
+			"--render","[!is[system]]","[encodeuricomponent[]addprefix[static/]addsuffix[.html]]","text/plain","$:/core/templates/static.tiddler.html",			
 			"--render","$:/core/templates/static.template.css","static/static.css","text/plain"],
 		"external-js": [
 			"--render","$:/core/save/offline-external-js","[[external-]addsuffix<version>addsuffix[.html]]","text/plain",

themes/tiddlywiki/vanilla/settings.multids

@@ -1,6 +1,6 @@
 title: $:/themes/tiddlywiki/vanilla/settings/
 
-fontfamily: -apple-system,BlinkMacSystemFont,Segoe UI,Helvetica,Arial,sans-serif,Apple Color Emoji,Segoe UI Emoji
+fontfamily: -apple-system,BlinkMacSystemFont,Segoe UI,Helvetica,Arial,sans-serif,Apple Color Emoji,Segoe UI Emoji;
 codefontfamily: "SFMono-Regular",Consolas,"Liberation Mono",Menlo,Courier,monospace
 backgroundimageattachment: fixed
 backgroundimagesize: auto