Introduces TerminalSearchOptions

Fixes Release Mode pattern behaviour (value was only updated on the next TerminalState copying)

lib/terminal/terminal.dart

@@ -22,6 +22,7 @@ import 'package:xterm/terminal/terminal_ui_interaction.dart';
 import 'package:xterm/theme/terminal_color.dart';
 import 'package:xterm/theme/terminal_theme.dart';
 import 'package:xterm/theme/terminal_themes.dart';
+import 'package:xterm/util/constants.dart';
 import 'package:xterm/util/debug_handler.dart';
 import 'package:xterm/util/observable.dart';
 
@@ -487,14 +488,6 @@ class Terminal with Observable implements TerminalUiInteraction {
     }
   }
 
-  final wordSeparatorCodes = <String>[
-    String.fromCharCode(0),
-    ' ',
-    '.',
-    ':',
-    '/'
-  ];
-
   void selectWordOrRow(Position position) {
     if (position.y > buffer.lines.length) {
       return;
@@ -524,7 +517,7 @@ class Terminal with Observable implements TerminalUiInteraction {
           break;
         }
         final content = line.cellGetContent(start - 1);
-        if (wordSeparatorCodes.contains(String.fromCharCode(content))) {
+        if (kWordSeparators.contains(String.fromCharCode(content))) {
           break;
         }
         start--;
@@ -534,7 +527,7 @@ class Terminal with Observable implements TerminalUiInteraction {
           break;
         }
         final content = line.cellGetContent(end + 1);
-        if (wordSeparatorCodes.contains(String.fromCharCode(content))) {
+        if (kWordSeparators.contains(String.fromCharCode(content))) {
           break;
         }
         end++;
@@ -543,6 +536,7 @@ class Terminal with Observable implements TerminalUiInteraction {
       _selection.clear();
       _selection.init(Position(start, row));
       _selection.update(Position(end, row));
+      refresh();
     }
   }
 
@@ -727,6 +721,7 @@ class Terminal with Observable implements TerminalUiInteraction {
   void selectAll() {
     _selection.init(Position(0, 0));
     _selection.update(Position(terminalWidth, bufferHeight));
+    refresh();
   }
 
   String _composingString = '';
@@ -743,6 +738,15 @@ class Terminal with Observable implements TerminalUiInteraction {
   @override
   TerminalSearchResult get userSearchResult => _userSearchTask.searchResult;
 
+  @override
+  TerminalSearchOptions get userSearchOptions => _userSearchTask.options;
+
+  @override
+  void set userSearchOptions(TerminalSearchOptions options) {
+    _userSearchTask.options = options;
+    refresh();
+  }
+
   @override
   String? get userSearchPattern => _userSearchTask.pattern;
 

lib/terminal/terminal_isolate.dart

@@ -34,7 +34,8 @@ enum _IsolateCommand {
   paste,
   terminateBackend,
   updateComposingString,
-  updateSearchPattern
+  updateSearchPattern,
+  updateSearchOptions,
 }
 
 enum _IsolateEvent {
@@ -150,6 +151,7 @@ void terminalMain(SendPort port) async {
             _terminal.composingString,
             _terminal.userSearchResult,
             _terminal.userSearchPattern,
+            _terminal.userSearchOptions,
           );
           port.send([_IsolateEvent.newState, newState]);
           _needNotify = true;
@@ -167,6 +169,9 @@ void terminalMain(SendPort port) async {
       case _IsolateCommand.updateSearchPattern:
         _terminal?.userSearchPattern = msg[1];
         break;
+      case _IsolateCommand.updateSearchOptions:
+        _terminal?.userSearchOptions = msg[1];
+        break;
     }
   }
 }
@@ -214,6 +219,7 @@ class TerminalState {
 
   TerminalSearchResult searchResult;
   String? userSearchPattern;
+  TerminalSearchOptions userSearchOptions;
 
   TerminalState(
     this.scrollOffsetFromBottom,
@@ -233,6 +239,7 @@ class TerminalState {
     this.composingString,
     this.searchResult,
     this.userSearchPattern,
+    this.userSearchOptions,
   );
 }
 
@@ -399,6 +406,7 @@ class TerminalIsolate with Observable implements TerminalUiInteraction {
           break;
         case _IsolateEvent.newState:
           _lastState = message[1];
+          _updateLocalCaches();
           if (!initialRefreshCompleted.isCompleted) {
             initialRefreshCompleted.complete(true);
           }
@@ -547,11 +555,26 @@ class TerminalIsolate with Observable implements TerminalUiInteraction {
   TerminalSearchResult get userSearchResult =>
       _lastState?.searchResult ?? TerminalSearchResult.empty();
 
+  TerminalSearchOptions? _localUserSearchOptionsCache;
+
+  @override
+  TerminalSearchOptions get userSearchOptions =>
+      _localUserSearchOptionsCache ?? TerminalSearchOptions();
+
+  @override
+  void set userSearchOptions(TerminalSearchOptions options) {
+    _localUserSearchOptionsCache = options;
+    _sendPort?.send([_IsolateCommand.updateSearchOptions, options]);
+  }
+
+  String? _localUserSearchPatternCache;
+
   @override
-  String? get userSearchPattern => _lastState?.userSearchPattern;
+  String? get userSearchPattern => _localUserSearchPatternCache;
 
   @override
   void set userSearchPattern(String? newValue) {
+    _localUserSearchPatternCache = newValue;
     _sendPort?.send([_IsolateCommand.updateSearchPattern, newValue]);
   }
 
@@ -564,4 +587,10 @@ class TerminalIsolate with Observable implements TerminalUiInteraction {
   void set isUserSearchActive(bool isUserSearchActive) {
     _isUserSearchActive = isUserSearchActive;
   }
+
+  void _updateLocalCaches() {
+    _localUserSearchPatternCache = _lastState?.userSearchPattern;
+    _localUserSearchOptionsCache =
+        _lastState?.userSearchOptions ?? TerminalSearchOptions();
+  }
 }

lib/terminal/terminal_search.dart

@@ -1,5 +1,7 @@
+import 'package:equatable/equatable.dart';
 import 'package:xterm/buffer/line/line.dart';
 import 'package:xterm/terminal/terminal.dart';
+import 'package:xterm/util/constants.dart';
 
 class TerminalSearchResult {
   final _hitsByLine = Map<int, List<TerminalSearchHit>>();
@@ -68,8 +70,40 @@ class TerminalSearchHit {
   }
 }
 
+class TerminalSearchOptions extends Equatable {
+  TerminalSearchOptions({
+    this.caseSensitive = false,
+    this.matchWholeWord = false,
+    this.useRegex = false,
+  });
+
+  final bool caseSensitive;
+  final bool matchWholeWord;
+  final bool useRegex;
+
+  TerminalSearchOptions copyWith(
+      {bool? caseSensitive, bool? matchWholeWord, bool? useRegex}) {
+    return TerminalSearchOptions(
+      caseSensitive: caseSensitive ?? this.caseSensitive,
+      matchWholeWord: matchWholeWord ?? this.matchWholeWord,
+      useRegex: useRegex ?? this.useRegex,
+    );
+  }
+
+  @override
+  bool get stringify => true;
+
+  @override
+  List<Object?> get props => [
+        caseSensitive,
+        matchWholeWord,
+        useRegex,
+      ];
+}
+
 class TerminalSearchTask {
-  TerminalSearchTask(this._search, this._terminal, this._dirtyTagName);
+  TerminalSearchTask(this._search, this._terminal, this._dirtyTagName,
+      this._terminalSearchOptions);
 
   final TerminalSearch _search;
   final Terminal _terminal;
@@ -77,6 +111,7 @@ class TerminalSearchTask {
   bool _isPatternDirty = true;
   RegExp? _searchRegexp = null;
   final String _dirtyTagName;
+  TerminalSearchOptions _terminalSearchOptions;
 
   bool? _hasBeenUsingAltBuffer;
   TerminalSearchResult? _lastSearchResult = null;
@@ -125,6 +160,16 @@ class TerminalSearchTask {
     }
   }
 
+  TerminalSearchOptions get options => _terminalSearchOptions;
+  void set options(TerminalSearchOptions newOptions) {
+    if (_terminalSearchOptions == newOptions) {
+      return;
+    }
+    _terminalSearchOptions = newOptions;
+    _isPatternDirty = true;
+    _searchRegexp = null;
+  }
+
   TerminalSearchResult get searchResult {
     if (_pattern == null) {
       return TerminalSearchResult.empty();
@@ -135,21 +180,43 @@ class TerminalSearchTask {
 
     final terminalWidth = _terminal.terminalWidth;
 
-    //TODO: make caseSensitive an option
     if (_searchRegexp == null) {
-      _searchRegexp = RegExp(_pattern!, caseSensitive: false, multiLine: false);
+      var pattern = _pattern!;
+      if (!_terminalSearchOptions.useRegex) {
+        pattern = RegExp.escape(_pattern!);
+      }
+      final regex = '(?<hit>$pattern)';
+      _searchRegexp = RegExp(regex,
+          caseSensitive: _terminalSearchOptions.caseSensitive,
+          multiLine: false);
     }
 
     final hits = List<TerminalSearchHit>.empty(growable: true);
 
     for (final match
         in _searchRegexp!.allMatches(_search.terminalSearchString)) {
-      final startLineIndex = (match.start / terminalWidth).floor();
-      final endLineIndex = (match.end / terminalWidth).floor();
+      final start = match.start;
+      final end = match.end;
+      final startLineIndex = (start / terminalWidth).floor();
+      final endLineIndex = (end / terminalWidth).floor();
 
       // subtract the lines that got added in order to get the index inside the line
-      final startIndex = match.start - startLineIndex * terminalWidth;
-      final endIndex = match.end - endLineIndex * terminalWidth;
+      final startIndex = start - startLineIndex * terminalWidth;
+      final endIndex = end - endLineIndex * terminalWidth;
+
+      if (_terminalSearchOptions.matchWholeWord) {
+        // we match a whole word when the hit fulfills:
+        // 1) starts at a line beginning or has a word-separator before it
+        final startIsOK =
+            startIndex == 0 || kWordSeparators.contains(match.input[start - 1]);
+        // 2) ends with a line or has a word-separator after it
+        final endIsOK = endIndex == terminalWidth ||
+            kWordSeparators.contains(match.input[end]);
+
+        if (!startIsOK || !endIsOK) {
+          continue;
+        }
+      }
 
       hits.add(
         TerminalSearchHit(
@@ -178,7 +245,8 @@ class TerminalSearch {
   int? _lastTerminalWidth;
 
   TerminalSearchTask createSearchTask(String dirtyTagName) {
-    return TerminalSearchTask(this, _terminal, dirtyTagName);
+    return TerminalSearchTask(
+        this, _terminal, dirtyTagName, TerminalSearchOptions());
   }
 
   String get terminalSearchString {

lib/terminal/terminal_ui_interaction.dart

@@ -138,6 +138,13 @@ abstract class TerminalUiInteraction with Observable {
   /// returns the list of search hits
   TerminalSearchResult get userSearchResult;
 
+  /// gets the current user search options
+  TerminalSearchOptions get userSearchOptions;
+
+  /// sets new user search options. This invalidates the cached search hits and
+  /// will re-trigger a new search
+  void set userSearchOptions(TerminalSearchOptions options);
+
   /// the search pattern of a currently active search or [null]
   String? get userSearchPattern;
 

lib/util/constants.dart

@@ -11,3 +11,17 @@ const kProfileMode = bool.fromEnvironment(
 const kDebugMode = !kReleaseMode && !kProfileMode;
 
 const kIsWeb = identical(0, 0.0);
+
+final kWordSeparators = [
+  String.fromCharCode(0),
+  ' ',
+  '.',
+  ':',
+  '-',
+  '\'',
+  '"',
+  '*',
+  '+',
+  '/',
+  '\\'
+];