@@ -8,7 +8,7 @@ import 'narrow.dart';
8
8
import 'store.dart' ;
9
9
10
10
extension ComposeContentAutocomplete on ComposeContentController {
11
- AutocompleteIntent ? autocompleteIntent () {
11
+ AutocompleteIntent < MentionAutocompleteQuery > ? autocompleteIntent () {
12
12
if (! selection.isValid || ! selection.isNormalized) {
13
13
// We don't require [isCollapsed] to be true because we've seen that
14
14
// autocorrect and even backspace involve programmatically expanding the
@@ -68,8 +68,8 @@ final RegExp mentionAutocompleteMarkerRegex = (() {
68
68
unicode: true );
69
69
})();
70
70
71
- /// The content controller's recognition that the user might want autocomplete UI.
72
- class AutocompleteIntent {
71
+ /// The text controller's recognition that the user might want autocomplete UI.
72
+ class AutocompleteIntent < QueryT extends AutocompleteQuery > {
73
73
AutocompleteIntent ({
74
74
required this .syntaxStart,
75
75
required this .query,
@@ -91,7 +91,7 @@ class AutocompleteIntent {
91
91
// that use a custom/subclassed [TextEditingValue], so that's not convenient.
92
92
final int syntaxStart;
93
93
94
- final MentionAutocompleteQuery query; // TODO other autocomplete query types
94
+ final QueryT query;
95
95
96
96
/// The [TextEditingValue] whose text [syntaxStart] refers to.
97
97
final TextEditingValue textEditingValue;
@@ -151,21 +151,90 @@ class AutocompleteViewManager {
151
151
// void dispose() { … }
152
152
}
153
153
154
- /// A view-model for a mention- autocomplete interaction.
154
+ /// A view-model for an autocomplete interaction.
155
155
///
156
156
/// The owner of one of these objects must call [dispose] when the object
157
157
/// will no longer be used, in order to free resources on the [PerAccountStore] .
158
158
///
159
159
/// Lifecycle:
160
- /// * Create with [init] .
160
+ /// * Create an instance of a concrete subtype .
161
161
/// * Add listeners with [addListener] .
162
162
/// * Use the [query] setter to start a search for a query.
163
163
/// * On reassemble, call [reassemble] .
164
164
/// * When the object will no longer be used, call [dispose] to free
165
165
/// resources on the [PerAccountStore].
166
- class MentionAutocompleteView extends ChangeNotifier {
166
+ abstract class AutocompleteView <QueryT extends AutocompleteQuery , ResultT extends AutocompleteResult , CandidateT > extends ChangeNotifier {
167
+ AutocompleteView ({required this .store});
168
+
169
+ final PerAccountStore store;
170
+
171
+ Iterable <CandidateT > getSortedItemsToTest (QueryT query);
172
+
173
+ ResultT ? testItem (QueryT query, CandidateT item);
174
+
175
+ QueryT ? get query => _query;
176
+ QueryT ? _query;
177
+ set query (QueryT ? query) {
178
+ _query = query;
179
+ if (query != null ) {
180
+ _startSearch (query);
181
+ }
182
+ }
183
+
184
+ /// Called when the app is reassembled during debugging, e.g. for hot reload.
185
+ ///
186
+ /// This will redo the search from scratch for the current query, if any.
187
+ void reassemble () {
188
+ if (_query != null ) {
189
+ _startSearch (_query! );
190
+ }
191
+ }
192
+
193
+ Iterable <ResultT > get results => _results;
194
+ List <ResultT > _results = [];
195
+
196
+ Future <void > _startSearch (QueryT query) async {
197
+ final newResults = await _computeResults (query);
198
+ if (newResults == null ) {
199
+ // Query was old; new search is in progress. Or, no listeners to notify.
200
+ return ;
201
+ }
202
+
203
+ _results = newResults;
204
+ notifyListeners ();
205
+ }
206
+
207
+ Future <List <ResultT >?> _computeResults (QueryT query) async {
208
+ final List <ResultT > results = [];
209
+ final Iterable <CandidateT > data = getSortedItemsToTest (query);
210
+
211
+ final iterator = data.iterator;
212
+ bool isDone = false ;
213
+ while (! isDone) {
214
+ // CPU perf: End this task; enqueue a new one for resuming this work
215
+ await Future (() {});
216
+
217
+ if (query != _query || ! hasListeners) { // false if [dispose] has been called.
218
+ return null ;
219
+ }
220
+
221
+ for (int i = 0 ; i < 1000 ; i++ ) {
222
+ if (! iterator.moveNext ()) {
223
+ isDone = true ;
224
+ break ;
225
+ }
226
+ final CandidateT item = iterator.current;
227
+ final result = testItem (query, item);
228
+ if (result != null ) results.add (result);
229
+ }
230
+ }
231
+ return results;
232
+ }
233
+ }
234
+
235
+ class MentionAutocompleteView extends AutocompleteView <MentionAutocompleteQuery , MentionAutocompleteResult , User > {
167
236
MentionAutocompleteView ._({
168
- required this .store,
237
+ required super .store,
169
238
required this .narrow,
170
239
required this .sortedUsers,
171
240
});
@@ -183,6 +252,9 @@ class MentionAutocompleteView extends ChangeNotifier {
183
252
return view;
184
253
}
185
254
255
+ final Narrow narrow;
256
+ final List <User > sortedUsers;
257
+
186
258
static List <User > _usersByRelevance ({
187
259
required PerAccountStore store,
188
260
required Narrow narrow,
@@ -278,6 +350,19 @@ class MentionAutocompleteView extends ChangeNotifier {
278
350
streamId: streamId, senderId: userB.userId));
279
351
}
280
352
353
+ @override
354
+ Iterable <User > getSortedItemsToTest (MentionAutocompleteQuery query) {
355
+ return sortedUsers;
356
+ }
357
+
358
+ @override
359
+ MentionAutocompleteResult ? testItem (MentionAutocompleteQuery query, User item) {
360
+ if (query.testUser (item, store.autocompleteViewManager.autocompleteDataCache)) {
361
+ return UserMentionAutocompleteResult (userId: item.userId);
362
+ }
363
+ return null ;
364
+ }
365
+
281
366
/// Determines which of the two users is more recent in DM conversations.
282
367
///
283
368
/// Returns a negative number if [userA] is more recent than [userB] ,
@@ -317,82 +402,44 @@ class MentionAutocompleteView extends ChangeNotifier {
317
402
// TODO test that logic (may involve detecting an unhandled Future rejection; how?)
318
403
super .dispose ();
319
404
}
405
+ }
320
406
321
- final PerAccountStore store;
322
- final Narrow narrow;
323
- final List < User > sortedUsers ;
407
+ abstract class AutocompleteQuery {
408
+ AutocompleteQuery ( this .raw)
409
+ : _lowercaseWords = raw. toLowerCase (). split ( ' ' ) ;
324
410
325
- MentionAutocompleteQuery ? get query => _query;
326
- MentionAutocompleteQuery ? _query;
327
- set query (MentionAutocompleteQuery ? query) {
328
- _query = query;
329
- if (query != null ) {
330
- _startSearch (query);
331
- }
332
- }
411
+ final String raw;
412
+ final List <String > _lowercaseWords;
333
413
334
- /// Called when the app is reassembled during debugging, e.g. for hot reload .
414
+ /// Whether all of this query's words have matches in [words] that appear in order .
335
415
///
336
- /// This will redo the search from scratch for the current query, if any.
337
- void reassemble () {
338
- if (_query != null ) {
339
- _startSearch (_query! );
340
- }
341
- }
342
-
343
- Iterable <MentionAutocompleteResult > get results => _results;
344
- List <MentionAutocompleteResult > _results = [];
345
-
346
- Future <void > _startSearch (MentionAutocompleteQuery query) async {
347
- final newResults = await _computeResults (query);
348
- if (newResults == null ) {
349
- // Query was old; new search is in progress. Or, no listeners to notify.
350
- return ;
351
- }
352
-
353
- _results = newResults;
354
- notifyListeners ();
355
- }
356
-
357
- Future <List <MentionAutocompleteResult >?> _computeResults (MentionAutocompleteQuery query) async {
358
- final List <MentionAutocompleteResult > results = [];
359
- final iterator = sortedUsers.iterator;
360
- bool isDone = false ;
361
- while (! isDone) {
362
- // CPU perf: End this task; enqueue a new one for resuming this work
363
- await Future (() {});
364
-
365
- if (query != _query || ! hasListeners) { // false if [dispose] has been called.
366
- return null ;
416
+ /// A "match" means the word in [words] starts with the query word.
417
+ bool _testContainsQueryWords (List <String > words) {
418
+ // TODO(#237) test with diacritics stripped, where appropriate
419
+ int wordsIndex = 0 ;
420
+ int queryWordsIndex = 0 ;
421
+ while (true ) {
422
+ if (queryWordsIndex == _lowercaseWords.length) {
423
+ return true ;
424
+ }
425
+ if (wordsIndex == words.length) {
426
+ return false ;
367
427
}
368
428
369
- for (int i = 0 ; i < 1000 ; i++ ) {
370
- if (! iterator.moveNext ()) {
371
- isDone = true ;
372
- break ;
373
- }
374
-
375
- final User user = iterator.current;
376
- if (query.testUser (user, store.autocompleteViewManager.autocompleteDataCache)) {
377
- results.add (UserMentionAutocompleteResult (userId: user.userId));
378
- }
429
+ if (words[wordsIndex].startsWith (_lowercaseWords[queryWordsIndex])) {
430
+ queryWordsIndex++ ;
379
431
}
432
+ wordsIndex++ ;
380
433
}
381
- return results;
382
434
}
383
435
}
384
436
385
- class MentionAutocompleteQuery {
386
- MentionAutocompleteQuery (this .raw, {this .silent = false })
387
- : _lowercaseWords = raw.toLowerCase ().split (' ' );
388
-
389
- final String raw;
437
+ class MentionAutocompleteQuery extends AutocompleteQuery {
438
+ MentionAutocompleteQuery (super .raw, {this .silent = false });
390
439
391
440
/// Whether the user wants a silent mention (@_query, vs. @query).
392
441
final bool silent;
393
442
394
- final List <String > _lowercaseWords;
395
-
396
443
bool testUser (User user, AutocompleteDataCache cache) {
397
444
// TODO(#236) test email too, not just name
398
445
@@ -402,25 +449,7 @@ class MentionAutocompleteQuery {
402
449
}
403
450
404
451
bool _testName (User user, AutocompleteDataCache cache) {
405
- // TODO(#237) test with diacritics stripped, where appropriate
406
-
407
- final List <String > nameWords = cache.nameWordsForUser (user);
408
-
409
- int nameWordsIndex = 0 ;
410
- int queryWordsIndex = 0 ;
411
- while (true ) {
412
- if (queryWordsIndex == _lowercaseWords.length) {
413
- return true ;
414
- }
415
- if (nameWordsIndex == nameWords.length) {
416
- return false ;
417
- }
418
-
419
- if (nameWords[nameWordsIndex].startsWith (_lowercaseWords[queryWordsIndex])) {
420
- queryWordsIndex++ ;
421
- }
422
- nameWordsIndex++ ;
423
- }
452
+ return _testContainsQueryWords (cache.nameWordsForUser (user));
424
453
}
425
454
426
455
@override
@@ -449,7 +478,9 @@ class AutocompleteDataCache {
449
478
}
450
479
}
451
480
452
- sealed class MentionAutocompleteResult {}
481
+ class AutocompleteResult {}
482
+
483
+ sealed class MentionAutocompleteResult extends AutocompleteResult {}
453
484
454
485
class UserMentionAutocompleteResult extends MentionAutocompleteResult {
455
486
UserMentionAutocompleteResult ({required this .userId});
0 commit comments