TypeOfExpression.h 4.79 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
**
hjk's avatar
hjk committed
7
** Contact: Nokia Corporation (info@qt.nokia.com)
con's avatar
con committed
8
**
9
**
10
** GNU Lesser General Public License Usage
11
**
hjk's avatar
hjk committed
12 13 14 15 16 17
** 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.
18
**
con's avatar
con committed
19
** In addition, as a special exception, Nokia gives you certain additional
hjk's avatar
hjk committed
20
** rights. These rights are described in the Nokia Qt LGPL Exception
con's avatar
con committed
21 22
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
23 24 25 26 27
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
con's avatar
con committed
28
** If you have questions regarding the use of this file, please contact
Tobias Hunger's avatar
Tobias Hunger committed
29
** Nokia at info@qt.nokia.com.
con's avatar
con committed
30
**
31
**************************************************************************/
con's avatar
con committed
32 33 34
#ifndef CPLUSPLUS_TYPEOFEXPRESSION_H
#define CPLUSPLUS_TYPEOFEXPRESSION_H

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

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

namespace CPlusPlus {

46 47 48
class Environment;
class Macro;

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

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

    /**
     * Sets the documents used to evaluate expressions. Should be set before
     * calling this functor.
59 60 61
     *
     * 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
62
     */
63 64 65 66
    void init(Document::Ptr thisDocument, const Snapshot &snapshot,
              QSharedPointer<CreateBindings> bindings = QSharedPointer<CreateBindings>());

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

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

con's avatar
con committed
73 74 75 76 77 78 79 80 81
    /**
     * 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.
82
     * @param scope             The scope enclosing the expression.
con's avatar
con committed
83
     */
84
    QList<LookupItem> operator()(const QString &expression,
85
                                 Scope *scope,
86
                                 PreprocessMode mode = NoPreprocess);
con's avatar
con committed
87

88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
    /**
     * 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);

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

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

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

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

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

    ExpressionAST *expressionAST() const;

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

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

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

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

} // namespace CPlusPlus

#endif // CPLUSPLUS_TYPEOFEXPRESSION_H