Collect IDL files and exract interface node object's information

Source/bindings/scripts/collect_idls_into_json.py

+#!/usr/bin/env python
+# Copyright 2015 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.
+
+"""Usage: collect_idls_into_json.py path_file.txt json_file.json
+"""
+
+import os
+import sys
+import json
+
+chromium_path = os.path.abspath(

[Yuki, 2015/09/10 10:23:04]

We should no longer need this hack.

[natsukoa, 2015/09/17 04:35:07]

Done.

+    os.path.join(os.environ['HOME'], 'chromium', 'src'))
+blink_bindings_path = os.path.join(
+    chromium_path, 'third_party', 'WebKit', 'Source', 'bindings', 'scripts')
+sys.path.insert(0, blink_bindings_path)
+
+from blink_idl_parser import parse_file, BlinkIDLParser
+import utilities
+
+
+_class_name = 'Interface'
+_partial = 'Partial'
+
+
+def load_filepaths(path_file):

[Yuki, 2015/09/10 10:23:04]

We should no longer need this function.

[natsukoa, 2015/09/17 04:35:07]

Done.

+    with open(path_file, 'r') as f:
+        for line in f:
+            path = line.strip()
+            yield path
+
+
+def get_interfaces(path):

[Yuki, 2015/09/10 10:23:05]

path?

Also inconsistent with the comment.

+    """Returns a generator which yields interface IDL nodes.
+    Args:
+      path_file: text file path
+    Returns:
+      a generator which yields interface node objects
+    """
+    parser = BlinkIDLParser(debug=False)
+    for idl_path in path:
+        definitions = parse_file(parser, idl_path)
+        for definition in definitions.GetChildren():
+            if definition.GetClass() == _class_name:
+                yield definition
+
+
+def get_filepath(interface_node):
+    """Returns relative path to the IDL file in which the |interface_node| is defined.
+    Args:
+      interface_node: IDL interface node
+    Returns:
+      str which is |interface_node| file path
+    """
+    filename = interface_node.GetProperty('FILENAME')
+    return os.path.relpath(filename)
+
+
+def filter_partial(interface_node_list):
+    """Returns a generator which yields partial interface node.
+    Args:
+      interface_node_list: a generator which is interface IDL node
+    Return:
+      a generator which yields partial interface node
+    """
+    for interface_node in interface_node_list:
+        if interface_node.GetProperty(_partial):
+            yield interface_node
+
+
+def filter_non_partial(interface_node_list):
+    """Returns a generator which yields interface node.
+    Args:
+      interface_node_list: a generator which is interface IDL node
+    Returns:
+      a generator which yields interface node
+    """
+    for interface_node in interface_node_list:
+        if not interface_node.GetProperty(_partial):
+            yield interface_node
+
+
+def get_attributes(interface_node):
+    """Returns list of Attribute if the interface_node have one.
+    Args:
+      interface_node: interface node object
+    Returns:
+      a list of attribute
+    """
+    return interface_node.GetListOf('Attribute')
+
+
+def get_attribute_type(attribute):
+    """Returns type of attribute or operation's argument.
+    Args:
+      node: attribute node object
+    Returns:
+      str which is Attribute object type
+    """
+    return attribute.GetOneOf('Type').GetChildren()[0].GetName()
+
+get_operation_type = get_attribute_type
+get_argument_type = get_attribute_type
+
+
+def get_extattributes(node):
+    """Returns a generator which yields Extattribute's object dictionary
+    Args:
+      node: interface, attribute or operation node which has extattribute
+    Returns:
+      a generator which yields extattribute dictionary
+    """
+    def get_extattr_nodes():
+        extattributes = node.GetOneOf('ExtAttributes')
+        if extattributes:
+            for extattribute in extattributes.GetChildren():
+                yield extattribute
+    for extattr_node in get_extattr_nodes():
+        yield {
+            'Name': extattr_node.GetName(),
+        }
+
+
+def attributes_dict(interface_node):
+    """Returns a generator which yields dictioary of Extattribute object information.
+    Args:
+      interface_node: interface node object
+    Returns:
+      a generator which yields dictionary of attribite information
+    """
+    for attribute in get_attributes(interface_node):
+        yield {
+            'Name': attribute.GetName(),
+            'Type': get_attribute_type(attribute),
+            'ExtAttributes': [extattr for extattr in get_extattributes(attribute)],
+        }
+
+
+def get_operations(interface_node):
+    """Returns list of Operations object under the interface_node.
+    Args:
+      interface_node: interface node object
+    Returns:
+      list which is list of oparation object
+    """
+    return interface_node.GetListOf('Operation')
+
+
+def get_arguments(operation):
+    """Returns list of Arguments object under the operation object.
+    Args:
+      operation: interface node object
+    Returns:
+      list which is list of argument object
+    """
+    argument_node = operation.GetOneOf('Arguments')
+    return argument_node.GetListOf('Argument')
+
+
+def argument_dict(argument):
+    """Returns generator which yields dictionary of Argument object information.
+    Args:
+      argument: interface node object
+    Returns:
+      a generator which yields dictionary of argument information
+    """
+    for arg_name in get_arguments(argument):
+        yield {
+            'Name': arg_name.GetName(),
+            'Type': get_argument_type(arg_name),
+        }
+
+
+def get_operation_name(operation):
+    """Returns openration object name.
+    Args:
+      operation: operation object in interface node object
+    Returns:
+      str which is operation's name
+    """
+    if operation.GetProperty('GETTER', default=None):
+        return '__getter__'
+    elif operation.GetProperty('SETTER', default=None):
+        return '__setter__'
+    elif operation.GetProperty('DELETER', default=None):
+        return '__deleter__'
+    else:
+        return operation.GetName()
+
+
+def operation_dict(interface_node):
+    """Returns a generator which yields dictionary of Operation object information.
+    Args:
+    interface_node: interface node object
+    Returns:
+      a generator which yields dictionary of operation's informantion
+    """
+    for operation in get_operations(interface_node):
+        yield {
+            'Name': get_operation_name(operation),
+            'Argument': [args for args in argument_dict(operation)],
+            'Type': get_operation_type(operation),
+            'ExtAttributes': [extattr for extattr in get_extattributes(operation)],
+        }
+
+
+def get_consts(interface_node):
+    """Returns list of Constant object.
+    Args:
+      interface_node: interface node object
+    Returns:
+      list which is list of constant object
+    """
+    return interface_node.GetListOf('Const')
+
+
+def get_const_type(node):
+    """Returns constant's type.
+    Args:
+      node: interface node's attribute or operation object
+    Returns:
+      node.GetChildren()[0].GetName(): str, constant object's name
+    """
+    return node.GetChildren()[0].GetName()
+
+
+def get_const_value(node):
+    """Returns constant's value.
+    Args:
+      node: interface node's attribute or operation object
+    Returns:
+      node.GetChildren()[1].GetName(): list, list of oparation object
+    """
+    return node.GetChildren()[1].GetName()
+
+
+def const_dict(interface_node):
+    """Returns generator which yields dictionary of constant object information.
+    Args:
+      interface_node: interface node object
+    Returns:
+      a generator which yields dictionary of constant object information
+    """
+    for const in get_consts(interface_node):
+        yield {
+            'Name': const.GetName(),
+            'Type': get_const_type(const),
+            'Value': get_const_value(const),
+            'ExtAttributes': [extattr for extattr in get_extattributes(const)],
+        }
+
+
+def format_interface_to_dict(interface_node):
+    """Returns dictioanry of each interface_node information.
+    Args:
+      interface_node: interface node object
+    Returns:
+      dictionary which has interface node information
+    """
+    return {
+        'Name': interface_node.GetName(),
+        'FilePath': get_filepath(interface_node),
+        'Attributes': [attr for attr in attributes_dict(interface_node)],
+        'Operations': [operation for operation in operation_dict(interface_node)],
+        'ExtAttributes': [extattr for extattr in get_extattributes(interface_node)],
+        'Consts': [const for const in const_dict(interface_node)],
+    }
+
+
+def merge_partial_interface(interface_dict_list, partial_dict_list):
+    """Returns list of interface_node information dictioary.
+    Args:
+      interface_dict_list: list of interface node dictionary
+      partial_dict_list: list of partial interface node dictionary
+    Returns:
+      list which is list of interface node's dictionry merged with partial interface node
+    """
+    for partial in partial_dict_list:
+        for interface in interface_dict_list:
+            if interface['Name'] == partial['Name']:
+                interface['Attributes'].append(partial['Attributes'])
+                interface['Operations'].append(partial['Operations'])
+                # TODO(natsukoa): filter extattribute of Web IDL or Blink
+                # interface['ExtAttributes'].append(partial['ExtAttributes'])
+                interface['Consts'].append(partial['Consts'])
+                interface.setdefault('Partial_FilePath', []).append(partial['FilePath'])
+    return interface_dict_list
+
+
+def format_list_to_dict(dictionary_list):
+    """Returns dictioary whose key is interface name and value is interface dictioary.
+    Args:
+      dictirary_list: list, list of interface node dictionary
+    Returns:
+      dictionary, {interface_node name: interface node dictionary}
+    """
+    dictionary = {}
+    for interface_dict in dictionary_list:
+        dictionary[interface_dict['Name']] = interface_dict
+    return dictionary
+
+
+# TODO(natsukoa): Supports a command line flag to indent the json
+def export_to_jsonfile(dictionary, json_file):
+    """Returns jsonfile which is dumped each interface_node information dictionary to json.
+    Args:
+      dictioary: dict, output of format_dictinatry
+      json_file: json file for output
+    Returns:
+      json file which is contained each interface node dictionary
+    """
+    # TODO(natsukoa): Remove indent_size
+    indent_size = 4
+    with open(json_file, 'w') as f:
+        json.dump(dictionary, f, sort_keys=True, indent=indent_size)
+
+
+def main(args):
+    path_file = args[0]
+    json_file = args[1]
+    file_to_list = utilities.read_file_to_list(path_file)
+    interface_dict_list = [format_interface_to_dict(interface_node) for interface_node in filter_non_partial(get_interfaces(file_to_list))]
+    partial_dict_list = [format_interface_to_dict(interface_node) for interface_node in filter_partial(get_interfaces(file_to_list))]
+    dictionary_list = merge_partial_interface(interface_dict_list, partial_dict_list)
+    dictionary = format_list_to_dict(dictionary_list)
+    export_to_jsonfile(dictionary, json_file)
+
+
+if __name__ == '__main__':
+    main(sys.argv[1:])