/***************************************************************************
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;
using MsVsShell = Microsoft.VisualStudio.Shell;
namespace BruSoft.VS2P4
{
/// <summary>
/// This attribute registers the source control provider.
/// This file contains the implementation of a custom registration attribute that registers a source control provider.
/// It is used to make the source control provider visible on the Tools, Options, SourceControl, Plugins page.
/// </summary>
[AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = true)]
public sealed class ProvideSourceControlProvider : MsVsShell.RegistrationAttribute
{
private string _regName = null;
private string _uiName = null;
/// <summary>
/// </summary>
public ProvideSourceControlProvider(string regName, string uiName)
{
_regName = regName;
_uiName = uiName;
}
/// <summary>
/// Get the friendly name of the provider (written in registry)
/// </summary>
public string RegName
{
get { return _regName; }
}
/// <summary>
/// Get the unique guid identifying the provider
/// </summary>
public Guid RegGuid
{
get { return GuidList.guidSccProvider; }
}
/// <summary>
/// Get the UI name of the provider (string resource ID)
/// </summary>
public string UIName
{
get { return _uiName; }
}
/// <summary>
/// Get the package containing the UI name of the provider
/// </summary>
public Guid UINamePkg
{
get { return GuidList.guidSccProviderPkg; }
}
/// <summary>
/// Get the guid of the provider's service
/// </summary>
public Guid SccProviderService
{
get { return GuidList.guidSccProviderService; }
}
/// <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)
{
// Write to the context's log what we are about to do
context.Log.WriteLine(String.Format(CultureInfo.CurrentCulture, "VS2P4Package:\t\t{0}\n", RegName));
// Declare the source control provider, its name, the provider's service
// and aditionally the packages implementing this provider
using (Key sccProviders = context.CreateKey("SourceControlProviders"))
{
using (Key sccProviderKey = sccProviders.CreateSubkey(RegGuid.ToString("B")))
{
sccProviderKey.SetValue("", RegName);
sccProviderKey.SetValue("Service", SccProviderService.ToString("B"));
using (Key sccProviderNameKey = sccProviderKey.CreateSubkey("Name"))
{
sccProviderNameKey.SetValue("", UIName);
sccProviderNameKey.SetValue("Package", UINamePkg.ToString("B"));
sccProviderNameKey.Close();
}
// Additionally, you can create a "Packages" subkey where you can enumerate the dll
// that are used by the source control provider, something like "Package1"="VS2P4Package.dll"
// but this is not a requirement.
sccProviderKey.Close();
}
sccProviders.Close();
}
}
/// <summary>
/// Unregister the source control provider
/// </summary>
/// <param name="context"></param>
public override void Unregister(RegistrationContext context)
{
context.RemoveKey("SourceControlProviders\\" + GuidList.guidSccProviderPkg.ToString("B"));
}
}
}