OLD | NEW |
| (Empty) |
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 #import <libkern/OSAtomic.h> | |
38 | |
39 @class GPBUnknownFieldSet; | |
40 @class GPBFieldDescriptor; | |
41 | |
42 // GPBString is a string subclass that avoids the overhead of initializing | |
43 // a full NSString until it is actually needed. Lots of protocol buffers contain | |
44 // strings, and instantiating all of those strings and having them parsed to | |
45 // verify correctness when the message was being read was expensive, when many | |
46 // of the strings were never being used. | |
47 // | |
48 // Note for future-self. I tried implementing this using a NSProxy. | |
49 // Turned out the performance was horrible in client apps because folks | |
50 // like to use libraries like SBJSON that grab characters one at a time. | |
51 // The proxy overhead was a killer. | |
52 @interface GPBString : NSString | |
53 @end | |
54 | |
55 typedef struct GPBCodedInputStreamState { | |
56 const uint8_t *bytes; | |
57 size_t bufferSize; | |
58 size_t bufferPos; | |
59 | |
60 // For parsing subsections of an input stream you can put a hard limit on | |
61 // how much should be read. Normally the limit is the end of the stream, | |
62 // but you can adjust it to anywhere, and if you hit it you will be at the | |
63 // end of the stream, until you adjust the limit. | |
64 size_t currentLimit; | |
65 int32_t lastTag; | |
66 NSUInteger recursionDepth; | |
67 } GPBCodedInputStreamState; | |
68 | |
69 @interface GPBCodedInputStream () { | |
70 @package | |
71 struct GPBCodedInputStreamState state_; | |
72 NSData *buffer_; | |
73 } | |
74 | |
75 // Group support is deprecated, so we hide this interface from users, but | |
76 // support for older data. | |
77 - (void)readGroup:(int32_t)fieldNumber | |
78 message:(GPBMessage *)message | |
79 extensionRegistry:(GPBExtensionRegistry *)extensionRegistry; | |
80 | |
81 // Reads a group field value from the stream and merges it into the given | |
82 // UnknownFieldSet. | |
83 - (void)readUnknownGroup:(int32_t)fieldNumber | |
84 message:(GPBUnknownFieldSet *)message; | |
85 | |
86 // Reads a map entry. | |
87 - (void)readMapEntry:(id)mapDictionary | |
88 extensionRegistry:(GPBExtensionRegistry *)extensionRegistry | |
89 field:(GPBFieldDescriptor *)field | |
90 parentMessage:(GPBMessage *)parentMessage; | |
91 @end | |
92 | |
93 CF_EXTERN_C_BEGIN | |
94 | |
95 // Returns a GPBString with a +1 retain count. | |
96 GPBString *GPBCreateGPBStringWithUTF8(const void *bytes, NSUInteger length) | |
97 __attribute__((ns_returns_retained)); | |
98 | |
99 int32_t GPBCodedInputStreamReadTag(GPBCodedInputStreamState *state); | |
100 | |
101 double GPBCodedInputStreamReadDouble(GPBCodedInputStreamState *state); | |
102 float GPBCodedInputStreamReadFloat(GPBCodedInputStreamState *state); | |
103 uint64_t GPBCodedInputStreamReadUInt64(GPBCodedInputStreamState *state); | |
104 uint32_t GPBCodedInputStreamReadUInt32(GPBCodedInputStreamState *state); | |
105 int64_t GPBCodedInputStreamReadInt64(GPBCodedInputStreamState *state); | |
106 int32_t GPBCodedInputStreamReadInt32(GPBCodedInputStreamState *state); | |
107 uint64_t GPBCodedInputStreamReadFixed64(GPBCodedInputStreamState *state); | |
108 uint32_t GPBCodedInputStreamReadFixed32(GPBCodedInputStreamState *state); | |
109 int32_t GPBCodedInputStreamReadEnum(GPBCodedInputStreamState *state); | |
110 int32_t GPBCodedInputStreamReadSFixed32(GPBCodedInputStreamState *state); | |
111 int64_t GPBCodedInputStreamReadSFixed64(GPBCodedInputStreamState *state); | |
112 int32_t GPBCodedInputStreamReadSInt32(GPBCodedInputStreamState *state); | |
113 int64_t GPBCodedInputStreamReadSInt64(GPBCodedInputStreamState *state); | |
114 BOOL GPBCodedInputStreamReadBool(GPBCodedInputStreamState *state); | |
115 NSString *GPBCodedInputStreamReadRetainedString(GPBCodedInputStreamState *state) | |
116 __attribute((ns_returns_retained)); | |
117 NSData *GPBCodedInputStreamReadRetainedBytes(GPBCodedInputStreamState *state) | |
118 __attribute((ns_returns_retained)); | |
119 NSData *GPBCodedInputStreamReadRetainedBytesNoCopy( | |
120 GPBCodedInputStreamState *state) __attribute((ns_returns_retained)); | |
121 | |
122 size_t GPBCodedInputStreamPushLimit(GPBCodedInputStreamState *state, | |
123 size_t byteLimit); | |
124 void GPBCodedInputStreamPopLimit(GPBCodedInputStreamState *state, | |
125 size_t oldLimit); | |
126 size_t GPBCodedInputStreamBytesUntilLimit(GPBCodedInputStreamState *state); | |
127 BOOL GPBCodedInputStreamIsAtEnd(GPBCodedInputStreamState *state); | |
128 void GPBCodedInputStreamCheckLastTagWas(GPBCodedInputStreamState *state, | |
129 int32_t value); | |
130 | |
131 CF_EXTERN_C_END | |
OLD | NEW |