testing lntextedit

Author: psifertex

__init__.py

@@ -5,17 +5,19 @@
 import re
 import codecs
 from PySide2.QtWidgets import (QLineEdit, QPushButton, QApplication, QTextEdit, QWidget,
-    QVBoxLayout, QHBoxLayout, QDialog, QFileSystemModel, QTreeView, QLabel, QSplitter,
-    QInputDialog, QMessageBox, QHeaderView, QMenu, QAction, QKeySequenceEdit,
-    QPlainTextEdit)
+     QVBoxLayout, QHBoxLayout, QDialog, QFileSystemModel, QTreeView, QLabel, QSplitter,
+     QInputDialog, QMessageBox, QHeaderView, QMenu, QAction, QKeySequenceEdit,
+     QPlainTextEdit)
 from PySide2.QtCore import (QDir, QObject, Qt, QFileInfo, QItemSelectionModel, QSettings, QUrl)
 from PySide2.QtGui import (QFont, QFontMetrics, QDesktopServices, QKeySequence, QIcon)
 from binaryninja import user_plugin_path
 from binaryninja.plugin import PluginCommand, MainThreadActionHandler
 from binaryninja.mainthread import execute_on_main_thread
 from binaryninja.log import (log_error, log_debug)
-from binaryninjaui import (getMonospaceFont, UIAction, UIActionHandler, Menu, DockHandler)
+from binaryninjaui import (getMonospaceFont, UIAction, UIActionHandler, Menu, DockHandler,
+     getThemeColor, ThemeColor)
 import numbers
+from .lntextedit import LNTextEdit
 
 snippetPath = os.path.realpath(os.path.join(user_plugin_path(), "..", "snippets"))
 try:
@@ -33,6 +35,7 @@ def includeWalk(dir, includeExt):
                 filePaths.append(os.path.join(root, f))
     return filePaths
 
+
 def loadSnippetFromFile(snippetPath):
     try:
         snippetText = codecs.open(snippetPath, 'r', "utf-8").readlines()
@@ -49,6 +52,7 @@ def loadSnippetFromFile(snippetPath):
                 ''.join(snippetText[2:])
         )
 
+
 def actionFromSnippet(snippetName, snippetDescription):
     if not snippetDescription:
         shortName = os.path.basename(snippetName)
@@ -113,6 +117,7 @@ def executeSnippet(code, context):
     if snippetGlobals['current_address'] != context.address:
         context.binaryView.file.navigate(context.binaryView.file.view, snippetGlobals['current_address'])
 
+
 def makeSnippetFunction(code):
     return lambda context: executeSnippet(code, context)
 
@@ -135,8 +140,9 @@ def __init__(self, context, parent=None):
         self.browseButton.setIcon(QIcon.fromTheme("edit-undo"))
         self.deleteSnippetButton = QPushButton("Delete")
         self.newSnippetButton = QPushButton("New Snippet")
-        self.edit = QPlainTextEdit()
-        self.edit.setPlaceholderText("python code")
+        self.edit = LNTextEdit()
+        self.edit.edit.setPlaceholderText("python code")
+        self.edit.edit.highlight_color = getThemeColor(ThemeColor.SelectionColor)
         self.resetting = False
         self.columns = 3
         self.context = context
@@ -151,9 +157,9 @@ def __init__(self, context, parent=None):
 
         #Set Editbox Size
         font = getMonospaceFont(self)
-        self.edit.setFont(font)
+        self.edit.edit.setFont(font)
         font = QFontMetrics(font)
-        self.edit.setTabStopWidth(4 * font.width(' ')); #TODO, replace with settings API
+        self.edit.edit.setTabStopWidth(4 * font.width(' ')); #TODO, replace with settings API
 
         #Files
         self.files = QFileSystemModel()
@@ -240,9 +246,9 @@ def __init__(self, context, parent=None):
             if self.tree.selectionModel().hasSelection():
                 self.selectFile(self.tree.selectionModel().selection(), None)
                 self.edit.setFocus()
-                cursor = self.edit.textCursor()
-                cursor.setPosition(self.edit.document().characterCount()-1)
-                self.edit.setTextCursor(cursor)
+                cursor = self.edit.edit.textCursor()
+                cursor.setPosition(self.edit.edit.document().characterCount()-1)
+                self.edit.edit.setTextCursor(cursor)
             else:
                 self.readOnly(True)
         else:
@@ -276,7 +282,7 @@ def clearSelection(self):
         self.currentHotkeyLabel.setText("")
         self.currentFileLabel.setText("")
         self.snippetDescription.setText("")
-        self.edit.setPlainText("")
+        self.edit.edit.setPlainText("")
         self.currentFile = ""
 
     def reject(self):
@@ -331,7 +337,7 @@ def loadSnippet(self):
         (snippetDescription, snippetKeys, snippetCode) = loadSnippetFromFile(self.currentFile)
         self.snippetDescription.setText(snippetDescription) if snippetDescription else self.snippetDescription.setText("")
         self.keySequenceEdit.setKeySequence(snippetKeys) if snippetKeys else self.keySequenceEdit.setKeySequence(QKeySequence(""))
-        self.edit.setPlainText(snippetCode) if snippetCode else self.edit.setPlainText("")
+        self.edit.edit.setPlainText(snippetCode) if snippetCode else self.edit.edit.setPlainText("")
         self.readOnly(False)
 
     def newFileDialog(self):
@@ -353,7 +359,7 @@ def newFileDialog(self):
     def readOnly(self, flag):
         self.keySequenceEdit.setEnabled(not flag)
         self.snippetDescription.setReadOnly(flag)
-        self.edit.setReadOnly(flag)
+        self.edit.edit.setReadOnly(flag)
         if flag:
             self.snippetDescription.setDisabled(True)
             self.edit.setDisabled(True)
@@ -379,15 +385,15 @@ def snippetChanged(self):
             return True
         if snippetKeys != None and snippetKeys != self.keySequenceEdit.keySequence().toString():
             return True
-        return self.edit.toPlainText() != snippetCode or \
+        return self.edit.edit.toPlainText() != snippetCode or \
                self.snippetDescription.text() != snippetDescription
 
     def save(self):
         log_debug("Saving snippet %s" % self.currentFile)
         outputSnippet = codecs.open(self.currentFile, "w", "utf-8")
         outputSnippet.write("#" + self.snippetDescription.text() + "\n")
         outputSnippet.write("#" + self.keySequenceEdit.keySequence().toString() + "\n")
-        outputSnippet.write(self.edit.toPlainText())
+        outputSnippet.write(self.edit.edit.toPlainText())
         outputSnippet.close()
         self.registerAllSnippets()
 
@@ -408,17 +414,19 @@ def run(self):
         outputSnippet = codecs.open(self.currentFile, "w", "utf-8")
         outputSnippet.write("#" + self.snippetDescription.text() + "\n")
         outputSnippet.write("#" + self.keySequenceEdit.keySequence().toString() + "\n")
-        outputSnippet.write(self.edit.toPlainText())
+        outputSnippet.write(self.edit.edit.toPlainText())
         outputSnippet.close()
         self.registerAllSnippets()
 
     def clearHotkey(self):
         self.keySequenceEdit.clear()
 
+
 def launchPlugin(context):
     snippets = Snippets(context)
     snippets.exec_()
 
+
 if __name__ == '__main__':
     app = QApplication(sys.argv)
     snippets = Snippets(None)

lntextedit.py

@@ -0,0 +1,128 @@
+'''
+Text widget with support for line numbers
+Originally from: https://nachtimwald.com/2009/08/19/better-qplaintextedit-with-line-numbers/
+And available under the MIT license: https://nachtimwald.com/legal/
+Adapted to PySide2 by Vector 35
+'''
+from PySide2.QtWidgets import (QFrame, QHBoxLayout, QPlainTextEdit, QTextEdit, QWidget)
+from PySide2.QtGui import (QPainter, QTextFormat)
+from PySide2.QtCore import (QRect, Qt)
+from builtins import str as unicode
+
+class LNTextEdit(QFrame):
+
+    class NumberBar(QWidget):
+
+        def __init__(self, edit):
+            QWidget.__init__(self, edit)
+
+            self.edit = edit
+            self.adjustWidth(1)
+
+        def paintEvent(self, event):
+            self.edit.numberbarPaint(self, event)
+            QWidget.paintEvent(self, event)
+
+        def adjustWidth(self, count):
+            width = self.fontMetrics().width(unicode(count))
+            if self.width() != width:
+                self.setFixedWidth(width)
+
+        def updateContents(self, rect, scroll):
+            if scroll:
+                self.scroll(0, scroll)
+            else:
+                # It would be nice to do
+                # self.update(0, rect.y(), self.width(), rect.height())
+                # But we can't because it will not remove the bold on the
+                # current line if word wrap is enabled and a new block is
+                # selected.
+                self.update()
+
+
+    class PlainTextEdit(QPlainTextEdit):
+
+        def __init__(self, *args):
+            QPlainTextEdit.__init__(self, *args)
+            self.highlight_color = self.palette().alternateBase()
+
+            #self.setFrameStyle(QFrame.NoFrame)
+
+            self.setFrameStyle(QFrame.NoFrame)
+            self.highlight()
+            #self.setLineWrapMode(QPlainTextEdit.NoWrap)
+
+            self.cursorPositionChanged.connect(self.highlight)
+
+        def highlight(self):
+            hi_selection = QTextEdit.ExtraSelection()
+
+            hi_selection.format.setBackground(self.highlight_color)
+            hi_selection.format.setProperty(QTextFormat.FullWidthSelection, True)
+            hi_selection.cursor = self.textCursor()
+            hi_selection.cursor.clearSelection()
+
+            self.setExtraSelections([hi_selection])
+
+        def numberbarPaint(self, number_bar, event):
+            font_metrics = self.fontMetrics()
+            current_line = self.document().findBlock(self.textCursor().position()).blockNumber() + 1
+
+            block = self.firstVisibleBlock()
+            line_count = block.blockNumber()
+            painter = QPainter(number_bar)
+            painter.fillRect(event.rect(), self.palette().base())
+
+            # Iterate over all visible text blocks in the document.
+            while block.isValid():
+                line_count += 1
+                block_top = self.blockBoundingGeometry(block).translated(self.contentOffset()).top()
+
+                # Check if the position of the block is out side of the visible
+                # area.
+                if not block.isVisible() or block_top >= event.rect().bottom():
+                    break
+
+                # We want the line number for the selected line to be bold.
+                if line_count == current_line:
+                    font = painter.font()
+                    font.setBold(True)
+                    painter.setFont(font)
+                else:
+                    font = painter.font()
+                    font.setBold(False)
+                    painter.setFont(font)
+
+                # Draw the line number right justified at the position of the line.
+                paint_rect = QRect(0, block_top, number_bar.width(), font_metrics.height())
+                painter.drawText(paint_rect, Qt.AlignRight, unicode(line_count))
+
+                block = block.next()
+
+            painter.end()
+
+    def __init__(self, *args):
+        QFrame.__init__(self, *args)
+
+        self.setFrameStyle(QFrame.StyledPanel | QFrame.Sunken)
+
+        self.edit = self.PlainTextEdit()
+        self.number_bar = self.NumberBar(self.edit)
+
+        hbox = QHBoxLayout(self)
+        hbox.setSpacing(0)
+        hbox.setMargin(0)
+        hbox.addWidget(self.number_bar)
+        hbox.addWidget(self.edit)
+
+        self.edit.blockCountChanged.connect(self.number_bar.adjustWidth)
+        self.edit.updateRequest.connect(self.number_bar.updateContents)
+
+    def isModified(self):
+        return self.edit.document().isModified()
+
+    def setModified(self, modified):
+        self.edit.document().setModified(modified)
+
+    def setLineWrapMode(self, mode):
+        self.edit.setLineWrapMode(mode)