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