vcsjob.h

Go to the documentation of this file.

/* This file is part of KDevelop
 *
 * Copyright 2007 Andreas Pakulat <[email protected]>
 * Copyright 2007 Matthew Woehlke <[email protected]>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */
 
#ifndef KDEVPLATFORM_VCSJOB_H
#define KDEVPLATFORM_VCSJOB_H
 
#include <outputview/outputjob.h>
 
#include "vcsexport.h"
 
class QVariant;
 
namespace KDevelop
{
 
class IPlugin;
class VcsJobPrivate;
 
class KDEVPLATFORMVCS_EXPORT VcsJob : public OutputJob
{
    Q_OBJECT
public:
    explicit VcsJob( QObject* parent = nullptr, OutputJobVerbosity verbosity = OutputJob::Verbose);
    ~VcsJob() override;
    enum JobType
    {
        Unknown = -1    ,
        Add = 0         ,
        Remove = 1      ,
        Copy = 2        ,
        Move = 3        ,
        Diff = 4        ,
        Commit = 5      ,
        Update = 6      ,
        Merge = 7       ,
        Resolve = 8     ,
        Import = 9      ,
        Checkout = 10   ,
        Log = 11        ,
        Push = 12       ,
        Pull = 13       ,
        Annotate = 14   ,
        Clone = 15      ,
        Status = 16     ,
        Revert = 17     ,
        Cat = 18        ,
        UserType = 1000 
    };
 
    enum JobStatus
    {
        JobRunning = 0    ,
        JobSucceeded = 1  ,
        JobCanceled = 2   ,
        JobFailed = 3     ,
        JobNotStarted = 4 
    };
 
    virtual QVariant fetchResults() = 0;
 
    virtual JobStatus status() const = 0;
 
    JobType type() const;
 
    virtual KDevelop::IPlugin* vcsPlugin() const = 0;
 
    void setType( JobType );
 
Q_SIGNALS:
    void resultsReady( KDevelop::VcsJob* );
 
private Q_SLOTS:
    void delayedModelInitialize();
 
private:
    const QScopedPointer<class VcsJobPrivate> d_ptr;
    Q_DECLARE_PRIVATE(VcsJob)
};
 
}
 
#endif