autocomplete: Identify when the user intends a channel link autocomplete

For this commit we temporarily intercept the query at the
AutocompleteField widget, to avoid invoking the widgets that are
still unimplemented. That lets us defer those widgets' logic to a
separate later commit.

Author: sm-sayedi

lib/model/autocomplete.dart

@@ -48,6 +48,9 @@ extension ComposeContentAutocomplete on ComposeContentController {
       } else if (charAtPos == ':') {
         final match = _emojiIntentRegex.matchAsPrefix(textUntilCursor, pos);
         if (match == null) continue;
+      } else if (charAtPos == '#') {
+        final match = _channelLinkIntentRegex.matchAsPrefix(textUntilCursor, pos);
+        if (match == null) continue;
       } else {
         continue;
       }
@@ -66,6 +69,10 @@ extension ComposeContentAutocomplete on ComposeContentController {
         final match = _emojiIntentRegex.matchAsPrefix(textUntilCursor, pos);
         if (match == null) continue;
         query = EmojiAutocompleteQuery(match[1]!);
+      } else if (charAtPos == '#') {
+        final match = _channelLinkIntentRegex.matchAsPrefix(textUntilCursor, pos);
+        if (match == null) continue;
+        query = ChannelLinkAutocompleteQuery(match[1] ?? match[2]!);
       } else {
         continue;
       }
@@ -165,6 +172,35 @@ final RegExp _emojiIntentRegex = (() {
     + r')$');
 })();
 
+final RegExp _channelLinkIntentRegex = () {
+  // Similar reasoning as in _mentionIntentRegex.
+  const before = r'(?<=^|\s|\p{Punctuation})';
+
+  // TODO(upstream): maybe use duplicate-named capture groups for better readability?
+  //   https://github.com/dart-lang/sdk/issues/61337
+  return RegExp(unicode: true,
+    before
+    + r'#'
+    // As Web, match both '#channel' and '#**channel'. In both cases, the raw
+    // query is going to be 'channel'. Matching the second case ('#**channel')
+    // is useful when the user selects a channel from the autocomplete list, but
+    // then starts pressing "backspace" to edit the query and choose another
+    // option, instead of clearing the entire query and starting from scratch.
+
+    // Also, web doesn't seem to have any sort of limitations for the type of
+    // characters the channel name can contain.
+    + r'(?:'
+      // Case '#channel': right after '#', reject whitespace as well as '**'.
+      + r'(?!\s|\*\*)(.*)'
+      + r'|'
+      // Case '#**channel': right after '#**', reject whitespace.
+      // Also, make sure that the remaining query doesn't contain '**',
+      // otherwise '#**channel**' (which is a complete channel link syntax) and
+      // any text followed by that will always match.
+      + r'\*\*(?!\s)((?:(?!\*\*).)*)'
+    + r')$');
+}();
+
 /// The text controller's recognition that the user might want autocomplete UI.
 class AutocompleteIntent<QueryT extends AutocompleteQuery> {
   AutocompleteIntent({

lib/widgets/autocomplete.dart

@@ -45,7 +45,8 @@ class _AutocompleteFieldState<QueryT extends AutocompleteQuery, ResultT extends
   }
 
   void _handleControllerChange() {
-    final newQuery = widget.autocompleteIntent()?.query;
+    var newQuery = widget.autocompleteIntent()?.query;
+    if (newQuery is ChannelLinkAutocompleteQuery) newQuery = null; // TODO(#124)
     // First, tear down the old view-model if necessary.
     if (_viewModel != null
         && (newQuery == null

test/model/autocomplete_test.dart

@@ -98,6 +98,7 @@ void main() {
 
     MentionAutocompleteQuery mention(String raw) => MentionAutocompleteQuery(raw, silent: false);
     MentionAutocompleteQuery silentMention(String raw) => MentionAutocompleteQuery(raw, silent: true);
+    ChannelLinkAutocompleteQuery channelLink(String raw) => .new(raw);
     EmojiAutocompleteQuery emoji(String raw) => EmojiAutocompleteQuery(raw);
 
     doTest('', null);
@@ -182,6 +183,83 @@ void main() {
     doTest('If @chris is around, please ask him.^', null); // @ sign is too far away from cursor
     doTest('If @_chris is around, please ask him.^', null); // @ sign is too far away from cursor
 
+    // #channel link.
+
+    doTest('^#', null);
+    doTest('^#abc', null);
+    doTest('#abc', null); // (no cursor)
+
+    doTest('~#^', channelLink(''));
+    doTest('~#abc^', channelLink('abc'));
+    doTest('~#abc ^', channelLink('abc '));
+    doTest('~#abc def^', channelLink('abc def'));
+
+    // Accept space before channel link syntax.
+    doTest(' ~#abc^', channelLink('abc'));
+    doTest('xyz ~#abc^', channelLink('abc'));
+
+    // Accept punctuations before channel link syntax.
+    doTest('#~#abc^', channelLink('abc'));
+    doTest('@~#abc^', channelLink('abc'));
+    doTest(':~#abc^', channelLink('abc'));
+    doTest('!~#abc^', channelLink('abc'));
+    doTest(',~#abc^', channelLink('abc'));
+    doTest('.~#abc^', channelLink('abc'));
+    doTest('(~#abc^', channelLink('abc')); doTest(')~#abc^', channelLink('abc'));
+    doTest('{~#abc^', channelLink('abc')); doTest('}~#abc^', channelLink('abc'));
+    doTest('[~#abc^', channelLink('abc')); doTest(']~#abc^', channelLink('abc'));
+    // … and other punctuations.
+
+    // Avoid other characters before channel link syntax.
+    doTest('\$#abc^', null);
+    doTest('+#abc^', null);
+    doTest('=#abc^', null);
+    doTest('XYZ#abc^', null);
+    doTest('xyz#abc^', null);
+    // … but
+    doTest('~#xyz#abc^', channelLink('xyz#abc'));
+
+    // Avoid leading space character in query.
+    doTest('# ^', null);
+    doTest('# abc^', null);
+
+    // Avoid line-break characters in query.
+    doTest('#\n^', null); doTest('#a\n^', null); doTest('#\na^', null); doTest('#a\nb^', null);
+    doTest('#\r^', null); doTest('#a\r^', null); doTest('#\ra^', null); doTest('#a\rb^', null);
+    doTest('#\r\n^', null); doTest('#a\r\n^', null); doTest('#\r\na^', null); doTest('#a\r\nb^', null);
+
+    // Allow all other sorts of characters in query.
+    doTest('~#\u0000^', channelLink('\u0000')); // control
+    doTest('~#\u061C^', channelLink('\u061C')); // format character
+    doTest('~#\u0600^', channelLink('\u0600')); // format
+    doTest('~#\uD834^', channelLink('\uD834')); // leading surrogate
+    doTest('~#`^', channelLink('`'));   doTest('~#a`b^', channelLink('a`b'));
+    doTest('~#\\^', channelLink('\\')); doTest('~#a\\b^', channelLink('a\\b'));
+    doTest('~#"^', channelLink('"'));   doTest('~#a"b^', channelLink('a"b'));
+    doTest('~#>^', channelLink('>'));   doTest('~#a>b^', channelLink('a>b'));
+    doTest('~#&^', channelLink('&'));   doTest('~#a&b^', channelLink('a&b'));
+    doTest('~#_^', channelLink('_'));   doTest('~#a_b^', channelLink('a_b'));
+    doTest('~#*^', channelLink('*'));   doTest('~#a*b^', channelLink('a*b'));
+
+    // Two leading stars ('**') in query are omitted.
+    doTest('~#**^', channelLink(''));
+    doTest('~#**abc^', channelLink('abc'));
+    doTest('~#**abc ^', channelLink('abc '));
+    doTest('~#**abc def^', channelLink('abc def'));
+    doTest('#** ^', null);
+    doTest('#** abc^', null);
+    doTest('~#**abc*^', channelLink('abc*'));
+
+    // Query with leading '**' should not contain other '**'.
+    doTest('#**abc**^', null);
+    doTest('#**abc** ^', null);
+    doTest('#**abc** def^', null);
+
+    // Query without leading '**' can contain other '**'.
+    doTest('~#abc**^', channelLink('abc**'));
+    doTest('~#abc** ^', channelLink('abc** '));
+    doTest('~#abc** def^', channelLink('abc** def'));
+
     // Emoji (":smile:").
 
     // Basic positive examples, to contrast with all the negative examples below.