qt5base-lts/qmake/project.h

/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/
**
** This file is part of the qmake application of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** 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.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef PROJECT_H
#define PROJECT_H

#include <qstringlist.h>
#include <qtextstream.h>
#include <qstring.h>
#include <qstack.h>
#include <qhash.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;
    QHash<QString, FunctionBlock*> testFunctions, replaceFunctions;

    bool recursive;
    bool own_prop;
    bool backslashWarned;
    QString pfile;
    QMakeProperty *prop;
    void reset();
    QStringList extra_configs;
    QHash<QString, QStringList> vars, base_vars, extra_vars;
    bool parse(const QString &text, QHash<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, QHash<QString, QStringList> &place);

    bool doProjectCheckReqs(const QStringList &deps, QHash<QString, QStringList> &place);
    bool doVariableReplace(QString &str, QHash<QString, QStringList> &place);
    QStringList doVariableReplaceExpand(const QString &str, QHash<QString, QStringList> &place, bool *ok=0);
    void init(QMakeProperty *);
    QStringList &values(const QString &v, QHash<QString, QStringList> &place);
    void validateModes();
    void resolveSpec(QString *spec, const QString &qmakespec);

public:
    QMakeProject(QMakeProperty *p = 0) { init(p); }
    QMakeProject(QMakeProject *p, const QHash<QString, QStringList> *nvars=0);
    ~QMakeProject();

    void setExtraVars(const QHash<QString, QStringList> &_vars) { extra_vars = _vars; }
    void setExtraConfigs(const QStringList &_cfgs) { extra_configs = _cfgs; }

    enum { ReadProFile=0x01, ReadSetup=0x02, ReadFeatures=0x04, 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();
    inline QMakeProperty *properties() { return prop; }

    bool doProjectTest(QString str, QHash<QString, QStringList> &place);
    bool doProjectTest(QString func, const QString &params,
                       QHash<QString, QStringList> &place);
    bool doProjectTest(QString func, QStringList args,
                       QHash<QString, QStringList> &place);
    bool doProjectTest(QString func, QList<QStringList> args,
                       QHash<QString, QStringList> &place);
    QStringList doProjectExpand(QString func, const QString &params,
                                QHash<QString, QStringList> &place);
    QStringList doProjectExpand(QString func, QStringList args,
                                QHash<QString, QStringList> &place);
    QStringList doProjectExpand(QString func, QList<QStringList> args,
                                QHash<QString, QStringList> &place);

    QStringList expand(const QString &v);
    QString expand(const QString &v, const QString &file, int line);
    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,
                        QHash<QString, QStringList> *place=NULL);

    bool isSet(const QString &v); // No compat mapping, no magic variables
    bool isEmpty(const QString &v); // With compat mapping, but no magic variables
    QStringList &values(const QString &v); // With compat mapping and magic variables
    QString first(const QString &v); // ditto
    QHash<QString, QStringList> &variables(); // No compat mapping and magic, obviously

    bool isRecursive() const { return recursive; }

protected:
    friend class MakefileGenerator;
    bool read(const QString &file, QHash<QString, QStringList> &place);
    bool read(QTextStream &file, QHash<QString, QStringList> &place);

};
Q_DECLARE_METATYPE(QMakeProject*)

inline QString QMakeProject::projectFile()
{
    if (pfile == "-")
        return QString("(stdin)");
    return pfile;
}

inline QStringList &QMakeProject::values(const QString &v)
{ return values(v, vars); }

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 QHash<QString, QStringList> &QMakeProject::variables()
{ return vars; }

QT_END_NAMESPACE

#endif // PROJECT_H