forked from qt-creator/qt-creator
72d173829c
A lot of our build system files specify unneeded include
paths. These roughly fall into the following categories:
a) Paths that are already set in more general files
such as qtcreator.pri.
b) Paths that serve no purpose at all, possibly
left over from earlier versions of the project.
c) Paths that act as workarounds for wrong include
statements of the form '#include "xyz.h"', where
xyz.h is not in the same directory as the including
file.
This patch removes such path specifications and fixes the offending
include statements from case c).
Tested on Linux, Windows and OSX with qmake and qbs.
Change-Id: I039a8449f8a65df0d616b4c08081145c18ae4b15
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
356 lines
13 KiB
C++
356 lines
13 KiB
C++
/****************************************************************************
|
|
**
|
|
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
|
|
** Contact: http://www.qt-project.org/legal
|
|
**
|
|
** This file is part of Qt Creator.
|
|
**
|
|
** 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 Digia. For licensing terms and
|
|
** conditions see http://qt.digia.com/licensing. For further information
|
|
** use the contact form at http://qt.digia.com/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 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, Digia gives you certain additional
|
|
** rights. These rights are described in the Digia Qt LGPL Exception
|
|
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
|
|
**
|
|
****************************************************************************/
|
|
|
|
#include "customwizardpreprocessor.h"
|
|
#ifdef WITH_TESTS
|
|
# include "../projectexplorer.h"
|
|
# include <QTest>
|
|
#endif
|
|
|
|
#include <utils/qtcassert.h>
|
|
|
|
#include <QStringList>
|
|
#include <QStack>
|
|
#include <QRegExp>
|
|
#include <QDebug>
|
|
|
|
#include <QScriptEngine>
|
|
#include <QScriptValue>
|
|
|
|
namespace ProjectExplorer {
|
|
namespace Internal {
|
|
|
|
enum { debug = 0 };
|
|
|
|
// Preprocessor: Conditional section type.
|
|
enum PreprocessorSection {
|
|
IfSection,
|
|
ElsifSection,
|
|
ElseSection,
|
|
EndifSection,
|
|
OtherSection
|
|
};
|
|
|
|
// Preprocessor: Section stack entry containing nested '@if' section
|
|
// state.
|
|
struct PreprocessStackEntry {
|
|
PreprocessStackEntry(PreprocessorSection section = OtherSection,
|
|
bool parentEnabled = true,
|
|
bool condition = false,
|
|
bool anyIfClauseMatched = false);
|
|
|
|
PreprocessorSection section;
|
|
bool parentEnabled;
|
|
bool condition; // Current 'if/elsif' section is enabled.
|
|
bool anyIfClauseMatched; // Determines if 'else' triggers
|
|
};
|
|
|
|
PreprocessStackEntry::PreprocessStackEntry(PreprocessorSection s,
|
|
bool p, bool c, bool a) :
|
|
section(s), parentEnabled(p), condition(c), anyIfClauseMatched(a)
|
|
{
|
|
}
|
|
|
|
// Context for preprocessing.
|
|
class PreprocessContext {
|
|
public:
|
|
PreprocessContext();
|
|
bool process(const QString &in, QString *out, QString *errorMessage);
|
|
|
|
private:
|
|
void reset();
|
|
PreprocessorSection preprocessorLine(const QString & in, QString *ifExpression) const;
|
|
|
|
mutable QRegExp m_ifPattern;
|
|
mutable QRegExp m_elsifPattern;
|
|
mutable QRegExp m_elsePattern;
|
|
mutable QRegExp m_endifPattern;
|
|
|
|
QStack<PreprocessStackEntry> m_sectionStack;
|
|
QScriptEngine m_scriptEngine;
|
|
};
|
|
|
|
PreprocessContext::PreprocessContext() :
|
|
// Cut out expression for 'if/elsif '
|
|
m_ifPattern(QLatin1String("^([\\s]*@[\\s]*if[\\s]*)(.*)$")),
|
|
m_elsifPattern(QLatin1String("^([\\s]*@[\\s]*elsif[\\s]*)(.*)$")),
|
|
m_elsePattern(QLatin1String("^[\\s]*@[\\s]*else.*$")),
|
|
m_endifPattern(QLatin1String("^[\\s]*@[\\s]*endif.*$"))
|
|
{
|
|
QTC_ASSERT(m_ifPattern.isValid() && m_elsifPattern.isValid()
|
|
&& m_elsePattern.isValid() &&m_endifPattern.isValid(), return);
|
|
}
|
|
|
|
void PreprocessContext::reset()
|
|
{
|
|
m_sectionStack.clear(); // Add a default, enabled section.
|
|
m_sectionStack.push(PreprocessStackEntry(OtherSection, true, true));
|
|
}
|
|
|
|
// Determine type of line and return enumeration, cut out
|
|
// expression for '@if/@elsif'.
|
|
PreprocessorSection PreprocessContext::preprocessorLine(const QString &in,
|
|
QString *ifExpression) const
|
|
{
|
|
if (m_ifPattern.exactMatch(in)) {
|
|
*ifExpression = m_ifPattern.cap(2).trimmed();
|
|
return IfSection;
|
|
}
|
|
if (m_elsifPattern.exactMatch(in)) {
|
|
*ifExpression = m_elsifPattern.cap(2).trimmed();
|
|
return ElsifSection;
|
|
}
|
|
|
|
ifExpression->clear();
|
|
|
|
if (m_elsePattern.exactMatch(in))
|
|
return ElseSection;
|
|
if (m_endifPattern.exactMatch(in))
|
|
return EndifSection;
|
|
return OtherSection;
|
|
}
|
|
|
|
// Evaluate an expression within an 'if'/'elsif' to a bool via QScript
|
|
bool evaluateBooleanJavaScriptExpression(QScriptEngine &engine, const QString &expression, bool *result, QString *errorMessage)
|
|
{
|
|
errorMessage->clear();
|
|
*result = false;
|
|
engine.clearExceptions();
|
|
const QScriptValue value = engine.evaluate(expression);
|
|
if (engine.hasUncaughtException()) {
|
|
*errorMessage = QString::fromLatin1("Error in '%1': %2").
|
|
arg(expression, engine.uncaughtException().toString());
|
|
return false;
|
|
}
|
|
// Try to convert to bool, be that an int or whatever.
|
|
if (value.isBool()) {
|
|
*result = value.toBool();
|
|
return true;
|
|
}
|
|
if (value.isNumber()) {
|
|
*result = !qFuzzyCompare(value.toNumber(), 0);
|
|
return true;
|
|
}
|
|
if (value.isString()) {
|
|
*result = !value.toString().isEmpty();
|
|
return true;
|
|
}
|
|
*errorMessage = QString::fromLatin1("Cannot convert result of '%1' ('%2'to bool.").
|
|
arg(expression, value.toString());
|
|
return false;
|
|
}
|
|
|
|
static inline QString msgEmptyStack(int line)
|
|
{
|
|
return QString::fromLatin1("Unmatched '@endif' at line %1.").arg(line);
|
|
}
|
|
|
|
bool PreprocessContext::process(const QString &in, QString *out, QString *errorMessage)
|
|
{
|
|
out->clear();
|
|
if (in.isEmpty())
|
|
return true;
|
|
|
|
out->reserve(in.size());
|
|
reset();
|
|
|
|
const QChar newLine = QLatin1Char('\n');
|
|
const QStringList lines = in.split(newLine, QString::KeepEmptyParts);
|
|
const int lineCount = lines.size();
|
|
for (int l = 0; l < lineCount; l++) {
|
|
// Check for element of the stack (be it dummy, else something is wrong).
|
|
if (m_sectionStack.isEmpty()) {
|
|
*errorMessage = msgEmptyStack(l);
|
|
return false;
|
|
}
|
|
QString expression;
|
|
bool expressionValue = false;
|
|
PreprocessStackEntry &top = m_sectionStack.back();
|
|
|
|
switch (preprocessorLine(lines.at(l), &expression)) {
|
|
case IfSection:
|
|
// '@If': Push new section
|
|
if (top.condition) {
|
|
if (!evaluateBooleanJavaScriptExpression(m_scriptEngine, expression, &expressionValue, errorMessage)) {
|
|
*errorMessage = QString::fromLatin1("Error in @if at %1: %2").
|
|
arg(l + 1).arg(*errorMessage);
|
|
return false;
|
|
}
|
|
}
|
|
if (debug)
|
|
qDebug("'%s' : expr='%s' -> %d", qPrintable(lines.at(l)), qPrintable(expression), expressionValue);
|
|
m_sectionStack.push(PreprocessStackEntry(IfSection,
|
|
top.condition, expressionValue, expressionValue));
|
|
break;
|
|
case ElsifSection: // '@elsif': Check condition.
|
|
if (top.section != IfSection && top.section != ElsifSection) {
|
|
*errorMessage = QString::fromLatin1("No preceding @if found for @elsif at %1").
|
|
arg(l + 1);
|
|
return false;
|
|
}
|
|
if (top.parentEnabled) {
|
|
if (!evaluateBooleanJavaScriptExpression(m_scriptEngine, expression, &expressionValue, errorMessage)) {
|
|
*errorMessage = QString::fromLatin1("Error in @elsif at %1: %2").
|
|
arg(l + 1).arg(*errorMessage);
|
|
return false;
|
|
}
|
|
}
|
|
if (debug)
|
|
qDebug("'%s' : expr='%s' -> %d", qPrintable(lines.at(l)), qPrintable(expression), expressionValue);
|
|
top.section = ElsifSection;
|
|
// ignore consecutive '@elsifs' once something matched
|
|
if (top.anyIfClauseMatched) {
|
|
top.condition = false;
|
|
} else {
|
|
if ( (top.condition = expressionValue) )
|
|
top.anyIfClauseMatched = true;
|
|
}
|
|
break;
|
|
case ElseSection: // '@else': Check condition.
|
|
if (top.section != IfSection && top.section != ElsifSection) {
|
|
*errorMessage = QString::fromLatin1("No preceding @if/@elsif found for @else at %1").
|
|
arg(l + 1);
|
|
return false;
|
|
}
|
|
expressionValue = top.parentEnabled && !top.anyIfClauseMatched;
|
|
if (debug)
|
|
qDebug("%s -> %d", qPrintable(lines.at(l)), expressionValue);
|
|
top.section = ElseSection;
|
|
top.condition = expressionValue;
|
|
break;
|
|
case EndifSection: // '@endif': Discard section.
|
|
m_sectionStack.pop();
|
|
break;
|
|
case OtherSection: // Rest: Append according to current condition.
|
|
if (top.condition) {
|
|
out->append(lines.at(l));
|
|
out->append(newLine);
|
|
}
|
|
break;
|
|
} // switch section
|
|
|
|
} // for lines
|
|
return true;
|
|
}
|
|
|
|
/*!
|
|
\brief Custom wizard preprocessor based on JavaScript expressions.
|
|
|
|
Preprocess a string using simple syntax:
|
|
\code
|
|
Text
|
|
@if <JavaScript-expression>
|
|
Bla...
|
|
@elsif <JavaScript-expression2>
|
|
Blup
|
|
@endif
|
|
\endcode
|
|
|
|
The JavaScript-expressions must evaluate to integers or boolean, like
|
|
\c '2 == 1 + 1', \c '"a" == "a"'. The variables of the custom wizard will be
|
|
expanded before, so , \c "%VAR%" should be used for strings and \c %VAR% for integers.
|
|
|
|
\sa ProjectExplorer::CustomWizard
|
|
*/
|
|
|
|
bool customWizardPreprocess(const QString &in, QString *out, QString *errorMessage)
|
|
{
|
|
PreprocessContext context;
|
|
return context.process(in, out, errorMessage);
|
|
}
|
|
|
|
} // namespace Internal
|
|
|
|
#ifdef WITH_TESTS // Run qtcreator -test ProjectExplorer
|
|
|
|
void ProjectExplorerPlugin::testCustomWizardPreprocessor_data()
|
|
{
|
|
QTest::addColumn<QString>("input");
|
|
QTest::addColumn<QString>("expectedOutput");
|
|
QTest::addColumn<bool>("expectedSuccess");
|
|
QTest::addColumn<QString>("expectedErrorMessage");
|
|
QTest::newRow("if")
|
|
<< QString::fromLatin1("@if 1\nline 1\n@elsif 0\nline 2\n@else\nline 3\n@endif\n")
|
|
<< QString::fromLatin1("line 1")
|
|
<< true << QString();
|
|
QTest::newRow("elsif")
|
|
<< QString::fromLatin1("@if 0\nline 1\n@elsif 1\nline 2\n@else\nline 3\n@endif\n")
|
|
<< QString::fromLatin1("line 2")
|
|
<< true << QString();
|
|
QTest::newRow("else")
|
|
<< QString::fromLatin1("@if 0\nline 1\n@elsif 0\nline 2\n@else\nline 3\n@endif\n")
|
|
<< QString::fromLatin1("line 3")
|
|
<< true << QString();
|
|
QTest::newRow("nested-if")
|
|
<< QString::fromLatin1("@if 1\n"
|
|
" @if 1\nline 1\n@elsif 0\nline 2\n@else\nline 3\n@endif\n"
|
|
"@else\n"
|
|
" @if 1\nline 4\n@elsif 0\nline 5\n@else\nline 6\n@endif\n"
|
|
"@endif\n")
|
|
<< QString::fromLatin1("line 1")
|
|
<< true << QString();
|
|
QTest::newRow("nested-else")
|
|
<< QString::fromLatin1("@if 0\n"
|
|
" @if 1\nline 1\n@elsif 0\nline 2\n@else\nline 3\n@endif\n"
|
|
"@else\n"
|
|
" @if 1\nline 4\n@elsif 0\nline 5\n@else\nline 6\n@endif\n"
|
|
"@endif\n")
|
|
<< QString::fromLatin1("line 4")
|
|
<< true << QString();
|
|
QTest::newRow("twice-nested-if")
|
|
<< QString::fromLatin1("@if 0\n"
|
|
" @if 1\n"
|
|
" @if 1\nline 1\n@else\nline 2\n@endif\n"
|
|
" @endif\n"
|
|
"@else\n"
|
|
" @if 1\n"
|
|
" @if 1\nline 3\n@else\nline 4\n@endif\n"
|
|
" @endif\n"
|
|
"@endif\n")
|
|
<< QString::fromLatin1("line 3")
|
|
<< true << QString();
|
|
}
|
|
|
|
void ProjectExplorerPlugin::testCustomWizardPreprocessor()
|
|
{
|
|
QFETCH(QString, input);
|
|
QFETCH(QString, expectedOutput);
|
|
QFETCH(bool, expectedSuccess);
|
|
QFETCH(QString, expectedErrorMessage);
|
|
|
|
QString errorMessage;
|
|
QString output;
|
|
const bool success = Internal::customWizardPreprocess(input, &output, &errorMessage);
|
|
QCOMPARE(success, expectedSuccess);
|
|
QCOMPARE(output.trimmed(), expectedOutput.trimmed());
|
|
QCOMPARE(errorMessage, expectedErrorMessage);
|
|
}
|
|
#endif // WITH_TESTS
|
|
} // namespace ProjectExplorer
|