| // Copyright 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 SYNC_API_SYNC_DATA_H_ |
| #define SYNC_API_SYNC_DATA_H_ |
| |
| #include <iosfwd> |
| #include <string> |
| #include <vector> |
| |
| #include "base/basictypes.h" |
| #include "base/time/time.h" |
| #include "sync/base/sync_export.h" |
| #include "sync/internal_api/public/base/model_type.h" |
| #include "sync/internal_api/public/util/immutable.h" |
| |
| namespace sync_pb { |
| class EntitySpecifics; |
| class SyncEntity; |
| } // namespace sync_pb |
| |
| namespace syncer { |
| |
| // A light-weight container for immutable sync data. Pass-by-value and storage |
| // in STL containers are supported and encouraged if helpful. |
| class SYNC_EXPORT SyncData { |
| public: |
| // Creates an empty and invalid SyncData. |
| SyncData(); |
| ~SyncData(); |
| |
| // Default copy and assign welcome. |
| |
| // Helper methods for creating SyncData objects for local data. |
| // The sync tag must be a string unique to this datatype and is used as a node |
| // identifier server-side. |
| // For deletes: |datatype| must specify the datatype who node is being |
| // deleted. |
| // For adds/updates: the specifics must be valid and the non-unique title (can |
| // be the same as sync tag) must be specfied. |
| // Note: the non_unique_title is primarily for debug purposes, and will be |
| // overwritten if the datatype is encrypted. |
| static SyncData CreateLocalDelete( |
| const std::string& sync_tag, |
| ModelType datatype); |
| static SyncData CreateLocalData( |
| const std::string& sync_tag, |
| const std::string& non_unique_title, |
| const sync_pb::EntitySpecifics& specifics); |
| |
| // Helper method for creating SyncData objects originating from the syncer. |
| static SyncData CreateRemoteData( |
| int64 id, |
| const sync_pb::EntitySpecifics& specifics, |
| const base::Time& last_modified_time); |
| |
| // Whether this SyncData holds valid data. The only way to have a SyncData |
| // without valid data is to use the default constructor. |
| bool IsValid() const; |
| |
| // Return the datatype we're holding information about. Derived from the sync |
| // datatype specifics. |
| ModelType GetDataType() const; |
| |
| // Return the current sync datatype specifics. |
| const sync_pb::EntitySpecifics& GetSpecifics() const; |
| |
| // Returns the value of the unique client tag. This is only set for data going |
| // TO the syncer, not coming from. |
| const std::string& GetTag() const; |
| |
| // Returns the non unique title (for debugging). Currently only set for data |
| // going TO the syncer, not from. |
| const std::string& GetTitle() const; |
| |
| // Returns the last motification time according to the server. This is |
| // only valid if IsLocal() is false, and may be null if the SyncData |
| // represents a deleted item. |
| const base::Time& GetRemoteModifiedTime() const; |
| |
| // Should only be called by sync code when IsLocal() is false. |
| int64 GetRemoteId() const; |
| |
| // Whether this sync data is for local data or data coming from the syncer. |
| bool IsLocal() const; |
| |
| std::string ToString() const; |
| |
| // TODO(zea): Query methods for other sync properties: parent, successor, etc. |
| |
| private: |
| // Necessary since we forward-declare sync_pb::SyncEntity; see |
| // comments in immutable.h. |
| struct ImmutableSyncEntityTraits { |
| typedef sync_pb::SyncEntity* Wrapper; |
| |
| static void InitializeWrapper(Wrapper* wrapper); |
| |
| static void DestroyWrapper(Wrapper* wrapper); |
| |
| static const sync_pb::SyncEntity& Unwrap(const Wrapper& wrapper); |
| |
| static sync_pb::SyncEntity* UnwrapMutable(Wrapper* wrapper); |
| |
| static void Swap(sync_pb::SyncEntity* t1, sync_pb::SyncEntity* t2); |
| }; |
| |
| typedef Immutable<sync_pb::SyncEntity, ImmutableSyncEntityTraits> |
| ImmutableSyncEntity; |
| |
| // Clears |entity|. |
| SyncData(int64 id, |
| sync_pb::SyncEntity* entity, |
| const base::Time& remote_modification_time); |
| |
| // Whether this SyncData holds valid data. |
| bool is_valid_; |
| |
| // Equal to kInvalidId iff this is local. |
| int64 id_; |
| |
| // This is only valid if IsLocal() is false, and may be null if the |
| // SyncData represents a deleted item. |
| base::Time remote_modification_time_; |
| |
| // The actual shared sync entity being held. |
| ImmutableSyncEntity immutable_entity_; |
| }; |
| |
| // gmock printer helper. |
| void PrintTo(const SyncData& sync_data, std::ostream* os); |
| |
| typedef std::vector<SyncData> SyncDataList; |
| |
| } // namespace syncer |
| |
| #endif // SYNC_API_SYNC_DATA_H_ |