/
SBJsonStreamWriter.h
144 lines (109 loc) · 4.6 KB
/
SBJsonStreamWriter.h
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
/*
Copyright (c) 2010, Stig Brautaset.
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.
Neither the name of the the author nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
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.
*/
#import <Foundation/Foundation.h>
@class SBJsonStreamWriterStateMachine;
/**
@brief The Stream Writer class.
SBJsonStreamWriter accepts various messages and writes JSON text to an
NSOutputStream designated at iniatilisation time.
A range of high-, mid- and low-level methods. You can mix and match calls
to these. For example, you may want to call -writeArrayOpen to start an
array and then repeatedly call -writeObject: with an object.
In JSON the keys of an object must be strings. NSDictionary keys need
not be, but attempting to convert an NSDictionary with non-string keys
into JSON will result in an error.
NSNumber instances created with the +initWithBool: method are
converted into the JSON boolean "true" and "false" values, and vice
versa. Any other NSNumber instances are converted to a JSON number the
way you would expect.
*/
@interface SBJsonStreamWriter : NSObject {
@private
NSString *error;
SBJsonStreamWriterStateMachine **states;
NSOutputStream *stream;
NSUInteger depth, maxDepth;
BOOL sortKeys, humanReadable;
}
/**
@brief The maximum recursing depth.
Defaults to 512. If the input is nested deeper than this the input will be deemed to be
malicious and the parser returns nil, signalling an error. ("Nested too deep".) You can
turn off this security feature by setting the maxDepth value to 0.
*/
@property NSUInteger maxDepth;
/**
@brief Whether we are generating human-readable (multiline) JSON.
Set whether or not to generate human-readable JSON. The default is NO, which produces
JSON without any whitespace between tokens. If set to YES, generates human-readable
JSON with linebreaks after each array value and dictionary key/value pair, indented two
spaces per nesting level.
*/
@property BOOL humanReadable;
/**
@brief Whether or not to sort the dictionary keys in the output.
If this is set to YES, the dictionary keys in the JSON output will be in sorted order.
(This is useful if you need to compare two structures, for example.) The default is NO.
*/
@property BOOL sortKeys;
/**
@brief Contains the error description after an error has occured.
*/
@property (copy, readonly) NSString *error;
/**
@brief Initialise a stream writer.
You have to create an output stream first. You should not open/close the stream
manually; this class takes care of that.
*/
- (id)initWithStream:(NSOutputStream*)stream;
/**
@brief Write an NSDictionary to the JSON stream.
*/
- (BOOL)writeObject:(NSDictionary*)dict;
/**
@brief Write an NSArray to the JSON stream.
*/
- (BOOL)writeArray:(NSArray *)array;
/// Start writing an Object to the stream
- (BOOL)writeObjectOpen;
/// Close the current object being written
- (BOOL)writeObjectClose;
/// Start writing an Array to the stream
- (BOOL)writeArrayOpen;
/// Close the current Array being written
- (BOOL)writeArrayClose;
/// Write a null to the stream
- (BOOL)writeNull;
/// Write a boolean to the stream
- (BOOL)writeBool:(BOOL)x;
//- (BOOL)writeInteger:(long)l;
//- (BOOL)writeDouble:(double)d;
/// Write a Number to the stream
- (BOOL)writeNumber:(NSNumber*)n;
/// Write a String to the stream
- (BOOL)writeString:(NSString*)s;
@end