/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing
**
** This file is part of Qbs.
**
** 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 http://www.qt.io/terms-conditions. For further information
** use the contact form at http://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 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, The Qt Company gives you certain additional
** rights.  These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/
#ifndef QBS_RULESEVALUATIONCONTEXT_H
#define QBS_RULESEVALUATIONCONTEXT_H

#include <language/forward_decls.h>

#include <QHash>
#include <QScriptProgram>
#include <QScriptValue>
#include <QString>

namespace qbs {
namespace Internal {
class Logger;
class ProgressObserver;
class ScriptEngine;

class RulesEvaluationContext
{
public:
    RulesEvaluationContext(const Logger &logger);
    ~RulesEvaluationContext();

    class Scope
    {
    public:
        Scope(RulesEvaluationContext *evalContext);
        ~Scope();

    private:
        RulesEvaluationContext * const m_evalContext;
    };

    ScriptEngine *engine() const { return m_engine; }
    QScriptValue scope() const { return m_scope; }
    bool isActive() const;

    void setObserver(ProgressObserver *observer) { m_observer = observer; }
    ProgressObserver *observer() const { return m_observer; }
    void initializeObserver(const QString &description, int maximumProgress);
    void incrementProgressValue();
    void checkForCancelation();

private:
    friend class Scope;

    void initScope();
    void cleanupScope();

    ScriptEngine * const m_engine;
    ProgressObserver *m_observer;
    unsigned int m_initScopeCalls;
    QScriptValue m_scope;
    QScriptValue m_prepareScriptScope;
};

} // namespace Internal
} // namespace qbs

#endif // QBS_RULESEVALUATIONCONTEXT_H
