/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qbs.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QBS_PROGRESSOBSERVER_H
#define QBS_PROGRESSOBSERVER_H

#include <QtCore/qglobal.h>

#include <vector>

QT_BEGIN_NAMESPACE
class QString;
QT_END_NAMESPACE

namespace qbs {
namespace Internal {
class ScriptEngine;

class ProgressObserver
{
public:
    virtual ~ProgressObserver() = default;

    virtual void initialize(const QString &task, int maximum) = 0;
    virtual void setProgressValue(int value) = 0;
    virtual int progressValue() = 0;
    virtual bool canceled() const = 0;
    virtual void setMaximum(int maximum) = 0;
    virtual int maximum() const = 0;

    void incrementProgressValue(int increment = 1);

    // Call this to ensure that the progress bar always goes to 100%.
    void setFinished();

    void addScriptEngine(ScriptEngine *engine) { m_scriptEngines.push_back(engine); }

protected:
    const std::vector<ScriptEngine *> &scriptEngines() const { return m_scriptEngines; }

private:
    std::vector<ScriptEngine *> m_scriptEngines;
};

} // namespace Internal
} // namespace qbs

#endif // QBS_PROGRESSOBSERVER_H
