diff options
Diffstat (limited to 'SBJsonParser.h')
-rwxr-xr-x | SBJsonParser.h | 107 |
1 files changed, 107 insertions, 0 deletions
diff --git a/SBJsonParser.h b/SBJsonParser.h new file mode 100755 index 0000000..bf728c7 --- /dev/null +++ b/SBJsonParser.h @@ -0,0 +1,107 @@ +/* + Copyright (C) 2009 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 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 OWNER 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> + +/** + @brief Parse JSON Strings and NSData objects + + This uses SBJsonStreamParser internally. + + @see @ref objc2json + + */ + +@interface SBJsonParser : NSObject { + +@private + NSString *error; + NSUInteger depth, maxDepth; + +} + +/** + @brief The maximum recursing depth. + + Defaults to 32. 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 Description of parse error + + This method returns the trace of the last method that failed. + You need to check the return value of the call you're making to figure out + if the call actually failed, before you know call this method. + + @return A string describing the error encountered, or nil if no error occured. + + */ +@property(copy) NSString *error; + +/** + @brief Return the object represented by the given NSData object. + + The data *must* be UTF8 encoded. + + @param data An NSData containing UTF8 encoded data to parse. + @return The NSArray or NSDictionary represented by the object, or nil if an error occured. + + */ +- (id)objectWithData:(NSData*)data; + +/** + @brief Return the object represented by the given string + + This method converts its input to an NSData object containing UTF8 and calls -objectWithData: with it. + + @return The NSArray or NSDictionary represented by the object, or nil if an error occured. + */ +- (id)objectWithString:(NSString *)repr; + +/** + @brief Return the object represented by the given string + + This method calls objectWithString: internally. If an error occurs, and if @p error + is not nil, it creates an NSError object and returns this through its second argument. + + @param jsonText the json string to parse + @param error pointer to an NSError object to populate on error + + @return The NSArray or NSDictionary represented by the object, or nil if an error occured. + */ + +- (id)objectWithString:(NSString*)jsonText + error:(NSError**)error; + +@end + + |