[MOD] XQuery, text editor: shortcuts, improved search&replace

Author: ChristianGruen

basex-core/src/main/java/org/basex/core/Text.java

@@ -843,21 +843,17 @@ public interface Text {
   /** Command info. */
   String REPLACE_ALL = lang("replace_all");
   /** Command info. */
+  String REPLACE_NEXT = lang("replace_next");
+  /** Command info. */
   String REPLACE_WITH = lang("replace_with");
   /** Match case. */
   String MATCH_CASE = lang("match_case");
   /** Whole word. */
   String WHOLE_WORD = lang("whole_word");
-  /** Multi-line mode. */
-  String MULTI_LINE = lang("multi_line");
+  /** Dot matches newline. */
+  String DOT_ALL = lang("dot_all");
   /** Regular expression. */
   String REGULAR_EXPR = lang("regular_expr");
-  /** % string(s) found.. */
-  String STRINGS_FOUND_X = lang("strings_found_%");
-  /** Strings were replaced.. */
-  String STRINGS_REPLACED = lang("strings_replaced");
-  /** Searching. */
-  String SEARCHING = lang("searching");
 
   /** Serialization parameters. */
   String SERIALIZATION = lang("serialization");

basex-core/src/main/java/org/basex/gui/layout/BaseXKeys.java

@@ -92,7 +92,8 @@ public enum BaseXKeys {
   /** Match case.            */ MATCHCASE(SHIFT, VK_F4),
   /** Whole word.            */ WHOLEWORD(SHIFT, VK_F5),
   /** Regular expression.    */ REGEX(SHIFT, VK_F6),
-  /** Multi-line.            */ MULTILINE(SHIFT, VK_F7),
+  /** Dot matches newline.   */ DOTALL(SHIFT, VK_F7),
+  /** Replace all.           */ REPLACEALL(META | SHIFT, VK_R),
 
   // Font
 

basex-core/src/main/java/org/basex/gui/text/ReplaceContext.java

@@ -15,6 +15,8 @@
 final class ReplaceContext {
   /** Replace string. */
   private final String replace;
+  /** Replace only the first hit in the range (regex mode). */
+  private final boolean single;
   /** Text. */
   byte[] text;
 
@@ -23,7 +25,17 @@ final class ReplaceContext {
    * @param replace replacement text
    */
   ReplaceContext(final String replace) {
+    this(replace, false);
+  }
+
+  /**
+   * Constructor.
+   * @param replace replacement text
+   * @param single replace only the first hit in the range (regex mode)
+   */
+  ReplaceContext(final String replace, final boolean single) {
     this.replace = replace;
+    this.single = single;
   }
 
   /**
@@ -41,21 +53,9 @@ int[] replace(final SearchContext sc, final byte[] txt, final int start, final i
     } else {
       final TokenBuilder tb = new TokenBuilder(os).add(txt, 0, start);
       if(sc.regex) {
-        // regular expressions, ignoring position arrays
-        int flags = Pattern.DOTALL;
-        if(!sc.mcase) flags |= Pattern.CASE_INSENSITIVE;
-        final Pattern pattern = Pattern.compile(sc.string, flags);
-        if(sc.multi) {
-          tb.add(pattern.matcher(string(txt, start, end - start)).replaceAll(replace));
-        } else {
-          for(int e = start, s = start; e <= end; e++) {
-            if(e < end ? txt[e] == '\n' : e != s) {
-              tb.add(pattern.matcher(string(txt, s, e - s)).replaceAll(replace));
-              if(e < end) tb.add('\n');
-              s = e + 1;
-            }
-          }
-        }
+        // regular expressions, applied to the whole range (ignoring position arrays)
+        final Matcher matcher = sc.pattern.matcher(string(txt, start, end - start));
+        tb.add(single ? matcher.replaceFirst(replace) : matcher.replaceAll(replace));
       } else {
         final byte[] srch = token(sc.string);
         final byte[] rplc = token(replace);

basex-core/src/main/java/org/basex/gui/text/SearchBar.java

@@ -11,7 +11,6 @@
 import org.basex.gui.*;
 import org.basex.gui.layout.*;
 import org.basex.gui.listener.*;
-import org.basex.util.*;
 
 /**
  * This panel provides search and replace facilities.
@@ -36,8 +35,8 @@ public enum SearchDir {
   final AbstractButton mcase;
   /** Mode: whole word. */
   final AbstractButton word;
-  /** Mode: multi-line. */
-  final AbstractButton multi;
+  /** Mode: dot matches newline. */
+  final AbstractButton dotall;
   /** Action: replace. */
   private final AbstractButton rplc;
   /** Action: close. */
@@ -49,6 +48,12 @@ public enum SearchDir {
   private final BaseXCombo find;
   /** Replace text. */
   private final BaseXCombo replace;
+  /** Hit count label. */
+  private final BaseXLabel count;
+  /** Total number of hits ({@code -1} if no search is active). */
+  private int total = -1;
+  /** Whether the next refresh-driven jump should select its hit (set by {@link #replaceNext}). */
+  private boolean selectNext;
 
   /** Escape key listener. */
   private final KeyListener keys;
@@ -75,14 +80,16 @@ public enum SearchDir {
     find.hint(Text.FIND + "\u2026");
     replace = new BaseXCombo(gui, true).history(GUIOptions.REPLACED, gui.gopts);
     replace.hint(Text.REPLACE_WITH + "\u2026");
+    count = new BaseXLabel(" ");
 
     final ActionListener al = e -> search();
     mcase = button("f_case", BaseXLayout.addShortcut(Text.MATCH_CASE, MATCHCASE.toString()), al);
     word = button("f_word", BaseXLayout.addShortcut(Text.WHOLE_WORD, WHOLEWORD.toString()), al);
     regex = button("f_regex", BaseXLayout.addShortcut(Text.REGULAR_EXPR, REGEX.toString()), al);
-    multi = button("f_multi", BaseXLayout.addShortcut(Text.MULTI_LINE, MULTILINE.toString()), al);
+    dotall = button("f_dotall", BaseXLayout.addShortcut(Text.DOT_ALL, DOTALL.toString()), al);
 
-    rplc  = BaseXButton.get("f_replace", Text.REPLACE_ALL, false, gui);
+    rplc  = BaseXButton.get("f_replace", BaseXLayout.addShortcut(Text.REPLACE_ALL,
+        REPLACEALL.toString()), false, gui);
     rplc.setFocusable(true);
     cls = BaseXButton.get("f_close", BaseXLayout.addShortcut(Text.CLOSE, ESCAPE.toString()),
         false, gui);
@@ -106,9 +113,6 @@ public void keyPressed(final KeyEvent e) {
       public void keyReleased(final KeyEvent e) {
         final String srch = find.getText();
         if(!oldSearch.equals(srch)) {
-          if(regex.isEnabled() && find.getText().matches("^.*(?<!\\\\)\\\\n.*")) {
-            multi.setSelected(true);
-          }
           oldSearch = srch;
           search();
         }
@@ -121,28 +125,36 @@ public void keyReleased(final KeyEvent e) {
       search();
     });
 
+    // replace the current hit when Enter is pressed in the replace field
+    replace.addKeyListener(new KeyAdapter() {
+      @Override
+      public void keyPressed(final KeyEvent e) {
+        if(ENTER.is(e)) {
+          replace.updateHistory();
+          replaceNext();
+        }
+      }
+    });
+
     // add default shortcuts to all interaction components
     keys = (KeyPressedListener) e -> {
       if(ESCAPE.is(e)) deactivate(false);
       else if(MATCHCASE.is(e)) toggle(mcase);
       else if(WHOLEWORD.is(e)) toggle(word);
       else if(REGEX.is(e)) toggle(regex);
-      else if(MULTILINE.is(e)) toggle(multi);
+      else if(DOTALL.is(e)) toggle(dotall);
+      else if(REPLACEALL.is(e)) replaceAll();
     };
     mcase.addKeyListener(keys);
     word.addKeyListener(keys);
     regex.addKeyListener(keys);
-    multi.addKeyListener(keys);
+    dotall.addKeyListener(keys);
     find.addKeyListener(keys);
     replace.addKeyListener(keys);
     rplc.addKeyListener(keys);
     cls.addKeyListener(keys);
 
-    rplc.addActionListener(e -> {
-      deactivate(true);
-      final String in = replace.getText();
-      editor.replace(new ReplaceContext(regex.isSelected() ? decode(in) : in));
-    });
+    rplc.addActionListener(e -> replaceAll());
     cls.addActionListener(e -> deactivate(true));
 
     // set initial values
@@ -165,10 +177,14 @@ public void editor(final TextPanel text, final boolean srch) {
       west.add(mcase);
       west.add(word);
       west.add(regex);
-      west.add(multi);
+      west.add(dotall);
+
+      final BaseXBack found = new BaseXBack(false).layout(new BorderLayout(8, 0));
+      found.add(find, BorderLayout.CENTER);
+      found.add(count, BorderLayout.EAST);
 
       final BaseXBack center = new BaseXBack(false).layout(new GridLayout(1, 2, 2, 0));
-      center.add(find);
+      center.add(found);
       if(editable) center.add(replace);
 
       final BaseXToolBar east = new BaseXToolBar();
@@ -261,12 +277,43 @@ public void toggle(final AbstractButton button) {
     activate(find.getText(), false, true);
   }
 
+  /**
+   * Indicates whether the current hits can be replaced.
+   * @return result of check
+   */
+  public boolean replaceEnabled() {
+    return editor != null && editor.isEditable() && isVisible() && rplc.isEnabled();
+  }
+
+  /**
+   * Replaces all hits of the current search.
+   */
+  public void replaceAll() {
+    if(!replaceEnabled()) return;
+    deactivate(true);
+    final String in = replace.getText();
+    editor.replace(new ReplaceContext(regex.isSelected() ? normalize(in) : in));
+  }
+
+  /**
+   * Replaces the current hit and advances to the next one.
+   */
+  public void replaceNext() {
+    if(!replaceEnabled() || editor.editor.searchIndex() < 0) return;
+    final String in = replace.getText();
+    final boolean rgx = regex.isSelected();
+    if(editor.replaceNext(new ReplaceContext(rgx ? normalize(in) : in, true))) {
+      selectNext = true;
+      search();
+    }
+  }
+
   /**
    * Searches text in the current editor.
    */
   private void search() {
     final boolean sel = regex.isSelected();
-    multi.setEnabled(sel);
+    dotall.setEnabled(sel);
     word.setEnabled(!sel);
     search(true);
   }
@@ -280,8 +327,31 @@ void refresh(final SearchContext sc, final boolean jump) {
     final boolean hits = sc.nr != 0, empty = sc.string.isEmpty();
     rplc.setEnabled(hits && !empty);
     find.highlight(hits || empty);
-    if(isVisible()) gui.status.setText(Util.info(Text.STRINGS_FOUND_X, sc.nr()), true);
-    if(jump) editor.jump(SearchDir.CURRENT, false);
+    total = empty ? -1 : sc.nr;
+    count.setText(countText());
+    // a Replace Next selects the following hit; a plain search only repositions the view
+    final boolean select = selectNext;
+    selectNext = false;
+    if(jump) editor.jump(SearchDir.CURRENT, select);
+  }
+
+  /**
+   * Updates the hit count to the current navigation position.
+   */
+  void refreshCount() {
+    count.setText(countText());
+  }
+
+  /**
+   * Returns the hit count text ("N/M" with a trailing space, empty if no search is active).
+   * @return count text
+   */
+  private String countText() {
+    if(total < 0) return "";
+    int n = editor == null ? -1 : editor.editor.searchIndex();
+    if(n < 0 || n >= total) n = 0;
+    // count string: thin spaces (U+2009) around the slash, trailing space for padding
+    return (total == 0 ? 0 : n + 1) + "\u2009/\u2009" + total + " ";
   }
 
   // PRIVATE METHODS ==============================================================================
@@ -301,8 +371,17 @@ private void setSearch(final String text) {
    */
   private void search(final boolean jump) {
     final String text = isVisible() ? find.getText() : "";
-    if(!text.isEmpty()) gui.status.setText(Text.SEARCHING + Text.DOTS, true);
-    editor.search(new SearchContext(this, text), jump);
+    final SearchContext sc = new SearchContext(this, text);
+    if(sc.error != null) {
+      // invalid regular expression: highlight the field red, show the cause as its tooltip
+      find.highlight(false);
+      find.setToolTipText(sc.error);
+      total = -1;
+      count.setText("");
+    } else {
+      find.setToolTipText(Text.FIND + "\u2026");
+      editor.search(sc, jump);
+    }
   }
 
   /**
@@ -321,34 +400,50 @@ private AbstractButton button(final String icon, final String tooltip,
   }
 
   /**
-   * Decodes the specified string and replaces backslashed n's and t's with
-   * newlines and tab characters.
+   * Normalizes a regular-expression replacement string to a valid Java replacement.
+   * Supported: {@code \n}, {@code \t}, {@code \\}, {@code \$}, group references
+   * {@code $1}/{@code \1}/{@code ${name}}; a bare {@code $} is treated as literal.
    * @param in input
-   * @return decoded string
+   * @return normalized string
    */
-  private static String decode(final String in) {
+  static String normalize(final String in) {
     final StringBuilder sb = new StringBuilder();
-    boolean bs = false;
     final int is = in.length();
     for(int i = 0; i < is; i++) {
       final char ch = in.charAt(i);
-      if(bs) {
-        if(ch == 'n') {
-          sb.append('\n');
-        } else if(ch == 't') {
-          sb.append('\t');
+      if(ch == '\\') {
+        final char n = i + 1 < is ? in.charAt(++i) : 0;
+        if(n == 'n') sb.append('\n');
+        else if(n == 't') sb.append('\t');
+        else if(n == '\\') sb.append("\\\\");
+        else if(n == '$') sb.append("\\$");
+        else if(n >= '0' && n <= '9') sb.append('$').append(n);
+        else {
+          sb.append("\\\\");
+          if(n != 0) sb.append(n);
+        }
+      } else if(ch == '$') {
+        final char n = i + 1 < is ? in.charAt(i + 1) : 0;
+        if(n >= '0' && n <= '9') {
+          sb.append('$');
+        } else if(n == '{') {
+          // ${digits} -> $digits (numbered); ${name} passes through as a named reference
+          int k = i + 2;
+          while(k < is && in.charAt(k) != '}') k++;
+          final String name = in.substring(i + 2, Math.min(k, is));
+          if(k < is && !name.isEmpty() && name.chars().allMatch(Character::isDigit)) {
+            sb.append('$').append(name);
+            i = k;
+          } else {
+            sb.append('$');
+          }
         } else {
-          sb.append('\\');
-          if(ch != '\\') sb.append(ch);
+          sb.append("\\$");
         }
-        bs = false;
-      } else if(ch == '\\') {
-        bs = true;
       } else {
         sb.append(ch);
       }
     }
-    if(bs) sb.append('\\');
     return sb.toString();
   }
 }