Change file format and move the hash out of non-Windows platforms.

Author: jonsimantov

analytics/generate_windows_stubs.py

@@ -152,16 +152,15 @@ def generate_function_pointers(dll_file_path, header_file_path, output_h_path, o
         f.write("\n\n")
         f.write("\n".join(macro_definitions))
         f.write("\n// clang-format on\n")
+        f.write(f'\n// Number of Google Analytics functions expected to be loaded from the DLL.')
+        f.write('\nextern const int FirebaseAnalytics_DynamicFunctionCount;\n');
         f.write("\n// --- Dynamic Loader Declaration for Windows ---\n")
-        f.write("#if defined(_WIN32)\n")
+        f.write("#if defined(_WIN32)\n\n")
         f.write('#include <windows.h>\n')
-        f.write(f'\n// Google Analytics Windows DLL SHA256 hash, to be verified on load.')
-        f.write(f'\nextern const unsigned char FirebaseAnalytics_WindowsDllHash[{len(dll_hash)}];\n');
-
-        f.write(f'\n// Number of Google Analytics functions expected to be loaded from the DLL.')
-        f.write(f'\n#define FIREBASE_ANALYTICS_DYNAMIC_FUNCTION_COUNT {len(function_details_for_loader)}\n\n')
+        f.write(f'\n// Google Analytics Windows DLL SHA256 hash, to be verified before loading.')
+        f.write(f'\nextern const unsigned char FirebaseAnalytics_WindowsDllHash[{len(dll_hash)}];\n\n');
         f.write('// Load Analytics functions from the given DLL handle into function pointers.\n')
-        f.write(f'// Returns the number of functions successfully loaded (out of\n// FIREBASE_ANALYTICS_DYNAMIC_FUNCTION_COUNT).\n')
+        f.write(f'// Returns the number of functions successfully loaded.\n')
         f.write("int FirebaseAnalytics_LoadDynamicFunctions(HMODULE dll_handle);\n\n")
         f.write('// Reset all function pointers back to stubs.\n')
         f.write("void FirebaseAnalytics_UnloadDynamicFunctions(void);\n\n")
@@ -180,12 +179,16 @@ def generate_function_pointers(dll_file_path, header_file_path, output_h_path, o
         f.write(f'#include "{INCLUDE_PREFIX}{os.path.basename(output_h_path)}"\n\n')
         f.write('#include <stddef.h>\n\n')
         f.write("static void* g_stub_memory = NULL;\n\n")
-        f.write("// clang-format off\n\n")
-        f.write('// Google Analytics Windows DLL SHA256 hash, to be verified on load.\n')
+        f.write("// clang-format off\n")
+        f.write(f'\n// Number of Google Analytics functions expected to be loaded from the DLL.')
+        f.write(f'\nconst int FirebaseAnalytics_DynamicFunctionCount = {len(function_details_for_loader)};\n\n');
+        f.write("#if defined(_WIN32)\n")
+        f.write('// Google Analytics Windows DLL SHA256 hash, to be verified before loading.\n')
         f.write('const unsigned char FirebaseAnalytics_WindowsDllHash[] = {\n    ')
         f.write(', '.join(["0x%02x" % s for s in dll_hash]))
-        f.write('\n};\n\n')
-        f.write("// --- Stub Function Definitions ---\n")
+        f.write('\n};\n')
+        f.write("#endif  // defined(_WIN32)\n")
+        f.write("\n// --- Stub Function Definitions ---\n")
         f.write("\n\n".join(stub_functions))
         f.write("\n\n\n// --- Function Pointer Initializations ---\n")
         f.write("\n".join(pointer_initializations))

analytics/src/analytics_desktop.cc

@@ -69,11 +69,11 @@ void Initialize(const App& app) {
     if (g_analytics_module) {
       int num_loaded = FirebaseAnalytics_LoadDynamicFunctions(
           g_analytics_module);  // Ensure g_analytics_module is used
-      if (num_loaded < FIREBASE_ANALYTICS_DYNAMIC_FUNCTION_COUNT) {
+      if (num_loaded < FirebaseAnalytics_DynamicFunctionCount) {
         LogWarning(
             "Analytics: Failed to load functions from Google Analytics "
             "module (%d out of %d loaded), reverting to stubs.",
-            num_loaded, FIREBASE_ANALYTICS_DYNAMIC_FUNCTION_COUNT);
+            num_loaded, FirebaseAnalytics_DynamicFunctionCount);
         FirebaseAnalytics_UnloadDynamicFunctions();
         FreeLibrary(g_analytics_module);
         g_analytics_module = 0;

analytics/src/analytics_desktop_dynamic.c

@@ -22,10 +22,15 @@ static void* g_stub_memory = NULL;
 
 // clang-format off
 
+// Number of Google Analytics functions expected to be loaded from the DLL.
+const int FirebaseAnalytics_DynamicFunctionCount = 19;
+
+#if defined(_WIN32)
 // Google Analytics Windows DLL SHA256 hash, to be verified on load.
 const unsigned char FirebaseAnalytics_WindowsDllHash[] = {
     0xc1, 0xb9, 0xff, 0x6e, 0x91, 0x19, 0xc3, 0x0b, 0xbe, 0xb7, 0x47, 0x23, 0x26, 0xdc, 0xde, 0x41, 0x8f, 0x45, 0x68, 0x2e, 0x6b, 0x82, 0x2e, 0x25, 0xee, 0xd9, 0x22, 0xfe, 0x6e, 0x3c, 0xc6, 0x98
 };
+#endif  // defined(_WIN32)
 
 // --- Stub Function Definitions ---
 // Stub for GoogleAnalytics_Item_Create

analytics/src/analytics_desktop_dynamic.h

@@ -112,19 +112,19 @@ extern void (*ptr_GoogleAnalytics_SetAnalyticsCollectionEnabled)(bool enabled);
 #define GoogleAnalytics_SetAnalyticsCollectionEnabled ptr_GoogleAnalytics_SetAnalyticsCollectionEnabled
 // clang-format on
 
+// Number of Google Analytics functions expected to be loaded from the DLL.
+extern const int FirebaseAnalytics_DynamicFunctionCount;
+
 // --- Dynamic Loader Declaration for Windows ---
 #if defined(_WIN32)
+
 #include <windows.h>
 
-// Google Analytics Windows DLL SHA256 hash, to be verified on load.
+// Google Analytics Windows DLL SHA256 hash, to be verified before loading.
 extern const unsigned char FirebaseAnalytics_WindowsDllHash[32];
 
-// Number of Google Analytics functions expected to be loaded from the DLL.
-#define FIREBASE_ANALYTICS_DYNAMIC_FUNCTION_COUNT 19
-
 // Load Analytics functions from the given DLL handle into function pointers.
-// Returns the number of functions successfully loaded (out of
-// FIREBASE_ANALYTICS_DYNAMIC_FUNCTION_COUNT).
+// Returns the number of functions successfully loaded.
 int FirebaseAnalytics_LoadDynamicFunctions(HMODULE dll_handle);
 
 // Reset all function pointers back to stubs.