mojom: Add associative arrays to the mojom language.

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 50 matching lines @@
   if kind.imported_from:
     parts.extend(NamespaceToArray(kind.imported_from["namespace"]))
   if internal:
     parts.append("internal")
   if kind.parent_kind:
     parts.append(kind.parent_kind.name)
   parts.append(kind.name)
   return "::".join(parts)
 
 def GetCppType(kind):
+  if mojom.IsAnyArrayKind(kind):
+    return "mojo::internal::Array_Data<%s>*" % GetCppType(kind.kind)
+  if mojom.IsMapKind(kind):
+    return "mojo::internal::Map_Data<%s, %s>*" % (
+      GetCppType(kind.key_kind), GetCppType(kind.value_kind))
   if mojom.IsStructKind(kind):
     return "%s_Data*" % GetNameForKind(kind, internal=True)
-  if mojom.IsAnyArrayKind(kind):
-    return "mojo::internal::Array_Data<%s>*" % GetCppType(kind.kind)
   if mojom.IsInterfaceKind(kind) or mojom.IsInterfaceRequestKind(kind):
     return "mojo::MessagePipeHandle"
   if mojom.IsEnumKind(kind):
     return "int32_t"
   if mojom.IsStringKind(kind):
     return "mojo::internal::String_Data*"
   return _kind_to_cpp_type[kind]
 
 def GetCppPodType(kind):
   if mojom.IsStringKind(kind):
     return "char*"
   return _kind_to_cpp_type[kind]
 
 def GetCppArrayArgWrapperType(kind):
   if mojom.IsEnumKind(kind):
     return GetNameForKind(kind)
   if mojom.IsStructKind(kind):
     return "%sPtr" % GetNameForKind(kind)
   if mojom.IsAnyArrayKind(kind):
     return "mojo::Array<%s> " % GetCppArrayArgWrapperType(kind.kind)
+  if mojom.IsMapKind(kind):
+    return "mojo::Map<%s, %s> " % (GetCppArrayArgWrapperType(kind.key_kind),
+                                   GetCppArrayArgWrapperType(kind.value_kind))
   if mojom.IsInterfaceKind(kind):
     raise Exception("Arrays of interfaces not yet supported!")
   if mojom.IsInterfaceRequestKind(kind):
     raise Exception("Arrays of interface requests not yet supported!")
   if mojom.IsStringKind(kind):
     return "mojo::String"
   if mojom.IsHandleKind(kind):
     return "mojo::ScopedHandle"
   if mojom.IsDataPipeConsumerKind(kind):
     return "mojo::ScopedDataPipeConsumerHandle"
   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 GetCppResultWrapperType(kind):
   if mojom.IsEnumKind(kind):
     return GetNameForKind(kind)
   if mojom.IsStructKind(kind):
     return "%sPtr" % GetNameForKind(kind)
   if mojom.IsAnyArrayKind(kind):
     return "mojo::Array<%s>" % GetCppArrayArgWrapperType(kind.kind)
+  if mojom.IsMapKind(kind):
+    return "mojo::Map<%s, %s>" % (GetCppArrayArgWrapperType(kind.key_kind),
+                                  GetCppArrayArgWrapperType(kind.value_kind))
   if mojom.IsInterfaceKind(kind):
     return "%sPtr" % GetNameForKind(kind)
   if mojom.IsInterfaceRequestKind(kind):
     return "mojo::InterfaceRequest<%s>" % GetNameForKind(kind.kind)
   if mojom.IsStringKind(kind):
     return "mojo::String"
   if mojom.IsHandleKind(kind):
     return "mojo::ScopedHandle"
   if mojom.IsDataPipeConsumerKind(kind):
     return "mojo::ScopedDataPipeConsumerHandle"
   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 GetCppWrapperType(kind):
   if mojom.IsEnumKind(kind):
     return GetNameForKind(kind)
   if mojom.IsStructKind(kind):
     return "%sPtr" % GetNameForKind(kind)
   if mojom.IsAnyArrayKind(kind):
     return "mojo::Array<%s>" % GetCppArrayArgWrapperType(kind.kind)
+  if mojom.IsMapKind(kind):
+    return "mojo::Map<%s, %s>" % (GetCppArrayArgWrapperType(kind.key_kind),
+                                  GetCppArrayArgWrapperType(kind.value_kind))
   if mojom.IsInterfaceKind(kind):
     return "%sPtr" % GetNameForKind(kind)
   if mojom.IsInterfaceRequestKind(kind):
     raise Exception("InterfaceRequest fields not supported!")
   if mojom.IsStringKind(kind):
     return "mojo::String"
   if mojom.IsHandleKind(kind):
     return "mojo::ScopedHandle"
   if mojom.IsDataPipeConsumerKind(kind):
     return "mojo::ScopedDataPipeConsumerHandle"
   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 GetCppConstWrapperType(kind):
   if mojom.IsStructKind(kind):
     return "%sPtr" % GetNameForKind(kind)
   if mojom.IsAnyArrayKind(kind):
     return "mojo::Array<%s>" % GetCppArrayArgWrapperType(kind.kind)
+  if mojom.IsMapKind(kind):
+    return "mojo::Map<%s, %s>" % (GetCppArrayArgWrapperType(kind.key_kind),
+                                  GetCppArrayArgWrapperType(kind.value_kind))
   if mojom.IsInterfaceKind(kind):
     return "%sPtr" % GetNameForKind(kind)
   if mojom.IsInterfaceRequestKind(kind):
     return "mojo::InterfaceRequest<%s>" % GetNameForKind(kind.kind)
   if mojom.IsEnumKind(kind):
     return GetNameForKind(kind)
   if mojom.IsStringKind(kind):
     return "const mojo::String&"
   if mojom.IsHandleKind(kind):
     return "mojo::ScopedHandle"
   if mojom.IsDataPipeConsumerKind(kind):
     return "mojo::ScopedDataPipeConsumerHandle"
   if mojom.IsDataPipeProducerKind(kind):
     return "mojo::ScopedDataPipeProducerHandle"
   if mojom.IsMessagePipeKind(kind):
     return "mojo::ScopedMessagePipeHandle"
   if mojom.IsSharedBufferKind(kind):
     return "mojo::ScopedSharedBufferHandle"
   if not kind in _kind_to_cpp_type:
     print "missing:", kind.spec
   return _kind_to_cpp_type[kind]
 
 def GetCppFieldType(kind):
   if mojom.IsStructKind(kind):
     return ("mojo::internal::StructPointer<%s_Data>" %
         GetNameForKind(kind, internal=True))
   if mojom.IsAnyArrayKind(kind):
     return "mojo::internal::ArrayPointer<%s>" % GetCppType(kind.kind)
+  if mojom.IsMapKind(kind):
+    return ("mojo::internal::StructPointer<mojo::internal::Map_Data<%s, %s>>" %
+            (GetCppType(kind.key_kind), GetCppType(kind.value_kind)))
   if mojom.IsInterfaceKind(kind) or mojom.IsInterfaceRequestKind(kind):
     return "mojo::MessagePipeHandle"
   if mojom.IsEnumKind(kind):
     return GetNameForKind(kind)
   if mojom.IsStringKind(kind):
     return "mojo::internal::StringPointer"
   return _kind_to_cpp_type[kind]
 
 def IsStructWithHandles(struct):
   for pf in struct.packed.packed_fields:
@@ skipping 38 matching lines @@
 def ShouldInlineStruct(struct):
   # TODO(darin): Base this on the size of the wrapper class.
   if len(struct.fields) > 4:
     return False
   for field in struct.fields:
     if mojom.IsMoveOnlyKind(field.kind):
       return False
   return True
 
 def GetArrayValidateParams(kind):
-  if not mojom.IsAnyArrayKind(kind) and not mojom.IsStringKind(kind):
+  if (not mojom.IsAnyArrayKind(kind) and not mojom.IsMapKind(kind) and
+      not mojom.IsStringKind(kind)):
     return "mojo::internal::NoValidateParams"
 
   if mojom.IsStringKind(kind):
     expected_num_elements = 0
     element_is_nullable = False
     element_validate_params = "mojo::internal::NoValidateParams"
+  elif mojom.IsMapKind(kind):
+    expected_num_elements = 0
+    element_is_nullable = mojom.IsNullableKind(kind.value_kind)
+    element_validate_params = GetArrayValidateParams(kind.value_kind)
   else:
     expected_num_elements = generator.ExpectedArraySize(kind)
     element_is_nullable = mojom.IsNullableKind(kind.kind)
     element_validate_params = GetArrayValidateParams(kind.kind)
 
   return "mojo::internal::ArrayValidateParams<%d, %s,\n%s> " % (
       expected_num_elements,
       'true' if element_is_nullable else 'false',
       element_validate_params)
 
+def GetMapValidateParams(kind):

[yzshen1, 2014/10/08 21:58:33]

Maybe use value_kind to be more clear?

+  # Unlike GetArrayValidateParams, we are given the wrapped kind, instead of
+  # the raw array kind. So we wrap the return value of GetArrayValidateParams.
+  element_is_nullable = mojom.IsNullableKind(kind)
+  return "mojo::internal::ArrayValidateParams<0, %s,\n%s> " % (
+      'true' if element_is_nullable else 'false',
+      GetArrayValidateParams(kind))
+
 _HEADER_SIZE = 8
 
 class Generator(generator.Generator):
 
   cpp_filters = {
     "constant_value": ConstantValue,
     "cpp_const_wrapper_type": GetCppConstWrapperType,
     "cpp_field_type": GetCppFieldType,
     "cpp_pod_type": GetCppPodType,
     "cpp_result_type": GetCppResultWrapperType,
     "cpp_type": GetCppType,
     "cpp_wrapper_type": GetCppWrapperType,
     "default_value": DefaultValue,
     "expected_array_size": generator.ExpectedArraySize,
     "expression_to_text": ExpressionToText,
     "get_array_validate_params": GetArrayValidateParams,
+    "get_map_validate_params": GetMapValidateParams,
     "get_name_for_kind": GetNameForKind,
     "get_pad": pack.GetPad,
     "has_callbacks": mojom.HasCallbacks,
     "should_inline": ShouldInlineStruct,
     "is_any_array_kind": mojom.IsAnyArrayKind,
     "is_cloneable_kind": mojom.IsCloneableKind,
     "is_enum_kind": mojom.IsEnumKind,
     "is_move_only_kind": mojom.IsMoveOnlyKind,
     "is_any_handle_kind": mojom.IsAnyHandleKind,
     "is_interface_kind": mojom.IsInterfaceKind,
     "is_interface_request_kind": mojom.IsInterfaceRequestKind,
+    "is_map_kind": mojom.IsMapKind,
     "is_nullable_kind": mojom.IsNullableKind,
     "is_object_kind": mojom.IsObjectKind,
     "is_string_kind": mojom.IsStringKind,
     "is_struct_kind": mojom.IsStructKind,
     "is_struct_with_handles": IsStructWithHandles,
     "struct_size": lambda ps: ps.GetTotalSize() + _HEADER_SIZE,
     "struct_from_method": generator.GetStructFromMethod,
     "response_struct_from_method": generator.GetResponseStructFromMethod,
     "stylize_method": generator.StudlyCapsToCamel,
     "to_all_caps": generator.CamelCaseToAllCaps,
@@ skipping 21 matching lines @@
 
   @UseJinja("cpp_templates/module.cc.tmpl", filters=cpp_filters)
   def GenerateModuleSource(self):
     return self.GetJinjaExports()
 
   def GenerateFiles(self, args):
     self.Write(self.GenerateModuleHeader(), "%s.h" % self.module.name)
     self.Write(self.GenerateModuleInternalHeader(),
         "%s-internal.h" % self.module.name)
     self.Write(self.GenerateModuleSource(), "%s.cc" % self.module.name)