1 /****************************************************************************

     2 **

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

     4 ** All rights reserved.

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

     6 **

     7 ** This file is part of the qt3to4 porting application of the Qt Toolkit.

     8 **

     9 ** $QT_BEGIN_LICENSE:LGPL$

    10 ** No Commercial Usage

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

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

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    15 **

    16 ** GNU Lesser General Public License Usage

    17 ** Alternatively, this file may be used under the terms of the GNU Lesser

    18 ** General Public License version 2.1 as published by the Free Software

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

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

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

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

    23 **

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

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

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

    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 **

    34 **

    35 **

    36 **

    37 **

    38 ** $QT_END_LICENSE$

    39 **

    40 ****************************************************************************/

    41 

    42 #ifndef TOKENREPLACEMENTS_H

    43 #define TOKENREPLACEMENTS_H

    44 

    45 #include "tokenengine.h"

    46 #include "textreplacement.h"

    47 #include <QStringList>

    48 #include <QByteArray>

    49 

    50 QT_BEGIN_NAMESPACE

    51 

    52 void addLogSourceEntry(const QString &text, const TokenEngine::TokenContainer&, const int index);

    53 void addLogWarning(const QString &text);

    54 

    55 class TokenReplacement

    56 {

    57 public:

    58 

    59     virtual bool doReplace(const TokenEngine::TokenContainer& ,

    60                            int /*tokenIndex*/,

    61                            TextReplacements&){return false;};

    62     /*

    63         returns the replace key for this replacement. Every time a token matches the replace key,

    64         doReplace() will be called for this TokenReplacement.

    65     */

    66     virtual QByteArray getReplaceKey(){return QByteArray();};

    67     virtual ~TokenReplacement(){};

    68 };

    69 

    70 /*

    71     A TokenReplacement that change any token

    72 */

    73 class GenericTokenReplacement : public TokenReplacement

    74 {

    75 public:

    76     GenericTokenReplacement(QByteArray oldToken, QByteArray newToken);

    77     bool doReplace(const TokenEngine::TokenContainer &tokenContainer,

    78                    int tokenIndex, TextReplacements &textReplacements);

    79     QByteArray getReplaceKey();

    80 private:

    81     QByteArray oldToken;

    82     QByteArray newToken;

    83 };

    84 

    85 /*

    86     A TokenReplacement that changes tokens that specify class names.

    87     In some cases where the class name token is a part of a qualified name

    88     it is not correct to rename it. ex:

    89 

    90     QButton::toggleState

    91 

    92     Here it is wrong to rename QButton -> Q3Button, since there is

    93     a rule that says QButton::ToggleState -> QCheckBox::ToggleState,

    94     but no rule for Q3Button::ToggleState.

    95 */

    96 class ClassNameReplacement : public TokenReplacement

    97 {

    98 public:

    99     ClassNameReplacement(QByteArray oldToken, QByteArray newToken);

   100     bool doReplace(const TokenEngine::TokenContainer &tokenContainer,

   101                    int tokenIndex, TextReplacements &textReplacements);

   102     QByteArray getReplaceKey();

   103 private:

   104     QByteArray oldToken;

   105     QByteArray newToken;

   106 };

   107 

   108 /*

   109    Changes scoped tokens:

   110    AA::BB -> CC::DD

   111    oldToken corresponds to the AA::BB part, newToken corresponds CC::DD.

   112    Since this is a token replacement, the AA part of oldToken is typically

   113    unknown. This means that we might change tokens named BB that does not belong

   114    to the AA scope. Ast replacemnts will fix this.

   115 

   116 */

   117 class ScopedTokenReplacement : public TokenReplacement

   118 {

   119 public:

   120     ScopedTokenReplacement(const QByteArray &oldToken, const QByteArray &newToken);

   121     bool doReplace(const TokenEngine::TokenContainer &tokenContainer,

   122                    int tokenIndex, TextReplacements &textReplacements);

   123     QByteArray getReplaceKey();

   124 private:

   125     QByteArray oldName;

   126     QByteArray oldScope;

   127     QByteArray newName;

   128     QByteArray newScope;

   129     QByteArray newScopedName;

   130     bool strictMode;

   131 };

   132 

   133 class QualifiedNameParser

   134 {

   135 public:

   136     QualifiedNameParser(const TokenEngine::TokenContainer &tokenContainer,

   137                         const int tokenIndex);

   138     enum Direction { Left=-1, Right=1 };

   139     bool isPartOfQualifiedName();

   140     bool isValidIndex(int index);

   141     bool isQualifier();

   142     bool isName();

   143     int peek(Direction direction);

   144     int move(Direction direction);

   145 private:

   146     int nextScopeToken(Direction direction);

   147     int findScopeOperator(Direction direction);

   148     const TokenEngine::TokenContainer tokenContainer;

   149     int currentIndex;

   150 };

   151 

   152 QT_END_NAMESPACE

   153 

   154 #endif