Update script and generated files.

Author: jonsimantov

analytics/generate_windows_stubs.py

@@ -5,15 +5,15 @@
 import re
 import sys
 
-HEADER_GUARD_PREFIX = "FIREBASE_ANALYTICS_"
+HEADER_GUARD_PREFIX = "FIREBASE_ANALYTICS_SRC_WINDOWS_"
 INCLUDE_PATH = "src/windows"
 INCLUDE_PREFIX = "analytics/" + INCLUDE_PATH
 
 def generate_function_pointers(header_file_path, output_h_path, output_c_path):
     """
-    Parses a C header file to generate a header with extern function pointer
-    declarations and a source file with stub functions, initialized pointers,
-    and a dynamic loading function for Windows.
+    Parses a C header file to generate a self-contained header with typedefs,
+    extern function pointer declarations, and a source file with stub functions,
+    initialized pointers, and a dynamic loading function for Windows.
 
     Args:
         header_file_path (str): The path to the input C header file.
@@ -28,11 +28,19 @@ def generate_function_pointers(header_file_path, output_h_path, output_c_path):
         print(f"Error: Header file not found at '{header_file_path}'")
         return
 
+    # --- Extract necessary definitions from the original header ---
+
+    # Find all standard includes (e.g., <stdint.h>)
+    includes = re.findall(r"#include\s+<.*?>", header_content)
+
+    # Find all typedefs, including their documentation comments
+    typedefs = re.findall(r"/\*\*(?:[\s\S]*?)\*/\s*typedef[\s\S]*?;\s*", header_content)
+
+    # --- Extract function prototypes ---
     function_pattern = re.compile(
         r"ANALYTICS_API\s+([\w\s\*]+?)\s+(\w+)\s*\((.*?)\);",
         re.DOTALL
     )
-
     matches = function_pattern.finditer(header_content)
 
     extern_declarations = []
@@ -45,18 +53,15 @@ def generate_function_pointers(header_file_path, output_h_path, output_c_path):
         function_name = match.group(2).strip()
         params_str = match.group(3).strip()
 
-        # Clean up newlines and extra spaces for declarations
         cleaned_params_for_decl = re.sub(r'\s+', ' ', params_str) if params_str else ""
-
-        # --- Prepare for Stub and Pointer Initialization ---
         stub_name = f"Stub_{function_name}"
 
-        # Generate the return statement for the stub
+        # Generate return statement for the stub
         if "void" in return_type:
             return_statement = "    // No return value."
         elif "*" in return_type:
             return_statement = "    return NULL;"
-        else:
+        else: # bool, int64_t, etc.
             return_statement = "    return 0;"
 
         stub_function = (
@@ -67,26 +72,29 @@ def generate_function_pointers(header_file_path, output_h_path, output_c_path):
         )
         stub_functions.append(stub_function)
 
-        # Create the extern declaration for the header file
         declaration = f"extern {return_type} (*ptr_{function_name})({cleaned_params_for_decl});"
         extern_declarations.append(declaration)
 
-        # Create the initialized pointer definition for the source file
         pointer_init = f"{return_type} (*ptr_{function_name})({cleaned_params_for_decl}) = &{stub_name};"
         pointer_initializations.append(pointer_init)
 
-        # Collect details for the dynamic loader function
         function_details_for_loader.append((function_name, return_type, cleaned_params_for_decl))
 
     print(f"Found {len(pointer_initializations)} functions. Generating output files...")
 
-    # --- Write the Header File (.h) ---
-    header_guard = HEADER_GUARD_PREFIX + f"{os.path.basename(output_h_path).upper().replace('.', '_')}_"
+    # --- Write the self-contained Header File (.h) ---
+    header_guard = f"{HEADER_GUARD_PREFIX}{os.path.basename(output_h_path).upper().replace('.', '_')}_"
     with open(output_h_path, 'w', encoding='utf-8') as f:
-        f.write(f"// Generated from {os.path.basename(header_file_path)}\n\n")
+        f.write(f"// Generated from {os.path.basename(header_file_path)}\n")
+        f.write(f"// This is a self-contained header file.\n\n")
         f.write(f"#ifndef {header_guard}\n")
         f.write(f"#define {header_guard}\n\n")
-        f.write(f'#include "{INCLUDE_PREFIX}{os.path.basename(header_file_path)}"\n\n')
+
+        f.write("// --- Copied from original header ---\n")
+        f.write("\n".join(includes) + "\n\n")
+        f.write("".join(typedefs))
+        f.write("// --- End of copied section ---\n\n")
+        
         f.write("#ifdef __cplusplus\n")
         f.write('extern "C" {\n')
         f.write("#endif\n\n")
@@ -108,7 +116,7 @@ def generate_function_pointers(header_file_path, output_h_path, output_c_path):
     with open(output_c_path, 'w', encoding='utf-8') as f:
         f.write(f"// Generated from {os.path.basename(header_file_path)}\n\n")
         f.write(f'#include "{INCLUDE_PREFIX}{os.path.basename(output_h_path)}"\n')
-        f.write('#include <stddef.h>\n\n')
+        f.write('#include <stddef.h> // For NULL\n\n')
         f.write("// --- Stub Function Definitions ---\n")
         f.write("\n\n".join(stub_functions))
         f.write("\n\n\n// --- Function Pointer Initializations ---\n")

analytics/src/windows/analytics_dynamic.c

@@ -1,7 +1,7 @@
 // Generated from analytics_windows.h
 
 #include "analytics/src/windowsanalytics_dynamic.h"
-#include <stddef.h>
+#include <stddef.h> // For NULL
 
 // --- Stub Function Definitions ---
 // Stub for GoogleAnalytics_Item_Create

analytics/src/windows/analytics_dynamic.h

@@ -1,9 +1,54 @@
 // Generated from analytics_windows.h
+// This is a self-contained header file.
 
-#ifndef FIREBASE_ANALYTICS_ANALYTICS_DYNAMIC_H_
-#define FIREBASE_ANALYTICS_ANALYTICS_DYNAMIC_H_
+#ifndef FIREBASE_ANALYTICS_SRC_WINDOWS_ANALYTICS_DYNAMIC_H_
+#define FIREBASE_ANALYTICS_SRC_WINDOWS_ANALYTICS_DYNAMIC_H_
 
-#include "analytics/src/windowsanalytics_windows.h"
+// --- Copied from original header ---
+#include <stdint.h>
+
+/**
+ * @brief Opaque type for an item.
+ *
+ * This type is an opaque object that represents an item in an item vector.
+ *
+ * The caller is responsible for creating the item using the
+ * GoogleAnalytics_Item_Create() function, and destroying it using the
+ * GoogleAnalytics_Item_Destroy() function, unless it has been added to an
+ * item vector, in which case it will be destroyed at that time.
+ */
+typedef struct GoogleAnalytics_Item_Opaque GoogleAnalytics_Item;
+
+/**
+ * @brief Opaque type for an item vector.
+ *
+ * This type is an opaque object that represents a list of items. It is
+ * used to pass item vectors to the
+ * GoogleAnalytics_EventParameters_InsertItemVector() function.
+ *
+ * The caller is responsible for creating the item vector using the
+ * GoogleAnalytics_ItemVector_Create() function, and destroying it using the
+ * GoogleAnalytics_ItemVector_Destroy() function, unless it has been added
+ * to an event parameter map, in which case it will be destroyed at that time.
+ */
+typedef struct GoogleAnalytics_ItemVector_Opaque GoogleAnalytics_ItemVector;
+
+/**
+ * @brief Opaque type for an event parameter map.
+ *
+ * This type is an opaque object that represents a dictionary of event
+ * parameters. It is used to pass event parameters to the
+ * GoogleAnalytics_LogEvent() function.
+ *
+ * The caller is responsible for creating the event parameter map using the
+ * GoogleAnalytics_EventParameters_Create() function, and destroying it using
+ * the GoogleAnalytics_EventParameters_Destroy() function, unless it has been
+ * logged, in which case it will be destroyed automatically.
+ */
+typedef struct GoogleAnalytics_EventParameters_Opaque
+    GoogleAnalytics_EventParameters;
+
+// --- End of copied section ---
 
 #ifdef __cplusplus
 extern "C" {
@@ -40,4 +85,4 @@ void LoadAnalyticsFunctions(HMODULE dll_handle);
 }
 #endif
 
-#endif  // FIREBASE_ANALYTICS_ANALYTICS_DYNAMIC_H_
+#endif  // FIREBASE_ANALYTICS_SRC_WINDOWS_ANALYTICS_DYNAMIC_H_