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
|
/**
* 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.
*/
#include "mongo/db/jsobj.h"
#include "mongo/db/matcher/expression_parser.h"
#include "mongo/util/mongoutils/str.h"
namespace mongo {
class ParsedProjection {
public:
// TODO: this is duplicated in here and in the proj exec code. When we have
// ProjectionExpression we can remove dups.
enum ArrayOpType {
ARRAY_OP_NORMAL = 0,
ARRAY_OP_ELEM_MATCH,
ARRAY_OP_POSITIONAL
};
/**
* Parses the projection 'spec' and checks its validity with respect to the query 'query'.
* Puts covering information into 'out'.
*
* Returns Status::OK() if it's a valid spec.
* Returns a Status indicating how it's invalid otherwise.
*/
static Status make(const BSONObj& spec, const MatchExpression* const query,
ParsedProjection** out);
/**
* Is the full document required to compute this projection?
*/
bool requiresDocument() const { return _requiresDocument; }
/**
* If requiresDocument() == false, what fields are required to compute
* the projection?
*/
const vector<string>& getRequiredFields() const {
return _requiredFields;
}
/**
* Get the raw BSONObj proj spec obj
*/
const BSONObj& getProjObj() const {
return _source;
}
private:
/**
* Must go through ::make
*/
ParsedProjection() : _requiresDocument(true) { }
/**
* Returns true if the MatchExpression 'query' queries against
* the field named by 'matchfield'. This deeply traverses logical
* nodes in the matchfield and returns true if any of the children
* have the field (so if 'query' is {$and: [{a: 1}, {b: 1}]} and
* 'matchfield' is "b", the return value is true).
*
* Does not take ownership of 'query'.
*/
static bool _hasPositionalOperatorMatch(const MatchExpression* const query,
const std::string& matchfield);
// XXX stringdata?
vector<string> _requiredFields;
bool _requiresDocument;
BSONObj _source;
};
} // namespace mongo
|