• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1  // Protocol Buffers - Google's data interchange format
2  // Copyright 2008 Google Inc.  All rights reserved.
3  // https://developers.google.com/protocol-buffers/
4  //
5  // Redistribution and use in source and binary forms, with or without
6  // modification, are permitted provided that the following conditions are
7  // met:
8  //
9  //     * Redistributions of source code must retain the above copyright
10  // notice, this list of conditions and the following disclaimer.
11  //     * Redistributions in binary form must reproduce the above
12  // copyright notice, this list of conditions and the following disclaimer
13  // in the documentation and/or other materials provided with the
14  // distribution.
15  //     * Neither the name of Google Inc. nor the names of its
16  // contributors may be used to endorse or promote products derived from
17  // this software without specific prior written permission.
18  //
19  // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  
31  // This header is private to the ProtobolBuffers library and must NOT be
32  // included by any sources outside this library. The contents of this file are
33  // subject to change at any time without notice.
34  
35  #import "GPBCodedInputStream.h"
36  
37  @class GPBUnknownFieldSet;
38  @class GPBFieldDescriptor;
39  
40  typedef struct GPBCodedInputStreamState {
41    const uint8_t *bytes;
42    size_t bufferSize;
43    size_t bufferPos;
44  
45    // For parsing subsections of an input stream you can put a hard limit on
46    // how much should be read. Normally the limit is the end of the stream,
47    // but you can adjust it to anywhere, and if you hit it you will be at the
48    // end of the stream, until you adjust the limit.
49    size_t currentLimit;
50    int32_t lastTag;
51    NSUInteger recursionDepth;
52  } GPBCodedInputStreamState;
53  
GPBCodedInputStream()54  @interface GPBCodedInputStream () {
55   @package
56    struct GPBCodedInputStreamState state_;
57    NSData *buffer_;
58  }
59  
60  // Group support is deprecated, so we hide this interface from users, but
61  // support for older data.
62  - (void)readGroup:(int32_t)fieldNumber
63                message:(GPBMessage *)message
64      extensionRegistry:(GPBExtensionRegistry *)extensionRegistry;
65  
66  // Reads a group field value from the stream and merges it into the given
67  // UnknownFieldSet.
68  - (void)readUnknownGroup:(int32_t)fieldNumber
69                   message:(GPBUnknownFieldSet *)message;
70  
71  // Reads a map entry.
72  - (void)readMapEntry:(id)mapDictionary
73      extensionRegistry:(GPBExtensionRegistry *)extensionRegistry
74                  field:(GPBFieldDescriptor *)field
75          parentMessage:(GPBMessage *)parentMessage;
76  @end
77  
78  CF_EXTERN_C_BEGIN
79  
80  int32_t GPBCodedInputStreamReadTag(GPBCodedInputStreamState *state);
81  
82  double GPBCodedInputStreamReadDouble(GPBCodedInputStreamState *state);
83  float GPBCodedInputStreamReadFloat(GPBCodedInputStreamState *state);
84  uint64_t GPBCodedInputStreamReadUInt64(GPBCodedInputStreamState *state);
85  uint32_t GPBCodedInputStreamReadUInt32(GPBCodedInputStreamState *state);
86  int64_t GPBCodedInputStreamReadInt64(GPBCodedInputStreamState *state);
87  int32_t GPBCodedInputStreamReadInt32(GPBCodedInputStreamState *state);
88  uint64_t GPBCodedInputStreamReadFixed64(GPBCodedInputStreamState *state);
89  uint32_t GPBCodedInputStreamReadFixed32(GPBCodedInputStreamState *state);
90  int32_t GPBCodedInputStreamReadEnum(GPBCodedInputStreamState *state);
91  int32_t GPBCodedInputStreamReadSFixed32(GPBCodedInputStreamState *state);
92  int64_t GPBCodedInputStreamReadSFixed64(GPBCodedInputStreamState *state);
93  int32_t GPBCodedInputStreamReadSInt32(GPBCodedInputStreamState *state);
94  int64_t GPBCodedInputStreamReadSInt64(GPBCodedInputStreamState *state);
95  BOOL GPBCodedInputStreamReadBool(GPBCodedInputStreamState *state);
96  NSString *GPBCodedInputStreamReadRetainedString(GPBCodedInputStreamState *state)
97      __attribute((ns_returns_retained));
98  NSData *GPBCodedInputStreamReadRetainedBytes(GPBCodedInputStreamState *state)
99      __attribute((ns_returns_retained));
100  NSData *GPBCodedInputStreamReadRetainedBytesNoCopy(
101      GPBCodedInputStreamState *state) __attribute((ns_returns_retained));
102  
103  size_t GPBCodedInputStreamPushLimit(GPBCodedInputStreamState *state,
104                                      size_t byteLimit);
105  void GPBCodedInputStreamPopLimit(GPBCodedInputStreamState *state,
106                                   size_t oldLimit);
107  size_t GPBCodedInputStreamBytesUntilLimit(GPBCodedInputStreamState *state);
108  BOOL GPBCodedInputStreamIsAtEnd(GPBCodedInputStreamState *state);
109  void GPBCodedInputStreamCheckLastTagWas(GPBCodedInputStreamState *state,
110                                          int32_t value);
111  
112  CF_EXTERN_C_END
113