Multi-strategy based tracking.

chrome/browser/prefs/pref_hash_store.h

 // Copyright 2013 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 CHROME_BROWSER_PREFS_PREF_HASH_STORE_H_
 #define CHROME_BROWSER_PREFS_PREF_HASH_STORE_H_
 
 #include <string>
+#include <vector>
 
 #include "base/memory/scoped_ptr.h"
 
-class PrefHashTracker;
-
 namespace base {
+class DictionaryValue;
 class Value;
 }  // namespace base
 
 // Stores hashes of and verifies preference values. To use, first call
 // |InitializeTrackedValue| with each preference that should be tracked. Then
 // call |OnPrefValueChanged| to update the hash store when preference values
 // change.
 class PrefHashStore {
  public:
   virtual ~PrefHashStore() {}
 
   enum ValueState {
     // The preference value corresponds to its stored hash.
     UNCHANGED,
     // The preference has been cleared since the last hash.
     CLEARED,
     // The preference value corresponds to its stored hash, which was calculated
     // using a legacy hash algorithm.
     MIGRATED,
     // The preference value has been changed since the last hash.
     CHANGED,
     // No stored hash exists for the preference value.
     UNKNOWN_VALUE,
   };
 
   // Checks |initial_value| against the existing stored value hash.
   virtual ValueState CheckValue(
       const std::string& path, const base::Value* initial_value) const = 0;
 
-  // Stores a hash of the current value of the preference at |path|.
+  // Stores a hash of the current |value| of the preference at |path|.
   virtual void StoreHash(const std::string& path,
                          const base::Value* value) = 0;
+
+  // Checks |initial_value| against the existing stored hashes for the split
+  // preference  at |path|. |invalid_keys| must initially be empty.

[Alexei Svitkine (slow), 2013/12/17 18:26:24]

Nit: Remove repeated space.

[gab, 2013/12/17 22:08:08]

Done.

+  // If the return value is CHANGED: |invalid_keys| will be filled with the keys

[Alexei Svitkine (slow), 2013/12/17 18:26:24]

Maybe document the valid return values here? (e.g. given that things like
CLEARED and MIGRATED shouldn't be returned by this).

[gab, 2013/12/17 22:08:08]

CLEARED can be return by this; it's when iteration over the items in the
dictionary in the implementation that CLEARED isn't expected, but this is an
implementation detail.

I don't think special documentation is otherwise required for MIGRATED here.

It currently never returns MIGRATED, but the callers shouldn't assume that.

+  // that are considered invalid (unknown or changed). |invalid_keys| will not
+  // be modified in all other cases.
+  virtual ValueState CheckSplitValue(
+      const std::string& path,
+      const base::DictionaryValue* initial_split_value,
+      std::vector<std::string>* invalid_keys) const = 0;
+
+  // Stores hashes for the |value| of the split preference at |path|.
+  virtual void StoreSplitHash(
+      const std::string& path,
+      const base::DictionaryValue* split_value) = 0;
 };
 
 #endif  // CHROME_BROWSER_PREFS_PREF_HASH_STORE_H_