diff -r 58ecdaf0b789 -r baf6da1ae288 Plugins/VcsPlugins/vcsGit/GitDiffGenerator.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Plugins/VcsPlugins/vcsGit/GitDiffGenerator.py Sun Dec 10 17:42:11 2017 +0100 @@ -0,0 +1,238 @@ +# -*- coding: utf-8 -*- + +# Copyright (c) 2014 - 2017 Detlev Offenbach <detlev@die-offenbachs.de> +# + +""" +Module implementing a class to generate the output of the git diff command +process. +""" + +from __future__ import unicode_literals +try: + str = unicode +except NameError: + pass + +import os + +from PyQt5.QtCore import pyqtSignal, QProcess, QTimer, QObject + +import Preferences + + +class GitDiffGenerator(QObject): + """ + Class implementing the generation of output of the git diff command. + + @signal finished() emitted when all processes have finished + """ + finished = pyqtSignal() + + def __init__(self, vcs, parent=None): + """ + Constructor + + @param vcs reference to the vcs object + @param parent parent widget (QWidget) + """ + super(GitDiffGenerator, self).__init__(parent) + + self.vcs = vcs + + self.process = QProcess() + self.process.finished.connect(self.__procFinished) + self.process.readyReadStandardOutput.connect(self.__readStdout) + self.process.readyReadStandardError.connect(self.__readStderr) + + self.process2 = QProcess() + self.process2.finished.connect(self.__procFinished) + self.process2.readyReadStandardOutput.connect(self.__readStdout) + self.process2.readyReadStandardError.connect(self.__readStderr) + + def stopProcesses(self): + """ + Public slot to stop the diff processes. + """ + for process in [self.process, self.process2]: + if process is not None and \ + process.state() != QProcess.NotRunning: + process.terminate() + QTimer.singleShot(2000, process.kill) + process.waitForFinished(3000) + + def start(self, fn, versions=None, diffMode="work2repo", stashName=""): + """ + Public slot to start the git diff command. + + @param fn filename to be diffed (string) + @param versions list of versions to be diffed (list of up to 2 strings + or None) + @param diffMode indication for the type of diff to be performed ( + 'work2repo' compares the working tree with the HEAD commit, + 'work2stage' compares the working tree with the staging area, + 'stage2repo' compares the staging area with the HEAD commit, + 'work2stage2repo' compares the working tree with the staging area + and the staging area with the HEAD commit, + 'stash' shows the diff for a stash) + @param stashName name of the stash to show a diff for (string) + @return flag indicating the start status (boolean) + """ + assert diffMode in ["work2repo", "work2stage", "stage2repo", + "work2stage2repo", "stash"] + + self.__output1 = [] + self.__output2 = [] + self.__errors = [] + self.__fileSeparators = [] + args2 = [] + + self.__ioEncoding = Preferences.getSystem("IOEncoding") + + if diffMode in ["work2repo", "work2stage", "stage2repo", + "work2stage2repo"]: + args = self.vcs.initCommand("diff") + args.append("--patch") + args.append("--find-copies-harder") + + if versions is not None: + for version in versions: + if version: + args.append(version) + else: + if diffMode == "work2stage2repo": + args2 = args[:] + args2.append("--cached") + args2.append("--") + elif diffMode == "stage2repo": + args.append("--cached") + elif diffMode == "work2repo": + args.append("HEAD") + + args.append("--") + if isinstance(fn, list): + dname, fnames = self.vcs.splitPathList(fn) + self.vcs.addArguments(args, fn) + if args2: + self.vcs.addArguments(args2, fn) + else: + dname, fname = self.vcs.splitPath(fn) + args.append(fn) + if args2: + args2.append(fn) + elif diffMode == "stash": + dname, fname = self.vcs.splitPath(fn) + args = self.vcs.initCommand("stash") + args.append("show") + args.append("--patch") + if stashName: + args.append(stashName) + + # find the root of the repo + repodir = dname + while not os.path.isdir(os.path.join(repodir, self.vcs.adminDir)): + repodir = os.path.dirname(repodir) + if os.path.splitdrive(repodir)[1] == os.sep: + return False + + self.process.kill() + self.process.setWorkingDirectory(repodir) + self.process.start('git', args) + procStarted = self.process.waitForStarted(5000) + if not procStarted: + return False + + if diffMode == "work2stage2repo": + self.process2.kill() + self.process2.setWorkingDirectory(repodir) + self.process2.start('git', args2) + procStarted = self.process2.waitForStarted(5000) + if not procStarted: + return False + + return True + + 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) + """ + if self.process.state() == QProcess.NotRunning and \ + self.process2.state() == QProcess.NotRunning: + self.finished.emit() + + def getResult(self): + """ + Public method to return the result data. + + @return tuple of lists of string containing lines of the diff, the diff + between stage and repo for 'work2stage2repo' mode (empty + otherwise), the list of errors and a list of tuples of filenames + and the line into the diff output. + """ + return (self.__output1, self.__output2, self.__errors, + self.__fileSeparators) + + def __processFileLine(self, line, isTopDiff): + """ + Private slot to process a line giving the old/new file. + + @param line line to be processed (string) + @param isTopDiff flag indicating to show the output in the top + output widget (boolean) + """ + prefix, filenames = line.split(" a/", 1) + oldFile, newFile = filenames.split(" b/", 1) + if isTopDiff: + self.__fileSeparators.append((oldFile.strip(), newFile.strip(), + len(self.__output1), -2)) + else: + self.__fileSeparators.append((oldFile.strip(), newFile.strip(), + -2, len(self.__output2))) + + def __processLine(self, line, isTopDiff): + """ + Private method to process one line of output. + + @param line output line to process (string) + @param isTopDiff flag indicating to show the output in the top + output widget (boolean) + """ + if line.startswith("diff --git"): + self.__processFileLine(line, isTopDiff) + + if isTopDiff: + self.__output1.append(line) + else: + self.__output2.append(line) + + def __readStdout(self): + """ + Private slot to handle the readyReadStandardOutput signal. + + It reads the output of the process, formats it and inserts it into + the contents pane. + """ + process = self.sender() + process.setReadChannel(QProcess.StandardOutput) + + isTopDiff = process == self.process + + while process.canReadLine(): + line = str(process.readLine(), self.__ioEncoding, + 'replace') + self.__processLine(line, isTopDiff) + + 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(), + self.__ioEncoding, 'replace') + self.__errors.append(s)