blob: f127156d7e84518935ea609d1e8bfd1692705955 (
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
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
|
/*
* Copyright 2017 Google
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#import <Foundation/Foundation.h>
#include "Firestore/core/src/firebase/firestore/model/field_path.h"
#include "Firestore/core/src/firebase/firestore/model/resource_path.h"
NS_ASSUME_NONNULL_BEGIN
/**
* FSTPath represents a path sequence in the Firestore database. It is composed of an ordered
* sequence of string segments.
*
* ## Subclassing Notes
*
* FSTPath itself is an abstract class that must be specialized by subclasses. Subclasses should
* implement constructors for common string-based representations of the path and also override
* -canonicalString which converts back to the canonical string-based representation of the path.
*/
@interface FSTPath <SelfType> : NSObject
/** Returns the path segment of the given index. */
- (NSString *)segmentAtIndex:(int)index;
- (id)objectAtIndexedSubscript:(int)index;
- (BOOL)isEqual:(id)path;
- (NSComparisonResult)compare:(SelfType)other;
/**
* Returns a new path whose segments are the current path's plus one more.
*
* @param segment The new segment to concatenate to the path.
* @return A new path with this path's segment plus the new one.
*/
- (instancetype)pathByAppendingSegment:(NSString *)segment;
/**
* Returns a new path whose segments are the current path's plus another's.
*
* @param path The new path whose segments should be concatenated to the path.
* @return A new path with this path's segment plus the new ones.
*/
- (instancetype)pathByAppendingPath:(SelfType)path;
/** Returns a new path whose segments are the same as this one's minus the first one. */
- (instancetype)pathByRemovingFirstSegment;
/** Returns a new path whose segments are the same as this one's minus the first `count`. */
- (instancetype)pathByRemovingFirstSegments:(int)count;
/** Returns a new path whose segments are the same as this one's minus the last one. */
- (instancetype)pathByRemovingLastSegment;
/** Convenience method for getting the first segment of this path. */
- (NSString *)firstSegment;
/** Convenience method for getting the last segment of this path. */
- (NSString *)lastSegment;
/** Returns true if this path is a prefix of the given path. */
- (BOOL)isPrefixOfPath:(SelfType)other;
/** Returns a standardized string representation of this path. */
- (NSString *)canonicalString;
/** The number of segments in the path. */
@property(nonatomic, readonly) int length;
/** True if the path is empty. */
@property(nonatomic, readonly, getter=isEmpty) BOOL empty;
@end
/** A dot-separated path for navigating sub-objects within a document. */
@class FSTFieldPath;
@interface FSTFieldPath : FSTPath <FSTFieldPath *>
/**
* Creates and returns a new path with the given segments. The array of segments is not copied, so
* one should not mutate the array once it is passed in here.
*
* @param segments The underlying array of segments for the path.
* @return A new instance of FSTPath.
*/
+ (instancetype)pathWithSegments:(NSArray<NSString *> *)segments;
/**
* Creates and returns a new path from the server formatted field-path string, where path segments
* are separated by a dot "." and optionally encoded using backticks.
*
* @param fieldPath A dot-separated string representing the path.
*/
+ (instancetype)pathWithServerFormat:(NSString *)fieldPath;
/** Returns a field path that represents a document key. */
+ (instancetype)keyFieldPath;
/** Returns a field path that represents an empty path. */
+ (instancetype)emptyPath;
/** Returns YES if this is the `FSTFieldPath.keyFieldPath` field path. */
- (BOOL)isKeyFieldPath;
/** Creates and returns a new path from C++ FieldPath.
*
* @param fieldPath A C++ FieldPath.
*/
+ (instancetype)fieldPathWithCPPFieldPath:(const firebase::firestore::model::FieldPath &)fieldPath;
/**
* Creates and returns a new C++ FieldPath.
*/
- (firebase::firestore::model::FieldPath)toCPPFieldPath;
@end
/** A slash-separated path for navigating resources (documents and collections) within Firestore. */
@class FSTResourcePath;
@interface FSTResourcePath : FSTPath <FSTResourcePath *>
/**
* Creates and returns a new path with the given segments. The array of segments is not copied, so
* one should not mutate the array once it is passed in here.
*
* @param segments The underlying array of segments for the path.
* @return A new instance of FSTPath.
*/
+ (instancetype)pathWithSegments:(NSArray<NSString *> *)segments;
/**
* Creates and returns a new path from the given resource-path string, where the path segments are
* separated by a slash "/".
*
* @param resourcePath A slash-separated string representing the path.
*/
+ (instancetype)pathWithString:(NSString *)resourcePath;
/** Creates and returns a new path from C++ ResourcePath.
*
* @param resourcePath A C++ ResourcePath.
*/
+ (instancetype)resourcePathWithCPPResourcePath:
(const firebase::firestore::model::ResourcePath &)resourcePath;
/**
* Creates and returns a new C++ ResourcePath.
*/
- (firebase::firestore::model::ResourcePath)toCPPResourcePath;
@end
NS_ASSUME_NONNULL_END
|
