[WebAgentsAPI]: Start adding support for method arguments.

third_party/WebKit/Source/bindings/scripts/code_generator_web_agent_api.py

 # Copyright 2016 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.
 
 # pylint: disable=import-error,print-statement,relative-import
 
 """Generates Web Agent API bindings.
 
 The Web Agent API bindings provide a stable, IDL-generated interface for the
 Web Agents.
@@ skipping 65 matching lines @@
 
     def type_from_definition(self, idl_definition):
         # TODO(dglazkov): The output of this method must be a reasonable C++
         # type that can be used directly in the jinja2 template.
         return idl_definition.idl_type.base_type
 
     def base_class_includes(self):
         return set(['platform/heap/Handle.h'])
 
 
+class MethodOverloadSplitter(object):
+    """Because of union and optional types being used as arguments, some
+       operations may result in more than one generated method. This class
+       contains the logic for spliting an operation into multiple C++ overloads.
+    """
+
+    def __init__(self, idl_operation):
+        self.idl_operation = idl_operation
+
+    def _update_argument_lists(self, argument_lists, idl_types):
+        """Given a list of IdlTypes and an existing list of argument lists (yes,
+           this is a list of lists), produces a next generation of the list of
+           lists. This is the where the actual splitting into overloads happens.

[haraken, 2017/03/18 16:30:17]

the place where

[dglazkov, 2017/03/20 03:25:33]

Fixed. Thanks! :)

+        """
+        result = []
+        for argument_list in argument_lists:
+            for idl_type in idl_types:
+                new_argument_list = list(argument_list)
+                if idl_type is not None:
+                    new_argument_list.append(idl_type)
+                result.append(new_argument_list)
+        return result
+
+    def _enumerate_argument_types(self, idl_argument):
+        """Given an IdlArgument, returns a list of types that are included
+           in this argument. If optional, the list will include a 'None'."""
+        argument_type = idl_argument.idl_type
+        # TODO(dglazkov): What should we do with primitive nullable args?
+        if (argument_type.is_nullable and
+                argument_type.inner_type.is_primitive_type):
+            raise ValueError('Primitive nullable types are not supported.')
+
+        idl_types = []
+        if idl_argument.is_optional:
+            idl_types.append(None)  # None is used to convey optionality.
+        if argument_type.is_union_type:
+            idl_types = idl_types + argument_type.member_types
+        else:
+            idl_types.append(argument_type)
+        return idl_types
+
+    def split_into_overloads(self):

[haraken, 2017/03/18 16:30:17]

It would be helpful to describe a concrete example of the list of the list in a
comment.

[dglazkov, 2017/03/20 03:25:33]

Sure thing! I added an explanation with an example and a unit test to show how
that example works.

+        argument_lists = [[]]
+        for idl_argument in self.idl_operation.arguments:
+            idl_types = self._enumerate_argument_types(idl_argument)
+            argument_lists = self._update_argument_lists(argument_lists,
+                                                         idl_types)
+        return argument_lists
+
+
 class InterfaceContextBuilder(object):
     def __init__(self, code_generator, type_resolver):
         self.result = {'code_generator': code_generator}
         self.type_resolver = type_resolver
 
     def set_class_name(self, class_name):
         converter = NameStyleConverter(class_name)
         self.result['class_name'] = converter.to_all_cases()
         self._ensure_set('cpp_includes').update(
             self.type_resolver.includes_from_interface(class_name))
@@ skipping 15 matching lines @@
 
     def add_attribute(self, idl_attribute):
         self._ensure_list('attributes').append(
             self.create_attribute(idl_attribute))
         self._ensure_set('cpp_includes').update(
             self.type_resolver.includes_from_definition(idl_attribute))
 
     def add_operation(self, idl_operation):
         if not idl_operation.name:
             return
-        self._ensure_list('methods').append(
-            self.create_method(idl_operation))
-        self._ensure_set('cpp_includes').update(
-            self.type_resolver.includes_from_definition(idl_operation))
+        overload_splitter = MethodOverloadSplitter(idl_operation)
+        overloads = overload_splitter.split_into_overloads()
+        argument_names = [argument.name for argument
+                          in idl_operation.arguments]
+        for argument_types in overloads:
+            arguments = []
+            for position, argument_type in enumerate(argument_types):
+                arguments.append(
+                    self.create_argument(argument_names[position],
+                                         argument_type))
+            self._ensure_list('methods').append(
+                self.create_method(idl_operation, arguments))
+            self._ensure_set('cpp_includes').update(
+                self.type_resolver.includes_from_definition(idl_operation))
 
-    def create_method(self, idl_operation):
-        name = idl_operation.name
+    def create_argument(self, argument_name, argument_type):
+        name_converter = NameStyleConverter(argument_name)
+        return {
+            'name': name_converter.to_snake_case(),
+            'type': argument_type.base_type,
+        }
+
+    def create_method(self, idl_operation, arguments):
+        name_converter = NameStyleConverter(idl_operation.name)
         return_type = self.type_resolver.type_from_definition(idl_operation)
         return {
-            'name': name,
-            'return_type': return_type
+            'name': name_converter.to_upper_camel_case(),
+            'type': return_type,
+            'arguments': arguments
         }
 
     def create_attribute(self, idl_attribute):
         name = idl_attribute.name
         return_type = self.type_resolver.type_from_definition(idl_attribute)
         return {
             'name': name,
-            'return_type': return_type
+            'type': return_type
         }
 
     def build(self):
         return self.result
 
 
 class CodeGeneratorWebAgentAPI(CodeGeneratorBase):
     def __init__(self, info_provider, cache_dir, output_dir):
         CodeGeneratorBase.__init__(self, MODULE_PYNAME, info_provider,
                                    cache_dir, output_dir)
@@ skipping 31 matching lines @@
 
         # TODO(dglazkov): Implement dictionaries
         if definition_name not in definitions.interfaces:
             return None
 
         interface = definitions.interfaces[definition_name]
         if WEB_AGENT_API_IDL_ATTRIBUTE not in interface.extended_attributes:
             return None
 
         return self.generate_interface_code(interface)