src/s11n-boost.h

   1 ///
   2 /// \file       s11n-boost.h
   3 ///             Non-intrusive versions of serialization functions for the
   4 ///             record classes.  These template functions make it possible
   5 ///             to use the record classes with the Boost::Serialization
   6 ///             library.
   7 ///
   8
   9 /*
  10     Copyright (C) 2005-2010, Net Direct Inc. (http://www.netdirect.ca/)
  11
  12     This program is free software; you can redistribute it and/or modify
  13     it under the terms of the GNU General Public License as published by
  14     the Free Software Foundation; either version 2 of the License, or
  15     (at your option) any later version.
  16
  17     This program is distributed in the hope that it will be useful,
  18     but WITHOUT ANY WARRANTY; without even the implied warranty of
  19     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  20
  21     See the GNU General Public License in the COPYING file at the
  22     root directory of this project for more details.
  23 */
  24
  25 #ifndef __BARRY_S11N_BOOST_H__
  26 #define __BARRY_S11N_BOOST_H__
  27
  28 #include "record.h"
  29 #include <boost/serialization/vector.hpp>
  30
  31 ///////////////////////////////////////////////////////////////////////////////
  32 // special versions
  33 //
  34 // BARRY_BASE_S11N_VERSION      - the base version where all record data is
  35 //                                stored so it can be fully retrieved and
  36 //                                uploaded to the handheld device later.
  37 // BARRY_POD_MAP_VERSION        - if these templates are called with a version
  38 //                                equal or greater than this, only mappable,
  39 //                                POD data is included in the serialization
  40 //
  41 #define BARRY_BASE_S11N_VERSION         0
  42 #define BARRY_POD_MAP_VERSION           1000
  43
  44 // namespace boost::serialization, for the non-intrusive version
  45 namespace boost {
  46 namespace serialization {
  47
  48 template <class ArchiveT>
  49 void serialize(ArchiveT &ar, Barry::UnknownField &uf, const unsigned int ver)
  50 {
  51         ar & make_nvp("type", uf.type);
  52         ar & make_nvp("data", uf.data.raw_data);
  53 }
  54
  55 template <class ArchiveT>
  56 void serialize(ArchiveT &ar, Barry::Contact::GroupLink &g, const unsigned int ver)
  57 {
  58         ar & make_nvp("Link", g.Link);
  59         ar & make_nvp("Unknown", g.Unknown);
  60 }
  61
  62 template <class ArchiveT>
  63 void serialize(ArchiveT &ar, Barry::CategoryList &cl, const unsigned int ver)
  64 {
  65         std::vector<std::string> &sl = cl;
  66         ar & make_nvp("CategoryList", sl);
  67 }
  68
  69 template <class ArchiveT>
  70 void serialize(ArchiveT &ar, Barry::Contact &c, const unsigned int ver)
  71 {
  72         ar & make_nvp("RecType", c.RecType);
  73         ar & make_nvp("RecordId", c.RecordId);
  74
  75         ar & make_nvp("EmailAddresses", c.EmailAddresses);
  76         ar & make_nvp("Phone", c.Phone);
  77         ar & make_nvp("Fax", c.Fax);
  78         ar & make_nvp("WorkPhone", c.WorkPhone);
  79         ar & make_nvp("HomePhone", c.HomePhone);
  80         ar & make_nvp("MobilePhone", c.MobilePhone);
  81         ar & make_nvp("Pager", c.Pager);
  82         ar & make_nvp("PIN", c.PIN);
  83         ar & make_nvp("Radio", c.Radio);
  84         ar & make_nvp("WorkPhone2", c.WorkPhone2);
  85         ar & make_nvp("HomePhone2", c.HomePhone2);
  86         ar & make_nvp("OtherPhone", c.OtherPhone);
  87         ar & make_nvp("FirstName", c.FirstName);
  88         ar & make_nvp("LastName", c.LastName);
  89         ar & make_nvp("Company", c.Company);
  90         ar & make_nvp("DefaultCommunicationsMethod", c.DefaultCommunicationsMethod);
  91         ar & make_nvp("Address1", c.WorkAddress.Address1);
  92         ar & make_nvp("Address2", c.WorkAddress.Address2);
  93         ar & make_nvp("Address3", c.WorkAddress.Address3);
  94         ar & make_nvp("City", c.WorkAddress.City);
  95         ar & make_nvp("Province", c.WorkAddress.Province);
  96         ar & make_nvp("PostalCode", c.WorkAddress.PostalCode);
  97         ar & make_nvp("Country", c.WorkAddress.Country);
  98         ar & make_nvp("JobTitle", c.JobTitle);
  99         ar & make_nvp("PublicKey", c.PublicKey);
 100         ar & make_nvp("URL", c.URL);
 101         ar & make_nvp("Prefix", c.Prefix);
 102         ar & make_nvp("Categories", c.Categories);
 103         ar & make_nvp("HomeAddress1", c.HomeAddress.Address1);
 104         ar & make_nvp("HomeAddress2", c.HomeAddress.Address2);
 105         ar & make_nvp("HomeAddress3", c.HomeAddress.Address3);
 106         ar & make_nvp("Notes", c.Notes);
 107         ar & make_nvp("UserDefined1", c.UserDefined1);
 108         ar & make_nvp("UserDefined2", c.UserDefined2);
 109         ar & make_nvp("UserDefined3", c.UserDefined3);
 110         ar & make_nvp("UserDefined4", c.UserDefined4);
 111         ar & make_nvp("HomeCity", c.HomeAddress.City);
 112         ar & make_nvp("HomeProvince", c.HomeAddress.Province);
 113         ar & make_nvp("HomePostalCode", c.HomeAddress.PostalCode);
 114         ar & make_nvp("HomeCountry", c.HomeAddress.Country);
 115         ar & make_nvp("Image", c.Image);
 116
 117         if( ver < BARRY_POD_MAP_VERSION ) {
 118                 ar & make_nvp("GroupLinks", c.GroupLinks);
 119                 ar & make_nvp("Unknowns", c.Unknowns);
 120         }
 121 }
 122
 123 template <class ArchiveT>
 124 void serialize(ArchiveT &ar, Barry::EmailAddress &a, const unsigned int ver)
 125 {
 126         ar & make_nvp("Name", a.Name);
 127         ar & make_nvp("Email", a.Email);
 128 }
 129
 130 template <class ArchiveT>
 131 void serialize(ArchiveT &ar, Barry::Message &m, const unsigned int ver)
 132 {
 133         ar & make_nvp("From", m.From);
 134         ar & make_nvp("To", m.To);
 135         ar & make_nvp("Cc", m.Cc);
 136         ar & make_nvp("Sender", m.Sender);
 137         ar & make_nvp("ReplyTo", m.ReplyTo);
 138         ar & make_nvp("Subject", m.Subject);
 139         ar & make_nvp("Body", m.Body);
 140         ar & make_nvp("Attachment", m.Attachment);
 141         ar & make_nvp("MessageRecordId", m.MessageRecordId);
 142         ar & make_nvp("MessageReplyTo", m.MessageReplyTo);
 143         ar & make_nvp("MessageDateSent", m.MessageDateSent);
 144         ar & make_nvp("MessageDateReceived", m.MessageDateReceived);
 145
 146         ar & make_nvp("MessageTruncated", m.MessageTruncated);
 147         ar & make_nvp("MessageRead", m.MessageRead);
 148         ar & make_nvp("MessageReply", m.MessageReply);
 149         ar & make_nvp("MessageSaved", m.MessageSaved);
 150         ar & make_nvp("MessageSavedDeleted", m.MessageSavedDeleted);
 151
 152         ar & make_nvp("MessagePriority", m.Priority);
 153         ar & make_nvp("MessageSensitivity", m.Sensitivity);
 154
 155         if( ver < BARRY_POD_MAP_VERSION ) {
 156                 ar & make_nvp("Unknowns", m.Unknowns);
 157         }
 158 }
 159
 160 template <class ArchiveT>
 161 void serialize(ArchiveT &ar, Barry::Calendar &c, const unsigned int ver)
 162 {
 163         ar & make_nvp("RecType", c.RecType);
 164         ar & make_nvp("RecordId", c.RecordId);
 165
 166         ar & make_nvp("AllDayEvent", c.AllDayEvent);
 167
 168         ar & make_nvp("Subject", c.Subject);
 169         ar & make_nvp("Notes", c.Notes);
 170         ar & make_nvp("Location", c.Location);
 171
 172         ar & make_nvp("NotificationTime", c.NotificationTime);
 173         ar & make_nvp("StartTime", c.StartTime);
 174         ar & make_nvp("EndTime", c.EndTime);
 175
 176         ar & make_nvp("Organizer", c.Organizer);
 177         ar & make_nvp("AcceptedBy", c.AcceptedBy);
 178         ar & make_nvp("Invited", c.Invited);
 179
 180         ar & make_nvp("FreeBusyFlag", c.FreeBusyFlag);
 181         ar & make_nvp("ClassFlag", c.ClassFlag);
 182
 183         ar & make_nvp("Recurring", c.Recurring);
 184         ar & make_nvp("RecurringType", c.RecurringType);
 185         ar & make_nvp("Interval", c.Interval);
 186         ar & make_nvp("RecurringEndTime", c.RecurringEndTime);
 187         ar & make_nvp("Perpetual", c.Perpetual);
 188         ar & make_nvp("CalendarID", c.CalendarID);
 189         ar & make_nvp("TimeZoneCode", c.TimeZoneCode);
 190         ar & make_nvp("TimeZoneValid", c.TimeZoneValid);
 191
 192         ar & make_nvp("DayOfWeek", c.DayOfWeek);
 193         ar & make_nvp("WeekOfMonth", c.WeekOfMonth);
 194         ar & make_nvp("DayOfMonth", c.DayOfMonth);
 195         ar & make_nvp("MonthOfYear", c.MonthOfYear);
 196         ar & make_nvp("WeekDays", c.WeekDays);
 197
 198         if( ver < BARRY_POD_MAP_VERSION ) {
 199                 ar & make_nvp("Unknowns", c.Unknowns);
 200         }
 201 }
 202
 203 template <class ArchiveT>
 204 void serialize(ArchiveT &ar, Barry::CalendarAll &c, const unsigned int ver)
 205 {
 206         serialize(ar, static_cast<Barry::Calendar&>(c), ver);
 207
 208         ar & make_nvp("MailAccount", c.MailAccount);
 209 }
 210
 211 template <class ArchiveT>
 212 void serialize(ArchiveT &ar, Barry::CallLog &c, const unsigned int ver)
 213 {
 214         ar & make_nvp("RecType", c.RecType);
 215         ar & make_nvp("RecordId", c.RecordId);
 216
 217         ar & make_nvp("Duration", c.Duration);
 218         ar & make_nvp("Timestamp", c.Timestamp);
 219         ar & make_nvp("ContactName", c.ContactName);
 220         ar & make_nvp("PhoneNumber", c.PhoneNumber);
 221
 222         ar & make_nvp("DirectionFlag", c.DirectionFlag);
 223         ar & make_nvp("StatusFlag", c.StatusFlag);
 224         ar & make_nvp("PhoneTypeFlag", c.PhoneTypeFlag);
 225         ar & make_nvp("PhoneInfoFlag", c.PhoneInfoFlag);
 226
 227         if( ver < BARRY_POD_MAP_VERSION ) {
 228                 ar & make_nvp("Unknowns", c.Unknowns);
 229         }
 230 }
 231
 232 template <class ArchiveT>
 233 void serialize(ArchiveT &ar, Barry::Bookmark &c, const unsigned int ver)
 234 {
 235         ar & make_nvp("RecType", c.RecType);
 236         ar & make_nvp("RecordId", c.RecordId);
 237
 238         ar & make_nvp("Name", c.Name);
 239         ar & make_nvp("URL", c.URL);
 240
 241         if( ver < BARRY_POD_MAP_VERSION ) {
 242                 ar & make_nvp("Unknowns", c.Unknowns);
 243         }
 244 }
 245
 246 template <class ArchiveT>
 247 void serialize(ArchiveT &ar, Barry::ServiceBookConfig &c, const unsigned int ver)
 248 {
 249         ar & make_nvp("Format", c.Format);
 250
 251         if( ver < BARRY_POD_MAP_VERSION ) {
 252                 ar & make_nvp("Unknowns", c.Unknowns);
 253         }
 254 }
 255
 256 template <class ArchiveT>
 257 void serialize(ArchiveT &ar, Barry::ServiceBook &c, const unsigned int ver)
 258 {
 259         ar & make_nvp("RecType", c.RecType);
 260         ar & make_nvp("RecordId", c.RecordId);
 261
 262         ar & make_nvp("Name", c.Name);
 263         ar & make_nvp("HiddenName", c.HiddenName);
 264         ar & make_nvp("Description", c.Description);
 265         ar & make_nvp("DSID", c.DSID);
 266         ar & make_nvp("BesDomain", c.BesDomain);
 267         ar & make_nvp("UniqueId", c.UniqueId);
 268         ar & make_nvp("ContentId", c.ContentId);
 269         ar & make_nvp("Config", c.Config);
 270
 271         if( ver < BARRY_POD_MAP_VERSION ) {
 272                 ar & make_nvp("Unknowns", c.Unknowns);
 273         }
 274 }
 275
 276 template <class ArchiveT>
 277 void serialize(ArchiveT &ar, Barry::Memo &m, const unsigned int ver)
 278 {
 279         ar & make_nvp("RecType", m.RecType);
 280         ar & make_nvp("RecordId", m.RecordId);
 281
 282         ar & make_nvp("Title", m.Title);
 283         ar & make_nvp("Body", m.Body);
 284         ar & make_nvp("Categories", m.Categories);
 285
 286         if( ver < BARRY_POD_MAP_VERSION ) {
 287                 ar & make_nvp( "Unknowns", m.Unknowns);
 288         }
 289 }
 290
 291 template <class ArchiveT>
 292 void serialize(ArchiveT &ar, Barry::Task &t, const unsigned int ver)
 293 {
 294         ar & make_nvp("RecType", t.RecType);
 295         ar & make_nvp("RecordId", t.RecordId);
 296
 297         ar & make_nvp("Summary", t.Summary);
 298         ar & make_nvp("Notes", t.Notes);
 299         ar & make_nvp("Categories", t.Categories);
 300         ar & make_nvp("UID", t.UID);
 301
 302         ar & make_nvp("StartTime", t.StartTime);
 303         ar & make_nvp("DueTime", t.DueTime);
 304         ar & make_nvp("AlarmTime", t.AlarmTime);
 305
 306         ar & make_nvp("TimeZoneCode", t.TimeZoneCode);
 307         ar & make_nvp("TimeZoneValid", t.TimeZoneValid);
 308
 309         ar & make_nvp("AlarmType", t.AlarmType);
 310         ar & make_nvp("Interval", t.Interval);
 311         ar & make_nvp("RecurringType", t.RecurringType);
 312         ar & make_nvp("RecurringEndTime", t.RecurringEndTime);
 313         ar & make_nvp("DayOfWeek", t.DayOfWeek);
 314         ar & make_nvp("WeekOfMonth", t.WeekOfMonth);
 315         ar & make_nvp("DayOfMonth", t.DayOfMonth);
 316         ar & make_nvp("MonthOfYear", t.MonthOfYear);
 317         ar & make_nvp("WeekDays", t.WeekDays);
 318
 319         ar & make_nvp("PriorityFlag", t.PriorityFlag);
 320         ar & make_nvp("StatusFlag", t.StatusFlag);
 321         ar & make_nvp("Recurring", t.Recurring);
 322         ar & make_nvp("Perpetual", t.Perpetual);
 323         ar & make_nvp("DueDateFlag", t.DueDateFlag);
 324
 325         if( ver < BARRY_POD_MAP_VERSION ) {
 326                 ar & make_nvp( "Unknowns", t.Unknowns);
 327         }
 328 }
 329
 330 template<class ArchiveT>
 331 void serialize(ArchiveT &ar, Barry::PINMessage &p, const unsigned int ver)
 332 {
 333         ar & make_nvp("RecType", p.RecType);
 334         ar & make_nvp("RecordId", p.RecordId);
 335
 336         ar & make_nvp("From", p.From);
 337         ar & make_nvp("To", p.To);
 338         ar & make_nvp("Cc", p.Cc);
 339         ar & make_nvp("Bcc", p.Bcc);
 340         ar & make_nvp("Subject", p.Subject);
 341         ar & make_nvp("Body", p.Body);
 342         ar & make_nvp("MessageRecordId", p.MessageRecordId);
 343         ar & make_nvp("MessageReplyTo", p.MessageReplyTo);
 344         ar & make_nvp("MessageDateSent", p.MessageDateSent);
 345         ar & make_nvp("MessageDateReceived", p.MessageDateReceived);
 346
 347         ar & make_nvp("MessageTruncated", p.MessageTruncated);
 348         ar & make_nvp("MessageRead", p.MessageRead);
 349         ar & make_nvp("MessageReply", p.MessageReply);
 350         ar & make_nvp("MessageSaved", p.MessageSaved);
 351         ar & make_nvp("MessageSavedDeleted", p.MessageSavedDeleted);
 352
 353         ar & make_nvp("MessagePriority", p.Priority);
 354         ar & make_nvp("MessageSensitivity", p.Sensitivity);
 355
 356         if(ver < BARRY_POD_MAP_VERSION) {
 357                 ar & make_nvp("Unknowns", p.Unknowns);
 358         }
 359 }
 360
 361 template <class ArchiveT>
 362 void serialize(ArchiveT &ar, Barry::SavedMessage &m, const unsigned int ver)
 363 {
 364         ar & make_nvp("RecType", m.RecType);
 365         ar & make_nvp("RecordId", m.RecordId);
 366
 367         ar & make_nvp("From", m.From);
 368         ar & make_nvp("To", m.To);
 369         ar & make_nvp("Cc", m.Cc);
 370         ar & make_nvp("Bcc", m.Bcc);
 371         ar & make_nvp("Sender", m.Sender);
 372         ar & make_nvp("ReplyTo", m.ReplyTo);
 373         ar & make_nvp("Subject", m.Subject);
 374         ar & make_nvp("Body", m.Body);
 375         ar & make_nvp("Attachment", m.Attachment);
 376         ar & make_nvp("MessageRecordId", m.MessageRecordId);
 377         ar & make_nvp("MessageReplyTo", m.MessageReplyTo);
 378         ar & make_nvp("MessageDateSent", m.MessageDateSent);
 379         ar & make_nvp("MessageDateReceived", m.MessageDateReceived);
 380
 381         ar & make_nvp("MessageTruncated", m.MessageTruncated);
 382         ar & make_nvp("MessageRead", m.MessageRead);
 383         ar & make_nvp("MessageReply", m.MessageReply);
 384         ar & make_nvp("MessageSaved", m.MessageSaved);
 385         ar & make_nvp("MessageSavedDeleted", m.MessageSavedDeleted);
 386
 387         ar & make_nvp("MessagePriority", m.Priority);
 388         ar & make_nvp("MessageSensitivity", m.Sensitivity);
 389
 390         if( ver < BARRY_POD_MAP_VERSION ) {
 391                 ar & make_nvp("Unknowns", m.Unknowns);
 392         }
 393 }
 394
 395 template <class ArchiveT>
 396 void serialize(ArchiveT &ar, Barry::Sms &m, const unsigned int ver)
 397 {
 398         ar & make_nvp("RecType", m.RecType);
 399         ar & make_nvp("RecordId", m.RecordId);
 400
 401         ar & make_nvp("MessageStatus", m.MessageStatus);
 402         ar & make_nvp("DeliveryStatus", m.DeliveryStatus);
 403
 404         ar & make_nvp("IsNew", m.IsNew);
 405         ar & make_nvp("NewConversation", m.NewConversation);
 406         ar & make_nvp("Saved", m.Saved);
 407         ar & make_nvp("Deleted", m.Deleted);
 408         ar & make_nvp("Opened", m.Opened);
 409
 410         ar & make_nvp("Timestamp", m.Timestamp);
 411         ar & make_nvp("ServiceCenterTimestamp", m.ServiceCenterTimestamp);
 412
 413         ar & make_nvp("DataCodingScheme", m.DataCodingScheme);
 414         ar & make_nvp("ErrorId", m.ErrorId);
 415
 416         ar & make_nvp("Addresses", m.Addresses);
 417         ar & make_nvp("Body", m.Body);
 418
 419         if( ver < BARRY_POD_MAP_VERSION ) {
 420                 ar & make_nvp("Unknowns", m.Unknowns);
 421         }
 422 }
 423
 424 template <class ArchiveT>
 425 void serialize(ArchiveT &ar, Barry::Folder &f, const unsigned int ver)
 426 {
 427         ar & make_nvp("RecType", f.RecType);
 428         ar & make_nvp("RecordId", f.RecordId);
 429
 430         ar & make_nvp("FolderName", f.Name);
 431         ar & make_nvp("FolderNumber", f.Number);
 432         ar & make_nvp("FolderLevel", f.Level);
 433         ar & make_nvp("FolderType", f.Type);
 434
 435         if( ver < BARRY_POD_MAP_VERSION ) {
 436                 ar & make_nvp( "Unknowns", f.Unknowns);
 437         }
 438 }
 439
 440 template <class ArchiveT>
 441 void serialize(ArchiveT &ar, Barry::Timezone &t, const unsigned int ver)
 442 {
 443         ar & make_nvp("RecType", t.RecType);
 444         ar & make_nvp("RecordId", t.RecordId);
 445
 446         ar & make_nvp("TZType", t.TZType);
 447         ar & make_nvp("DSTOffset", t.DSTOffset);
 448         ar & make_nvp("Index", t.Index);
 449         ar & make_nvp("Offset", t.Offset);
 450         ar & make_nvp("OffsetFraction", t.OffsetFraction);
 451         ar & make_nvp("StartMonth", t.StartMonth);
 452         ar & make_nvp("EndMonth", t.EndMonth);
 453         ar & make_nvp("Left", t.Left);
 454         ar & make_nvp("UseDST", t.UseDST);
 455
 456         ar & make_nvp("TimeZoneName", t.TimeZoneName);
 457
 458         if( ver < BARRY_POD_MAP_VERSION ) {
 459                 ar & make_nvp("Unknowns", t.Unknowns);
 460         }
 461 }
 462
 463 }} // namespace boost::serialization
 464
 465 #endif
 466