KDevelop::DistributedVersionControlPlugin Class Reference

#include <dvcsplugin.h>

Inheritance diagram for KDevelop::DistributedVersionControlPlugin:

Public Slots
void	ctxBranchManager ()

Public Member Functions
	DistributedVersionControlPlugin (QObject *parent, const QString &componentName)
	~DistributedVersionControlPlugin () override
virtual void	additionalMenuEntries (QMenu *menu, const QList< QUrl > &urls)
virtual QVector< KDevelop::DVcsEvent >	allCommits (const QString &repo)=0
ContextMenuExtension	contextMenuExtension (Context *context, QWidget *parent) override
VcsImportMetadataWidget *	createImportMetadataWidget (QWidget *parent) override
virtual void	parseLogOutput (const DVcsJob *job, QVector< KDevelop::DVcsEvent > &revisions) const =0
Public Member Functions inherited from KDevelop::IDistributedVersionControl
	~IDistributedVersionControl () override=default
virtual VcsJob *	init (const QUrl &localRepositoryRoot)=0
virtual VcsJob *	pull (const VcsLocation &localOrRepoLocationSrc, const QUrl &localRepositoryLocation)=0
virtual VcsJob *	push (const QUrl &localRepositoryLocation, const VcsLocation &localOrRepoLocationDst)=0
Public Member Functions inherited from KDevelop::IBasicVersionControl
virtual	~IBasicVersionControl ()
virtual VcsJob *	add (const QList< QUrl > &localLocations, RecursionMode recursion=IBasicVersionControl::Recursive)=0
virtual VcsJob *	annotate (const QUrl &localLocation, const VcsRevision &rev=VcsRevision::createSpecialRevision(VcsRevision::Head))=0
virtual VcsJob *	commit (const QString &message, const QList< QUrl > &localLocations, RecursionMode recursion=IBasicVersionControl::Recursive)=0
virtual VcsJob *	copy (const QUrl &localLocationSrc, const QUrl &localLocationDstn)=0
virtual VcsJob *	createWorkingCopy (const VcsLocation &sourceRepository, const QUrl &destinationDirectory, RecursionMode recursion=IBasicVersionControl::Recursive)=0
virtual VcsJob *	diff (const QUrl &fileOrDirectory, const VcsRevision &srcRevision, const VcsRevision &dstRevision, IBasicVersionControl::RecursionMode recursion=IBasicVersionControl::Recursive)=0
virtual bool	isValidRemoteRepositoryUrl (const QUrl &remoteLocation)=0
virtual bool	isVersionControlled (const QUrl &localLocation)=0
virtual VcsJob *	log (const QUrl &localLocation, const VcsRevision &rev, unsigned long limit=0)=0
virtual VcsJob *	log (const QUrl &localLocation, const VcsRevision &rev=VcsRevision::createSpecialRevision(VcsRevision::Base), const VcsRevision &limit=VcsRevision::createSpecialRevision(VcsRevision::Start))=0
virtual VcsJob *	move (const QUrl &localLocationSrc, const QUrl &localLocationDst)=0
virtual QString	name () const =0
virtual VcsJob *	remove (const QList< QUrl > &localLocations)=0
virtual VcsJob *	repositoryLocation (const QUrl &localLocation)=0
virtual VcsJob *	resolve (const QList< QUrl > &localLocations, RecursionMode recursion)=0
virtual VcsJob *	revert (const QList< QUrl > &localLocations, RecursionMode recursion=IBasicVersionControl::Recursive)=0
virtual void	setupCommitMessageEditor (const QUrl &, KTextEdit *edit) const
virtual VcsJob *	status (const QList< QUrl > &localLocations, RecursionMode recursion=IBasicVersionControl::Recursive)=0
virtual VcsJob *	update (const QList< QUrl > &localLocations, const VcsRevision &rev=VcsRevision::createSpecialRevision(VcsRevision::Head), RecursionMode recursion=IBasicVersionControl::Recursive)=0
virtual VcsLocationWidget *	vcsLocation (QWidget *parent) const =0
Public Member Functions inherited from KDevelop::IBranchingVersionControl
virtual	~IBranchingVersionControl ()
virtual VcsJob *	branch (const QUrl &repository, const VcsRevision &rev, const QString &branchName)=0
virtual VcsJob *	branches (const QUrl &repository)=0
virtual VcsJob *	currentBranch (const QUrl &repository)=0
virtual VcsJob *	deleteBranch (const QUrl &repository, const QString &branchName)=0
virtual VcsJob *	mergeBranch (const QUrl &repository, const QString &branchName)=0
virtual void	registerRepositoryForCurrentBranchChanges (const QUrl &repository)=0
virtual VcsJob *	renameBranch (const QUrl &repository, const QString &oldBranchName, const QString &newBranchName)=0
virtual VcsJob *	switchBranch (const QUrl &repository, const QString &branchName)=0
virtual VcsJob *	tag (const QUrl &repository, const QString &commitMessage, const VcsRevision &rev, const QString &tagName)=0

Protected Member Functions
virtual bool	isValidDirectory (const QUrl &dirPath)=0

Additional Inherited Members
Public Types inherited from KDevelop::IBasicVersionControl
enum	RecursionMode { Recursive, NonRecursive }
Signals inherited from KDevelop::IBranchingVersionControl
void	repositoryBranchChanged (const QUrl &repository)

Detailed Description

DistributedVersionControlPlugin is a base class for git/hg/bzr plugins.

This class implements KDevelop::IBasicVersionControl, KDevelop::IDistributedVersionControl and KDevelop::IPlugin (contextMenuExtension). DistributedVersionControlPlugin class uses IDVCSexecutor to get all jobs from real DVCS plugins like Git. It is based on KDevelop's CVS plugin (also looks like svn plugin is it's relative too).

Note

Create only special items in contextMenuExtension, all standard menu items are created in vcscommon plugin!

Definition at line 47 of file dvcsplugin.h.

Constructor & Destructor Documentation

DistributedVersionControlPlugin()

KDevelop::DistributedVersionControlPlugin::DistributedVersionControlPlugin	(	QObject *	parent,
		const QString &	componentName
	)

Definition at line 63 of file dvcsplugin.cpp.

~DistributedVersionControlPlugin()

KDevelop::DistributedVersionControlPlugin::~DistributedVersionControlPlugin ( )

override

Definition at line 68 of file dvcsplugin.cpp.

Member Function Documentation

additionalMenuEntries()

void KDevelop::DistributedVersionControlPlugin::additionalMenuEntries ( QMenu *  menu, const QList< QUrl > &  urls  )

virtual

When a plugin wants to add elements to the vcs menu, this method can be overridden.

Definition at line 119 of file dvcsplugin.cpp.

allCommits()

virtual QVector<KDevelop::DVcsEvent> KDevelop::DistributedVersionControlPlugin::allCommits ( const QString &  repo )

pure virtual

Returns the list of all commits (in all branches).

See also

CommitView and CommitViewDelegate to see how this list is used.

contextMenuExtension()

KDevelop::ContextMenuExtension KDevelop::DistributedVersionControlPlugin::contextMenuExtension ( Context *  context, QWidget *  parent  )

override

Creates context menu.

Note

Create only special items here (like checkout), all standard menu items are created in vcscommon plugin!

Definition at line 88 of file dvcsplugin.cpp.

createImportMetadataWidget()

KDevelop::VcsImportMetadataWidget * KDevelop::DistributedVersionControlPlugin::createImportMetadataWidget ( QWidget *  parent )

overridevirtual

Used in KDevelop's appwizardplugin (creates import widget)

Implements KDevelop::IBasicVersionControl.

Definition at line 82 of file dvcsplugin.cpp.

ctxBranchManager

void KDevelop::DistributedVersionControlPlugin::ctxBranchManager ( )

slot

Definition at line 128 of file dvcsplugin.cpp.

isValidDirectory()

virtual bool KDevelop::DistributedVersionControlPlugin::isValidDirectory ( const QUrl &  dirPath )

protectedpure virtual

Checks if dirPath is located in DVCS repository.

parseLogOutput()

virtual void KDevelop::DistributedVersionControlPlugin::parseLogOutput ( const DVcsJob *  job, QVector< KDevelop::DVcsEvent > &  revisions  ) const

pure virtual

Parses the output generated by a dvcs log command and fills the given QList with all commits infos found in the given output.

Parameters

job	The finished job of a dvcs log call
revisions	Will be filled with all revision infos found in jobOutput TODO: Change it to pass the results in job->getResults()

---

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

• dvcsplugin.h
• dvcsplugin.cpp