Added FIREBASE_ARRAYSIZE macro to internal/common.h

smiles · a-maurice · commit c5fc220e63a8 · 2019-09-10T18:19:29.000-07:00
Also, moved all compile time array size calculation to the macro.

PiperOrigin-RevId: 266401243
diff --git a/admob/src/android/admob_android.cc b/admob/src/android/admob_android.cc
@@ -33,6 +33,7 @@
 #include "admob/src/include/firebase/admob/types.h"
 #include "app/src/assert.h"
 #include "app/src/embedded_file.h"
+#include "app/src/include/firebase/internal/common.h"
 #include "app/src/include/google_play_services/availability.h"
 #include "app/src/reference_counted_future_impl.h"
 #include "app/src/util_android.h"
@@ -426,18 +427,16 @@ bool RegisterNatives() {
   };
   JNIEnv* env = GetJNI();
   return banner_view_helper::RegisterNatives(
-             env, kBannerMethods,
-             sizeof(kBannerMethods) / sizeof(kBannerMethods[0])) &&
+             env, kBannerMethods, FIREBASE_ARRAYSIZE(kBannerMethods)) &&
          interstitial_ad_helper::RegisterNatives(
              env, kInterstitialMethods,
-             sizeof(kInterstitialMethods) / sizeof(kInterstitialMethods[0])) &&
+             FIREBASE_ARRAYSIZE(kInterstitialMethods)) &&
          native_express_ad_view_helper::RegisterNatives(
              env, kNativeExpressMethods,
-             sizeof(kNativeExpressMethods) /
-                 sizeof(kNativeExpressMethods[0])) &&
+             FIREBASE_ARRAYSIZE(kNativeExpressMethods)) &&
          rewarded_video::rewarded_video_helper::RegisterNatives(
              env, kRewardedVideoMethods,
-             sizeof(kRewardedVideoMethods) / sizeof(kRewardedVideoMethods[0]));
+             FIREBASE_ARRAYSIZE(kRewardedVideoMethods));
 }
 
 }  // namespace admob
diff --git a/app/src/app_common.cc b/app/src/app_common.cc
@@ -29,6 +29,7 @@
 #include "app/src/callback.h"
 #include "app/src/cleanup_notifier.h"
 #include "app/src/include/firebase/app.h"
+#include "app/src/include/firebase/internal/common.h"
 #include "app/src/include/firebase/internal/platform.h"
 #include "app/src/include/firebase/version.h"
 #include "app/src/mutex.h"
@@ -425,8 +426,7 @@ void GetOuterMostSdkAndVersion(std::string* sdk, std::string* version) {
       FIREBASE_CPP_USER_AGENT_PREFIX,
   };
   LibraryRegistry* registry = LibraryRegistry::Initialize();
-  for (size_t i = 0; i < sizeof(kLibraryVersions) / sizeof(kLibraryVersions[0]);
-       ++i) {
+  for (size_t i = 0; i < FIREBASE_ARRAYSIZE(kLibraryVersions); ++i) {
     std::string library(kLibraryVersions[i]);
     std::string library_version = registry->GetLibraryVersion(library);
     if (!library_version.empty()) {
diff --git a/app/src/app_desktop.cc b/app/src/app_desktop.cc
@@ -14,13 +14,14 @@
  * limitations under the License.
  */
 
-#include "app/src/include/firebase/app.h"
-
 #include <string.h>
+
 #include <fstream>
 
 #include "app/src/app_common.h"
 #include "app/src/function_registry.h"
+#include "app/src/include/firebase/app.h"
+#include "app/src/include/firebase/internal/common.h"
 #include "app/src/include/firebase/version.h"
 #include "app/src/log.h"
 #include "app/src/util.h"
@@ -99,8 +100,8 @@ AppOptions* AppOptions::LoadDefault(AppOptions* options) {
     allocated_options = true;
   }
   std::string config_files;
-  size_t number_of_config_filenames = sizeof(kDefaultGoogleServicesNames) /
-                                      sizeof(kDefaultGoogleServicesNames[0]);
+  size_t number_of_config_filenames =
+      FIREBASE_ARRAYSIZE(kDefaultGoogleServicesNames);
   for (size_t i = 0; i < number_of_config_filenames; i++) {
     std::string full_path = internal::g_default_config_path +
                             kDefaultGoogleServicesNames[i];
diff --git a/app/src/app_options.cc b/app/src/app_options.cc
@@ -23,6 +23,7 @@
 #include "app/google_services_resource.h"
 #include "app/src/assert.h"
 #include "app/src/include/firebase/app.h"
+#include "app/src/include/firebase/internal/common.h"
 #include "app/src/include/firebase/internal/platform.h"
 #include "app/src/log.h"
 #include "flatbuffers/idl.h"
@@ -158,8 +159,7 @@ AppOptions* AppOptions::LoadFromJsonConfig(const char* config,  // NOLINT
       // We explicitly ignore the value of GA tracking ID and Messaging Sender
       // ID as we don't support analytics on desktop at the moment.
   };
-  for (size_t i = 0;
-       i < sizeof(options_to_validate) / sizeof(options_to_validate[0]); ++i) {
+  for (size_t i = 0; i < FIREBASE_ARRAYSIZE(options_to_validate); ++i) {
     const auto& validate_option = options_to_validate[i];
     if (strlen(validate_option.option_value) == 0) {
       LogWarning("%s not set in the Firebase config.",
diff --git a/app/src/google_play_services/availability_android.cc b/app/src/google_play_services/availability_android.cc
@@ -22,6 +22,7 @@
 
 #include "app/google_api_resources.h"
 #include "app/src/embedded_file.h"
+#include "app/src/include/firebase/internal/common.h"
 #include "app/src/log.h"
 #include "app/src/reference_counted_future_impl.h"
 #include "app/src/util_android.h"
@@ -174,8 +175,7 @@ bool Initialize(JNIEnv* env, jobject activity) {
                                                            &embedded_files) &&
           googleapiavailabilityhelper::CacheMethodIds(env, activity) &&
           googleapiavailabilityhelper::RegisterNatives(
-              env, kHelperMethods,
-              sizeof(kHelperMethods) / sizeof(kHelperMethods[0]))) {
+              env, kHelperMethods, FIREBASE_ARRAYSIZE(kHelperMethods))) {
         // Everything initialized properly.
         g_data->classes_loaded = true;
         return true;
@@ -232,8 +232,7 @@ Availability CheckAvailability(JNIEnv* env, jobject activity) {
         activity);
     firebase::util::CheckAndClearJniExceptions(env);
     env->DeleteLocalRef(api);
-    for (size_t i = 0; i < sizeof(ConnectionResultToAvailability) /
-                               sizeof(ConnectionResultToAvailability[0]);
+    for (size_t i = 0; i < FIREBASE_ARRAYSIZE(ConnectionResultToAvailability);
          i++) {
       if (result == ConnectionResultToAvailability[i].java) {
         g_data->cached_availability = ConnectionResultToAvailability[i].cpp;
diff --git a/app/src/include/firebase/internal/common.h b/app/src/include/firebase/internal/common.h
@@ -121,4 +121,10 @@ struct AlignedStorage {
 #endif
 #endif  // FIREBASE_DEPRECATED
 
+// Calculates the number of elements in an array.
+#define FIREBASE_ARRAYSIZE(x) (sizeof(x) / sizeof((x)[0]))
+
+// Guaranteed compile time strlen.
+#define FIREBASE_STRLEN(s) (FIREBASE_ARRAYSIZE(s) - sizeof((s)[0]))
+
 #endif  // FIREBASE_APP_CLIENT_CPP_SRC_INCLUDE_FIREBASE_INTERNAL_COMMON_H_
diff --git a/app/src/invites/android/invites_android_helper.cc b/app/src/invites/android/invites_android_helper.cc
@@ -21,6 +21,7 @@
 
 #include "app/invites_resources.h"
 #include "app/src/embedded_file.h"
+#include "app/src/include/firebase/internal/common.h"
 #include "app/src/invites/receiver_interface.h"
 #include "app/src/invites/sender_receiver_interface.h"
 #include "app/src/log.h"
@@ -81,8 +82,7 @@ AndroidHelper::AndroidHelper(const ::firebase::App& app,
             dynamic_links_native_wrapper::CacheMethodIds(env,
                                                          app_->activity()) &&
             dynamic_links_native_wrapper::RegisterNatives(
-                env, kNativeMethods,
-                sizeof(kNativeMethods) / sizeof(kNativeMethods[0])))) {
+                env, kNativeMethods, FIREBASE_ARRAYSIZE(kNativeMethods)))) {
         util::Terminate(env);
         app_ = nullptr;
         return;
diff --git a/app/src/log_android_callback.cc b/app/src/log_android_callback.cc
@@ -19,6 +19,7 @@
 
 #include <string>
 
+#include "app/src/include/firebase/internal/common.h"
 #include "app/src/log.h"
 #include "app/src/util_android.h"
 
@@ -44,8 +45,7 @@ Java_com_google_firebase_app_internal_cpp_Log_nativeLog(
       kLogLevelError,    // 6 = android.util.Log.ERROR
       kLogLevelAssert,   // 7 = android.util.Log.ASSERT
   };
-  assert(priority <
-         sizeof(kLogPriorityToLogLevel) / sizeof(kLogPriorityToLogLevel[0]));
+  assert(priority < FIREBASE_ARRAYSIZE(kLogPriorityToLogLevel));
   assert(priority >= 0);
   LogMessage(kLogPriorityToLogLevel[priority], "(%s) %s", ctag.c_str(),
              cmsg.c_str());
diff --git a/app/src/log_ios.mm b/app/src/log_ios.mm
@@ -20,6 +20,8 @@
 
 #import "FIRConfiguration.h"
 
+#include "app/src/include/firebase/internal/common.h"
+
 #include <stdarg.h>
 
 namespace firebase {
@@ -58,7 +60,7 @@ void LogInitialize() {
 
 // Set the platform specific SDK log level.
 void LogSetPlatformLevel(LogLevel level) {
-  assert(level < sizeof(kCppToIOSLogLevel) / sizeof(kCppToIOSLogLevel[0]));
+  assert(level < FIREBASE_ARRAYSIZE(kCppToIOSLogLevel));
   [[FIRConfiguration sharedInstance] setLoggerLevel:kCppToIOSLogLevel[level]];
 }
 
diff --git a/app/src/log_stdio.cc b/app/src/log_stdio.cc
@@ -19,6 +19,7 @@
 #include <stdio.h>
 #include <string.h>
 
+#include "app/src/include/firebase/internal/common.h"
 #include "app/src/include/firebase/internal/platform.h"
 #include "app/src/log.h"
 
@@ -57,7 +58,7 @@ void LogSetPlatformLevel(LogLevel level) {}
 
 // Log a firebase message.
 void LogMessageV(LogLevel log_level, const char* format, va_list args) {
-  assert(log_level < (sizeof(kLogLevelPrefix) / sizeof(kLogLevelPrefix[0])));
+  assert(log_level < FIREBASE_ARRAYSIZE(kLogLevelPrefix));
   const char* prefix = kLogLevelPrefix[log_level];
   printf("%s", prefix);
   vprintf(format, args);
diff --git a/app/src/util_android.cc b/app/src/util_android.cc
@@ -34,6 +34,7 @@
 #include "app/app_resources.h"
 #include "app/src/app_common.h"
 #include "app/src/embedded_file.h"
+#include "app/src/include/firebase/internal/common.h"
 #include "app/src/log.h"
 
 #if !defined(FIREBASE_NAMESPACE)
@@ -293,9 +294,7 @@ static jclass FindOrLoadClassFromLoaders(JNIEnv* env, const char* class_name) {
       class_loader::kFindLoadedClass, class_loader::kLoadClass};
   jstring class_name_object = env->NewStringUTF(class_name);
   jclass class_object = nullptr;
-  for (size_t i = 0;
-       i < sizeof(kFindLoadClassMethods) / sizeof(kFindLoadClassMethods[0]);
-       ++i) {
+  for (size_t i = 0; i < FIREBASE_ARRAYSIZE(kFindLoadClassMethods); ++i) {
     for (auto it = g_class_loaders->begin();
          !class_object && it != g_class_loaders->end(); ++it) {
       class_object = static_cast<jclass>(env->CallObjectMethod(
@@ -510,9 +509,8 @@ bool Initialize(JNIEnv* env, jobject activity_object) {
   if (!(log::CacheClassFromFiles(env, activity_object, &embedded_files) !=
             nullptr &&
         log::CacheMethodIds(env, activity_object) &&
-        log::RegisterNatives(
-            env, kNativeLogMethods,
-            sizeof(kNativeLogMethods) / sizeof(kNativeLogMethods[0])))) {
+        log::RegisterNatives(env, kNativeLogMethods,
+                             FIREBASE_ARRAYSIZE(kNativeLogMethods)))) {
     return false;
   }
 
@@ -1350,8 +1348,7 @@ bool JavaThreadContext::Initialize(
                                                         &embedded_files) &&
         cppthreaddispatchercontext::CacheMethodIds(env, activity_object) &&
         cppthreaddispatchercontext::RegisterNatives(
-            env, kCppThreadMethods,
-            sizeof(kCppThreadMethods) / sizeof(kCppThreadMethods[0])) &&
+            env, kCppThreadMethods, FIREBASE_ARRAYSIZE(kCppThreadMethods)) &&
         cppthreaddispatcher::CacheClassFromFiles(env, activity_object,
                                                  &embedded_files) &&
         cppthreaddispatcher::CacheMethodIds(env, activity_object))) {
diff --git a/app/src/util_ios.mm b/app/src/util_ios.mm
@@ -17,6 +17,7 @@
 #include "app/src/util_ios.h"
 
 #include "app/src/assert.h"
+#include "app/src/include/firebase/internal/common.h"
 #include "app/src/log.h"
 
 #include <assert.h>
@@ -94,9 +95,7 @@ void ForEachAppDelegateClass(void (^block)(Class)) {
           "FIRAAppDelegate",
           // Declared here.
           "FIRSAMAppDelegate"};
-      for (size_t i = 0;
-           i < sizeof(kClassNameBlacklist) / sizeof(kClassNameBlacklist[0]);
-           ++i) {
+      for (size_t i = 0; i < FIREBASE_ARRAYSIZE(kClassNameBlacklist); ++i) {
         if (strcmp(class_name, kClassNameBlacklist[i]) == 0) {
           blacklisted = true;
           break;
diff --git a/auth/src/android/common_android.cc b/auth/src/android/common_android.cc
@@ -16,6 +16,7 @@
 
 #include "auth/src/android/common_android.h"
 
+#include "app/src/include/firebase/internal/common.h"
 #include "app/src/log.h"
 
 namespace firebase {
@@ -387,8 +388,7 @@ AuthError ErrorCodeFromException(JNIEnv* env, jobject exception) {
       {firebase_exception::GetClass(), kFirebaseCodes, kAuthErrorUnimplemented},
   };
 
-  size_t array_size = sizeof(exception_map) / sizeof(exception_map[0]);
-  for (size_t i = 0; i < array_size; i++) {
+  for (size_t i = 0; i < FIREBASE_ARRAYSIZE(exception_map); i++) {
     if (exception_map[i].exception_class &&
         env->IsInstanceOf(exception, exception_map[i].exception_class)) {
       const ErrorCodeMapping* error_map = exception_map[i].error_map;
diff --git a/auth/src/android/credential_android.cc b/auth/src/android/credential_android.cc
@@ -23,6 +23,7 @@
 #include "app/src/build_type_generated.h"
 #include "app/src/embedded_file.h"
 #include "app/src/include/firebase/app.h"
+#include "app/src/include/firebase/internal/common.h"
 #include "app/src/util_android.h"
 #include "auth/src/android/common_android.h"
 
@@ -269,8 +270,7 @@ bool CacheCredentialMethodIds(
         jniphone::CacheMethodIds(env, activity) &&
         jniphone::RegisterNatives(
             env, kNativeJniAuthPhoneListenerMethods,
-            sizeof(kNativeJniAuthPhoneListenerMethods) /
-                sizeof(kNativeJniAuthPhoneListenerMethods[0])))) {
+            FIREBASE_ARRAYSIZE(kNativeJniAuthPhoneListenerMethods)))) {
     return false;
   }
 
diff --git a/auth/src/ios/auth_ios.mm b/auth/src/ios/auth_ios.mm
@@ -21,6 +21,7 @@
 
 #include "app/src/app_ios.h"
 #include "app/src/assert.h"
+#include "app/src/include/firebase/internal/common.h"
 #include "app/src/log.h"
 #include "app/src/mutex.h"
 #include "app/src/reference_counted_future_impl.h"
@@ -273,8 +274,7 @@ AuthError AuthErrorFromNSError(NSError *_Nullable error) {
   if (!error || error.code == 0) {
     return kAuthErrorNone;
   }
-  size_t array_size = sizeof(kIosToCppErrorMap) / sizeof(kIosToCppErrorMap[0]);
-  for (size_t i = 0; i < array_size; i++) {
+  for (size_t i = 0; i < FIREBASE_ARRAYSIZE(kIosToCppErrorMap); i++) {
     if (error.code == kIosToCppErrorMap[i].ios_error) return kIosToCppErrorMap[i].cpp_error;
   }
   return kAuthErrorUnimplemented;
diff --git a/database/src/android/database_android.cc b/database/src/android/database_android.cc
@@ -20,6 +20,7 @@
 #include "app/src/embedded_file.h"
 #include "app/src/include/firebase/app.h"
 #include "app/src/include/firebase/future.h"
+#include "app/src/include/firebase/internal/common.h"
 #include "app/src/include/firebase/log.h"
 #include "app/src/reference_counted_future_impl.h"
 #include "app/src/util_android.h"
@@ -344,19 +345,16 @@ bool DatabaseInternal::InitializeEmbeddedClasses(App* app) {
         cpp_transaction_handler::CacheMethodIds(env, app->activity()) &&
         cpp_transaction_handler::RegisterNatives(
             env, kCppTransactionHandler,
-            sizeof(kCppTransactionHandler) /
-                sizeof(kCppTransactionHandler[0])) &&
+            FIREBASE_ARRAYSIZE(kCppTransactionHandler)) &&
         cpp_event_listener::CacheMethodIds(env, app->activity()) &&
         cpp_value_event_listener::CacheMethodIds(env, app->activity()) &&
         cpp_value_event_listener::RegisterNatives(
             env, kCppValueEventListenerNatives,
-            sizeof(kCppValueEventListenerNatives) /
-                sizeof(kCppValueEventListenerNatives[0])) &&
+            FIREBASE_ARRAYSIZE(kCppValueEventListenerNatives)) &&
         cpp_child_event_listener::CacheMethodIds(env, app->activity()) &&
         cpp_child_event_listener::RegisterNatives(
             env, kCppChildEventListenerNatives,
-            sizeof(kCppChildEventListenerNatives) /
-                sizeof(kCppChildEventListenerNatives[0])))) {
+            FIREBASE_ARRAYSIZE(kCppChildEventListenerNatives)))) {
     return false;
   }
   return true;
diff --git a/database/src/common/common.cc b/database/src/common/common.cc
@@ -14,6 +14,8 @@
 
 #include "database/src/include/firebase/database/common.h"
 
+#include "app/src/include/firebase/internal/common.h"
+
 namespace firebase {
 namespace database {
 
@@ -51,10 +53,8 @@ static const char* g_error_messages[] = {
 };
 
 const char* GetErrorMessage(Error error) {
-  if (error < sizeof(g_error_messages) / sizeof(g_error_messages[0]))
-    return g_error_messages[error];
-  else
-    return "";
+  return error < FIREBASE_ARRAYSIZE(g_error_messages) ? g_error_messages[error]
+                                                      : "";
 }
 
 static const Variant* g_server_value_timestamp = nullptr;
diff --git a/dynamic_links/src/dynamic_links_android.cc b/dynamic_links/src/dynamic_links_android.cc
diff --git a/instance_id/src/android/instance_id.cc b/instance_id/src/android/instance_id.cc
diff --git a/instance_id/src/ios/instance_id.mm b/instance_id/src/ios/instance_id.mm
diff --git a/messaging/src/ios/messaging.mm b/messaging/src/ios/messaging.mm
diff --git a/storage/src/android/storage_android.cc b/storage/src/android/storage_android.cc
diff --git a/storage/src/common/common.cc b/storage/src/common/common.cc
diff --git a/storage/src/common/storage_uri_parser.cc b/storage/src/common/storage_uri_parser.cc
diff --git a/storage/src/desktop/storage_path.cc b/storage/src/desktop/storage_path.cc
