IAttributeRegistry.cs

Go to the documentation of this file.

// Copyright (c) 2014 Silicon Studio Corp. (http://siliconstudio.co.jp)
// This file is distributed under GPL v3. See LICENSE.md for details.
using System;
using System.Collections.Generic;
using System.Linq;
using System.Reflection;

namespace SiliconStudio.Core.Reflection
{
    /// <summary>
    /// A registry for all attributes.
    /// </summary>
    public interface IAttributeRegistry
    {
        /// <summary>
        /// Gets the attributes associated with the specified member.
        /// </summary>
        /// <param name="memberInfo">The reflection member.</param>
        /// <param name="inherit">if set to <c>true</c> includes inherited attributes.</param>
        /// <returns>An enumeration of <see cref="Attribute"/>.</returns>
        IReadOnlyCollection<Attribute> GetAttributes(MemberInfo memberInfo, bool inherit = true);

        /// <summary>
        /// Registers an attribute for the specified member. Restriction: Attributes registered this way cannot be listed in inherited attributes.
        /// </summary>
        /// <param name="memberInfo">The member information.</param>
        /// <param name="attribute">The attribute.</param>
        void Register(MemberInfo memberInfo, Attribute attribute);
    }

    /// <summary>
    /// Extension methods for attribute registry.
    /// </summary>
    public static class AttributeRegistryExtensions
    {
        /// <summary>
        /// Gets the attributes associated with the specified member.
        /// </summary>
        /// <typeparam name="T">Type of the attribute</typeparam>
        /// <param name="attributeRegistry">The attribute registry.</param>
        /// <param name="memberInfo">The member information.</param>
        /// <param name="inherit">if set to <c>true</c> [inherit].</param>
        /// <returns>An enumeration of <see cref="Attribute" />.</returns>
        public static IEnumerable<T> GetAttributes<T>(this IAttributeRegistry attributeRegistry, MemberInfo memberInfo, bool inherit = true) where T : Attribute
        {
            return attributeRegistry.GetAttributes(memberInfo, inherit).OfType<T>();
        }

        /// <summary>
        /// Gets an attribute associated with the specified member.
        /// </summary>
        /// <typeparam name="T">Type of the attribute</typeparam>
        /// <param name="attributeRegistry">The attribute registry.</param>
        /// <param name="memberInfo">The member information.</param>
        /// <param name="inherit">if set to <c>true</c> [inherit].</param>
        /// <returns>An attribute of type {T} if it was found; otherwise <c>null</c></returns>
        public static T GetAttribute<T>(this IAttributeRegistry attributeRegistry, MemberInfo memberInfo, bool inherit = true) where T : Attribute
        {
            var list = attributeRegistry.GetAttributes(memberInfo, inherit);
            return list.OfType<T>().FirstOrDefault();
        }
    }
}