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
|
/**
* 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 <map>
#include <string>
#include "mongo/base/clonable_ptr.h"
#include "mongo/db/field_ref.h"
#include "mongo/db/update/update_node.h"
namespace mongo {
/**
* An internal node in the prefix tree of update modifier expressions. See comment in class
* definition of UpdateNode for more details.
*/
class UpdateInternalNode : public UpdateNode {
public:
/**
* Helper class for appending to a FieldRef for the duration of the current scope and then
* restoring the FieldRef at the end of the scope.
*/
class FieldRefTempAppend {
public:
FieldRefTempAppend(FieldRef& fieldRef, StringData part) : _fieldRef(fieldRef) {
_fieldRef.appendPart(part);
}
~FieldRefTempAppend() {
_fieldRef.removeLastPart();
}
private:
FieldRef& _fieldRef;
};
UpdateInternalNode(UpdateNode::Type type) : UpdateNode(type) {}
/**
* Returns the child with field name 'field' or nullptr if there is no such child.
*/
virtual UpdateNode* getChild(const std::string& field) const = 0;
/**
* Adds a child with field name 'field'. The node must not already have a child with field
* name 'field'.
*/
virtual void setChild(std::string field, std::unique_ptr<UpdateNode> child) = 0;
protected:
/**
* Helper for subclass implementations needing to produce the syntax for applied array filters.
*/
static std::string toArrayFilterIdentifier(const std::string& fieldName) {
return "$[" + fieldName + "]";
}
/**
* Helper for subclass implementations of createUpdateNodeByMerging. Any UpdateNode value whose
* key is only in 'leftMap' or only in 'rightMap' is cloned and added to the output map. If the
* key is in both maps, the two UpdateNodes are merged and added to the output map. If
* wrapFieldNameAsArrayFilterIdentifier is true, field names are wrapped as $[<field name>] for
* error reporting.
*/
static std::map<std::string, clonable_ptr<UpdateNode>> createUpdateNodeMapByMerging(
const std::map<std::string, clonable_ptr<UpdateNode>>& leftMap,
const std::map<std::string, clonable_ptr<UpdateNode>>& rightMap,
FieldRef* pathTaken,
bool wrapFieldNameAsArrayFilterIdentifier = false);
/**
* Helper for subclass implementations of createUpdateNodeByMerging. If one of 'leftNode' or
* 'rightNode' is non-null, we clone it. If 'leftNode' and 'rightNode' are both non-null, we
* merge them recursively. If 'leftNode' and 'rightNode' are both null, we return nullptr. If
* wrapFieldNameAsArrayFilterIdentifier is true, field names are wrapped as $[<field name>] for
* error reporting.
*/
static std::unique_ptr<UpdateNode> copyOrMergeAsNecessary(
UpdateNode* leftNode,
UpdateNode* rightNode,
FieldRef* pathTaken,
const std::string& nextField,
bool wrapFieldNameAsArrayFilterIdentifier = false);
};
} // namespace mongo
|
