File: ducontextdynamicdata.h

package info (click to toggle)
kdevelop 4%3A5.6.2-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 57,892 kB
  • sloc: cpp: 278,773; javascript: 3,558; python: 3,385; sh: 1,317; ansic: 689; xml: 273; php: 95; makefile: 40; lisp: 13; sed: 12
file content (167 lines) | stat: -rw-r--r-- 6,135 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
/***************************************************************************
*   This file is part of KDevelop                                         *
*   Copyright 2006 Hamish Rodda <rodda@kde.org>                           *
*   Copyright 2007-2008 David Nolden <david.nolden.kdevelop@art-master.de>*
*                                                                         *
*   This program is free software; you can redistribute it and/or modify  *
*   it under the terms of the GNU Library General Public License as       *
*   published by the Free Software Foundation; either version 2 of the    *
*   License, or (at your option) any later version.                       *
*                                                                         *
*   This program is distributed in the hope that it will be useful,       *
*   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
*   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
*   GNU General Public License for more details.                          *
*                                                                         *
*   You should have received a copy of the GNU Library General Public     *
*   License along with this program; if not, write to the                 *
*   Free Software Foundation, Inc.,                                       *
*   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
***************************************************************************/

#ifndef DUCONTEXTDYNAMICDATA_H
#define DUCONTEXTDYNAMICDATA_H

#include "ducontextdata.h"

namespace KDevelop {
///This class contains data that is only runtime-dependent and does not need to be stored to disk
class DUContextDynamicData
{
private:
    inline const DUContextData* d_func() const { return m_context->d_func(); }
    inline DUContextData* d_func_dynamic() { return m_context->d_func_dynamic(); }
    static inline const DUContextData* ctx_d_func(DUContext* ctx) { return ctx->d_func(); }
    static inline DUContextDynamicData* ctx_dynamicData(DUContext* ctx) { return ctx->m_dynamicData; }

public:
    explicit DUContextDynamicData(DUContext*);
    DUContextPointer m_parentContext;

    TopDUContext* m_topContext;

    uint m_indexInTopContext; //Index of this DUContext in the top-context

    DUContext* m_context;

    // cache of unserialized child contexts
    QVector<DUContext*> m_childContexts;
    // cache of unserialized local declarations
    QVector<Declaration*> m_localDeclarations;

    /**
     * Adds a child context.
     *
     * \note Be sure to have set the text location first, so that
     * the chain is sorted correctly.
     */
    void addChildContext(DUContext* context);

    /**Removes the context from childContexts
     * @return Whether a context was removed
     * */
    bool removeChildContext(DUContext* context);

    void addImportedChildContext(DUContext* context);
    void removeImportedChildContext(DUContext* context);

    void addDeclaration(Declaration* declaration);

    /**Removes the declaration from localDeclarations
     * @return Whether a declaration was removed
     * */
    bool removeDeclaration(Declaration* declaration);

    //Files the scope identifier into target
    void scopeIdentifier(bool includeClasses, QualifiedIdentifier& target) const;

    //Iterates through all visible declarations within a given context, including the ones propagated from sub-contexts
    class VisibleDeclarationIterator
    {
public:
        struct StackEntry
        {
            explicit StackEntry(const DUContextDynamicData* data = nullptr)
                : data(data)
                , index(0)
                , nextChild(0)
            {
            }

            const DUContextDynamicData* data;
            int index;
            uint nextChild;
        };

        explicit VisibleDeclarationIterator(const DUContextDynamicData* data)
            : current(data)
        {
            toValidPosition();
        }

        inline Declaration* operator*() const
        {
            return current.data ? current.data->m_localDeclarations.value(current.index) : nullptr;
        }

        inline VisibleDeclarationIterator& operator++()
        {
            ++current.index;
            toValidPosition();
            return *this;
        }

        inline operator bool() const
        {
            return current.data && !current.data->m_localDeclarations.isEmpty();
        }

        // Moves the cursor to the next valid position, from an invalid one
        void toValidPosition()
        {
            if (!current.data || current.index < current.data->m_localDeclarations.size()) {
                // still valid
                return;
            }

            do {
                // Check if we can proceed into a propagating child-context
                for (int a = current.nextChild; a < current.data->m_childContexts.size(); ++a) {
                    DUContext* child = current.data->m_childContexts[a];

                    if (ctx_d_func(child)->m_propagateDeclarations) {
                        current.nextChild = a + 1;
                        stack.append(current);
                        current = StackEntry(ctx_dynamicData(child));
                        toValidPosition();
                        return;
                    }
                }

                //Go up and into the next valid context
                if (stack.isEmpty()) {
                    current = StackEntry();
                    return;
                }

                current = stack.back();
                stack.pop_back();
            } while (true);
        }

        StackEntry current;

        KDevVarLengthArray<StackEntry> stack;
    };

    /**
     * Returns true if this context is imported by the given one, on any level.
     * */
    bool imports(const DUContext* context, const TopDUContext* source,
                 QSet<const DUContextDynamicData*>* recursionGuard) const;
};
}

Q_DECLARE_TYPEINFO(KDevelop::DUContextDynamicData::VisibleDeclarationIterator::StackEntry, Q_MOVABLE_TYPE);

#endif