TypeOfExpression.h 4.69 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
Eike Ziller's avatar
Eike Ziller committed
7
** Contact: http://www.qt-project.org/
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
**
29
**************************************************************************/
con's avatar
con committed
30 31 32
#ifndef CPLUSPLUS_TYPEOFEXPRESSION_H
#define CPLUSPLUS_TYPEOFEXPRESSION_H

33
#include "CppDocument.h"
34 35
#include "LookupContext.h"
#include "PreprocessorEnvironment.h"
con's avatar
con committed
36

37
#include <ASTfwd.h>
38 39 40 41
#include <QMap>
#include <QObject>
#include <QString>
#include <QByteArray>
con's avatar
con committed
42 43 44

namespace CPlusPlus {

45 46 47
class Environment;
class Macro;

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

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

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

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

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

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

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

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

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

111
    QByteArray preprocess(const QByteArray &utf8code) const;
112

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

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

    ExpressionAST *expressionAST() const;

private:
    ExpressionAST *extractExpressionAST(Document::Ptr doc) const;
128
    Document::Ptr documentForExpression(const QByteArray &utf8code) const;
con's avatar
con committed
129

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

133
    QByteArray preprocessedExpression(const QByteArray &utf8code) const;
134

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

} // namespace CPlusPlus

#endif // CPLUSPLUS_TYPEOFEXPRESSION_H