C++ port: add C++ equivalent of FSTDocumentKey. #762
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| /* | ||
| * Copyright 2018 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. | ||
| */ | ||
|
|
||
| #include "Firestore/core/src/firebase/firestore/model/document_key.h" | ||
|
|
||
| #include <utility> | ||
|
|
||
| #include "Firestore/core/src/firebase/firestore/model/resource_path.h" | ||
| #include "Firestore/core/src/firebase/firestore/util/firebase_assert.h" | ||
|
|
||
| namespace firebase { | ||
| namespace firestore { | ||
| namespace model { | ||
|
|
||
| namespace { | ||
|
|
||
| void AssertValidPath(const ResourcePath& path) { | ||
| FIREBASE_ASSERT_MESSAGE(DocumentKey::IsDocumentKey(path), | ||
| "invalid document key path: %s", | ||
| path.CanonicalString().c_str()); | ||
| } | ||
|
|
||
| } // namespace | ||
|
|
||
| DocumentKey::DocumentKey() : path_{std::make_shared<ResourcePath>()} { | ||
| } | ||
|
|
||
| DocumentKey::DocumentKey(const ResourcePath& path) | ||
| : path_{std::make_shared<ResourcePath>(path)} { | ||
| AssertValidPath(*path_); | ||
| } | ||
|
|
||
| DocumentKey::DocumentKey(ResourcePath&& path) | ||
| : path_{std::make_shared<ResourcePath>(std::move(path))} { | ||
| AssertValidPath(*path_); | ||
| } | ||
|
|
||
| DocumentKey DocumentKey::FromPathString(const absl::string_view path) { | ||
| return DocumentKey{ResourcePath::FromString(path)}; | ||
| } | ||
|
|
||
| DocumentKey DocumentKey::FromSegments(std::initializer_list<std::string> list) { | ||
| return DocumentKey{ResourcePath{list}}; | ||
| } | ||
|
|
||
| const DocumentKey& DocumentKey::Empty() { | ||
| static DocumentKey empty; | ||
| return empty; | ||
| } | ||
|
|
||
| bool DocumentKey::IsDocumentKey(const ResourcePath& path) { | ||
| return path.size() % 2 == 0; | ||
| } | ||
|
|
||
| const ResourcePath& DocumentKey::path() const { | ||
| return path_ ? *path_ : Empty().path(); | ||
| } | ||
|
|
||
| bool operator==(const DocumentKey& lhs, const DocumentKey& rhs) { | ||
| return lhs.path() == rhs.path(); | ||
| } | ||
| bool operator!=(const DocumentKey& lhs, const DocumentKey& rhs) { | ||
| return lhs.path() != rhs.path(); | ||
| } | ||
| bool operator<(const DocumentKey& lhs, const DocumentKey& rhs) { | ||
| return lhs.path() < rhs.path(); | ||
| } | ||
| bool operator<=(const DocumentKey& lhs, const DocumentKey& rhs) { | ||
| return lhs.path() <= rhs.path(); | ||
| } | ||
| bool operator>(const DocumentKey& lhs, const DocumentKey& rhs) { | ||
| return lhs.path() > rhs.path(); | ||
| } | ||
| bool operator>=(const DocumentKey& lhs, const DocumentKey& rhs) { | ||
| return lhs.path() >= rhs.path(); | ||
| } | ||
|
|
||
| } // namespace model | ||
| } // namespace firestore | ||
| } // namespace firebase | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| /* | ||
| * Copyright 2018 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. | ||
| */ | ||
|
|
||
| #ifndef FIRESTORE_CORE_SRC_FIREBASE_FIRESTORE_MODEL_DOCUMENT_KEY_H_ | ||
| #define FIRESTORE_CORE_SRC_FIREBASE_FIRESTORE_MODEL_DOCUMENT_KEY_H_ | ||
|
|
||
| #include <initializer_list> | ||
| #include <memory> | ||
| #include <string> | ||
|
|
||
| #include "absl/strings/string_view.h" | ||
|
|
||
| namespace firebase { | ||
| namespace firestore { | ||
| namespace model { | ||
|
|
||
| class ResourcePath; | ||
|
||
|
|
||
| /** | ||
| * DocumentKey represents the location of a document in the Firestore database. | ||
| */ | ||
| class DocumentKey { | ||
|
Member
There was a problem hiding this comment. uber-nit: Some of your methods have a blank line after them (eg lines 39, 51, 58, etc) while others don't (eg 34,45, 68, etc). Consider unifying.
Contributor
Author
There was a problem hiding this comment. I'm trying to group together more-or-less related methods. So I'm mildly in favor of keeping (provided it's not against the style guide), but not too much against removing as well.
Member
There was a problem hiding this comment. AFAICT, it's not at all against the style guide. From the examples listed, the style guide usually omits blank lines after methods that are entirely contained on a single line, but adds them when the definition spans lines. (See guide for examples). But I don't think there's any requirement here. I'm fine with it as is.
Contributor
There was a problem hiding this comment. Please port comments: /** DocumentKey represents the location of a document in the Firestore database. */ |
||
| public: | ||
| /** Creates a "blank" document key not associated with any document. */ | ||
| DocumentKey(); | ||
|
|
||
| /** Creates a new document key containing a copy of the given path. */ | ||
| explicit DocumentKey(const ResourcePath& path); | ||
|
|
||
| /** Creates a new document key, taking ownership of the given path. */ | ||
| explicit DocumentKey(ResourcePath&& path); | ||
|
|
||
| /** | ||
| * Creates and returns a new document key using '/' to split the string into | ||
| * segments. | ||
| */ | ||
| static DocumentKey FromPathString(absl::string_view path); | ||
|
|
||
| /** Creates and returns a new document key with the given segments. */ | ||
| static DocumentKey FromSegments(std::initializer_list<std::string> list); | ||
|
|
||
| /** Returns a shared instance of an empty document key. */ | ||
| static const DocumentKey& Empty(); | ||
|
|
||
| /** Returns true iff the given path is a path to a document. */ | ||
| static bool IsDocumentKey(const ResourcePath& path); | ||
| /** The path to the document. */ | ||
|
|
||
| const ResourcePath& path() const; | ||
|
|
||
| private: | ||
| // This is an optimization to make passing DocumentKey around cheaper (it's | ||
| // copied often). | ||
| std::shared_ptr<const ResourcePath> path_; | ||
| }; | ||
|
|
||
| bool operator==(const DocumentKey& lhs, const DocumentKey& rhs); | ||
| bool operator!=(const DocumentKey& lhs, const DocumentKey& rhs); | ||
| bool operator<(const DocumentKey& lhs, const DocumentKey& rhs); | ||
| bool operator<=(const DocumentKey& lhs, const DocumentKey& rhs); | ||
| bool operator>(const DocumentKey& lhs, const DocumentKey& rhs); | ||
| bool operator>=(const DocumentKey& lhs, const DocumentKey& rhs); | ||
|
|
||
| } // namespace model | ||
| } // namespace firestore | ||
| } // namespace firebase | ||
|
|
||
| #endif // FIRESTORE_CORE_SRC_FIREBASE_FIRESTORE_MODEL_DOCUMENT_KEY_H_ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be
static const DocumentKey empty?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.