]>
Dogcows Code - chaz/yoink/blob - src/Moof/Serializer.hh
2 /*******************************************************************************
4 Copyright (c) 2009, Charles McGarvey
7 Redistribution and use in source and binary forms, with or without
8 modification, are permitted provided that the following conditions are met:
10 * Redistributions of source code must retain the above copyright notice,
11 this list of conditions and the following disclaimer.
12 * Redistributions in binary form must reproduce the above copyright notice,
13 this list of conditions and the following disclaimer in the documentation
14 and/or other materials provided with the distribution.
16 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
20 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
23 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *******************************************************************************/
29 #ifndef _MOOF_SERIALIZER_HH_
30 #define _MOOF_SERIALIZER_HH_
34 * Serialize structures and types for output on a stream.
41 #include <boost/shared_ptr.hpp>
43 #include <Moof/Exception.hh>
52 boost::shared_ptr
<Impl
> impl_
;
57 * Construction is initialization. Use either an output stream or a string
58 * representing a path to a fill to which the serialized data will be
59 * written (replacing any previous file).
60 * @param indent If non-empty, the string's characters will be used as
61 * indentation. Otherwise, the serialized data will not be formatted neatly
62 * but will be tightly packed.
65 Serializer(const std::string
& filePath
, const std::string
& indent
= "");
66 Serializer(std::ostream
& output
, const std::string
& indent
= "");
71 * Push various types of data onto the stream.
74 void push(long value
);
75 void push(double value
);
76 void push(bool value
);
77 void push(const std::string
& value
);
78 void push(const std::wstring
& value
);
82 * Push a map onto the stream. Each map head must be matched by a map tail.
89 * Push an array onto the stream. Each array head must be matched by an
97 * Write any pending bytes to the stream. This is called automatically by
98 * the destructor of this class.
105 * This exception is thrown for serializer-related exceptional errors.
108 struct Exception
: public Mf::Exception
112 ARCHIVE_TERMINATED
= 1024,
113 KEYS_MUST_BE_STRINGS
= 1025,
114 RECURSION_TOO_DEEP
= 1026,
115 ALREADY_FAILED
= 1027,
118 explicit Exception(unsigned error
) :
119 Mf::Exception(error
) {}
126 const char* what() const throw()
130 case ARCHIVE_TERMINATED
:
131 return "archive is already terminated";
132 case KEYS_MUST_BE_STRINGS
:
133 return "map keys must be strings";
134 case RECURSION_TOO_DEEP
:
135 return "generator recursion too deep";
137 return "generator already errored out";
139 return Mf::Exception::what();
147 #endif // _MOOF_SERIALIZER_HH_
149 /** vim: set ts=4 sw=4 tw=80: *************************************************/
This page took 0.041937 seconds and 4 git commands to generate.