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
|
/**
* Copyright (C) 2013 10gen Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* 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 GNU Affero General 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 "mongo/base/disallow_copying.h"
#include "mongo/base/owned_pointer_vector.h"
#include "mongo/base/status.h"
#include "mongo/db/field_ref.h"
namespace mongo {
/**
* A FieldRefSet holds a set of FieldRefs's that do not conflict with one another, that is,
* they target different subtrees of a given document. Two fieldRef's would conflict if they
* are equal or one is prefix of the other.
*/
class FieldRefSet {
MONGO_DISALLOW_COPYING(FieldRefSet);
struct FieldRefPtrLessThan {
bool operator()(const FieldRef* lhs, const FieldRef* rhs) const;
};
typedef std::set<const FieldRef*, FieldRefPtrLessThan> FieldSet;
public:
typedef FieldSet::iterator iterator;
typedef FieldSet::const_iterator const_iterator;
FieldRefSet();
/** 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 field 'toInsert' can be added in the set without
* conflicts. Otherwise returns false and fill in '*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);
/**
* Fills the set with the supplied FieldRef*s
*/
void fillFrom(const std::vector<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();
}
/**
* A debug/log-able string
*/
const std::string toString() const;
private:
// A set of field_ref pointers, none of which is owned here.
FieldSet _fieldSet;
};
} // namespace mongo
|
