Mojo C++ bindings: extract code shared by different variants.

mojo/public/tools/bindings/generators/mojom_cpp_generator.py

 # Copyright 2013 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """Generates C++ source files from a mojom.Module."""
 
 import mojom.generate.generator as generator
 import mojom.generate.module as mojom
 import mojom.generate.pack as pack
 from mojom.generate.template_expander import UseJinja
@@ skipping 32 matching lines @@
 
 
 class _NameFormatter(object):
   """A formatter for the names of kinds or values."""
 
   def __init__(self, token, variant):
     self._token = token
     self._variant = variant
 
   def Format(self, separator, prefixed=False, internal=False,
-             include_variant=False, add_same_module_namespaces=False):
+             include_variant=False, add_same_module_namespaces=False,
+             flatten_nested_kind=False):
+    """Formats the name according to the given configuration.
+
+    Args:
+      separator: Separator between different parts of the name.
+      prefixed: Whether a leading separator should be added.
+      internal: Returns the name in the "internal" namespace.
+      include_variant: Whether to include variant as namespace. If |internal| is
+          True, then this flag is ignored and variant is not included.
+      add_same_module_namespaces: Includes all namespaces even if the token is
+          from the same module as the current mojom file.
+      flatten_nested_kind: It is allowed to define enums inside structs and
+          interfaces. If this flag is set to True, this method concatenates the
+          parent kind and the nested kind with '_', instead of treating the
+          parent kind as a scope."""
+
     parts = []
     if self._ShouldIncludeNamespace(add_same_module_namespaces):
       if prefixed:
         parts.append("")
       parts.extend(self._GetNamespace())
-      if include_variant and self._variant:
+      if include_variant and self._variant and not internal:
         parts.append(self._variant)
-    parts.extend(self._GetName(internal))
+    parts.extend(self._GetName(internal, flatten_nested_kind))
     return separator.join(parts)
 
-  def FormatForCpp(self, add_same_module_namespaces=False, internal=False):
+  def FormatForCpp(self, add_same_module_namespaces=False, internal=False,
+                   flatten_nested_kind=False):
     return self.Format(
         "::", prefixed=True,
         add_same_module_namespaces=add_same_module_namespaces,
-        internal=internal, include_variant=True)
+        internal=internal, include_variant=True,
+        flatten_nested_kind=flatten_nested_kind)
 
   def FormatForMojom(self):
     return self.Format(".", add_same_module_namespaces=True)
 
   def _MapKindName(self, token, internal):
     if not internal:
       return token.name
     if (mojom.IsStructKind(token) or mojom.IsUnionKind(token) or
-        mojom.IsInterfaceKind(token) or mojom.IsEnumKind(token)):
+        mojom.IsEnumKind(token)):
       return token.name + "_Data"
     return token.name
 
-  def _GetName(self, internal):
-    name = []
+  def _GetName(self, internal, flatten_nested_kind):
+    if isinstance(self._token, mojom.EnumValue):
+      name_parts = _NameFormatter(self._token.enum, self._variant)._GetName(
+          internal, flatten_nested_kind)
+      name_parts.append(self._token.name)
+      return name_parts
+
+    name_parts = []
     if internal:
-      name.append("internal")
+      name_parts.append("internal")
+
+    if (flatten_nested_kind and mojom.IsEnumKind(self._token) and
+        self._token.parent_kind):
+      name = "%s_%s" % (self._token.parent_kind.name,
+                        self._MapKindName(self._token, internal))
+      name_parts.append(name)
+      return name_parts
+
     if self._token.parent_kind:
-      name.append(self._MapKindName(self._token.parent_kind, internal))
-    # Both variable and enum constants are constructed like:
-    # Namespace::Struct::CONSTANT_NAME
-    # For enums, CONSTANT_NAME is EnumName::ENUM_VALUE.
-    if isinstance(self._token, mojom.EnumValue):
-      name.extend([self._token.enum.name, self._token.name])
-    else:
-      name.append(self._MapKindName(self._token, internal))
-    return name
+      name_parts.append(self._MapKindName(self._token.parent_kind, internal))
+    name_parts.append(self._MapKindName(self._token, internal))
+    return name_parts
 
   def _ShouldIncludeNamespace(self, add_same_module_namespaces):
     return add_same_module_namespaces or self._token.imported_from
 
   def _GetNamespace(self):
     if self._token.imported_from:
       return NamespaceToArray(self._token.imported_from["namespace"])
     elif hasattr(self._token, "module"):
       return NamespaceToArray(self._token.module.namespace)
     return []
@@ skipping 14 matching lines @@
   if not _use_new_wrapper_types:
     if mojom.IsArrayKind(field.kind) or mojom.IsMapKind(field.kind):
       return "nullptr";
     if mojom.IsStringKind(field.kind):
       return "" if _for_blink else "nullptr"
   return ""
 
 def NamespaceToArray(namespace):
   return namespace.split(".") if namespace else []
 
-def GetNameForKind(kind, internal=False):
-  return _NameFormatter(kind, _variant).FormatForCpp(internal=internal)
+def GetNameForKind(kind, internal=False, flatten_nested_kind=False):
+  return _NameFormatter(kind, _variant).FormatForCpp(
+      internal=internal, flatten_nested_kind=flatten_nested_kind)
 
-def GetQualifiedNameForKind(kind, internal=False):
+def GetQualifiedNameForKind(kind, internal=False, flatten_nested_kind=False):
   return _NameFormatter(kind, _variant).FormatForCpp(
-      internal=internal, add_same_module_namespaces=True)
+      internal=internal, add_same_module_namespaces=True,
+      flatten_nested_kind=flatten_nested_kind)
 
 def GetFullMojomNameForKind(kind):
   return _NameFormatter(kind, _variant).FormatForMojom()
 
 def IsTypemappedKind(kind):
   return hasattr(kind, "name") and \
       GetFullMojomNameForKind(kind) in _current_typemap
 
 def IsNativeOnlyKind(kind):
   return (mojom.IsStructKind(kind) or mojom.IsEnumKind(kind)) and \
@@ skipping 182 matching lines @@
   if mojom.IsDataPipeProducerKind(kind):
     return "mojo::ScopedDataPipeProducerHandle"
   if mojom.IsMessagePipeKind(kind):
     return "mojo::ScopedMessagePipeHandle"
   if mojom.IsSharedBufferKind(kind):
     return "mojo::ScopedSharedBufferHandle"
   return _kind_to_cpp_type[kind]
 
 def TranslateConstants(token, kind):
   if isinstance(token, mojom.NamedValue):
-    return _NameFormatter(token, _variant).FormatForCpp()
+    return _NameFormatter(token, _variant).FormatForCpp(
+        flatten_nested_kind=True)
 
   if isinstance(token, mojom.BuiltinValue):
     if token.value == "double.INFINITY" or token.value == "float.INFINITY":
       return "INFINITY";
     if token.value == "double.NEGATIVE_INFINITY" or \
        token.value == "float.NEGATIVE_INFINITY":
       return "-INFINITY";
     if token.value == "double.NAN" or token.value == "float.NAN":
       return "NAN";
 
@@ skipping 55 matching lines @@
     element_validate_params = GetNewContainerValidateParams(mojom.Array(
         kind=kind.value_kind))
     enum_validate_func = "nullptr"
   else:  # mojom.IsArrayKind(kind)
     expected_num_elements = generator.ExpectedArraySize(kind) or 0
     element_is_nullable = mojom.IsNullableKind(kind.kind)
     key_validate_params = "nullptr"
     element_validate_params = GetNewContainerValidateParams(kind.kind)
     if mojom.IsEnumKind(kind.kind):
       enum_validate_func = ("%s::Validate" %
-                            GetQualifiedNameForKind(kind.kind, internal=True))
+                            GetQualifiedNameForKind(kind.kind, internal=True,
+                                                    flatten_nested_kind=True))
     else:
       enum_validate_func = "nullptr"
 
   if enum_validate_func == "nullptr":
     if key_validate_params == "nullptr":
       return "%d, %s, %s" % (expected_num_elements,
                              "true" if element_is_nullable else "false",
                              element_validate_params)
     else:
       return "%s, %s" % (key_validate_params, element_validate_params)
@@ skipping 15 matching lines @@
     "cpp_wrapper_param_type": GetCppWrapperParamType,
     "cpp_data_view_type": GetCppDataViewType,
     "cpp_field_type": GetCppFieldType,
     "cpp_union_field_type": GetCppUnionFieldType,
     "cpp_pod_type": GetCppPodType,
     "cpp_union_getter_return_type": GetUnionGetterReturnType,
     "cpp_wrapper_type": GetCppWrapperType,
     "default_value": DefaultValue,
     "expression_to_text": ExpressionToText,
     "get_container_validate_params_ctor_args":
-    GetContainerValidateParamsCtorArgs,
+        GetContainerValidateParamsCtorArgs,
     "get_name_for_kind": GetNameForKind,
     "get_pad": pack.GetPad,
     "get_qualified_name_for_kind": GetQualifiedNameForKind,
     "has_callbacks": mojom.HasCallbacks,
     "has_sync_methods": mojom.HasSyncMethods,
     "requires_context_for_data_view": RequiresContextForDataView,
     "should_inline": ShouldInlineStruct,
     "should_inline_union": ShouldInlineUnion,
     "is_array_kind": mojom.IsArrayKind,
     "is_enum_kind": mojom.IsEnumKind,
@@ skipping 21 matching lines @@
       extra_headers.update(entry.get("traits_headers", []))
     return list(extra_headers)
 
   def GetExtraPublicHeaders(self):
     extra_headers = set()
     for entry in self.typemap.itervalues():
       extra_headers.update(entry.get("public_headers", []))
     return list(extra_headers)
 
   def GetJinjaExports(self):
+    structs = self.GetStructs()
+    interfaces = self.GetInterfaces()
+    all_enums = list(self.module.enums)
+    for struct in structs:
+      all_enums.extend(struct.enums)
+    for interface in interfaces:
+      all_enums.extend(interface.enums)
+
     return {
       "module": self.module,
       "namespace": self.module.namespace,
       "namespaces_as_array": NamespaceToArray(self.module.namespace),
       "imports": self.module.imports,
       "kinds": self.module.kinds,
       "enums": self.module.enums,
-      "structs": self.GetStructs(),
+      "all_enums": all_enums,
+      "structs": structs,
       "unions": self.GetUnions(),
-      "interfaces": self.GetInterfaces(),
+      "interfaces": interfaces,
       "variant": self.variant,
       "extra_traits_headers": self.GetExtraTraitsHeaders(),
       "extra_public_headers": self.GetExtraPublicHeaders(),
       "for_blink": self.for_blink,
       "use_new_wrapper_types": self.use_new_wrapper_types,
       "export_attribute": self.export_attribute,
       "export_header": self.export_header,
     }
 
   @staticmethod
   def GetTemplatePrefix():
     return "cpp_templates"
 
   @classmethod
   def GetFilters(cls):
     return cls.cpp_filters
 
   @UseJinja("module.h.tmpl")
   def GenerateModuleHeader(self):
     return self.GetJinjaExports()
 
-  @UseJinja("module-internal.h.tmpl")
-  def GenerateModuleInternalHeader(self):
-    return self.GetJinjaExports()
-
   @UseJinja("module.cc.tmpl")
   def GenerateModuleSource(self):
     return self.GetJinjaExports()
 
   @UseJinja("module-shared.h.tmpl")
   def GenerateModuleSharedHeader(self):
     return self.GetJinjaExports()
 
   @UseJinja("module-shared-internal.h.tmpl")
   def GenerateModuleSharedInternalHeader(self):
@@ skipping 17 matching lines @@
       _current_typemap = self.typemap
       global _for_blink
       _for_blink = self.for_blink
       global _use_new_wrapper_types
       _use_new_wrapper_types = self.use_new_wrapper_types
       global _variant
       _variant = self.variant
       suffix = "-%s" % self.variant if self.variant else ""
       self.Write(self.GenerateModuleHeader(),
                  self.MatchMojomFilePath("%s%s.h" % (self.module.name, suffix)))
-      self.Write(self.GenerateModuleInternalHeader(),
-                 self.MatchMojomFilePath("%s%s-internal.h" %
-                                             (self.module.name, suffix)))
       self.Write(
           self.GenerateModuleSource(),
           self.MatchMojomFilePath("%s%s.cc" % (self.module.name, suffix)))