Add extra swig post process for analytics static properties (#201)

Co-authored-by: Cynthia Jiang <[email protected]>

Author: cynthiajoan

cmake/firebase_swig.cmake

@@ -187,6 +187,11 @@ macro(firebase_swig_add_library name)
     set(import_module_override "")
   endif()
 
+  set(static_k_removal_override "")
+  if("${name}" STREQUAL "firebase_analytics_swig") # hack for now, need to find better way to do special cases
+    set(static_k_removal_override "--static_k_removal=True")
+  endif()
+
   add_custom_command(
     OUTPUT ${UNITY_SWIG_CS_FIX_FILE}
     DEPENDS ${UNITY_SWIG_CS_GEN_FILE}
@@ -198,6 +203,7 @@ macro(firebase_swig_add_library name)
         --out_file=\"${UNITY_SWIG_CS_FIX_FILE}\"
         --namespace=${UNITY_SWIG_MODULE_OUT}
         ${import_module_override}
+        ${static_k_removal_override}
   )
 
   set(UNITY_SWIG_CPP_GEN_FILE ${swig_generated_file_fullname})

cmake/swig_fix.py

@@ -47,6 +47,8 @@
                      'Clear out in file once out file is written')
 flags.DEFINE_string('import_module', None,
                     'Change DllImport module to this value')
+flags.DEFINE_boolean('static_k_removal', False,
+                    'Whether to remove public static attributes k initial')
 
 
 def get_dll_import_transformation():
@@ -63,6 +65,20 @@ def get_dll_import_transformation():
   ]
 
 
+def get_static_k_removal_transformation():
+  """Gets the transforms to remove k initial for public static attribute
+  
+  Returns:
+    list of static k removal transformations.
+  """
+  if not FLAGS.static_k_removal:
+    return []
+
+  return [
+      swig_post_process.StaticFunctionKInitRemoval()
+  ]
+
+
 class NamespaceCMethodsCMake(swig_post_process.SWIGPostProcessingInterface):
   """Add a module namespace prefix to all generated C methods."""
 
@@ -146,7 +162,8 @@ def get_transformations(namespace):
           swig_post_process.RenameAsyncMethods(),
           swig_post_process.RenameArgsFromSnakeToCamelCase(),
           swig_post_process.AddPInvokeAttribute(),
-      ] + get_dll_import_transformation(),
+      ] + get_dll_import_transformation()
+        + get_static_k_removal_transformation(),
   }
 
 
@@ -166,7 +183,7 @@ def main(argv):  # pylint: disable=unused-argument
     logging.warning('Empty input file "%s"', FLAGS.in_file)
     return 0
 
-  new_contents = swig_post_process.apply_post_process(contents, '', processes)
+  new_contents = swig_post_process.apply_post_process(contents, FLAGS.in_file, processes)
 
   with open(FLAGS.out_file, 'w') as out_file:
     out_file.write(new_contents)

swig_post_process.py

@@ -479,7 +479,40 @@ def __call__(self, file_str, filename, iteration):
       output.append(line)
     return '\n'.join(output)
 
+class StaticFunctionKInitRemoval(SWIGPostProcessingInterface):
+  """Change static function or property that has k in the name initial.
 
+  Any function or property after "public static" and named as kXYZ will
+  be renamed to XYZ.
+  """
+
+  def __init__(self):
+    """Initialize the instance."""
+    self.static_function_regex = re.compile(
+        r'public static ([^ =]*) (k[^ =]*)')
+
+  def __call__(self, file_str, filename, iteration):
+    """Change static function or property that has k in the name initial.
+
+    Args:
+      file_str: This is a string containing the file contents to be processed.
+      filename: Unused.
+      iteration: Unused.
+
+    Returns:
+      Returns the modified file_str.
+    """
+    output = []
+    for line in file_str.splitlines():
+      match = self.static_function_regex.search(line)
+      if match:
+        function_name = match.groups()[1]
+        line = ''.join([line[:match.end(1)+1],
+                        function_name.replace('k', ''),
+                        line[match.end(2):]])
+      output.append(line)
+    return '\n'.join(output)
+    
 class DynamicToReinterpretCast(SWIGPostProcessingInterface):
   """Changes the use of dynamic_cast in SWIG generated code to reinterpret_cast.