h_generator.py revision 58537e28ecd584eab876aee8be7156509866d23a
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)# found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)from code import Code 658537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)from model import PropertyType 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)import cpp_util 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)import schema_util 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class HGenerator(object): 112a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) def __init__(self, type_generator, cpp_namespace): 122a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) self._type_generator = type_generator 132a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) self._cpp_namespace = cpp_namespace 142a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 152a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) def Generate(self, namespace): 162a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) return _Generator(namespace, 172a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) self._type_generator, 182a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) self._cpp_namespace).Generate() 192a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 2058537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 212a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class _Generator(object): 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """A .h generator for a namespace. 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """ 242a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) def __init__(self, namespace, cpp_type_generator, cpp_namespace): 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) self._namespace = namespace 262a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) self._type_helper = cpp_type_generator 272a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) self._cpp_namespace = cpp_namespace 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) self._target_namespace = ( 292a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) self._type_helper.GetCppNamespaceName(self._namespace)) 30c2db58bd994c04d98e4ee2cd7565b71548655fe3Ben Murdoch self._generate_error_messages = namespace.compiler_options.get( 31c2db58bd994c04d98e4ee2cd7565b71548655fe3Ben Murdoch 'generate_error_messages', False) 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) def Generate(self): 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """Generates a Code object with the .h for a single namespace. 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """ 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c = Code() 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (c.Append(cpp_util.CHROMIUM_LICENSE) 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append() 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append(cpp_util.GENERATED_FILE_MESSAGE % self._namespace.source_file) 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append() 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ifndef_name = cpp_util.GenerateIfndefName(self._namespace.source_file_dir, 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) self._target_namespace) 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (c.Append('#ifndef %s' % ifndef_name) 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('#define %s' % ifndef_name) 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append() 482a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append('#include <map>') 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('#include <string>') 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('#include <vector>') 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append() 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('#include "base/basictypes.h"') 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('#include "base/logging.h"') 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('#include "base/memory/linked_ptr.h"') 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('#include "base/memory/scoped_ptr.h"') 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('#include "base/values.h"') 572a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Cblock(self._type_helper.GenerateIncludes()) 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append() 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 612a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Concat(cpp_util.OpenNamespace(self._cpp_namespace)) 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) # TODO(calamity): These forward declarations should be #includes to allow 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) # $ref types from other files to be used as required params. This requires 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) # some detangling of windows and tabs which will currently lead to circular 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) # #includes. 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) forward_declarations = ( 672a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) self._type_helper.GenerateForwardDeclarations()) 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if not forward_declarations.IsEmpty(): 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (c.Append() 702a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Cblock(forward_declarations) 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 732a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Concat(self._type_helper.GetNamespaceStart()) 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c.Append() 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if self._namespace.properties: 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (c.Append('//') 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('// Properties') 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('//') 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append() 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for property in self._namespace.properties.values(): 822a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) property_code = self._type_helper.GeneratePropertyValues( 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) property, 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 'extern const %(type)s %(name)s;') 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if property_code: 862a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Cblock(property_code) 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if self._namespace.types: 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (c.Append('//') 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('// Types') 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('//') 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append() 922a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Cblock(self._GenerateTypes(self._FieldDependencyOrder(), 932a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) is_toplevel=True, 942a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) generate_typedefs=True)) 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if self._namespace.functions: 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (c.Append('//') 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('// Functions') 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('//') 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append() 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for function in self._namespace.functions.values(): 1032a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Cblock(self._GenerateFunction(function)) 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if self._namespace.events: 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (c.Append('//') 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('// Events') 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('//') 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append() 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for event in self._namespace.events.values(): 1112a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Cblock(self._GenerateEvent(event)) 1122a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) (c.Concat(self._type_helper.GetNamespaceEnd()) 1132a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Concat(cpp_util.CloseNamespace(self._cpp_namespace)) 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('#endif // %s' % ifndef_name) 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append() 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return c 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) def _FieldDependencyOrder(self): 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """Generates the list of types in the current namespace in an order in which 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) depended-upon types appear before types which depend on them. 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """ 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) dependency_order = [] 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) def ExpandType(path, type_): 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if type_ in path: 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) raise ValueError("Illegal circular dependency via cycle " + 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ", ".join(map(lambda x: x.name, path + [type_]))) 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for prop in type_.properties.values(): 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (prop.type_ == PropertyType.REF and 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) schema_util.GetNamespace(prop.ref_type) == self._namespace.name): 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ExpandType(path + [type_], self._namespace.types[prop.ref_type]) 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if not type_ in dependency_order: 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) dependency_order.append(type_) 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for type_ in self._namespace.types.values(): 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ExpandType([], type_) 1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return dependency_order 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1402a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) def _GenerateEnumDeclaration(self, enum_name, type_): 1412a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) """Generate the declaration of a C++ enum. 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """ 1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c = Code() 1445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c.Sblock('enum %s {' % enum_name) 1452a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Append(self._type_helper.GetEnumNoneValue(type_) + ',') 1462a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) for value in type_.enum_values: 1472a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Append(self._type_helper.GetEnumValue(type_, value) + ',') 1482a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) return c.Eblock('};') 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) def _GenerateFields(self, props): 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """Generates the field declarations when declaring a type. 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """ 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c = Code() 1542a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) needs_blank_line = False 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for prop in props: 1562a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if needs_blank_line: 1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c.Append() 1582a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) needs_blank_line = True 1595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if prop.description: 1605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c.Comment(prop.description) 1612a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) # ANY is a base::Value which is abstract and cannot be a direct member, so 1622a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) # we always need to wrap it in a scoped_ptr. 1632a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) is_ptr = prop.optional or prop.type_.property_type == PropertyType.ANY 1645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (c.Append('%s %s;' % ( 1652a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) self._type_helper.GetCppType(prop.type_, is_ptr=is_ptr), 1665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) prop.unix_name)) 1675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 1685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return c 1695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1702a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) def _GenerateType(self, type_, is_toplevel=False, generate_typedefs=False): 1712a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) """Generates a struct for |type_|. 1722a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1732a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) |is_toplevel| implies that the type was declared in the "types" field 1742a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) of an API schema. This determines the correct function 1752a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) modifier(s). 1762a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) |generate_typedefs| controls whether primitive types should be generated as 1772a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) a typedef. This may not always be desired. If false, 1782a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) primitive types are ignored. 1795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """ 1802a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) classname = cpp_util.Classname(schema_util.StripNamespace(type_.name)) 1815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c = Code() 1825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if type_.functions: 1842a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) # Wrap functions within types in the type's namespace. 1852a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) (c.Append('namespace %s {' % classname) 1862a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append() 1872a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) ) 1885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for function in type_.functions.values(): 1892a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Cblock(self._GenerateFunction(function)) 1902a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Append('} // namespace %s' % classname) 1912a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) elif type_.property_type == PropertyType.ARRAY: 1922a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if generate_typedefs and type_.description: 1935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c.Comment(type_.description) 1942a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Cblock(self._GenerateType(type_.item_type)) 1952a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if generate_typedefs: 1962a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) (c.Append('typedef std::vector<%s > %s;' % ( 1972a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) self._type_helper.GetCppType(type_.item_type), 1982a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) classname)) 1992a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) ) 2002a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) elif type_.property_type == PropertyType.STRING: 2012a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if generate_typedefs: 2022a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if type_.description: 2032a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Comment(type_.description) 2042a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Append('typedef std::string %(classname)s;') 2052a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) elif type_.property_type == PropertyType.ENUM: 2065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if type_.description: 2075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c.Comment(type_.description) 2085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c.Sblock('enum %(classname)s {') 2092a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Append('%s,' % self._type_helper.GetEnumNoneValue(type_)) 2105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for value in type_.enum_values: 2112a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Append('%s,' % self._type_helper.GetEnumValue(type_, value)) 2122a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) # Top level enums are in a namespace scope so the methods shouldn't be 2132a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) # static. On the other hand, those declared inline (e.g. in an object) do. 2142a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) maybe_static = '' if is_toplevel else 'static ' 2155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (c.Eblock('};') 2165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append() 2172a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append('%sstd::string ToString(%s as_enum);' % 2182a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) (maybe_static, classname)) 2192a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append('%s%s Parse%s(const std::string& as_string);' % 2202a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) (maybe_static, classname, classname)) 2215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 2227dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch elif type_.property_type in (PropertyType.CHOICES, 2237dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch PropertyType.OBJECT): 2245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if type_.description: 2255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c.Comment(type_.description) 2265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (c.Sblock('struct %(classname)s {') 2275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('%(classname)s();') 2282a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append('~%(classname)s();') 2295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 2302a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if type_.origin.from_json: 2312a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) (c.Append() 2322a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Comment('Populates a %s object from a base::Value. Returns' 2335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ' whether |out| was successfully populated.' % classname) 234c2db58bd994c04d98e4ee2cd7565b71548655fe3Ben Murdoch .Append('static bool Populate(%s);' % self._GenerateParams( 235c2db58bd994c04d98e4ee2cd7565b71548655fe3Ben Murdoch ('const base::Value& value', '%s* out' % classname))) 2365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 237c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) if is_toplevel: 238c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) (c.Append() 239c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) .Comment('Creates a %s object from a base::Value, or NULL on ' 240c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 'failure.' % classname) 241c2db58bd994c04d98e4ee2cd7565b71548655fe3Ben Murdoch .Append('static scoped_ptr<%s> FromValue(%s);' % ( 242c2db58bd994c04d98e4ee2cd7565b71548655fe3Ben Murdoch classname, self._GenerateParams(('const base::Value& value',)))) 243c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) ) 2442a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if type_.origin.from_client: 2457dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch value_type = ('base::Value' 2467dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch if type_.property_type is PropertyType.CHOICES else 2477dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch 'base::DictionaryValue') 2482a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) (c.Append() 2497dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch .Comment('Returns a new %s representing the serialized form of this ' 2507dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch '%s object.' % (value_type, classname)) 2517dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch .Append('scoped_ptr<%s> ToValue() const;' % value_type) 2525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 2537dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch if type_.property_type == PropertyType.CHOICES: 2547dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch # Choices are modelled with optional fields for each choice. Exactly one 2557dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch # field of the choice is guaranteed to be set by the compiler. 2567dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch c.Cblock(self._GenerateTypes(type_.choices)) 2577dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch c.Append('// Choices:') 2587dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch for choice_type in type_.choices: 2597dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch c.Append('%s as_%s;' % ( 2607dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch self._type_helper.GetCppType(choice_type, is_ptr=True), 2617dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch choice_type.unix_name)) 2627dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch else: 2637dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch properties = type_.properties.values() 2647dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch (c.Append() 2657dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch .Cblock(self._GenerateTypes(p.type_ for p in properties)) 2667dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch .Cblock(self._GenerateFields(properties))) 2677dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch if type_.additional_properties is not None: 2687dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch # Most additionalProperties actually have type "any", which is better 2697dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch # modelled as a DictionaryValue rather than a map of string -> Value. 2707dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch if type_.additional_properties.property_type == PropertyType.ANY: 2717dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch c.Append('base::DictionaryValue additional_properties;') 2727dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch else: 2737dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch (c.Cblock(self._GenerateType(type_.additional_properties)) 2747dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch .Append('std::map<std::string, %s> additional_properties;' % 2757dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch cpp_util.PadForGenerics( 2767dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch self._type_helper.GetCppType(type_.additional_properties, 2777dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch is_in_container=True))) 2787dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch ) 2795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (c.Eblock() 2802a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append() 2815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Sblock(' private:') 2825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('DISALLOW_COPY_AND_ASSIGN(%(classname)s);') 2835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Eblock('};') 2845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 2857dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch return c.Substitute({'classname': classname}) 2865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) def _GenerateEvent(self, event): 2885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """Generates the namespaces for an event. 2895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """ 2905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c = Code() 2912a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) # TODO(kalman): use event.unix_name not Classname. 2922a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) event_namespace = cpp_util.Classname(event.name) 2932a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) (c.Append('namespace %s {' % event_namespace) 2942a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append() 2952385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch .Concat(self._GenerateEventNameConstant(event)) 2962a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Concat(self._GenerateCreateCallbackArguments(event)) 2972a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Eblock('} // namespace %s' % event_namespace) 2985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 2995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return c 3005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) def _GenerateFunction(self, function): 3025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """Generates the namespaces and structs for a function. 3035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """ 3045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c = Code() 3052a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) # TODO(kalman): Use function.unix_name not Classname here. 3062a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) function_namespace = cpp_util.Classname(function.name) 30758537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) # Windows has a #define for SendMessage, so to avoid any issues, we need 30858537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) # to not use the name. 30990dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) if function_namespace == 'SendMessage': 31090dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) function_namespace = 'PassMessage' 3112a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) (c.Append('namespace %s {' % function_namespace) 3122a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append() 3132a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Cblock(self._GenerateFunctionParams(function)) 3145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 3155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if function.callback: 3162a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Cblock(self._GenerateFunctionResults(function.callback)) 3172a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Append('} // namespace %s' % function_namespace) 3185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return c 3195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) def _GenerateFunctionParams(self, function): 3215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """Generates the struct for passing parameters from JSON to a function. 3225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """ 3232a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if not function.params: 3242a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) return Code() 3255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3262a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c = Code() 3272a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) (c.Sblock('struct Params {') 328c2db58bd994c04d98e4ee2cd7565b71548655fe3Ben Murdoch .Append('static scoped_ptr<Params> Create(%s);' % self._GenerateParams( 329c2db58bd994c04d98e4ee2cd7565b71548655fe3Ben Murdoch ('const base::ListValue& args',))) 3302a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append('~Params();') 3312a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append() 3322a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Cblock(self._GenerateTypes(p.type_ for p in function.params)) 3332a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Cblock(self._GenerateFields(function.params)) 3342a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Eblock() 3352a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append() 3362a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Sblock(' private:') 3372a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append('Params();') 3382a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append() 3392a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append('DISALLOW_COPY_AND_ASSIGN(Params);') 3402a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Eblock('};') 3412a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) ) 3425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return c 3435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3442a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) def _GenerateTypes(self, types, is_toplevel=False, generate_typedefs=False): 3455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """Generate the structures required by a property such as OBJECT classes 3465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) and enums. 3475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """ 3485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c = Code() 3492a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) for type_ in types: 3502a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Cblock(self._GenerateType(type_, 3512a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) is_toplevel=is_toplevel, 3522a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) generate_typedefs=generate_typedefs)) 3535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return c 3545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3552a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) def _GenerateCreateCallbackArguments(self, function): 3562a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) """Generates functions for passing parameters to a callback. 3575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """ 3585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c = Code() 3595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) params = function.params 3602a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Cblock(self._GenerateTypes((p.type_ for p in params), is_toplevel=True)) 3615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3622a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) declaration_list = [] 3632a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) for param in params: 3642a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if param.description: 3652a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Comment(param.description) 3662a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) declaration_list.append(cpp_util.GetParameterDeclaration( 3672a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) param, self._type_helper.GetCppType(param.type_))) 3682a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Append('scoped_ptr<base::ListValue> Create(%s);' % 3692a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) ', '.join(declaration_list)) 3705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return c 3715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3722385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch def _GenerateEventNameConstant(self, event): 3732385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch """Generates a constant string array for the event name. 3742385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch """ 3752385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch c = Code() 3762385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch c.Append('extern const char kEventName[]; // "%s.%s"' % ( 3772385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch self._namespace.name, event.name)) 3782385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch c.Append() 3792385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch return c 3802385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch 3815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) def _GenerateFunctionResults(self, callback): 3825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """Generates namespace for passing a function's result back. 3835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """ 3845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c = Code() 3852a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) (c.Append('namespace Results {') 3862a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append() 3872a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Concat(self._GenerateCreateCallbackArguments(callback)) 3882a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append('} // namespace Results') 3895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 3905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return c 391c2db58bd994c04d98e4ee2cd7565b71548655fe3Ben Murdoch 392c2db58bd994c04d98e4ee2cd7565b71548655fe3Ben Murdoch def _GenerateParams(self, params): 393c2db58bd994c04d98e4ee2cd7565b71548655fe3Ben Murdoch """Builds the parameter list for a function, given an array of parameters. 394c2db58bd994c04d98e4ee2cd7565b71548655fe3Ben Murdoch """ 395c2db58bd994c04d98e4ee2cd7565b71548655fe3Ben Murdoch if self._generate_error_messages: 3963551c9c881056c480085172ff9840cab31610854Torne (Richard Coles) params += ('base::string16* error = NULL',) 397c2db58bd994c04d98e4ee2cd7565b71548655fe3Ben Murdoch return ', '.join(str(p) for p in params) 398