Rationalize C++ source layout (#446)

* Fix file name to reflect platforms that it applies to.

* Rename the 'ios' directory to 'main'.

* Change cross-platform file suffixes to '_main'.

* create_firebase_metadata_provider_apple should in fact be create_firebase_metadata_provider_ios.

* Update integration_test_internal and comments.

Author: ehsannas

firestore/CMakeLists.txt

@@ -14,7 +14,7 @@
 
 if(APPLE AND NOT ANDROID)
   set(settings_apple_SRCS
-      src/common/settings_ios.mm)
+      src/common/settings_apple.mm)
 else()
   set(settings_apple_SRCS)
 endif()
@@ -179,76 +179,76 @@ set(android_SRCS
 
 # Sources that apply to all non-Android platforms.
 set(main_SRCS
-    src/ios/collection_reference_ios.cc
-    src/ios/collection_reference_ios.h
-    src/ios/converter_ios.h
-    src/ios/document_change_ios.cc
-    src/ios/document_change_ios.h
-    src/ios/document_reference_ios.cc
-    src/ios/document_reference_ios.h
-    src/ios/document_snapshot_ios.cc
-    src/ios/document_snapshot_ios.h
-    src/ios/field_value_ios.cc
-    src/ios/field_value_ios.h
-    src/ios/firestore_ios.cc
-    src/ios/firestore_ios.h
-    src/ios/listener_ios.h
-    src/ios/listener_registration_ios.cc
-    src/ios/listener_registration_ios.h
-    src/ios/promise_factory_ios.h
-    src/ios/promise_ios.h
-    src/ios/query_ios.cc
-    src/ios/query_ios.h
-    src/ios/query_snapshot_ios.cc
-    src/ios/query_snapshot_ios.h
-    src/ios/set_options_ios.h
-    src/ios/source_ios.h
-    src/ios/transaction_ios.cc
-    src/ios/transaction_ios.h
-    src/ios/user_data_converter_ios.cc
-    src/ios/user_data_converter_ios.h
-    src/ios/util_ios.h
-    src/ios/write_batch_ios.cc
-    src/ios/write_batch_ios.h)
+    src/main/collection_reference_main.cc
+    src/main/collection_reference_main.h
+    src/main/converter_main.h
+    src/main/document_change_main.cc
+    src/main/document_change_main.h
+    src/main/document_reference_main.cc
+    src/main/document_reference_main.h
+    src/main/document_snapshot_main.cc
+    src/main/document_snapshot_main.h
+    src/main/field_value_main.cc
+    src/main/field_value_main.h
+    src/main/firestore_main.cc
+    src/main/firestore_main.h
+    src/main/listener_main.h
+    src/main/listener_registration_main.cc
+    src/main/listener_registration_main.h
+    src/main/promise_factory_main.h
+    src/main/promise_main.h
+    src/main/query_main.cc
+    src/main/query_main.h
+    src/main/query_snapshot_main.cc
+    src/main/query_snapshot_main.h
+    src/main/set_options_main.h
+    src/main/source_main.h
+    src/main/transaction_main.cc
+    src/main/transaction_main.h
+    src/main/user_data_converter_main.cc
+    src/main/user_data_converter_main.h
+    src/main/util_main.h
+    src/main/write_batch_main.cc
+    src/main/write_batch_main.h)
 
 # CredentialsProvider has no implementatation on Android and distinct
 # implementations for iOS and desktop platforms. On iOS, the implementation of
 # the interface actually comes from the FirebaseFirestore CocoaPod, so there's
 # no implementation listed here.
 set(credentials_provider_desktop_SRCS
-    src/ios/create_credentials_provider.h
-    src/ios/create_credentials_provider_desktop.cc
-    src/ios/credentials_provider_desktop.cc
-    src/ios/credentials_provider_desktop.h)
+    src/main/create_credentials_provider.h
+    src/main/create_credentials_provider_desktop.cc
+    src/main/credentials_provider_desktop.cc
+    src/main/credentials_provider_desktop.h)
 
 set(credentials_provider_ios_SRCS
-    src/ios/create_credentials_provider.h
-    src/ios/create_credentials_provider_ios.mm)
+    src/main/create_credentials_provider.h
+    src/main/create_credentials_provider_ios.mm)
 
 # FirebaseMetadataProvider has no implementation on Android and distinct
 # implementations for iOS and desktop platforms. On iOS, the implementation of
 # the interface actually comes from the FirebaseFirestore CocoaPod, so there's
 # no implementation listed here.
 set(firebase_metadata_provider_desktop_SRCS
-    src/ios/create_firebase_metadata_provider.h
-    src/ios/create_firebase_metadata_provider_desktop.cc
-    src/ios/firebase_metadata_provider_desktop.cc
-    src/ios/firebase_metadata_provider_desktop.h)
+    src/main/create_firebase_metadata_provider.h
+    src/main/create_firebase_metadata_provider_desktop.cc
+    src/main/firebase_metadata_provider_desktop.cc
+    src/main/firebase_metadata_provider_desktop.h)
 
 set(firebase_metadata_provider_ios_SRCS
-    src/ios/create_firebase_metadata_provider.h
-    src/ios/create_firebase_metadata_provider_apple.mm)
+    src/main/create_firebase_metadata_provider.h
+    src/main/create_firebase_metadata_provider_ios.mm)
 
 set(wrapper_assertions_SRCS
     src/common/wrapper_assertions.cc
     src/common/wrapper_assertions.h)
 
 set(ios_only_SRCS
-    src/ios/create_firebase_metadata_provider_apple.mm)
+    src/main/create_firebase_metadata_provider_ios.mm)
 
 set(desktop_only_SRCS
-    src/ios/create_firebase_metadata_provider_desktop.cc
-    src/ios/firebase_metadata_provider_desktop.cc)
+    src/main/create_firebase_metadata_provider_desktop.cc
+    src/main/firebase_metadata_provider_desktop.cc)
 
 if(ANDROID)
   set(firestore_platform_SRCS "${android_SRCS}")

firestore/integration_test_internal/src/field_value_test.cc

@@ -8,7 +8,7 @@
 #elif defined(FIRESTORE_STUB_BUILD)
 #include "firestore/src/stub/field_value_stub.h"
 #else
-#include "firestore/src/ios/field_value_ios.h"
+#include "firestore/src/main/field_value_main.h"
 #endif  // defined(__ANDROID__)
 
 #include "gmock/gmock.h"

firestore/integration_test_internal/src/firestore_test.cc

@@ -1027,7 +1027,7 @@ TEST_F(FirestoreIntegrationTest, TestDocumentReferenceExposesFirestore) {
   // aren't registered in the main cache. Because of that, Firestore objects
   // will lazily create a new Firestore instance upon the first access. This
   // doesn't affect production code, only tests.
-  // Also, the logic in `util_ios.h` can be modified to make sure that
+  // Also, the logic in `util_main.h` can be modified to make sure that
   // `TestFirestore()` doesn't create a new Firestore instance if there isn't
   // one already.
   EXPECT_NE(nullptr, db->Document("foo/bar").firestore());

firestore/integration_test_internal/src/util/integration_test_util.cc

@@ -7,7 +7,7 @@
 #include "firebase/app.h"
 #include "firebase/firestore.h"
 #include "firestore/src/common/hard_assert_common.h"
-#include "firestore/src/ios/firestore_ios.h"
+#include "firestore/src/main/firestore_main.h"
 
 namespace firebase {
 namespace firestore {

firestore/src/android/field_value_android.h

@@ -33,7 +33,7 @@ class FieldValueInternal {
   FieldValueInternal(Type type, const jni::Object& object);
 
   // Constructs a FieldValueInternal from a value of a specific type. Note that
-  // these constructors must match the equivalents in field_value_ios.h.
+  // these constructors must match the equivalents in field_value_main.h.
   //
   // Of particular note is that these pass by value even though the Android
   // implementation does not retain the values. This is done to make the

firestore/src/common/cleanup.h

@@ -6,7 +6,7 @@
 #if __ANDROID__
 #include "firestore/src/android/firestore_android.h"
 #else
-#include "firestore/src/ios/firestore_ios.h"
+#include "firestore/src/main/firestore_main.h"
 #endif  // __ANDROID__
 
 #include "firestore/src/common/type_mapping.h"

firestore/src/common/collection_reference.cc

@@ -10,7 +10,7 @@
 #elif defined(FIRESTORE_STUB_BUILD)
 #include "firestore/src/stub/collection_reference_stub.h"
 #else
-#include "firestore/src/ios/collection_reference_ios.h"
+#include "firestore/src/main/collection_reference_main.h"
 #endif  // defined(__ANDROID__)
 
 namespace firebase {

firestore/src/common/document_change.cc

@@ -10,7 +10,7 @@
 #elif defined(FIRESTORE_STUB_BUILD)
 #include "firestore/src/stub/document_change_stub.h"
 #else
-#include "firestore/src/ios/document_change_ios.h"
+#include "firestore/src/main/document_change_main.h"
 #endif  // defined(__ANDROID__)
 
 namespace firebase {

firestore/src/common/document_reference.cc

@@ -17,7 +17,7 @@
 #elif defined(FIRESTORE_STUB_BUILD)
 #include "firestore/src/stub/document_reference_stub.h"
 #else
-#include "firestore/src/ios/document_reference_ios.h"
+#include "firestore/src/main/document_reference_main.h"
 #endif  // defined(__ANDROID__)
 
 namespace firebase {

firestore/src/common/document_snapshot.cc

@@ -15,7 +15,7 @@
 #elif defined(FIRESTORE_STUB_BUILD)
 #include "firestore/src/stub/document_snapshot_stub.h"
 #else
-#include "firestore/src/ios/document_snapshot_ios.h"
+#include "firestore/src/main/document_snapshot_main.h"
 #endif  // defined(__ANDROID__)
 
 namespace firebase {

firestore/src/common/field_value.cc

@@ -15,7 +15,7 @@
 #elif defined(FIRESTORE_STUB_BUILD)
 #include "firestore/src/stub/field_value_stub.h"
 #else
-#include "firestore/src/ios/field_value_ios.h"
+#include "firestore/src/main/field_value_main.h"
 #endif  // defined(__ANDROID__)
 
 namespace firebase {

firestore/src/common/firestore.cc

@@ -17,7 +17,7 @@
 #elif defined(FIRESTORE_STUB_BUILD)
 #include "firestore/src/stub/firestore_stub.h"
 #else
-#include "firestore/src/ios/firestore_ios.h"
+#include "firestore/src/main/firestore_main.h"
 #endif  // defined(__ANDROID__)
 
 #ifdef __APPLE__

firestore/src/common/listener_registration.cc

@@ -9,7 +9,7 @@
 #elif defined(FIRESTORE_STUB_BUILD)
 #include "firestore/src/stub/listener_registration_stub.h"
 #else
-#include "firestore/src/ios/listener_registration_ios.h"
+#include "firestore/src/main/listener_registration_main.h"
 #endif  // defined(__ANDROID__)
 
 namespace firebase {

firestore/src/common/query.cc

@@ -16,7 +16,7 @@
 #elif defined(FIRESTORE_STUB_BUILD)
 #include "firestore/src/stub/query_stub.h"
 #else
-#include "firestore/src/ios/query_ios.h"
+#include "firestore/src/main/query_main.h"
 #endif  // defined(__ANDROID__)
 
 namespace firebase {

firestore/src/common/query_snapshot.cc

@@ -12,7 +12,7 @@
 #elif defined(FIRESTORE_STUB_BUILD)
 #include "firestore/src/stub/query_snapshot_stub.h"
 #else
-#include "firestore/src/ios/query_snapshot_ios.h"
+#include "firestore/src/main/query_snapshot_main.h"
 #endif  // defined(__ANDROID__)
 
 namespace firebase {

firestore/src/common/settings.cc

@@ -55,7 +55,7 @@ std::ostream& operator<<(std::ostream& out, const Settings& settings) {
   return out << settings.ToString();
 }
 
-// Apple uses a different mechanism, defined in `settings_ios.mm`.
+// Apple uses a different mechanism, defined in `settings_apple.mm`.
 #if !defined(__APPLE__) && !defined(__ANDROID__) && \
     !defined(FIRESTORE_STUB_BUILD)
 std::unique_ptr<util::Executor> Settings::CreateExecutor() const {

firestore/src/common/settings_ios.mm renamed to firestore/src/common/settings_apple.mm

@@ -9,7 +9,7 @@
 #elif defined(FIRESTORE_STUB_BUILD)
 #include "firestore/src/stub/transaction_stub.h"
 #else
-#include "firestore/src/ios/transaction_ios.h"
+#include "firestore/src/main/transaction_main.h"
 #endif  // defined(__ANDROID__)
 
 namespace firebase {

firestore/src/common/transaction.cc

@@ -12,7 +12,7 @@
 #elif defined(FIRESTORE_STUB_BUILD)
 #include "firestore/src/stub/write_batch_stub.h"
 #else
-#include "firestore/src/ios/write_batch_ios.h"
+#include "firestore/src/main/write_batch_main.h"
 #endif  // defined(__ANDROID__)
 
 namespace firebase {

firestore/src/common/write_batch.cc

@@ -1,13 +1,13 @@
-#include "firestore/src/ios/collection_reference_ios.h"
+#include "firestore/src/main/collection_reference_main.h"
 
 #include <future>  // NOLINT(build/c++11)
 #include <utility>
 
 #include "Firestore/core/src/core/user_data.h"
-#include "firestore/src/ios/converter_ios.h"
-#include "firestore/src/ios/document_reference_ios.h"
-#include "firestore/src/ios/field_value_ios.h"
-#include "firestore/src/ios/user_data_converter_ios.h"
+#include "firestore/src/main/converter_main.h"
+#include "firestore/src/main/document_reference_main.h"
+#include "firestore/src/main/field_value_main.h"
+#include "firestore/src/main/user_data_converter_main.h"
 
 namespace firebase {
 namespace firestore {

firestore/src/ios/collection_reference_ios.cc renamed to firestore/src/main/collection_reference_main.cc

@@ -1,12 +1,12 @@
-#ifndef FIREBASE_FIRESTORE_CLIENT_CPP_SRC_IOS_COLLECTION_REFERENCE_IOS_H_
-#define FIREBASE_FIRESTORE_CLIENT_CPP_SRC_IOS_COLLECTION_REFERENCE_IOS_H_
+#ifndef FIREBASE_FIRESTORE_CLIENT_CPP_SRC_MAIN_COLLECTION_REFERENCE_MAIN_H_
+#define FIREBASE_FIRESTORE_CLIENT_CPP_SRC_MAIN_COLLECTION_REFERENCE_MAIN_H_
 
 #include <string>
 
 #include "Firestore/core/src/api/collection_reference.h"
 #include "firestore/src/include/firebase/firestore/document_reference.h"
-#include "firestore/src/ios/promise_factory_ios.h"
-#include "firestore/src/ios/query_ios.h"
+#include "firestore/src/main/promise_factory_main.h"
+#include "firestore/src/main/query_main.h"
 
 namespace firebase {
 namespace firestore {
@@ -31,4 +31,4 @@ class CollectionReferenceInternal : public QueryInternal {
 }  // namespace firestore
 }  // namespace firebase
 
-#endif  // FIREBASE_FIRESTORE_CLIENT_CPP_SRC_IOS_COLLECTION_REFERENCE_IOS_H_
+#endif  // FIREBASE_FIRESTORE_CLIENT_CPP_SRC_MAIN_COLLECTION_REFERENCE_MAIN_H_

firestore/src/ios/collection_reference_ios.h renamed to firestore/src/main/collection_reference_main.h

@@ -1,5 +1,5 @@
-#ifndef FIREBASE_FIRESTORE_CLIENT_CPP_SRC_IOS_CONVERTER_IOS_H_
-#define FIREBASE_FIRESTORE_CLIENT_CPP_SRC_IOS_CONVERTER_IOS_H_
+#ifndef FIREBASE_FIRESTORE_CLIENT_CPP_SRC_MAIN_CONVERTER_MAIN_H_
+#define FIREBASE_FIRESTORE_CLIENT_CPP_SRC_MAIN_CONVERTER_MAIN_H_
 
 #include <memory>
 #include <utility>
@@ -16,16 +16,16 @@
 #include "absl/memory/memory.h"
 #include "firestore/src/common/type_mapping.h"
 #include "firestore/src/include/firebase/firestore.h"
-#include "firestore/src/ios/collection_reference_ios.h"
-#include "firestore/src/ios/document_change_ios.h"
-#include "firestore/src/ios/document_reference_ios.h"
-#include "firestore/src/ios/document_snapshot_ios.h"
-#include "firestore/src/ios/field_value_ios.h"
-#include "firestore/src/ios/listener_registration_ios.h"
-#include "firestore/src/ios/query_ios.h"
-#include "firestore/src/ios/query_snapshot_ios.h"
-#include "firestore/src/ios/transaction_ios.h"
-#include "firestore/src/ios/write_batch_ios.h"
+#include "firestore/src/main/collection_reference_main.h"
+#include "firestore/src/main/document_change_main.h"
+#include "firestore/src/main/document_reference_main.h"
+#include "firestore/src/main/document_snapshot_main.h"
+#include "firestore/src/main/field_value_main.h"
+#include "firestore/src/main/listener_registration_main.h"
+#include "firestore/src/main/query_main.h"
+#include "firestore/src/main/query_snapshot_main.h"
+#include "firestore/src/main/transaction_main.h"
+#include "firestore/src/main/write_batch_main.h"
 
 namespace firebase {
 namespace firestore {
@@ -128,4 +128,4 @@ inline const api::DocumentSnapshot& GetCoreApi(const DocumentSnapshot& from) {
 }  // namespace firestore
 }  // namespace firebase
 
-#endif  // FIREBASE_FIRESTORE_CLIENT_CPP_SRC_IOS_CONVERTER_IOS_H_
+#endif  // FIREBASE_FIRESTORE_CLIENT_CPP_SRC_MAIN_CONVERTER_MAIN_H_

firestore/src/ios/converter_ios.h renamed to firestore/src/main/converter_main.h

@@ -1,5 +1,5 @@
-#ifndef FIREBASE_FIRESTORE_CLIENT_CPP_SRC_IOS_CREATE_CREDENTIALS_PROVIDER_H_
-#define FIREBASE_FIRESTORE_CLIENT_CPP_SRC_IOS_CREATE_CREDENTIALS_PROVIDER_H_
+#ifndef FIREBASE_FIRESTORE_CLIENT_CPP_SRC_MAIN_CREATE_CREDENTIALS_PROVIDER_H_
+#define FIREBASE_FIRESTORE_CLIENT_CPP_SRC_MAIN_CREATE_CREDENTIALS_PROVIDER_H_
 
 #include <memory>
 
@@ -16,4 +16,4 @@ std::unique_ptr<auth::CredentialsProvider> CreateCredentialsProvider(App& app);
 }  // namespace firestore
 }  // namespace firebase
 
-#endif  // FIREBASE_FIRESTORE_CLIENT_CPP_SRC_IOS_CREATE_CREDENTIALS_PROVIDER_H_
+#endif  // FIREBASE_FIRESTORE_CLIENT_CPP_SRC_MAIN_CREATE_CREDENTIALS_PROVIDER_H_

firestore/src/ios/create_credentials_provider.h renamed to firestore/src/main/create_credentials_provider.h

@@ -1,7 +1,7 @@
 #include "absl/memory/memory.h"
 #include "auth/src/include/firebase/auth.h"
-#include "firestore/src/ios/create_credentials_provider.h"
-#include "firestore/src/ios/credentials_provider_desktop.h"
+#include "firestore/src/main/create_credentials_provider.h"
+#include "firestore/src/main/credentials_provider_desktop.h"
 
 namespace firebase {
 namespace firestore {

firestore/src/ios/create_credentials_provider_desktop.cc renamed to firestore/src/main/create_credentials_provider_desktop.cc

@@ -1,4 +1,4 @@
-#include "firestore/src/ios/create_credentials_provider.h"
+#include "firestore/src/main/create_credentials_provider.h"
 
 #import "FirebaseCoreInternal.h"
 #import "FIRAuthInterop.h"