forked from Unity-Technologies/UnityCsReference
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathQueryEngine.cs
More file actions
3306 lines (2870 loc) · 170 KB
/
Copy pathQueryEngine.cs
File metadata and controls
3306 lines (2870 loc) · 170 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Unity C# reference source
// Copyright (c) Unity Technologies. For terms of use, see
// https://unity3d.com/legal/licenses/Unity_Reference_Only_License
using System;
using System.Collections.Generic;
using System.Globalization;
using System.Linq;
using System.Reflection;
using System.Text.RegularExpressions;
using UnityEngine;
using NodesToStringPosition = System.Collections.Generic.Dictionary<UnityEditor.Search.IQueryNode, UnityEditor.Search.QueryToken>;
namespace UnityEditor.Search
{
interface IParseResult
{
bool success { get; }
}
interface ITypeParser
{
Type type { get; }
IParseResult Parse(string value);
}
readonly struct TypeParser<T> : ITypeParser
{
readonly Func<string, ParseResult<T>> m_Parser;
public Type type => typeof(T);
public TypeParser(Func<string, ParseResult<T>> parser)
{
m_Parser = parser;
}
public IParseResult Parse(string value)
{
return m_Parser(value);
}
}
/// <summary>
/// A ParseResult holds the result of a parsing operation.
/// </summary>
/// <typeparam name="T">Type of the result of the parsing operation.</typeparam>
public readonly struct ParseResult<T> : IParseResult
{
/// <summary>
/// Flag indicating if the parsing succeeded or not.
/// </summary>
public bool success { get; }
/// <summary>
/// Actual result of the parsing.
/// </summary>
public readonly T parsedValue;
/// <summary>
/// Create a ParseResult.
/// </summary>
/// <param name="success">Flag indicating if the parsing succeeded or not.</param>
/// <param name="value">Actual result of the parsing.</param>
public ParseResult(bool success, T value)
{
this.success = success;
this.parsedValue = value;
}
/// <summary>
/// Default value when no ParsetResult are available.
/// </summary>
public static readonly ParseResult<T> none = new ParseResult<T>(false, default(T));
}
interface IQueryEngineImplementation
{
void AddFilterOperationGenerator<T>();
void AddDefaultEnumTypeParser<T>();
}
/// <summary>
/// Struct containing the available query validation options.
/// </summary>
public struct QueryValidationOptions
{
/// <summary>
/// Boolean indicating if filters should be validated.
/// </summary>
public bool validateFilters;
/// <summary>
/// Boolean indicating if unknown filters should be skipped.
/// If validateFilters is true and skipUnknownFilters is false, unknown filters will generate errors
/// if no default handler is provided.
/// </summary>
public bool skipUnknownFilters;
/// <summary>
/// Boolean indicating if incomplete filters should be skipped.
/// If skipIncompleteFilters is false, incomplete filters will generate errors when parsed.
/// </summary>
public bool skipIncompleteFilters;
internal bool skipNestedQueries;
internal bool validateSyntaxOnly;
}
class QueryEngineParserData
{
public List<IQueryNode> expressionNodes;
public NodesToStringPosition nodesToStringPosition;
public ICollection<string> tokens;
public ICollection<QueryToggle> toggles;
public QueryEngineParserData(NodesToStringPosition nodesToStringPosition, ICollection<string> tokens, ICollection<QueryToggle> toggles)
{
expressionNodes = new List<IQueryNode>();
this.nodesToStringPosition = nodesToStringPosition;
this.tokens = tokens;
this.toggles = toggles;
}
}
struct BuildGraphResult
{
public QueryGraph evaluationGraph;
public QueryGraph queryGraph;
public BuildGraphResult(QueryGraph evaluationGraph, QueryGraph queryGraph)
{
this.evaluationGraph = evaluationGraph;
this.queryGraph = queryGraph;
}
}
static class DictionaryExtensions
{
public static bool TryGetValueByStringView(this Dictionary<string, QueryFilterOperator> source, in StringView key, out QueryFilterOperator op)
{
var keys = source.Keys;
foreach (var k in keys)
{
if (key.Equals(k))
{
op = source[k];
return true;
}
}
op = QueryFilterOperator.invalid;
return false;
}
public static bool TryGetValueByStringView(this IReadOnlyDictionary<string, QueryFilterOperator> source, in StringView key, out QueryFilterOperator op)
{
var keys = source.Keys;
foreach (var k in keys)
{
if (key.Equals(k))
{
op = source[k];
return true;
}
}
op = QueryFilterOperator.invalid;
return false;
}
}
sealed class QueryEngineImpl<TData> : QueryTokenizer<QueryEngineParserData>, IQueryEngineImplementation
{
Dictionary<string, IFilter> m_Filters = new Dictionary<string, IFilter>();
DefaultQueryFilterHandlerBase<TData> m_DefaultFilterHandler;
DefaultQueryFilterHandlerBase<TData> m_DefaultParamFilterHandler;
Dictionary<string, QueryFilterOperator> m_FilterOperators = new Dictionary<string, QueryFilterOperator>();
List<ITypeParser> m_TypeParsers = new List<ITypeParser>();
Dictionary<Type, ITypeParser> m_DefaultTypeParsers = new Dictionary<Type, ITypeParser>();
Dictionary<Type, IFilterOperationGenerator> m_FilterOperationGenerators = new Dictionary<Type, IFilterOperationGenerator>();
Regex m_PartialFilterRx = new Regex(QueryRegexValues.k_PartialFilterNamePattern +
QueryRegexValues.k_PartialFilterFunctionPattern +
QueryRegexValues.k_PartialFilterOperatorsPattern +
QueryRegexValues.k_PartialFilterValuePattern, RegexOptions.Compiled);
Regex m_BooleanFilterRx = new Regex(QueryRegexValues.k_FilterNamePattern +
QueryRegexValues.k_FilterFunctionPattern, RegexOptions.Compiled);
static readonly Dictionary<string, Func<IQueryNode>> k_CombiningTokenGenerators = new Dictionary<string, Func<IQueryNode>>
{
{"and", () => new AndNode()},
{"or", () => new OrNode()},
{"not", () => new NotNode()},
{"-", () => new NotNode()}
};
enum ExtendedTokenHandlerPriority
{
Boolean = TokenHandlerPriority.Filter + 5,
Partial = Boolean + 10,
PartialWithQuotes = Partial - 5
}
readonly struct FilterCreationParams
{
public readonly string token;
public readonly Regex regexToken;
public readonly bool useRegexToken;
public readonly string[] supportedOperators;
public readonly bool overridesGlobalComparisonOptions;
public readonly StringComparison comparisonOptions;
public readonly bool useParameterTransformer;
public readonly string parameterTransformerFunction;
public readonly Type parameterTransformerAttributeType;
public FilterCreationParams(
string token, Regex regexToken, bool useRegexToken, string[] supportedOperators, bool overridesGlobalComparison,
StringComparison comparisonOptions, bool useParameterTransformer,
string parameterTransformerFunction, Type parameterTransformerAttributeType)
{
this.token = token;
this.regexToken = regexToken;
this.useRegexToken = useRegexToken;
this.supportedOperators = supportedOperators;
this.overridesGlobalComparisonOptions = overridesGlobalComparison;
this.comparisonOptions = comparisonOptions;
this.useParameterTransformer = useParameterTransformer;
this.parameterTransformerFunction = parameterTransformerFunction;
this.parameterTransformerAttributeType = parameterTransformerAttributeType;
}
}
readonly struct CreateFilterTokenArgs
{
public readonly StringView token;
public readonly Match match;
public readonly int index;
public readonly ICollection<QueryError> errors;
public readonly StringView filterType;
public readonly StringView filterParam;
public readonly StringView filterOperator;
public readonly StringView filterValue;
public readonly StringView nestedQueryAggregator;
public readonly int filterTypeIndex;
public readonly int filterOperatorIndex;
public readonly int filterValueIndex;
public CreateFilterTokenArgs(in StringView token, Match match, int index, ICollection<QueryError> errors, in StringView filterType, in StringView filterParam, in StringView filterOperator, in StringView filterValue, in StringView nestedQueryAggregator, int filterTypeIndex,
int filterOperatorIndex, int filterValueIndex)
{
this.token = token;
this.match = match;
this.index = index;
this.errors = errors;
this.filterType = filterType;
this.filterParam = filterParam;
this.filterOperator = filterOperator;
this.filterValue = filterValue;
this.nestedQueryAggregator = nestedQueryAggregator;
this.filterTypeIndex = filterTypeIndex;
this.filterOperatorIndex = filterOperatorIndex;
this.filterValueIndex = filterValueIndex;
}
}
public Func<TData, IEnumerable<string>> searchDataCallback { get; private set; }
public Func<string, string> searchWordTransformerCallback { get; private set; }
public Func<string, bool, StringComparison, string, bool> searchWordMatcher { get; private set; }
public QueryValidationOptions validationOptions { get; set; }
public StringComparison globalStringComparison { get; set; } = StringComparison.OrdinalIgnoreCase;
public StringComparison searchDataStringComparison { get; private set; } = StringComparison.OrdinalIgnoreCase;
public bool searchDataOverridesGlobalStringComparison { get; private set; }
INestedQueryHandler m_NestedQueryHandler;
Dictionary<string, INestedQueryAggregator> m_NestedQueryAggregators = new Dictionary<string, INestedQueryAggregator>();
HashSet<int> m_CustomFilterTokenHandlers = new HashSet<int>();
delegate int MatchFilterFunction(Regex filterRx, string text, int startIndex, int endIndex, ICollection<QueryError> errors, out StringView sv, out Match match, out bool matched);
delegate IQueryNode CreateFilterFunction(IFilter filter, string text, in StringView token, Match match, int index, ICollection<QueryError> errors);
delegate IQueryNode CreateFilterTokenFunction(string text, in StringView token, Match match, int index, ICollection<QueryError> errors);
delegate IQueryNode CreateTextNodeFunction(string text, in StringView token, Match match, ICollection<QueryError> errors, QueryEngineParserData data);
public QueryEngineImpl()
: this(new QueryValidationOptions())
{}
public QueryEngineImpl(QueryValidationOptions validationOptions)
{
this.validationOptions = validationOptions;
// Default operators
AddOperator(":", FilterOperatorType.Contains, false)
.AddHandler((FilterOperatorContext ctx, object ev, object fv, StringComparison sc) => CompareObjects(ctx, ev, fv, sc, FilterOperatorType.Contains, ":"))
.AddHandler((string ev, string fv, StringComparison sc) => ev?.IndexOf(fv, sc) >= 0)
.AddHandler((int ev, int fv, StringComparison sc) => ev.ToString().IndexOf(fv.ToString(), sc) != -1)
.AddHandler((float ev, float fv, StringComparison sc) => ev.ToString().IndexOf(fv.ToString(), sc) != -1)
.AddHandler((double ev, double fv, StringComparison sc) => ev.ToString().IndexOf(fv.ToString(), sc) != -1);
AddOperator("=", FilterOperatorType.Equal, false)
.AddHandler((FilterOperatorContext ctx, object ev, object fv, StringComparison sc) => CompareObjects(ctx, ev, fv, sc, FilterOperatorType.Equal, "="))
.AddHandler((int ev, int fv) => ev == fv)
.AddHandler((float ev, float fv) => Math.Abs(ev - fv) < Mathf.Epsilon)
.AddHandler((double ev, double fv) => Math.Abs(ev - fv) < double.Epsilon)
.AddHandler((bool ev, bool fv) => ev == fv)
.AddHandler((string ev, string fv, StringComparison sc) => string.Equals(ev, fv, sc));
AddOperator("!=", FilterOperatorType.NotEqual, false)
.AddHandler((FilterOperatorContext ctx, object ev, object fv, StringComparison sc) => CompareObjects(ctx, ev, fv, sc, FilterOperatorType.NotEqual, "!="))
.AddHandler((int ev, int fv) => ev != fv)
.AddHandler((float ev, float fv) => Math.Abs(ev - fv) >= Mathf.Epsilon)
.AddHandler((double ev, double fv) => Math.Abs(ev - fv) >= double.Epsilon)
.AddHandler((bool ev, bool fv) => ev != fv)
.AddHandler((string ev, string fv, StringComparison sc) => !string.Equals(ev, fv, sc));
AddOperator("<", FilterOperatorType.Lesser, false)
.AddHandler((FilterOperatorContext ctx, object ev, object fv, StringComparison sc) => CompareObjects(ctx, ev, fv, sc, FilterOperatorType.Lesser, "<"))
.AddHandler((int ev, int fv) => ev < fv)
.AddHandler((float ev, float fv) => ev < fv)
.AddHandler((double ev, double fv) => ev < fv)
.AddHandler((string ev, string fv, StringComparison sc) => string.Compare(ev, fv, sc) < 0);
AddOperator(">", FilterOperatorType.Greater, false)
.AddHandler((FilterOperatorContext ctx, object ev, object fv, StringComparison sc) => CompareObjects(ctx, ev, fv, sc, FilterOperatorType.Greater, ">"))
.AddHandler((int ev, int fv) => ev > fv)
.AddHandler((float ev, float fv) => ev > fv)
.AddHandler((double ev, double fv) => ev > fv)
.AddHandler((string ev, string fv, StringComparison sc) => string.Compare(ev, fv, sc) > 0);
AddOperator("<=", FilterOperatorType.LesserOrEqual, false)
.AddHandler((FilterOperatorContext ctx, object ev, object fv, StringComparison sc) => CompareObjects(ctx, ev, fv, sc, FilterOperatorType.LesserOrEqual, "<="))
.AddHandler((int ev, int fv) => ev <= fv)
.AddHandler((float ev, float fv) => ev <= fv)
.AddHandler((double ev, double fv) => ev <= fv)
.AddHandler((string ev, string fv, StringComparison sc) => string.Compare(ev, fv, sc) <= 0);
AddOperator(">=", FilterOperatorType.GreaterOrEqual, false)
.AddHandler((FilterOperatorContext ctx, object ev, object fv, StringComparison sc) => CompareObjects(ctx, ev, fv, sc, FilterOperatorType.GreaterOrEqual, ">="))
.AddHandler((int ev, int fv) => ev >= fv)
.AddHandler((float ev, float fv) => ev >= fv)
.AddHandler((double ev, double fv) => ev >= fv)
.AddHandler((string ev, string fv, StringComparison sc) => string.Compare(ev, fv, sc) >= 0);
BuildFilterRegex();
BuildDefaultTypeParsers();
// Insert boolean filter matcher/consumer after normal filter
AddQueryTokenHandler(new QueryTokenHandler(MatchBooleanFilter, ConsumeBooleanFilter, (int)ExtendedTokenHandlerPriority.Boolean), false);
// Insert partial filter matcher/consumer before the word consumer
AddQueryTokenHandler(new QueryTokenHandler(MatchPartialFilter, ConsumePartialFilter, (int)ExtendedTokenHandlerPriority.Partial));
}
bool CompareObjects(FilterOperatorContext ctx, object ev, object fv, StringComparison sc, FilterOperatorType op, string opToken)
{
if (ev == null || fv == null)
return false;
var evt = ev.GetType();
var fvt = fv.GetType();
// Check filter operators first
if (ctx.filter != null && ctx.filter.operators.TryGetValue(opToken, out var filterOperators))
{
var opHandler = filterOperators.GetHandler(evt, fvt);
if (opHandler != null)
return opHandler.Invoke(ctx, ev, fv, sc);
}
if (m_FilterOperators.TryGetValue(opToken, out var operators))
{
var opHandler = operators.GetHandler(evt, fvt);
if (opHandler != null)
return opHandler.Invoke(ctx, ev, fv, sc);
}
if (evt != fvt)
return false;
if (ev is string evs && fv is string fvs)
{
switch (op)
{
case FilterOperatorType.Contains: return evs.IndexOf(fvs, sc) != -1;
case FilterOperatorType.Equal: return evs.Equals(fvs, sc);
case FilterOperatorType.NotEqual: return !evs.Equals(fvs, sc);
case FilterOperatorType.Greater: return string.Compare(evs, fvs, sc) > 0;
case FilterOperatorType.GreaterOrEqual: return string.Compare(evs, fvs, sc) >= 0;
case FilterOperatorType.Lesser: return string.Compare(evs, fvs, sc) < 0;
case FilterOperatorType.LesserOrEqual: return string.Compare(evs, fvs, sc) <= 0;
}
return false;
}
switch (op)
{
case FilterOperatorType.Contains: return ev.ToString().IndexOf(fv.ToString(), sc) >= 0;
case FilterOperatorType.Equal: return ev.Equals(fv);
case FilterOperatorType.NotEqual: return !ev.Equals(fv);
case FilterOperatorType.Greater: return Comparer<object>.Default.Compare(ev, fv) > 0;
case FilterOperatorType.GreaterOrEqual: return Comparer<object>.Default.Compare(ev, fv) >= 0;
case FilterOperatorType.Lesser: return Comparer<object>.Default.Compare(ev, fv) < 0;
case FilterOperatorType.LesserOrEqual: return Comparer<object>.Default.Compare(ev, fv) <= 0;
}
return false;
}
public void AddFilter(string token, IFilter filter)
{
if (m_Filters.ContainsKey(token))
{
Debug.LogWarning($"A filter for \"{token}\" already exists. Please remove it first before adding a new one.");
return;
}
m_Filters.Add(token, filter);
}
public void AddFilter(Regex token, IFilter filter)
{
AddFilter(token.ToString(), filter);
}
public void AddFilter(IFilter filter)
{
if (filter.usesRegularExpressionToken)
AddFilter(filter.regexToken, filter);
else
AddFilter(filter.token, filter);
}
public void RemoveFilter(string token)
{
if (!m_Filters.ContainsKey(token))
{
Debug.LogWarning($"No filter found for \"{token}\".");
return;
}
var filter = m_Filters[token];
var filterId = filter.GetHashCode();
if (m_CustomFilterTokenHandlers.Contains(filterId))
RemoveQueryTokenHandlers(filterId);
m_Filters.Remove(token);
}
public void RemoveFilter(Regex token)
{
RemoveFilter(token.ToString());
}
public void RemoveFilter(IFilter filter)
{
if (filter.usesRegularExpressionToken)
RemoveFilter(filter.regexToken);
else
RemoveFilter(filter.token);
}
public void ClearFilters()
{
foreach (var filterId in m_CustomFilterTokenHandlers)
{
RemoveQueryTokenHandlers(filterId);
}
m_Filters.Clear();
m_CustomFilterTokenHandlers.Clear();
}
public IFilter GetFilter(string token)
{
if (!m_Filters.ContainsKey(token))
{
Debug.LogWarning($"No filter found for \"{token}\".");
return null;
}
return m_Filters[token];
}
public IFilter GetFilter(Regex token)
{
return GetFilter(token.ToString());
}
public IEnumerable<IFilter> GetAllFilters()
{
return m_Filters.Values;
}
public bool HasFilter(string token)
{
return m_Filters.ContainsKey(token);
}
public bool HasFilter(Regex token)
{
return HasFilter(token.ToString());
}
public bool TryGetFilter(string token, out IFilter filter)
{
return m_Filters.TryGetValue(token, out filter);
}
public bool TryGetFilter(Regex token, out IFilter filter)
{
return TryGetFilter(token.ToString(), out filter);
}
public QueryFilterOperator AddOperator(string op)
{
return AddOperator(op, true);
}
QueryFilterOperator AddOperator(string op, bool rebuildFilterRegex)
{
// This is called only by users. If they try to add an existing default
// operator, the default operator is returned and the type doesn't matter.
return AddOperator(op, FilterOperatorType.Custom, rebuildFilterRegex);
}
QueryFilterOperator AddOperator(string op, FilterOperatorType type, bool rebuildFilterRegex)
{
if (m_FilterOperators.ContainsKey(op))
return m_FilterOperators[op];
var filterOperator = new QueryFilterOperator(op, type, this);
m_FilterOperators.Add(op, filterOperator);
if (rebuildFilterRegex)
BuildFilterRegex();
return filterOperator;
}
public void RemoveOperator(string op)
{
RemoveOperator(op, true);
}
void RemoveOperator(string op, bool rebuildFilterRegex)
{
if (!m_FilterOperators.ContainsKey(op))
return;
m_FilterOperators.Remove(op);
if (rebuildFilterRegex)
BuildFilterRegex();
}
public QueryFilterOperator GetOperator(string op)
{
return m_FilterOperators.ContainsKey(op) ? m_FilterOperators[op] : QueryFilterOperator.invalid;
}
public void AddOperatorHandler<TLhs, TRhs>(string op, Func<TLhs, TRhs, bool> handler)
{
AddOperatorHandler<TLhs, TRhs>(op, (ctx, ev, fv, sc) => handler(ev, fv));
}
public void AddOperatorHandler<TLhs, TRhs>(string op, Func<TLhs, TRhs, StringComparison, bool> handler)
{
AddOperatorHandler<TLhs, TRhs>(op, (ctx, ev, fv, sc) => handler(ev, fv, sc));
}
public void AddOperatorHandler<TLhs, TRhs>(string op, Func<FilterOperatorContext, TLhs, TRhs, bool> handler)
{
AddOperatorHandler<TLhs, TRhs>(op, (ctx, ev, fv, sc) => handler(ctx, ev, fv));
}
public void AddOperatorHandler<TLhs, TRhs>(string op, Func<FilterOperatorContext, TLhs, TRhs, StringComparison, bool> handler)
{
if (!m_FilterOperators.ContainsKey(op))
return;
m_FilterOperators[op].AddHandler(handler);
}
public void SetDefaultFilterHandler(DefaultQueryFilterHandlerBase<TData> handler)
{
m_DefaultFilterHandler = handler;
}
public void SetDefaultParamFilterHandler(DefaultQueryFilterHandlerBase<TData> handler)
{
m_DefaultParamFilterHandler = handler;
}
public void SetSearchDataCallback(Func<TData, IEnumerable<string>> getSearchDataCallback)
{
searchDataCallback = getSearchDataCallback;
// Remove the override flag in case it was already set.
searchDataOverridesGlobalStringComparison = false;
}
public void SetSearchDataCallback(Func<TData, IEnumerable<string>> getSearchDataCallback, StringComparison stringComparison)
{
SetSearchDataCallback(getSearchDataCallback);
searchDataStringComparison = stringComparison;
searchDataOverridesGlobalStringComparison = true;
}
public void SetSearchDataCallback(Func<TData, IEnumerable<string>> getSearchDataCallback, Func<string, string> searchWordTransformerCallback, StringComparison stringComparison)
{
SetSearchDataCallback(getSearchDataCallback, stringComparison);
this.searchWordTransformerCallback = searchWordTransformerCallback;
}
public void SetSearchWordMatcher(Func<string, bool, StringComparison, string, bool> wordMatcher)
{
searchWordMatcher = wordMatcher;
}
public void AddTypeParser<TFilterConstant>(Func<string, ParseResult<TFilterConstant>> parser)
{
m_TypeParsers.Add(new TypeParser<TFilterConstant>(parser));
AddFilterOperationGenerator<TFilterConstant>();
}
public void SetNestedQueryHandler<TNestedQueryData>(Func<string, string, IEnumerable<TNestedQueryData>> handler)
{
if (handler == null)
return;
m_NestedQueryHandler = new NestedQueryHandler<TNestedQueryData>(handler);
// Reset default aggregators with the correct type
m_NestedQueryAggregators = new Dictionary<string, INestedQueryAggregator>();
AddNestedQueryAggregator<TNestedQueryData>("max", MaxAggregator<TNestedQueryData>.Aggregate);
AddNestedQueryAggregator<TNestedQueryData>("min", MinAggregator<TNestedQueryData>.Aggregate);
AddNestedQueryAggregator<TNestedQueryData>("first", FirstAggregator<TNestedQueryData>.Aggregate);
AddNestedQueryAggregator<TNestedQueryData>("last", LastAggregator<TNestedQueryData>.Aggregate);
}
public void SetFilterNestedQueryTransformer<TNestedQueryData, TRhs>(string filterToken, Func<TNestedQueryData, TRhs> transformer)
{
if (m_Filters.TryGetValue(filterToken, out var filter))
{
filter.SetNestedQueryTransformer(transformer);
}
}
public void AddNestedQueryAggregator<TNestedQueryData>(string token, Func<IEnumerable<TNestedQueryData>, IEnumerable<TNestedQueryData>> aggregator)
{
var lowerToken = token.ToLowerInvariant();
if (m_NestedQueryAggregators.ContainsKey(lowerToken))
{
Debug.LogWarning($"An aggregator for \"{token}\" already exists. Please remove it first before adding a new one.");
return;
}
m_NestedQueryAggregators.Add(lowerToken, new NestedQueryAggregator<TNestedQueryData>(aggregator));
}
public void RemoveNestedQueryAggregator<TNestedQuery>(string token)
{
var lowerToken = token.ToLowerInvariant();
if (!m_NestedQueryAggregators.ContainsKey(lowerToken))
{
Debug.LogWarning($"No aggregator found for \"{token}\".");
return;
}
m_NestedQueryAggregators.Remove(token);
}
public IFilterOperationGenerator GetGeneratorForType(Type type)
{
if (!m_FilterOperationGenerators.ContainsKey(type))
{
return null;
}
return m_FilterOperationGenerators[type];
}
public override void AddQuoteDelimiter(in QueryTextDelimiter textDelimiter)
{
AddQuoteDelimiter(textDelimiter, m_FilterOperators.Keys);
}
public void RemoveQuoteDelimiter(in QueryTextDelimiter textDelimiter)
{
RemoveQuoteDelimiter(textDelimiter, true);
}
IQueryNode BuildGraphRecursively(string text, int startIndex, int endIndex, ICollection<QueryError> errors, ICollection<string> tokens, ICollection<QueryToggle> toggles, NodesToStringPosition nodesToStringPosition)
{
var userData = new QueryEngineParserData(nodesToStringPosition, tokens, toggles);
var result = Parse(text, startIndex, endIndex, errors, userData);
if (result != ParseState.Matched)
return null;
InsertAndIfNecessary(userData.expressionNodes, nodesToStringPosition);
var rootNode = CombineNodesToTree(userData.expressionNodes, errors, nodesToStringPosition);
return rootNode;
}
internal BuildGraphResult BuildGraph(string text, ICollection<QueryError> errors, ICollection<string> tokens, ICollection<QueryToggle> toggles)
{
if (text == null)
return new BuildGraphResult(new QueryGraph(null), new QueryGraph(null));
var nodesToStringPosition = new NodesToStringPosition();
var evaluationRootNode = BuildGraphRecursively(text, 0, text.Length, errors, tokens, toggles, nodesToStringPosition);
// Make a copy of the query graph for the stock query graph
IQueryNode queryRootNode = null;
if (evaluationRootNode != null)
{
if (!(evaluationRootNode is ICopyableNode copyableRoot))
throw new Exception($"Root node should be an instance of {nameof(ICopyableNode)}.");
queryRootNode = copyableRoot.Copy();
}
// When validating syntax only, set the evaluation node to null to prevent further errors.
if (validationOptions.validateSyntaxOnly)
evaluationRootNode = null;
// Final simplification
RemoveGroupNodes(ref evaluationRootNode, errors, nodesToStringPosition);
RemoveSkippedNodes(ref evaluationRootNode, errors, nodesToStringPosition);
evaluationRootNode = InsertWhereNode(evaluationRootNode, errors, nodesToStringPosition);
// Validate the evaluationGraph at the final stage, not when building all the subgraphs
// otherwise you will validate each nodes multiple times. A null node
// is valid if we removed all noOp nodes.
if (evaluationRootNode != null)
ValidateGraph(evaluationRootNode, errors, nodesToStringPosition);
if (evaluationRootNode != null && !IsEnumerableNode(evaluationRootNode))
{
errors.Add(new QueryError(evaluationRootNode.token.position, evaluationRootNode.token.length, "Only enumerable nodes can be at the root level"));
evaluationRootNode.skipped = false;
}
return new BuildGraphResult(new QueryGraph(evaluationRootNode), new QueryGraph(queryRootNode));
}
protected override bool ConsumeEmpty(string text, int startIndex, int endIndex, in StringView sv, Match match, ICollection<QueryError> errors, QueryEngineParserData userData)
{
return true;
}
protected override bool ConsumeCombiningToken(string text, int startIndex, int endIndex, in StringView sv, Match match, ICollection<QueryError> errors, QueryEngineParserData userData)
{
var token = sv.ToString();
IQueryNode newNode = null;
foreach (var tokenGenerator in k_CombiningTokenGenerators)
{
if (sv.Equals(tokenGenerator.Key, StringComparison.OrdinalIgnoreCase))
{
newNode = tokenGenerator.Value();
break;
}
}
if (newNode == null)
{
errors.Add(new QueryError(startIndex, endIndex - startIndex, $"No node generator found for combining token \"{token}\"."));
return false;
}
newNode.token = new QueryToken(in sv, startIndex);
userData.nodesToStringPosition.Add(newNode, new QueryToken(startIndex, sv.length));
userData.expressionNodes.Add(newNode);
userData.tokens.Add(token);
return true;
}
protected override bool ConsumeFilter(string text, int startIndex, int endIndex, in StringView sv, Match match, ICollection<QueryError> errors, QueryEngineParserData userData)
{
return ConsumeFilter(text, startIndex, endIndex, in sv, match, errors, userData, CreateFilterToken);
}
int MatchBooleanFilter(string text, int startIndex, int endIndex, ICollection<QueryError> errors, out StringView sv, out Match match, out bool matched)
{
return MatchBooleanFilter(m_BooleanFilterRx, text, startIndex, endIndex, errors, out sv, out match, out matched);
}
int MatchBooleanFilter(Regex booleanFilterRx, string text, int startIndex, int endIndex, ICollection<QueryError> errors, out StringView sv, out Match match, out bool matched)
{
sv = text.GetStringView();
match = booleanFilterRx.Match(text, startIndex, endIndex - startIndex);
matched = false;
if (!match.Success)
return -1;
if (match.Groups.Count < 2)
return -1;
var filterType = match.Groups[1].Value;
if (!m_Filters.TryGetValue(filterType, out var filter))
return -1;
if (filter.type != typeof(bool))
return -1;
matched = true;
return match.Length;
}
static int MatchKnownBooleanFilter(Regex booleanFilterRx, string text, int startIndex, int endIndex, ICollection<QueryError> errors, out StringView sv, out Match match, out bool matched)
{
sv = text.GetStringView();
match = booleanFilterRx.Match(text, startIndex, endIndex - startIndex);
matched = false;
if (!match.Success)
return -1;
if (match.Groups.Count < 2)
return -1;
matched = true;
return match.Length;
}
bool ConsumeBooleanFilter(string text, int startIndex, int endIndex, in StringView sv, Match match, ICollection<QueryError> errors, QueryEngineParserData userData)
{
return ConsumeFilter(text, startIndex, endIndex, in sv, match, errors, userData, CreateBooleanFilterToken);
}
int MatchPartialFilter(string text, int startIndex, int endIndex, ICollection<QueryError> errors, out StringView sv, out Match match, out bool matched)
{
return MatchFilter(m_PartialFilterRx, text, startIndex, endIndex, errors, out sv, out match, out matched);
}
bool ConsumePartialFilter(string text, int startIndex, int endIndex, in StringView sv, Match match, ICollection<QueryError> errors, QueryEngineParserData userData)
{
return ConsumeFilter(text, startIndex, endIndex, in sv, match, errors, userData, CreatePartialFilterToken);
}
static bool ConsumeFilter(string text, int startIndex, int endIndex, in StringView sv, Match match, ICollection<QueryError> errors, QueryEngineParserData userData, CreateFilterTokenFunction createFilterFunc)
{
var svToken = new StringView(text, startIndex, startIndex + match.Length);
var node = createFilterFunc(text, in svToken, match, startIndex, errors);
if (node == null)
return false;
node.token = new QueryToken(in svToken, startIndex);
userData.nodesToStringPosition.Add(node, new QueryToken(startIndex, match.Length));
userData.expressionNodes.Add(node);
userData.tokens.Add(match.Value);
return true;
}
protected override bool ConsumeWord(string text, int startIndex, int endIndex, in StringView sv, Match match, ICollection<QueryError> errors, QueryEngineParserData userData)
{
if (validationOptions.validateFilters && searchDataCallback == null && !validationOptions.validateSyntaxOnly)
{
errors.Add(new QueryError(startIndex, match.Length, "Cannot use a search word without setting the search data callback."));
return false;
}
return ConsumeText(text, startIndex, endIndex, in sv, match, errors, userData, CreateWordExpressionNode);
}
protected override bool ConsumeComment(string text, int startIndex, int endIndex, in StringView sv, Match match, ICollection<QueryError> errors, QueryEngineParserData userData)
{
return ConsumeText(text, startIndex, endIndex, in sv, match, errors, userData, CreateCommentNode);
}
protected override bool ConsumeToggle(string text, int startIndex, int endIndex, in StringView sv, Match match, ICollection<QueryError> errors, QueryEngineParserData userData)
{
return ConsumeText(text, startIndex, endIndex, in sv, match, errors, userData, CreateToggleNode);
}
static bool ConsumeText(string text, int startIndex, int endIndex, in StringView sv, Match match, ICollection<QueryError> errors, QueryEngineParserData userData, CreateTextNodeFunction createNodeFunc)
{
var tokenSv = new StringView(text, startIndex, startIndex + match.Length);
var node = createNodeFunc(text, in tokenSv, match, errors, userData);
if (node == null)
return false;
node.token = new QueryToken(in tokenSv, startIndex);
userData.nodesToStringPosition.Add(node, new QueryToken(startIndex, match.Length));
userData.expressionNodes.Add(node);
if (!node.skipped)
userData.tokens.Add(match.Value);
return true;
}
protected override bool ConsumeGroup(string text, int startIndex, int endIndex, in StringView sv, Match match, ICollection<QueryError> errors, QueryEngineParserData userData)
{
var innerNode = BuildGraphRecursively(text, startIndex + 1, endIndex - 1, errors, userData.tokens, userData.toggles, userData.nodesToStringPosition);
if (innerNode == null)
return false;
var token = new QueryToken(in sv, startIndex);
var groupNode = new GroupNode(in sv) { token = token };
groupNode.AddNode(innerNode);
userData.expressionNodes.Add(groupNode);
userData.nodesToStringPosition.Add(groupNode, token);
return true;
}
protected override bool ConsumeNestedQuery(string text, int startIndex, int endIndex, in StringView sv, Match match, ICollection<QueryError> errors, QueryEngineParserData userData)
{
if (validationOptions.validateFilters && !validationOptions.skipNestedQueries && !validationOptions.validateSyntaxOnly)
{
if (m_NestedQueryHandler == null)
{
errors.Add(new QueryError(startIndex, match.Length, "Cannot use a nested query without setting the handler first."));
return false;
}
if (m_NestedQueryHandler.enumerableType != typeof(TData))
{
errors.Add(new QueryError(startIndex, match.Length, "When not in a filter, a nested query must return the same type as the QueryEngine it is used in."));
return false;
}
}
var aggregatorGroup = match.Groups["agg"];
var nestedGroup = match.Groups["nested"];
var nestedQueryAggregator = GetStringViewFromMatch(text, aggregatorGroup);
var queryString = GetStringViewFromMatch(text, nestedGroup);
var nestedQueryString = queryString.Substring(1, queryString.length - 2);
nestedQueryString = nestedQueryString.Trim();
var nestedQueryNode = new NestedQueryNode(in nestedQueryString, in queryString, m_NestedQueryHandler);
nestedQueryNode.token = new QueryToken(startIndex + (nestedQueryAggregator.IsNullOrEmpty() ? 0 : nestedQueryAggregator.length), queryString.length);
userData.nodesToStringPosition.Add(nestedQueryNode, nestedQueryNode.token);
if (validationOptions.skipNestedQueries)
{
nestedQueryNode.skipped = true;
userData.expressionNodes.Add(nestedQueryNode);
return true;
}
userData.tokens.Add(match.Value);
if (nestedQueryAggregator.IsNullOrEmpty())
userData.expressionNodes.Add(nestedQueryNode);
else
{
var lowerAggregator = nestedQueryAggregator.ToString().ToLowerInvariant();
if (!m_NestedQueryAggregators.TryGetValue(lowerAggregator, out var aggregator) && validationOptions.validateFilters && !validationOptions.validateSyntaxOnly)
{
errors.Add(new QueryError(startIndex, nestedQueryAggregator.length, $"Unknown nested query aggregator \"{nestedQueryAggregator}\""));
return false;
}
var aggregatorNode = new AggregatorNode(in nestedQueryAggregator, aggregator);
aggregatorNode.token = new QueryToken(startIndex, nestedQueryAggregator.length + nestedQueryNode.token.length);
userData.nodesToStringPosition.Add(aggregatorNode, aggregatorNode.token);
aggregatorNode.children.Add(nestedQueryNode);
nestedQueryNode.parent = aggregatorNode;
userData.expressionNodes.Add(aggregatorNode);
}
return true;
}
static void InsertAndIfNecessary(List<IQueryNode> nodes, NodesToStringPosition nodesToStringPosition)
{
if (nodes.Count <= 1)
return;
for (var i = 0; i < nodes.Count - 1; ++i)
{
if (nodes[i] is CombinedNode cn && cn.leaf)
continue;
if (nodes[i + 1] is CombinedNode nextCn && nextCn.leaf && nextCn.type != QueryNodeType.Not)
continue;
var andNode = new AndNode();
var previousNodePosition = nodesToStringPosition[nodes[i]];
var nextNodePosition = nodesToStringPosition[nodes[i + 1]];
var startPosition = previousNodePosition.position + previousNodePosition.length;
var length = nextNodePosition.position - startPosition;
nodesToStringPosition.Add(andNode, new QueryToken(startPosition, length));
nodes.Insert(i + 1, andNode);
andNode.token = new QueryToken("", startPosition, length);
// Skip this new node
++i;
}
}
IQueryNode CreateFilterToken(string text, in StringView token, Match match, int index, ICollection<QueryError> errors)
{
return CreateFilterToken(null, text, in token, match, index, errors);
}
IQueryNode CreateFilterToken(IFilter filter, string text, in StringView token, Match match, int index, ICollection<QueryError> errors)
{
// Mandatory groups
var filterTypeGroup = match.Groups["name"];
var filterOperatorGroup = match.Groups["op"];
var filterValueGroup = match.Groups["value"];
var filterParamGroup = match.Groups["f1"];
var nestedQueryGroup = match.Groups["agg"];
if (!filterTypeGroup.Success || !filterOperatorGroup.Success || !filterValueGroup.Success)
{
errors.Add(new QueryError(index, token.length, $"Could not parse filter block \"{token}\"."));
return null;
}
var filterType = GetStringViewFromMatch(text, filterTypeGroup);
var filterParam = GetStringViewFromMatch(text, filterParamGroup);
var filterOperator = GetStringViewFromMatch(text, filterOperatorGroup);
var filterValue = GetStringViewFromMatch(text, filterValueGroup);