code.grnet.gr Git - pithos-ios/blob - Classes/SBJsonBase.h

   1 /*
   2  Copyright (C) 2009 Stig Brautaset. All rights reserved.
   3
   4  Redistribution and use in source and binary forms, with or without
   5  modification, are permitted provided that the following conditions are met:
   6
   7  * Redistributions of source code must retain the above copyright notice, this
   8    list of conditions and the following disclaimer.
   9
  10  * Redistributions in binary form must reproduce the above copyright notice,
  11    this list of conditions and the following disclaimer in the documentation
  12    and/or other materials provided with the distribution.
  13
  14  * Neither the name of the author nor the names of its contributors may be used
  15    to endorse or promote products derived from this software without specific
  16    prior written permission.
  17
  18  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  19  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  21  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
  22  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  24  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  25  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  26  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #import <Foundation/Foundation.h>
  31
  32 extern NSString * SBJSONErrorDomain;
  33
  34
  35 enum {
  36     EUNSUPPORTED = 1,
  37     EPARSENUM,
  38     EPARSE,
  39     EFRAGMENT,
  40     ECTRL,
  41     EUNICODE,
  42     EDEPTH,
  43     EESCAPE,
  44     ETRAILCOMMA,
  45     ETRAILGARBAGE,
  46     EEOF,
  47     EINPUT
  48 };
  49
  50 /**
  51  @brief Common base class for parsing & writing.
  52
  53  This class contains the common error-handling code and option between the parser/writer.
  54  */
  55 @interface SBJsonBase : NSObject {
  56     NSMutableArray *errorTrace;
  57
  58 @protected
  59     NSUInteger depth, maxDepth;
  60 }
  61
  62 /**
  63  @brief The maximum recursing depth.
  64
  65  Defaults to 512. If the input is nested deeper than this the input will be deemed to be
  66  malicious and the parser returns nil, signalling an error. ("Nested too deep".) You can
  67  turn off this security feature by setting the maxDepth value to 0.
  68  */
  69 @property NSUInteger maxDepth;
  70
  71 /**
  72  @brief Return an error trace, or nil if there was no errors.
  73
  74  Note that this method returns the trace of the last method that failed.
  75  You need to check the return value of the call you're making to figure out
  76  if the call actually failed, before you know call this method.
  77  */
  78  @property(copy,readonly) NSArray* errorTrace;
  79
  80 /// @internal for use in subclasses to add errors to the stack trace
  81 - (void)addErrorWithCode:(NSUInteger)code description:(NSString*)str;
  82
  83 /// @internal for use in subclasess to clear the error before a new parsing attempt
  84 - (void)clearErrorTrace;
  85
  86 @end