tools/porting/src/tokenreplacements.h
changeset 0 1918ee327afb
child 4 3b1da2848fc7
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/tools/porting/src/tokenreplacements.h	Mon Jan 11 14:00:40 2010 +0000
@@ -0,0 +1,154 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the qt3to4 porting 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 TOKENREPLACEMENTS_H
+#define TOKENREPLACEMENTS_H
+
+#include "tokenengine.h"
+#include "textreplacement.h"
+#include <QStringList>
+#include <QByteArray>
+
+QT_BEGIN_NAMESPACE
+
+void addLogSourceEntry(const QString &text, const TokenEngine::TokenContainer&, const int index);
+void addLogWarning(const QString &text);
+
+class TokenReplacement
+{
+public:
+
+    virtual bool doReplace(const TokenEngine::TokenContainer& ,
+                           int /*tokenIndex*/,
+                           TextReplacements&){return false;};
+    /*
+        returns the replace key for this replacement. Every time a token matches the replace key,
+        doReplace() will be called for this TokenReplacement.
+    */
+    virtual QByteArray getReplaceKey(){return QByteArray();};
+    virtual ~TokenReplacement(){};
+};
+
+/*
+    A TokenReplacement that change any token
+*/
+class GenericTokenReplacement : public TokenReplacement
+{
+public:
+    GenericTokenReplacement(QByteArray oldToken, QByteArray newToken);
+    bool doReplace(const TokenEngine::TokenContainer &tokenContainer,
+                   int tokenIndex, TextReplacements &textReplacements);
+    QByteArray getReplaceKey();
+private:
+    QByteArray oldToken;
+    QByteArray newToken;
+};
+
+/*
+    A TokenReplacement that changes tokens that specify class names.
+    In some cases where the class name token is a part of a qualified name
+    it is not correct to rename it. ex:
+
+    QButton::toggleState
+
+    Here it is wrong to rename QButton -> Q3Button, since there is
+    a rule that says QButton::ToggleState -> QCheckBox::ToggleState,
+    but no rule for Q3Button::ToggleState.
+*/
+class ClassNameReplacement : public TokenReplacement
+{
+public:
+    ClassNameReplacement(QByteArray oldToken, QByteArray newToken);
+    bool doReplace(const TokenEngine::TokenContainer &tokenContainer,
+                   int tokenIndex, TextReplacements &textReplacements);
+    QByteArray getReplaceKey();
+private:
+    QByteArray oldToken;
+    QByteArray newToken;
+};
+
+/*
+   Changes scoped tokens:
+   AA::BB -> CC::DD
+   oldToken corresponds to the AA::BB part, newToken corresponds CC::DD.
+   Since this is a token replacement, the AA part of oldToken is typically
+   unknown. This means that we might change tokens named BB that does not belong
+   to the AA scope. Ast replacemnts will fix this.
+
+*/
+class ScopedTokenReplacement : public TokenReplacement
+{
+public:
+    ScopedTokenReplacement(const QByteArray &oldToken, const QByteArray &newToken);
+    bool doReplace(const TokenEngine::TokenContainer &tokenContainer,
+                   int tokenIndex, TextReplacements &textReplacements);
+    QByteArray getReplaceKey();
+private:
+    QByteArray oldName;
+    QByteArray oldScope;
+    QByteArray newName;
+    QByteArray newScope;
+    QByteArray newScopedName;
+    bool strictMode;
+};
+
+class QualifiedNameParser
+{
+public:
+    QualifiedNameParser(const TokenEngine::TokenContainer &tokenContainer,
+                        const int tokenIndex);
+    enum Direction { Left=-1, Right=1 };
+    bool isPartOfQualifiedName();
+    bool isValidIndex(int index);
+    bool isQualifier();
+    bool isName();
+    int peek(Direction direction);
+    int move(Direction direction);
+private:
+    int nextScopeToken(Direction direction);
+    int findScopeOperator(Direction direction);
+    const TokenEngine::TokenContainer tokenContainer;
+    int currentIndex;
+};
+
+QT_END_NAMESPACE
+
+#endif