blob: d8a8984b9f0a941f2621d733af3b4f08b8c75d20 (
plain)
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
|
/**
* Copyright (c) 2011 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 "mongo/pch.h"
namespace mongo {
class FieldPath {
public:
/**
* Constructor.
*
* @param fieldPath the dotted field path string or non empty pre-split vector.
* The constructed object will have getPathLength() > 0.
* Uassert if any component field names do not pass validation.
*/
FieldPath(const string& fieldPath);
FieldPath(const vector<string>& fieldPath);
/**
Get the number of path elements in the field path.
@returns the number of path elements
*/
size_t getPathLength() const;
/**
Get a particular path element from the path.
@param i the zero based index of the path element.
@returns the path element
*/
const string& getFieldName(size_t i) const;
/**
Get the full path.
@param fieldPrefix whether or not to include the field prefix
@returns the complete field path
*/
string getPath(bool fieldPrefix) const;
/**
Write the full path.
@param outStream where to write the path to
@param fieldPrefix whether or not to include the field prefix
*/
void writePath(ostream &outStream, bool fieldPrefix) const;
/**
Get the prefix string.
@returns the prefix string
*/
static const char *getPrefix();
static const char prefix[];
/**
* A FieldPath like this but missing the first element (useful for recursion).
* Precondition getPathLength() > 1.
*/
FieldPath tail() const;
private:
/** Uassert if a field name does not pass validation. */
static void uassertValidFieldName(const string& fieldName);
/**
* Push a new field name to the back of the vector of names comprising the field path.
* Uassert if 'fieldName' does not pass validation.
*/
void pushFieldName(const string& fieldName);
vector<string> vFieldName;
};
}
/* ======================= INLINED IMPLEMENTATIONS ========================== */
namespace mongo {
inline size_t FieldPath::getPathLength() const {
return vFieldName.size();
}
inline const string& FieldPath::getFieldName(size_t i) const {
dassert(i < getPathLength());
return vFieldName[i];
}
inline const char *FieldPath::getPrefix() {
return prefix;
}
}
|
