v1: hint (CXX-3237, CXX-3238) (mongodb#1516)

Author: eramongodb

src/mongocxx/include/mongocxx/v1/hint.hpp

@@ -131,7 +131,7 @@ class hint {
     ///
     /// @{
     friend bool operator==(hint const& lhs, hint const& rhs) {
-        return lhs.str() == rhs.str() || lhs.doc() == rhs.doc();
+        return lhs.str() == rhs.str() && lhs.doc() == rhs.doc();
     }
 
     friend bool operator!=(hint const& lhs, hint const& rhs) {
@@ -183,6 +183,8 @@ class hint {
     }
     /// @}
     ///
+
+    class internal;
 };
 
 } // namespace v1

src/mongocxx/include/mongocxx/v_noabi/mongocxx/hint-fwd.hpp

@@ -14,6 +14,8 @@
 
 #pragma once
 
+#include <mongocxx/v1/hint-fwd.hpp> // IWYU pragma: export
+
 #include <mongocxx/config/prelude.hpp>
 
 namespace mongocxx {
@@ -26,7 +28,7 @@ class hint;
 
 namespace mongocxx {
 
-using ::mongocxx::v_noabi::hint;
+using v_noabi::hint;
 
 } // namespace mongocxx
 
@@ -36,3 +38,6 @@ using ::mongocxx::v_noabi::hint;
 /// @file
 /// Declares @ref mongocxx::v_noabi::hint.
 ///
+/// @par Includes
+/// - @ref mongocxx/v1/hint-fwd.hpp
+///

src/mongocxx/include/mongocxx/v_noabi/mongocxx/hint.hpp

@@ -14,15 +14,22 @@
 
 #pragma once
 
-#include <string>
-
 #include <mongocxx/hint-fwd.hpp> // IWYU pragma: export
 
+//
+
+#include <mongocxx/v1/hint.hpp> // IWYU pragma: export
+
+#include <string>
+#include <utility>
+
 #include <bsoncxx/document/value.hpp> // IWYU pragma: keep: backward compatibility, to be removed.
+#include <bsoncxx/document/view.hpp>
 #include <bsoncxx/document/view_or_value.hpp>
-#include <bsoncxx/stdx/optional.hpp>
+#include <bsoncxx/stdx/optional.hpp> // IWYU pragma: keep: backward compatibility, to be removed.
 #include <bsoncxx/string/view_or_value.hpp>
-#include <bsoncxx/types/bson_value/view.hpp>
+#include <bsoncxx/types.hpp>
+#include <bsoncxx/types/view.hpp>
 
 #include <mongocxx/config/prelude.hpp>
 
@@ -34,6 +41,22 @@ namespace v_noabi {
 ///
 class hint {
    public:
+    ///
+    /// Construct with the @ref mongocxx::v1 equivalent.
+    ///
+    /* explicit(false) */ MONGOCXX_ABI_EXPORT_CDECL() hint(v1::hint hint);
+
+    ///
+    /// Convert to the @ref mongocxx::v1 equivalent.
+    ///
+    explicit operator v1::hint() const {
+        if (_index_doc) {
+            return v1::hint{bsoncxx::v1::document::value{bsoncxx::v_noabi::to_v1(_index_doc->view())}};
+        }
+
+        return v1::hint{std::string{_index_string->view()}};
+    }
+
     ///
     /// Constructs a new hint.
     ///
@@ -43,15 +66,15 @@ class hint {
     /// @param index
     ///   Document view or value representing the index to be used.
     ///
-    MONGOCXX_ABI_EXPORT_CDECL() hint(bsoncxx::v_noabi::document::view_or_value index);
+    hint(bsoncxx::v_noabi::document::view_or_value index) : _index_doc{std::move(index)} {}
 
     ///
     /// Constructs a new hint.
     ///
     /// @param index
     ///   String representing the name of the index to be used.
     ///
-    explicit MONGOCXX_ABI_EXPORT_CDECL() hint(bsoncxx::v_noabi::string::view_or_value index);
+    explicit hint(bsoncxx::v_noabi::string::view_or_value index) : _index_string(std::move(index)) {}
 
     ///
     /// @relates mongocxx::v_noabi::hint
@@ -60,7 +83,9 @@ class hint {
     ///
     /// Compares equal if the hint contains a matching index name. Otherwise, compares unequal.
     ///
-    friend MONGOCXX_ABI_EXPORT_CDECL(bool) operator==(hint const& index_hint, std::string index);
+    friend bool operator==(hint const& index_hint, std::string index) {
+        return index_hint._index_string == index;
+    }
 
     ///
     /// @relates mongocxx::v_noabi::hint
@@ -69,26 +94,32 @@ class hint {
     ///
     /// Compares equal if the hint contains a matching index document. Otherwise, compares unequal.
     ///
-    friend MONGOCXX_ABI_EXPORT_CDECL(bool) operator==(hint const& index_hint, bsoncxx::v_noabi::document::view index);
+    friend bool operator==(hint const& index_hint, bsoncxx::v_noabi::document::view index) {
+        return index_hint._index_doc == index;
+    }
 
     ///
-    /// Returns a types::bson_value::view representing this hint.
+    /// Returns a @ref bsoncxx::v_noabi::types::view representing this hint.
     ///
-    /// @return Hint, as a types::bson_value::view. The caller must ensure that the returned object
-    /// not outlive
-    /// the hint object that it was created from.
+    /// @return Hint, as a @ref bsoncxx::v_noabi::types::view. The caller must ensure that the returned object not
+    /// outlive the hint object that it was created from.
     ///
-    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::types::bson_value::view) to_value() const;
+    bsoncxx::v_noabi::types::view to_value() const {
+        if (_index_doc) {
+            return bsoncxx::v_noabi::types::view{bsoncxx::v_noabi::types::b_document{_index_doc->view()}};
+        }
+
+        return bsoncxx::v_noabi::types::view{bsoncxx::v_noabi::types::b_string{_index_string->view()}};
+    }
 
     ///
-    /// Returns a types::bson_value::view representing this hint.
+    /// Returns a @ref bsoncxx::v_noabi::types::view representing this hint.
     ///
-    /// @return Hint, as a types::bson_value::view. The caller must ensure that the returned object
-    /// not outlive
-    /// the hint object that it was created from.
+    /// @return Hint, as a @ref bsoncxx::v_noabi::types::view. The caller must ensure that the returned object not
+    /// outlive the hint object that it was created from.
     ///
-    operator bsoncxx::v_noabi::types::bson_value::view() const {
-        return to_value();
+    operator bsoncxx::v_noabi::types::view() const {
+        return this->to_value();
     }
 
    private:
@@ -104,13 +135,19 @@ class hint {
 /// @{
 
 /// @relatesalso mongocxx::v_noabi::hint
-MONGOCXX_ABI_EXPORT_CDECL(bool) operator==(std::string index, hint const& index_hint);
+inline bool operator==(std::string str, hint const& hint) {
+    return hint == str;
+}
 
 /// @relatesalso mongocxx::v_noabi::hint
-MONGOCXX_ABI_EXPORT_CDECL(bool) operator!=(hint const& index_hint, std::string index);
+inline bool operator!=(hint const& hint, std::string str) {
+    return !(hint == str);
+}
 
 /// @relatesalso mongocxx::v_noabi::hint
-MONGOCXX_ABI_EXPORT_CDECL(bool) operator!=(std::string index, hint const& index_index);
+inline bool operator!=(std::string str, hint const& hint) {
+    return !(hint == str);
+}
 
 /// @}
 ///
@@ -123,25 +160,44 @@ MONGOCXX_ABI_EXPORT_CDECL(bool) operator!=(std::string index, hint const& index_
 /// @{
 
 /// @relatesalso mongocxx::v_noabi::hint
-MONGOCXX_ABI_EXPORT_CDECL(bool)
-operator==(bsoncxx::v_noabi::document::view index, hint const& index_hint);
+inline bool operator==(bsoncxx::v_noabi::document::view doc, hint const& hint) {
+    return hint == doc;
+}
+
 /// @relatesalso mongocxx::v_noabi::hint
-MONGOCXX_ABI_EXPORT_CDECL(bool)
-operator!=(hint const& index_hint, bsoncxx::v_noabi::document::view index);
+inline bool operator!=(hint const& hint, bsoncxx::v_noabi::document::view doc) {
+    return !(hint == doc);
+}
+
 /// @relatesalso mongocxx::v_noabi::hint
-MONGOCXX_ABI_EXPORT_CDECL(bool)
-operator!=(bsoncxx::v_noabi::document::view index, hint const& index_hint);
+inline bool operator!=(bsoncxx::v_noabi::document::view doc, hint const& hint) {
+    return !(hint == doc);
+}
 
 /// @}
 ///
 
+///
+/// Convert to the @ref mongocxx::v_noabi equivalent of `v`.
+///
+inline v_noabi::hint from_v1(v1::hint v) {
+    return {std::move(v)};
+}
+
+///
+/// Convert to the @ref mongocxx::v1 equivalent of `v`.
+///
+inline v1::hint to_v1(v_noabi::hint const& v) {
+    return v1::hint{v};
+}
+
 } // namespace v_noabi
 } // namespace mongocxx
 
 namespace mongocxx {
 
-using ::mongocxx::v_noabi::operator==;
-using ::mongocxx::v_noabi::operator!=;
+using v_noabi::operator==;
+using v_noabi::operator!=;
 
 } // namespace mongocxx
 
@@ -151,3 +207,6 @@ using ::mongocxx::v_noabi::operator!=;
 /// @file
 /// Provides @ref mongocxx::v_noabi::hint.
 ///
+/// @par Includes
+/// - @ref mongocxx/v1/hint.hpp
+///

src/mongocxx/lib/mongocxx/v1/hint.cpp

@@ -12,4 +12,110 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#include <mongocxx/v1/hint.hpp>
+#include <mongocxx/v1/hint.hh>
+
+#include <string>
+
+//
+
+#include <bsoncxx/v1/document/value.hpp>
+#include <bsoncxx/v1/stdx/optional.hpp>
+#include <bsoncxx/v1/stdx/string_view.hpp>
+#include <bsoncxx/v1/types/view.hpp>
+
+#include <mongocxx/private/utility.hh>
+
+namespace mongocxx {
+namespace v1 {
+
+class hint::impl {
+   public:
+    bsoncxx::v1::stdx::optional<bsoncxx::v1::document::value> _doc;
+    bsoncxx::v1::stdx::optional<std::string> _str;
+
+    static impl const& with(hint const& other) {
+        return *static_cast<impl const*>(other._impl);
+    }
+
+    static impl const* with(hint const* other) {
+        return static_cast<impl const*>(other->_impl);
+    }
+
+    static impl& with(hint& other) {
+        return *static_cast<impl*>(other._impl);
+    }
+
+    static impl* with(hint* other) {
+        return static_cast<impl*>(other->_impl);
+    }
+
+    static impl* with(void* ptr) {
+        return static_cast<impl*>(ptr);
+    }
+};
+
+hint::~hint() {
+    delete impl::with(_impl);
+}
+
+hint::hint(hint&& other) noexcept : _impl{exchange(other._impl, nullptr)} {}
+
+hint& hint::operator=(hint&& other) noexcept {
+    if (this != &other) {
+        delete impl::with(exchange(_impl, exchange(other._impl, nullptr)));
+    }
+
+    return *this;
+}
+
+hint::hint(hint const& other) : _impl{new impl{impl::with(other)}} {}
+
+hint& hint::operator=(hint const& other) {
+    if (this != &other) {
+        delete impl::with(exchange(_impl, new impl{impl::with(other)}));
+    }
+
+    return *this;
+}
+
+hint::hint() : _impl{new impl{}} {}
+
+hint::hint(std::string str) : hint{} {
+    impl::with(this)->_str = std::move(str);
+}
+
+hint::hint(bsoncxx::v1::document::value doc) : hint{} {
+    impl::with(this)->_doc = std::move(doc);
+}
+
+bsoncxx::v1::stdx::optional<bsoncxx::v1::stdx::string_view> hint::str() const {
+    return impl::with(this)->_str;
+}
+
+bsoncxx::v1::stdx::optional<bsoncxx::v1::document::view> hint::doc() const {
+    return impl::with(this)->_doc;
+}
+
+bsoncxx::v1::types::view hint::to_value() const {
+    if (auto const& opt = impl::with(this)->_doc) {
+        return bsoncxx::v1::types::b_document{*opt};
+    }
+
+    // Invariant: either `_doc` or `_str` has a value.
+    return bsoncxx::v1::types::b_string{*impl::with(this)->_str};
+}
+
+hint::operator bsoncxx::v1::types::view() const {
+    return this->to_value();
+}
+
+bsoncxx::v1::stdx::optional<bsoncxx::v1::document::value>& hint::internal::doc(hint& self) {
+    return impl::with(self)._doc;
+}
+
+bsoncxx::v1::stdx::optional<std::string>& hint::internal::str(hint& self) {
+    return impl::with(self)._str;
+}
+
+} // namespace v1
+} // namespace mongocxx

src/mongocxx/lib/mongocxx/v1/hint.hh

@@ -0,0 +1,37 @@
+// Copyright 2009-present MongoDB, Inc.
+//
+// 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.
+
+#pragma once
+
+#include <mongocxx/v1/hint.hpp> // IWYU pragma: export
+
+//
+
+#include <bsoncxx/v1/document/value-fwd.hpp>
+
+#include <bsoncxx/v1/stdx/optional.hpp>
+
+#include <string>
+
+namespace mongocxx {
+namespace v1 {
+
+class hint::internal {
+   public:
+    static bsoncxx::v1::stdx::optional<bsoncxx::v1::document::value>& doc(hint& self);
+    static bsoncxx::v1::stdx::optional<std::string>& str(hint& self);
+};
+
+} // namespace v1
+} // namespace mongocxx