Refactor chrome.cookies API to use JSON schema compiler.

chrome/browser/extensions/api/cookies/cookies_helpers.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.
 
 // Defines common functionality used by the implementation of the Chrome
 // Extensions Cookies API implemented in
 // chrome/browser/extensions/api/cookies/cookies_api.cc. This separate interface
 // exposes pieces of the API implementation mainly for unit testing purposes.
 
 #ifndef CHROME_BROWSER_EXTENSIONS_API_COOKIES_COOKIES_HELPERS_H_
 #define CHROME_BROWSER_EXTENSIONS_API_COOKIES_COOKIES_HELPERS_H_
 #pragma once
 
 #include <string>
+#include <vector>
 
+#include "base/memory/linked_ptr.h"
+#include "chrome/common/extensions/api/cookies.h"
 #include "net/cookies/cookie_monster.h"
 
 class Browser;
 class Profile;
 
 namespace base {
 class DictionaryValue;
 class ListValue;
 }
 
 namespace extensions {
 
 class Extension;
 
 namespace cookies_helpers {
 
 // Returns either the original profile or the incognito profile, based on the
 // given store ID.  Returns NULL if the profile doesn't exist or is not allowed
 // (e.g. if incognito mode is not enabled for the extension).
 Profile* ChooseProfileFromStoreId(const std::string& store_id,
                                   Profile* profile,
                                   bool include_incognito);
 
 // Returns the store ID for a particular user profile.
 const char* GetStoreIdFromProfile(Profile* profile);
 
-// Constructs a Cookie object as defined by the cookies API. This function
-// allocates a new DictionaryValue object; the caller is responsible for
-// freeing it.
-base::DictionaryValue* CreateCookieValue(
+// Allocates and construct a new Cookie object representing a cookie as defined
+// by the cookies API. The caller is responsible for freeing it.

[Aaron Boodman, 2012/07/09 17:34:49]

Change this to return scoped_ptr. Then you don't have to document the ownership
rules; they will be enforced by the compiler. Same below.

[mitchellwrosen, 2012/07/09 19:36:12]

Done.

+extensions::api::cookies::Cookie* CreateCookie(
     const net::CookieMonster::CanonicalCookie& cookie,
     const std::string& store_id);
 
-// Constructs a CookieStore object as defined by the cookies API. This function
-// allocates a new DictionaryValue object; the caller is responsible for
-// freeing it.
-base::DictionaryValue* CreateCookieStoreValue(Profile* profile,
-                                              base::ListValue* tab_ids);
+// Allocates and constructs a new CookieStore object as defined by the cookies
+// API. The caller is responsible for freeing it.
+extensions::api::cookies::CookieStore* CreateCookieStore(
+    Profile* profile,
+    base::ListValue* tab_ids);
 
 // Retrieves all cookies from the given cookie store corresponding to the given
 // URL. If the URL is empty, all cookies in the cookie store are retrieved.
 // This can only be called on the IO thread.
 void GetCookieListFromStore(
     net::CookieStore* cookie_store, const GURL& url,
     const net::CookieMonster::GetCookieListCallback& callback);
 
 // Constructs a URL from a cookie's information for use in checking
 // a cookie against the extension's host permissions. The Secure
 // property of the cookie defines the URL scheme, and the cookie's
 // domain becomes the URL host.
 GURL GetURLFromCanonicalCookie(
     const net::CookieMonster::CanonicalCookie& cookie);
 
 // Looks through all cookies in the given cookie store, and appends to the
-// match list all the cookies that both match the given URL and cookie details
+// match vector all the cookies that both match the given URL and cookie details
 // and are allowed by extension host permissions.
-void AppendMatchingCookiesToList(
+void AppendMatchingCookiesToVector(
     const net::CookieList& all_cookies,
-    const std::string& store_id,
-    const GURL& url, const base::DictionaryValue* details,
+    const GURL& url,
+    const extensions::api::cookies::GetAll::Params::Details* details,
     const Extension* extension,
-    base::ListValue* match_list);
+    std::vector<linked_ptr<extensions::api::cookies::Cookie> >* match_vector);

[Aaron Boodman, 2012/07/09 17:34:49]

Create a typedef for this.

[mitchellwrosen, 2012/07/09 19:36:12]

Done.

 
 // Appends the IDs of all tabs belonging to the given browser to the
 // given list.
 void AppendToTabIdList(Browser* browser, base::ListValue* tab_ids);
 
 // A class representing the cookie filter parameters passed into
 // cookies.getAll().
 // This class is essentially a convenience wrapper for the details dictionary
 // passed into the cookies.getAll() API by the user. If the dictionary contains
 // no filter parameters, the MatchFilter will always trivially
 // match all cookies.
 class MatchFilter {
  public:
   // Takes the details dictionary argument given by the user as input.
-  // This class does not take ownership of the lifetime of the DictionaryValue
+  // This class does not take ownership of the lifetime of the Details
   // object.
-  explicit MatchFilter(const base::DictionaryValue* details);
+  explicit MatchFilter(
+      const extensions::api::cookies::GetAll::Params::Details* details);
 
   // Returns true if the given cookie matches the properties in the match
   // filter.
   bool MatchesCookie(const net::CookieMonster::CanonicalCookie& cookie);
 
  private:
-  // Returns true if the details dictionary contains a string with the given
-  // key and value. Also returns true if the dictionary doesn't contain the
-  // given key at all (trival match).
-  bool MatchesString(const char* key, const std::string& value);
-
-  // Returns true if the details dictionary contains a boolean with the given
-  // key and value. Also returns true if the dictionary doesn't contain the
-  // given key at all (trival match).
-  bool MatchesBoolean(const char* key, bool value);
-
   // Returns true if the given cookie domain string matches the filter's
   // domain. Any cookie domain which is equal to or is a subdomain of the
   // filter's domain will be matched; leading '.' characters indicating
   // host-only domains have no meaning in the match filter domain (for
   // instance, a match filter domain of 'foo.bar.com' will be treated the same
   // as '.foo.bar.com', and both will match cookies with domain values of
   // 'foo.bar.com', '.foo.bar.com', and 'baz.foo.bar.com'.
   bool MatchesDomain(const std::string& domain);
 
-  const base::DictionaryValue* details_;
+  const extensions::api::cookies::GetAll::Params::Details* details_;
 };
 
 }  // namespace cookies_helpers
 }  // namespace extensions
 
 #endif  // CHROME_BROWSER_EXTENSIONS_API_COOKIES_COOKIES_HELPERS_H_