1#!/usr/bin/python
2# Copyright (C) 2013 Google Inc. All rights reserved.
3#
4# Redistribution and use in source and binary forms, with or without
5# modification, are permitted provided that the following conditions are
6# met:
7#
8#     * Redistributions of source code must retain the above copyright
9# notice, this list of conditions and the following disclaimer.
10#     * Redistributions in binary form must reproduce the above
11# copyright notice, this list of conditions and the following disclaimer
12# in the documentation and/or other materials provided with the
13# distribution.
14#     * Neither the name of Google Inc. nor the names of its
15# contributors may be used to endorse or promote products derived from
16# this software without specific prior written permission.
17#
18# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30"""Compile an .idl file to Blink V8 bindings (.h and .cpp files).
31
32Design doc: http://www.chromium.org/developers/design-documents/idl-compiler
33"""
34
35import abc
36from optparse import OptionParser
37import os
38import cPickle as pickle
39import sys
40
41from code_generator_v8 import CodeGeneratorDictionaryImpl, CodeGeneratorV8
42from idl_reader import IdlReader
43from utilities import read_idl_files_list_from_file, write_file, idl_filename_to_component
44
45
46def parse_options():
47    parser = OptionParser()
48    parser.add_option('--cache-directory',
49                      help='cache directory, defaults to output directory')
50    parser.add_option('--generate-dictionary-impl',
51                      action="store_true", default=False)
52    parser.add_option('--output-directory')
53    parser.add_option('--interfaces-info-file')
54    parser.add_option('--write-file-only-if-changed', type='int')
55    # ensure output comes last, so command line easy to parse via regexes
56    parser.disable_interspersed_args()
57
58    options, args = parser.parse_args()
59    if options.output_directory is None:
60        parser.error('Must specify output directory using --output-directory.')
61    options.write_file_only_if_changed = bool(options.write_file_only_if_changed)
62    if len(args) != 1:
63        parser.error('Must specify exactly 1 input file as argument, but %d given.' % len(args))
64    idl_filename = os.path.realpath(args[0])
65    return options, idl_filename
66
67
68def idl_filename_to_interface_name(idl_filename):
69    basename = os.path.basename(idl_filename)
70    interface_name, _ = os.path.splitext(basename)
71    return interface_name
72
73
74class IdlCompiler(object):
75    """Abstract Base Class for IDL compilers.
76
77    In concrete classes:
78    * self.code_generator must be set, implementing generate_code()
79      (returning a list of output code), and
80    * compile_file() must be implemented (handling output filenames).
81    """
82    __metaclass__ = abc.ABCMeta
83
84    def __init__(self, output_directory, cache_directory='',
85                 code_generator=None, interfaces_info=None,
86                 interfaces_info_filename='', only_if_changed=False):
87        """
88        Args:
89            interfaces_info:
90                interfaces_info dict
91                (avoids auxiliary file in run-bindings-tests)
92            interfaces_info_file: filename of pickled interfaces_info
93        """
94        cache_directory = cache_directory or output_directory
95        self.cache_directory = cache_directory
96        self.code_generator = code_generator
97        if interfaces_info_filename:
98            with open(interfaces_info_filename) as interfaces_info_file:
99                interfaces_info = pickle.load(interfaces_info_file)
100        self.interfaces_info = interfaces_info
101        self.only_if_changed = only_if_changed
102        self.output_directory = output_directory
103        self.reader = IdlReader(interfaces_info, cache_directory)
104
105    def compile_and_write(self, idl_filename):
106        interface_name = idl_filename_to_interface_name(idl_filename)
107        component = idl_filename_to_component(idl_filename)
108        definitions = self.reader.read_idl_definitions(idl_filename)
109        output_code_list = self.code_generator.generate_code(
110            definitions[component], interface_name)
111        for output_path, output_code in output_code_list:
112            write_file(output_code, output_path, self.only_if_changed)
113
114    @abc.abstractmethod
115    def compile_file(self, idl_filename):
116        pass
117
118
119class IdlCompilerV8(IdlCompiler):
120    def __init__(self, *args, **kwargs):
121        IdlCompiler.__init__(self, *args, **kwargs)
122        self.code_generator = CodeGeneratorV8(self.interfaces_info,
123                                              self.cache_directory,
124                                              self.output_directory)
125
126    def compile_file(self, idl_filename):
127        self.compile_and_write(idl_filename)
128
129
130class IdlCompilerDictionaryImpl(IdlCompiler):
131    def __init__(self, *args, **kwargs):
132        IdlCompiler.__init__(self, *args, **kwargs)
133        self.code_generator = CodeGeneratorDictionaryImpl(
134            self.interfaces_info, self.cache_directory, self.output_directory)
135
136    def compile_file(self, idl_filename):
137        self.compile_and_write(idl_filename)
138
139
140def generate_bindings(options, input_filename):
141    idl_compiler = IdlCompilerV8(
142        options.output_directory,
143        cache_directory=options.cache_directory,
144        interfaces_info_filename=options.interfaces_info_file,
145        only_if_changed=options.write_file_only_if_changed)
146    idl_compiler.compile_file(input_filename)
147
148
149def generate_dictionary_impl(options, input_filename):
150    idl_compiler = IdlCompilerDictionaryImpl(
151        options.output_directory,
152        cache_directory=options.cache_directory,
153        interfaces_info_filename=options.interfaces_info_file,
154        only_if_changed=options.write_file_only_if_changed)
155
156    idl_filenames = read_idl_files_list_from_file(input_filename)
157    for idl_filename in idl_filenames:
158        idl_compiler.compile_file(idl_filename)
159
160
161def main():
162    options, input_filename = parse_options()
163    if options.generate_dictionary_impl:
164        # |input_filename| should be a file which contains a list of IDL
165        # dictionary paths.
166        generate_dictionary_impl(options, input_filename)
167    else:
168        # |input_filename| should be a path of an IDL file.
169        generate_bindings(options, input_filename)
170
171
172if __name__ == '__main__':
173    sys.exit(main())
174