Added FIREBASE_ARRAYSIZE macro to internal/common.h

Also, moved all compile time array size calculation to the macro. PiperOrigin-RevId: 266401243

Author: smiles

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

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()) {

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];

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.",

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;

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_

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;

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());

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]];
 }
 

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);