| #!/usr/bin/python |
| # |
| # Copyright 2014 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. |
| |
| """Compute global objects. |
| |
| Global objects are defined by interfaces with [Global] or [PrimaryGlobal] on |
| their definition: http://heycam.github.io/webidl/#Global |
| |
| Design document: http://www.chromium.org/developers/design-documents/idl-build |
| """ |
| |
| # pylint: disable=relative-import |
| |
| import optparse |
| import os |
| import sys |
| |
| from utilities import get_file_contents |
| from utilities import get_interface_extended_attributes_from_idl |
| from utilities import idl_filename_to_interface_name |
| from utilities import read_file_to_list |
| from utilities import read_pickle_files |
| from utilities import write_pickle_file |
| |
| GLOBAL_EXTENDED_ATTRIBUTES = frozenset([ |
| 'Global', |
| 'PrimaryGlobal', |
| ]) |
| |
| |
| def parse_options(): |
| usage = 'Usage: %prog [options] [GlobalObjects.pickle]' |
| parser = optparse.OptionParser(usage=usage) |
| parser.add_option('--idl-files-list', help='file listing IDL files') |
| parser.add_option('--global-objects-component-files', action='append', |
| help='optionally preceeded input pickle filename.') |
| |
| options, args = parser.parse_args() |
| |
| if options.idl_files_list is None: |
| parser.error('Must specify a file listing IDL files using --idl-files-list.') |
| if options.global_objects_component_files is None: |
| options.global_objects_component_files = [] |
| if len(args) != 1: |
| parser.error('Must specify an output pickle filename as an argument') |
| |
| return options, args |
| |
| |
| def dict_union(dicts): |
| return dict((k, v) for d in dicts for k, v in d.iteritems()) |
| |
| |
| def idl_file_to_global_names(idl_filename): |
| """Returns global names, if any, for an IDL file. |
| |
| If the [Global] or [PrimaryGlobal] extended attribute is declared with an |
| identifier list argument, then those identifiers are the interface's global |
| names; otherwise, the interface has a single global name, which is the |
| interface's identifier (http://heycam.github.io/webidl/#Global). |
| """ |
| interface_name = idl_filename_to_interface_name(idl_filename) |
| full_path = os.path.realpath(idl_filename) |
| idl_file_contents = get_file_contents(full_path) |
| extended_attributes = get_interface_extended_attributes_from_idl(idl_file_contents) |
| |
| global_keys = GLOBAL_EXTENDED_ATTRIBUTES.intersection( |
| extended_attributes.iterkeys()) |
| if not global_keys: |
| return |
| if len(global_keys) > 1: |
| raise ValueError('The [Global] and [PrimaryGlobal] extended attributes ' |
| 'MUST NOT be declared on the same interface.') |
| global_key = next(iter(global_keys)) |
| |
| global_value = extended_attributes[global_key] |
| if global_value: |
| return global_value.strip('()').split(',') |
| return [interface_name] |
| |
| |
| def idl_files_to_interface_name_global_names(idl_files): |
| """Yields pairs (interface_name, global_names) found in IDL files.""" |
| for idl_filename in idl_files: |
| interface_name = idl_filename_to_interface_name(idl_filename) |
| global_names = idl_file_to_global_names(idl_filename) |
| if global_names: |
| yield interface_name, global_names |
| |
| |
| ################################################################################ |
| |
| def main(): |
| options, args = parse_options() |
| output_global_objects_filename = args.pop() |
| interface_name_global_names = dict_union( |
| existing_interface_name_global_names |
| for existing_interface_name_global_names |
| in read_pickle_files(options.global_objects_component_files)) |
| |
| # Input IDL files are passed in a file, due to OS command line length |
| # limits. This is generated at GYP time, which is ok b/c files are static. |
| idl_files = read_file_to_list(options.idl_files_list) |
| interface_name_global_names.update( |
| idl_files_to_interface_name_global_names(idl_files)) |
| |
| write_pickle_file(output_global_objects_filename, |
| interface_name_global_names) |
| |
| |
| if __name__ == '__main__': |
| sys.exit(main()) |