KDevelop::VcsDiff Class Reference

#include <vcsdiff.h>

Classes
struct	FilePair

Public Types
enum	DiffDirection { Normal = 0, Foward = 0, Reverse = 1 }

Public Member Functions
	VcsDiff ()
	VcsDiff (const VcsDiff &)
virtual	~VcsDiff ()
QUrl	baseDiff () const
uint	depth () const
QString	diff () const
int	diffLineToSourceLine (const uint line) const
int	diffLineToTargetLine (const uint line) const
const QVector< FilePair >	fileNames () const
bool	isEmpty () const
VcsDiff &	operator= (const VcsDiff &rhs)
void	setBaseDiff (const QUrl &url)
void	setDepth (const uint depth)
void	setDiff (const QString &diff)
VcsDiff	subDiff (const uint startLine, const uint endLine, DiffDirection dir=Normal) const
VcsDiff	subDiffHunk (const uint line, DiffDirection dir=Normal) const

Detailed Description

A class representing a unified diff, possibly with conflict markers.

A diff is assumed to be a collection of hunks, where each hunk has the following structure:

METADATA — a/SOURCE_PATH +++ b/TARGET_PATH HUNK1 HEADER HUNK1 CONTENT [METADATA] HUNK2 HEADER HUNK2 CONTENT ...

METADATA are lines which start with anything except for a '+', '-' and ' '. The path specifications may optionally precede a hunk and are assumed to apply to all following hunks until a new path specification is found. These indicate the files for which the diff is generated.

Hunk Header

Each hunk header has the following form

@ -SRC_OFFSET[, SRC_CHANGES_COUNT] +TGT_OFFSET[, TGT_CHANGES_COUNT] @ Heading

where the SRC_OFFSET is a 1-based line index pointing to the source file where the hunk applies and TGT_OFFSET is a 1-based line index pointing to the target file where the hunk applies. The optional SRC_CHANGES_COUNTS (assumed to be 1 if not present) specifies the number of context lines plus the number of deleted lines. Similarly, the optional TGT_CHANGES_COUNT specifies the number of context lines plus the number of added lines. The Heading, used as a visual aid for users, is supposed to show the line where the nearest enclosing function scope of the hunk starts.

Hunk Content

The hunk content is a collection of lines which starting with '+' (additions), '-' (deletions) and ' ' (context lines; empty lines are also take to be context lines). Additionally, a hunk may contain conflict markers which are of the form

our ref

our content

...

their content ... <<<<<<< their ref

and indicate unresolved conflicts.

Definition at line 95 of file vcsdiff.h.

Member Enumeration Documentation

DiffDirection

enum KDevelop::VcsDiff::DiffDirection

Enumerator
Normal	the unchanged patch
Foward	the unchanged patch
Reverse	the inverse of the patch (i.e. a new patch which, when applied, undoes the old patch)

Definition at line 99 of file vcsdiff.h.

Constructor & Destructor Documentation

VcsDiff() [1/2]

KDevelop::VcsDiff::VcsDiff

(

)

Definition at line 571 of file vcsdiff.cpp.

~VcsDiff()

KDevelop::VcsDiff::~VcsDiff ( )

virtualdefault

VcsDiff() [2/2]

KDevelop::VcsDiff::VcsDiff

(

const VcsDiff &

rhs

)

Definition at line 578 of file vcsdiff.cpp.

Member Function Documentation

baseDiff()

QUrl KDevelop::VcsDiff::baseDiff

(

)

const

Returns

the base directory of the diff.

Definition at line 606 of file vcsdiff.cpp.

depth()

uint KDevelop::VcsDiff::depth

(

)

const

Depth - number of directories to left-strip from paths in the patch - see "patch -p" Defaults to 0.

Definition at line 611 of file vcsdiff.cpp.

diff()

QString KDevelop::VcsDiff::diff

(

)

const

Returns

the source of the diff.

Definition at line 588 of file vcsdiff.cpp.

diffLineToSourceLine()

int KDevelop::VcsDiff::diffLineToSourceLine

(

const uint

line

)

const

Maps a line position in the diff to a corresponding line position in the source file.

Parameters

line	a 0-based line position in the diff

Returns

the 0-based line position in the source file or -1 if no such position exists.

Definition at line 561 of file vcsdiff.cpp.

diffLineToTargetLine()

int KDevelop::VcsDiff::diffLineToTargetLine

(

const uint

line

)

const

Maps a line position in the diff to a corresponding line position in the source file.

Parameters

line	a 0-based line position in the diff

Returns

the 0-based line position in the source file or -1 if no such position exists.

Definition at line 566 of file vcsdiff.cpp.

fileNames()

const QVector< VcsDiff::FilePair > KDevelop::VcsDiff::fileNames

(

)

const

Returns

a list of filename pairs that the patch applies to

Note

: Each file-pair is only listed once for each consecutive run of hunks which apply to it.

Definition at line 546 of file vcsdiff.cpp.

isEmpty()

bool KDevelop::VcsDiff::isEmpty

(

)

const

Returns

whether or not there are changes in the diff

Definition at line 583 of file vcsdiff.cpp.

operator=()

VcsDiff & KDevelop::VcsDiff::operator=

(

const VcsDiff &

rhs

)

Definition at line 600 of file vcsdiff.cpp.

setBaseDiff()

void KDevelop::VcsDiff::setBaseDiff

(

const QUrl &

url

)

Sets the base directory of the diff to the url.

Definition at line 616 of file vcsdiff.cpp.

setDepth()

void KDevelop::VcsDiff::setDepth

(

const uint

depth

)

Sets the depth of the diff to depth.

Definition at line 621 of file vcsdiff.cpp.

setDiff()

void KDevelop::VcsDiff::setDiff

(

const QString &

diff

)

Sets the diff source and parses it.

Parameters

diff	the diff in unified diff format

Definition at line 594 of file vcsdiff.cpp.

subDiff()

KDevelop::VcsDiff KDevelop::VcsDiff::subDiff	(	const uint	startLine,
		const uint	endLine,
		DiffDirection	dir = Normal
	)		const

Creates a standalone diff containing the differences in a given range.

Returns

a diff containing only the changes from the current diff which are in the range startLine-endLine (in the diff text)

Parameters

startLine	0-based line number (in the diff) of the first line in the range
endLine	0-based line number (in the diff) of the last line in the range
dir	if set to Reverse, the role of src and tgt are reversed, i.e. a diff is generated which can be applied to the target to get the source.

Definition at line 423 of file vcsdiff.cpp.

subDiffHunk()

KDevelop::VcsDiff KDevelop::VcsDiff::subDiffHunk	(	const uint	line,
		DiffDirection	dir = Normal
	)		const

Creates a new standalone diff from a single hunk identified by a containing line.

Returns

a diff containing only the changes from hunk containing the line the line

Parameters

line	0-based line number (in the diff) of the line in the hunk
dir	if set to Reverse, the role of src and tgt are reversed, i.e. a diff is generated which can be applied to the target to get the source.

Definition at line 407 of file vcsdiff.cpp.

---

The documentation for this class was generated from the following files:

• vcsdiff.h
• vcsdiff.cpp