json_schema_compiler: any, additionalProperties, functions on types

tools/json_schema_compiler/cc_generator.py

 # Copyright (c) 2012 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.
 
 from model import PropertyType
+import any_helper
 import code
 import cpp_util
 import util_cc_helper
 
 class CCGenerator(object):
   """A .cc generator for a namespace.
   """
   def __init__(self, namespace, cpp_type_generator):
     self._cpp_type_generator = cpp_type_generator
     self._namespace = namespace
     self._target_namespace = (
         self._cpp_type_generator.GetCppNamespaceName(self._namespace))
     self._util_cc_helper = (
         util_cc_helper.UtilCCHelper(self._cpp_type_generator))
+    self._any_helper = any_helper.AnyHelper()
 
   def Generate(self):
     """Generates a code.Code object with the .cc for a single namespace.
     """
     c = code.Code()
     (c.Append(cpp_util.CHROMIUM_LICENSE)
       .Append()
       .Append(cpp_util.GENERATED_FILE_MESSAGE % self._namespace.source_file)
       .Append()
       .Append(self._util_cc_helper.GetIncludePath())
       .Append('#include "%s/%s.h"' %
           (self._namespace.source_file_dir, self._namespace.name))
     )
     includes = self._cpp_type_generator.GenerateIncludes()
     if not includes.IsEmpty():
       (c.Concat(includes)
         .Append()
       )
 
     (c.Append()
       .Append('using base::Value;')
       .Append('using base::DictionaryValue;')
       .Append('using base::ListValue;')
+      .Append('using %s;' % any_helper.ANY_CLASS)
       .Append()
       .Concat(self._cpp_type_generator.GetRootNamespaceStart())
       .Concat(self._cpp_type_generator.GetNamespaceStart())
       .Append()
     )
     if self._namespace.types:
       (c.Append('//')
         .Append('// Types')
         .Append('//')
         .Append()
       )
     for type_ in self._namespace.types.values():
       (c.Concat(self._GenerateType(type_.name, type_))
         .Append()
       )
     if self._namespace.functions:
       (c.Append('//')
         .Append('// Functions')
         .Append('//')
         .Append()
       )
     for function in self._namespace.functions.values():
-      (c.Concat(self._GenerateFunction(function))
+      (c.Concat(self._GenerateFunction(
+          cpp_util.Classname(function.name), function))
         .Append()
       )
     (c.Concat(self._cpp_type_generator.GetNamespaceEnd())
       .Concat(self._cpp_type_generator.GetRootNamespaceEnd())
       .Append()
     )
     # TODO(calamity): Events
     return c
 
   def _GenerateType(self, cpp_namespace, type_):
     """Generates the function definitions for a type.
     """
     classname = cpp_util.Classname(type_.name)
     c = code.Code()
 
-    (c.Concat(self._GeneratePropertyFunctions(
-        cpp_namespace, type_.properties.values()))
-      .Append('%(namespace)s::%(classname)s() {}')
-      .Append('%(namespace)s::~%(classname)s() {}')
-      .Append()
-    )
-    if type_.from_json:
-      (c.Concat(self._GenerateTypePopulate(cpp_namespace, type_))
+    # Functions on types cannot have properties on them and are not
+    # instantiable because they're dealt with renderer side.
+    if type_.functions:
+      assert not type_.properties
+      for function in type_.functions.values():
+        (c.Concat(
+            self._GenerateFunction(
+                cpp_namespace + '::' + cpp_util.Classname(function.name),
+                function))
+          .Append()
+        )
+    else:
+      (c.Concat(self._GeneratePropertyFunctions(
+          cpp_namespace, type_.properties.values()))
+        .Append('%(namespace)s::%(classname)s() {}')
+        .Append('%(namespace)s::~%(classname)s() {}')
         .Append()
       )
-    if type_.from_client:
-      c.Concat(self._GenerateTypeToValue(cpp_namespace, type_))
-    c.Append()
+      if type_.from_json:
+        (c.Concat(self._GenerateTypePopulate(cpp_namespace, type_))
+          .Append()
+        )
+      if type_.from_client:
+        (c.Concat(self._GenerateTypeToValue(cpp_namespace, type_))
+          .Append()
+        )
     c.Substitute({'classname': classname, 'namespace': cpp_namespace})
 
     return c
 
   def _GenerateTypePopulate(self, cpp_namespace, type_):
     """Generates the function for populating a type given a pointer to it.
+
+    E.g for type "Foo", generates Foo::Populate()
     """
     classname = cpp_util.Classname(type_.name)
     c = code.Code()
     (c.Append('// static')
       .Sblock('bool %(namespace)s::Populate'
               '(const Value& value, %(name)s* out) {')
         .Append('if (!value.IsType(Value::TYPE_DICTIONARY))')
         .Append('  return false;')
         .Append('const DictionaryValue* dict = '
                 'static_cast<const DictionaryValue*>(&value);')
         .Append()
     )
     for prop in type_.properties.values():
       c.Concat(self._InitializePropertyToDefault(prop, 'out'))
     for prop in type_.properties.values():
-      c.Concat(self._GenerateTypePopulateProperty(prop, 'dict', 'out'))
+      if prop.type_ == PropertyType.ADDITIONAL_PROPERTIES:
+        c.Append('out->additional_properties.MergeDictionary(dict);')
+        # remove all keys that are actual properties
+        for key in type_.properties:
+          if prop.name != key:
+            c.Append('out->additional_properties'

[Yoyo Zhou, 2012/02/28 22:23:41]

The additional properties can't have any name conflicts with the existing keys?

[calamity, 2012/03/01 04:47:09]

The additional properties are the keys in the dictionary that didn't map to a
defined property. 

[not at google - send to devlin, 2012/03/01 07:09:37]

I think he meant what I pointed out, that if you have additional properties then
it means you can't have a property with name additional properties.

Which as discussed, is hard to avoid if you want to maintain the simple struct
interface of these things.

One way you could avoid this would be to generate a GetAdditionalProperties
method and additional_properties_ private variable... probably not worth it
though.

+                '.RemoveWithoutPathExpansion("%s", NULL);' % key)
+        c.Append()
+      else:
+        c.Concat(self._GenerateTypePopulateProperty(prop, 'dict', 'out'))
     (c.Append('return true;')
       .Eblock('}')
     )
     c.Substitute({'namespace': cpp_namespace, 'name': classname})
     return c
 
   def _GenerateTypePopulateProperty(self, prop, src, dst):
     """Generate the code to populate a single property in a type.
 
     src: DictionaryValue*
@@ skipping 16 matching lines @@
         .Append('  return false;')
         .Concat(self._GeneratePopulatePropertyFromValue(
             prop, value_var, dst, 'false'))
       )
     c.Append()
     c.Substitute({'value_var': value_var, 'key': prop.name, 'src': src})
     return c
 
   def _GenerateTypeToValue(self, cpp_namespace, type_):
     """Generates a function that serializes the type into a |DictionaryValue|.
+
+    E.g. for type "Foo" generates Foo::ToValue()
     """
     c = code.Code()
     (c.Sblock('scoped_ptr<DictionaryValue> %s::ToValue() const {' %
           cpp_namespace)
         .Append('scoped_ptr<DictionaryValue> value(new DictionaryValue());')
         .Append()
     )
     for prop in type_.properties.values():
-      if prop.optional:
-        if prop.type_ == PropertyType.ENUM:
-          c.Sblock('if (%s != %s)' %
-              (prop.unix_name, self._cpp_type_generator.GetEnumNoneValue(prop)))
-        else:
-          c.Sblock('if (%s.get())' % prop.unix_name)
-      c.Append('value->SetWithoutPathExpansion("%s", %s);' % (
-          prop.name,
-          self._CreateValueFromProperty(prop, prop.unix_name)))
-      if prop.optional:
-        c.Eblock();
+      if prop.type_ == PropertyType.ADDITIONAL_PROPERTIES:
+        c.Append('value->MergeDictionary(&%s);' % prop.unix_name)
+      else:
+        if prop.optional:
+          if prop.type_ == PropertyType.ENUM:
+            c.Sblock('if (%s != %s)' %
+                (prop.unix_name,
+                    self._cpp_type_generator.GetEnumNoneValue(prop)))
+          else:
+            c.Sblock('if (%s.get())' % prop.unix_name)
+        c.Append('value->SetWithoutPathExpansion("%s", %s);' % (
+            prop.name,
+            self._CreateValueFromProperty(prop, prop.unix_name)))
+        if prop.optional:
+          c.Eblock();
     (c.Append()
       .Append('return value.Pass();')
       .Eblock('}')
     )
     return c
 
-  def _GenerateFunction(self, function):
+  def _GenerateFunction(self, cpp_namespace, function):
     """Generates the definitions for function structs.
     """
-    classname = cpp_util.Classname(function.name)
     c = code.Code()
 
     # Params::Populate function
     if function.params:
-      c.Concat(self._GeneratePropertyFunctions(classname + '::Params',
+      c.Concat(self._GeneratePropertyFunctions(cpp_namespace + '::Params',
           function.params))
-      (c.Append('%(name)s::Params::Params() {}')
-        .Append('%(name)s::Params::~Params() {}')
+      (c.Append('%(cpp_namespace)s::Params::Params() {}')
+        .Append('%(cpp_namespace)s::Params::~Params() {}')
         .Append()
-        .Concat(self._GenerateFunctionParamsCreate(function))
+        .Concat(self._GenerateFunctionParamsCreate(cpp_namespace, function))
         .Append()
       )
 
     # Result::Create function
     if function.callback:
-      c.Concat(self._GenerateFunctionResultCreate(function))
+      c.Concat(self._GenerateFunctionResultCreate(cpp_namespace, function))
 
-    c.Substitute({'name': classname})
+    c.Substitute({'cpp_namespace': cpp_namespace})
 
     return c
 
   def _GenerateCreateEnumValue(self, cpp_namespace, prop):
-    """Generates a function that returns the |StringValue| representation of an
-    enum.
+    """Generates CreateEnumValue() that returns the |StringValue|
+    representation of an enum.
     """
     c = code.Code()
     c.Append('// static')
     c.Sblock('scoped_ptr<Value> %(cpp_namespace)s::CreateEnumValue(%(arg)s) {')
     c.Sblock('switch (%s) {' % prop.unix_name)
     if prop.optional:
       (c.Append('case %s: {' % self._cpp_type_generator.GetEnumNoneValue(prop))
         .Append('  return scoped_ptr<Value>();')
         .Append('}')
       )
@@ skipping 11 matching lines @@
     c.Eblock('}')
     c.Eblock('}')
     c.Substitute({
         'cpp_namespace': cpp_namespace,
         'arg': cpp_util.GetParameterDeclaration(
             prop, self._cpp_type_generator.GetType(prop))
     })
     return c
 
   def _CreateValueFromProperty(self, prop, var):
-    """Creates a Value given a single property. Generated code passes ownership
+    """Creates a Value given a property. Generated code passes ownership
     to caller.
 
     var: variable or variable*
+
+    E.g for std::string, generate Value::CreateStringValue(var)
     """
     if prop.type_ == PropertyType.CHOICES:
-      # CHOICES conversion not implemented because it's not used. If needed,
-      # write something to generate a function that returns a scoped_ptr<Value>
-      # and put it in _GeneratePropertyFunctions.
+      # CHOICES conversion not implemented. If needed, write something to
+      # generate a function that returns a scoped_ptr<Value> and put it in
+      # _GeneratePropertyFunctions, then use it here. Look at CreateEnumValue()
+      # for reference.
       raise NotImplementedError(
           'Conversion of CHOICES to Value not implemented')
     if prop.type_ in (PropertyType.REF, PropertyType.OBJECT):
       if prop.optional:
         return '%s->ToValue().release()' % var
       else:
         return '%s.ToValue().release()' % var
+    elif prop.type_ == PropertyType.ANY:
+      return '%s.DeepCopy()' % self._any_helper.GetValue(prop, var)
+    elif prop.type_ == PropertyType.ADDITIONAL_PROPERTIES:
+      return '%s.DeepCopy()' % var
     elif prop.type_ == PropertyType.ENUM:
       return 'CreateEnumValue(%s).release()' % var
     elif prop.type_ == PropertyType.ARRAY:
       return '%s.release()' % self._util_cc_helper.CreateValueFromArray(
           prop, var)
     elif prop.type_.is_fundamental:
       if prop.optional:
         var = '*' + var
       return {
           PropertyType.STRING: 'Value::CreateStringValue(%s)',
@@ skipping 22 matching lines @@
       c.Append('if (%(var)s.GetSize() < %(required)d'
           ' || %(var)s.GetSize() > %(total)d)')
     c.Append('  return scoped_ptr<Params>();')
     c.Substitute({
         'var': var,
         'required': num_required,
         'total': len(function.params),
     })
     return c
 
-  def _GenerateFunctionParamsCreate(self, function):
+  def _GenerateFunctionParamsCreate(self, cpp_namespace, function):
     """Generate function to create an instance of Params. The generated
     function takes a ListValue of arguments.
+
+    E.g for function "Bar", generate Bar::Params::Create()
     """
-    classname = cpp_util.Classname(function.name)
     c = code.Code()
     (c.Append('// static')
-      .Sblock('scoped_ptr<%(classname)s::Params> %(classname)s::Params::Create'
-               '(const ListValue& args) {')
+      .Sblock('scoped_ptr<%(cpp_namespace)s::Params> '
+        '%(cpp_namespace)s::Params::Create(const ListValue& args) {')
       .Concat(self._GenerateParamsCheck(function, 'args'))
       .Append('scoped_ptr<Params> params(new Params());')
     )
-    c.Substitute({'classname': classname})
+    c.Substitute({'cpp_namespace': cpp_namespace})
 
     for param in function.params:
       c.Concat(self._InitializePropertyToDefault(param, 'params'))
 
     for i, param in enumerate(function.params):
       # Any failure will cause this function to return. If any argument is
       # incorrect or missing, those following it are not processed. Note that
       # this is still correct in the case of multiple optional arguments as an
       # optional argument at position 4 cannot exist without an argument at
       # position 3.
@@ skipping 29 matching lines @@
     prop: the property the code is populating.
     value_var: a Value* that should represent |prop|.
     dst: the object with |prop| as a member.
     failure_value: the value to return if |prop| cannot be extracted from
     |value_var|
     check_type: if true, will check if |value_var| is the correct Value::Type
     """
     c = code.Code()
     c.Sblock('{')
 
-    if check_type and prop.type_ != PropertyType.CHOICES:
+    if check_type and prop.type_ not in (
+        PropertyType.CHOICES, PropertyType.ANY):
       (c.Append('if (!%(value_var)s->IsType(%(value_type)s))')
         .Append('  return %(failure_value)s;')
       )
 
     if prop.type_.is_fundamental:
       if prop.optional:
         (c.Append('%(ctype)s temp;')
           .Append('if (%s)' %
               cpp_util.GetAsFundamentalValue(prop, value_var, '&temp'))
           .Append('  %(dst)s->%(name)s.reset(new %(ctype)s(temp));')
@@ skipping 15 matching lines @@
           .Append('%(dst)s->%(name)s = temp.Pass();')
         )
       else:
         (c.Append('DictionaryValue* dictionary = NULL;')
           .Append('if (!%(value_var)s->GetAsDictionary(&dictionary))')
           .Append('  return %(failure_value)s;')
           .Append(
               'if (!%(ctype)s::Populate(*dictionary, &%(dst)s->%(name)s))')
           .Append('  return %(failure_value)s;')
         )
+    elif prop.type_ == PropertyType.ANY:
+      if prop.optional:
+        c.Append('%(dst)s->%(name)s.reset(new Any());')
+      c.Append(self._any_helper.CopyInto(prop, value_var, dst) + ';')
     elif prop.type_ == PropertyType.ARRAY:
       # util_cc_helper deals with optional and required arrays
       (c.Append('ListValue* list = NULL;')
         .Append('if (!%(value_var)s->GetAsList(&list))')
         .Append('  return %(failure_value)s;')
         .Append('if (!%s)' % self._util_cc_helper.PopulateArrayFromList(
             prop, 'list', dst + '->' + prop.unix_name))
         .Append('  return %(failure_value)s;')
       )
     elif prop.type_ == PropertyType.CHOICES:
@@ skipping 33 matching lines @@
       )
     else:
       raise NotImplementedError(prop.type_)
     c.Eblock('}')
     sub = {
         'value_var': value_var,
         'name': prop.unix_name,
         'dst': dst,
         'failure_value': failure_value,
     }
-    if prop.type_ != PropertyType.CHOICES:
+    if prop.type_ not in (PropertyType.CHOICES, PropertyType.ANY):
       sub['ctype'] = self._cpp_type_generator.GetType(prop)
       sub['value_type'] = cpp_util.GetValueType(prop)
     c.Substitute(sub)
     return c
 
   def _GeneratePropertyFunctions(self, param_namespace, params):
     """Generate the functions for structures generated by a property such as
     CreateEnumValue for ENUMs and Populate/ToValue for Params/Result objects.
     """
     c = code.Code()
     for param in params:
       if param.type_ == PropertyType.OBJECT:
         c.Concat(self._GenerateType(
             param_namespace + '::' + cpp_util.Classname(param.name),
             param))
         c.Append()
       elif param.type_ == PropertyType.ENUM:
         c.Concat(self._GenerateCreateEnumValue(param_namespace, param))
         c.Append()
     return c
 
-  def _GenerateFunctionResultCreate(self, function):
+  def _GenerateFunctionResultCreate(self, cpp_namespace, function):
     """Generate function to create a Result given the return value.
+
+    E.g for function "Bar", generate Bar::Result::Create
     """
-    classname = cpp_util.Classname(function.name)
     c = code.Code()
     params = function.callback.params
 
     if not params:
-      (c.Append('Value* %s::Result::Create() {' % classname)
+      (c.Append('Value* %s::Result::Create() {' % cpp_namespace)
         .Append('  return Value::CreateNullValue();')
         .Append('}')
       )
     else:
       expanded_params = self._cpp_type_generator.GetExpandedChoicesInParams(
           params)
       c.Concat(self._GeneratePropertyFunctions(
-          classname + '::Result', expanded_params))
+          cpp_namespace + '::Result', expanded_params))
 
       # If there is a single parameter, this is straightforward. However, if
       # the callback parameter is of 'choices', this generates a Create method
       # for each choice. This works because only 1 choice can be returned at a
       # time.
       for param in expanded_params:
+        if param.type_ == PropertyType.ANY:
+          # Generation of Value* Create(Value*) is redundant.
+          continue
         # We treat this argument as 'required' to avoid wrapping it in a
         # scoped_ptr if it's optional.
         param_copy = param.Copy()
         param_copy.optional = False
-        c.Sblock('Value* %(classname)s::Result::Create(const %(arg)s) {')
+        c.Sblock('Value* %(cpp_namespace)s::Result::Create(const %(arg)s) {')
         c.Append('return %s;' %
            self._CreateValueFromProperty(param_copy, param_copy.unix_name))
         c.Eblock('}')
-        c.Substitute({'classname': classname,
+        c.Substitute({
+            'cpp_namespace': cpp_namespace,
             'arg': cpp_util.GetParameterDeclaration(
                 param_copy, self._cpp_type_generator.GetType(param_copy))
         })
 
     return c
 
   def _InitializePropertyToDefault(self, prop, dst):
     """Initialize a model.Property to its default value inside an object.
 
+    E.g for optional enum "state", generate dst->state = STATE_NONE;
+
     dst: Type*
     """
     c = code.Code()
     if prop.type_ in (PropertyType.ENUM, PropertyType.CHOICES):
       if prop.optional:
         prop_name = prop.unix_name
         if prop.type_ == PropertyType.CHOICES:
           prop_name = prop.unix_name + '_type'
         c.Append('%s->%s = %s;' % (
           dst,
           prop_name,
           self._cpp_type_generator.GetEnumNoneValue(prop)))
     return c