| OLD | NEW |
| (Empty) | |
| 1 #!/usr/bin/env python |
| 2 # Copyright (c) 2012 The Chromium Authors. All rights reserved. |
| 3 # Use of this source code is governed by a BSD-style license that can be |
| 4 # found in the LICENSE file. |
| 5 """Generator for C++ structs from api json files. |
| 6 |
| 7 The purpose of this tool is to remove the need for hand-written code that |
| 8 converts to and from base::Value types when receiving javascript api calls. |
| 9 Originally written for generating code for extension apis. Reference schemas |
| 10 are in chrome/common/extensions/api. |
| 11 |
| 12 Usage example: |
| 13 compiler.py --root /home/Work/src --namespace extensions windows.json |
| 14 tabs.json |
| 15 compiler.py --destdir gen --root /home/Work/src |
| 16 --namespace extensions windows.json tabs.json |
| 17 """ |
| 18 |
| 19 import cc_generator |
| 20 import cpp_type_generator |
| 21 import h_generator |
| 22 import idl_schema |
| 23 import json_schema |
| 24 import model |
| 25 import schema_bundle_generator |
| 26 |
| 27 import optparse |
| 28 import os.path |
| 29 import sys |
| 30 |
| 31 def load_schema(schema): |
| 32 schema_filename, schema_extension = os.path.splitext(schema) |
| 33 |
| 34 if schema_extension == '.json': |
| 35 api_defs = json_schema.Load(schema) |
| 36 elif schema_extension == '.idl': |
| 37 api_defs = idl_schema.Load(schema) |
| 38 else: |
| 39 sys.exit("Did not recognize file extension %s for schema %s" % |
| 40 (schema_extension, schema)) |
| 41 if len(api_defs) != 1: |
| 42 sys.exit("File %s has multiple schemas. Files are only allowed to contain a" |
| 43 " single schema." % schema) |
| 44 |
| 45 return api_defs |
| 46 |
| 47 def handle_single_schema(filename, dest_dir, root, root_namespace): |
| 48 schema = os.path.normpath(filename) |
| 49 schema_filename, schema_extension = os.path.splitext(schema) |
| 50 path, short_filename = os.path.split(schema_filename) |
| 51 api_defs = json_schema.DeleteNocompileNodes(load_schema(schema)) |
| 52 |
| 53 api_model = model.Model() |
| 54 |
| 55 for target_namespace in api_defs: |
| 56 referenced_schemas = target_namespace.get('dependencies', []) |
| 57 # Load type dependencies into the model. |
| 58 # TODO(miket): do we need this in IDL? |
| 59 for referenced_schema in referenced_schemas: |
| 60 split_schema = referenced_schema.split(':', 1) |
| 61 if len(split_schema) > 1: |
| 62 if split_schema[0] != 'api': |
| 63 continue |
| 64 else: |
| 65 referenced_schema = split_schema[1] |
| 66 |
| 67 referenced_schema_path = os.path.join( |
| 68 os.path.dirname(schema), referenced_schema + '.json') |
| 69 referenced_api_defs = json_schema.Load(referenced_schema_path) |
| 70 |
| 71 for namespace in referenced_api_defs: |
| 72 api_model.AddNamespace( |
| 73 namespace, |
| 74 os.path.relpath(referenced_schema_path, opts.root)) |
| 75 |
| 76 # Gets the relative path from opts.root to the schema to correctly determine |
| 77 # the include path. |
| 78 relpath = os.path.relpath(schema, opts.root) |
| 79 namespace = api_model.AddNamespace(target_namespace, |
| 80 relpath, |
| 81 include_compiler_options=True) |
| 82 if not namespace: |
| 83 continue |
| 84 |
| 85 if short_filename != namespace.unix_name: |
| 86 sys.exit("Filename %s is illegal. Name files using unix_hacker style." % |
| 87 filename) |
| 88 |
| 89 # The output filename must match the input filename for gyp to deal with it |
| 90 # properly. |
| 91 out_file = namespace.unix_name |
| 92 type_generator = cpp_type_generator.CppTypeGenerator( |
| 93 root_namespace, namespace, namespace.unix_name) |
| 94 for referenced_namespace in api_model.namespaces.values(): |
| 95 if referenced_namespace == namespace: |
| 96 continue |
| 97 type_generator.AddNamespace( |
| 98 referenced_namespace, |
| 99 referenced_namespace.unix_name) |
| 100 |
| 101 h_code = (h_generator.HGenerator(namespace, type_generator) |
| 102 .Generate().Render()) |
| 103 cc_code = (cc_generator.CCGenerator(namespace, type_generator) |
| 104 .Generate().Render()) |
| 105 |
| 106 if dest_dir: |
| 107 with open( |
| 108 os.path.join(dest_dir, namespace.source_file_dir, out_file + '.cc'), |
| 109 'w') as cc_file: |
| 110 cc_file.write(cc_code) |
| 111 with open( |
| 112 os.path.join(dest_dir, namespace.source_file_dir, out_file + '.h'), |
| 113 'w') as h_file: |
| 114 h_file.write(h_code) |
| 115 else: |
| 116 print '%s.h' % out_file |
| 117 print |
| 118 print h_code |
| 119 print |
| 120 print '%s.cc' % out_file |
| 121 print |
| 122 print cc_code |
| 123 |
| 124 def handle_bundle_schema(filenames, dest_dir, root, root_namespace): |
| 125 # Merge the source files into a single list of schemas. |
| 126 api_defs = [] |
| 127 for filename in filenames: |
| 128 schema = os.path.normpath(filename) |
| 129 schema_filename, schema_extension = os.path.splitext(schema) |
| 130 api_defs.extend(load_schema(schema)) |
| 131 |
| 132 api_model = model.Model() |
| 133 relpath = os.path.relpath(os.path.normpath(filenames[0]), root) |
| 134 |
| 135 for target_namespace, schema_filename in zip(api_defs, filenames): |
| 136 namespace = api_model.AddNamespace(target_namespace, |
| 137 relpath, |
| 138 include_compiler_options=True) |
| 139 path, filename = os.path.split(schema_filename) |
| 140 short_filename, extension = os.path.splitext(filename) |
| 141 |
| 142 # Filenames are checked against the unix_names of the namespaces they |
| 143 # generate because the gyp uses the names of the JSON files to generate |
| 144 # the names of the .cc and .h files. We want these to be using unix_names. |
| 145 if namespace.unix_name != short_filename: |
| 146 sys.exit("Filename %s is illegal. Name files using unix_hacker style." % |
| 147 schema_filename) |
| 148 |
| 149 type_generator = cpp_type_generator.CppTypeGenerator(root_namespace) |
| 150 for referenced_namespace in api_model.namespaces.values(): |
| 151 type_generator.AddNamespace( |
| 152 referenced_namespace, |
| 153 referenced_namespace.unix_name) |
| 154 |
| 155 generator = schema_bundle_generator.SchemaBundleGenerator( |
| 156 root, api_model, api_defs, type_generator) |
| 157 api_h_code = generator.GenerateAPIHeader().Render() |
| 158 schemas_h_code = generator.GenerateSchemasHeader().Render() |
| 159 schemas_cc_code = generator.GenerateSchemasCC().Render() |
| 160 |
| 161 if dest_dir: |
| 162 basedir = os.path.join(dest_dir, 'chrome/common/extensions/api') |
| 163 with open(os.path.join(basedir, 'generated_api.h'), 'w') as h_file: |
| 164 h_file.write(api_h_code) |
| 165 with open(os.path.join(basedir, 'generated_schemas.h'), 'w') as h_file: |
| 166 h_file.write(schemas_h_code) |
| 167 with open(os.path.join(basedir, 'generated_schemas.cc'), 'w') as cc_file: |
| 168 cc_file.write(schemas_cc_code) |
| 169 else: |
| 170 print 'generated_api.h' |
| 171 print |
| 172 print api_h_code |
| 173 print |
| 174 print 'generated_schemas.h' |
| 175 print |
| 176 print schemas_h_code |
| 177 print |
| 178 print 'generated_schemas.cc' |
| 179 print |
| 180 print schemas_cc_code |
| 181 |
| 182 if __name__ == '__main__': |
| 183 parser = optparse.OptionParser( |
| 184 description='Generates a C++ model of an API from JSON schema', |
| 185 usage='usage: %prog [option]... schema') |
| 186 parser.add_option('-r', '--root', default='.', |
| 187 help='logical include root directory. Path to schema files from specified' |
| 188 'dir will be the include path.') |
| 189 parser.add_option('-d', '--destdir', |
| 190 help='root directory to output generated files.') |
| 191 parser.add_option('-n', '--namespace', default='generated_api_schemas', |
| 192 help='C++ namespace for generated files. e.g extensions::api.') |
| 193 parser.add_option('-b', '--bundle', action="store_true", help= |
| 194 '''if supplied, causes compiler to generate bundle files for the given set of |
| 195 source files.''') |
| 196 |
| 197 (opts, args) = parser.parse_args() |
| 198 |
| 199 if not args: |
| 200 sys.exit(0) # This is OK as a no-op |
| 201 dest_dir = opts.destdir |
| 202 root_namespace = opts.namespace |
| 203 |
| 204 if opts.bundle: |
| 205 handle_bundle_schema(args, dest_dir, opts.root, root_namespace) |
| 206 else: |
| 207 handle_single_schema(args[0], dest_dir, opts.root, root_namespace) |
| OLD | NEW |