extreme refactoring

[chaz/yoink] / src / Moof / Serializer.hh

diff --git a/src/Moof/Serializer.hh b/src/Moof/Serializer.hh
new file mode 100644 (file)
index 0000000..7d54834
--- /dev/null
+++ b/src/Moof/Serializer.hh
@@ -0,0 +1,119 @@
+
+/*******************************************************************************
+
+ Copyright (c) 2009, Charles McGarvey
+ All rights reserved.
+ 
+ Redistribution   and   use  in  source  and  binary  forms,  with  or  without
+ modification, are permitted provided that the following conditions are met:
+ 
+   * Redistributions  of  source  code  must retain the above copyright notice,
+     this list of conditions and the following disclaimer.
+   * Redistributions  in binary form must reproduce the above copyright notice,
+     this  list of conditions and the following disclaimer in the documentation
+     and/or other materials provided with the distribution.
+ 
+ THIS  SOFTWARE  IS  PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ AND  ANY  EXPRESS  OR  IMPLIED  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ DISCLAIMED.  IN  NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ FOR  ANY  DIRECT,  INDIRECT,  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ DAMAGES  (INCLUDING,  BUT  NOT  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ SERVICES;  LOSS  OF  USE,  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ CAUSED  AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ OR  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+*******************************************************************************/
+
+#ifndef _MOOF_SERIALIZER_HH_
+#define _MOOF_SERIALIZER_HH_
+
+/**
+ * @file Serializer.hh
+ * Serialize structures and types for output on a stream.
+ */
+
+#include <stdexcept>
+#include <string>
+#include <ostream>
+
+#include <boost/shared_ptr.hpp>
+
+
+namespace Mf {
+
+
+class Serializer
+{
+public:
+
+       /**
+        * Construction is initialization.  Use either an output stream or a string
+        * representing a path to a fill to which the serialized data will be
+        * written (replacing any previous file).
+        * @param indent If non-empty, the string's characters will be used as
+        * indentation.  Otherwise, the serialized data will not be formatted neatly
+        * but will be tightly packed.
+        */
+
+       Serializer(const std::string& filePath, const std::string& indent = "");
+       Serializer(std::ostream& output, const std::string& indent = "");
+
+       ~Serializer();
+
+       /**
+        * Push various types of data onto the stream.
+        */
+
+       void push(long value);
+       void push(double value);
+       void push(bool value);
+       void push(const std::string& value);
+       void push(const std::wstring& value);
+       void pushNull();
+
+       /**
+        * Push a map onto the stream.  Each map head must be matched by a map tail.
+        */
+
+       void pushMapHead();
+       void pushMapTail();
+
+       /**
+        * Push an array onto the stream.  Each array head must be matched by an
+        * array tail.
+        */
+
+       void pushArrayHead();
+       void pushArrayTail();
+
+       /**
+        * Write any pending bytes to the stream.  This is called automatically by
+        * the destructor of this class.
+        */
+
+       void flush();
+
+       /**
+        * This exception is thrown for serializer-related exceptional errors.
+        */
+
+       struct Exception : std::runtime_error
+       {
+               explicit Exception(const std::string& what_arg) :
+                       std::runtime_error(what_arg) {}
+       };
+
+private:
+       class SerializerImpl;
+       boost::shared_ptr<SerializerImpl> impl_;
+};
+
+} // namespace Mf
+
+
+#endif // _MOOF_SERIALIZER_HH_
+
+/** vim: set ts=4 sw=4 tw=80: *************************************************/
+