fix doc example typo
[boost.git] / boost / archive / xml_iarchive.hpp
blobac188e903308e5dfdf89c8ab0171bdc3d3d03e83
1 #ifndef BOOST_ARCHIVE_XML_IARCHIVE_HPP
2 #define BOOST_ARCHIVE_XML_IARCHIVE_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 // xml_iarchive.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 #include <istream>
21 //#include <boost/scoped_ptr.hpp>
22 #include <boost/archive/detail/auto_link_archive.hpp>
23 #include <boost/archive/basic_text_iprimitive.hpp>
24 #include <boost/archive/basic_xml_iarchive.hpp>
26 #include <boost/archive/detail/abi_prefix.hpp> // must be the last header
28 namespace boost {
29 namespace archive {
31 template<class CharType>
32 class basic_xml_grammar;
33 typedef basic_xml_grammar<char> xml_grammar;
35 template<class Archive>
36 class xml_iarchive_impl :
37 public basic_text_iprimitive<std::istream>,
38 public basic_xml_iarchive<Archive>
40 #ifdef BOOST_NO_MEMBER_TEMPLATE_FRIENDS
41 public:
42 #else
43 friend class detail::interface_iarchive<Archive>;
44 friend class basic_xml_iarchive<Archive>;
45 friend class load_access;
46 protected:
47 #endif
48 // instances of micro xml parser to parse start preambles
49 // scoped_ptr doesn't play nice with borland - so use a naked pointer
50 // scoped_ptr<xml_grammar> gimpl;
51 xml_grammar *gimpl;
53 std::istream & get_is(){
54 return is;
56 template<class T>
57 void load(T & t){
58 basic_text_iprimitive<std::istream>::load(t);
60 BOOST_ARCHIVE_DECL(void)
61 load(char * t);
62 #ifndef BOOST_NO_INTRINSIC_WCHAR_T
63 BOOST_ARCHIVE_DECL(void)
64 load(wchar_t * t);
65 #endif
66 BOOST_ARCHIVE_DECL(void)
67 load(std::string &s);
68 #ifndef BOOST_NO_STD_WSTRING
69 BOOST_ARCHIVE_DECL(void)
70 load(std::wstring &ws);
71 #endif
72 template<class T>
73 void load_override(T & t, BOOST_PFTO int){
74 basic_xml_iarchive<Archive>::load_override(t, 0);
76 BOOST_ARCHIVE_DECL(void)
77 load_override(class_name_type & t, int);
78 BOOST_ARCHIVE_DECL(void)
79 init();
80 BOOST_ARCHIVE_DECL(BOOST_PP_EMPTY())
81 xml_iarchive_impl(std::istream & is, unsigned int flags);
82 BOOST_ARCHIVE_DECL(BOOST_PP_EMPTY())
83 ~xml_iarchive_impl();
86 // do not derive from the classes below. If you want to extend this functionality
87 // via inhertance, derived from text_iarchive_impl instead. This will
88 // preserve correct static polymorphism.
90 // same as xml_iarchive below - without the shared_ptr_helper
91 class naked_xml_iarchive :
92 public xml_iarchive_impl<naked_xml_iarchive>
94 public:
95 naked_xml_iarchive(std::istream & is, unsigned int flags = 0) :
96 xml_iarchive_impl<naked_xml_iarchive>(is, flags)
98 ~naked_xml_iarchive(){}
101 } // namespace archive
102 } // namespace boost
104 // note special treatment of shared_ptr. This type needs a special
105 // structure associated with every archive. We created a "mix-in"
106 // class to provide this functionality. Since shared_ptr holds a
107 // special esteem in the boost library - we included it here by default.
108 #include <boost/archive/shared_ptr_helper.hpp>
110 namespace boost {
111 namespace archive {
113 class xml_iarchive :
114 public xml_iarchive_impl<xml_iarchive>,
115 public detail::shared_ptr_helper
117 public:
118 xml_iarchive(std::istream & is, unsigned int flags = 0) :
119 xml_iarchive_impl<xml_iarchive>(is, flags)
121 ~xml_iarchive(){};
124 } // namespace archive
125 } // namespace boost
127 // required by export
128 BOOST_SERIALIZATION_REGISTER_ARCHIVE(boost::archive::xml_iarchive)
130 #include <boost/archive/detail/abi_suffix.hpp> // pops abi_suffix.hpp pragmas
132 #endif // BOOST_ARCHIVE_XML_IARCHIVE_HPP