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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
/******************************************************************************
*
* Copyright (C) 1997-2020 by Dimitri van Heesch.
*
* Permission to use, copy, modify, and distribute this software and its
* documentation under the terms of the GNU General Public License is hereby
* granted. No representations are made about the suitability of this software
* for any purpose. It is provided "as is" without express or implied warranty.
* See the GNU General Public License for more details.
*
* Documents produced by Doxygen are derivative works derived from the
* input used in their production; they are not affected by this license.
*
*/
#ifndef SCOPEDTYPEVARIANT_H
#define SCOPEDTYPEVARIANT_H
#include <utility>
#include <vector>
#include <variant>
#include "qcstring.h"
#include "definition.h"
//! Class representing a local class definition found while
//! generating syntax highlighted code.
class LocalDef
{
public:
void insertBaseClass(const QCString &name) { m_baseClasses.push_back(name); }
std::vector<QCString> baseClasses() const { return m_baseClasses; }
private:
std::vector<QCString> m_baseClasses;
};
//-----------------------------------------------------------------------------
/*! Variant class for a scoped type.
*
* Variants:
* - DummyDef: a type used for hiding a global type.
* - LocalDef: a locally defined type (e.g. found inside a function)
* - GlobalDef: a globally defined type (processed by doxygen in an earlier pass).
*/
class ScopedTypeVariant
{
public:
struct DummyDef {};
using GlobalDef = const Definition *;
using Variant = std::variant<DummyDef,LocalDef,GlobalDef>;
explicit ScopedTypeVariant(GlobalDef d = nullptr)
: m_name(d ? d->name() : QCString()), m_variant(d ? Variant(d) : Variant(DummyDef())) {}
explicit ScopedTypeVariant(const QCString &name)
: m_name(name), m_variant(LocalDef()) {}
QCString name() const { return m_name; }
LocalDef *localDef() { return std::get_if<LocalDef>(&m_variant); }
const LocalDef *localDef() const { return std::get_if<LocalDef>(&m_variant); }
const Definition *globalDef() const { auto pp = std::get_if<GlobalDef>(&m_variant); return pp ? *pp : nullptr; }
bool isDummy() const { return std::holds_alternative<DummyDef>(m_variant); }
private:
QCString m_name;
Variant m_variant;
};
//-----------------------------------------------------------------------------
/*! Represents a stack of variable to class mappings as found in the
* code. Each scope is enclosed in pushScope() and popScope() calls.
* Variables are added by calling addVariables() and one can search
* for variable using findVariable().
*/
class VariableContext
{
public:
using Scope = std::unordered_map<std::string,ScopedTypeVariant>;
void pushScope()
{
m_scopes.push_back(Scope());
}
void popScope()
{
if (!m_scopes.empty())
{
m_scopes.pop_back();
}
}
void clear()
{
m_scopes.clear();
m_globalScope.clear();
}
void clearExceptGlobal()
{
m_scopes.clear();
}
void addVariable(const QCString &name,ScopedTypeVariant stv)
{
Scope *scope = m_scopes.empty() ? &m_globalScope : &m_scopes.back();
scope->emplace(std::make_pair(name.str(),std::move(stv))); // add it to a list
}
const ScopedTypeVariant *findVariable(const QCString &name)
{
const ScopedTypeVariant *result = 0;
if (name.isEmpty()) return result;
// search from inner to outer scope
auto it = std::rbegin(m_scopes);
while (it != std::rend(m_scopes))
{
auto it2 = it->find(name.str());
if (it2 != std::end(*it))
{
result = &it2->second;
return result;
}
++it;
}
// nothing found -> also try the global scope
auto it2 = m_globalScope.find(name.str());
if (it2 != m_globalScope.end())
{
result = &it2->second;
}
return result;
}
bool atGlobalScope() const { return m_scopes.empty(); }
private:
Scope m_globalScope;
std::vector<Scope> m_scopes;
};
//-----------------------------------------------------------------------------
/** Represents the call context */
class CallContext
{
public:
struct Ctx
{
Ctx(const QCString &name_,const QCString &type_) : name(name_), type(type_) {}
QCString name;
QCString type;
ScopedTypeVariant stv;
};
CallContext()
{
clear();
}
void setScope(const ScopedTypeVariant &stv)
{
Ctx &ctx = m_stvList.back();
ctx.stv=stv;
}
void pushScope(const QCString &name_,const QCString &type_)
{
m_stvList.push_back(Ctx(name_,type_));
}
void popScope(QCString &name_,QCString &type_)
{
if (m_stvList.size()>1)
{
const Ctx &ctx = m_stvList.back();
name_ = ctx.name;
type_ = ctx.type;
m_stvList.pop_back();
}
}
void clear()
{
m_stvList.clear();
m_stvList.push_back(Ctx(QCString(),QCString()));
}
const ScopedTypeVariant getScope() const
{
return m_stvList.back().stv;
}
private:
std::vector<Ctx> m_stvList;
};
#endif
|
