-
Notifications
You must be signed in to change notification settings - Fork 755
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #245 from KostkaBrukowa/VIM-1970
VIM-1970 | Working solution of plugin vim-highlightedyank
- Loading branch information
Showing
9 changed files
with
474 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
196 changes: 196 additions & 0 deletions
196
src/com/maddyhome/idea/vim/extension/highlightedyank/VimHighlightedYank.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,196 @@ | ||
| /* | ||
| * IdeaVim - Vim emulator for IDEs based on the IntelliJ platform | ||
| * Copyright (C) 2003-2020 The IdeaVim authors | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU General Public License as published by | ||
| * the Free Software Foundation, either version 2 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU General Public License | ||
| * along with this program. If not, see <https://www.gnu.org/licenses/>. | ||
| */ | ||
|
|
||
| package com.maddyhome.idea.vim.extension.highlightedyank | ||
|
|
||
| import com.intellij.openapi.Disposable | ||
| import com.intellij.openapi.application.ApplicationManager | ||
| import com.intellij.openapi.editor.Editor | ||
| import com.intellij.openapi.editor.colors.EditorColors | ||
| import com.intellij.openapi.editor.markup.EffectType | ||
| import com.intellij.openapi.editor.markup.HighlighterLayer | ||
| import com.intellij.openapi.editor.markup.HighlighterTargetArea | ||
| import com.intellij.openapi.editor.markup.RangeHighlighter | ||
| import com.intellij.openapi.editor.markup.TextAttributes | ||
| import com.intellij.openapi.util.Disposer | ||
| import com.maddyhome.idea.vim.VimPlugin | ||
| import com.maddyhome.idea.vim.VimProjectService | ||
| import com.maddyhome.idea.vim.common.TextRange | ||
| import com.maddyhome.idea.vim.ex.vimscript.VimScriptGlobalEnvironment | ||
| import com.maddyhome.idea.vim.extension.VimExtension | ||
| import com.maddyhome.idea.vim.listener.VimInsertListener | ||
| import com.maddyhome.idea.vim.listener.VimYankListener | ||
| import com.maddyhome.idea.vim.option.StrictMode | ||
| import java.awt.Color | ||
| import java.awt.Font | ||
| import java.util.concurrent.Executors | ||
| import java.util.concurrent.TimeUnit | ||
|
|
||
| const val DEFAULT_HIGHLIGHT_DURATION: Long = 300 | ||
| private const val HIGHLIGHT_DURATION_VARIABLE_NAME = "g:highlightedyank_highlight_duration" | ||
| private const val HIGHLIGHT_COLOR_VARIABLE_NAME = "g:highlightedyank_highlight_color" | ||
| private val DEFAULT_HIGHLIGHT_TEXT_COLOR: Color = EditorColors.TEXT_SEARCH_RESULT_ATTRIBUTES.defaultAttributes.backgroundColor | ||
|
|
||
|
|
||
| /** | ||
| * @author KostkaBrukowa (@kostkabrukowa) | ||
| * | ||
| * Port of vim-highlightedyank | ||
| * See https://github.com/machakann/vim-highlightedyank | ||
| * | ||
| * if you want to optimize highlight duration, use g:highlightedyank_highlight_duration. Assign a time in milliseconds. | ||
| * | ||
| * let g:highlightedyank_highlight_duration = "1000" | ||
| * | ||
| * A negative number makes the highlight persistent. | ||
| * let g:highlightedyank_highlight_duration = "-1" | ||
| * | ||
| * if you want to change background color of highlight you can provide the rgba of the color you want e.g. | ||
| * let g:highlightedyank_highlight_color = "rgba(160, 160, 160, 155)" | ||
| * | ||
| * When a new text is yanked or user starts editing, the old highlighting would be deleted. | ||
| */ | ||
| class VimHighlightedYank: VimExtension, VimYankListener, VimInsertListener { | ||
| private val highlightHandler = HighlightHandler() | ||
|
|
||
| override fun getName() = "highlightedyank" | ||
|
|
||
| override fun init() { | ||
| VimPlugin.getYank().addListener(this) | ||
| VimPlugin.getChange().addInsertListener(this) | ||
| } | ||
|
|
||
| override fun dispose() { | ||
| VimPlugin.getYank().removeListener(this) | ||
| VimPlugin.getChange().removeInsertListener(this) | ||
| } | ||
|
|
||
| override fun yankPerformed(editor: Editor, range: TextRange) { | ||
| highlightHandler.highlightYankRange(editor, range) | ||
| } | ||
|
|
||
| override fun insertModeStarted(editor: Editor) { | ||
| highlightHandler.clearAllYankHighlighters() | ||
| } | ||
|
|
||
| private class HighlightHandler { | ||
| private var editor: Editor? = null | ||
| private val yankHighlighters: MutableSet<RangeHighlighter> = mutableSetOf() | ||
|
|
||
| fun highlightYankRange(editor: Editor, range: TextRange) { | ||
| //from vim-highlightedyank docs: When a new text is yanked or user starts editing, the old highlighting would be deleted | ||
| clearAllYankHighlighters() | ||
|
|
||
| this.editor = editor | ||
| val project = editor.project | ||
| if (project != null) { | ||
| Disposer.register(VimProjectService.getInstance(project), Disposable { | ||
| this.editor = null | ||
| yankHighlighters.clear() | ||
| }) | ||
| } | ||
|
|
||
| if (range.isMultiple) { | ||
| for (i in 0 until range.size()) { | ||
| highlightSingleRange(editor, range.startOffsets[i]..range.endOffsets[i]) | ||
| } | ||
| } else { | ||
| highlightSingleRange(editor, range.startOffset..range.endOffset) | ||
| } | ||
| } | ||
|
|
||
| fun clearAllYankHighlighters() { | ||
| yankHighlighters.forEach { highlighter -> | ||
| editor?.markupModel?.removeHighlighter(highlighter) ?: StrictMode.fail("Highlighters without an editor") | ||
| } | ||
|
|
||
| yankHighlighters.clear() | ||
| } | ||
|
|
||
| private fun highlightSingleRange(editor: Editor, range: ClosedRange<Int>) { | ||
| val highlighter = editor.markupModel.addRangeHighlighter( | ||
| range.start, | ||
| range.endInclusive, | ||
| HighlighterLayer.SELECTION, | ||
| getHighlightTextAttributes(), | ||
| HighlighterTargetArea.EXACT_RANGE | ||
| ) | ||
|
|
||
| yankHighlighters.add(highlighter) | ||
|
|
||
| setClearHighlightRangeTimer(highlighter) | ||
| } | ||
|
|
||
| private fun setClearHighlightRangeTimer(highlighter: RangeHighlighter) { | ||
| val timeout = extractUsersHighlightDuration() | ||
|
|
||
| //from vim-highlightedyank docs: A negative number makes the highlight persistent. | ||
| if(timeout >= 0) { | ||
| Executors.newSingleThreadScheduledExecutor().schedule({ | ||
| ApplicationManager.getApplication().invokeLater { | ||
| editor?.markupModel?.removeHighlighter(highlighter) ?: StrictMode.fail("Highlighters without an editor") | ||
| } | ||
| }, timeout, TimeUnit.MILLISECONDS) | ||
| } | ||
| } | ||
|
|
||
| private fun getHighlightTextAttributes() = TextAttributes( | ||
| null, | ||
| extractUsersHighlightColor(), | ||
| editor?.colorsScheme?.getColor(EditorColors.CARET_COLOR), | ||
| EffectType.SEARCH_MATCH, | ||
| Font.PLAIN | ||
| ) | ||
|
|
||
| private fun extractUsersHighlightDuration(): Long { | ||
| return extractVariable(HIGHLIGHT_DURATION_VARIABLE_NAME, DEFAULT_HIGHLIGHT_DURATION) { | ||
| it.toLong() | ||
| } | ||
| } | ||
|
|
||
| private fun extractUsersHighlightColor(): Color { | ||
| return extractVariable(HIGHLIGHT_COLOR_VARIABLE_NAME, DEFAULT_HIGHLIGHT_TEXT_COLOR) { value -> | ||
| val rgba = value | ||
| .substring(4) | ||
| .filter { it != '(' && it != ')' && !it.isWhitespace() } | ||
| .split(',') | ||
| .map { it.toInt() } | ||
|
|
||
| Color(rgba[0], rgba[1], rgba[2], rgba[3]) | ||
| } | ||
| } | ||
|
|
||
| private fun<T> extractVariable(variableName: String, default: T, extractFun: (value: String) -> T): T { | ||
| val env = VimScriptGlobalEnvironment.getInstance() | ||
| val value = env.variables[variableName] | ||
|
|
||
| if(value is String) { | ||
| return try { | ||
| extractFun(value) | ||
| } | ||
| catch (e: Exception){ | ||
| VimPlugin.showMessage("highlightedyank: Invalid value of $variableName -- ${e.message}") | ||
|
|
||
| default | ||
| } | ||
| } | ||
|
|
||
| return default | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| /* | ||
| * IdeaVim - Vim emulator for IDEs based on the IntelliJ platform | ||
| * Copyright (C) 2003-2020 The IdeaVim authors | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU General Public License as published by | ||
| * the Free Software Foundation, either version 2 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU General Public License | ||
| * along with this program. If not, see <https://www.gnu.org/licenses/>. | ||
| */ | ||
|
|
||
| package com.maddyhome.idea.vim.listener | ||
|
|
||
| import com.intellij.openapi.editor.Editor | ||
|
|
||
| interface VimInsertListener { | ||
| fun insertModeStarted(editor: Editor) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| /* | ||
| * IdeaVim - Vim emulator for IDEs based on the IntelliJ platform | ||
| * Copyright (C) 2003-2020 The IdeaVim authors | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU General Public License as published by | ||
| * the Free Software Foundation, either version 2 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU General Public License | ||
| * along with this program. If not, see <https://www.gnu.org/licenses/>. | ||
| */ | ||
|
|
||
| package com.maddyhome.idea.vim.listener | ||
|
|
||
| import com.intellij.openapi.editor.Editor | ||
| import com.maddyhome.idea.vim.common.TextRange | ||
|
|
||
| interface VimYankListener { | ||
| fun yankPerformed(editor: Editor, range: TextRange) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.