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
|
/**
* Copyright (C) 2018-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 <set>
#include <vector>
#include "mongo/base/status.h"
#include "mongo/db/field_ref.h"
namespace mongo {
/**
* A FieldRefSet holds a number of unique FieldRefs - a set of dotted paths into a document.
*
* The FieldRefSet provides helpful functions for efficiently finding conflicts between field
* ref paths - field ref paths conflict if they are equal to each other or if one is a prefix.
* To maintain a FieldRefSet of non-conflicting paths, always use the insert method which
* returns conflicting FieldRefs.
*
* FieldRefSets do not own the FieldRef paths they contain.
*/
class FieldRefSet {
FieldRefSet(const FieldRefSet&) = delete;
FieldRefSet& operator=(const FieldRefSet&) = delete;
struct FieldRefPtrLessThan {
bool operator()(const FieldRef* lhs, const FieldRef* rhs) const;
};
typedef std::set<const FieldRef*, FieldRefPtrLessThan> FieldSet;
public:
using iterator = FieldSet::iterator;
using const_iterator = FieldSet::const_iterator;
FieldRefSet();
FieldRefSet(const std::vector<std::unique_ptr<FieldRef>>& paths);
FieldRefSet(const std::vector<const FieldRef*>& paths);
FieldRefSet(const std::vector<FieldRef*>& paths);
/** Returns 'true' if the set is empty */
bool empty() const {
return _fieldSet.empty();
}
inline const_iterator begin() const {
return _fieldSet.begin();
}
inline const_iterator end() const {
return _fieldSet.end();
}
/**
* Returns true if the path does not already exist in the set, false otherwise.
*
* Note that *no* conflict resolution occurs - any path can be inserted into a set.
*/
inline bool insert(const FieldRef* path) {
return _fieldSet.insert(path).second;
}
/**
* Returns true if the field 'toInsert' was added to the set without conflicts.
*
* Otherwise, returns false and fills '*conflict' with the field 'toInsert' clashed with.
*
* There is no ownership transfer of 'toInsert'. The caller is responsible for
* maintaining it alive for as long as the FieldRefSet is so. By the same token
* 'conflict' can only be referred to while the FieldRefSet can.
*/
bool insert(const FieldRef* toInsert, const FieldRef** conflict);
/**
* Returns true if the field 'toInsert' was added to the set without conflicts.
*/
bool insertNoConflict(const FieldRef* toInsert);
/**
* Fills the set with the supplied FieldRef pointers.
*
* Note that *no* conflict resolution occurs here.
*/
void fillFrom(const std::vector<FieldRef*>& fields);
/**
* Fills the set with the supplied FieldRefs. Does not take ownership of the managed pointers.
*
* Note that *no* conflict resolution occurs here.
*/
void fillFrom(const std::vector<std::unique_ptr<FieldRef>>& fields);
/**
* Replace any existing conflicting FieldRef with the shortest (closest to root) one.
*/
void keepShortest(const FieldRef* toInsert);
/**
* Find all inserted fields which conflict with the FieldRef 'toCheck' by the semantics
* of 'insert', and add those fields to the 'conflicts' set.
*
* Return true if conflicts were found.
*/
bool findConflicts(const FieldRef* toCheck, FieldRefSet* conflicts) const;
void clear() {
_fieldSet.clear();
}
void erase(const FieldRef* item) {
_fieldSet.erase(item);
}
/**
* A debug/log-able string
*/
std::string toString() const;
private:
// A set of field_ref pointers, none of which is owned here.
FieldSet _fieldSet;
};
/**
* A wrapper class for FieldRefSet which owns the storage of the underlying FieldRef objects.
*/
class FieldRefSetWithStorage {
public:
/**
* Inserts the given FieldRef into the set. In the case of a conflict with an existing element,
* only the shortest path is kept in the set.
*/
void keepShortest(const FieldRef& toInsert) {
const FieldRef* inserted = &(*_ownedFieldRefs.insert(toInsert).first);
_fieldRefSet.keepShortest(inserted);
}
std::vector<std::string> serialize() const {
std::vector<std::string> ret;
for (const auto fieldRef : _fieldRefSet) {
ret.push_back(fieldRef->dottedField().toString());
}
return ret;
}
bool empty() const {
return _fieldRefSet.empty();
}
void clear() {
_ownedFieldRefs.clear();
_fieldRefSet.clear();
}
std::string toString() const {
return _fieldRefSet.toString();
}
private:
// Holds the storage for FieldRef's inserted into the set. This may become out of sync with
// '_fieldRefSet' since we don't attempt to remove conflicts from the backing set, which can
// leave '_ownedFieldRefs' holding storage for a superset of the field refs that are actually
// contained in '_fieldRefSet'.
std::set<FieldRef> _ownedFieldRefs;
FieldRefSet _fieldRefSet;
};
} // namespace mongo
|
