#region Copyright notice and license
// Protocol Buffers - Google's data interchange format
// Copyright 2008 Google Inc. All rights reserved.
// https://developers.google.com/protocol-buffers/
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#endregion
using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Linq;
namespace Google.Protobuf.Reflection
{
///
/// Describes a message type.
///
public sealed class MessageDescriptor : DescriptorBase
{
private static readonly HashSet WellKnownTypeNames = new HashSet
{
"google/protobuf/any.proto",
"google/protobuf/api.proto",
"google/protobuf/duration.proto",
"google/protobuf/empty.proto",
"google/protobuf/wrappers.proto",
"google/protobuf/timestamp.proto",
"google/protobuf/field_mask.proto",
"google/protobuf/source_context.proto",
"google/protobuf/struct.proto",
"google/protobuf/type.proto",
};
private readonly IList fieldsInDeclarationOrder;
private readonly IList fieldsInNumberOrder;
private readonly IDictionary jsonFieldMap;
internal MessageDescriptor(DescriptorProto proto, FileDescriptor file, MessageDescriptor parent, int typeIndex, GeneratedCodeInfo generatedCodeInfo)
: base(file, file.ComputeFullName(parent, proto.Name), typeIndex)
{
Proto = proto;
Parser = generatedCodeInfo?.Parser;
ClrType = generatedCodeInfo?.ClrType;
ContainingType = parent;
// Note use of generatedCodeInfo. rather than generatedCodeInfo?. here... we don't expect
// to see any nested oneofs, types or enums in "not actually generated" code... we do
// expect fields though (for map entry messages).
Oneofs = DescriptorUtil.ConvertAndMakeReadOnly(
proto.OneofDecl,
(oneof, index) =>
new OneofDescriptor(oneof, file, this, index, generatedCodeInfo.OneofNames[index]));
NestedTypes = DescriptorUtil.ConvertAndMakeReadOnly(
proto.NestedType,
(type, index) =>
new MessageDescriptor(type, file, this, index, generatedCodeInfo.NestedTypes[index]));
EnumTypes = DescriptorUtil.ConvertAndMakeReadOnly(
proto.EnumType,
(type, index) =>
new EnumDescriptor(type, file, this, index, generatedCodeInfo.NestedEnums[index]));
fieldsInDeclarationOrder = DescriptorUtil.ConvertAndMakeReadOnly(
proto.Field,
(field, index) =>
new FieldDescriptor(field, file, this, index, generatedCodeInfo?.PropertyNames[index]));
fieldsInNumberOrder = new ReadOnlyCollection(fieldsInDeclarationOrder.OrderBy(field => field.FieldNumber).ToArray());
// TODO: Use field => field.Proto.JsonName when we're confident it's appropriate. (And then use it in the formatter, too.)
jsonFieldMap = CreateJsonFieldMap(fieldsInNumberOrder);
file.DescriptorPool.AddSymbol(this);
Fields = new FieldCollection(this);
}
private static ReadOnlyDictionary CreateJsonFieldMap(IList fields)
{
var map = new Dictionary();
foreach (var field in fields)
{
map[JsonFormatter.ToCamelCase(field.Name)] = field;
map[field.Name] = field;
}
return new ReadOnlyDictionary(map);
}
///
/// The brief name of the descriptor's target.
///
public override string Name => Proto.Name;
internal DescriptorProto Proto { get; }
///
/// The CLR type used to represent message instances from this descriptor.
///
///
///
/// The value returned by this property will be non-null for all regular fields. However,
/// if a message containing a map field is introspected, the list of nested messages will include
/// an auto-generated nested key/value pair message for the field. This is not represented in any
/// generated type, so this property will return null in such cases.
///
///
/// For wrapper types ( and the like), the type returned here
/// will be the generated message type, not the native type used by reflection for fields of those types. Code
/// using reflection should call to determine whether a message descriptor represents
/// a wrapper type, and handle the result appropriately.
///
///
public Type ClrType { get; }
///
/// A parser for this message type.
///
///
///
/// As is not generic, this cannot be statically
/// typed to the relevant type, but it should produce objects of a type compatible with .
///
///
/// The value returned by this property will be non-null for all regular fields. However,
/// if a message containing a map field is introspected, the list of nested messages will include
/// an auto-generated nested key/value pair message for the field. No message parser object is created for
/// such messages, so this property will return null in such cases.
///
///
/// For wrapper types ( and the like), the parser returned here
/// will be the generated message type, not the native type used by reflection for fields of those types. Code
/// using reflection should call to determine whether a message descriptor represents
/// a wrapper type, and handle the result appropriately.
///
///
public MessageParser Parser { get; }
///
/// Returns whether this message is one of the "well known types" which may have runtime/protoc support.
///
internal bool IsWellKnownType => File.Package == "google.protobuf" && WellKnownTypeNames.Contains(File.Name);
///
/// Returns whether this message is one of the "wrapper types" used for fields which represent primitive values
/// with the addition of presence.
///
internal bool IsWrapperType => File.Package == "google.protobuf" && File.Name == "google/protobuf/wrappers.proto";
///
/// If this is a nested type, get the outer descriptor, otherwise null.
///
public MessageDescriptor ContainingType { get; }
///
/// A collection of fields, which can be retrieved by name or field number.
///
public FieldCollection Fields { get; }
///
/// An unmodifiable list of this message type's nested types.
///
public IList NestedTypes { get; }
///
/// An unmodifiable list of this message type's enum types.
///
public IList EnumTypes { get; }
///
/// An unmodifiable list of the "oneof" field collections in this message type.
///
public IList Oneofs { get; }
///
/// Finds a field by field name.
///
/// The unqualified name of the field (e.g. "foo").
/// The field's descriptor, or null if not found.
public FieldDescriptor FindFieldByName(String name) => File.DescriptorPool.FindSymbol(FullName + "." + name);
///
/// Finds a field by field number.
///
/// The field number within this message type.
/// The field's descriptor, or null if not found.
public FieldDescriptor FindFieldByNumber(int number) => File.DescriptorPool.FindFieldByNumber(this, number);
///
/// Finds a nested descriptor by name. The is valid for fields, nested
/// message types, oneofs and enums.
///
/// The unqualified name of the descriptor, e.g. "Foo"
/// The descriptor, or null if not found.
public T FindDescriptor(string name) where T : class, IDescriptor =>
File.DescriptorPool.FindSymbol(FullName + "." + name);
///
/// Looks up and cross-links all fields and nested types.
///
internal void CrossLink()
{
foreach (MessageDescriptor message in NestedTypes)
{
message.CrossLink();
}
foreach (FieldDescriptor field in fieldsInDeclarationOrder)
{
field.CrossLink();
}
foreach (OneofDescriptor oneof in Oneofs)
{
oneof.CrossLink();
}
}
///
/// A collection to simplify retrieving the field accessor for a particular field.
///
public sealed class FieldCollection
{
private readonly MessageDescriptor messageDescriptor;
internal FieldCollection(MessageDescriptor messageDescriptor)
{
this.messageDescriptor = messageDescriptor;
}
///
/// Returns the fields in the message as an immutable list, in the order in which they
/// are declared in the source .proto file.
///
public IList InDeclarationOrder() => messageDescriptor.fieldsInDeclarationOrder;
///
/// Returns the fields in the message as an immutable list, in ascending field number
/// order. Field numbers need not be contiguous, so there is no direct mapping from the
/// index in the list to the field number; to retrieve a field by field number, it is better
/// to use the indexer.
///
public IList InFieldNumberOrder() => messageDescriptor.fieldsInNumberOrder;
// TODO: consider making this public in the future. (Being conservative for now...)
///
/// Returns a read-only dictionary mapping the field names in this message as they're available
/// in the JSON representation to the field descriptors. For example, a field foo_bar
/// in the message would result two entries, one with a key fooBar and one with a key
/// foo_bar, both referring to the same field.
///
internal IDictionary ByJsonName() => messageDescriptor.jsonFieldMap;
///
/// Retrieves the descriptor for the field with the given number.
///
/// Number of the field to retrieve the descriptor for
/// The accessor for the given field
/// The message descriptor does not contain a field
/// with the given number
public FieldDescriptor this[int number]
{
get
{
var fieldDescriptor = messageDescriptor.FindFieldByNumber(number);
if (fieldDescriptor == null)
{
throw new KeyNotFoundException("No such field number");
}
return fieldDescriptor;
}
}
///
/// Retrieves the descriptor for the field with the given name.
///
/// Name of the field to retrieve the descriptor for
/// The descriptor for the given field
/// The message descriptor does not contain a field
/// with the given name
public FieldDescriptor this[string name]
{
get
{
var fieldDescriptor = messageDescriptor.FindFieldByName(name);
if (fieldDescriptor == null)
{
throw new KeyNotFoundException("No such field name");
}
return fieldDescriptor;
}
}
}
}
}