# eric7.Plugins.VcsPlugins.vcsMercurial.HgDiffGenerator

Module implementing a class to generate the output of the hg diff command.

### Global Attributes

None

### Classes

HgDiffGenerator | Class implementing the generation of output of the hg diff command.

### Functions

None

## HgDiffGenerator

Class implementing the generation of output of the hg diff command.

### Signals

finished()
  emitted when all processes have finished

### Derived from

QObject

### Class Attributes

None

### Class Methods

None

### Methods

HgDiffGenerator | Constructor
__extractFileName | Private method to extract the file name out of a file separator line.
__finish | Private slot called when the process finished or the user pressed the button.
__getVersionArg | Private method to get a hg revision argument for the given revision.
__processFileLine | Private slot to process a line giving the old/new file.
getResult | Public method to return the result data.
start | Public slot to start the hg diff command.
stopProcess | Public slot to stop the diff process.

### Static Methods

None

#### HgDiffGenerator (Constructor)

HgDiffGenerator(vcs, parent=None)

Constructor

vcs (Hg)
  reference to the vcs object
parent (QWidget)
  parent widget

#### HgDiffGenerator.__extractFileName

__extractFileName(line)

Private method to extract the file name out of a file separator line.

line (str)
  line to be processed

Return:
  extracted file name

Return Type:
  str

#### HgDiffGenerator.__finish

__finish()

Private slot called when the process finished or the user pressed the button.

#### HgDiffGenerator.__getVersionArg

__getVersionArg(version)

Private method to get a hg revision argument for the given revision.

version (int or str)
  revision

Return:
  version argument

Return Type:
  str

#### HgDiffGenerator.__processFileLine

__processFileLine(lineno, line)

Private slot to process a line giving the old/new file.

lineno (int)
  line number of line to be processed
line (str)
  line to be processed

#### HgDiffGenerator.getResult

getResult()

Public method to return the result data.

Return:
  tuple containing a list of lines of the diff, a list of errors and a list of tuples of filenames and the line into the diff output

Return Type:
  tuple of (list of str, list of str, list of tuple of (str, int))

#### HgDiffGenerator.start

start(fn, versions=None, bundle=None, qdiff=False)

Public slot to start the hg diff command.

fn (str)
  filename to be diffed
versions (list of up to 2 str or None)
  list of versions to be diffed
bundle (str)
  name of a bundle file
qdiff (bool)
  flag indicating qdiff command shall be used

Return:
  flag indicating a successful start of the diff command

Return Type:
  bool

#### HgDiffGenerator.stopProcess

stopProcess()

Public slot to stop the diff process.

Up