summaryrefslogtreecommitdiffstatshomepage
path: root/src/lib/web/json/writer.h
blob: fcbd44950e0c46bc29238118bbc82befba60971a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
// Copyright 2007-2010 Baptiste Lepilleur
// Distributed under MIT license, or public domain if desired and
// recognized in your jurisdiction.
// See file LICENSE for detail or copy at http://jsoncpp.sourceforge.net/LICENSE

#ifndef JSON_WRITER_H_INCLUDED
# define JSON_WRITER_H_INCLUDED

#if !defined(JSON_IS_AMALGAMATION)
# include "value.h"
#endif // if !defined(JSON_IS_AMALGAMATION)
# include <vector>
# include <string>
# include <iostream>

namespace Json {
	class Value;

	/** \brief Abstract class for writers.
	*/
	class JSON_API Writer
	{
	public:
		virtual ~Writer();

		virtual std::string write( const Value &root ) = 0;
	};

	/** \brief Outputs a Value in <a HREF="http://www.json.org">JSON</a> format without formatting (not human friendly).
	*
	* The JSON document is written in a single line. It is not intended for 'human' consumption,
	* but may be usefull to support feature such as RPC where bandwith is limited.
	* \sa Reader, Value
	*/
	class JSON_API FastWriter : public Writer
	{
	public:
		FastWriter();
		virtual ~FastWriter(){}

		void enableYAMLCompatibility();

	public: // overridden from Writer
		virtual std::string write( const Value &root );

	private:
		void writeValue( const Value &value );

		std::string document_;
		bool yamlCompatiblityEnabled_;
	};

	/** \brief Writes a Value in <a HREF="http://www.json.org">JSON</a> format in a human friendly way.
	*
	* The rules for line break and indent are as follow:
	* - Object value:
	*     - if empty then print {} without indent and line break
	*     - if not empty the print '{', line break & indent, print one value per line
	*       and then unindent and line break and print '}'.
	* - Array value:
	*     - if empty then print [] without indent and line break
	*     - if the array contains no object value, empty array or some other value types,
	*       and all the values fit on one lines, then print the array on a single line.
	*     - otherwise, it the values do not fit on one line, or the array contains
	*       object or non empty array, then print one value per line.
	*
	* If the Value have comments then they are outputed according to their #CommentPlacement.
	*
	* \sa Reader, Value, Value::setComment()
	*/
	class JSON_API StyledWriter: public Writer
	{
	public:
		StyledWriter();
		virtual ~StyledWriter(){}

	public: // overridden from Writer
		/** \brief Serialize a Value in <a HREF="http://www.json.org">JSON</a> format.
		* \param root Value to serialize.
		* \return String containing the JSON document that represents the root value.
		*/
		virtual std::string write( const Value &root );

	private:
		void writeValue( const Value &value );
		void writeArrayValue( const Value &value );
		bool isMultineArray( const Value &value );
		void pushValue( const std::string &value );
		void writeIndent();
		void writeWithIndent( const std::string &value );
		void indent();
		void unindent();
		void writeCommentBeforeValue( const Value &root );
		void writeCommentAfterValueOnSameLine( const Value &root );
		bool hasCommentForValue( const Value &value );
		static std::string normalizeEOL( const std::string &text );

		typedef std::vector<std::string> ChildValues;

		ChildValues childValues_;
		std::string document_;
		std::string indentString_;
		int rightMargin_;
		int indentSize_;
		bool addChildValues_;
	};

	/** \brief Writes a Value in <a HREF="http://www.json.org">JSON</a> format in a human friendly way,
	    to a stream rather than to a string.
	*
	* The rules for line break and indent are as follow:
	* - Object value:
	*     - if empty then print {} without indent and line break
	*     - if not empty the print '{', line break & indent, print one value per line
	*       and then unindent and line break and print '}'.
	* - Array value:
	*     - if empty then print [] without indent and line break
	*     - if the array contains no object value, empty array or some other value types,
	*       and all the values fit on one lines, then print the array on a single line.
	*     - otherwise, it the values do not fit on one line, or the array contains
	*       object or non empty array, then print one value per line.
	*
	* If the Value have comments then they are outputed according to their #CommentPlacement.
	*
	* \param indentation Each level will be indented by this amount extra.
	* \sa Reader, Value, Value::setComment()
	*/
	class JSON_API StyledStreamWriter
	{
	public:
		StyledStreamWriter( std::string indentation="\t" );
		~StyledStreamWriter(){}

	public:
		/** \brief Serialize a Value in <a HREF="http://www.json.org">JSON</a> format.
		* \param out Stream to write to. (Can be ostringstream, e.g.)
		* \param root Value to serialize.
		* \note There is no point in deriving from Writer, since write() should not return a value.
		*/
		void write( std::ostream &out, const Value &root );

	private:
		void writeValue( const Value &value );
		void writeArrayValue( const Value &value );
		bool isMultineArray( const Value &value );
		void pushValue( const std::string &value );
		void writeIndent();
		void writeWithIndent( const std::string &value );
		void indent();
		void unindent();
		void writeCommentBeforeValue( const Value &root );
		void writeCommentAfterValueOnSameLine( const Value &root );
		bool hasCommentForValue( const Value &value );
		static std::string normalizeEOL( const std::string &text );

		typedef std::vector<std::string> ChildValues;

		ChildValues childValues_;
		std::ostream* document_;
		std::string indentString_;
		int rightMargin_;
		std::string indentation_;
		bool addChildValues_;
	};

# if defined(JSON_HAS_INT64)
	std::string JSON_API valueToString( Int value );
	std::string JSON_API valueToString( UInt value );
# endif // if defined(JSON_HAS_INT64)
	std::string JSON_API valueToString( LargestInt value );
	std::string JSON_API valueToString( LargestUInt value );
	std::string JSON_API valueToString( double value );
	std::string JSON_API valueToString( bool value );
	std::string JSON_API valueToQuotedString( const char *value );

	/// \brief Output using the StyledStreamWriter.
	/// \see Json::operator>>()
	std::ostream& operator<<( std::ostream&, const Value &root );

} // namespace Json



#endif // JSON_WRITER_H_INCLUDED