Add JS bindings validation logic for non-nullable types

mojo/public/tools/bindings/generators/mojom_js_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 JavaScript 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 61 matching lines @@
   mojom.INT16:                 "codec.Int16",
   mojom.UINT16:                "codec.Uint16",
   mojom.INT32:                 "codec.Int32",
   mojom.UINT32:                "codec.Uint32",
   mojom.FLOAT:                 "codec.Float",
   mojom.HANDLE:                "codec.Handle",
   mojom.DCPIPE:                "codec.Handle",
   mojom.DPPIPE:                "codec.Handle",
   mojom.MSGPIPE:               "codec.Handle",
   mojom.SHAREDBUFFER:          "codec.Handle",
-  mojom.NULLABLE_HANDLE:       "codec.Handle",
-  mojom.NULLABLE_DCPIPE:       "codec.Handle",
-  mojom.NULLABLE_DPPIPE:       "codec.Handle",
-  mojom.NULLABLE_MSGPIPE:      "codec.Handle",
-  mojom.NULLABLE_SHAREDBUFFER: "codec.Handle",
+  mojom.NULLABLE_HANDLE:       "codec.NullableHandle",
+  mojom.NULLABLE_DCPIPE:       "codec.NullableHandle",
+  mojom.NULLABLE_DPPIPE:       "codec.NullableHandle",
+  mojom.NULLABLE_MSGPIPE:      "codec.NullableHandle",
+  mojom.NULLABLE_SHAREDBUFFER: "codec.NullableHandle",
   mojom.INT64:                 "codec.Int64",
   mojom.UINT64:                "codec.Uint64",
   mojom.DOUBLE:                "codec.Double",
   mojom.STRING:                "codec.String",
-  mojom.NULLABLE_STRING:       "codec.String",
+  mojom.NULLABLE_STRING:       "codec.NullableString",
 }
 
 
 def CodecType(kind):
   if kind in mojom.PRIMITIVES:
     return _kind_to_codec_type[kind]
   if mojom.IsStructKind(kind):
-    return "new codec.PointerTo(%s)" % CodecType(kind.name)
+    ptrType = "NullablePointerTo" if mojom.IsNullableKind(kind) else "PointerTo"

[yzshen1, 2014/08/20 17:04:20]

please use naming style ptr_type. (here and below)

[hansmuller, 2014/08/20 17:46:31]

Done.

+    return "new codec.%s(%s)" % (ptrType, CodecType(kind.name))
   if mojom.IsAnyArrayKind(kind) and mojom.IsBoolKind(kind.kind):

[yzshen1, 2014/08/20 17:04:21]

nit: maybe we could merge this if-block into the next one:
if IsAnyArrayKind():
  array_type = ...
  return "..." % ... IsBoolKind() ...
  

[hansmuller, 2014/08/20 17:46:31]

Done.

-    return "new codec.ArrayOf(codec.PackedBool)"
+    arrayType = "NullableArrayOf" if mojom.IsNullableKind(kind) else "ArrayOf"
+    return "new codec.%s(codec.PackedBool)" % arrayType
   if mojom.IsAnyArrayKind(kind):
-    return "new codec.ArrayOf(%s)" % CodecType(kind.kind)
+    arrayType = "NullableArrayOf" if mojom.IsNullableKind(kind) else "ArrayOf"
+    return "new codec.%s(%s)" % (arrayType, CodecType(kind.kind))
   if mojom.IsInterfaceKind(kind) or mojom.IsInterfaceRequestKind(kind):
     return CodecType(mojom.MSGPIPE)
   if mojom.IsEnumKind(kind):
     return _kind_to_codec_type[mojom.INT32]
   return kind
 
 
 def JavaScriptDecodeSnippet(kind):
   if kind in mojom.PRIMITIVES:
     return "decodeStruct(%s)" % CodecType(kind)
@@ skipping 20 matching lines @@
     return "encodeArrayPointer(%s, " % CodecType(kind.kind)
   if mojom.IsInterfaceKind(kind) or mojom.IsInterfaceRequestKind(kind):
     return JavaScriptEncodeSnippet(mojom.MSGPIPE)
   if mojom.IsEnumKind(kind):
     return JavaScriptEncodeSnippet(mojom.INT32)
 
 
 def JavaScriptFieldOffset(packed_field):
   return "offset + codec.kStructHeaderSize + %s" % packed_field.offset
 
+
+def JavaScriptNullableParam(pf):

[yzshen1, 2014/08/20 17:04:20]

packed_field may be a better name than pf. (like line 144)

[hansmuller, 2014/08/20 17:46:31]

Done.

+  return "true" if mojom.IsNullableKind(pf.field.kind) else "false"
+
+
 def JavaScriptValidateArrayParams(pf):
-  elementKind = pf.field.kind.kind
-  elementSize = pack.PackedField.GetSizeForKind(elementKind)
-  elementCount = generator.ExpectedArraySize(pf.field.kind)
-  elementType = "codec.PackedBool" if mojom.IsBoolKind(elementKind) \
-      else CodecType(elementKind)
-  return "%s, %s, %s, %s" % \
-    (JavaScriptFieldOffset(pf), elementSize, elementCount, elementType)
+  nullable = JavaScriptNullableParam(pf)
+  eltKind = pf.field.kind.kind

[yzshen1, 2014/08/20 17:04:20]

element_kind is actually better than elt_kind according to style guide.

[hansmuller, 2014/08/20 17:46:31]

Done.

+  eltSize = pack.PackedField.GetSizeForKind(eltKind)
+  eltCount = generator.ExpectedArraySize(pf.field.kind)
+  eltType = "codec.PackedBool" if mojom.IsBoolKind(eltKind) \
+      else CodecType(eltKind)
+  return "%s, %s, %s, %s, %s" % \
+    (JavaScriptFieldOffset(pf), eltSize, eltCount, eltType, nullable)

[yzshen1, 2014/08/20 17:04:20]

wrong indent.

[hansmuller, 2014/08/20 17:46:31]

Done.

+
 
 def JavaScriptValidateStructParams(pf):
-  return "%s, %s" % (JavaScriptFieldOffset(pf), pf.field.kind.name)
+  nullable = JavaScriptNullableParam(pf)
+  structType = pf.field.kind.name
+  return "%s, %s, %s" % (JavaScriptFieldOffset(pf), structType, nullable)
+
+
+def JavaScriptValidateStringParams(pf):
+  nullable = JavaScriptNullableParam(pf)
+  return "%s, %s" % (JavaScriptFieldOffset(pf), nullable)
+
+
+def JavaScriptValidateHandleParams(pf):
+  nullable = JavaScriptNullableParam(pf)
+  return "%s, %s" % (JavaScriptFieldOffset(pf), nullable)
 
 
 def TranslateConstants(token):
   if isinstance(token, (mojom.EnumValue, mojom.NamedValue)):
     # Both variable and enum constants are constructed like:
     # NamespaceUid.Struct[.Enum].CONSTANT_NAME
     name = []
     if token.imported_from:
       name.append(token.imported_from["unique_name"])
     if token.parent_kind:
@@ skipping 37 matching lines @@
     "expression_to_text": ExpressionToText,
     "field_offset": JavaScriptFieldOffset,
     "has_callbacks": mojom.HasCallbacks,
     "is_array_pointer_field": IsArrayPointerField,
     "is_struct_pointer_field": IsStructPointerField,
     "is_string_pointer_field": IsStringPointerField,
     "is_handle_field": IsHandleField,
     "js_type": JavascriptType,
     "stylize_method": generator.StudlyCapsToCamel,
     "validate_array_params": JavaScriptValidateArrayParams,
+    "validate_handle_params": JavaScriptValidateHandleParams,
+    "validate_string_params": JavaScriptValidateStringParams,
     "validate_struct_params": JavaScriptValidateStructParams,
   }
 
   @UseJinja("js_templates/module.js.tmpl", filters=js_filters)
   def GenerateJsModule(self):
     return {
       "namespace": self.module.namespace,
       "imports": self.GetImports(),
       "kinds": self.module.kinds,
       "enums": self.module.enums,
       "module": self.module,
       "structs": self.GetStructs() + self.GetStructsFromMethods(),
       "interfaces": self.module.interfaces,
     }
 
   def GenerateFiles(self, args):
     self.Write(self.GenerateJsModule(), "%s.js" % self.module.name)
 
   def GetImports(self):
     # Since each import is assigned a variable in JS, they need to have unique
     # names.
     counter = 1
     for each in self.module.imports:
       each["unique_name"] = "import" + str(counter)
       counter += 1
     return self.module.imports