fix doc example typo
[boost.git] / boost / archive / basic_text_oarchive.hpp
blob4fd55f0694c31745e4286267bb49667ac5208651
1 #ifndef BOOST_ARCHIVE_BASIC_TEXT_OARCHIVE_HPP
2 #define BOOST_ARCHIVE_BASIC_TEXT_OARCHIVE_HPP
4 // MS compatible compilers support #pragma once
5 #if defined(_MSC_VER) && (_MSC_VER >= 1020)
6 # pragma once
7 #endif
9 /////////1/////////2/////////3/////////4/////////5/////////6/////////7/////////8
10 // basic_text_oarchive.hpp
12 // (C) Copyright 2002 Robert Ramey - http://www.rrsd.com .
13 // Use, modification and distribution is subject to the Boost Software
14 // License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
15 // http://www.boost.org/LICENSE_1_0.txt)
17 // See http://www.boost.org for updates, documentation, and revision history.
19 // archives stored as text - note these ar templated on the basic
20 // stream templates to accommodate wide (and other?) kind of characters
22 // note the fact that on libraries without wide characters, ostream is
23 // is not a specialization of basic_ostream which in fact is not defined
24 // in such cases. So we can't use basic_ostream<OStream::char_type> but rather
25 // use two template parameters
27 #include <cassert>
28 #include <boost/config.hpp>
29 #include <boost/serialization/pfto.hpp>
30 #include <boost/detail/workaround.hpp>
32 #include <boost/archive/detail/common_oarchive.hpp>
33 #include <boost/serialization/string.hpp>
35 #include <boost/archive/detail/abi_prefix.hpp> // must be the last header
37 namespace boost {
38 namespace archive {
40 /////////////////////////////////////////////////////////////////////////
41 // class basic_text_oarchive
42 template<class Archive>
43 class basic_text_oarchive :
44 public detail::common_oarchive<Archive>
46 protected:
47 #if BOOST_WORKAROUND(BOOST_MSVC, <= 1300) \
48 || BOOST_WORKAROUND(__BORLANDC__,BOOST_TESTED_AT(0x560))
49 public:
50 #elif defined(BOOST_MSVC)
51 // for some inexplicable reason insertion of "class" generates compile erro
52 // on msvc 7.1
53 friend detail::interface_oarchive<Archive>;
54 #else
55 friend class detail::interface_oarchive<Archive>;
56 #endif
57 enum {
58 none,
59 eol,
60 space
61 } delimiter;
63 BOOST_ARCHIVE_OR_WARCHIVE_DECL(void)
64 newtoken();
66 void newline(){
67 delimiter = eol;
70 // default processing - kick back to base class. Note the
71 // extra stuff to get it passed borland compilers
72 typedef detail::common_oarchive<Archive> detail_common_oarchive;
73 template<class T>
74 void save_override(T & t, BOOST_PFTO int){
75 this->detail_common_oarchive::save_override(t, 0);
78 // start new objects on a new line
79 void save_override(const object_id_type & t, int){
80 this->This()->newline();
81 // note extra .t to funciton with Borland 5.51 compiler
82 // and invoke prmitive to underlying value
83 this->This()->save(t.t);
86 void save_override(const object_reference_type & t, int){
87 this->This()->newline();
88 // note extra .t to funciton with Borland 5.51 compiler
89 // and invoke prmitive to underlying value
90 this->This()->save(t.t);
93 // note the following four overrides are necessary for some borland
94 // compilers(5.51) which don't handle BOOST_STRONG_TYPE properly.
95 void save_override(const version_type & t, int){
96 // note:t.t resolves borland ambguity
97 const unsigned int x = t.t;
98 * this->This() << x;
100 void save_override(const class_id_type & t, int){
101 // note:t.t resolves borland ambguity
102 const int x = t.t;
103 * this->This() << x;
105 void save_override(const class_id_reference_type & t, int){
106 // note:t.t resolves borland ambguity
107 const int x = t.t;
108 * this->This() << x;
111 // text file don't include the optional information
112 void save_override(const class_id_optional_type & /* t */, int){}
114 void save_override(const class_name_type & t, int){
115 const std::string s(t);
116 * this->This() << s;
119 BOOST_ARCHIVE_OR_WARCHIVE_DECL(void)
120 init();
122 basic_text_oarchive(unsigned int flags) :
123 detail::common_oarchive<Archive>(flags),
124 delimiter(none)
126 ~basic_text_oarchive(){}
129 } // namespace archive
130 } // namespace boost
132 #include <boost/archive/detail/abi_suffix.hpp> // pops abi_suffix.hpp pragmas
134 #endif // BOOST_ARCHIVE_BASIC_TEXT_OARCHIVE_HPP