/****************************************************************************

**

** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the qmake application of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** 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 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#ifndef PROJECT_H

#define PROJECT_H

#include <qstringlist.h>

#include <qtextstream.h>

#include <qstring.h>

#include <qstack.h>

#include <qmap.h>

#include <qmetatype.h>

QT_BEGIN_NAMESPACE

class QMakeProperty;

struct ParsableBlock;

struct IteratorBlock;

struct FunctionBlock;

class QMakeProject

{

    struct ScopeBlock

    {

        enum TestStatus { TestNone, TestFound, TestSeek };

        ScopeBlock() : iterate(0), ignore(false), else_status(TestNone) { }

        ScopeBlock(bool i) : iterate(0), ignore(i), else_status(TestNone) { }

        ~ScopeBlock();

        IteratorBlock *iterate;

        uint ignore : 1, else_status : 2;

    };

    friend struct ParsableBlock;

    friend struct IteratorBlock;

    friend struct FunctionBlock;

    QStack<ScopeBlock> scope_blocks;

    QStack<FunctionBlock *> function_blocks;

    IteratorBlock *iterator;

    FunctionBlock *function;

    QMap<QString, FunctionBlock*> testFunctions, replaceFunctions;

    bool own_prop;

    QString pfile, cfile;

    QMakeProperty *prop;

    void reset();

    QMap<QString, QStringList> vars, base_vars, cache;

    bool parse(const QString &text, QMap<QString, QStringList> &place, int line_count=1);

    enum IncludeStatus {

        IncludeSuccess,

        IncludeFeatureAlreadyLoaded,

        IncludeFailure,

        IncludeNoExist,

        IncludeParseFailure

    };

    enum IncludeFlags {

        IncludeFlagNone = 0x00,

        IncludeFlagFeature = 0x01,

        IncludeFlagNewParser = 0x02,

        IncludeFlagNewProject = 0x04

    };

    IncludeStatus doProjectInclude(QString file, uchar flags, QMap<QString, QStringList> &place);

    bool doProjectCheckReqs(const QStringList &deps, QMap<QString, QStringList> &place);

    bool doVariableReplace(QString &str, QMap<QString, QStringList> &place);

    QStringList doVariableReplaceExpand(const QString &str, QMap<QString, QStringList> &place, bool *ok=0);

    void init(QMakeProperty *, const QMap<QString, QStringList> *);

    QStringList &values(const QString &v, QMap<QString, QStringList> &place);

public:

    QMakeProject() { init(0, 0); }

    QMakeProject(QMakeProperty *p) { init(p, 0); }

    QMakeProject(QMakeProject *p, const QMap<QString, QStringList> *nvars=0);

    QMakeProject(const QMap<QString, QStringList> &nvars) { init(0, &nvars); }

    QMakeProject(QMakeProperty *p, const QMap<QString, QStringList> &nvars) { init(p, &nvars); }

    ~QMakeProject();

    enum { ReadCache=0x01, ReadConf=0x02, ReadCmdLine=0x04, ReadProFile=0x08,

           ReadPostFiles=0x10, ReadFeatures=0x20, ReadConfigs=0x40, ReadAll=0xFF };

    inline bool parse(const QString &text) { return parse(text, vars); }

    bool read(const QString &project, uchar cmd=ReadAll);

    bool read(uchar cmd=ReadAll);

    QStringList userExpandFunctions() { return replaceFunctions.keys(); }

    QStringList userTestFunctions() { return testFunctions.keys(); }

    QString projectFile();

    QString configFile();

    inline QMakeProperty *properties() { return prop; }

    bool doProjectTest(QString str, QMap<QString, QStringList> &place);

    bool doProjectTest(QString func, const QString &params,

                       QMap<QString, QStringList> &place);

    bool doProjectTest(QString func, QStringList args,

                       QMap<QString, QStringList> &place);

    bool doProjectTest(QString func, QList<QStringList> args,

                       QMap<QString, QStringList> &place);

    QStringList doProjectExpand(QString func, const QString &params,

                                QMap<QString, QStringList> &place);

    QStringList doProjectExpand(QString func, QStringList args,

                                QMap<QString, QStringList> &place);

    QStringList doProjectExpand(QString func, QList<QStringList> args,

                                QMap<QString, QStringList> &place);

    QStringList expand(const QString &v);

    QStringList expand(const QString &func, const QList<QStringList> &args);

    bool test(const QString &v);

    bool test(const QString &func, const QList<QStringList> &args);

    bool isActiveConfig(const QString &x, bool regex=false,

                        QMap<QString, QStringList> *place=NULL);

    bool isSet(const QString &v);

    bool isEmpty(const QString &v);

    QStringList &values(const QString &v);

    QString first(const QString &v);

    QMap<QString, QStringList> &variables();

protected:

    friend class MakefileGenerator;

    bool read(const QString &file, QMap<QString, QStringList> &place);

    bool read(QTextStream &file, QMap<QString, QStringList> &place);

};

Q_DECLARE_METATYPE(QMakeProject*)

inline QString QMakeProject::projectFile()

{

    if (pfile == "-")

        return QString("(stdin)");

    return pfile;

}

inline QString QMakeProject::configFile()

{ return cfile; }

inline QStringList &QMakeProject::values(const QString &v)

{ return values(v, vars); }

inline bool QMakeProject::isEmpty(const QString &v)

{ return !isSet(v) || values(v).isEmpty(); }

inline bool QMakeProject::isSet(const QString &v)

{ return vars.contains(v); }

inline QString QMakeProject::first(const QString &v)

{

    const QStringList vals = values(v);

    if(vals.isEmpty())

        return QString("");

    return vals.first();

}

inline QMap<QString, QStringList> &QMakeProject::variables()

{ return vars; }

// Helper functions needed for Symbian

bool isForSymbian();

bool isForSymbianSbsv2();

QT_END_NAMESPACE

#endif // PROJECT_H