1 #ifndef GREGORIAN_SERIALIZE_HPP___
2 #define GREGORIAN_SERIALIZE_HPP___
4 /* Copyright (c) 2004-2005 CrystalClear Software, Inc.
5 * Use, modification and distribution is subject to the
6 * Boost Software License, Version 1.0. (See accompanying
7 * file LICENSE_1_0.txt or http://www.boost.org/LICENSE_1_0.txt)
8 * Author: Jeff Garland, Bart Garst
12 #include "boost/date_time/gregorian/gregorian_types.hpp"
13 #include "boost/date_time/gregorian/parsers.hpp"
14 #include "boost/core/nvp.hpp"
20 std::string to_iso_string(const date&);
23 namespace serialization {
25 // A macro to split serialize functions into save & load functions.
26 // It is here to avoid dependency on Boost.Serialization just for the
27 // BOOST_SERIALIZATION_SPLIT_FREE macro
28 #define BOOST_DATE_TIME_SPLIT_FREE(T) \
29 template<class Archive> \
30 inline void serialize(Archive & ar, \
32 const unsigned int file_version) \
34 split_free(ar, t, file_version); \
37 /*! Method that does serialization for gregorian::date -- splits to load/save
39 BOOST_DATE_TIME_SPLIT_FREE(::boost::gregorian::date)
40 BOOST_DATE_TIME_SPLIT_FREE(::boost::gregorian::date_duration)
41 BOOST_DATE_TIME_SPLIT_FREE(::boost::gregorian::date_duration::duration_rep)
42 BOOST_DATE_TIME_SPLIT_FREE(::boost::gregorian::date_period)
43 BOOST_DATE_TIME_SPLIT_FREE(::boost::gregorian::greg_year)
44 BOOST_DATE_TIME_SPLIT_FREE(::boost::gregorian::greg_month)
45 BOOST_DATE_TIME_SPLIT_FREE(::boost::gregorian::greg_day)
46 BOOST_DATE_TIME_SPLIT_FREE(::boost::gregorian::greg_weekday)
47 BOOST_DATE_TIME_SPLIT_FREE(::boost::gregorian::partial_date)
48 BOOST_DATE_TIME_SPLIT_FREE(::boost::gregorian::nth_kday_of_month)
49 BOOST_DATE_TIME_SPLIT_FREE(::boost::gregorian::first_kday_of_month)
50 BOOST_DATE_TIME_SPLIT_FREE(::boost::gregorian::last_kday_of_month)
51 BOOST_DATE_TIME_SPLIT_FREE(::boost::gregorian::first_kday_before)
52 BOOST_DATE_TIME_SPLIT_FREE(::boost::gregorian::first_kday_after)
54 #undef BOOST_DATE_TIME_SPLIT_FREE
56 //! Function to save gregorian::date objects using serialization lib
57 /*! Dates are serialized into a string for transport and storage.
58 * While it would be more efficient to store the internal
59 * integer used to manipulate the dates, it is an unstable solution.
61 template<class Archive>
62 void save(Archive & ar,
63 const ::boost::gregorian::date & d,
64 unsigned int /* version */)
66 std::string ds = to_iso_string(d);
67 ar & make_nvp("date", ds);
70 //! Function to load gregorian::date objects using serialization lib
71 /*! Dates are serialized into a string for transport and storage.
72 * While it would be more efficient to store the internal
73 * integer used to manipulate the dates, it is an unstable solution.
75 template<class Archive>
76 void load(Archive & ar,
77 ::boost::gregorian::date & d,
78 unsigned int /*version*/)
81 ar & make_nvp("date", ds);
83 d = ::boost::gregorian::from_undelimited_string(ds);
84 }catch(bad_lexical_cast&) {
85 gregorian::special_values sv = gregorian::special_value_from_string(ds);
86 if(sv == gregorian::not_special) {
87 throw; // no match found, rethrow original exception
90 d = gregorian::date(sv);
96 //!override needed b/c no default constructor
97 template<class Archive>
98 inline void load_construct_data(Archive & /*ar*/,
99 ::boost::gregorian::date* dp,
100 const unsigned int /*file_version*/)
102 // retrieve data from archive required to construct new
103 // invoke inplace constructor to initialize instance of date
104 ::new(dp) ::boost::gregorian::date(::boost::gregorian::not_a_date_time);
107 /**** date_duration ****/
109 //! Function to save gregorian::date_duration objects using serialization lib
110 template<class Archive>
111 void save(Archive & ar, const gregorian::date_duration & dd,
112 unsigned int /*version*/)
114 typename gregorian::date_duration::duration_rep dr = dd.get_rep();
115 ar & make_nvp("date_duration", dr);
117 //! Function to load gregorian::date_duration objects using serialization lib
118 template<class Archive>
119 void load(Archive & ar, gregorian::date_duration & dd, unsigned int /*version*/)
121 typename gregorian::date_duration::duration_rep dr(0);
122 ar & make_nvp("date_duration", dr);
123 dd = gregorian::date_duration(dr);
125 //!override needed b/c no default constructor
126 template<class Archive>
127 inline void load_construct_data(Archive & /*ar*/, gregorian::date_duration* dd,
128 const unsigned int /*file_version*/)
130 ::new(dd) gregorian::date_duration(gregorian::not_a_date_time);
133 /**** date_duration::duration_rep (most likely int_adapter) ****/
135 //! helper unction to save date_duration objects using serialization lib
136 template<class Archive>
137 void save(Archive & ar, const gregorian::date_duration::duration_rep & dr,
138 unsigned int /*version*/)
140 typename gregorian::date_duration::duration_rep::int_type it = dr.as_number();
141 ar & make_nvp("date_duration_duration_rep", it);
143 //! helper function to load date_duration objects using serialization lib
144 template<class Archive>
145 void load(Archive & ar, gregorian::date_duration::duration_rep & dr, unsigned int /*version*/)
147 typename gregorian::date_duration::duration_rep::int_type it(0);
148 ar & make_nvp("date_duration_duration_rep", it);
149 dr = gregorian::date_duration::duration_rep::int_type(it);
151 //!override needed b/c no default constructor
152 template<class Archive>
153 inline void load_construct_data(Archive & /*ar*/, gregorian::date_duration::duration_rep* dr,
154 const unsigned int /*file_version*/)
156 ::new(dr) gregorian::date_duration::duration_rep(0);
159 /**** date_period ****/
161 //! Function to save gregorian::date_period objects using serialization lib
162 /*! date_period objects are broken down into 2 parts for serialization:
163 * the begining date object and the end date object
165 template<class Archive>
166 void save(Archive & ar, const gregorian::date_period& dp,
167 unsigned int /*version*/)
169 gregorian::date d1 = dp.begin();
170 gregorian::date d2 = dp.end();
171 ar & make_nvp("date_period_begin_date", d1);
172 ar & make_nvp("date_period_end_date", d2);
174 //! Function to load gregorian::date_period objects using serialization lib
175 /*! date_period objects are broken down into 2 parts for serialization:
176 * the begining date object and the end date object
178 template<class Archive>
179 void load(Archive & ar, gregorian::date_period& dp, unsigned int /*version*/)
181 gregorian::date d1(gregorian::not_a_date_time);
182 gregorian::date d2(gregorian::not_a_date_time);
183 ar & make_nvp("date_period_begin_date", d1);
184 ar & make_nvp("date_period_end_date", d2);
185 dp = gregorian::date_period(d1,d2);
187 //!override needed b/c no default constructor
188 template<class Archive>
189 inline void load_construct_data(Archive & /*ar*/, gregorian::date_period* dp,
190 const unsigned int /*file_version*/)
192 gregorian::date d(gregorian::not_a_date_time);
193 gregorian::date_duration dd(1);
194 ::new(dp) gregorian::date_period(d,dd);
197 /**** greg_year ****/
199 //! Function to save gregorian::greg_year objects using serialization lib
200 template<class Archive>
201 void save(Archive & ar, const gregorian::greg_year& gy,
202 unsigned int /*version*/)
204 unsigned short us = gy;
205 ar & make_nvp("greg_year", us);
207 //! Function to load gregorian::greg_year objects using serialization lib
208 template<class Archive>
209 void load(Archive & ar, gregorian::greg_year& gy, unsigned int /*version*/)
212 ar & make_nvp("greg_year", us);
213 gy = gregorian::greg_year(us);
215 //!override needed b/c no default constructor
216 template<class Archive>
217 inline void load_construct_data(Archive & /*ar*/, gregorian::greg_year* gy,
218 const unsigned int /*file_version*/)
220 ::new(gy) gregorian::greg_year(1900);
223 /**** greg_month ****/
225 //! Function to save gregorian::greg_month objects using serialization lib
226 template<class Archive>
227 void save(Archive & ar, const gregorian::greg_month& gm,
228 unsigned int /*version*/)
230 unsigned short us = gm.as_number();
231 ar & make_nvp("greg_month", us);
233 //! Function to load gregorian::greg_month objects using serialization lib
234 template<class Archive>
235 void load(Archive & ar, gregorian::greg_month& gm, unsigned int /*version*/)
238 ar & make_nvp("greg_month", us);
239 gm = gregorian::greg_month(us);
241 //!override needed b/c no default constructor
242 template<class Archive>
243 inline void load_construct_data(Archive & /*ar*/, gregorian::greg_month* gm,
244 const unsigned int /*file_version*/)
246 ::new(gm) gregorian::greg_month(1);
251 //! Function to save gregorian::greg_day objects using serialization lib
252 template<class Archive>
253 void save(Archive & ar, const gregorian::greg_day& gd,
254 unsigned int /*version*/)
256 unsigned short us = gd.as_number();
257 ar & make_nvp("greg_day", us);
259 //! Function to load gregorian::greg_day objects using serialization lib
260 template<class Archive>
261 void load(Archive & ar, gregorian::greg_day& gd, unsigned int /*version*/)
264 ar & make_nvp("greg_day", us);
265 gd = gregorian::greg_day(us);
267 //!override needed b/c no default constructor
268 template<class Archive>
269 inline void load_construct_data(Archive & /*ar*/, gregorian::greg_day* gd,
270 const unsigned int /*file_version*/)
272 ::new(gd) gregorian::greg_day(1);
275 /**** greg_weekday ****/
277 //! Function to save gregorian::greg_weekday objects using serialization lib
278 template<class Archive>
279 void save(Archive & ar, const gregorian::greg_weekday& gd,
280 unsigned int /*version*/)
282 unsigned short us = gd.as_number();
283 ar & make_nvp("greg_weekday", us);
285 //! Function to load gregorian::greg_weekday objects using serialization lib
286 template<class Archive>
287 void load(Archive & ar, gregorian::greg_weekday& gd, unsigned int /*version*/)
290 ar & make_nvp("greg_weekday", us);
291 gd = gregorian::greg_weekday(us);
293 //!override needed b/c no default constructor
294 template<class Archive>
295 inline void load_construct_data(Archive & /*ar*/, gregorian::greg_weekday* gd,
296 const unsigned int /*file_version*/)
298 ::new(gd) gregorian::greg_weekday(1);
301 /**** date_generators ****/
303 /**** partial_date ****/
305 //! Function to save gregorian::partial_date objects using serialization lib
306 /*! partial_date objects are broken down into 2 parts for serialization:
307 * the day (typically greg_day) and month (typically greg_month) objects
309 template<class Archive>
310 void save(Archive & ar, const gregorian::partial_date& pd,
311 unsigned int /*version*/)
313 gregorian::greg_day gd(pd.day());
314 gregorian::greg_month gm(pd.month().as_number());
315 ar & make_nvp("partial_date_day", gd);
316 ar & make_nvp("partial_date_month", gm);
318 //! Function to load gregorian::partial_date objects using serialization lib
319 /*! partial_date objects are broken down into 2 parts for serialization:
320 * the day (greg_day) and month (greg_month) objects
322 template<class Archive>
323 void load(Archive & ar, gregorian::partial_date& pd, unsigned int /*version*/)
325 gregorian::greg_day gd(1);
326 gregorian::greg_month gm(1);
327 ar & make_nvp("partial_date_day", gd);
328 ar & make_nvp("partial_date_month", gm);
329 pd = gregorian::partial_date(gd,gm);
331 //!override needed b/c no default constructor
332 template<class Archive>
333 inline void load_construct_data(Archive & /*ar*/, gregorian::partial_date* pd,
334 const unsigned int /*file_version*/)
336 gregorian::greg_month gm(1);
337 gregorian::greg_day gd(1);
338 ::new(pd) gregorian::partial_date(gd,gm);
341 /**** nth_kday_of_month ****/
343 //! Function to save nth_day_of_the_week_in_month objects using serialization lib
344 /*! nth_day_of_the_week_in_month objects are broken down into 3 parts for
345 * serialization: the week number, the day of the week, and the month
347 template<class Archive>
348 void save(Archive & ar, const gregorian::nth_kday_of_month& nkd,
349 unsigned int /*version*/)
351 typename gregorian::nth_kday_of_month::week_num wn(nkd.nth_week());
352 typename gregorian::nth_kday_of_month::day_of_week_type d(nkd.day_of_week().as_number());
353 typename gregorian::nth_kday_of_month::month_type m(nkd.month().as_number());
354 ar & make_nvp("nth_kday_of_month_week_num", wn);
355 ar & make_nvp("nth_kday_of_month_day_of_week", d);
356 ar & make_nvp("nth_kday_of_month_month", m);
358 //! Function to load nth_day_of_the_week_in_month objects using serialization lib
359 /*! nth_day_of_the_week_in_month objects are broken down into 3 parts for
360 * serialization: the week number, the day of the week, and the month
362 template<class Archive>
363 void load(Archive & ar, gregorian::nth_kday_of_month& nkd, unsigned int /*version*/)
365 typename gregorian::nth_kday_of_month::week_num wn(gregorian::nth_kday_of_month::first);
366 typename gregorian::nth_kday_of_month::day_of_week_type d(gregorian::Monday);
367 typename gregorian::nth_kday_of_month::month_type m(gregorian::Jan);
368 ar & make_nvp("nth_kday_of_month_week_num", wn);
369 ar & make_nvp("nth_kday_of_month_day_of_week", d);
370 ar & make_nvp("nth_kday_of_month_month", m);
372 nkd = gregorian::nth_kday_of_month(wn,d,m);
374 //!override needed b/c no default constructor
375 template<class Archive>
376 inline void load_construct_data(Archive & /*ar*/,
377 gregorian::nth_kday_of_month* nkd,
378 const unsigned int /*file_version*/)
380 // values used are not significant
381 ::new(nkd) gregorian::nth_kday_of_month(gregorian::nth_kday_of_month::first,
382 gregorian::Monday,gregorian::Jan);
385 /**** first_kday_of_month ****/
387 //! Function to save first_day_of_the_week_in_month objects using serialization lib
388 /*! first_day_of_the_week_in_month objects are broken down into 2 parts for
389 * serialization: the day of the week, and the month
391 template<class Archive>
392 void save(Archive & ar, const gregorian::first_kday_of_month& fkd,
393 unsigned int /*version*/)
395 typename gregorian::first_kday_of_month::day_of_week_type d(fkd.day_of_week().as_number());
396 typename gregorian::first_kday_of_month::month_type m(fkd.month().as_number());
397 ar & make_nvp("first_kday_of_month_day_of_week", d);
398 ar & make_nvp("first_kday_of_month_month", m);
400 //! Function to load first_day_of_the_week_in_month objects using serialization lib
401 /*! first_day_of_the_week_in_month objects are broken down into 2 parts for
402 * serialization: the day of the week, and the month
404 template<class Archive>
405 void load(Archive & ar, gregorian::first_kday_of_month& fkd, unsigned int /*version*/)
407 typename gregorian::first_kday_of_month::day_of_week_type d(gregorian::Monday);
408 typename gregorian::first_kday_of_month::month_type m(gregorian::Jan);
409 ar & make_nvp("first_kday_of_month_day_of_week", d);
410 ar & make_nvp("first_kday_of_month_month", m);
412 fkd = gregorian::first_kday_of_month(d,m);
414 //!override needed b/c no default constructor
415 template<class Archive>
416 inline void load_construct_data(Archive & /*ar*/,
417 gregorian::first_kday_of_month* fkd,
418 const unsigned int /*file_version*/)
420 // values used are not significant
421 ::new(fkd) gregorian::first_kday_of_month(gregorian::Monday,gregorian::Jan);
424 /**** last_kday_of_month ****/
426 //! Function to save last_day_of_the_week_in_month objects using serialization lib
427 /*! last_day_of_the_week_in_month objects are broken down into 2 parts for
428 * serialization: the day of the week, and the month
430 template<class Archive>
431 void save(Archive & ar, const gregorian::last_kday_of_month& lkd,
432 unsigned int /*version*/)
434 typename gregorian::last_kday_of_month::day_of_week_type d(lkd.day_of_week().as_number());
435 typename gregorian::last_kday_of_month::month_type m(lkd.month().as_number());
436 ar & make_nvp("last_kday_of_month_day_of_week", d);
437 ar & make_nvp("last_kday_of_month_month", m);
439 //! Function to load last_day_of_the_week_in_month objects using serialization lib
440 /*! last_day_of_the_week_in_month objects are broken down into 2 parts for
441 * serialization: the day of the week, and the month
443 template<class Archive>
444 void load(Archive & ar, gregorian::last_kday_of_month& lkd, unsigned int /*version*/)
446 typename gregorian::last_kday_of_month::day_of_week_type d(gregorian::Monday);
447 typename gregorian::last_kday_of_month::month_type m(gregorian::Jan);
448 ar & make_nvp("last_kday_of_month_day_of_week", d);
449 ar & make_nvp("last_kday_of_month_month", m);
451 lkd = gregorian::last_kday_of_month(d,m);
453 //!override needed b/c no default constructor
454 template<class Archive>
455 inline void load_construct_data(Archive & /*ar*/,
456 gregorian::last_kday_of_month* lkd,
457 const unsigned int /*file_version*/)
459 // values used are not significant
460 ::new(lkd) gregorian::last_kday_of_month(gregorian::Monday,gregorian::Jan);
463 /**** first_kday_before ****/
465 //! Function to save first_day_of_the_week_before objects using serialization lib
466 template<class Archive>
467 void save(Archive & ar, const gregorian::first_kday_before& fkdb,
468 unsigned int /*version*/)
470 typename gregorian::first_kday_before::day_of_week_type d(fkdb.day_of_week().as_number());
471 ar & make_nvp("first_kday_before_day_of_week", d);
473 //! Function to load first_day_of_the_week_before objects using serialization lib
474 template<class Archive>
475 void load(Archive & ar, gregorian::first_kday_before& fkdb, unsigned int /*version*/)
477 typename gregorian::first_kday_before::day_of_week_type d(gregorian::Monday);
478 ar & make_nvp("first_kday_before_day_of_week", d);
480 fkdb = gregorian::first_kday_before(d);
482 //!override needed b/c no default constructor
483 template<class Archive>
484 inline void load_construct_data(Archive & /*ar*/,
485 gregorian::first_kday_before* fkdb,
486 const unsigned int /*file_version*/)
488 // values used are not significant
489 ::new(fkdb) gregorian::first_kday_before(gregorian::Monday);
492 /**** first_kday_after ****/
494 //! Function to save first_day_of_the_week_after objects using serialization lib
495 template<class Archive>
496 void save(Archive & ar, const gregorian::first_kday_after& fkda,
497 unsigned int /*version*/)
499 typename gregorian::first_kday_after::day_of_week_type d(fkda.day_of_week().as_number());
500 ar & make_nvp("first_kday_after_day_of_week", d);
502 //! Function to load first_day_of_the_week_after objects using serialization lib
503 template<class Archive>
504 void load(Archive & ar, gregorian::first_kday_after& fkda, unsigned int /*version*/)
506 typename gregorian::first_kday_after::day_of_week_type d(gregorian::Monday);
507 ar & make_nvp("first_kday_after_day_of_week", d);
509 fkda = gregorian::first_kday_after(d);
511 //!override needed b/c no default constructor
512 template<class Archive>
513 inline void load_construct_data(Archive & /*ar*/,
514 gregorian::first_kday_after* fkda,
515 const unsigned int /*file_version*/)
517 // values used are not significant
518 ::new(fkda) gregorian::first_kday_after(gregorian::Monday);
521 } // namespace serialization