src/plugins/projectexplorer/customwizard/customwizardpreprocessor.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (info@qt.nokia.com)
   8 **
   9 **
  10 ** GNU Lesser General Public License Usage
  11 **
  12 ** This file may be used under the terms of the GNU Lesser General Public
  13 ** License version 2.1 as published by the Free Software Foundation and
  14 ** appearing in the file LICENSE.LGPL included in the packaging of this file.
  15 ** Please review the following information to ensure the GNU Lesser General
  16 ** Public License version 2.1 requirements will be met:
  17 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  18 **
  19 ** In addition, as a special exception, Nokia gives you certain additional
  20 ** rights. These rights are described in the Nokia Qt LGPL Exception
  21 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  22 **
  23 ** Other Usage
  24 **
  25 ** Alternatively, this file may be used in accordance with the terms and
  26 ** conditions contained in a signed written agreement between you and Nokia.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **************************************************************************/
  32
  33 #ifndef CUSTOMWIZARDPREPROCESSOR_H
  34 #define CUSTOMWIZARDPREPROCESSOR_H
  35
  36 #include <QtCore/QString>
  37
  38 QT_FORWARD_DECLARE_CLASS(QScriptEngine)
  39
  40 namespace ProjectExplorer {
  41 namespace Internal {
  42
  43 /* Preprocess a string using simple syntax: \code
  44
  45 Text
  46 @if <JavaScript-expression>
  47 Bla...
  48 @elsif <JavaScript-expression2>
  49 Blup
  50 @endif
  51 \endcode
  52
  53 * JavaScript-expressions must evaluate to integers or boolean, like
  54 * '2 == 1 + 1', '"a" == "a"'. The variables of the custom wizard will be
  55 * expanded beforem, so , "%VAR%" should be used for strings and %VAR% for integers.
  56 */
  57
  58 bool customWizardPreprocess(const QString &in, QString *out, QString *errorMessage);
  59 /* Helper to evaluate an expression. */
  60 bool evaluateBooleanJavaScriptExpression(QScriptEngine &engine, const QString &expression, bool *result, QString *errorMessage);
  61 } // namespace Internal
  62 } // namespace ProjectExplorer
  63
  64 #endif // CUSTOMWIZARDPREPROCESSOR_H