h_generator.py revision 2a99a7e74a7f215066514fe81d2bfa6639d9eddd
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 62a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)from model import PropertyType, Type 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) 202a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class _Generator(object): 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """A .h generator for a namespace. 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """ 232a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) def __init__(self, namespace, cpp_type_generator, cpp_namespace): 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) self._namespace = namespace 252a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) self._type_helper = cpp_type_generator 262a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) self._cpp_namespace = cpp_namespace 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) self._target_namespace = ( 282a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) self._type_helper.GetCppNamespaceName(self._namespace)) 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) def Generate(self): 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """Generates a Code object with the .h for a single namespace. 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """ 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c = Code() 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (c.Append(cpp_util.CHROMIUM_LICENSE) 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append() 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append(cpp_util.GENERATED_FILE_MESSAGE % self._namespace.source_file) 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append() 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ifndef_name = cpp_util.GenerateIfndefName(self._namespace.source_file_dir, 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) self._target_namespace) 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (c.Append('#ifndef %s' % ifndef_name) 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('#define %s' % ifndef_name) 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append() 452a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append('#include <map>') 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('#include <string>') 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('#include <vector>') 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append() 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('#include "base/basictypes.h"') 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('#include "base/logging.h"') 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('#include "base/memory/linked_ptr.h"') 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('#include "base/memory/scoped_ptr.h"') 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('#include "base/values.h"') 542a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Cblock(self._type_helper.GenerateIncludes()) 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append() 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 582a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Concat(cpp_util.OpenNamespace(self._cpp_namespace)) 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) # TODO(calamity): These forward declarations should be #includes to allow 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) # $ref types from other files to be used as required params. This requires 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) # some detangling of windows and tabs which will currently lead to circular 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) # #includes. 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) forward_declarations = ( 642a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) self._type_helper.GenerateForwardDeclarations()) 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if not forward_declarations.IsEmpty(): 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (c.Append() 672a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Cblock(forward_declarations) 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 702a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Concat(self._type_helper.GetNamespaceStart()) 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c.Append() 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if self._namespace.properties: 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (c.Append('//') 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('// Properties') 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('//') 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append() 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for property in self._namespace.properties.values(): 792a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) property_code = self._type_helper.GeneratePropertyValues( 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) property, 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 'extern const %(type)s %(name)s;') 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if property_code: 832a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Cblock(property_code) 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if self._namespace.types: 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (c.Append('//') 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('// Types') 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('//') 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append() 892a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Cblock(self._GenerateTypes(self._FieldDependencyOrder(), 902a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) is_toplevel=True, 912a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) generate_typedefs=True)) 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if self._namespace.functions: 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (c.Append('//') 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('// Functions') 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('//') 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append() 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for function in self._namespace.functions.values(): 1002a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Cblock(self._GenerateFunction(function)) 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if self._namespace.events: 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (c.Append('//') 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('// Events') 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('//') 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append() 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for event in self._namespace.events.values(): 1082a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Cblock(self._GenerateEvent(event)) 1092a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) (c.Concat(self._type_helper.GetNamespaceEnd()) 1102a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Concat(cpp_util.CloseNamespace(self._cpp_namespace)) 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('#endif // %s' % ifndef_name) 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append() 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return c 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) def _FieldDependencyOrder(self): 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """Generates the list of types in the current namespace in an order in which 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) depended-upon types appear before types which depend on them. 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """ 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) dependency_order = [] 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) def ExpandType(path, type_): 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if type_ in path: 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) raise ValueError("Illegal circular dependency via cycle " + 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ", ".join(map(lambda x: x.name, path + [type_]))) 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for prop in type_.properties.values(): 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (prop.type_ == PropertyType.REF and 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) schema_util.GetNamespace(prop.ref_type) == self._namespace.name): 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ExpandType(path + [type_], self._namespace.types[prop.ref_type]) 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if not type_ in dependency_order: 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) dependency_order.append(type_) 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for type_ in self._namespace.types.values(): 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ExpandType([], type_) 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return dependency_order 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1372a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) def _GenerateEnumDeclaration(self, enum_name, type_): 1382a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) """Generate the declaration of a C++ enum. 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """ 1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c = Code() 1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c.Sblock('enum %s {' % enum_name) 1422a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Append(self._type_helper.GetEnumNoneValue(type_) + ',') 1432a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) for value in type_.enum_values: 1442a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Append(self._type_helper.GetEnumValue(type_, value) + ',') 1452a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) return c.Eblock('};') 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) def _GenerateFields(self, props): 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """Generates the field declarations when declaring a type. 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """ 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c = Code() 1512a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) needs_blank_line = False 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for prop in props: 1532a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if needs_blank_line: 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c.Append() 1552a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) needs_blank_line = True 1565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if prop.description: 1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c.Comment(prop.description) 1582a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) # ANY is a base::Value which is abstract and cannot be a direct member, so 1592a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) # we always need to wrap it in a scoped_ptr. 1602a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) is_ptr = prop.optional or prop.type_.property_type == PropertyType.ANY 1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (c.Append('%s %s;' % ( 1622a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) self._type_helper.GetCppType(prop.type_, is_ptr=is_ptr), 1635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) prop.unix_name)) 1645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 1655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return c 1665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1672a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) def _GenerateType(self, type_, is_toplevel=False, generate_typedefs=False): 1682a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) """Generates a struct for |type_|. 1692a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1702a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) |is_toplevel| implies that the type was declared in the "types" field 1712a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) of an API schema. This determines the correct function 1722a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) modifier(s). 1732a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) |generate_typedefs| controls whether primitive types should be generated as 1742a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) a typedef. This may not always be desired. If false, 1752a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) primitive types are ignored. 1765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """ 1772a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) classname = cpp_util.Classname(schema_util.StripNamespace(type_.name)) 1785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c = Code() 1795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if type_.functions: 1812a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) # Wrap functions within types in the type's namespace. 1822a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) (c.Append('namespace %s {' % classname) 1832a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append() 1842a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) ) 1855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for function in type_.functions.values(): 1862a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Cblock(self._GenerateFunction(function)) 1872a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Append('} // namespace %s' % classname) 1882a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) elif type_.property_type == PropertyType.ARRAY: 1892a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if generate_typedefs and type_.description: 1905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c.Comment(type_.description) 1912a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Cblock(self._GenerateType(type_.item_type)) 1922a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if generate_typedefs: 1932a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) (c.Append('typedef std::vector<%s > %s;' % ( 1942a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) self._type_helper.GetCppType(type_.item_type), 1952a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) classname)) 1962a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) ) 1972a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) elif type_.property_type == PropertyType.STRING: 1982a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if generate_typedefs: 1992a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if type_.description: 2002a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Comment(type_.description) 2012a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Append('typedef std::string %(classname)s;') 2022a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) elif type_.property_type == PropertyType.ENUM: 2035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if type_.description: 2045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c.Comment(type_.description) 2055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c.Sblock('enum %(classname)s {') 2062a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Append('%s,' % self._type_helper.GetEnumNoneValue(type_)) 2075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for value in type_.enum_values: 2082a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Append('%s,' % self._type_helper.GetEnumValue(type_, value)) 2092a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) # Top level enums are in a namespace scope so the methods shouldn't be 2102a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) # static. On the other hand, those declared inline (e.g. in an object) do. 2112a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) maybe_static = '' if is_toplevel else 'static ' 2125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (c.Eblock('};') 2135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append() 2142a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append('%sstd::string ToString(%s as_enum);' % 2152a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) (maybe_static, classname)) 2162a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append('%s%s Parse%s(const std::string& as_string);' % 2172a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) (maybe_static, classname, classname)) 2185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 2192a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) elif type_.property_type == PropertyType.OBJECT: 2205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if type_.description: 2215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c.Comment(type_.description) 2225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (c.Sblock('struct %(classname)s {') 2235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('%(classname)s();') 2242a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append('~%(classname)s();') 2255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 2262a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if type_.origin.from_json: 2272a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) (c.Append() 2282a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Comment('Populates a %s object from a base::Value. Returns' 2295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ' whether |out| was successfully populated.' % classname) 2305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('static bool Populate(const base::Value& value, ' 2315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) '%(classname)s* out);') 2325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 2332a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if type_.origin.from_client: 2342a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) (c.Append() 2352a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Comment('Returns a new base::DictionaryValue representing the' 2362a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) ' serialized form of this %s object.' % classname) 2375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('scoped_ptr<base::DictionaryValue> ToValue() const;') 2385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 2392a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) properties = type_.properties.values() 2402a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) (c.Append() 2412a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Cblock(self._GenerateTypes(p.type_ for p in properties)) 2422a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Cblock(self._GenerateFields(properties))) 2432a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if type_.additional_properties is not None: 2442a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) # Most additionalProperties actually have type "any", which is better 2452a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) # modelled as a DictionaryValue rather than a map of string -> Value. 2462a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if type_.additional_properties.property_type == PropertyType.ANY: 2472a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Append('base::DictionaryValue additional_properties;') 2482a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) else: 2492a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) (c.Cblock(self._GenerateType(type_.additional_properties)) 2502a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append('std::map<std::string, %s> additional_properties;' % 2512a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) cpp_util.PadForGenerics( 2522a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) self._type_helper.GetCppType(type_.additional_properties, 2532a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) is_in_container=True))) 2542a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) ) 2555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (c.Eblock() 2562a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append() 2575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Sblock(' private:') 2585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Append('DISALLOW_COPY_AND_ASSIGN(%(classname)s);') 2595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) .Eblock('};') 2605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 2612a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) elif type_.property_type == PropertyType.CHOICES: 2622a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if type_.description: 2632a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Comment(type_.description) 2642a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) # Choices are modelled with optional fields for each choice. Exactly one 2652a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) # field of the choice is guaranteed to be set by the compiler. 2662a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) (c.Sblock('struct %(classname)s {') 2672a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append('%(classname)s();') 2682a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append('~%(classname)s();') 2692a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append()) 2702a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Cblock(self._GenerateTypes(type_.choices)) 2712a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if type_.origin.from_json: 2722a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) (c.Comment('Populates a %s object from a base::Value. Returns' 2732a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) ' whether |out| was successfully populated.' % classname) 2742a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append('static bool Populate(const base::Value& value, ' 2752a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) '%(classname)s* out);') 2762a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append() 2772a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) ) 2782a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if type_.origin.from_client: 2792a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) (c.Comment('Returns a new base::Value representing the' 2802a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) ' serialized form of this %s object.' % classname) 2812a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append('scoped_ptr<base::Value> ToValue() const;') 2822a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append() 2832a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) ) 2842a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Append('// Choices:') 2852a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) for choice_type in type_.choices: 2862a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Append('%s as_%s;' % ( 2872a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) self._type_helper.GetCppType(choice_type, is_ptr=True), 2882a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) choice_type.unix_name)) 2892a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Eblock('};') 2905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c.Substitute({'classname': classname}) 2915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return c 2925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) def _GenerateEvent(self, event): 2945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """Generates the namespaces for an event. 2955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """ 2965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c = Code() 2972a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) # TODO(kalman): use event.unix_name not Classname. 2982a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) event_namespace = cpp_util.Classname(event.name) 2992a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) (c.Append('namespace %s {' % event_namespace) 3002a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append() 3012a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Concat(self._GenerateCreateCallbackArguments(event)) 3022a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Eblock('} // namespace %s' % event_namespace) 3035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 3045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return c 3055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) def _GenerateFunction(self, function): 3075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """Generates the namespaces and structs for a function. 3085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """ 3095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c = Code() 3102a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) # TODO(kalman): Use function.unix_name not Classname here. 3112a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) function_namespace = cpp_util.Classname(function.name) 3122a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) (c.Append('namespace %s {' % function_namespace) 3132a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append() 3142a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Cblock(self._GenerateFunctionParams(function)) 3155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 3165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if function.callback: 3172a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Cblock(self._GenerateFunctionResults(function.callback)) 3182a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c.Append('} // namespace %s' % function_namespace) 3195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return c 3205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) def _GenerateFunctionParams(self, function): 3225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """Generates the struct for passing parameters from JSON to a function. 3235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """ 3242a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if not function.params: 3252a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) return Code() 3265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3272a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) c = Code() 3282a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) (c.Sblock('struct Params {') 3292a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append('static scoped_ptr<Params> Create(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) 3725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) def _GenerateFunctionResults(self, callback): 3735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """Generates namespace for passing a function's result back. 3745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) """ 3755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) c = Code() 3762a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) (c.Append('namespace Results {') 3772a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append() 3782a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Concat(self._GenerateCreateCallbackArguments(callback)) 3792a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) .Append('} // namespace Results') 3805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ) 3815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return c 382