Home | History | Annotate | Download | only in objectivec
      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 #import <Foundation/Foundation.h>
     32 
     33 @class GPBDescriptor;
     34 @class GPBExtensionDescriptor;
     35 
     36 NS_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 a
     40 /// @c GPBExtensionRegistry in which you have registered any extensions that you
     41 /// want to be able to parse. Otherwise, those extensions will just be treated
     42 /// like unknown fields.
     43 ///
     44 /// The @c *Root classes provide @c +extensionRegistry for the extensions defined
     45 /// in a given file *and* all files it imports. You can also create a
     46 /// @c GPBExtensionRegistry, and merge those registries to handle parsing
     47 /// extensions defined from non overlapping files.
     48 ///
     49 /// @code
     50 /// GPBExtensionRegistry *registry =
     51 ///     [[[MyProtoFileRoot extensionRegistry] copy] autorelease];
     52 /// [registry addExtension:[OtherMessage neededExtension];  // Not in MyProtoFile
     53 /// NSError *parseError = nil;
     54 /// MyMessage *msg = [MyMessage parseData:data
     55 ///                     extensionRegistry:registry
     56 ///                                 error:&parseError];
     57 /// @endcode
     58 @interface GPBExtensionRegistry : NSObject<NSCopying>
     59 
     60 /// Add the given @c GPBExtensionDescriptor to this registry.
     61 ///
     62 /// @param extension The extension description to add.
     63 - (void)addExtension:(GPBExtensionDescriptor *)extension;
     64 
     65 /// Adds all the extensions from another registry to this registry.
     66 ///
     67 /// @param registry The registry to merge into this registry.
     68 - (void)addExtensions:(GPBExtensionRegistry *)registry;
     69 
     70 /// Looks for the extension registered for the given field number on a given
     71 /// @c GPBDescriptor.
     72 ///
     73 /// @param descriptor  The descriptor to look for a registered extension on.
     74 /// @param fieldNumber The field number of an extension to look for.
     75 ///
     76 /// @return The registered @c GPBExtensionDescripto or nil if none was found.
     77 - (nullable GPBExtensionDescriptor *)extensionForDescriptor:(GPBDescriptor *)descriptor
     78                                                 fieldNumber:(NSInteger)fieldNumber;
     79 
     80 @end
     81 
     82 NS_ASSUME_NONNULL_END
     83