TypeOfExpression.h 4.89 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
con's avatar
con committed
5
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
con's avatar
con committed
8
**
con's avatar
con committed
9
** No Commercial Usage
10
**
con's avatar
con committed
11 12 13 14
** 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.
15
**
16
** GNU Lesser General Public License Usage
17
**
18 19 20 21 22 23
** 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.
24
**
con's avatar
con committed
25 26 27 28 29 30
** 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.
con's avatar
con committed
31
**
32
**************************************************************************/
con's avatar
con committed
33 34 35
#ifndef CPLUSPLUS_TYPEOFEXPRESSION_H
#define CPLUSPLUS_TYPEOFEXPRESSION_H

36
#include "CppDocument.h"
37 38
#include "LookupContext.h"
#include "PreprocessorEnvironment.h"
con's avatar
con committed
39

40
#include <ASTfwd.h>
con's avatar
con committed
41 42 43 44 45 46
#include <QtCore/QMap>
#include <QtCore/QObject>
#include <QtCore/QString>

namespace CPlusPlus {

47 48 49
class Environment;
class Macro;

con's avatar
con committed
50 51
class CPLUSPLUS_EXPORT TypeOfExpression
{
52 53
    Q_DISABLE_COPY(TypeOfExpression)

con's avatar
con committed
54 55 56 57 58 59
public:
    TypeOfExpression();

    /**
     * Sets the documents used to evaluate expressions. Should be set before
     * calling this functor.
60 61 62
     *
     * Also clears the lookup context, so can be used to make sure references
     * to the documents previously used are removed.
con's avatar
con committed
63
     */
64 65 66 67
    void init(Document::Ptr thisDocument, const Snapshot &snapshot,
              QSharedPointer<CreateBindings> bindings = QSharedPointer<CreateBindings>());

    void reset();
con's avatar
con committed
68

69 70 71 72 73
    enum PreprocessMode {
        NoPreprocess,
        Preprocess
    };

con's avatar
con committed
74 75 76 77 78 79 80 81 82
    /**
     * Returns a list of possible fully specified types associated with the
     * given expression.
     *
     * NOTE: The fully specified types only stay valid for as long as this
     * expression evaluator instance still exists, and no new call to evaluate
     * has been made!
     *
     * @param expression        The expression to evaluate.
83
     * @param scope             The scope enclosing the expression.
con's avatar
con committed
84
     */
85
    QList<LookupItem> operator()(const QString &expression,
86
                                 Scope *scope,
87
                                 PreprocessMode mode = NoPreprocess);
con's avatar
con committed
88

89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
    /**
     * Returns a list of possible fully specified types associated with the
     * given expression AST from the given document.
     *
     * NOTE: The fully specified types only stay valid for as long as this
     * expression evaluator instance still exists, and no new call to evaluate
     * has been made!
     *
     * @param expression        The expression to evaluate.
     * @param document          The document in which the expression lives.
     * @param scope             The scope enclosing the expression.
     */
    QList<LookupItem> operator()(ExpressionAST *expression,
                                 Document::Ptr document,
                                 Scope *scope);

105 106 107 108 109 110 111 112
    QList<LookupItem> reference(const QString &expression,
                                Scope *scope,
                                PreprocessMode mode = NoPreprocess);

    QList<LookupItem> reference(ExpressionAST *expression,
                                Document::Ptr document,
                                Scope *scope);

113
    QString preprocess(const QString &expression) const;
114

con's avatar
con committed
115 116 117 118 119 120 121 122
    /**
     * Returns the AST of the last evaluated expression.
     */
    ExpressionAST *ast() const;

    /**
     * Returns the lookup context of the last evaluated expression.
     */
123
    const LookupContext &context() const;
124
    Scope *scope() const;
con's avatar
con committed
125 126 127 128 129 130 131

    ExpressionAST *expressionAST() const;

private:
    ExpressionAST *extractExpressionAST(Document::Ptr doc) const;
    Document::Ptr documentForExpression(const QString &expression) const;

132
    void processEnvironment(Document::Ptr doc, Environment *env,
133 134
                            QSet<QString> *processed) const;

135
    QString preprocessedExpression(const QString &expression) const;
136

137 138
private:
    Document::Ptr m_thisDocument;
139
    Snapshot m_snapshot;
140
    QSharedPointer<CreateBindings> m_bindings;
con's avatar
con committed
141
    ExpressionAST *m_ast;
142
    Scope *m_scope;
143 144
    LookupContext m_lookupContext;
    mutable QSharedPointer<Environment> m_environment;
con's avatar
con committed
145 146 147 148 149
};

} // namespace CPlusPlus

#endif // CPLUSPLUS_TYPEOFEXPRESSION_H