Collect idls and organize interface node

third_party/WebKit/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
+
+This script collects and organizes interface information and that information dumps into json file.
+"""
+
+import json
+import os
+import sys
+import utilities
+
+from blink_idl_parser import parse_file, BlinkIDLParser
+
+_INTERFACE_CLASS_NAME = 'Interface'
+_PARTIAL = 'Partial'
+_STRIP_FILEPATH = '../chromium/src/third_party/WebKit'
+_MEMBERS = ['Attributes', 'Operations', 'Consts']
+
+
+def get_definitions(paths):
+    """Returns IDL node.
+    Args:
+      paths: list of IDL file path
+    Returns:
+      a generator which yields IDL node objects
+    """
+    parser = BlinkIDLParser()
+    for path in paths:
+        definitions = parse_file(parser, path)
+        for definition in definitions.GetChildren():
+            yield definition
+
+
+def is_implements(definition):
+    """Returns implement node.

[Yuki, 2015/10/05 10:03:21]

Let's update the comments accordingly.

+    Args:
+      definition: IDL node
+    Returns:
+      implement node
+    """
+    if definition.GetClass() == 'Implements':

[Yuki, 2015/10/05 10:03:21]

The code is equivalent to

    x = definition.GetClass() == 'Implements'
    if x == True:
        return True
    else:  # x == False
        return False

Thus,

    x = definition.GetClass() == 'Implements'  # True or False
    return x

And then,

    return definition.GetClass() == 'Implements'

[natsukoa, 2015/10/06 07:10:22]

Done.

+        return True
+    else:
+        return False
+
+
+def filter_non_partial(definition):

[Yuki, 2015/10/05 10:03:21]

filter_non_partial => is_non_partial

[natsukoa, 2015/10/06 07:10:22]

Done.

+    """Returns boolean.

[Yuki, 2015/10/05 10:03:21]

"Returns boolean" doesn't make much sense.

One of common descriptions of predicates is:
"Returns True if ..., otherwise False."

[natsukoa, 2015/10/06 07:10:21]

Done.

+    Args:
+      definition: IDL node
+    Returns:
+      True: its 'Interface' class node and not 'partial' node

[Yuki, 2015/10/05 10:03:21]

For example,
    Returns:
      True if |definition| is an interface node and not partial interface.

Probably, "its" is a typo of "it's"?
If so, it's unclear what "it" means.  Better to explicitly say |definition|.

[natsukoa, 2015/10/06 07:10:22]

Done.

+      False: its not 'interface' class node and not 'partial' node
+    """
+    if definition.GetClass() == _INTERFACE_CLASS_NAME and not definition.GetProperty(_PARTIAL):
+        return True
+    else:
+        return False
+
+
+def filter_partial(definition):
+    """Returns boolean.
+    Args:
+      definition: IDL node
+    Return:
+      True: it's 'interface' class node and 'partial' node
+      False: it's not 'interface' class node and 'partial' node
+    """
+    if definition.GetClass() == _INTERFACE_CLASS_NAME and definition.GetProperty(_PARTIAL):
+        return True
+    else:
+        return False
+
+
+def get_filepath(interface_node):
+    """Returns relative path under the WebKit directory which |interface_node| is defined.

[Yuki, 2015/10/05 10:03:21]

For example,
    Returns the relative path to the IDL file in which |interface_node| is
defined.
    The IDL files are supposed to be placed in the WebKit directory.

[natsukoa, 2015/10/06 07:10:22]

Done.

+    Args:
+      interface_node: IDL interface
+    Returns:
+      str which is |interface_node| file path

[Yuki, 2015/10/05 10:03:21]

|interface_node|'s file path

[natsukoa, 2015/10/06 07:10:22]

Done.

+    """
+    filename = interface_node.GetProperty('FILENAME')
+    return os.path.relpath(filename).strip(_STRIP_FILEPATH)
+
+
+def get_const_node_list(interface_node):
+    """Returns Constant object.

[Yuki, 2015/10/05 10:03:21]

object?

Better to use the same terminology.

Your comments are mixture of
- Constant vs constant vs Const vs const
- node vs object vs node object

It would be confusing for readers.  Please choose one style and always use it.

[natsukoa, 2015/10/06 07:10:22]

Done.

+    Args:
+      interface_node: interface node object
+    Returns:
+      list which is list of constant object
+    """
+    return interface_node.GetListOf('Const')
+
+
+def get_const_type(const_node):
+    """Returns constant's type.
+    Args:
+      const_node: constant node object
+    Returns:
+      node.GetChildren()[0].GetName(): str, constant object's name

[Yuki, 2015/10/05 10:03:21]

The comment seems strange.

[natsukoa, 2015/10/06 07:10:22]

Done.

+    """
+    return const_node.GetChildren()[0].GetName()
+
+
+def get_const_value(const_node):
+    """Returns constant's value.
+    Args:
+      const_node: constant node object
+    Returns:
+      node.GetChildren()[1].GetName(): list, list of oparation object
+    """
+    return const_node.GetChildren()[1].GetName()
+
+
+def const_node_to_dict(const_node):
+    """Returns dictionary of constant object information.
+    Args:
+      const_nodes: list of interface node object which has constant

[Yuki, 2015/10/05 10:03:21]

nodes => node

[Yuki, 2015/10/05 10:03:21]

nodes => node

Update the description, too.

[natsukoa, 2015/10/06 07:10:22]

Done.

+    Returns:
+      a generator which yields dictionary of constant object information
+    """
+    return {
+        'Name': const_node.GetName(),
+        'Type': get_const_type(const_node),
+        'Value': get_const_value(const_node),
+        'ExtAttributes': [extattr_node_to_dict(extattr) for extattr in get_extattribute_node_list(const_node)],
+    }
+
+
+def get_attribute_node_list(interface_node):
+    """Returns list of Attribute if the interface have one.
+    Args:
+      interface_node: interface node object
+    Returns:
+      a list of attribute
+    """
+    return interface_node.GetListOf('Attribute')
+
+
+def get_attribute_type(attribute_node):
+    """Returns type of attribute.
+    Args:
+      attribute_node: attribute node object
+    Returns:
+      str which is type of Attribute
+    """
+    return attribute_node.GetOneOf('Type').GetChildren()[0].GetName()
+
+
+get_operation_type = get_attribute_type
+get_argument_type = get_attribute_type
+
+
+def attribute_node_to_dict(attribute_node):
+    """Returns dictioary of attribute object information.
+    Args:
+      attribute_nodes: list of attribute node object

[Yuki, 2015/10/05 10:03:21]

attribute_nodes = > attribute_node

[natsukoa, 2015/10/06 07:10:22]

Done.

+    Returns:
+      a generator which yields dictionary of attribite information
+    """
+    return {
+        'Name': attribute_node.GetName(),
+        'Type': get_attribute_type(attribute_node),
+        'ExtAttributes': [extattr_node_to_dict(extattr) for extattr in get_extattribute_node_list(attribute_node)],
+        'Readonly': attribute_node.GetProperty('READONLY', default=False),
+        'Static': attribute_node.GetProperty('STATIC', default=False),
+    }
+
+
+def get_operation_node_list(interface_node):
+    """Returns Operations object under the interface.
+    Args:
+      interface: interface node object
+    Returns:
+      list which is list of oparation object
+    """
+    return interface_node.GetListOf('Operation')
+
+
+def get_argument_node_list(operation_node):
+    """Returns Argument object under the operation object.
+    Args:
+      operation_node: operation node object
+    Returns:
+      list of argument object
+    """
+    return operation_node.GetOneOf('Arguments').GetListOf('Argument')
+
+
+def argument_node_to_dict(argument_node):
+    """Returns generator which yields dictionary of Argument object information.
+    Args:
+      arguments: list of argument node object
+    Returns:
+      a generator which yields dictionary of argument information
+    """
+    return {
+        'Name': argument_node.GetName(),
+        'Type': get_argument_type(argument_node),
+    }
+
+
+def get_operation_name(operation_node):
+    """Returns openration object name.
+    Args:
+      operation_node: operation node object
+    Returns:
+      str which is operation's name
+    """
+    if operation_node.GetProperty('GETTER'):
+        return '__getter__'
+    elif operation_node.GetProperty('SETTER'):
+        return '__setter__'
+    elif operation_node.GetProperty('DELETER'):
+        return '__deleter__'
+    else:
+        return operation_node.GetName()
+
+
+def operation_node_to_dict(operation_node):
+    """Returns  dictionary of Operation object information.
+    Args:
+      operation_nodes: list of operation node object
+    Returns:
+      dictionary of operation's informantion
+    """
+    return {
+        'Name': get_operation_name(operation_node),
+        'Arguments': [argument_node_to_dict(argument) for argument in get_argument_node_list(operation_node) if argument_node_to_dict(argument)],
+        'Type': get_operation_type(operation_node),
+        'ExtAttributes': [extattr_node_to_dict(extattr) for extattr in get_extattribute_node_list(operation_node)],
+        'Static': operation_node.GetProperty('STATIC', default=False),
+    }
+
+
+def get_extattribute_node_list(node):
+    """Returns list of ExtAttribute.
+    Args:
+      IDL node object
+    Returns:
+      a list of ExtAttrbute
+    """
+    if node.GetOneOf('ExtAttributes'):
+        return node.GetOneOf('ExtAttributes').GetListOf('ExtAttribute')
+    else:
+        return []
+
+
+def extattr_node_to_dict(extattr):
+    """Returns a generator which yields Extattribute's object dictionary
+    Args:
+      extattribute_nodes: list of extended attribute
+    Returns:
+      a generator which yields extattribute dictionary
+    """
+    return {
+        'Name': extattr.GetName(),
+    }
+
+
+def get_inherit_node(interface_node):
+    if interface_node.GetListOf('Inherit'):
+        return interface_node.GetListOf('Inherit')
+    else:
+        return []
+
+
+def inherit_node_to_dict(inherit):
+    return {'Parent': inherit.GetName()}
+
+
+def interface_node_to_dict(interface_node):
+    """Returns dictioary whose key is interface name and value is interface dictioary.
+    Args:
+      interface_node: interface node
+    Returns:
+      dictionary, {interface name: interface node dictionary}
+    """
+    return {
+        'Name': interface_node.GetName(),
+        'FilePath': get_filepath(interface_node),
+        'Consts': [const_node_to_dict(const) for const in get_const_node_list(interface_node)],
+        'Attributes': [attribute_node_to_dict(attr) for attr in get_attribute_node_list(interface_node) if attribute_node_to_dict(attr)],
+        'Operations': [operation_node_to_dict(operation) for operation in get_operation_node_list(interface_node) if operation_node_to_dict(operation)],
+        'ExtAttributes': [extattr_node_to_dict(extattr) for extattr in get_extattribute_node_list(interface_node)],
+        'Inherit': [inherit_node_to_dict(inherit) for inherit in get_inherit_node(interface_node)],
+    }
+
+
+def merge_partial_dicts(interfaces_dict, partials_dict):
+    """Returns interface information dictioary.
+    Args:
+      interfaces_dict: interface node dictionary
+      partial_dict: partial interface node dictionary
+    Returns:
+      a dictronary merged with interfaces_dict and  partial_dict
+    """
+    for interface_name, partial in partials_dict.iteritems():
+        interface = interfaces_dict.get(interface_name)
+        if not interface:
+            continue
+        else:
+            for member in _MEMBERS:
+                interface[member].extend(partial.get(member))
+            interface.setdefault('Partial_FilePaths', []).append(partial['FilePath'])
+    return interfaces_dict
+
+
+def merge_implement_node(interfaces_dict, implement_nodes):
+    """Returns dict of interface information combined with referenced interface information
+    Args:
+      interfaces_dict: dict of interface information
+      implement_nodes: list of implemented interface node
+    Returns:
+      interfaces_dict: dict of interface information combine into implements node
+    """
+    for implement in implement_nodes:
+        reference = implement.GetProperty('REFERENCE')
+        implement = implement.GetName()
+        if not reference:
+            continue
+        else:
+            for member in _MEMBERS:
+                interfaces_dict[implement][member].extend(interfaces_dict[reference].get(member))
+    return interfaces_dict
+
+
+# TODO(natsukoa): Remove indent
+def export_to_jsonfile(dictionary, json_file):
+    """Returns jsonfile which is dumped each interface information dictionary to json.
+    Args:
+      dictioary: interface dictionary
+      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, indent=4)
+
+
+def main(args):
+    path_file = args[0]
+    json_file = args[1]
+    path_list = utilities.read_file_to_list(path_file)
+    implement_nodes = [definition
+                       for definition in get_definitions(path_list)
+                       if is_implements(definition)]
+    interfaces_dict = {definition.GetName(): interface_node_to_dict(definition)
+                       for definition in get_definitions(path_list)
+                       if filter_non_partial(definition)}
+    partials_dict = {definition.GetName(): interface_node_to_dict(definition)
+                     for definition in get_definitions(path_list)
+                     if filter_partial(definition)}
+    dictionary = merge_partial_dicts(interfaces_dict, partials_dict)
+    interfaces_dict = merge_implement_node(interfaces_dict, implement_nodes)
+    export_to_jsonfile(dictionary, json_file)
+
+
+if __name__ == '__main__':
+    main(sys.argv[1:])