Drizzled Public API Documentation

writer.h
1 /* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
2  *
3  * JSON Library, originally from http://jsoncpp.sourceforge.net/
4  *
5  * Copyright (C) 2011 Stewart Smith
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are
10  * met:
11  *
12  * * Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * * Redistributions in binary form must reproduce the above
16  * copyright notice, this list of conditions and the following disclaimer
17  * in the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * * The names of its contributors may not be used to endorse or
21  * promote products derived from this software without specific prior
22  * written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35  *
36  */
37 
38 #pragma once
39 
40 # include "value.h"
41 # include <vector>
42 # include <string>
43 # include <iosfwd>
44 
45 namespace Json {
46 
47  class Value;
48 
51  class JSON_API Writer
52  {
53  public:
54  virtual ~Writer();
55 
56  virtual std::string write( const Value &root ) = 0;
57  };
58 
65  class JSON_API FastWriter : public Writer
66  {
67  public:
68  FastWriter();
69 
70  void enableYAMLCompatibility();
71 
72  public: // overridden from Writer
73  virtual std::string write( const Value &root );
74 
75  private:
76  void writeValue( const Value &value );
77 
78  std::string document_;
79  bool yamlCompatiblityEnabled_;
80  };
81 
100  class JSON_API StyledWriter: public Writer
101  {
102  public:
103  StyledWriter();
104 
105  public: // overridden from Writer
110  virtual std::string write( const Value &root );
111 
112  private:
113  void writeValue( const Value &value );
114  void writeArrayValue( const Value &value );
115  bool isMultineArray( const Value &value );
116  void pushValue( const std::string &value );
117  void writeIndent();
118  void writeWithIndent( const std::string &value );
119  void indent();
120  void unindent();
121  void writeCommentBeforeValue( const Value &root );
122  void writeCommentAfterValueOnSameLine( const Value &root );
123  bool hasCommentForValue( const Value &value );
124  static std::string normalizeEOL( const std::string &text );
125 
126  typedef std::vector<std::string> ChildValues;
127 
128  ChildValues childValues_;
129  std::string document_;
130  std::string indentString_;
131  int rightMargin_;
132  int indentSize_;
133  bool addChildValues_;
134  };
135 
156  class JSON_API StyledStreamWriter
157  {
158  public:
159  StyledStreamWriter( std::string indentation="\t" );
160  ~StyledStreamWriter(){}
161 
162  public:
168  void write( std::ostream &out, const Value &root );
169 
170  private:
171  void writeValue( const Value &value );
172  void writeArrayValue( const Value &value );
173  bool isMultineArray( const Value &value );
174  void pushValue( const std::string &value );
175  void writeIndent();
176  void writeWithIndent( const std::string &value );
177  void indent();
178  void unindent();
179  void writeCommentBeforeValue( const Value &root );
180  void writeCommentAfterValueOnSameLine( const Value &root );
181  bool hasCommentForValue( const Value &value );
182  static std::string normalizeEOL( const std::string &text );
183 
184  typedef std::vector<std::string> ChildValues;
185 
186  ChildValues childValues_;
187  std::ostream* document_;
188  std::string indentString_;
189  int rightMargin_;
190  std::string indentation_;
191  bool addChildValues_;
192  };
193 
194  std::string JSON_API valueToString( Int value );
195  std::string JSON_API valueToString( UInt value );
196  std::string JSON_API valueToString( double value );
197  std::string JSON_API valueToString( bool value );
198  std::string JSON_API valueToQuotedString( const char *value );
199 
202  std::ostream& operator<<( std::ostream&, const Value &root );
203 
204 } // namespace Json
std::ostream & operator<<(std::ostream &sout, const Value &root)
Output using the StyledStreamWriter.
Writes a Value in JSON format in a human friendly way, to a stream rather than to a string...
Definition: writer.h:156
Represents a JSON value.
Definition: value.h:149
Outputs a Value in JSON format without formatting (not human friendly).
Definition: writer.h:65
Abstract class for writers.
Definition: writer.h:51
Writes a Value in JSON format in a human friendly way.
Definition: writer.h:100