Plugins/VcsPlugins/vcsGit/GitBisectLogBrowserDialog.py

changeset 6020
baf6da1ae288
child 6048
82ad8ec9548c
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Plugins/VcsPlugins/vcsGit/GitBisectLogBrowserDialog.py	Sun Dec 10 17:42:11 2017 +0100
@@ -0,0 +1,376 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2014 - 2017 Detlev Offenbach <detlev@die-offenbachs.de>
+#
+
+"""
+Module implementing a dialog to browse the bisect log history.
+"""
+
+from __future__ import unicode_literals
+try:
+    str = unicode
+except NameError:
+    pass
+
+import os
+
+from PyQt5.QtCore import pyqtSlot, Qt, QPoint, QProcess, QTimer
+from PyQt5.QtGui import QCursor
+from PyQt5.QtWidgets import QWidget, QDialogButtonBox, QHeaderView, \
+    QTreeWidgetItem, QApplication, QLineEdit
+
+from E5Gui import E5MessageBox
+
+from .Ui_GitBisectLogBrowserDialog import Ui_GitBisectLogBrowserDialog
+
+from .GitUtilities import strToQByteArray
+
+import Preferences
+
+
+class GitBisectLogBrowserDialog(QWidget, Ui_GitBisectLogBrowserDialog):
+    """
+    Class implementing a dialog to browse the bisect log history.
+    """
+    CommitIdColumn = 0
+    OperationColumn = 1
+    SubjectColumn = 2
+    
+    def __init__(self, vcs, parent=None):
+        """
+        Constructor
+        
+        @param vcs reference to the vcs object
+        @param parent reference to the parent widget (QWidget)
+        """
+        super(GitBisectLogBrowserDialog, self).__init__(parent)
+        self.setupUi(self)
+        
+        self.__position = QPoint()
+        
+        self.buttonBox.button(QDialogButtonBox.Close).setEnabled(False)
+        self.buttonBox.button(QDialogButtonBox.Cancel).setDefault(True)
+        
+        self.logTree.headerItem().setText(self.logTree.columnCount(), "")
+        
+        self.refreshButton = self.buttonBox.addButton(
+            self.tr("&Refresh"), QDialogButtonBox.ActionRole)
+        self.refreshButton.setToolTip(
+            self.tr("Press to refresh the list of commits"))
+        self.refreshButton.setEnabled(False)
+        
+        self.vcs = vcs
+        
+        self.repodir = ""
+        self.__currentCommitId = ""
+        
+        self.__initData()
+        self.__resetUI()
+        
+        self.process = QProcess()
+        self.process.finished.connect(self.__procFinished)
+        self.process.readyReadStandardOutput.connect(self.__readStdout)
+        self.process.readyReadStandardError.connect(self.__readStderr)
+    
+    def __initData(self):
+        """
+        Private method to (re-)initialize some data.
+        """
+        self.buf = []        # buffer for stdout
+    
+    def closeEvent(self, e):
+        """
+        Protected slot implementing a close event handler.
+        
+        @param e close event (QCloseEvent)
+        """
+        if self.process is not None and \
+           self.process.state() != QProcess.NotRunning:
+            self.process.terminate()
+            QTimer.singleShot(2000, self.process.kill)
+            self.process.waitForFinished(3000)
+        
+        self.__position = self.pos()
+        
+        e.accept()
+    
+    def show(self):
+        """
+        Public slot to show the dialog.
+        """
+        if not self.__position.isNull():
+            self.move(self.__position)
+        self.__resetUI()
+        
+        super(GitBisectLogBrowserDialog, self).show()
+    
+    def __resetUI(self):
+        """
+        Private method to reset the user interface.
+        """
+        self.logTree.clear()
+    
+    def __resizeColumnsLog(self):
+        """
+        Private method to resize the log tree columns.
+        """
+        self.logTree.header().resizeSections(QHeaderView.ResizeToContents)
+        self.logTree.header().setStretchLastSection(True)
+    
+    def __generateLogItem(self, commitId, operation, subject):
+        """
+        Private method to generate a bisect log tree entry.
+        
+        @param commitId commit id info (string)
+        @param operation bisect operation (string)
+        @param subject subject of the bisect log entry (string)
+        @return reference to the generated item (QTreeWidgetItem)
+        """
+        columnLabels = [
+            commitId,
+            operation,
+            subject,
+        ]
+        itm = QTreeWidgetItem(self.logTree, columnLabels)
+        return itm
+    
+    def __getLogEntries(self):
+        """
+        Private method to retrieve bisect log entries from the repository.
+        """
+        self.buttonBox.button(QDialogButtonBox.Close).setEnabled(False)
+        self.buttonBox.button(QDialogButtonBox.Cancel).setEnabled(True)
+        self.buttonBox.button(QDialogButtonBox.Cancel).setDefault(True)
+        
+        self.inputGroup.setEnabled(True)
+        self.inputGroup.show()
+        self.refreshButton.setEnabled(False)
+        
+        QApplication.setOverrideCursor(QCursor(Qt.WaitCursor))
+        QApplication.processEvents()
+        
+        self.buf = []
+        self.cancelled = False
+        self.errors.clear()
+        self.intercept = False
+        
+        args = self.vcs.initCommand("bisect")
+        args.append("log")
+        
+        self.process.kill()
+        
+        self.process.setWorkingDirectory(self.repodir)
+        
+        self.inputGroup.setEnabled(True)
+        self.inputGroup.show()
+        
+        self.process.start('git', args)
+        procStarted = self.process.waitForStarted(5000)
+        if not procStarted:
+            self.inputGroup.setEnabled(False)
+            self.inputGroup.hide()
+            E5MessageBox.critical(
+                self,
+                self.tr('Process Generation Error'),
+                self.tr(
+                    'The process {0} could not be started. '
+                    'Ensure, that it is in the search path.'
+                ).format('git'))
+    
+    def start(self, projectdir):
+        """
+        Public slot to start the git bisect log command.
+        
+        @param projectdir directory name of the project (string)
+        """
+        self.errorGroup.hide()
+        QApplication.processEvents()
+        
+        self.__initData()
+        
+        # find the root of the repo
+        self.repodir = projectdir
+        while not os.path.isdir(os.path.join(self.repodir, self.vcs.adminDir)):
+            self.repodir = os.path.dirname(self.repodir)
+            if os.path.splitdrive(self.repodir)[1] == os.sep:
+                return
+        
+        self.activateWindow()
+        self.raise_()
+        
+        self.logTree.clear()
+        self.__getLogEntries()
+    
+    def __procFinished(self, exitCode, exitStatus):
+        """
+        Private slot connected to the finished signal.
+        
+        @param exitCode exit code of the process (integer)
+        @param exitStatus exit status of the process (QProcess.ExitStatus)
+        """
+        self.__processBuffer()
+        self.__finish()
+    
+    def __finish(self):
+        """
+        Private slot called when the process finished or the user pressed
+        the button.
+        """
+        if self.process is not None and \
+           self.process.state() != QProcess.NotRunning:
+            self.process.terminate()
+            QTimer.singleShot(2000, self.process.kill)
+            self.process.waitForFinished(3000)
+        
+        QApplication.restoreOverrideCursor()
+        
+        self.buttonBox.button(QDialogButtonBox.Close).setEnabled(True)
+        self.buttonBox.button(QDialogButtonBox.Cancel).setEnabled(False)
+        self.buttonBox.button(QDialogButtonBox.Close).setDefault(True)
+        
+        self.inputGroup.setEnabled(False)
+        self.inputGroup.hide()
+        self.refreshButton.setEnabled(True)
+    
+    def __processBuffer(self):
+        """
+        Private method to process the buffered output of the git log command.
+        """
+        for line in self.buf:
+            line = line.rstrip()
+            
+            if line.startswith("# "):
+                operation, commitId, subject = line[2:].split(None, 2)
+                # commit is surrounded by [...], abbreviate to 20 chars
+                commitId = commitId[1:-1][:20]
+                # operation is followed by ':'
+                operation = operation[:-1]
+                self.__generateLogItem(commitId, operation, subject)
+        
+        self.__resizeColumnsLog()
+        self.logTree.setCurrentItem(self.logTree.topLevelItem(0))
+        
+        # restore current item
+        if self.__currentCommitId:
+            items = self.logTree.findItems(
+                self.__currentCommitId, Qt.MatchExactly, self.CommitIdColumn)
+            if items:
+                self.logTree.setCurrentItem(items[0])
+                self.__currentCommitId = ""
+    
+    def __readStdout(self):
+        """
+        Private slot to handle the readyReadStandardOutput signal.
+        
+        It reads the output of the process and inserts it into a buffer.
+        """
+        self.process.setReadChannel(QProcess.StandardOutput)
+        
+        while self.process.canReadLine():
+            line = str(self.process.readLine(),
+                       Preferences.getSystem("IOEncoding"),
+                       'replace')
+            self.buf.append(line)
+    
+    def __readStderr(self):
+        """
+        Private slot to handle the readyReadStandardError signal.
+        
+        It reads the error output of the process and inserts it into the
+        error pane.
+        """
+        if self.process is not None:
+            s = str(self.process.readAllStandardError(),
+                    Preferences.getSystem("IOEncoding"),
+                    'replace')
+            self.__showError(s)
+    
+    def __showError(self, out):
+        """
+        Private slot to show some error.
+        
+        @param out error to be shown (string)
+        """
+        self.errorGroup.show()
+        self.errors.insertPlainText(out)
+        self.errors.ensureCursorVisible()
+    
+    def on_buttonBox_clicked(self, button):
+        """
+        Private slot called by a button of the button box clicked.
+        
+        @param button button that was clicked (QAbstractButton)
+        """
+        if button == self.buttonBox.button(QDialogButtonBox.Close):
+            self.close()
+        elif button == self.buttonBox.button(QDialogButtonBox.Cancel):
+            self.cancelled = True
+            self.__finish()
+        elif button == self.refreshButton:
+            self.on_refreshButton_clicked()
+    
+    @pyqtSlot()
+    def on_refreshButton_clicked(self):
+        """
+        Private slot to refresh the log.
+        """
+        # save the current item's commit ID
+        itm = self.logTree.currentItem()
+        if itm is not None:
+            self.__currentCommitId = itm.text(self.CommitIdColumn)
+        else:
+            self.__currentCommitId = ""
+        
+        self.start(self.repodir)
+    
+    def on_passwordCheckBox_toggled(self, isOn):
+        """
+        Private slot to handle the password checkbox toggled.
+        
+        @param isOn flag indicating the status of the check box (boolean)
+        """
+        if isOn:
+            self.input.setEchoMode(QLineEdit.Password)
+        else:
+            self.input.setEchoMode(QLineEdit.Normal)
+    
+    @pyqtSlot()
+    def on_sendButton_clicked(self):
+        """
+        Private slot to send the input to the git process.
+        """
+        inputTxt = self.input.text()
+        inputTxt += os.linesep
+        
+        if self.passwordCheckBox.isChecked():
+            self.errors.insertPlainText(os.linesep)
+            self.errors.ensureCursorVisible()
+        else:
+            self.errors.insertPlainText(inputTxt)
+            self.errors.ensureCursorVisible()
+        self.errorGroup.show()
+        
+        self.process.write(strToQByteArray(inputTxt))
+        
+        self.passwordCheckBox.setChecked(False)
+        self.input.clear()
+    
+    def on_input_returnPressed(self):
+        """
+        Private slot to handle the press of the return key in the input field.
+        """
+        self.intercept = True
+        self.on_sendButton_clicked()
+    
+    def keyPressEvent(self, evt):
+        """
+        Protected slot to handle a key press event.
+        
+        @param evt the key press event (QKeyEvent)
+        """
+        if self.intercept:
+            self.intercept = False
+            evt.accept()
+            return
+        super(GitBisectLogBrowserDialog, self).keyPressEvent(evt)

eric ide

mercurial