json_schema_compiler: any, additionalProperties, functions on types

tools/json_schema_compiler/h_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 code
 import cpp_util
 import os
 
 class HGenerator(object):
@@ skipping 20 matching lines @@
       .Append('#define %s' % ifndef_name)
       .Append('#pragma once')
       .Append()
       .Append('#include <string>')
       .Append('#include <vector>')
       .Append()
       .Append('#include "base/basictypes.h"')
       .Append('#include "base/memory/linked_ptr.h"')
       .Append('#include "base/memory/scoped_ptr.h"')
       .Append('#include "base/values.h"')
+      .Append('#include "tools/json_schema_compiler/any.h"')
       .Append()
     )
 
     c.Concat(self._cpp_type_generator.GetRootNamespaceStart())
     # TODO(calamity): These forward declarations should be #includes to allow
     # $ref types from other files to be used as required params. This requires
     # some detangling of windows and tabs which will currently lead to circular
     # #includes.
     forward_declarations = (
         self._cpp_type_generator.GenerateForwardDeclarations())
@@ skipping 18 matching lines @@
     if self._namespace.functions:
       (c.Append('//')
         .Append('// Functions')
         .Append('//')
         .Append()
       )
       for function in self._namespace.functions.values():
         (c.Concat(self._GenerateFunction(function))
           .Append()
         )
-    (c.Append()
-      .Concat(self._cpp_type_generator.GetNamespaceEnd())
+    (c.Concat(self._cpp_type_generator.GetNamespaceEnd())
       .Concat(self._cpp_type_generator.GetRootNamespaceEnd())
       .Append()
       .Append('#endif  // %s' % ifndef_name)
       .Append()
     )
     return c
 
   def _GenerateEnumDeclaration(self, enum_name, prop, values):
     """Generate the declaration of a C++ enum for the given property and
     values.
@@ skipping 10 matching lines @@
     return c
 
   def _GenerateFields(self, props):
     """Generates the field declarations when declaring a type.
     """
     c = code.Code()
     # Generate the enums needed for any fields with "choices"
     for prop in props:
       if prop.type_ == PropertyType.CHOICES:
         enum_name = self._cpp_type_generator.GetChoicesEnumType(prop)
         c.Append('%s %s_type;' % (enum_name, prop.unix_name))

[not at google - send to devlin, 2012/02/28 22:41:17]

browsing through generated code (specifically the storage API); could you add a
new line (as in Append()) here, the KeysType is right above keys_string which
looks strange.

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

Done.

     for prop in self._cpp_type_generator.GetExpandedChoicesInParams(props):
       if prop.description:
         c.Comment(prop.description)
       c.Append('%s %s;' % (
           self._cpp_type_generator.GetType(prop, wrap_optional=True),
           prop.unix_name))
       c.Append()
     return c
 
   def _GenerateType(self, type_):
     """Generates a struct for a type.
     """
     classname = cpp_util.Classname(type_.name)
     c = code.Code()
-    if type_.description:
-      c.Comment(type_.description)
-    (c.Sblock('struct %(classname)s {')
-        .Append('~%(classname)s();')
-        .Append('%(classname)s();')
-        .Append()
-        .Concat(self._GeneratePropertyStructures(type_.properties.values()))
-        .Concat(self._GenerateFields(type_.properties.values()))
-    )
-    if type_.from_json:
-      (c.Comment('Populates a %s object from a Value. Returns'
-                 ' whether |out| was successfully populated.' % classname)
-        .Append('static bool Populate(const Value& value, %(classname)s* out);')
-        .Append()
+    # Functions on types cannot have properties on them and are not
+    # instantiable because they're dealt with renderer side.

[not at google - send to devlin, 2012/02/28 22:41:17]

See my comment about this comment in model.py.  Maybe just reference that
comment here?

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

Done.

+    if type_.functions:
+      assert not type_.properties

[not at google - send to devlin, 2012/02/28 22:41:17]

Also: again, asserts are for internal errors not errors with input, so this
should raise an exception

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

Done.

+      c.Sblock('namespace %(classname)s {')
+      for function in type_.functions.values():
+        (c.Concat(self._GenerateFunction(function))
+          .Append()
+        )
+      c.Eblock('}')
+    else:
+      if type_.description:
+        c.Comment(type_.description)
+      (c.Sblock('struct %(classname)s {')
+          .Append('~%(classname)s();')
+          .Append('%(classname)s();')
+          .Append()
+          .Concat(self._GeneratePropertyStructures(type_.properties.values()))
+          .Concat(self._GenerateFields(type_.properties.values()))
       )
+      if type_.from_json:
+        (c.Comment('Populates a %s object from a Value. Returns'
+                   ' whether |out| was successfully populated.' % classname)
+          .Append(
+              'static bool Populate(const Value& value, %(classname)s* out);')
+          .Append()
+        )
 
-    if type_.from_client:
-      (c.Comment('Returns a new DictionaryValue representing the'
-                 ' serialized form of this %s object. Passes '
-                 'ownership to caller.' % classname)
-        .Append('scoped_ptr<DictionaryValue> ToValue() const;')
+      if type_.from_client:
+        (c.Comment('Returns a new DictionaryValue representing the'
+                   ' serialized form of this %s object. Passes '
+                   'ownership to caller.' % classname)
+          .Append('scoped_ptr<DictionaryValue> ToValue() const;')
+        )
+
+      (c.Eblock()
+        .Sblock(' private:')
+          .Append('DISALLOW_COPY_AND_ASSIGN(%(classname)s);')
+        .Eblock('};')
       )
-    (c.Eblock()
-      .Sblock(' private:')
-        .Append('DISALLOW_COPY_AND_ASSIGN(%(classname)s);')
-      .Eblock('};')
-    )
     c.Substitute({'classname': classname})
     return c
 
   def _GenerateFunction(self, function):
     """Generates the structs for a function.
     """
     c = code.Code()
     (c.Sblock('namespace %s {' % cpp_util.Classname(function.name))
         .Concat(self._GenerateFunctionParams(function))
         .Append()
@@ skipping 64 matching lines @@
     else:
       c.Concat(self._GeneratePropertyStructures(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 self._cpp_type_generator.GetExpandedChoicesInParams(params):
         if param.description:
           c.Comment(param.description)
+        if param.type_ == PropertyType.ANY:
+          c.Comment("Value* Result::Create(Value*) not generated "
+              "because it's redundant.")

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

nit: indent to paren

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

Done.

+          continue
         c.Append('Value* Create(const %s);' % cpp_util.GetParameterDeclaration(
             param, self._cpp_type_generator.GetType(param)))
     c.Eblock('};')
 
     return c
 
   def _GenerateIfndefName(self):
     """Formats a path and filename as a #define name.
 
     e.g chrome/extensions/gen, file.h becomes CHROME_EXTENSIONS_GEN_FILE_H__.
     """
     return (('%s_%s_H__' %
         (self._namespace.source_file_dir, self._target_namespace))
         .upper().replace(os.sep, '_'))