blob: 0363c70ab8f71c8eb41c71edbf2f74aff4a3152c [file] [log] [blame]
Brian Silverman9c614bc2016-02-15 20:20:02 -05001// 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#import <Foundation/Foundation.h>
32
33@class GPBDescriptor;
34@class GPBExtensionDescriptor;
35
36NS_ASSUME_NONNULL_BEGIN
37
38// A table of known extensions, searchable by name or field number. When
39// parsing a protocol message that might have extensions, you must provide an
40// ExtensionRegistry in which you have registered any extensions that you want
41// to be able to parse. Otherwise, those extensions will just be treated like
42// unknown fields.
43//
44// The *Root classes provide +extensionRegistry for the extensions defined in a
45// given file *and* all files it imports. You can also create a
46// GPBExtensionRegistry, and merge those registries to handle parsing extensions
47// defined from non overlapping files.
48//
49// GPBExtensionRegistry *registry =
50// [[[MyProtoFileRoot extensionRegistry] copy] autorelease];
51// [registry addExtension:[OtherMessage neededExtension]; // Not in MyProtoFile
52// NSError *parseError = nil;
53// MyMessage *msg = [MyMessage parseData:data
54// extensionRegistry:registry
55// error:&parseError];
56//
57@interface GPBExtensionRegistry : NSObject<NSCopying>
58
59- (void)addExtension:(GPBExtensionDescriptor *)extension;
60- (void)addExtensions:(GPBExtensionRegistry *)registry;
61
62- (nullable GPBExtensionDescriptor *)extensionForDescriptor:(GPBDescriptor *)descriptor
63 fieldNumber:(NSInteger)fieldNumber;
64
65@end
66
67NS_ASSUME_NONNULL_END