sync/protocol/proto_value_conversions.h

   1 // Copyright 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 // Keep this file in sync with the .proto files in this directory.
   6
   7 #ifndef SYNC_PROTOCOL_PROTO_VALUE_CONVERSIONS_H_
   8 #define SYNC_PROTOCOL_PROTO_VALUE_CONVERSIONS_H_
   9
  10 #include "sync/base/sync_export.h"
  11
  12 namespace base {
  13 class DictionaryValue;
  14 }
  15
  16 namespace sync_pb {
  17 class AppNotification;
  18 class AppNotificationSettings;
  19 class AppSettingSpecifics;
  20 class AppSpecifics;
  21 class ArticleSpecifics;
  22 class AutofillProfileSpecifics;
  23 class AutofillSpecifics;
  24 class BookmarkSpecifics;
  25 class ClientConfigParams;
  26 class ClientToServerMessage;
  27 class ClientToServerResponse;
  28 class CoalescedSyncedNotification;
  29 class CollapsedInfo;
  30 class DatatypeAssociationStats;
  31 class DebugEventInfo;
  32 class DebugInfo;
  33 class DeviceInfoSpecifics;
  34 class DeviceInformation;
  35 class DictionarySpecifics;
  36 class EncryptedData;
  37 class EntitySpecifics;
  38 class EverythingDirective;
  39 class ExperimentsSpecifics;
  40 class ExtensionSettingSpecifics;
  41 class ExtensionSpecifics;
  42 class FaviconImageSpecifics;
  43 class FaviconTrackingSpecifics;
  44 class GlobalIdDirective;
  45 class HistoryDeleteDirectiveSpecifics;
  46 class KeystoreEncryptionFlagsSpecifics;
  47 class Media;
  48 class ManagedUserSettingSpecifics;
  49 class ManagedUserSpecifics;
  50 class NigoriSpecifics;
  51 class PasswordSpecifics;
  52 class PasswordSpecificsData;
  53 class PreferenceSpecifics;
  54 class PriorityPreferenceSpecifics;
  55 class SearchEngineSpecifics;
  56 class SessionHeader;
  57 class SessionSpecifics;
  58 class SessionTab;
  59 class SessionWindow;
  60 class SimpleCollapsedLayout;
  61 class SyncCycleCompletedEventInfo;
  62 class SyncedNotification;
  63 class SyncedNotificationAction;
  64 class SyncedNotificationDestination;
  65 class SyncedNotificationImage;
  66 class SyncedNotificationProfileImage;
  67 class SyncedNotificationRenderInfo;
  68 class SyncedNotificationSpecifics;
  69 class TabNavigation;
  70 class Target;
  71 class ThemeSpecifics;
  72 class TimeRangeDirective;
  73 class TypedUrlSpecifics;
  74 }  // namespace sync_pb
  75
  76 // Utility functions to convert sync protocol buffers to dictionaries.
  77 // Each protocol field is mapped to a key of the same name.  Repeated
  78 // fields are mapped to array values and sub-messages are mapped to
  79 // sub-dictionary values.
  80 //
  81 // TODO(akalin): Add has_* information.
  82 //
  83 // TODO(akalin): Improve enum support.
  84
  85 namespace syncer {
  86
  87 // Ownership of all returned DictionaryValues are transferred to the
  88 // caller.
  89
  90 // TODO(akalin): Perhaps extend this to decrypt?
  91 SYNC_EXPORT_PRIVATE base::DictionaryValue* EncryptedDataToValue(
  92     const sync_pb::EncryptedData& encrypted_data);
  93
  94 // Sub-protocol of AppSpecifics.
  95 SYNC_EXPORT_PRIVATE base::DictionaryValue* AppSettingsToValue(
  96     const sync_pb::AppNotificationSettings& app_notification_settings);
  97
  98 // Sub-protocols of SessionSpecifics.
  99
 100 SYNC_EXPORT_PRIVATE base::DictionaryValue* SessionHeaderToValue(
 101     const sync_pb::SessionHeader& session_header);
 102
 103 SYNC_EXPORT_PRIVATE base::DictionaryValue* SessionTabToValue(
 104     const sync_pb::SessionTab& session_tab);
 105
 106 SYNC_EXPORT_PRIVATE base::DictionaryValue* SessionWindowToValue(
 107     const sync_pb::SessionWindow& session_window);
 108
 109 SYNC_EXPORT_PRIVATE base::DictionaryValue* TabNavigationToValue(
 110     const sync_pb::TabNavigation& tab_navigation);
 111
 112 // Sub-protocol of PasswordSpecifics.
 113
 114 SYNC_EXPORT_PRIVATE base::DictionaryValue* PasswordSpecificsDataToValue(
 115     const sync_pb::PasswordSpecificsData& password_specifics_data);
 116
 117 // Sub-protocol of NigoriSpecifics.
 118
 119 base::DictionaryValue* DeviceInformationToValue(
 120     const sync_pb::DeviceInformation& device_information);
 121
 122 // Sub-protocol of HistoryDeleteDirectiveSpecifics.
 123
 124 base::DictionaryValue* GlobalIdDirectiveToValue(
 125     const sync_pb::GlobalIdDirective& global_id_directive);
 126
 127 base::DictionaryValue* TimeRangeDirectiveToValue(
 128     const sync_pb::TimeRangeDirective& time_range_directive);
 129
 130 // Sub-protocol of Experiments.
 131
 132 base::DictionaryValue* KeystoreEncryptionToValue(
 133     const sync_pb::KeystoreEncryptionFlagsSpecifics& proto);
 134
 135 // Sub protocols of SyncedNotifications.
 136
 137 base::DictionaryValue* SimpleCollapsedLayoutToValue(
 138     const sync_pb::SimpleCollapsedLayout& proto);
 139
 140 base::DictionaryValue* CollapsedInfoToValue(
 141     const sync_pb::CollapsedInfo& proto);
 142
 143 base::DictionaryValue* RenderInfoToValue(
 144     const sync_pb::SyncedNotificationRenderInfo& proto);
 145
 146 base::DictionaryValue* CoalescedNotificationToValue(
 147     const sync_pb::CoalescedSyncedNotification& proto);
 148
 149 base::DictionaryValue* SyncedNotificationActionToValue(
 150     const sync_pb::SyncedNotificationAction& action);
 151
 152 base::DictionaryValue* SyncedNotificationDestinationToValue(
 153     const sync_pb::SyncedNotificationDestination& destination);
 154
 155 base::DictionaryValue* SyncedNotificationToValue(
 156     const sync_pb::SyncedNotification& notification);
 157
 158 SYNC_EXPORT_PRIVATE base::DictionaryValue* SessionSpecificsToValue(
 159     const sync_pb::SessionSpecifics& session_specifics);
 160
 161 SYNC_EXPORT_PRIVATE base::DictionaryValue* SyncedNotificationImageToValue(
 162     const sync_pb::SyncedNotificationImage& image);
 163
 164 SYNC_EXPORT_PRIVATE base::DictionaryValue*
 165     SyncedNotificationProfileImageToValue(
 166         const sync_pb::SyncedNotificationProfileImage& image);
 167
 168 SYNC_EXPORT_PRIVATE base::DictionaryValue* TargetToValue(
 169     const sync_pb::Target& target);
 170
 171 // Main *SpecificsToValue functions.
 172
 173 SYNC_EXPORT_PRIVATE base::DictionaryValue* AppNotificationToValue(
 174     const sync_pb::AppNotification& app_notification_specifics);
 175
 176 base::DictionaryValue* AppSettingSpecificsToValue(
 177     const sync_pb::AppSettingSpecifics& app_setting_specifics);
 178
 179 SYNC_EXPORT_PRIVATE base::DictionaryValue* AppSpecificsToValue(
 180     const sync_pb::AppSpecifics& app_specifics);
 181
 182 SYNC_EXPORT_PRIVATE base::DictionaryValue* ArticleSpecificsToValue(
 183     const sync_pb::ArticleSpecifics& article_specifics);
 184
 185 SYNC_EXPORT_PRIVATE base::DictionaryValue* AutofillSpecificsToValue(
 186     const sync_pb::AutofillSpecifics& autofill_specifics);
 187
 188 SYNC_EXPORT_PRIVATE base::DictionaryValue* AutofillProfileSpecificsToValue(
 189     const sync_pb::AutofillProfileSpecifics& autofill_profile_specifics);
 190
 191 SYNC_EXPORT_PRIVATE base::DictionaryValue* BookmarkSpecificsToValue(
 192     const sync_pb::BookmarkSpecifics& bookmark_specifics);
 193
 194 SYNC_EXPORT_PRIVATE base::DictionaryValue* DeviceInfoSpecificsToValue(
 195     const sync_pb::DeviceInfoSpecifics& device_info_specifics);
 196
 197 SYNC_EXPORT_PRIVATE base::DictionaryValue* DictionarySpecificsToValue(
 198     const sync_pb::DictionarySpecifics& dictionary_specifics);
 199
 200 SYNC_EXPORT_PRIVATE base::DictionaryValue* ExperimentsSpecificsToValue(
 201     const sync_pb::ExperimentsSpecifics& proto);
 202
 203 SYNC_EXPORT_PRIVATE base::DictionaryValue* PriorityPreferenceSpecificsToValue(
 204     const sync_pb::PriorityPreferenceSpecifics& proto);
 205
 206 SYNC_EXPORT_PRIVATE base::DictionaryValue* ExtensionSettingSpecificsToValue(
 207     const sync_pb::ExtensionSettingSpecifics& extension_setting_specifics);
 208
 209 SYNC_EXPORT_PRIVATE base::DictionaryValue* ExtensionSpecificsToValue(
 210     const sync_pb::ExtensionSpecifics& extension_specifics);
 211
 212 SYNC_EXPORT_PRIVATE base::DictionaryValue* FaviconImageSpecificsToValue(
 213     const sync_pb::FaviconImageSpecifics& favicon_image_specifics);
 214
 215 SYNC_EXPORT_PRIVATE base::DictionaryValue* FaviconTrackingSpecificsToValue(
 216     const sync_pb::FaviconTrackingSpecifics& favicon_tracking_specifics);
 217
 218 SYNC_EXPORT base::DictionaryValue* HistoryDeleteDirectiveSpecificsToValue(
 219     const sync_pb::HistoryDeleteDirectiveSpecifics&
 220         history_delete_directive_specifics);
 221
 222 SYNC_EXPORT_PRIVATE base::DictionaryValue* ManagedUserSettingSpecificsToValue(
 223     const sync_pb::ManagedUserSettingSpecifics& managed_user_setting_specifics);
 224
 225 SYNC_EXPORT_PRIVATE base::DictionaryValue* ManagedUserSpecificsToValue(
 226     const sync_pb::ManagedUserSpecifics& managed_user_specifics);
 227
 228 SYNC_EXPORT_PRIVATE base::DictionaryValue* MediaToValue(
 229     const sync_pb::Media& media);
 230
 231 SYNC_EXPORT_PRIVATE base::DictionaryValue* NigoriSpecificsToValue(
 232     const sync_pb::NigoriSpecifics& nigori_specifics);
 233
 234 SYNC_EXPORT_PRIVATE base::DictionaryValue* PasswordSpecificsToValue(
 235     const sync_pb::PasswordSpecifics& password_specifics);
 236
 237 SYNC_EXPORT_PRIVATE base::DictionaryValue* PreferenceSpecificsToValue(
 238     const sync_pb::PreferenceSpecifics& password_specifics);
 239
 240 SYNC_EXPORT_PRIVATE base::DictionaryValue* SyncedNotificationSpecificsToValue(
 241     const sync_pb::SyncedNotificationSpecifics&
 242     synced_notification_specifics);
 243
 244 SYNC_EXPORT_PRIVATE base::DictionaryValue* SearchEngineSpecificsToValue(
 245     const sync_pb::SearchEngineSpecifics& search_engine_specifics);
 246
 247 SYNC_EXPORT_PRIVATE base::DictionaryValue* ThemeSpecificsToValue(
 248     const sync_pb::ThemeSpecifics& theme_specifics);
 249
 250 SYNC_EXPORT_PRIVATE base::DictionaryValue* TypedUrlSpecificsToValue(
 251     const sync_pb::TypedUrlSpecifics& typed_url_specifics);
 252
 253 // Any present extensions are mapped to sub-dictionary values with the
 254 // key equal to the extension name.
 255 SYNC_EXPORT_PRIVATE base::DictionaryValue* EntitySpecificsToValue(
 256     const sync_pb::EntitySpecifics& specifics);
 257
 258 SYNC_EXPORT_PRIVATE base::DictionaryValue* ClientToServerMessageToValue(
 259     const sync_pb::ClientToServerMessage& proto,
 260     bool include_specifics);
 261
 262 SYNC_EXPORT_PRIVATE base::DictionaryValue* ClientToServerResponseToValue(
 263     const sync_pb::ClientToServerResponse& proto,
 264     bool include_specifics);
 265
 266 base::DictionaryValue* DatatypeAssociationStatsToValue(
 267     const sync_pb::DatatypeAssociationStats& proto);
 268
 269 base::DictionaryValue* DebugEventInfoToValue(
 270     const sync_pb::DebugEventInfo& proto);
 271
 272 base::DictionaryValue* DebugInfoToValue(
 273     const sync_pb::DebugInfo& proto);
 274
 275 base::DictionaryValue* SyncCycleCompletedEventInfoToValue(
 276     const sync_pb::SyncCycleCompletedEventInfo& proto);
 277
 278 base::DictionaryValue* ClientConfigParamsToValue(
 279     const sync_pb::ClientConfigParams& proto);
 280
 281 }  // namespace syncer
 282
 283 #endif  // SYNC_PROTOCOL_PROTO_VALUE_CONVERSIONS_H_