smc-search.js

/*
 *  This file is part of CoCalc: Copyright © 2020 Sagemath, Inc.
 *  License: MS-RSL – see LICENSE.md for details
 */

// CodeMirror, copyright (c) by Marijn Haverbeke and others
// Distributed under an MIT license: http://codemirror.net/LICENSE

// Define search commands. Depends on dialog.js or another
// implementation of the openDialog method.

// Replace works a little oddly -- it will do the replace on the next
// Ctrl-G (or whatever is bound to findNext) press. You prevent a
// replace by making sure the match is no longer selected when hitting
// Ctrl-G.


"use strict";

import * as CodeMirror from "codemirror";

function searchOverlay(query, caseInsensitive) {
  if (typeof query == "string")
    query = new RegExp(query.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, "\\$&"), caseInsensitive ? "gi" : "g");
  else if (!query.global)
    query = new RegExp(query.source, query.ignoreCase ? "gi" : "g");

  return {token: function(stream) {
    query.lastIndex = stream.pos;
    var match = query.exec(stream.string);
    if (match && match.index == stream.pos) {
      stream.pos += match[0].length || 1;
      return "searching";
    } else if (match) {
      stream.pos = match.index;
    } else {
      stream.skipToEnd();
    }
  }};
}

function SearchState() {
  this.posFrom = this.posTo = this.lastQuery = this.query = null;
  this.overlay = null;
}

function getSearchState(cm) {
  return cm.state.search || (cm.state.search = new SearchState());
}

function queryCaseInsensitive(query) {
  return typeof query == "string" && query == query.toLowerCase();
}

function getSearchCursor(cm, query, pos) {
  // Heuristic: if the query string is all lowercase, do a case insensitive search.
  return cm.getSearchCursor(query, pos, queryCaseInsensitive(query));
}

function persistentDialog(cm, text, deflt, onEnter, onKeyDown) {
  cm.openDialog(text, onEnter, {
    value: deflt,
    selectValueOnOpen: true,
    closeOnEnter: false,
    onClose: function() { clearSearch(cm); },
    onKeyDown: onKeyDown
  });
}

function dialog(cm, text, shortText, deflt, f) {
  if (cm.openDialog) cm.openDialog(text, f, {value: deflt, selectValueOnOpen: true});
  else f(prompt(shortText, deflt));
}

function confirmDialog(cm, text, shortText, fs) {
  if (cm.openConfirm) cm.openConfirm(text, fs);
  else if (confirm(shortText)) fs[0]();
}

function parseString(string) {
  return string.replace(/\\(.)/g, function(_, ch) {
    if (ch == "n") return "\n"
    if (ch == "r") return "\r"
    return ch
  })
}

function parseQuery(query) {
  var isRE = query.match(/^\/(.*)\/([a-z]*)$/);
  if (isRE) {
    try { query = new RegExp(isRE[1], isRE[2].indexOf("i") == -1 ? "" : "i"); }
    catch(e) {} // Not a regular expression after all, do a string search
  } else {
    query = parseString(query)
  }
  if (typeof query == "string" ? query == "" : query.test(""))
    query = /x^/;
  return query;
}

if(navigator.platform == "MacIntel") {
    var queryDialog =
      'Search: <input type="text" style="width: 10em" class="CodeMirror-search-field"/> <span style="color: #666" class="CodeMirror-search-hint">Next (⌘-G) and Prev (Shift-⌘-G).  Use /re/ for regular expression.';
} else {
    var queryDialog =
      'Search: <input type="text" style="width: 10em" class="CodeMirror-search-field"/> <span style="color: #666" class="CodeMirror-search-hint">Next (Ctrl-G) and Prev (Shift-Ctrl-G).  Use /re/ for regular expression.';
}

function startSearch(cm, state, query) {
  state.queryText = query;
  state.query = parseQuery(query);
  cm.removeOverlay(state.overlay, queryCaseInsensitive(state.query));
  state.overlay = searchOverlay(state.query, queryCaseInsensitive(state.query));
  cm.addOverlay(state.overlay);
  if (cm.showMatchesOnScrollbar) {
    if (state.annotate) { state.annotate.clear(); state.annotate = null; }
    state.annotate = cm.showMatchesOnScrollbar(state.query, queryCaseInsensitive(state.query));
  }
}

function doSearch(cm, rev, persistent, immediate) {
  var state = getSearchState(cm);
  if (state.query) return findNext(cm, rev);
  var q = cm.getSelection() || state.lastQuery;
  if (persistent && cm.openDialog) {
    var hiding = null
    var searchNext = function(query, event) {
      CodeMirror.e_stop(event);
      if (!query) return;
      if (query != state.queryText) {
        startSearch(cm, state, query);
        state.posFrom = state.posTo = cm.getCursor();
      }
      if (hiding) hiding.style.opacity = 1
      findNext(cm, event.shiftKey, function(_, to) {
        var dialog
        if (to.line < 3 && document.querySelector &&
            (dialog = cm.display.wrapper.querySelector(".CodeMirror-dialog")) &&
            dialog.getBoundingClientRect().bottom - 4 > cm.cursorCoords(to, "window").top)
          (hiding = dialog).style.opacity = .4
      })
    };
    persistentDialog(cm, queryDialog, q, searchNext, function(event, query) {
      var keyName = CodeMirror.keyName(event)
      var cmd = CodeMirror.keyMap[cm.getOption("keyMap")][keyName]
      if (!cmd) cmd = cm.getOption('extraKeys')[keyName]
      if (cmd == "findNext" || cmd == "findPrev" ||
        cmd == "findPersistentNext" || cmd == "findPersistentPrev") {
        CodeMirror.e_stop(event);
        startSearch(cm, getSearchState(cm), query);
        cm.execCommand(cmd);
      } else if (cmd == "find" || cmd == "findPersistent") {
        CodeMirror.e_stop(event);
        searchNext(query, event);
      }
    });
    if (immediate && q) {
      startSearch(cm, state, q);
      findNext(cm, rev);
    }
  } else {
    dialog(cm, queryDialog, "Search for:", q, function(query) {
      if (query && !state.query) cm.operation(function() {
        startSearch(cm, state, query);
        state.posFrom = state.posTo = cm.getCursor();
        findNext(cm, rev);
      });
    });
  }
}

/* Return true if the given position is part of a collapsed mark.
   See https://github.com/sagemathinc/cocalc/issues/522
   We need this since codemirror's own search doesn't ignore
   collapsed ranges, e.g., the output in sage worksheets.
*/
function isCollapsedPos(cm, pos) {
  var marks = cm.findMarksAt(pos);
  for(var i=0; i<marks.length; i++) {
    if(marks[i].collapsed) {
      return true;
    }
  }
  return false;
}

function findNext(cm, rev, callback) {cm.operation(function() {
  var state = getSearchState(cm);
  var cursor = getSearchCursor(cm, state.query, rev ? state.posFrom : state.posTo);
  if (!cursor.find(rev)) {
    cursor = getSearchCursor(cm, state.query, rev ? CodeMirror.Pos(cm.lastLine()) : CodeMirror.Pos(cm.firstLine(), 0));
    if (!cursor.find(rev)) {
        state.init = false;
        return;
    }
  }
  cm.setSelection(cursor.from(), cursor.to());
  cm.scrollIntoView({from: cursor.from(), to: cursor.to()}, 20);
  state.posFrom = cursor.from(); state.posTo = cursor.to();

  if (isCollapsedPos(cm, state.posFrom) &&
      (!state.init || (state.init.ch != state.posFrom.ch || state.init.line != state.posFrom.line))) {
    /* In a collapsed range -- try again.  This won't lead to an infinite loop in case
       of no , since that's handled by the "if (!cursor.find(rev))" above and only_one below. */
    if (!state.init) {
      state.init = {line:state.posFrom.line, ch:state.posFrom.ch};
    }
    findNext(cm, rev, callback);
    return
  }
  state.init = false;
  if (callback) callback(cursor.from(), cursor.to())
});}



function clearSearch(cm) {cm.operation(function() {
  var state = getSearchState(cm);
  state.lastQuery = state.query;
  if (!state.query) return;
  state.query = state.queryText = null;
  cm.removeOverlay(state.overlay);
  if (state.annotate) { state.annotate.clear(); state.annotate = null; }
});}

var replaceQueryDialog =
  ' <input type="text" style="width: 10em" class="CodeMirror-search-field"/> <span style="color: #666" class="CodeMirror-search-hint">Hit enter (use /re/ syntax for regular expression search)</span>';
var replacementQueryDialog = 'With: <input type="text" style="width: 10em" class="CodeMirror-search-field"/>';
var doReplaceConfirm = "Replace? <button>Yes</button> <button>No</button> <button>All</button> <button>Stop</button>";

function replaceAll(cm, query, text) {
  cm.operation(function() {
    for (var cursor = getSearchCursor(cm, query); cursor.findNext();) {
      if (isCollapsedPos(cm, cursor.from())) {
          /* ignore when cursor starts in a collapsed range. */
          continue;
      }
      if (typeof query != "string") {
        var match = cm.getRange(cursor.from(), cursor.to()).match(query);
        cursor.replace(text.replace(/\$(\d)/g, function(_, i) {return match[i];}));
      } else cursor.replace(text);
    }
  });
}

function replace(cm, all) {
  if (cm.getOption("readOnly")) return;
  var query = cm.getSelection() || getSearchState(cm).lastQuery;
  var dialogText = all ? "Replace all:" : "Replace:"
  dialog(cm, dialogText + replaceQueryDialog, dialogText, query, function(query) {
    if (!query) return;
    query = parseQuery(query);
    dialog(cm, replacementQueryDialog, "Replace with:", "", function(text) {
      text = parseString(text)
      if (all) {
        replaceAll(cm, query, text)
      } else {
        clearSearch(cm);
        var cursor = getSearchCursor(cm, query, cm.getCursor("from"));
        var init = false;
        var advance = function() {
          var start = cursor.from(), match;
          if (!(match = cursor.findNext())) {
            cursor = getSearchCursor(cm, query);
            if (!(match = cursor.findNext()) ||
                (start && cursor.from().line == start.line && cursor.from().ch == start.ch))
            { init = false;
              return; }
          }
          cm.setSelection(cursor.from(), cursor.to());
          cm.scrollIntoView({from: cursor.from(), to: cursor.to()});

          /* search again when cursor is in a collapsed range. */
          var pos = cursor.from();
          if (isCollapsedPos(cm, pos) &&
              (!init || (init.ch != pos.ch || init.line != pos.line))) {
              if (!init) {
                init = {line:pos.line, ch:pos.ch};
              }
              advance();
              return;
          }

          init = false;
          confirmDialog(cm, doReplaceConfirm, "Replace?",
                        [function() {doReplace(match);}, advance,
                         function() {replaceAll(cm, query, text)}]);
        };
        var doReplace = function(match) {
          cursor.replace(typeof query == "string" ? text :
                         text.replace(/\$(\d)/g, function(_, i) {return match[i];}));
          advance();
        };
        advance();
      }
    });
  });
}

CodeMirror.commands.find = function(cm) {clearSearch(cm); doSearch(cm);};
CodeMirror.commands.findNext = doSearch;
CodeMirror.commands.findPrev = function(cm) {doSearch(cm, true);};

CodeMirror.commands.findPersistent = function(cm) {clearSearch(cm); doSearch(cm, false, true);};
CodeMirror.commands.findPersistentNext = function(cm) {doSearch(cm, false, true, true);};
CodeMirror.commands.findPersistentPrev = function(cm) {doSearch(cm, true, true, true);};

CodeMirror.commands.findPersistent = function(cm) {clearSearch(cm); doSearch(cm, false, true);};
CodeMirror.commands.findPersistentNext = function(cm) {doSearch(cm, false, true, true);};
CodeMirror.commands.findPersistentPrev = function(cm) {doSearch(cm, true, true, true);};

CodeMirror.commands.clearSearch = clearSearch;
CodeMirror.commands.replace = replace;
CodeMirror.commands.replaceAll = function(cm) {replace(cm, true);};