Dogcows Code - chaz/yoink/blob - src/serializer.hh

   1
   2 /*******************************************************************************
   3
   4  Copyright (c) 2009, Charles McGarvey
   5  All rights reserved.
   6
   7  Redistribution   and   use  in  source  and  binary  forms,  with  or  without
   8  modification, are permitted provided that the following conditions are met:
   9
  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.
  15
  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.
  26
  27 *******************************************************************************/
  28
  29 #ifndef _SERIALIZER_HH_
  30 #define _SERIALIZER_HH_
  31
  32 /**
  33  * @file serializer.hh
  34  * Serialize structures and types for output on a stream.
  35  */
  36
  37 #include <ostream>
  38 #include <string>
  39 #include <stdexcept>
  40
  41 #include <boost/shared_ptr.hpp>
  42
  43
  44 namespace dc {
  45
  46
  47 class serializer
  48 {
  49 public:
  50
  51         /**
  52          * Construction is initialization.  Use either an output stream or a string
  53          * representing a path to a fill to which the serialized data will be
  54          * written (replacing any previous file).
  55          * @param indent If non-empty, the string's characters will be used as
  56          * indentation.  Otherwise, the serialized data will not be formatted neatly
  57          * but will be tightly packed.
  58          */
  59
  60         serializer(const std::string& filePath, const std::string& indent = "");
  61         serializer(std::ostream& output, const std::string& indent = "");
  62
  63         ~serializer();
  64
  65         /**
  66          * Push various types of data onto the stream.
  67          */
  68
  69         void push(long value);
  70         void push(double value);
  71         void push(bool value);
  72         void push(const std::string& value);
  73         void push(const std::wstring& value);
  74         void pushNull();
  75
  76         /**
  77          * Push a map onto the stream.  Each map head must be matched by a map tail.
  78          */
  79
  80         void pushMapHead();
  81         void pushMapTail();
  82
  83         /**
  84          * Push an array onto the stream.  Each array head must be matched by an
  85          * array tail.
  86          */
  87
  88         void pushArrayHead();
  89         void pushArrayTail();
  90
  91         /**
  92          * Write any pending bytes to the stream.  This is called automatically by
  93          * the destructor of this class.
  94          */
  95
  96         void flush();
  97
  98         /**
  99          * This exception is thrown for serializer-related exceptional errors.
 100          */
 101
 102         struct exception : std::runtime_error
 103         {
 104                 explicit exception(const std::string& what_arg) :
 105                         std::runtime_error(what_arg) {}
 106         };
 107
 108 private:
 109         class serializer_impl;
 110         boost::shared_ptr<serializer_impl> impl;
 111 };
 112
 113 } // namespace dc
 114
 115
 116 #endif // _SERIALIZER_HH_
 117
 118 /** vim: set ts=4 sw=4 tw=80: *************************************************/
 119