// Protocol Buffers - Google's data interchange format // Copyright 2008 Google Inc. // http://code.google.com/p/protobuf/ // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. using System; using System.Collections; using System.Collections.Generic; using System.Reflection; using Google.ProtocolBuffers.Descriptors; namespace Google.ProtocolBuffers { /// /// Base type for all generated extensions. /// /// /// The protocol compiler generates a static singleton instance of this /// class for each extension. For exmaple, imagine a .proto file with: /// /// message Foo { /// extensions 1000 to max /// } /// /// extend Foo { /// optional int32 bar; /// } /// /// Then MyProto.Foo.Bar has type GeneratedExtensionBase<MyProto.Foo,int>. /// /// In general, users should ignore the details of this type, and /// simply use the static singletons as parameters to the extension accessors /// in ExtendableMessage and ExtendableBuilder. /// The interface implemented by both GeneratedException and GeneratedRepeatException, /// to make it easier to cope with repeats separately. /// public abstract class GeneratedExtensionBase { private readonly FieldDescriptor descriptor; private readonly IMessage messageDefaultInstance; protected GeneratedExtensionBase(FieldDescriptor descriptor, Type singularExtensionType) { if (!descriptor.IsExtension) { throw new ArgumentException("GeneratedExtension given a regular (non-extension) field."); } this.descriptor = descriptor; if (descriptor.MappedType == MappedType.Message) { PropertyInfo defaultInstanceProperty = singularExtensionType .GetProperty("DefaultInstance", BindingFlags.Static | BindingFlags.Public); if (defaultInstanceProperty == null) { throw new ArgumentException("No public static DefaultInstance property for type " + typeof(TExtension).Name); } messageDefaultInstance = (IMessage)defaultInstanceProperty.GetValue(null, null); } } public FieldDescriptor Descriptor { get { return descriptor; } } /// /// Returns the default message instance for extensions which are message types. /// public IMessage MessageDefaultInstance { get { return messageDefaultInstance; } } public object SingularFromReflectionType(object value) { switch (Descriptor.MappedType) { case MappedType.Message: if (value is TExtension) { return value; } else { // It seems the copy of the embedded message stored inside the // extended message is not of the exact type the user was // expecting. This can happen if a user defines a // GeneratedExtension manually and gives it a different type. // This should not happen in normal use. But, to be nice, we'll // copy the message to whatever type the caller was expecting. return MessageDefaultInstance.WeakCreateBuilderForType() .WeakMergeFrom((IMessage)value).WeakBuild(); } case MappedType.Enum: // Just return a boxed int - that can be unboxed to the enum EnumValueDescriptor enumValue = (EnumValueDescriptor) value; return enumValue.Number; default: return value; } } /// /// Converts from the type used by the native accessors to the type /// used by reflection accessors. For example, the reflection accessors /// for enums use EnumValueDescriptors but the native accessors use /// the generated enum type. /// public object ToReflectionType(object value) { if (descriptor.IsRepeated) { if (descriptor.MappedType == MappedType.Enum) { // Must convert the whole list. IList result = new List(); foreach (object element in (IEnumerable) value) { result.Add(SingularToReflectionType(element)); } return result; } else { return value; } } else { return SingularToReflectionType(value); } } /// /// Like ToReflectionType(object) but for a single element. /// internal Object SingularToReflectionType(object value) { return descriptor.MappedType == MappedType.Enum ? descriptor.EnumType.FindValueByNumber((int) value) : value; } public abstract object FromReflectionType(object value); } }