LookupContext.h 11.5 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
2
**
3
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
7
**
hjk's avatar
hjk committed
8 9 10 11 12 13 14
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
15 16
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17 18 19 20 21 22 23 24 25
** 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, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
con's avatar
con committed
26 27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
29 30 31 32 33 34

#ifndef CPLUSPLUS_LOOKUPCONTEXT_H
#define CPLUSPLUS_LOOKUPCONTEXT_H

#include "CppDocument.h"
#include "LookupItem.h"
35
#include "AlreadyConsideredClassContainer.h"
36 37 38 39 40 41 42

#include <cplusplus/FullySpecifiedType.h>
#include <cplusplus/Type.h>
#include <cplusplus/SymbolVisitor.h>
#include <cplusplus/Control.h>
#include <cplusplus/Name.h>

43
#include <QSet>
44 45
#include <QMap>

46 47
#include <map>
#include <functional>
48 49 50

namespace CPlusPlus {

51 52 53 54 55 56 57 58 59 60 61
namespace Internal {
struct FullyQualifiedName
{
    QList<const Name *> fqn;

    FullyQualifiedName(const QList<const Name *> &fqn)
        : fqn(fqn)
    {}
};
} // namespace Internal;

62 63 64 65 66 67
class CreateBindings;

class CPLUSPLUS_EXPORT ClassOrNamespace
{
public:
    ClassOrNamespace(CreateBindings *factory, ClassOrNamespace *parent);
68
    ~ClassOrNamespace();
69

70
    const TemplateNameId *templateId() const;
71 72
    ClassOrNamespace *instantiationOrigin() const;

73
    ClassOrNamespace *parent() const;
74
    QList<ClassOrNamespace *> usings() const;
75
    QList<Enum *> unscopedEnums() const;
76 77 78 79
    QList<Symbol *> symbols() const;

    ClassOrNamespace *globalNamespace() const;

80 81
    QList<LookupItem> lookup(const Name *name);
    QList<LookupItem> find(const Name *name);
82

83 84
    ClassOrNamespace *lookupType(const Name *name);
    ClassOrNamespace *findType(const Name *name);
85

86 87
    Symbol *lookupInScope(const QList<const Name *> &fullName);

88
private:
89 90 91
    typedef std::map<const Name *, ClassOrNamespace *, Name::Compare> Table;
    typedef std::map<const TemplateNameId *, ClassOrNamespace *, TemplateNameId::Compare> TemplateNameIdTable;

92 93 94 95
    /// \internal
    void flush();

    /// \internal
96
    ClassOrNamespace *findOrCreateType(const Name *name, ClassOrNamespace *origin = 0);
97

98 99
    void addTodo(Symbol *symbol);
    void addSymbol(Symbol *symbol);
100
    void addUnscopedEnum(Enum *e);
101
    void addUsing(ClassOrNamespace *u);
Roberto Raggi's avatar
Roberto Raggi committed
102
    void addNestedType(const Name *alias, ClassOrNamespace *e);
103

104
    QList<LookupItem> lookup_helper(const Name *name, bool searchInEnclosingScope);
105

106
    void lookup_helper(const Name *name, ClassOrNamespace *binding,
107 108 109
                       QList<LookupItem> *result,
                       QSet<ClassOrNamespace *> *processed,
                       const TemplateNameId *templateId);
110

111
    ClassOrNamespace *lookupType_helper(const Name *name, QSet<ClassOrNamespace *> *processed,
112
                                        bool searchInEnclosingScope, ClassOrNamespace *origin);
113

114
    ClassOrNamespace *nestedType(const Name *name, ClassOrNamespace *origin);
115

116 117 118 119 120
    void instantiateNestedClasses(ClassOrNamespace *enclosingTemplateClass,
                                  Clone &cloner,
                                  Subst &subst,
                                  ClassOrNamespace *enclosingTemplateClassInstantiation);
    bool isInstantiateNestedClassNeeded(const QList<Symbol *>& symbols, const Subst &subst) const;
121 122
    ClassOrNamespace *findSpecializationWithPointer(const TemplateNameId *templId,
                                           const TemplateNameIdTable &specializations);
123

124 125 126 127
    CreateBindings *_factory;
    ClassOrNamespace *_parent;
    QList<Symbol *> _symbols;
    QList<ClassOrNamespace *> _usings;
128
    Table _classOrNamespaces;
129 130
    QList<Enum *> _enums;
    QList<Symbol *> _todo;
131
    QSharedPointer<Control> _control;
132
    TemplateNameIdTable _specializations;
133
    QMap<const TemplateNameId *, ClassOrNamespace *> _instantiations;
134

135 136
    QHash<Internal::FullyQualifiedName, Symbol *> *_scopeLookupCache;

137 138
    // it's an instantiation.
    const TemplateNameId *_templateId;
139
    ClassOrNamespace *_instantiationOrigin;
140

141 142 143
    AlreadyConsideredClassContainer<Class> _alreadyConsideredClasses;
    AlreadyConsideredClassContainer<TemplateNameId> _alreadyConsideredTemplates;

144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
    class NestedClassInstantiator
    {
    public:
        NestedClassInstantiator(CreateBindings *factory, Clone &cloner, Subst &subst)
            : _factory(factory)
            , _cloner(cloner)
            , _subst(subst)
        {}
        void instantiate(ClassOrNamespace *enclosingTemplateClass,
                         ClassOrNamespace *enclosingTemplateClassInstantiation);
    private:
        bool isInstantiateNestedClassNeeded(const QList<Symbol *> &symbols) const;
        bool containsTemplateType(Declaration *declaration) const;
        bool containsTemplateType(Function *function) const;
        NamedType *findMemberNamedType(Type *memberType) const;

        QSet<ClassOrNamespace *> _alreadyConsideredNestedClassInstantiations;
        CreateBindings *_factory;
        Clone &_cloner;
        Subst &_subst;
    };

166
#ifdef DEBUG_LOOKUP
167
public:
168 169 170
    const Name *_name;
#endif // DEBUG_LOOKUP

171 172 173 174 175 176 177 178
    friend class CreateBindings;
};

class CPLUSPLUS_EXPORT CreateBindings: protected SymbolVisitor
{
    Q_DISABLE_COPY(CreateBindings)

public:
179
    CreateBindings(Document::Ptr thisDocument, const Snapshot &snapshot, QSharedPointer<Control> control);
180 181
    virtual ~CreateBindings();

182
    /// Returns the binding for the global namespace.
183 184
    ClassOrNamespace *globalNamespace() const;

185
    /// Finds the binding associated to the given symbol.
186 187 188 189
    ClassOrNamespace *lookupType(Symbol *symbol,
                                 ClassOrNamespace* enclosingTemplateInstantiation = 0);
    ClassOrNamespace *lookupType(const QList<const Name *> &path,
                                 ClassOrNamespace* enclosingTemplateInstantiation = 0);
190 191

    /// Returns the Control that must be used to create temporary symbols.
192
    /// \internal
193
    QSharedPointer<Control> control() const;
194

195 196 197 198 199
    bool expandTemplates() const
    { return _expandTemplates; }
    void setExpandTemplates(bool expandTemplates)
    { _expandTemplates = expandTemplates; }

200 201
    /// Searches in \a scope for symbols with the given \a name.
    /// Store the result in \a results.
202
    /// \internal
203 204
    void lookupInScope(const Name *name, Scope *scope, QList<LookupItem> *result,
                            const TemplateNameId *templateId, ClassOrNamespace *binding);
205

206
    /// Create bindings for the symbols reachable from \a rootSymbol.
207
    /// \internal
208
    void process(Symbol *rootSymbol, ClassOrNamespace *classOrNamespace);
209

210
    /// Create an empty ClassOrNamespace binding with the given \a parent.
211
    /// \internal
Roberto Raggi's avatar
Roberto Raggi committed
212
    ClassOrNamespace *allocClassOrNamespace(ClassOrNamespace *parent);
213

214 215 216
protected:
    using SymbolVisitor::visit;

217
    /// Change the current ClassOrNamespace binding.
Roberto Raggi's avatar
Roberto Raggi committed
218
    ClassOrNamespace *switchCurrentClassOrNamespace(ClassOrNamespace *classOrNamespace);
219

220 221 222 223 224 225 226 227 228 229 230 231
    /// Enters the ClassOrNamespace binding associated with the given \a symbol.
    ClassOrNamespace *enterClassOrNamespaceBinding(Symbol *symbol);

    /// Enters a ClassOrNamespace binding for the given \a symbol in the global
    /// namespace binding.
    ClassOrNamespace *enterGlobalClassOrNamespace(Symbol *symbol);

    /// Creates bindings for the given \a document.
    void process(Document::Ptr document);

    /// Creates bindings for the symbols reachable from the \a root symbol.
    void process(Symbol *root);
232

233
    virtual bool visit(Template *templ);
234 235 236 237 238 239 240 241
    virtual bool visit(Namespace *ns);
    virtual bool visit(Class *klass);
    virtual bool visit(ForwardClassDeclaration *klass);
    virtual bool visit(Enum *e);
    virtual bool visit(Declaration *decl);
    virtual bool visit(Function *);
    virtual bool visit(BaseClass *b);
    virtual bool visit(UsingNamespaceDirective *u);
Roberto Raggi's avatar
Roberto Raggi committed
242
    virtual bool visit(UsingDeclaration *u);
243 244 245 246 247 248 249 250 251 252 253 254
    virtual bool visit(NamespaceAlias *a);

    virtual bool visit(ObjCClass *klass);
    virtual bool visit(ObjCBaseClass *b);
    virtual bool visit(ObjCForwardClassDeclaration *klass);
    virtual bool visit(ObjCProtocol *proto);
    virtual bool visit(ObjCBaseProtocol *b);
    virtual bool visit(ObjCForwardProtocolDeclaration *proto);
    virtual bool visit(ObjCMethod *);

private:
    Snapshot _snapshot;
255
    QSharedPointer<Control> _control;
256 257 258 259
    QSet<Namespace *> _processed;
    QList<ClassOrNamespace *> _entities;
    ClassOrNamespace *_globalNamespace;
    ClassOrNamespace *_currentClassOrNamespace;
260
    bool _expandTemplates;
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
};

class CPLUSPLUS_EXPORT LookupContext
{
public:
    LookupContext();

    LookupContext(Document::Ptr thisDocument,
                  const Snapshot &snapshot);

    LookupContext(Document::Ptr expressionDocument,
                  Document::Ptr thisDocument,
                  const Snapshot &snapshot);

    LookupContext(const LookupContext &other);
    LookupContext &operator = (const LookupContext &other);

    Document::Ptr expressionDocument() const;
    Document::Ptr thisDocument() const;
    Document::Ptr document(const QString &fileName) const;
    Snapshot snapshot() const;

    ClassOrNamespace *globalNamespace() const;

285
    QList<LookupItem> lookup(const Name *name, Scope *scope) const;
286 287 288 289
    ClassOrNamespace *lookupType(const Name *name, Scope *scope,
                                 ClassOrNamespace* enclosingTemplateInstantiation = 0) const;
    ClassOrNamespace *lookupType(Symbol *symbol,
                                 ClassOrNamespace* enclosingTemplateInstantiation = 0) const;
290
    ClassOrNamespace *lookupParent(Symbol *symbol) const;
291 292 293 294 295 296 297

    /// \internal
    QSharedPointer<CreateBindings> bindings() const;

    /// \internal
    void setBindings(QSharedPointer<CreateBindings> bindings);

298
    QSharedPointer<Control> control() const; // ### deprecate
299

300
    static QList<const Name *> fullyQualifiedName(Symbol *symbol);
301
    static QList<const Name *> path(Symbol *symbol);
302

303
    static const Name *minimalName(Symbol *symbol, ClassOrNamespace *target, Control *control);
304

305
    void setExpandTemplates(bool expandTemplates)
306 307 308 309 310
    {
        if (_bindings)
            _bindings->setExpandTemplates(expandTemplates);
        m_expandTemplates = expandTemplates;
    }
311

312 313 314 315 316 317 318 319 320 321 322 323
private:
    // The current expression.
    Document::Ptr _expressionDocument;

    // The current document.
    Document::Ptr _thisDocument;

    // All documents.
    Snapshot _snapshot;

    // Bindings
    mutable QSharedPointer<CreateBindings> _bindings;
324 325

    QSharedPointer<Control> _control;
326 327

    bool m_expandTemplates;
328 329
};

330 331 332 333
bool CPLUSPLUS_EXPORT compareFullyQualifiedName(const QList<const Name *> &path,
                                                const QList<const Name *> &other);


334
} // namespace CPlusPlus
335 336

#endif // CPLUSPLUS_LOOKUPCONTEXT_H