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
+import utilities
+
+from blink_idl_parser import parse_file, BlinkIDLParser
+
+_class_name = 'Interface'
+_partial = 'Partial'
+
+
+def get_interfaces(path):
+    """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).strip('../chromium/src/third_party/WebKit')
+
+
+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 list of ExtAttribute.
+    Args:
+      node which has ExtAttribute
+    Returns:
+      a generator which yields list of ExtAttribute
+    """
+    extattributes = node.GetOneOf('ExtAttributes')
+    if extattributes:
+        for extattribute in extattributes.GetChildren():
+            yield extattribute
+
+
+def extattr_dict(extattribute):

[Yuki, 2015/09/17 05:45:06]

extattr_to_dict

[natsukoa, 2015/09/17 07:34:59]

Done.

+    """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
+    """
+    for extattr_node in extattribute:
+        yield {
+            'Name': extattr_node.GetName(),
+        }
+
+
+def attributes_dict(attribute_list):
+    """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 attribute_list:
+        yield {
+            'Name': attribute.GetName(),
+            'Type': get_attribute_type(attribute),
+            'ExtAttributes': [extattr for extattr in extattr_dict(get_extattributes(attribute))],

[Yuki, 2015/09/17 05:45:06]

list(extattr_dict(...))

[natsukoa, 2015/09/17 07:34:59]

Done.

+            'Readonly': attribute.GetProperty('READONLY', default=False),
+            'Static': attribute.GetProperty('STATIC', default=False),
+        }
+
+
+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 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'):
+        return '__getter__'
+    elif operation.GetProperty('SETTER'):
+        return '__setter__'
+    elif operation.GetProperty('DELETER'):
+        return '__deleter__'
+    else:
+        return operation.GetName()
+
+
+def operation_dict(operations):
+    """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 operations:
+        yield {
+            'Name': get_operation_name(operation),
+            'Arguments': [args for args in argument_dict(get_arguments(operation))],
+            'Type': get_operation_type(operation),
+            'ExtAttributes': [extattr for extattr in extattr_dict(get_extattributes(operation))],
+            'Static': operation.GetProperty('STATIC', default=False),
+        }
+
+
+def get_inherit(interface_node):

[Yuki, 2015/09/17 05:45:06]

Let's remove get_inherit and inherit_dict for the first version.

[natsukoa, 2015/09/17 07:34:59]

Done.

+    return interface_node.GetOneOf('Inherit')
+
+
+def inherit_dict(inherit):
+    if inherit is None:
+        return []
+    else:
+        return {'Name': inherit.GetName()}
+
+
+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(consts):
+    """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 consts:
+        yield {
+            'Name': const.GetName(),
+            'Type': get_const_type(const),
+            'Value': get_const_value(const),
+            'ExtAttributes': [extattr for extattr in extattr_dict(get_extattributes(const))],
+        }
+
+
+def get_name(interface_node):

[Yuki, 2015/09/17 05:45:06]

get_name(my_interface)

is not shorter or simpler than

my_interface.GetName()

Do you really want this function?

[natsukoa, 2015/09/17 07:34:59]

Actually, I don't need it. I just removed it.

+    return interface_node.GetName()
+
+
+def get_dict(interface_node):

[Yuki, 2015/09/17 05:45:06]

interface_to_dict

[natsukoa, 2015/09/17 07:34:59]

Done.

+    """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}
+    """
+
+    return {
+        'Attributes': [attr for attr in attributes_dict(get_attributes(interface_node))],
+        'Operations': [operation for operation in operation_dict(get_operations(interface_node))],
+        'ExtAttributes': [extattr for extattr in extattr_dict(get_extattributes(interface_node))],
+        'Consts': [const for const in const_dict(get_consts(interface_node))],
+        'Inherit': inherit_dict(get_inherit(interface_node)),
+        'FilePath': get_filepath(interface_node),
+    }
+
+
+def merge_dict(interface_dict, partial_dict):
+    """Returns list of interface_node information dictioary.
+    Args:
+      interface_dict: interface node dictionary
+      partial_dict: partial interface node dictionary
+    Returns:
+      list which is list of interface node's dictionry merged with partial interface node
+    """
+    for key in partial_dict.keys():
+        if key in interface_dict:
+            interface_dict[key]['Attributes'].append(partial_dict[key]['Attributes'])
+            interface_dict[key]['Operations'].append(partial_dict[key]['Operations'])
+            interface_dict[key]['Consts'].append(partial_dict[key]['Consts'])
+            interface_dict[key].setdefault('Partial_FilePaths', []).append(partial_dict[key]['FilePath'])
+    return interface_dict
+
+
+# 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
+    """
+    with open(json_file, 'w') as f:
+        json.dump(dictionary, f, sort_keys=True)
+
+
+def main(args):
+    path_file = args[0]
+    json_file = args[1]
+    file_to_list = utilities.read_file_to_list(path_file)
+    interface_dict = {get_name(interface_node): get_dict(interface_node) for interface_node in filter_non_partial(get_interfaces(file_to_list))}
+    partial_dict = {get_name(interface_node): get_dict(interface_node) for interface_node in filter_partial(get_interfaces(file_to_list))}
+    dictionary = merge_dict(interface_dict, partial_dict)
+    export_to_jsonfile(dictionary, json_file)
+
+
+if __name__ == '__main__':
+    main(sys.argv[1:])