consolidate public headers into one place

Author: wu-hui

FirebaseFirestore.podspec

@@ -35,6 +35,7 @@ Google Cloud Firestore is a NoSQL document database built for automatic scaling,
   s.pod_target_xcconfig = {
     # Enables C++ <-> Swift interop (by default it's only C)
     "SWIFT_OBJC_INTEROP_MODE" => "objcxx",
+    'HEADER_SEARCH_PATHS' => '"${PODS_TARGET_SRCROOT}/Firestore/core/src/api"'
   }
 
   s.resource_bundles = {

FirebaseFirestoreInternal.podspec

@@ -30,7 +30,7 @@ Google Cloud Firestore is a NoSQL document database built for automatic scaling,
   # framework.
   s.public_header_files = [
     'Firestore/Source/Public/FirebaseFirestore/*.h',
-    'Firestore/core/interfaceForSwift/api/*.h'
+    'Firestore/core/src/api/FirebaseFirestoreCpp.h'
   ]
 
   # source_files contains most of the header and source files for the project.
@@ -54,8 +54,8 @@ Google Cloud Firestore is a NoSQL document database built for automatic scaling,
     'Firestore/Protos/nanopb/**/*.cc',
     'Firestore/core/include/**/*.{cc,mm}',
     'Firestore/core/src/**/*.{cc,mm}',
+    'Firestore/core/src/api/*.{cc,mm}',
     'FirebaseAuth/Interop/**/*.h',
-    'Firestore/core/interfaceForSwift/**/*.{cc,h}',
   ]
 
   # Internal headers that aren't necessarily globally unique. Most C++ internal
@@ -132,6 +132,7 @@ Google Cloud Firestore is a NoSQL document database built for automatic scaling,
     'HEADER_SEARCH_PATHS' =>
       '"${PODS_TARGET_SRCROOT}" ' +
       '"${PODS_TARGET_SRCROOT}/Firestore/Source/Public" ' +
+      '"${PODS_TARGET_SRCROOT}/Firestore/core/src/api" ' +
       '"${PODS_ROOT}/nanopb" ' +
       '"${PODS_TARGET_SRCROOT}/Firestore/Protos/nanopb"'
   }

Firestore/Example/Firestore.xcodeproj/xcshareddata/xcschemes/Firestore_IntegrationTests_macOS.xcscheme

@@ -27,6 +27,15 @@
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
       shouldUseLaunchSchemeArgsEnv = "YES">
+      <MacroExpansion>
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "54B8E4A9224BDC4100930F18"
+            BuildableName = "Firestore_IntegrationTests_macOS.xctest"
+            BlueprintName = "Firestore_IntegrationTests_macOS"
+            ReferencedContainer = "container:Firestore.xcodeproj">
+         </BuildableReference>
+      </MacroExpansion>
       <Testables>
          <TestableReference
             skipped = "NO">
@@ -39,17 +48,6 @@
             </BuildableReference>
          </TestableReference>
       </Testables>
-      <MacroExpansion>
-         <BuildableReference
-            BuildableIdentifier = "primary"
-            BlueprintIdentifier = "54B8E4A9224BDC4100930F18"
-            BuildableName = "Firestore_IntegrationTests_macOS.xctest"
-            BlueprintName = "Firestore_IntegrationTests_macOS"
-            ReferencedContainer = "container:Firestore.xcodeproj">
-         </BuildableReference>
-      </MacroExpansion>
-      <AdditionalOptions>
-      </AdditionalOptions>
    </TestAction>
    <LaunchAction
       buildConfiguration = "Debug"
@@ -70,8 +68,6 @@
             ReferencedContainer = "container:Firestore.xcodeproj">
          </BuildableReference>
       </MacroExpansion>
-      <AdditionalOptions>
-      </AdditionalOptions>
    </LaunchAction>
    <ProfileAction
       buildConfiguration = "Release"

Firestore/Source/Public/FirebaseFirestore/FirebaseFirestore.h

@@ -18,7 +18,6 @@
 #import "FIRAggregateQuery.h"
 #import "FIRAggregateQuerySnapshot.h"
 #import "FIRAggregateSource.h"
-#import "FIRCallbackWrapper.h"
 #import "FIRCollectionReference.h"
 #import "FIRDocumentChange.h"
 #import "FIRDocumentReference.h"

Firestore/core/interfaceForSwift/api/CollectionStage.h

@@ -14,6 +14,9 @@
  * limitations under the License.
  */
 
+#ifndef FIRESTORE_CORE_SRC_API_FIRCALLBACKWRAPPER_H_
+#define FIRESTORE_CORE_SRC_API_FIRCALLBACKWRAPPER_H_
+
 #import <Foundation/Foundation.h>
 
 #if defined(__cplusplus)
@@ -26,40 +29,43 @@ namespace api {
 class Firestore;
 class PipelineResult;
 }  // namespace api
-
 namespace core {
 template <typename T>
 class EventListener;
 }  // namespace core
-
 }  // namespace firestore
 }  // namespace firebase
-
 namespace api = firebase::firestore::api;
 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)(CppPipelineResult* _Nullable result,
+                              NSError* _Nullable error)
     NS_SWIFT_UNAVAILABLE("Use Swift's closure syntax instead.");
 
 NS_SWIFT_SENDABLE
 NS_SWIFT_NAME(CallbackWrapper)
 @interface FIRCallbackWrapper : NSObject
 
-// Note: Marking callbacks in callback-based APIs as `Sendable` can help prevent crashes when they
-// 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.
+// Note: Marking callbacks in callback-based APIs as `Sendable` can help prevent
+// crashes when they 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>>)
+    // NOLINTNEXTLINE(whitespace/parens)
     wrapPipelineCallback:(std::shared_ptr<api::Firestore>)firestore
-              completion:(void (^NS_SWIFT_SENDABLE)(CppPipelineResult *_Nullable result,
-                                                    NSError *_Nullable error))completion
+              // NOLINTNEXTLINE(whitespace/parens)
+              completion:(void (^NS_SWIFT_SENDABLE)(
+                             CppPipelineResult* _Nullable result,
+                             NSError* _Nullable error))completion
     NS_SWIFT_NAME(wrapPipelineCallback(firestore:completion:));
 
 @end
 
 NS_ASSUME_NONNULL_END
-#endif
+#endif  // defined(__cplusplus)
+
+#endif  // FIRESTORE_CORE_SRC_API_FIRCALLBACKWRAPPER_H_

Firestore/core/interfaceForSwift/api/FirestorePipeline.h

@@ -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,18 +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,
-                                                           NSError *_Nullable error))completion {
+// 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,
+                                   NSError* _Nullable error))completion {
   class Converter : public EventListener<CppPipelineResult> {
    public:
-    explicit Converter(std::shared_ptr<api::Firestore> firestore, PipelineBlock completion)
+    explicit Converter(std::shared_ptr<api::Firestore> firestore,
+                       PipelineBlock completion)
         : firestore_(firestore), completion_(completion) {
     }
 

Firestore/core/interfaceForSwift/api/PipelineSource.h

@@ -14,14 +14,15 @@
  * limitations under the License.
  */
 
-#ifndef FIRESTORE_CORE_INTERFACEFORSWIFT_API_FIREBASEFIRESTORECPP_H_
-#define FIRESTORE_CORE_INTERFACEFORSWIFT_API_FIREBASEFIRESTORECPP_H_
+#ifndef FIRESTORE_CORE_SRC_API_FIREBASEFIRESTORECPP_H_
+#define FIRESTORE_CORE_SRC_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_
+#endif  // FIRESTORE_CORE_SRC_API_FIREBASEFIRESTORECPP_H_

Firestore/Source/Public/FirebaseFirestore/FIRCallbackWrapper.h Firestore/core/src/api/FIRCallbackWrapper.h

@@ -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 {

Firestore/Source/API/FIRCallbackWrapper.mm Firestore/core/src/api/FIRCallbackWrapper.mm

@@ -12,11 +12,11 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#ifndef FIRESTORE_CORE_INTERFACEFORSWIFT_API_COLLECTION_STAGE_H_
-#define FIRESTORE_CORE_INTERFACEFORSWIFT_API_COLLECTION_STAGE_H_
+#ifndef FIRESTORE_CORE_SRC_API_COLLECTION_STAGE_H_
+#define FIRESTORE_CORE_SRC_API_COLLECTION_STAGE_H_
 
 #include <string>
-#include "Firestore/core/interfaceForSwift/api/stage.h"
+#include "Firestore/core/src/api/stage.h"
 
 namespace firebase {
 namespace firestore {
@@ -36,4 +36,4 @@ class Collection : public Stage {
 }  // namespace firestore
 }  // namespace firebase
 
-#endif  // FIRESTORE_CORE_INTERFACEFORSWIFT_API_COLLECTION_STAGE_H_
+#endif  // FIRESTORE_CORE_SRC_API_COLLECTION_STAGE_H_

Firestore/core/interfaceForSwift/api/FirebaseFirestoreCpp.h Firestore/core/src/api/FirebaseFirestoreCpp.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"

Firestore/core/interfaceForSwift/api/CollectionStage.cc 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/FirestorePipeline.h"
+#include "Firestore/core/src/api/firestore_pipeline.h"
 
 #include <memory>