Supporting more APIs with json_schema_compiler

tools/json_schema_compiler/util.h

 // 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.
 
 #ifndef TOOLS_JSON_SCHEMA_COMPILER_UTIL_H__
 #define TOOLS_JSON_SCHEMA_COMPILER_UTIL_H__
 #pragma once
 
 #include <string>
 #include <vector>
 
+#include "base/memory/linked_ptr.h"
 #include "base/memory/scoped_ptr.h"
-
-namespace base {
-class DictionaryValue;
-}
+#include "base/values.h"
 
 namespace json_schema_compiler {
 namespace util {
 
-// Creates a new vector containing the strings |from|.|name| at |out|. Returns
+// Creates a new item at |out| from |from|[|index|]. These are used by template
+// specializations of |Get(Optional)ArrayFromList|.
+bool GetItemFromList(const ListValue& from, int index, int* out);
+bool GetItemFromList(const ListValue& from, int index, bool* out);
+bool GetItemFromList(const ListValue& from, int index, double* out);
+bool GetItemFromList(const ListValue& from, int index, std::string* out);
+bool GetItemFromList(const ListValue& from, int index,
+    linked_ptr<base::DictionaryValue>* out);
+
+// This template is used for types generated by tools/json_schema_compiler.
+template<class T>
+bool GetItemFromList(const ListValue& from, int index, linked_ptr<T>* out) {
+  DictionaryValue* dict;
+  if (!from.GetDictionary(index, &dict))
+    return false;
+  T* obj(new T());
+  if (!T::Populate(*dict, obj))
+    return false;
+  *out = linked_ptr<T>(obj);
+  return true;
+}
+// Creates a new vector containing Llist| at |out|. Returns

[Yoyo Zhou, 2012/02/10 01:49:33]

typo: L -> |
Also, this doesn't appear to create a new vector.

[calamity, 2012/02/10 03:52:50]

Done. Also erases |out|.

 // false if there is no list at the specified key or if the list has anything
-// other than strings.
-bool GetStrings(
+// other than |T|.
+template <class T>
+bool GetArrayFromList(
+    const base::ListValue& list, std::vector<T>* out) {
+  T value;
+  for (size_t i = 0; i < list.GetSize(); ++i) {
+    if (!GetItemFromList(list, i, &value))
+      return false;
+    out->push_back(value);
+  }
+
+  return true;
+}
+
+// Creates a new vector containing |from|.|name| at |out|. Returns
+// false if there is no list at the specified key or if the list has anything
+// other than |T|.
+template <class T>
+bool GetArrayFromDictionary(
     const base::DictionaryValue& from,
     const std::string& name,
-    std::vector<std::string>* out);
+    std::vector<T>* out) {
+  base::ListValue* list = NULL;
+  if (!from.GetListWithoutPathExpansion(name, &list))
+    return false;
 
-// Creates a new vector containing the strings |from|.|name| at |out|. Returns
+  return GetArrayFromList(*list, out);
+}
+
+// Creates a new vector containing |list| at |out|. Returns
 // true on success or if there is nothing at the specified key. Returns false
-// if anything other than a list of strings is at the specified key.
-bool GetOptionalStrings(
+// if anything other than a list of |T| is at the specified key.
+template <class T>
+bool GetOptionalArrayFromList(
+    const base::ListValue& list,
+    scoped_ptr<std::vector<T> >* out) {
+  out->reset(new std::vector<T>());
+  T value;
+  for (size_t i = 0; i < list.GetSize(); ++i) {
+    if (!GetItemFromList(list, i, &value)) {
+      out->reset();
+      return false;
+    }
+    (*out)->push_back(value);
+  }
+
+  return true;
+}
+
+// Creates a new vector containing |from|.|name| at |out|. Returns
+// true on success or if there is nothing at the specified key. Returns false
+// if anything other than a list of |T| is at the specified key.
+template <class T>
+bool GetOptionalArrayFromDictionary(
     const base::DictionaryValue& from,
     const std::string& name,
-    scoped_ptr<std::vector<std::string> >* out);
+    scoped_ptr<std::vector<T> >* out) {
+  base::ListValue* list = NULL;
+  {
+    base::Value* maybe_list = NULL;
+    // Since |name| is optional, its absence is acceptable. However, anything
+    // other than a ListValue is not.
+    if (!from.GetWithoutPathExpansion(name, &maybe_list))
+      return true;
+    if (!maybe_list->IsType(base::Value::TYPE_LIST))
+      return false;
+    list = static_cast<base::ListValue*>(maybe_list);
+  }
 
-// Puts the each string in |from| into a new ListValue at |out|.|name|.
-void SetStrings(
-    const std::vector<std::string>& from,
+  return GetOptionalArrayFromList(*list, out);
+}
+
+// Appends a Value newly created from |from| to |out|. These used by template
+// specializations of |Set(Optional)ArrayToList|.
+void AddItemToList(const int from, base::ListValue* out);
+void AddItemToList(const bool from, base::ListValue* out);
+void AddItemToList(const double from, base::ListValue* out);
+void AddItemToList(const std::string& from, base::ListValue* out);
+void AddItemToList(const linked_ptr<base::DictionaryValue>& from,
+    base::ListValue* out);
+
+// This template is used for types generated by tools/json_schema_compiler.
+template<class T>
+void AddItemToList(const linked_ptr<T>& from, ListValue* out) {
+  out->Append(from->ToValue().release());
+}
+
+// Set |out| to the the contents of |from|. Requires GetItemFromList to be

[Yoyo Zhou, 2012/02/10 01:49:33]

This one doesn't appear to erase |out|'s existing contents.

[calamity, 2012/02/10 03:52:50]

Done. Erases now.

+// implemented for |T|.
+template <class T>
+void SetArrayToList(

[Yoyo Zhou, 2012/02/10 01:49:33]

This name is a little awkward. I'd think it means
array = list;
when it's actually vice versa.
What about AddArrayItemsToList or some such? Maybe ...From...?

Same for the names below.

[calamity, 2012/02/10 03:52:50]

You're right. Since I added the erasure of |out|, I didn't want to use Add in
the name. I chose Populate instead? Let me know if you think of something
better.

[Yoyo Zhou, 2012/02/10 19:43:21]

All the populating looks pretty consistent.

+    const std::vector<T>& from,
+    base::ListValue* out) {
+  for (typename std::vector<T>::const_iterator it = from.begin();
+      it != from.end(); ++it) {
+    AddItemToList(*it, out);
+  }
+}
+
+// Set |out| to the the contents of |from| if |from| is non-NULL. Requires
+// GetItemFromList to be implemented for |T|.
+template <class T>
+void SetOptionalArrayToList(
+    const scoped_ptr<std::vector<T> >& from,
+    base::ListValue* out) {
+  if (from.get())
+    SetArrayToList(*from, out);
+
+}
+
+// Sets |out|.|name| to a newly created ListValue containing |from|. Requires
+// GetItemFromList to be implemented for |T|.
+template <class T>
+void SetArrayToDictionary(
+    const std::vector<T>& from,
     const std::string& name,
-    base::DictionaryValue* out);
+    base::DictionaryValue* out) {
+  base::ListValue* list = new base::ListValue();
+  out->SetWithoutPathExpansion(name, list);
+  SetArrayToList(from, list);
+}
 
-// If from is non-NULL, puts each string in |from| into a new ListValue at
-// |out|.|name|.
-void SetOptionalStrings(
-    const scoped_ptr<std::vector<std::string> >& from,
+// If |from| is non-NULL, sets |out|.|name| to a newly created ListValue
+// containing |from|. Requires GetItemFromList to be implemented for |T|.
+template <class T>
+void SetOptionalArrayToDictionary(
+    const scoped_ptr<std::vector<T> >& from,
     const std::string& name,
-    base::DictionaryValue* out);
+    base::DictionaryValue* out) {
+  if (from.get())
+    SetArrayToDictionary(*from, name, out);
+}
+
 
 }  // namespace api_util
 }  // namespace extensions
 
 #endif // TOOLS_JSON_SCHEMA_COMPILER_UTIL_H__