mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2025-04-06 10:46:57 +00:00
Merge ddeb4fd6e6d2078488421e2d1911cde58a21dae9 into 961e74f73d230d0028efb586db07699120eac888
This commit is contained in:
Jeremy Ruston
GitHub
commit
075c2f54b5
@ -4,6 +4,8 @@ DefaultResults/Caption: List
|
||||
Filter/Caption: Filter
|
||||
Filter/Hint: Search via a [[filter expression|https://tiddlywiki.com/static/Filters.html]]
|
||||
Filter/Matches: //<small><<resultCount>> matches</small>//
|
||||
Filter/FilterResults/Results/Caption: Results
|
||||
Filter/FilterResults/Inspect/Caption: Inspect
|
||||
Matches: //<small><<resultCount>> matches</small>//
|
||||
Matches/All: All matches:
|
||||
Matches/NoMatch: //No match//
|
||||
|
||||
@ -220,13 +220,22 @@ exports.filterTiddlers = function(filterString,widget,source) {
|
||||
Compile a filter into a function with the signature fn(source,widget) where:
|
||||
source: an iterator function for the source tiddlers, called source(iterator), where iterator is called as iterator(tiddler,title)
|
||||
widget: an optional widget node for retrieving the current tiddler etc.
|
||||
|
||||
Parameters:
|
||||
filterString: the filter string to compile
|
||||
options: includes:
|
||||
|
||||
wrappers: a hashmap of wrapper functions to apply to the compiled filter function
|
||||
*/
|
||||
exports.compileFilter = function(filterString) {
|
||||
exports.compileFilter = function(filterString,options) {
|
||||
options = options || {};
|
||||
var self = this;
|
||||
var wrappers = options.wrappers || {};
|
||||
if(!this.filterCache) {
|
||||
this.filterCache = Object.create(null);
|
||||
this.filterCacheCount = 0;
|
||||
}
|
||||
if(this.filterCache[filterString] !== undefined) {
|
||||
if(this.filterCache[filterString] !== undefined && !wrappers) {
|
||||
return this.filterCache[filterString];
|
||||
}
|
||||
var filterParseTree;
|
||||
@ -252,17 +261,18 @@ exports.compileFilter = function(filterString) {
|
||||
currTiddlerTitle = widget && widget.getVariable("currentTiddler");
|
||||
$tw.utils.each(operation.operators,function(operator) {
|
||||
var operands = [],
|
||||
operatorFunction;
|
||||
operatorName,operatorFunction;
|
||||
if(!operator.operator) {
|
||||
// Use the "title" operator if no operator is specified
|
||||
operatorFunction = filterOperators.title;
|
||||
operatorName = "title";
|
||||
} else if(!filterOperators[operator.operator]) {
|
||||
// Unknown operators treated as "[unknown]" - at run time we can distinguish between a custom operator and falling back to the default "field" operator
|
||||
operatorFunction = filterOperators["[unknown]"];
|
||||
operatorName = "[unknown]";
|
||||
} else {
|
||||
// Use the operator function
|
||||
operatorFunction = filterOperators[operator.operator];
|
||||
operatorName = operator.operator;
|
||||
}
|
||||
operatorFunction = filterOperators[operatorName];
|
||||
$tw.utils.each(operator.operands,function(operand) {
|
||||
if(operand.indirect) {
|
||||
operand.value = self.getTextReference(operand.text,"",currTiddlerTitle);
|
||||
@ -274,10 +284,14 @@ exports.compileFilter = function(filterString) {
|
||||
}
|
||||
operands.push(operand.value);
|
||||
});
|
||||
|
||||
// Wrap the filter operator module if required
|
||||
if(wrappers.operator) {
|
||||
operatorFunction = wrappers.operator.bind(self,operatorFunction);
|
||||
}
|
||||
// Invoke the appropriate filteroperator module
|
||||
results = operatorFunction(accumulator,{
|
||||
operator: operator.operator,
|
||||
operatorName: operatorName,
|
||||
operand: operands.length > 0 ? operands[0] : undefined,
|
||||
operands: operands,
|
||||
prefix: operator.prefix,
|
||||
@ -307,27 +321,44 @@ exports.compileFilter = function(filterString) {
|
||||
var filterRunPrefixes = self.getFilterRunPrefixes();
|
||||
// Wrap the operator functions in a wrapper function that depends on the prefix
|
||||
operationFunctions.push((function() {
|
||||
var options = {wiki: self, suffixes: operation.suffixes || []};
|
||||
var prefixName;
|
||||
switch(operation.prefix || "") {
|
||||
case "": // No prefix means that the operation is unioned into the result
|
||||
return filterRunPrefixes["or"](operationSubFunction, options);
|
||||
prefixName = "or";
|
||||
break;
|
||||
case "=": // The results of the operation are pushed into the result without deduplication
|
||||
return filterRunPrefixes["all"](operationSubFunction, options);
|
||||
prefixName = "all";
|
||||
break;
|
||||
case "-": // The results of this operation are removed from the main result
|
||||
return filterRunPrefixes["except"](operationSubFunction, options);
|
||||
prefixName = "except";
|
||||
break;
|
||||
case "+": // This operation is applied to the main results so far
|
||||
return filterRunPrefixes["and"](operationSubFunction, options);
|
||||
prefixName = "and";
|
||||
break;
|
||||
case "~": // This operation is unioned into the result only if the main result so far is empty
|
||||
return filterRunPrefixes["else"](operationSubFunction, options);
|
||||
default:
|
||||
if(operation.namedPrefix && filterRunPrefixes[operation.namedPrefix]) {
|
||||
return filterRunPrefixes[operation.namedPrefix](operationSubFunction, options);
|
||||
} else {
|
||||
return function(results,source,widget) {
|
||||
results.clear();
|
||||
results.push($tw.language.getString("Error/FilterRunPrefix"));
|
||||
};
|
||||
}
|
||||
prefixName = "else";
|
||||
break;
|
||||
default:
|
||||
prefixName = operation.namedPrefix;
|
||||
break;
|
||||
}
|
||||
if(prefixName && filterRunPrefixes[prefixName]) {
|
||||
var options = {
|
||||
wiki: self,
|
||||
suffixes: operation.suffixes || [],
|
||||
prefixName: prefixName
|
||||
},
|
||||
filterRunPrefixFunction = filterRunPrefixes[prefixName];
|
||||
// Wrap the filter operator module if required
|
||||
if(wrappers.prefix) {
|
||||
filterRunPrefixFunction = wrappers.prefix.bind(self,filterRunPrefixFunction);
|
||||
}
|
||||
return filterRunPrefixFunction(operationSubFunction,options);
|
||||
} else {
|
||||
return function(results,source,widget) {
|
||||
results.clear();
|
||||
results.push($tw.language.getString("Error/FilterRunPrefix"));
|
||||
};
|
||||
}
|
||||
})());
|
||||
});
|
||||
|
||||
63
core/modules/filters/inspect.js
Normal file
63
core/modules/filters/inspect.js
Normal file
@ -0,0 +1,63 @@
|
||||
/*\
|
||||
title: $:/core/modules/filters/inspect.js
|
||||
type: application/javascript
|
||||
module-type: filteroperator
|
||||
|
||||
Filter operator for inspecting the evaluation of a filter
|
||||
|
||||
\*/
|
||||
|
||||
"use strict";
|
||||
|
||||
/*
|
||||
Export our filter function
|
||||
*/
|
||||
exports.inspect = function(source,operator,options) {
|
||||
var self = this,
|
||||
inputFilter = operator.operands[0] || "",
|
||||
output = {input: [],runs: []},
|
||||
currentRun;
|
||||
// Save the input
|
||||
source(function(tiddler,title) {
|
||||
output.input.push(title);
|
||||
});
|
||||
// Compile the filter with wrapper functions to log the details
|
||||
var compiledFilter = options.wiki.compileFilter(inputFilter,{
|
||||
wrappers: {
|
||||
prefix: function(filterRunPrefixFunction,operationFunction,innerOptions) {
|
||||
return function(results,innerSource,innerWidget) {
|
||||
var details ={
|
||||
input: results.toArray(),
|
||||
prefixName: innerOptions.prefixName,
|
||||
operators: []
|
||||
};
|
||||
currentRun = details.operators;
|
||||
var innerResults = filterRunPrefixFunction.call(null,operationFunction,innerOptions);
|
||||
innerResults(results,innerSource,innerWidget);
|
||||
output.runs.push(details);
|
||||
};
|
||||
},
|
||||
operator: function(operatorFunction,innerSource,innerOperator,innerOptions) {
|
||||
var details = {
|
||||
operatorName: innerOperator.operatorName,
|
||||
operands: innerOperator.operands,
|
||||
prefix: innerOperator.prefix,
|
||||
suffix: innerOperator.suffix,
|
||||
suffixes: innerOperator.suffixes,
|
||||
regexp: innerOperator.regexp,
|
||||
input: []
|
||||
};
|
||||
innerSource(function(tiddler,title) {
|
||||
details.input.push(title);
|
||||
});
|
||||
currentRun.push(details);
|
||||
var innerResults = operatorFunction.apply(null,Array.prototype.slice.call(arguments,1));
|
||||
return innerResults;
|
||||
}
|
||||
}
|
||||
});
|
||||
output.output = compiledFilter.call(options.wiki,source,options.widget);
|
||||
var results = [];
|
||||
results.push(JSON.stringify(output,null,4));
|
||||
return results;
|
||||
};
|
||||
@ -34,39 +34,11 @@ caption: {{$:/language/Search/Filter/Caption}}
|
||||
</$list>
|
||||
\end
|
||||
|
||||
\procedure input-accept-actions()
|
||||
\whitespace trim
|
||||
<$list filter="[{$:/config/Search/NavigateOnEnter/enable}match[yes]]">
|
||||
<$list-empty>
|
||||
<$list filter="[<tiddler>get[text]!is[missing]] :else[<tiddler>get[text]is[shadow]]">
|
||||
<$action-navigate $to={{{ [<tiddler>get[text]] }}}/>
|
||||
</$list>
|
||||
<$/list-empty>
|
||||
<$action-navigate $to={{{ [<tiddler>get[text]] }}}/>
|
||||
</$list>
|
||||
\end
|
||||
|
||||
\procedure input-accept-variant-actions()
|
||||
\whitespace trim
|
||||
<$list filter="[{$:/config/Search/NavigateOnEnter/enable}match[yes]]">
|
||||
<$list-empty>
|
||||
<$list filter="[<tiddler>get[text]!is[missing]] :else[<tiddler>get[text]is[shadow]]">
|
||||
<$list filter="[<__tiddler__>get[text]minlength[1]]">
|
||||
<$action-sendmessage $message="tm-edit-tiddler" $param={{{ [<tiddler>get[text]] }}}/>
|
||||
</$list>
|
||||
</$list>
|
||||
</$list-empty>
|
||||
<$list filter="[<tiddler>get[text]minlength[1]]">
|
||||
<$action-sendmessage $message="tm-edit-tiddler" $param={{{ [<tiddler>get[text]] }}}/>
|
||||
</$list>
|
||||
</$list>
|
||||
\end
|
||||
|
||||
\whitespace trim
|
||||
|
||||
<<lingo Filter/Hint>>
|
||||
|
||||
<div class="tc-search tc-advanced-search">
|
||||
<div class="tc-search tc-advanced-search tc-edit-max-width">
|
||||
<$keyboard key="((input-tab-right))" actions=<<set-next-input-tab>> class="tc-small-gap-right">
|
||||
<$keyboard key="((input-tab-left))" actions=<<set-previous-input-tab>>>
|
||||
<$transclude $variable="keyboard-driven-input"
|
||||
@ -75,13 +47,15 @@ caption: {{$:/language/Search/Filter/Caption}}
|
||||
refreshTitle="$:/temp/advancedsearch/refresh"
|
||||
selectionStateTitle="$:/temp/advancedsearch/selected-item"
|
||||
type="search"
|
||||
tag="input"
|
||||
tag="textarea"
|
||||
focus={{$:/config/Search/AutoFocus}}
|
||||
configTiddlerFilter="[[$:/temp/advancedsearch]]"
|
||||
firstSearchFilterField="text"
|
||||
inputAcceptActions=<<input-accept-actions>>
|
||||
inputAcceptVariantActions=<<input-accept-variant-actions>>
|
||||
inputAcceptActions=""
|
||||
inputAcceptVariantActions=""
|
||||
inputCancelActions=<<cancel-search-actions>>
|
||||
minHeight="2em"
|
||||
autoHeight="yes"
|
||||
/>
|
||||
</$keyboard>
|
||||
</$keyboard>
|
||||
@ -91,12 +65,10 @@ caption: {{$:/language/Search/Filter/Caption}}
|
||||
</div>
|
||||
|
||||
<$reveal state="$:/temp/advancedsearch" type="nomatch" text="" tag="div" class="tc-search-results">
|
||||
<$set name="resultCount" value="<$count filter={{$:/temp/advancedsearch}}/>">
|
||||
<p><<lingo Filter/Matches>></p>
|
||||
<$list filter={{$:/temp/advancedsearch}}>
|
||||
<span class={{{[<currentTiddler>addsuffix[-primaryList]] -[[$:/temp/advancedsearch/selected-item]get[text]] :and[then[]else[tc-list-item-selected]] }}}>
|
||||
<$transclude tiddler="$:/core/ui/ListItemTemplate"/>
|
||||
</span>
|
||||
</$list>
|
||||
</$set>
|
||||
<$macrocall
|
||||
$name="tabs"
|
||||
tabsList="[all[shadows+tiddlers]tag[$:/tags/AdvancedSearch/FilterResults]!has[draft.of]]"
|
||||
default="$:/core/ui/AdvancedSearch/Filter/FilterResults/Results"
|
||||
explicitState="$:/state/tab-1749438307"
|
||||
/>
|
||||
</$reveal>
|
||||
|
||||
11
core/ui/AdvancedSearch/FilterResults/Inspect.tid
Normal file
11
core/ui/AdvancedSearch/FilterResults/Inspect.tid
Normal file
@ -0,0 +1,11 @@
|
||||
title: $:/core/ui/AdvancedSearch/Filter/FilterResults/Inspect
|
||||
tags: $:/tags/AdvancedSearch/FilterResults
|
||||
caption: {{$:/language/Search/Filter/FilterResults/Inspect/Caption}}
|
||||
|
||||
\procedure lingo-base() $:/language/Search/
|
||||
|
||||
|
||||
<$let json={{{ [inspect{$:/temp/advancedsearch}] }}}>
|
||||
<$transclude $variable="copy-to-clipboard-above-right" src=<<json>>/>
|
||||
<$codeblock code=<<json>> language="application/json" }}}/>
|
||||
</$let>
|
||||
13
core/ui/AdvancedSearch/FilterResults/Results.tid
Normal file
13
core/ui/AdvancedSearch/FilterResults/Results.tid
Normal file
@ -0,0 +1,13 @@
|
||||
title: $:/core/ui/AdvancedSearch/Filter/FilterResults/Results
|
||||
tags: $:/tags/AdvancedSearch/FilterResults
|
||||
caption: {{$:/language/Search/Filter/FilterResults/Results/Caption}}
|
||||
|
||||
\procedure lingo-base() $:/language/Search/
|
||||
<$set name="resultCount" value="<$count filter={{$:/temp/advancedsearch}}/>">
|
||||
<p><<lingo Filter/Matches>></p>
|
||||
<$list filter={{$:/temp/advancedsearch}}>
|
||||
<span class={{{[<currentTiddler>addsuffix[-primaryList]] -[[$:/temp/advancedsearch/selected-item]get[text]] :and[then[]else[tc-list-item-selected]] }}}>
|
||||
<$transclude tiddler="$:/core/ui/ListItemTemplate"/>
|
||||
</span>
|
||||
</$list>
|
||||
</$set>
|
||||
2
core/wiki/config/AdvancedSearchDefaultTab.tid
Normal file
2
core/wiki/config/AdvancedSearchDefaultTab.tid
Normal file
@ -0,0 +1,2 @@
|
||||
title: $:/state/tab--1498284803
|
||||
text: $:/core/ui/AdvancedSearch/Filter
|
||||
2
core/wiki/config/AdvancedSearchFilterDefaultTab.tid
Normal file
2
core/wiki/config/AdvancedSearchFilterDefaultTab.tid
Normal file
@ -0,0 +1,2 @@
|
||||
title: $:/state/tab-1749438307
|
||||
text: $:/core/ui/AdvancedSearch/Filter/FilterResults/Results
|
||||
2
core/wiki/tags/AdvancedSearchFilterResults.tid
Normal file
2
core/wiki/tags/AdvancedSearchFilterResults.tid
Normal file
@ -0,0 +1,2 @@
|
||||
title: $:/tags/AdvancedSearch/FilterResults
|
||||
list: $:/core/ui/AdvancedSearch/Filter/FilterResults/Results $:/core/ui/AdvancedSearch/Filter/FilterResults/Inspect
|
||||
93
editions/test/tiddlers/tests/data/filter-wrappers/Simple.tid
Normal file
93
editions/test/tiddlers/tests/data/filter-wrappers/Simple.tid
Normal file
@ -0,0 +1,93 @@
|
||||
title: FiltersWrappers/Simple
|
||||
description: Test filter inspection
|
||||
type: text/vnd.tiddlywiki-multiple
|
||||
tags: [[$:/tags/wiki-test-spec]]
|
||||
|
||||
title: Output
|
||||
|
||||
\whitespace trim
|
||||
|
||||
\procedure test-filter()
|
||||
1 2 3
|
||||
\end
|
||||
|
||||
\function test-filter-wrapper()
|
||||
[inspect<test-filter>]
|
||||
\end
|
||||
|
||||
<$text text=<<test-filter>>/>
|
||||
-
|
||||
<$text text=<<test-filter-wrapper>>/>
|
||||
+
|
||||
title: ExpectedResult
|
||||
|
||||
<p>1 2 3-{
|
||||
"input": [
|
||||
"$:/core",
|
||||
"ExpectedResult",
|
||||
"Output"
|
||||
],
|
||||
"runs": [
|
||||
{
|
||||
"input": [],
|
||||
"prefixName": "or",
|
||||
"operators": [
|
||||
{
|
||||
"operatorName": "title",
|
||||
"operands": [
|
||||
"1"
|
||||
],
|
||||
"input": [
|
||||
"$:/core",
|
||||
"ExpectedResult",
|
||||
"Output"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"input": [
|
||||
"1"
|
||||
],
|
||||
"prefixName": "or",
|
||||
"operators": [
|
||||
{
|
||||
"operatorName": "title",
|
||||
"operands": [
|
||||
"2"
|
||||
],
|
||||
"input": [
|
||||
"$:/core",
|
||||
"ExpectedResult",
|
||||
"Output"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"input": [
|
||||
"1",
|
||||
"2"
|
||||
],
|
||||
"prefixName": "or",
|
||||
"operators": [
|
||||
{
|
||||
"operatorName": "title",
|
||||
"operands": [
|
||||
"3"
|
||||
],
|
||||
"input": [
|
||||
"$:/core",
|
||||
"ExpectedResult",
|
||||
"Output"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"output": [
|
||||
"1",
|
||||
"2",
|
||||
"3"
|
||||
]
|
||||
}</p>
|
||||
26
editions/tw5.com/tiddlers/filters/inspect Operator.tid
Normal file
26
editions/tw5.com/tiddlers/filters/inspect Operator.tid
Normal file
@ -0,0 +1,26 @@
|
||||
caption: inspect
|
||||
created: 20250401094200994
|
||||
modified: 20250401094200994
|
||||
op-input: a [[selection of titles|Title Selection]]
|
||||
op-output: a JSON object containing the input, output and intermediate results of evaluating the specified filter
|
||||
op-parameter: the filter to be inspected
|
||||
op-parameter-name: F
|
||||
op-purpose: inspect the evaluation of a filter to aid debugging
|
||||
tags: [[Filter Operators]]
|
||||
title: inspect Operator
|
||||
type: text/vnd.tiddlywiki
|
||||
|
||||
<<.from-version "5.3.7">> The <<.op inspect>> operator evaluates a filter with the specified input titles and returns a JSON object containing the input, output and intermediate results of evaluating the specified filter.
|
||||
|
||||
The JSON object contains the following properties:
|
||||
|
||||
* `input`: the input titles passed to the filter
|
||||
* `output`: the output titles resulting from evaluating the filter
|
||||
* `runs`: an array of objects, each of which represents a single run of the filter. Each object contains the following properties:
|
||||
** `prefixName`: the name of the prefix operator that was used in this run
|
||||
** `input`: the input titles passed to the prefix operator
|
||||
** `operators`: an array of objects, each of which represents a single operator that was used in this run. Each object contains the following properties:
|
||||
*** `operatorName`: the name of the operator
|
||||
*** `operands`: an array of string operands passed to the operator
|
||||
*** `input`: the input titles passed to the operator
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user