consolidate public headers into one place

wu-hui · wu-hui · commit 317ccfb4b494 · 2025-01-29T13:52:12.000-05:00
diff --git a/Firestore/core/interfaceForSwift/api/CollectionStage.h b/Firestore/core/interfaceForSwift/api/CollectionStage.h
diff --git a/Firestore/core/interfaceForSwift/api/FirestorePipeline.h b/Firestore/core/interfaceForSwift/api/FirestorePipeline.h
diff --git a/Firestore/core/interfaceForSwift/api/PipelineSource.h b/Firestore/core/interfaceForSwift/api/PipelineSource.h
diff --git a/Firestore/core/src/api/FIRCallbackWrapper.h b/Firestore/core/src/api/FIRCallbackWrapper.h
@@ -15,8 +15,6 @@
  */
 
 #import <Foundation/Foundation.h>
-
-#if defined(__cplusplus)
 #include <memory>
 #include <vector>
 
@@ -40,11 +38,11 @@ namespace core = firebase::firestore::core;
 
 NS_ASSUME_NONNULL_BEGIN
 
-typedef api::PipelineResult CppPipelineResult;
-
-typedef void (^PipelineBlock)(CppPipelineResult *_Nullable result, NSError *_Nullable error)
+typedef void (^PipelineBlock)(std::vector<api::PipelineResult> result, NSError *_Nullable error)
     NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.");
 
+typedef std::vector<api::PipelineResult> PipelineResultVector;
+
 NS_SWIFT_SENDABLE
 NS_SWIFT_NAME(CallbackWrapper)
 @interface FIRCallbackWrapper : NSObject
@@ -53,13 +51,12 @@ NS_SWIFT_NAME(CallbackWrapper)
 // are invoked on a different thread than the one they were originally defined in. If this callback
 // is expected to be called on a different thread, it should be marked as `Sendable` to ensure
 // thread safety.
-+ (std::shared_ptr<core::EventListener<api::PipelineResult>>)
++ (std::shared_ptr<core::EventListener<std::vector<api::PipelineResult>>>)
     wrapPipelineCallback:(std::shared_ptr<api::Firestore>)firestore
-              completion:(void (^NS_SWIFT_SENDABLE)(CppPipelineResult *_Nullable result,
+              completion:(void (^NS_SWIFT_SENDABLE)(PipelineResultVector result,
                                                     NSError *_Nullable error))completion
     NS_SWIFT_NAME(wrapPipelineCallback(firestore:completion:));
 
 @end
 
 NS_ASSUME_NONNULL_END
-#endif
diff --git a/Firestore/core/src/api/FIRCallbackWrapper.mm b/Firestore/core/src/api/FIRCallbackWrapper.mm
@@ -20,8 +20,8 @@
 #include <utility>
 #include <vector>
 
-#include "Firestore/core/interfaceForSwift/api/Pipeline.h"
-#include "Firestore/core/interfaceForSwift/api/PipelineResult.h"
+#include "Firestore/core/src/api/pipeline.h"
+#include "Firestore/core/src/api/pipeline_result.h"
 #include "Firestore/core/src/core/event_listener.h"
 #include "Firestore/core/src/util/error_apple.h"
 #include "Firestore/core/src/util/statusor.h"
@@ -34,26 +34,22 @@
 
 @implementation FIRCallbackWrapper
 
-// In public Swift documentation for integrating Swift and C++, using raw pointers in C++ is
-// generally considered unsafe. However, during an experiment where the result was passed as a value
-// instead of a pointer, a double free error occurred. This issue could not be traced effectively
-// because the implementation resides within the Swift-C++ transition layer. In this specific use
-// case, the C++ OnEvent() scope is destroyed after the Swift callback has been destroyed. Due to
-// this ordering, using a raw pointer is a safe workaround for now.
 + (PipelineSnapshotListener)wrapPipelineCallback:(std::shared_ptr<api::Firestore>)firestore
-                                      completion:(void (^)(CppPipelineResult *_Nullable result,
+                                      completion:(void (^)(PipelineResultVector result,
                                                            NSError *_Nullable error))completion {
-  class Converter : public EventListener<CppPipelineResult> {
+  class Converter : public EventListener<std::vector<PipelineResult>> {
    public:
     explicit Converter(std::shared_ptr<api::Firestore> firestore, PipelineBlock completion)
         : firestore_(firestore), completion_(completion) {
     }
 
-    void OnEvent(StatusOr<CppPipelineResult> maybe_snapshot) override {
+    void OnEvent(StatusOr<std::vector<PipelineResult>> maybe_snapshot) override {
       if (maybe_snapshot.ok()) {
-        completion_(&maybe_snapshot.ValueOrDie(), nullptr);
+        completion_(
+            std::initializer_list<PipelineResult>{PipelineResult::GetTestResult(firestore_)},
+            nullptr);
       } else {
-        completion_(nullptr, MakeNSError(maybe_snapshot.status()));
+        completion_(std::initializer_list<PipelineResult>{}, MakeNSError(maybe_snapshot.status()));
       }
     }
 
@@ -62,7 +58,7 @@ void OnEvent(StatusOr<CppPipelineResult> maybe_snapshot) override {
     PipelineBlock completion_;
   };
 
-  return std::make_shared<Converter>(firestore, completion);
+  return absl::make_unique<Converter>(firestore, completion);
 }
 
 @end
diff --git a/Firestore/core/src/api/FirebaseFirestoreCpp.h b/Firestore/core/src/api/FirebaseFirestoreCpp.h
@@ -17,11 +17,12 @@
 #ifndef FIRESTORE_CORE_INTERFACEFORSWIFT_API_FIREBASEFIRESTORECPP_H_
 #define FIRESTORE_CORE_INTERFACEFORSWIFT_API_FIREBASEFIRESTORECPP_H_
 
-#import "Firestore/core/interfaceForSwift/api/collection_stage.h"
-#import "Firestore/core/interfaceForSwift/api/firestore_pipeline.h"
-#import "Firestore/core/interfaceForSwift/api/pipeline.h"
-#import "Firestore/core/interfaceForSwift/api/pipeline_result.h"
-#import "Firestore/core/interfaceForSwift/api/pipeline_source.h"
-#import "Firestore/core/interfaceForSwift/api/stage.h"
+#import "Firestore/core/src/api/FIRCallbackWrapper.h"
+#import "Firestore/core/src/api/collection_stage.h"
+#import "Firestore/core/src/api/firestore_pipeline.h"
+#import "Firestore/core/src/api/pipeline.h"
+#import "Firestore/core/src/api/pipeline_result.h"
+#import "Firestore/core/src/api/pipeline_source.h"
+#import "Firestore/core/src/api/stage.h"
 
 #endif  // FIRESTORE_CORE_INTERFACEFORSWIFT_API_FIREBASEFIRESTORECPP_H_
diff --git a/Firestore/core/src/api/collection_stage.cc b/Firestore/core/src/api/collection_stage.cc
@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#include "Firestore/core/interfaceForSwift/api/CollectionStage.h"
+#include "Firestore/core/src/api/collection_stage.h"
 #include <iostream>
 
 namespace firebase {
diff --git a/Firestore/core/src/api/collection_stage.h b/Firestore/core/src/api/collection_stage.h
@@ -16,7 +16,7 @@
 #define FIRESTORE_CORE_INTERFACEFORSWIFT_API_COLLECTION_STAGE_H_
 
 #include <string>
-#include "Firestore/core/interfaceForSwift/api/stage.h"
+#include "Firestore/core/src/api/stage.h"
 
 namespace firebase {
 namespace firestore {
diff --git a/Firestore/core/src/api/firestore.h b/Firestore/core/src/api/firestore.h
@@ -21,9 +21,9 @@
 #include <mutex>
 #include <string>
 
-#include "Firestore/core/interfaceForSwift/api/PipelineSource.h"
 #include "Firestore/core/src/api/api_fwd.h"
 #include "Firestore/core/src/api/load_bundle_task.h"
+#include "Firestore/core/src/api/pipeline_source.h"
 #include "Firestore/core/src/api/settings.h"
 #include "Firestore/core/src/core/core_fwd.h"
 #include "Firestore/core/src/credentials/credentials_fwd.h"
diff --git a/Firestore/core/src/api/firestore_pipeline.cc b/Firestore/core/src/api/firestore_pipeline.cc
@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#include "Firestore/core/interfaceForSwift/api/FirestorePipeline.h"
+#include "Firestore/core/src/api/firestore_pipeline.h"
 
 #include <memory>
 
diff --git a/Firestore/core/src/api/firestore_pipeline.h b/Firestore/core/src/api/firestore_pipeline.h
@@ -17,7 +17,7 @@
 
 #include <memory>
 
-#include "Firestore/core/interfaceForSwift/api/pipeline_source.h"
+#include "Firestore/core/src/api/pipeline_source.h"
 
 namespace firebase {
 namespace firestore {
diff --git a/Firestore/core/src/api/pipeline.cc b/Firestore/core/src/api/pipeline.cc
@@ -12,15 +12,15 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#include "Firestore/core/interfaceForSwift/api/Pipeline.h"
+#include "Firestore/core/src/api/pipeline.h"
 
-#include <future>
+#include <future>  // NOLINT(build/c++11)
 #include <memory>
 
 #include "Firestore/core/include/firebase/firestore/timestamp.h"
-#include "Firestore/core/interfaceForSwift/api/PipelineResult.h"
 #include "Firestore/core/src/api/firestore.h"
 #include "Firestore/core/src/api/listener_registration.h"
+#include "Firestore/core/src/api/pipeline_result.h"
 #include "Firestore/core/src/api/source.h"
 #include "Firestore/core/src/core/event_listener.h"
 #include "Firestore/core/src/core/listen_options.h"
@@ -45,10 +45,8 @@ void Pipeline::GetPipelineResult(PipelineSnapshotListener callback) const {
       /*include_document_metadata_changes=*/true,
       /*wait_for_sync_when_online=*/true);
 
-  PipelineResult sample = PipelineResult::GetTestResult(firestore_);
-
-  StatusOr<PipelineResult> res(sample);
-  callback->OnEvent(res);
+  callback->OnEvent(StatusOr<std::vector<PipelineResult>>(
+      {(PipelineResult::GetTestResult(firestore_))}));
 
   //  class ListenOnce : public EventListener<std::vector<PipelineResult>> {
   //   public:
diff --git a/Firestore/core/src/api/pipeline.h b/Firestore/core/src/api/pipeline.h
@@ -18,8 +18,8 @@
 #include <functional>
 #include <memory>
 #include <vector>
-#include "PipelineResult.h"
-#include "Stage.h"
+#include "Firestore/core/src/api/pipeline_result.h"
+#include "Firestore/core/src/api/stage.h"
 
 namespace firebase {
 namespace firestore {
@@ -35,7 +35,7 @@ class Firestore;
 class PipelineResult;
 
 using PipelineSnapshotListener =
-    std::shared_ptr<core::EventListener<PipelineResult>>;
+    std::shared_ptr<core::EventListener<std::vector<PipelineResult>>>;
 
 class Pipeline {
  public:
diff --git a/Firestore/core/src/api/pipeline_result.cc b/Firestore/core/src/api/pipeline_result.cc
@@ -12,10 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#include <iostream>
-
+#include "Firestore/core/src/api/pipeline_result.h"
 #include "Firestore/core/include/firebase/firestore/timestamp.h"
-#include "Firestore/core/interfaceForSwift/api/PipelineResult.h"
 
 namespace firebase {
 namespace firestore {
diff --git a/Firestore/core/src/api/pipeline_result.h b/Firestore/core/src/api/pipeline_result.h
@@ -12,8 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#ifndef FIRESTORE_CORE_INTERFACEFORSWIFT_API_PIPELINERESULT_H_
-#define FIRESTORE_CORE_INTERFACEFORSWIFT_API_PIPELINERESULT_H_
+#ifndef FIRESTORE_CORE_INTERFACEFORSWIFT_API_PIPELINE_RESULT_H_
+#define FIRESTORE_CORE_INTERFACEFORSWIFT_API_PIPELINE_RESULT_H_
 
 #include <memory>
 
@@ -48,4 +48,4 @@ class PipelineResult {
 
 }  // namespace firestore
 }  // namespace firebase
-#endif  // FIRESTORE_CORE_INTERFACEFORSWIFT_API_PIPELINERESULT_H_
+#endif  // FIRESTORE_CORE_INTERFACEFORSWIFT_API_PIPELINE_RESULT_H_
diff --git a/Firestore/core/src/api/pipeline_source.cc b/Firestore/core/src/api/pipeline_source.cc
@@ -12,11 +12,11 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#include "Firestore/core/interfaceForSwift/api/PipelineSource.h"
+#include "Firestore/core/src/api/pipeline_source.h"
 
 #include <string>
 
-#include "Firestore/core/interfaceForSwift/api/CollectionStage.h"
+#include "Firestore/core/src/api/collection_stage.h"
 #include "Firestore/core/src/api/document_reference.h"
 #include "Firestore/core/src/api/firestore.h"
 
diff --git a/Firestore/core/src/api/pipeline_source.h b/Firestore/core/src/api/pipeline_source.h
@@ -19,7 +19,7 @@
 #include <string>
 #include <vector>
 
-#include "Firestore/core/interfaceForSwift/api/pipeline.h"
+#include "Firestore/core/src/api/pipeline.h"
 
 namespace firebase {
 namespace firestore {
diff --git a/Firestore/core/src/api/stage.cc b/Firestore/core/src/api/stage.cc
@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#include "Firestore/core/interfaceForSwift/api/Stage.h"
+#include "Firestore/core/src/api/stage.h"
 
 namespace firebase {
 namespace firestore {
diff --git a/Firestore/core/src/api/stage.h b/Firestore/core/src/api/stage.h
diff --git a/Package.swift b/Package.swift
