CodeGeneratorRegistrationAttribute.cs :  » Development » StyleCop » Microsoft » VisualStudio » Shell » C# / CSharp Open Source

/***************************************************************************

Copyright (c) Microsoft Corporation. All rights reserved.
This code is licensed under the Visual Studio SDK license terms.
THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF
ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY
IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR
PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.

***************************************************************************/

using System;
using System.Globalization;

namespace Microsoft.VisualStudio.Shell{
  /// <summary>
  /// This attribute adds a custom file generator registry entry for specific file 
    /// type. 
  /// For Example:
  ///   [HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\VisualStudio\9.0\Generators\
    ///    {fae04ec1-301f-11d3-bf4b-00c04f79efbc}\MyGenerator]
    ///      "CLSID"="{AAAA53CC-3D4F-40a2-BD4D-4F3419755476}"
    ///         "GeneratesDesignTimeSource" = d'1'
  /// 
  /// </summary>
  [AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = true)]
  public sealed class CodeGeneratorRegistrationAttribute : RegistrationAttribute
  {
    private string _contextGuid;
    private Type _generatorType;
        private Guid _generatorGuid;
    private string _generatorName;
        private string _generatorRegKeyName;
        private bool _generatesDesignTimeSource = false;
        private bool _generatesSharedDesignTimeSource = false;
    /// <summary>
        /// Creates a new CodeGeneratorRegistrationAttribute attribute to register a custom
    /// code generator for the provided context. 
    /// </summary>
        /// <param name="generatorType">The type of Code generator. Type that implements IVsSingleFileGenerator</param>
        /// <param name="generatorName">The generator name</param>
        /// <param name="contextGuid">The context GUID this code generator would appear under.</param>
        public CodeGeneratorRegistrationAttribute(Type generatorType, string generatorName, string contextGuid)
    {
            if (generatorType == null)
                throw new ArgumentNullException("generatorType");
            if (generatorName == null)
                throw new ArgumentNullException("generatorName");
            if (contextGuid == null)
                throw new ArgumentNullException("contextGuid");

            _contextGuid = contextGuid;
            _generatorType = generatorType;
            _generatorName = generatorName;
            _generatorRegKeyName = generatorType.Name;
            _generatorGuid = generatorType.GUID;
        }

    /// <summary>
    /// Get the generator Type
    /// </summary>
    public Type GeneratorType
    {
            get { return _generatorType; }
    }

    /// <summary>
    /// Get the Guid representing the project type
    /// </summary>
    public string ContextGuid
    {
            get { return _contextGuid; }
    }

        /// <summary>
        /// Get the Guid representing the generator type
        /// </summary>
        public Guid GeneratorGuid
        {
            get { return _generatorGuid; }
        }

    /// <summary>
        /// Get or Set the GeneratesDesignTimeSource value
    /// </summary>
        public bool GeneratesDesignTimeSource
    {
            get { return _generatesDesignTimeSource; }
            set { _generatesDesignTimeSource = value; }
    }

        /// <summary>
        /// Get or Set the GeneratesSharedDesignTimeSource value
        /// </summary>
        public bool GeneratesSharedDesignTimeSource
        {
            get { return _generatesSharedDesignTimeSource; }
            set { _generatesSharedDesignTimeSource = value; }
        }


        /// <summary>
        /// Gets the Generator name 
        /// </summary>
        public string GeneratorName
        {
            get { return _generatorName; }
        }

        /// <summary>
        /// Gets the Generator reg key name under 
        /// </summary>
        public string GeneratorRegKeyName
        {
            get { return _generatorRegKeyName; }
            set { _generatorRegKeyName = value; }
        }

        /// <summary>
        /// Property that gets the generator base key name
        /// </summary>
        private string GeneratorRegKey
        {
            get { return string.Format(CultureInfo.InvariantCulture, @"Generators\{0}\{1}", ContextGuid, GeneratorRegKeyName); }
        }
    /// <summary>
    ///     Called to register this attribute with the given context.  The context
    ///     contains the location where the registration inforomation should be placed.
    ///     It also contains other information such as the type being registered and path information.
    /// </summary>
    public override void Register(RegistrationContext context)
    {
            using (Key childKey = context.CreateKey(GeneratorRegKey))
            {
                childKey.SetValue(string.Empty, GeneratorName);
                childKey.SetValue("CLSID", GeneratorGuid.ToString("B"));

                if (GeneratesDesignTimeSource)
                    childKey.SetValue("GeneratesDesignTimeSource", 1);

                if (GeneratesSharedDesignTimeSource)
                    childKey.SetValue("GeneratesSharedDesignTimeSource", 1);

            }

        }

    /// <summary>
    /// Unregister this file extension.
    /// </summary>
    /// <param name="context"></param>
    public override void Unregister(RegistrationContext context)
    {
            context.RemoveKey(GeneratorRegKey);
    }
  }
}