Skip to content

Commit

Permalink
Split out the text searching into separate file.
Browse files Browse the repository at this point in the history 
#197
  • Loading branch information
@richrace
richrace committed Mar 17, 2019
1 parent e796c65 commit ba74245
Show file tree
Hide file tree
Showing 3 changed files with 226 additions and 214 deletions.
222 changes: 8 additions & 214 deletions lib/highlighted-area-view.js
View file
Original file line number Diff line number Diff line change
@@ -1,60 +1,13 @@
const { CompositeDisposable, Emitter } = require('atom');
const escapeRegExp = require('./utils/escape-reg-exp');
const getNonWordCharacters = require('./utils/non-word-characters');
const isWordSelected = require('./utils/is-word-selected');

class EarlyTerminationSignal extends Error {}
const SearchModel = require('./search-model');
const { getActiveEditor } = require('./utils/editor-finders');

module.exports = class HighlightedAreaView {
static getActiveEditor() {
return atom.workspace.getActiveTextEditor();
}

static getActiveEditors() {
return atom.workspace.getPanes().map(pane => {
const { activeItem } = pane;
if (activeItem && activeItem.constructor.name === 'TextEditor') {
return activeItem;
}
return null;
});
}

static makeClasses() {
let className = 'highlight-selected';
if (atom.config.get('highlight-selected.lightTheme')) {
className += ' light-theme';
}

if (atom.config.get('highlight-selected.highlightBackground')) {
className += ' background';
}
return className;
}

static showHighlightOnSelectedWord(range, selections) {
if (!atom.config.get('highlight-selected.hideHighlightOnSelectedWord')) {
return false;
}
let outcome = false;
for (let i = 0; i < selections.length; i += 1) {
const selection = selections[i];
const selectionRange = selection.getBufferRange();
outcome =
range.start.column === selectionRange.start.column &&
range.start.row === selectionRange.start.row &&
range.end.column === selectionRange.end.column &&
range.end.row === selectionRange.end.row;
if (outcome) {
break;
}
}
return outcome;
}

constructor() {
this.debouncedHandleSelection = this.debouncedHandleSelection.bind(this);

this.searchModel = new SearchModel(this);

this.emitter = new Emitter();
this.editorToMarkerLayerMap = {};
this.markerLayers = [];
Expand Down Expand Up @@ -139,7 +92,7 @@ module.exports = class HighlightedAreaView {
debouncedHandleSelection() {
clearTimeout(this.handleSelectionTimeout);
this.handleSelectionTimeout = setTimeout(() => {
this.handleSelection();
this.searchModel.handleSelection();
}, atom.config.get('highlight-selected.timeout'));
return this.handleSelectionTimeout;
}
Expand All @@ -155,7 +108,7 @@ module.exports = class HighlightedAreaView {
this.selectionSubscription.dispose();
}

const editor = HighlightedAreaView.getActiveEditor();
const editor = getActiveEditor();
if (!editor) {
return;
}
Expand All @@ -164,166 +117,7 @@ module.exports = class HighlightedAreaView {

this.selectionSubscription.add(editor.onDidAddSelection(this.debouncedHandleSelection));
this.selectionSubscription.add(editor.onDidChangeSelectionRange(this.debouncedHandleSelection));
this.handleSelection();
}

handleSelection() {
const editor = HighlightedAreaView.getActiveEditor();
if (!editor) {
return;
}

this.removeAllMarkers();

if (this.disabled) {
return;
}
if (editor.getLastSelection().isEmpty()) {
return;
}

this.selections = editor.getSelections();
const lastSelection = editor.getLastSelection();
const text = lastSelection.getText();

if (text.length < atom.config.get('highlight-selected.minimumLength')) {
return;
}
if (text.includes('\n')) {
return;
}
const regex = new RegExp('^\\s+$');
if (regex.test(text)) {
return;
}

let regexFlags = 'g';
if (atom.config.get('highlight-selected.ignoreCase')) {
regexFlags = 'gi';
}

let regexSearch = escapeRegExp(text);

if (atom.config.get('highlight-selected.onlyHighlightWholeWords')) {
if (!isWordSelected(editor, lastSelection)) {
return;
}
const selectionStart = lastSelection.getBufferRange().start;
const nonWordCharacters = getNonWordCharacters(editor, selectionStart);
const allowedCharactersToSelect = atom.config.get(
'highlight-selected.allowedCharactersToSelect'
);
const nonWordCharactersToStrip = nonWordCharacters.replace(
new RegExp(`[${allowedCharactersToSelect}]`, 'g'),
''
);
const regexForWholeWord = new RegExp(
`[ \\t${escapeRegExp(nonWordCharactersToStrip)}]`,
regexFlags
);
if (regexForWholeWord.test(text)) {
return;
}
regexSearch = `(?:[ \\t${escapeRegExp(
nonWordCharacters
)}]|^)(${regexSearch})(?:[ \\t${escapeRegExp(nonWordCharacters)}]|$)`;
}

this.resultCount = 0;
if (atom.config.get('highlight-selected.highlightInPanes')) {
const originalEditor = editor;
HighlightedAreaView.getActiveEditors().forEach(otherEditor => {
return this.highlightSelectionInEditor(
otherEditor,
regexSearch,
regexFlags,
originalEditor
);
});
} else {
this.highlightSelectionInEditor(editor, regexSearch, regexFlags);
}

this.emitter.emit('did-finish-adding-markers');
}

highlightSelectionInEditor(editor, regexSearch, regexFlags, originalEditor) {
if (!editor) {
return;
}
const maximumHighlights = atom.config.get('highlight-selected.maximumHighlights');
if (this.resultCount > maximumHighlights) {
return;
}

const markerLayers = this.editorToMarkerLayerMap[editor.id];
if (!markerLayers) {
return;
}
const markerLayer = markerLayers.visibleMarkerLayer;
const markerLayerForHiddenMarkers = markerLayers.selectedMarkerLayer;

// HACK: `editor.scan` is a synchronous process which iterates the entire buffer,
// executing a regex against every line and yielding each match. This can be
// costly for very large files with many matches.
//
// While we can and do limit the maximum number of highlight markers,
// `editor.scan` cannot be terminated early, meaning that we are forced to
// pay the cost of iterating every line in the file, running the regex, and
// returning matches, even if we shouldn't be creating any more markers.
//
// Instead, throw an exception. This isn't pretty, but it prevents the
// scan from running to completion unnecessarily.
try {
editor.scan(new RegExp(regexSearch, regexFlags), result => {
if (this.resultCount >= maximumHighlights) {
throw new EarlyTerminationSignal();
}

let newResult = result;
if (atom.config.get('highlight-selected.onlyHighlightWholeWords')) {
editor.scanInBufferRange(new RegExp(escapeRegExp(result.match[1])), result.range, e => {
newResult = e;
});
}

if (!newResult) {
return;
}
this.resultCount += 1;

const showHighlight = HighlightedAreaView.showHighlightOnSelectedWord(
newResult.range,
this.selections
);

if (showHighlight && originalEditor && originalEditor.id === editor.id) {
const marker = markerLayerForHiddenMarkers.markBufferRange(newResult.range);
this.emitter.emit('did-add-selected-marker', marker);
this.emitter.emit('did-add-selected-marker-for-editor', {
marker,
editor
});
} else {
const marker = markerLayer.markBufferRange(newResult.range);
this.emitter.emit('did-add-marker', marker);
this.emitter.emit('did-add-marker-for-editor', {
marker,
editor
});
}
});
} catch (error) {
if (!(error instanceof EarlyTerminationSignal)) {
// If this is an early termination, just continue on.
throw error;
}
}

editor.decorateMarkerLayer(markerLayer, {
type: 'highlight',
class: HighlightedAreaView.makeClasses()
});
this.searchModel.handleSelection();
}

removeAllMarkers() {
Expand All @@ -348,7 +142,7 @@ module.exports = class HighlightedAreaView {
}

selectAll() {
const editor = HighlightedAreaView.getActiveEditor();
const editor = getActiveEditor();
const markerLayers = this.editorToMarkerLayerMap[editor.id];
if (!markerLayers) {
return;
Expand Down
Loading

0 comments on commit ba74245

Please sign in to comment.