Skip to content

Commit 3bfefbd

Browse files
committed
Update some nomenclature.
1 parent 4620f05 commit 3bfefbd

File tree

4 files changed

+27
-16
lines changed

4 files changed

+27
-16
lines changed

analytics/generate_windows_stubs.py

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -142,11 +142,13 @@ def generate_function_pointers(header_file_path, output_h_path, output_c_path):
142142
f.write("\n\n// --- Dynamic Loader Declaration for Windows ---\n")
143143
f.write("#if defined(_WIN32)\n")
144144
f.write('#include <windows.h> // For HMODULE\n')
145+
f.write(f'\n// Number of Google Analytics functions expected to be loaded from the DLL.')
146+
f.write(f'\n#define FIREBASE_ANALYTICS_DYNAMIC_FUNCTION_COUNT {len(function_details_for_loader)}\n\n')
145147
f.write('// Load Google Analytics functions from the given DLL handle into function pointers.\n')
146-
f.write(f'// Returns the number of functions successfully loaded (out of {len(function_details_for_loader)}).\n')
147-
f.write("int FirebaseAnalytics_LoadAnalyticsFunctions(HMODULE dll_handle);\n\n")
148+
f.write(f'// Returns the number of functions successfully loaded (out of FIREBASE_ANALYTICS_DYNAMIC_FUNCTION_COUNT).\n')
149+
f.write("int FirebaseAnalytics_LoadDynamicFunctions(HMODULE dll_handle);\n\n")
148150
f.write('// Reset all function pointers back to stubs.\n')
149-
f.write("void FirebaseAnalytics_UnloadAnalyticsFunctions(void);\n\n")
151+
f.write("void FirebaseAnalytics_UnloadDynamicFunctions(void);\n\n")
150152
f.write("#endif // defined(_WIN32)\n")
151153
f.write("\n#ifdef __cplusplus\n")
152154
f.write("}\n")
@@ -170,7 +172,7 @@ def generate_function_pointers(header_file_path, output_h_path, output_c_path):
170172
f.write("\n\n// --- Dynamic Loader Function for Windows ---\n")
171173
loader_lines = [
172174
'#if defined(_WIN32)',
173-
'int FirebaseAnalytics_LoadAnalyticsFunctions(HMODULE dll_handle) {',
175+
'int FirebaseAnalytics_LoadDynamicFunctions(HMODULE dll_handle) {',
174176
' int count = 0;\n',
175177
' if (!dll_handle) {',
176178
' return count;',
@@ -188,7 +190,7 @@ def generate_function_pointers(header_file_path, output_h_path, output_c_path):
188190
loader_lines.extend(proc_check)
189191
loader_lines.append('\n return count;')
190192
loader_lines.append('}\n')
191-
loader_lines.append('void FirebaseAnalytics_UnloadAnalyticsFunctions(void) {')
193+
loader_lines.append('void FirebaseAnalytics_UnloadDynamicFunctions(void) {')
192194
for name, ret_type, params in function_details_for_loader:
193195
loader_lines.append(f' ptr_{name} = &Stub_{name};');
194196
loader_lines.append('}\n')

analytics/src/analytics_desktop.cc

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,11 @@ void Initialize(const App& app) {
131131
g_analytics_dll = LoadLibraryW(g_analytics_dll_filename.c_str());
132132
if (g_analytics_dll) {
133133
LogInfo("Loaded Google Analytics DLL");
134-
FirebaseAnalytics_LoadAnalyticsFunctions(g_analytics_dll);
134+
int num_loaded = FirebaseAnalytics_LoadDynamicFunctions(g_analytics_dll);
135+
if (num_loaded < FIREBASE_ANALYTICS_DYNAMIC_FUNCTION_COUNT) {
136+
LogWarning("Only loaded %d out of %d expected functions from DLL.",
137+
num_loaded, FIREBASE_ANALYTICS_DYNAMIC_FUNCTION_COUNT);
138+
}
135139
} else {
136140
// Silently fail and continue in stub mode.
137141
}
@@ -150,7 +154,7 @@ bool IsInitialized() { return g_initialized; }
150154
// Call this function when Analytics is no longer needed to free up resources.
151155
void Terminate() {
152156
#if defined(_WIN32)
153-
FirebaseAnalytics_UnloadAnalyticsFunctions();
157+
FirebaseAnalytics_UnloadDynamicFunctions();
154158
if (g_analytics_dll) {
155159
FreeLibrary(g_analytics_dll);
156160
g_analytics_dll = 0;

analytics/src/analytics_desktop_dynamic.c

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
// Generated from analytics.h by generate_windows_stubs.py
1616

1717
#include "analytics/src/analytics_desktop_dynamic.h"
18+
1819
#include <stddef.h>
1920

2021
// clang-format off
@@ -152,7 +153,7 @@ void (*ptr_GoogleAnalytics_SetAnalyticsCollectionEnabled)(bool enabled) = &Stub_
152153

153154
// --- Dynamic Loader Function for Windows ---
154155
#if defined(_WIN32)
155-
int FirebaseAnalytics_LoadAnalyticsFunctions(HMODULE dll_handle) {
156+
int FirebaseAnalytics_LoadDynamicFunctions(HMODULE dll_handle) {
156157
int count = 0;
157158

158159
if (!dll_handle) {
@@ -258,7 +259,7 @@ int FirebaseAnalytics_LoadAnalyticsFunctions(HMODULE dll_handle) {
258259
return count;
259260
}
260261

261-
void FirebaseAnalytics_UnloadAnalyticsFunctions(void) {
262+
void FirebaseAnalytics_UnloadDynamicFunctions(void) {
262263
ptr_GoogleAnalytics_Item_Create = &Stub_GoogleAnalytics_Item_Create;
263264
ptr_GoogleAnalytics_Item_InsertInt = &Stub_GoogleAnalytics_Item_InsertInt;
264265
ptr_GoogleAnalytics_Item_InsertDouble = &Stub_GoogleAnalytics_Item_InsertDouble;

analytics/src/analytics_desktop_dynamic.h

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -112,18 +112,22 @@ extern void (*ptr_GoogleAnalytics_SetAnalyticsCollectionEnabled)(bool enabled);
112112
#define GoogleAnalytics_SetAnalyticsCollectionEnabled ptr_GoogleAnalytics_SetAnalyticsCollectionEnabled
113113
// clang-format on
114114

115-
116115
// --- Dynamic Loader Declaration for Windows ---
117116
#if defined(_WIN32)
118-
#include <windows.h> // For HMODULE
119-
// Load Google Analytics functions from the given DLL handle into function pointers.
120-
// Returns the number of functions successfully loaded (out of 19).
121-
int FirebaseAnalytics_LoadAnalyticsFunctions(HMODULE dll_handle);
117+
#include <windows.h> // For HMODULE
118+
119+
// Number of Google Analytics functions expected to be loaded from the DLL.
120+
#define FIREBASE_ANALYTICS_DYNAMIC_FUNCTION_COUNT 19
121+
122+
// Load Google Analytics functions from the given DLL handle into function
123+
// pointers. Returns the number of functions successfully loaded (out of
124+
// FIREBASE_ANALYTICS_DYNAMIC_FUNCTION_COUNT).
125+
int FirebaseAnalytics_LoadDynamicFunctions(HMODULE dll_handle);
122126

123127
// Reset all function pointers back to stubs.
124-
void FirebaseAnalytics_UnloadAnalyticsFunctions(void);
128+
void FirebaseAnalytics_UnloadDynamicFunctions(void);
125129

126-
#endif // defined(_WIN32)
130+
#endif // defined(_WIN32)
127131

128132
#ifdef __cplusplus
129133
}

0 commit comments

Comments
 (0)