Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(1222)

Unified Diff: components/syncable_prefs/pref_model_associator.h

Issue 2459823002: [Sync] Rename syncable_prefs to sync_preferences. (Closed)
Patch Set: Created 4 years, 2 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « components/syncable_prefs/OWNERS ('k') | components/syncable_prefs/pref_model_associator.cc » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: components/syncable_prefs/pref_model_associator.h
diff --git a/components/syncable_prefs/pref_model_associator.h b/components/syncable_prefs/pref_model_associator.h
deleted file mode 100644
index bce8f53c7ece0d10aaf61c720abf23f58a31b538..0000000000000000000000000000000000000000
--- a/components/syncable_prefs/pref_model_associator.h
+++ /dev/null
@@ -1,209 +0,0 @@
-// 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 COMPONENTS_SYNCABLE_PREFS_PREF_MODEL_ASSOCIATOR_H_
-#define COMPONENTS_SYNCABLE_PREFS_PREF_MODEL_ASSOCIATOR_H_
-
-#include <map>
-#include <memory>
-#include <set>
-#include <string>
-#include <vector>
-
-#include "base/callback.h"
-#include "base/compiler_specific.h"
-#include "base/containers/hash_tables.h"
-#include "base/macros.h"
-#include "base/observer_list.h"
-#include "base/threading/non_thread_safe.h"
-#include "components/sync/model/sync_data.h"
-#include "components/sync/model/syncable_service.h"
-#include "components/syncable_prefs/synced_pref_observer.h"
-
-namespace base {
-class Value;
-}
-
-namespace sync_pb {
-class PreferenceSpecifics;
-}
-
-namespace syncable_prefs {
-
-class PrefModelAssociatorClient;
-class PrefRegistrySyncable;
-class PrefServiceSyncable;
-
-// Contains all preference sync related logic.
-// TODO(sync): Merge this into PrefService once we separate the profile
-// PrefService from the local state PrefService.
-class PrefModelAssociator
- : public syncer::SyncableService,
- public base::NonThreadSafe {
- public:
- // Constructs a PrefModelAssociator initializing the |client_| and |type_|
- // instance variable. The |client| is not owned by this object and the caller
- // must ensure that it oulives the PrefModelAssociator.
- PrefModelAssociator(const PrefModelAssociatorClient* client,
- syncer::ModelType type);
- ~PrefModelAssociator() override;
-
- // See description above field for details.
- bool models_associated() const { return models_associated_; }
-
- // syncer::SyncableService implementation.
- syncer::SyncDataList GetAllSyncData(syncer::ModelType type) const override;
- syncer::SyncError ProcessSyncChanges(
- const tracked_objects::Location& from_here,
- const syncer::SyncChangeList& change_list) override;
- syncer::SyncMergeResult MergeDataAndStartSyncing(
- syncer::ModelType type,
- const syncer::SyncDataList& initial_sync_data,
- std::unique_ptr<syncer::SyncChangeProcessor> sync_processor,
- std::unique_ptr<syncer::SyncErrorFactory> sync_error_factory) override;
- void StopSyncing(syncer::ModelType type) override;
-
- // Returns the list of preference names that are registered as syncable, and
- // hence should be monitored for changes.
- std::set<std::string> registered_preferences() const;
-
- // Register a preference with the specified name for syncing. We do not care
- // about the type at registration time, but when changes arrive from the
- // syncer, we check if they can be applied and if not drop them.
- // Note: This should only be called at profile startup time (before sync
- // begins).
- virtual void RegisterPref(const char* name);
-
- // Returns true if the specified preference is registered for syncing.
- virtual bool IsPrefRegistered(const char* name);
-
- // Process a local preference change. This can trigger new SyncChanges being
- // sent to the syncer.
- virtual void ProcessPrefChange(const std::string& name);
-
- void SetPrefService(PrefServiceSyncable* pref_service);
-
- // Merges the local_value into the supplied server_value and returns
- // the result (caller takes ownership). If there is a conflict, the server
- // value always takes precedence. Note that only certain preferences will
- // actually be merged, all others will return a copy of the server value. See
- // the method's implementation for details.
- std::unique_ptr<base::Value> MergePreference(const std::string& name,
- const base::Value& local_value,
- const base::Value& server_value);
-
- // Fills |sync_data| with a sync representation of the preference data
- // provided.
- bool CreatePrefSyncData(const std::string& name,
- const base::Value& value,
- syncer::SyncData* sync_data) const;
-
- // Extract preference value from sync specifics.
- base::Value* ReadPreferenceSpecifics(
- const sync_pb::PreferenceSpecifics& specifics);
-
- // Returns true if the pref under the given name is pulled down from sync.
- // Note this does not refer to SYNCABLE_PREF.
- bool IsPrefSynced(const std::string& name) const;
-
- // Adds a SyncedPrefObserver to watch for changes to a specific pref.
- void AddSyncedPrefObserver(const std::string& name,
- SyncedPrefObserver* observer);
-
- // Removes a SyncedPrefObserver from a pref's list of observers.
- void RemoveSyncedPrefObserver(const std::string& name,
- SyncedPrefObserver* observer);
-
- // Returns the PrefModelAssociatorClient for this object.
- const PrefModelAssociatorClient* client() const { return client_; }
-
- // Set the PrefModelAssociatorClient to use for that object during tests.
- void SetPrefModelAssociatorClientForTesting(
- const PrefModelAssociatorClient* client);
-
- // Register callback method which will get called at the end of
- // PrefModelAssociator::MergeDataAndStartSyncing().
- void RegisterMergeDataFinishedCallback(const base::Closure& callback);
-
- protected:
- friend class PrefServiceSyncableTest;
-
- typedef std::map<std::string, syncer::SyncData> SyncDataMap;
-
- // Create an association for a given preference. If |sync_pref| is valid,
- // signifying that sync has data for this preference, we reconcile their data
- // with ours and append a new UPDATE SyncChange to |sync_changes|. If
- // sync_pref is not set, we append an ADD SyncChange to |sync_changes| with
- // the current preference data.
- // Note: We do not modify the sync data for preferences that are either
- // controlled by policy (are not user modifiable) or have their default value
- // (are not user controlled).
- void InitPrefAndAssociate(const syncer::SyncData& sync_pref,
- const std::string& pref_name,
- syncer::SyncChangeList* sync_changes);
-
- static base::Value* MergeListValues(
- const base::Value& from_value, const base::Value& to_value);
- static base::Value* MergeDictionaryValues(const base::Value& from_value,
- const base::Value& to_value);
-
- // Do we have an active association between the preferences and sync models?
- // Set when start syncing, reset in StopSyncing. While this is not set, we
- // ignore any local preference changes (when we start syncing we will look
- // up the most recent values anyways).
- bool models_associated_;
-
- // Whether we're currently processing changes from the syncer. While this is
- // true, we ignore any local preference changes, since we triggered them.
- bool processing_syncer_changes_;
-
- // A set of preference names.
- typedef std::set<std::string> PreferenceSet;
-
- // All preferences that have registered as being syncable with this profile.
- PreferenceSet registered_preferences_;
-
- // The preferences that are currently synced (excludes those preferences
- // that have never had sync data and currently have default values or are
- // policy controlled).
- // Note: this set never decreases, only grows to eventually match
- // registered_preferences_ as more preferences are synced. It determines
- // whether a preference change should update an existing sync node or create
- // a new sync node.
- PreferenceSet synced_preferences_;
-
- // The PrefService we are syncing to.
- PrefServiceSyncable* pref_service_;
-
- // Sync's syncer::SyncChange handler. We push all our changes through this.
- std::unique_ptr<syncer::SyncChangeProcessor> sync_processor_;
-
- // Sync's error handler. We use this to create sync errors.
- std::unique_ptr<syncer::SyncErrorFactory> sync_error_factory_;
-
- // The datatype that this associator is responible for, either PREFERENCES or
- // PRIORITY_PREFERENCES.
- syncer::ModelType type_;
-
- private:
- // Map prefs to lists of observers. Observers will receive notification when
- // a pref changes, including the detail of whether or not the change came
- // from sync.
- using SyncedPrefObserverList = base::ObserverList<SyncedPrefObserver>;
- using SyncedPrefObserverMap =
- base::hash_map<std::string, std::unique_ptr<SyncedPrefObserverList>>;
-
- void NotifySyncedPrefObservers(const std::string& path, bool from_sync) const;
-
- SyncedPrefObserverMap synced_pref_observers_;
- const PrefModelAssociatorClient* client_; // Weak.
-
- std::vector<base::Closure> callback_list_;
-
- DISALLOW_COPY_AND_ASSIGN(PrefModelAssociator);
-};
-
-} // namespace syncable_prefs
-
-#endif // COMPONENTS_SYNCABLE_PREFS_PREF_MODEL_ASSOCIATOR_H_
« no previous file with comments | « components/syncable_prefs/OWNERS ('k') | components/syncable_prefs/pref_model_associator.cc » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698