Dogcows Code - chaz/yoink/blob - src/Moof/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 _MOOF_SERIALIZER_HH_
  30 #define _MOOF_SERIALIZER_HH_
  31
  32 /**
  33  * @file Serializer.hh
  34  * Serialize structures and types for output on a stream.
  35  */
  36
  37 #include <stdexcept>
  38 #include <string>
  39 #include <ostream>
  40
  41 #include <boost/shared_ptr.hpp>
  42
  43 #include <Moof/Exception.hh>
  44
  45
  46 namespace Mf {
  47
  48
  49 class Serializer
  50 {
  51         class Impl;
  52         boost::shared_ptr<Impl> impl_;
  53
  54 public:
  55
  56         /**
  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.
  63          */
  64
  65         Serializer(const std::string& filePath, const std::string& indent = "");
  66         Serializer(std::ostream& output, const std::string& indent = "");
  67
  68         ~Serializer();
  69
  70         /**
  71          * Push various types of data onto the stream.
  72          */
  73
  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);
  79         void pushNull();
  80
  81         /**
  82          * Push a map onto the stream.  Each map head must be matched by a map tail.
  83          */
  84
  85         void pushMapHead();
  86         void pushMapTail();
  87
  88         /**
  89          * Push an array onto the stream.  Each array head must be matched by an
  90          * array tail.
  91          */
  92
  93         void pushArrayHead();
  94         void pushArrayTail();
  95
  96         /**
  97          * Write any pending bytes to the stream.  This is called automatically by
  98          * the destructor of this class.
  99          */
 100
 101         void flush();
 102
 103
 104         /**
 105          * This exception is thrown for serializer-related exceptional errors.
 106          */
 107
 108         struct Exception : public Mf::Exception
 109         {
 110                 enum
 111                 {
 112                         ARCHIVE_TERMINATED              = 1024,
 113                         KEYS_MUST_BE_STRINGS    = 1025,
 114                         RECURSION_TOO_DEEP              = 1026,
 115                         ALREADY_FAILED                  = 1027,
 116                 };
 117
 118                 explicit Exception(unsigned error) :
 119                         Mf::Exception(error) {}
 120
 121                 void raise()
 122                 {
 123                         throw *this;
 124                 }
 125
 126                 const char* what() const throw()
 127                 {
 128                         switch (code)
 129                         {
 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";
 136                                 case ALREADY_FAILED:
 137                                         return "generator already errored out";
 138                         }
 139                         return Mf::Exception::what();
 140                 }
 141         };
 142 };
 143
 144 } // namespace Mf
 145
 146
 147 #endif // _MOOF_SERIALIZER_HH_
 148
 149 /** vim: set ts=4 sw=4 tw=80: *************************************************/
 150