Deprecate Lock and all related members

castleproject · Jun 22, 2018 · 8885558 · 8885558
1 parent 41c0dd2
commit 8885558
Show file tree

Hide file tree

Showing 15 changed files with 66 additions and 1 deletion.
diff --git a/buildscripts/common.props b/buildscripts/common.props
@@ -2,6 +2,7 @@
 
 	<PropertyGroup>
 		<NoWarn>$(NoWarn);CS1591;CS3014;CS3003;CS3001;CS3021</NoWarn>
+		<NoWarn>$(NoWarn);CS0612;CS0618</NoWarn> <!-- TODO: Remove this line once `[Obsolete]` members have been dealt with. -->
 		<RepositoryType>git</RepositoryType>
 		<RepositoryUrl>https://github.com/castleproject/Core</RepositoryUrl>
 		<BuildVersion>0.0.0</BuildVersion>

diff --git a/src/Castle.Core.Tests/Core.Tests/Internal/SlimReadWriteLockTestCase.cs b/src/Castle.Core.Tests/Core.Tests/Internal/SlimReadWriteLockTestCase.cs
@@ -14,11 +14,13 @@
 
 namespace Castle.Core.Internal.Tests
 {
+	using System;
 	using System.Threading;
 
 	using NUnit.Framework;
 
 	[TestFixture]
+	[Obsolete]
 	public class SlimReadWriteLockTestCase
 	{
 		private SlimReadWriteLock @lock;

diff --git a/src/Castle.Core/Core/Internal/ILockHolder.cs b/src/Castle.Core/Core/Internal/ILockHolder.cs
@@ -15,7 +15,10 @@
 namespace Castle.Core.Internal
 {
 	using System;
+	using System.ComponentModel;
 
+	[Obsolete("Consider using `System.Threading.ReaderWriterLockSlim` instead of `Lock` and related types.")] // TODO: Remove this type.
+	[EditorBrowsable(EditorBrowsableState.Never)]
 	public interface ILockHolder:IDisposable
 	{
 		bool LockAcquired { get; }

diff --git a/src/Castle.Core/Core/Internal/IUpgradeableLockHolder.cs b/src/Castle.Core/Core/Internal/IUpgradeableLockHolder.cs
@@ -14,6 +14,11 @@
 
 namespace Castle.Core.Internal
 {
+	using System;
+	using System.ComponentModel;
+
+	[Obsolete("Consider using `System.Threading.ReaderWriterLockSlim` instead of `Lock` and related types.")] // TODO: Remove this type.
+	[EditorBrowsable(EditorBrowsableState.Never)]
 	public interface IUpgradeableLockHolder : ILockHolder
 	{
 		ILockHolder Upgrade();

diff --git a/src/Castle.Core/Core/Internal/Lock.cs b/src/Castle.Core/Core/Internal/Lock.cs
@@ -14,8 +14,12 @@
 
 namespace Castle.Core.Internal
 {
+	using System;
+	using System.ComponentModel;
 	using System.Threading;
 
+	[Obsolete("Consider using `System.Threading.ReaderWriterLockSlim` instead of `Lock` and related types.")] // TODO: Remove this type.
+	[EditorBrowsable(EditorBrowsableState.Never)]
 	public abstract class Lock
 	{
 		public abstract IUpgradeableLockHolder ForReadingUpgradeable();

diff --git a/src/Castle.Core/Core/Internal/NoOpLock.cs b/src/Castle.Core/Core/Internal/NoOpLock.cs
@@ -14,6 +14,11 @@
 
 namespace Castle.Core.Internal
 {
+	using System;
+	using System.ComponentModel;
+
+	[Obsolete("Consider using `System.Threading.ReaderWriterLockSlim` instead of `Lock` and related types.")] // TODO: Remove this type.
+	[EditorBrowsable(EditorBrowsableState.Never)]
 	internal class NoOpLock : ILockHolder
 	{
 		public static readonly ILockHolder Lock = new NoOpLock();

diff --git a/src/Castle.Core/Core/Internal/NoOpUpgradeableLock.cs b/src/Castle.Core/Core/Internal/NoOpUpgradeableLock.cs
@@ -14,6 +14,11 @@
 
 namespace Castle.Core.Internal
 {
+	using System;
+	using System.ComponentModel;
+
+	[Obsolete("Consider using `System.Threading.ReaderWriterLockSlim` instead of `Lock` and related types.")] // TODO: Remove this type.
+	[EditorBrowsable(EditorBrowsableState.Never)]
 	internal class NoOpUpgradeableLock : IUpgradeableLockHolder
 	{
 		public static readonly IUpgradeableLockHolder Lock = new NoOpUpgradeableLock();

diff --git a/src/Castle.Core/Core/Internal/SlimReadLockHolder.cs b/src/Castle.Core/Core/Internal/SlimReadLockHolder.cs
@@ -14,8 +14,12 @@
 
 namespace Castle.Core.Internal
 {
+	using System;
+	using System.ComponentModel;
 	using System.Threading;
 
+	[Obsolete("Consider using `System.Threading.ReaderWriterLockSlim` instead of `Lock` and related types.")] // TODO: Remove this type.
+	[EditorBrowsable(EditorBrowsableState.Never)]
 	internal class SlimReadLockHolder : ILockHolder
 	{
 		private readonly ReaderWriterLockSlim locker;

diff --git a/src/Castle.Core/Core/Internal/SlimReadWriteLock.cs b/src/Castle.Core/Core/Internal/SlimReadWriteLock.cs
@@ -14,8 +14,12 @@
 
 namespace Castle.Core.Internal
 {
+	using System;
+	using System.ComponentModel;
 	using System.Threading;
 
+	[Obsolete("Consider using `System.Threading.ReaderWriterLockSlim` instead of `Lock` and related types.")] // TODO: Remove this type.
+	[EditorBrowsable(EditorBrowsableState.Never)]
 	internal class SlimReadWriteLock : Lock
 	{
 		private readonly ReaderWriterLockSlim locker;

diff --git a/src/Castle.Core/Core/Internal/SlimUpgradeableReadLockHolder.cs b/src/Castle.Core/Core/Internal/SlimUpgradeableReadLockHolder.cs
@@ -14,8 +14,12 @@
 
 namespace Castle.Core.Internal
 {
+	using System;
+	using System.ComponentModel;
 	using System.Threading;
 
+	[Obsolete("Consider using `System.Threading.ReaderWriterLockSlim` instead of `Lock` and related types.")] // TODO: Remove this type.
+	[EditorBrowsable(EditorBrowsableState.Never)]
 	internal class SlimUpgradeableReadLockHolder : IUpgradeableLockHolder
 	{
 		private readonly ReaderWriterLockSlim locker;

diff --git a/src/Castle.Core/Core/Internal/SlimWriteLockHolder.cs b/src/Castle.Core/Core/Internal/SlimWriteLockHolder.cs
@@ -14,8 +14,12 @@
 
 namespace Castle.Core.Internal
 {
+	using System;
+	using System.ComponentModel;
 	using System.Threading;
 
+	[Obsolete("Consider using `System.Threading.ReaderWriterLockSlim` instead of `Lock` and related types.")] // TODO: Remove this type.
+	[EditorBrowsable(EditorBrowsableState.Never)]
 	internal class SlimWriteLockHolder : ILockHolder
 	{
 		private readonly ReaderWriterLockSlim locker;

diff --git a/src/Castle.Core/DynamicProxy/Generators/BaseProxyGenerator.cs b/src/Castle.Core/DynamicProxy/Generators/BaseProxyGenerator.cs
@@ -16,6 +16,7 @@ namespace Castle.DynamicProxy.Generators
 {
 	using System;
 	using System.Collections.Generic;
+	using System.ComponentModel;
 	using System.Diagnostics;
 	using System.Linq;
 	using System.Reflection;
@@ -111,6 +112,8 @@ protected void AddMappingNoCheck(Type @interface, ITypeContributor implementer,
 			mapping.Add(@interface, implementer);
 		}
 
+		[Obsolete("Exposes a component that is intended for internal use only.")] // TODO: Remove this method.
+		[EditorBrowsable(EditorBrowsableState.Never)]
 		protected void AddToCache(CacheKey key, Type type)
 		{
 			scope.RegisterInCache(key, type);
@@ -335,6 +338,8 @@ protected ConstructorEmitter GenerateStaticConstructor(ClassEmitter emitter)
 			return emitter.CreateTypeConstructor();
 		}
 
+		[Obsolete("Exposes a component that is intended for internal use only.")] // TODO: Remove this method.
+		[EditorBrowsable(EditorBrowsableState.Never)]
 		protected Type GetFromCache(CacheKey key)
 		{
 			return scope.GetFromCache(key);
@@ -382,6 +387,8 @@ protected void InitializeStaticFields(Type builtType)
 			builtType.SetStaticField("proxyGenerationOptions", BindingFlags.NonPublic, ProxyGenerationOptions);
 		}
 
+		[Obsolete("Exposes a component that is intended for internal use only.")] // TODO: Redeclare this method as `private protected`.
+		[EditorBrowsable(EditorBrowsableState.Never)]
 		protected Type ObtainProxyType(CacheKey cacheKey, Func<string, INamingScope, Type> factory)
 		{
 			bool notFoundInTypeCache = false;

diff --git a/src/Castle.Core/DynamicProxy/Generators/CacheKey.cs b/src/Castle.Core/DynamicProxy/Generators/CacheKey.cs
@@ -15,8 +15,11 @@
 namespace Castle.DynamicProxy.Generators
 {
 	using System;
+	using System.ComponentModel;
 	using System.Reflection;
 
+	[Obsolete("Intended for internal use only.")] // TODO: Redeclare this type as `internal`.
+	[EditorBrowsable(EditorBrowsableState.Never)]
 #if FEATURE_SERIALIZATION
 	[Serializable]
 #endif

diff --git a/src/Castle.Core/DynamicProxy/ModuleScope.cs b/src/Castle.Core/DynamicProxy/ModuleScope.cs
@@ -16,6 +16,7 @@ namespace Castle.DynamicProxy
 {
 	using System;
 	using System.Collections.Generic;
+	using System.ComponentModel;
 	using System.Diagnostics;
 	using System.IO;
 	using System.Reflection;
@@ -57,7 +58,9 @@ public class ModuleScope
 		private readonly Dictionary<CacheKey, Type> typeCache = new Dictionary<CacheKey, Type>();
 
 		// Users of ModuleScope should use this lock when accessing the cache
+		[Obsolete] // TODO: Remove this field together with the `Lock` property.
 		private readonly Lock cacheLock;
+
 		private readonly ReaderWriterLockSlim typeCacheLock;
 
 		// Used to lock the module builder creation
@@ -158,6 +161,8 @@ public INamingScope NamingScope
 		/// <summary>
 		///   Users of this <see cref = "ModuleScope" /> should use this lock when accessing the cache.
 		/// </summary>
+		[Obsolete("Exposes a component that is intended for internal use only.")] // TODO: Remove this property.
+		[EditorBrowsable(EditorBrowsableState.Never)]
 		public Lock Lock
 		{
 			get { return cacheLock; }
@@ -168,6 +173,8 @@ public Lock Lock
 		/// </summary>
 		/// <param name = "key">The key to be looked up in the cache.</param>
 		/// <returns>The type from this scope's type cache matching the key, or null if the key cannot be found</returns>
+		[Obsolete("Exposes a component that is intended for internal use only.")] // TODO: Remove this method.
+		[EditorBrowsable(EditorBrowsableState.Never)]
 		public Type GetFromCache(CacheKey key)
 		{
 			Type type;
@@ -180,6 +187,8 @@ public Type GetFromCache(CacheKey key)
 		/// </summary>
 		/// <param name = "key">The key to be associated with the type.</param>
 		/// <param name = "type">The type to be stored in the cache.</param>
+		[Obsolete("Exposes a component that is intended for internal use only.")] // TODO: Remove this method.
+		[EditorBrowsable(EditorBrowsableState.Never)]
 		public void RegisterInCache(CacheKey key, Type type)
 		{
 			typeCache[key] = type;
@@ -648,7 +657,7 @@ public void LoadAssemblyIntoCache(Assembly assembly)
 
 				if (loadedType != null)
 				{
-					RegisterInCache(mapping.Key, loadedType);
+					typeCache[mapping.Key] = loadedType;
 				}
 			}
 		}

diff --git a/src/Castle.Core/DynamicProxy/Serialization/CacheMappingsAttribute.cs b/src/Castle.Core/DynamicProxy/Serialization/CacheMappingsAttribute.cs
@@ -18,6 +18,7 @@ namespace Castle.DynamicProxy.Serialization
 {
 	using System;
 	using System.Collections.Generic;
+	using System.ComponentModel;
 	using System.IO;
 	using System.Reflection;
 	using System.Reflection.Emit;
@@ -47,6 +48,8 @@ public byte[] SerializedCacheMappings
 			get { return serializedCacheMappings; }
 		}
 
+		[Obsolete("Exposes a component that is intended for internal use only.")] // TODO: Redeclare this method as `internal`.
+		[EditorBrowsable(EditorBrowsableState.Never)]
 		public Dictionary<CacheKey, string> GetDeserializedMappings()
 		{
 			using (var stream = new MemoryStream(SerializedCacheMappings))
@@ -56,6 +59,8 @@ public Dictionary<CacheKey, string> GetDeserializedMappings()
 			}
 		}
 
+		[Obsolete("Exposes a component that is intended for internal use only.")] // TODO: Redeclare this method as `internal`.
+		[EditorBrowsable(EditorBrowsableState.Never)]
 		public static void ApplyTo(AssemblyBuilder assemblyBuilder, Dictionary<CacheKey, string> mappings)
 		{
 			using (var stream = new MemoryStream())