VcsBaseClient Class

(VcsBase::VcsBaseClient)

The VcsBaseClient class is the base class for Mercurial and Bazaar 'clients'. More...

Header: #include <VcsBaseClient>
Inherits: VcsBase::VcsBaseClientImpl

Public Types

class StatusItem

Public Functions

VcsBaseClient(VcsBaseClientSettings *settings)
~VcsBaseClient() override
virtual void commit(const QString &repositoryRoot, const QStringList &files, const QString &commitMessageFile, const QStringList &extraOptions = QStringList())
virtual void diff(const QString &workingDir, const QStringList &files = QStringList(), const QStringList &extraOptions = QStringList())
virtual void emitParsedStatus(const QString &repository, const QStringList &extraOptions = QStringList())
virtual QString findTopLevelForFile(const QFileInfo &file) const = 0
virtual void import(const QString &repositoryRoot, const QStringList &files, const QStringList &extraOptions = QStringList())
virtual void log(const QString &workingDir, const QStringList &files = QStringList(), const QStringList &extraOptions = QStringList(), bool enableAnnotationContextMenu = false)
virtual void revertAll(const QString &workingDir, const QString &revision = QString(), const QStringList &extraOptions = QStringList())
virtual void revertFile(const QString &workingDir, const QString &file, const QString &revision = QString(), const QStringList &extraOptions = QStringList())
virtual void status(const QString &workingDir, const QString &file = QString(), const QStringList &extraOptions = QStringList())
virtual bool synchronousAdd(const QString &workingDir, const QString &fileName, const QStringList &extraOptions = QStringList())
virtual bool synchronousClone(const QString &workingDir, const QString &srcLocation, const QString &dstLocation, const QStringList &extraOptions = QStringList())
virtual bool synchronousCreateRepository(const QString &workingDir, const QStringList &extraOptions = QStringList())
virtual bool synchronousMove(const QString &workingDir, const QString &from, const QString &to, const QStringList &extraOptions = QStringList())
virtual bool synchronousPull(const QString &workingDir, const QString &srcLocation, const QStringList &extraOptions = QStringList())
virtual bool synchronousPush(const QString &workingDir, const QString &dstLocation, const QStringList &extraOptions = QStringList())
virtual bool synchronousRemove(const QString &workingDir, const QString &fileName, const QStringList &extraOptions = QStringList())
virtual void update(const QString &repositoryRoot, const QString &revision = QString(), const QStringList &extraOptions = QStringList())
virtual void view(const QString &source, const QString &id, const QStringList &extraOptions = QStringList())

Reimplemented Public Functions

virtual VcsBaseEditorWidget *annotate(const QString &workingDir, const QString &file, const QString &revision = QString(), int lineNumber = -1, const QStringList &extraOptions = QStringList()) override

Signals

void changed(const QVariant &v)
void parsedStatus(const QList<VcsBase::VcsBaseClient::StatusItem> &statusList)

Protected Types

typedef ConfigCreator
enum VcsCommandTag { CreateRepositoryCommand, CloneCommand, AddCommand, RemoveCommand, ..., StatusCommand }

Protected Functions

virtual Utils::ExitCodeInterpreter exitCodeInterpreter(VcsCommandTag cmd) const
virtual StatusItem parseStatusLine(const QString &line) const = 0
virtual QStringList revisionSpec(const QString &revision) const = 0
void setDiffConfigCreator(ConfigCreator creator)
void setLogConfigCreator(ConfigCreator creator)
virtual QString vcsCommandString(VcsCommandTag cmd) const
virtual Core::Id vcsEditorKind(VcsCommandTag cmd) const = 0
QString vcsEditorTitle(const QString &vcsCmd, const QString &sourceId) const

Additional Inherited Members

Detailed Description

The VcsBaseClient class is the base class for Mercurial and Bazaar 'clients'.

Provides base functionality for common commands (diff, log, etc).

See also VcsBase::VcsJobRunner.

Member Type Documentation

typedef VcsBaseClient::ConfigCreator

enum VcsBaseClient::VcsCommandTag

Member Function Documentation

VcsBaseClient::VcsBaseClient(VcsBaseClientSettings *settings)

Default constructs an instance of VcsBaseClient.

VcsBaseClient::~VcsBaseClient()

Destroys the instance of VcsBaseClient.

[override virtual] VcsBaseEditorWidget *VcsBaseClient::annotate(const QString &workingDir, const QString &file, const QString &revision = QString(), int lineNumber = -1, const QStringList &extraOptions = QStringList())

[signal] void VcsBaseClient::changed(const QVariant &v)

[virtual] void VcsBaseClient::commit(const QString &repositoryRoot, const QStringList &files, const QString &commitMessageFile, const QStringList &extraOptions = QStringList())

[virtual] void VcsBaseClient::diff(const QString &workingDir, const QStringList &files = QStringList(), const QStringList &extraOptions = QStringList())

[virtual] void VcsBaseClient::emitParsedStatus(const QString &repository, const QStringList &extraOptions = QStringList())

[virtual protected] Utils::ExitCodeInterpreter VcsBaseClient::exitCodeInterpreter(VcsCommandTag cmd) const

[pure virtual] QString VcsBaseClient::findTopLevelForFile(const QFileInfo &file) const

[virtual] void VcsBaseClient::import(const QString &repositoryRoot, const QStringList &files, const QStringList &extraOptions = QStringList())

[virtual] void VcsBaseClient::log(const QString &workingDir, const QStringList &files = QStringList(), const QStringList &extraOptions = QStringList(), bool enableAnnotationContextMenu = false)

[pure virtual protected] StatusItem VcsBaseClient::parseStatusLine(const QString &line) const

[signal] void VcsBaseClient::parsedStatus(const QList<VcsBase::VcsBaseClient::StatusItem> &statusList)

[virtual] void VcsBaseClient::revertAll(const QString &workingDir, const QString &revision = QString(), const QStringList &extraOptions = QStringList())

[virtual] void VcsBaseClient::revertFile(const QString &workingDir, const QString &file, const QString &revision = QString(), const QStringList &extraOptions = QStringList())

[pure virtual protected] QStringList VcsBaseClient::revisionSpec(const QString &revision) const

[protected] void VcsBaseClient::setDiffConfigCreator(ConfigCreator creator)

[protected] void VcsBaseClient::setLogConfigCreator(ConfigCreator creator)

[virtual] void VcsBaseClient::status(const QString &workingDir, const QString &file = QString(), const QStringList &extraOptions = QStringList())

[virtual] bool VcsBaseClient::synchronousAdd(const QString &workingDir, const QString &fileName, const QStringList &extraOptions = QStringList())

[virtual] bool VcsBaseClient::synchronousClone(const QString &workingDir, const QString &srcLocation, const QString &dstLocation, const QStringList &extraOptions = QStringList())

[virtual] bool VcsBaseClient::synchronousCreateRepository(const QString &workingDir, const QStringList &extraOptions = QStringList())

[virtual] bool VcsBaseClient::synchronousMove(const QString &workingDir, const QString &from, const QString &to, const QStringList &extraOptions = QStringList())

[virtual] bool VcsBaseClient::synchronousPull(const QString &workingDir, const QString &srcLocation, const QStringList &extraOptions = QStringList())

[virtual] bool VcsBaseClient::synchronousPush(const QString &workingDir, const QString &dstLocation, const QStringList &extraOptions = QStringList())

[virtual] bool VcsBaseClient::synchronousRemove(const QString &workingDir, const QString &fileName, const QStringList &extraOptions = QStringList())

[virtual] void VcsBaseClient::update(const QString &repositoryRoot, const QString &revision = QString(), const QStringList &extraOptions = QStringList())

[virtual protected] QString VcsBaseClient::vcsCommandString(VcsCommandTag cmd) const

[pure virtual protected] Core::Id VcsBaseClient::vcsEditorKind(VcsCommandTag cmd) const

[protected] QString VcsBaseClient::vcsEditorTitle(const QString &vcsCmd, const QString &sourceId) const

[virtual] void VcsBaseClient::view(const QString &source, const QString &id, const QStringList &extraOptions = QStringList())