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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
|
/**
* Copyright (C) 2020-present MongoDB, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* 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
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* <http://www.mongodb.com/licensing/server-side-public-license>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the Server Side Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#pragma once
#include "mongo/db/query/tree_walker.h"
namespace mongo {
class AlwaysFalseMatchExpression;
class AlwaysTrueMatchExpression;
class AndMatchExpression;
class BitsAllClearMatchExpression;
class BitsAllSetMatchExpression;
class BitsAnyClearMatchExpression;
class BitsAnySetMatchExpression;
class ElemMatchObjectMatchExpression;
class ElemMatchValueMatchExpression;
class EqualityMatchExpression;
class ExistsMatchExpression;
class ExprMatchExpression;
class GTEMatchExpression;
class GTMatchExpression;
class GeoMatchExpression;
class GeoNearMatchExpression;
class InMatchExpression;
class InternalBucketGeoWithinMatchExpression;
class InternalExprEqMatchExpression;
class InternalExprGTMatchExpression;
class InternalExprGTEMatchExpression;
class InternalExprLTMatchExpression;
class InternalExprLTEMatchExpression;
class BetweenMatchExpression;
class InternalSchemaAllElemMatchFromIndexMatchExpression;
class InternalSchemaAllowedPropertiesMatchExpression;
class InternalSchemaBinDataEncryptedTypeExpression;
class InternalSchemaBinDataFLE2EncryptedTypeExpression;
class InternalSchemaBinDataSubTypeExpression;
class InternalSchemaCondMatchExpression;
class InternalSchemaEqMatchExpression;
class InternalSchemaFmodMatchExpression;
class InternalSchemaMatchArrayIndexMatchExpression;
class InternalSchemaMaxItemsMatchExpression;
class InternalSchemaMaxLengthMatchExpression;
class InternalSchemaMaxPropertiesMatchExpression;
class InternalSchemaMinItemsMatchExpression;
class InternalSchemaMinLengthMatchExpression;
class InternalSchemaMinPropertiesMatchExpression;
class InternalSchemaObjectMatchExpression;
class InternalSchemaRootDocEqMatchExpression;
class InternalSchemaTypeExpression;
class InternalSchemaUniqueItemsMatchExpression;
class InternalSchemaXorMatchExpression;
class LTEMatchExpression;
class LTMatchExpression;
class ModMatchExpression;
class NorMatchExpression;
class NotMatchExpression;
class OrMatchExpression;
class RegexMatchExpression;
class SizeMatchExpression;
class TextMatchExpression;
class TextNoOpMatchExpression;
class TwoDPtInAnnulusExpression;
class TypeMatchExpression;
class WhereMatchExpression;
class WhereNoOpMatchExpression;
/**
* Visitor pattern for the MatchExpression tree.
*
* This code is not responsible for traversing the tree, only for performing the double-dispatch.
*
* If the visitor doesn't intend to modify the tree, then the template argument 'IsConst' should be
* set to 'true'. In this case all 'visit()' methods will take a const pointer to a visiting node.
*/
template <bool IsConst = false>
class MatchExpressionVisitor {
public:
template <typename T>
using MaybeConstPtr = tree_walker::MaybeConstPtr<IsConst, T>;
virtual ~MatchExpressionVisitor() = default;
virtual void visit(MaybeConstPtr<AlwaysFalseMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<AlwaysTrueMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<AndMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<BitsAllClearMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<BitsAllSetMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<BitsAnyClearMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<BitsAnySetMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<ElemMatchObjectMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<ElemMatchValueMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<EqualityMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<ExistsMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<ExprMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<GTEMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<GTMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<GeoMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<GeoNearMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<InMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<InternalBucketGeoWithinMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<InternalExprEqMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<InternalExprGTMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<InternalExprGTEMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<InternalExprLTMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<InternalExprLTEMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<InternalSchemaAllElemMatchFromIndexMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<InternalSchemaAllowedPropertiesMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<InternalSchemaBinDataEncryptedTypeExpression> expr) = 0;
virtual void visit(MaybeConstPtr<InternalSchemaBinDataFLE2EncryptedTypeExpression> expr) = 0;
virtual void visit(MaybeConstPtr<InternalSchemaBinDataSubTypeExpression> expr) = 0;
virtual void visit(MaybeConstPtr<InternalSchemaCondMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<InternalSchemaEqMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<InternalSchemaFmodMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<InternalSchemaMatchArrayIndexMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<InternalSchemaMaxItemsMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<InternalSchemaMaxLengthMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<InternalSchemaMaxPropertiesMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<InternalSchemaMinItemsMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<InternalSchemaMinLengthMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<InternalSchemaMinPropertiesMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<InternalSchemaObjectMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<InternalSchemaRootDocEqMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<InternalSchemaTypeExpression> expr) = 0;
virtual void visit(MaybeConstPtr<InternalSchemaUniqueItemsMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<InternalSchemaXorMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<LTEMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<LTMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<ModMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<NorMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<NotMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<OrMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<RegexMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<SizeMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<TextMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<TextNoOpMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<TwoDPtInAnnulusExpression> expr) = 0;
virtual void visit(MaybeConstPtr<TypeMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<WhereMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<WhereNoOpMatchExpression> expr) = 0;
virtual void visit(MaybeConstPtr<BetweenMatchExpression> expr) = 0;
};
using MatchExpressionMutableVisitor = MatchExpressionVisitor<false>;
using MatchExpressionConstVisitor = MatchExpressionVisitor<true>;
/**
* This class provides null implementations for all visit methods so that a derived class can
* override visit method(s) only for interested 'MatchExpression' types. For example, if one wants
* to visit only 'EqualityMatchExpression', one can override only void visit(const
* EqualityMatchExpression*).
*
* struct EqVisitor : public SelectiveMatchExpressionVisitorBase<true> {
* // To avoid overloaded-virtual warnings.
* using SelectiveMatchExpressionVisitorBase<true>::visit;
*
* void visit(const EqualityMatchExpression* expr) final {
* // logic for what to do with an EqualityMatchExpression.
* }
* };
*
* NOTE: Take caution when deriving from this class as you lose the compile-time safety of ensuring
* that new expressions must consider the impact in the corresponding visitor implementation.
*/
template <bool IsConst>
struct SelectiveMatchExpressionVisitorBase : public MatchExpressionVisitor<IsConst> {
template <typename T>
using MaybeConstPtr = tree_walker::MaybeConstPtr<IsConst, T>;
void visit(MaybeConstPtr<AlwaysFalseMatchExpression> expr) override {}
void visit(MaybeConstPtr<AlwaysTrueMatchExpression> expr) override {}
void visit(MaybeConstPtr<AndMatchExpression> expr) override {}
void visit(MaybeConstPtr<BitsAllClearMatchExpression> expr) override {}
void visit(MaybeConstPtr<BitsAllSetMatchExpression> expr) override {}
void visit(MaybeConstPtr<BitsAnyClearMatchExpression> expr) override {}
void visit(MaybeConstPtr<BitsAnySetMatchExpression> expr) override {}
void visit(MaybeConstPtr<ElemMatchObjectMatchExpression> expr) override {}
void visit(MaybeConstPtr<ElemMatchValueMatchExpression> expr) override {}
void visit(MaybeConstPtr<EqualityMatchExpression> expr) override {}
void visit(MaybeConstPtr<ExistsMatchExpression> expr) override {}
void visit(MaybeConstPtr<ExprMatchExpression> expr) override {}
void visit(MaybeConstPtr<GTEMatchExpression> expr) override {}
void visit(MaybeConstPtr<GTMatchExpression> expr) override {}
void visit(MaybeConstPtr<GeoMatchExpression> expr) override {}
void visit(MaybeConstPtr<GeoNearMatchExpression> expr) override {}
void visit(MaybeConstPtr<InMatchExpression> expr) override {}
void visit(MaybeConstPtr<InternalBucketGeoWithinMatchExpression> expr) override {}
void visit(MaybeConstPtr<InternalExprEqMatchExpression> expr) override {}
void visit(MaybeConstPtr<InternalExprGTMatchExpression> expr) override {}
void visit(MaybeConstPtr<InternalExprGTEMatchExpression> expr) override {}
void visit(MaybeConstPtr<InternalExprLTMatchExpression> expr) override {}
void visit(MaybeConstPtr<InternalExprLTEMatchExpression> expr) override {}
void visit(MaybeConstPtr<InternalSchemaAllElemMatchFromIndexMatchExpression> expr) override {}
void visit(MaybeConstPtr<InternalSchemaAllowedPropertiesMatchExpression> expr) override {}
void visit(MaybeConstPtr<InternalSchemaBinDataEncryptedTypeExpression> expr) override {}
void visit(MaybeConstPtr<InternalSchemaBinDataFLE2EncryptedTypeExpression> expr) override {}
void visit(MaybeConstPtr<InternalSchemaBinDataSubTypeExpression> expr) override {}
void visit(MaybeConstPtr<InternalSchemaCondMatchExpression> expr) override {}
void visit(MaybeConstPtr<InternalSchemaEqMatchExpression> expr) override {}
void visit(MaybeConstPtr<InternalSchemaFmodMatchExpression> expr) override {}
void visit(MaybeConstPtr<InternalSchemaMatchArrayIndexMatchExpression> expr) override {}
void visit(MaybeConstPtr<InternalSchemaMaxItemsMatchExpression> expr) override {}
void visit(MaybeConstPtr<InternalSchemaMaxLengthMatchExpression> expr) override {}
void visit(MaybeConstPtr<InternalSchemaMaxPropertiesMatchExpression> expr) override {}
void visit(MaybeConstPtr<InternalSchemaMinItemsMatchExpression> expr) override {}
void visit(MaybeConstPtr<InternalSchemaMinLengthMatchExpression> expr) override {}
void visit(MaybeConstPtr<InternalSchemaMinPropertiesMatchExpression> expr) override {}
void visit(MaybeConstPtr<InternalSchemaObjectMatchExpression> expr) override {}
void visit(MaybeConstPtr<InternalSchemaRootDocEqMatchExpression> expr) override {}
void visit(MaybeConstPtr<InternalSchemaTypeExpression> expr) override {}
void visit(MaybeConstPtr<InternalSchemaUniqueItemsMatchExpression> expr) override {}
void visit(MaybeConstPtr<InternalSchemaXorMatchExpression> expr) override {}
void visit(MaybeConstPtr<LTEMatchExpression> expr) override {}
void visit(MaybeConstPtr<LTMatchExpression> expr) override {}
void visit(MaybeConstPtr<ModMatchExpression> expr) override {}
void visit(MaybeConstPtr<NorMatchExpression> expr) override {}
void visit(MaybeConstPtr<NotMatchExpression> expr) override {}
void visit(MaybeConstPtr<OrMatchExpression> expr) override {}
void visit(MaybeConstPtr<RegexMatchExpression> expr) override {}
void visit(MaybeConstPtr<SizeMatchExpression> expr) override {}
void visit(MaybeConstPtr<TextMatchExpression> expr) override {}
void visit(MaybeConstPtr<TextNoOpMatchExpression> expr) override {}
void visit(MaybeConstPtr<TwoDPtInAnnulusExpression> expr) override {}
void visit(MaybeConstPtr<TypeMatchExpression> expr) override {}
void visit(MaybeConstPtr<WhereMatchExpression> expr) override {}
void visit(MaybeConstPtr<WhereNoOpMatchExpression> expr) override {}
void visit(MaybeConstPtr<BetweenMatchExpression> expr) override {}
};
} // namespace mongo
|
