[mojo] Add pickling support for native-only structs

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 24 matching lines @@
 }
 
 _kind_to_cpp_literal_suffix = {
   mojom.UINT8:        "U",
   mojom.UINT16:       "U",
   mojom.UINT32:       "U",
   mojom.FLOAT:        "f",
   mojom.UINT64:       "ULL",
 }
 
+# TODO(rockot): Get rid of this global. This requires some refactoring of the
+# generator library code so that filters can use the generator as context.
+_current_typemap = {}
+
+
 def ConstantValue(constant):
   return ExpressionToText(constant.value, kind=constant.kind)
 
 def DefaultValue(field):
   if field.default:
     if mojom.IsStructKind(field.kind):
       assert field.default == "default"
       return "%s::New()" % GetNameForKind(field.kind)
     return ExpressionToText(field.default, kind=field.kind)
   return ""
 
 def NamespaceToArray(namespace):
   return namespace.split(".") if namespace else []
 
 def GetNameForKind(kind, internal = False):
   parts = []
   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 GetFullMojomNameForKind(kind):
+  parts = []
+  if kind.imported_from:
+    parts.extend(NamespaceToArray(kind.imported_from["namespace"]))
+  elif hasattr(kind, "module"):
+    parts.extend(NamespaceToArray(kind.module.namespace))
+  parts.append(kind.name)
+  return ".".join(parts)
+
+def IsTypemappedKind(kind):
+  return hasattr(kind, "name") and \
+      GetFullMojomNameForKind(kind) in _current_typemap
+
+def IsNativeOnlyKind(kind):
+  return IsTypemappedKind(kind) and kind.native_only
+
+def GetNativeTypeName(typemapped_kind):
+  return _current_typemap[GetFullMojomNameForKind(typemapped_kind)]["typename"]
+
 def GetQualifiedNameForKind(kind):
   # Always start with an empty part to force a leading "::" on output.
   parts = [""]
   parts.extend(NamespaceToArray(kind.module.namespace))
   parts.append(kind.name)
   return "::".join(parts)
 
 def GetCppType(kind):
+  if mojom.IsStructKind(kind) and kind.native_only:
+    raise Exception("Should not be reached!")
   if mojom.IsArrayKind(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.IsUnionKind(kind):
     return "%s_Data" % GetNameForKind(kind, internal=True)
   if mojom.IsInterfaceKind(kind):
     return "mojo::internal::Interface_Data"
   if mojom.IsInterfaceRequestKind(kind):
     return "mojo::MessagePipeHandle"
   if mojom.IsAssociatedInterfaceKind(kind):
     return "mojo::internal::AssociatedInterface_Data"
   if mojom.IsAssociatedInterfaceRequestKind(kind):
     return "mojo::internal::AssociatedInterfaceRequest_Data"
   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.IsStructKind(kind) and kind.native_only:
+    raise Exception("Cannot serialize containers of native-only types yet!")
   if mojom.IsEnumKind(kind):
     return GetNameForKind(kind)
   if mojom.IsStructKind(kind) or mojom.IsUnionKind(kind):
     return "%sPtr" % GetNameForKind(kind)
   if mojom.IsArrayKind(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):
@@ skipping 13 matching lines @@
     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 IsTypemappedKind(kind):
+    return "const %s&" % GetNativeTypeName(kind)
   if mojom.IsEnumKind(kind):
     return GetNameForKind(kind)
   if mojom.IsStructKind(kind) or mojom.IsUnionKind(kind):
     return "%sPtr" % GetNameForKind(kind)
   if mojom.IsArrayKind(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):
@@ skipping 18 matching lines @@
     return "mojo::ScopedSharedBufferHandle"
   # TODO(rudominer) After improvements to compiler front end have landed,
   # revisit strategy used below for emitting a useful error message when an
   # undefined identifier is referenced.
   val =  _kind_to_cpp_type.get(kind)
   if (val is not None):
     return val
   raise Exception("Unrecognized kind %s" % kind.spec)
 
 def GetCppWrapperType(kind):
+  if IsTypemappedKind(kind):
+    return GetNativeTypeName(kind)
   if mojom.IsEnumKind(kind):
     return GetNameForKind(kind)
   if mojom.IsStructKind(kind) or mojom.IsUnionKind(kind):
     return "%sPtr" % GetNameForKind(kind)
   if mojom.IsArrayKind(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):
@@ skipping 12 matching lines @@
     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 IsTypemappedKind(kind):
+    return "const %s&" % GetNativeTypeName(kind)
   if mojom.IsStructKind(kind) or mojom.IsUnionKind(kind):
     return "%sPtr" % GetNameForKind(kind)
   if mojom.IsArrayKind(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):
@@ skipping 14 matching lines @@
     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 IsNativeOnlyKind(kind):
+    return "mojo::internal::ArrayPointer<uint8_t>"
   if mojom.IsStructKind(kind):
     return ("mojo::internal::StructPointer<%s_Data>" %
         GetNameForKind(kind, internal=True))
   if mojom.IsUnionKind(kind):
     return "%s_Data" % GetNameForKind(kind, internal=True)
   if mojom.IsArrayKind(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)))
@@ skipping 86 matching lines @@
     return False
   for field in struct.fields:
     if mojom.IsMoveOnlyKind(field.kind):
       return False
   return True
 
 def ShouldInlineUnion(union):
   return not any(mojom.IsMoveOnlyKind(field.kind) for field in union.fields)
 
 def GetArrayValidateParamsCtorArgs(kind):
-  if mojom.IsStringKind(kind):
+  if mojom.IsStringKind(kind) or (mojom.IsStructKind(kind) and
+                                  kind.native_only):
     expected_num_elements = 0
     element_is_nullable = False
     element_validate_params = "nullptr"
   elif mojom.IsMapKind(kind):
     expected_num_elements = 0
     element_is_nullable = mojom.IsNullableKind(kind.value_kind)
     element_validate_params = GetNewArrayValidateParams(kind.value_kind)
   else:
     expected_num_elements = generator.ExpectedArraySize(kind) or 0
     element_is_nullable = mojom.IsNullableKind(kind.kind)
@@ skipping 38 matching lines @@
     "get_pad": pack.GetPad,
     "get_qualified_name_for_kind": GetQualifiedNameForKind,
     "has_callbacks": mojom.HasCallbacks,
     "should_inline": ShouldInlineStruct,
     "should_inline_union": ShouldInlineUnion,
     "is_array_kind": mojom.IsArrayKind,
     "is_cloneable_kind": mojom.IsCloneableKind,
     "is_enum_kind": mojom.IsEnumKind,
     "is_integral_kind": mojom.IsIntegralKind,
     "is_move_only_kind": mojom.IsMoveOnlyKind,
+    "is_native_only_kind": IsNativeOnlyKind,
     "is_any_handle_kind": mojom.IsAnyHandleKind,
     "is_interface_kind": mojom.IsInterfaceKind,
     "is_interface_request_kind": mojom.IsInterfaceRequestKind,
     "is_associated_interface_kind": mojom.IsAssociatedInterfaceKind,
     "is_associated_interface_request_kind":
         mojom.IsAssociatedInterfaceRequestKind,
     "is_associated_kind": mojom.IsAssociatedKind,
     "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_typemapped_kind": IsTypemappedKind,
     "is_union_kind": mojom.IsUnionKind,
     "passes_associated_kinds": mojom.PassesAssociatedKinds,
     "struct_size": lambda ps: ps.GetTotalSize() + _HEADER_SIZE,
     "stylize_method": generator.StudlyCapsToCamel,
     "to_all_caps": generator.CamelCaseToAllCaps,
     "under_to_camel": generator.UnderToCamel,
   }
 
+  def GetExtraHeaders(self):
+    extra_headers = set()
+    for name, entry in self.typemap.iteritems():
+      extra_headers.update(entry["headers"])
+    return list(extra_headers)
+
   def GetJinjaExports(self):
     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(),
       "unions": self.GetUnions(),
       "interfaces": self.GetInterfaces(),
       "variant": self.variant,
+      "extra_headers": self.GetExtraHeaders(),
     }
 
   @UseJinja("cpp_templates/module.h.tmpl", filters=cpp_filters)
   def GenerateModuleHeader(self):
     return self.GetJinjaExports()
 
   @UseJinja("cpp_templates/module-internal.h.tmpl", filters=cpp_filters)
   def GenerateModuleInternalHeader(self):
     return self.GetJinjaExports()
 
   @UseJinja("cpp_templates/module.cc.tmpl", filters=cpp_filters)
   def GenerateModuleSource(self):
     return self.GetJinjaExports()
 
   def GenerateFiles(self, args):
+    global _current_typemap
+    _current_typemap = self.typemap
     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)))