Quick add links or “goodbye Add Reference”

Recently, I finished one problem that has been getting to me for a very long time. Its essence is that the Add Reference dialog in Visual Studio is not needed if you take the assembly from one of those places where the studio is looking for them. It is not needed because the studio could easily index all the namespaces in these assemblies and, when writing using Biztalk give me the opportunity to add a link automatically. Since the studio cannot do this, I had to help her.

The idea itself is simple, and consists of 2 parts, namely:

You need to find all the important assemblies and index all their namespaces.
When you hover over using , you need to search for all possible assemblies and show the menu.

Indexing

The base for namespaces and paths to build files is done in seconds. The only trick is to use Cecil instead of perversions such as Assembly.ReflectionOnlyLoad() , which are trying to load the dependencies, and that's all. We quickly find all the types, write them down the names of the names in the HashSet , and put all this in the base. How? We will talk about this now.
')
First, the paths to the files that the Add Reference uses are in at least 2 places - in the registry, and in the PublicAssemblies folder. To find those folders that are listed in the registry, I wrote the following code:

public static IEnumerable< string > GetAssemblyFolders() { string [] valueNames = new [] { string .Empty, "All Assemblies In" }; string [] keyNames = new [] { @"SOFTWARE\Microsoft\.NETFramework\AssemblyFolders" , @"SOFTWARE\Wow6432Node\Microsoft\.NETFramework\AssemblyFolders" }; var result = new HashSet< string >(); foreach ( var keyName in keyNames) { using ( var key = Registry.LocalMachine.OpenSubKey(keyName)) { if (key != null ) foreach ( string subkeyName in key.GetSubKeyNames()) { using ( var subkey = key.OpenSubKey(subkeyName)) { if (subkey != null ) { foreach ( string valueName in valueNames) { string value = (subkey.GetValue(valueName) as string ?? string .Empty).Trim(); if (! string .IsNullOrEmpty( value )) result.Add( value ); } } } } } } return result; }

Initially, I had little work, because The keys on the 32-bit and 64-bit systems are different. Once again I notice that with the transition to a 64-bit system I started writing better code :)

To find the PublicAssemblies folder, you must first find where Visual Studio is installed:

public static string GetVS9InstallDirectory() { var keyNames = new string [] { @"SOFTWARE\Wow6432Node\Microsoft\VisualStudio\9.0\Setup\VS" , @"SOFTWARE\Microsoft\VisualStudio\9.0\Setup\VS" }; foreach ( var keyName in keyNames) { using ( var key = Registry.LocalMachine.OpenSubKey(keyName)) { if (key != null ) return key.GetValue( "ProductDir" ).ToString(); } } return null ; } 

Having a list of folders, you can search each of all DLL-files and index them. In addition to those folders that always appear in the Add Reference dialog, you can add your own folders, which is convenient.

using ( var dc = new StatsDataContext()) { var dirs = new HashSet< string >(); dirs.Add( @"C:\Program Files (x86)\JetBrains\ReSharper\v4.5\Bin" ); foreach ( var dir in GetAssemblyFolders()) dirs.Add(dir); dirs.Add(Path.Combine(GetVS9InstallDirectory(), @"Common7\IDE\PublicAssemblies" )); foreach ( string dir in dirs.Where(Directory.Exists)) { string [] files = Directory.GetFiles(dir, "*.dll" ); var entries = new HashSet<Namespace>(); foreach ( string file in files) { var ns = AddNamespacesFromFile(file); foreach ( var n in ns) entries.Add(n); } dc.Namespaces.InsertAllOnSubmit(entries); } dc.SubmitChanges(); }

Adding is done using the AddNamespacesFromFile() method which, as I already wrote, uses Mono.Cecil.

private static IEnumerable<Namespace> AddNamespacesFromFile( string file) { HashSet<Namespace> result = new HashSet<Namespace>(); try { var ad = AssemblyFactory.GetAssembly(file); foreach (ModuleDefinition m in ad.Modules) { foreach (TypeDefinition type in m.Types) { if (type.IsPublic && ! string .IsNullOrEmpty(type.Namespace)) { result.Add( new Namespace { AssemblyName = ad.Name.Name, AssemblyVersion = ad.Name.Version.ToString(), NamespaceName = type.Namespace, PhysicalPath = file }); } } } } catch { // it's okay, probably a non-.Net DLL } return result; }

With filling the base on it all. Then you can use the results, although I also made a background utility that allows you to refresh the data and add new paths.

Using

Not having the best options, I implemented adding links as context action for ReSharper. The idea is simple - the user hovers over the word Biztalk in the line using Biztalk; and sees the magic menu, when selecting elements of which a link is automatically added to the project.

The CA itself inherits from the CSharpContextActionBase utility class, within which, besides checking and “applicability”, nothing clever happens. Searching the database is done using a simple SELECT * from Namespaces where NamespaceName LIKE '%BizTalk%' -style selection SELECT * from Namespaces where NamespaceName LIKE '%BizTalk%' . For the base in which you will have a couple of thousand elements (well, maybe 10 thousand if you try), this approach is adequate.

protected override bool IsAvailableInternal() { items = EmptyArray<IBulbItem>.Instance; var element = GetSelectedElement<IElement>( false ); if (element == null ) return false ; var parent = element.ToTreeNode().Parent; if (parent == null || parent.GetType().Name != "ReferenceName" || parent.Parent == null || string .IsNullOrEmpty(parent.Parent.GetText())) return false ; string s = parent.Parent.GetText(); if ( string .IsNullOrEmpty(s)) return false ; var bulbItems = new HashSet<RefBulbItem>(); using ( var conn = new SqlConnection( "Data Source=(local);Initial Catalog=Stats;Integrated Security=True" )) { conn.Open(); var cmd = new SqlCommand( "select * from Namespaces where NamespaceName like '%" + s + "%'" , conn); using ( var r = cmd.ExecuteReader()) { int count = 0; while (r.Read()) { bulbItems.Add( new RefBulbItem( provider, r.GetString(2).Trim(), r.GetString(3).Trim(), r.GetString(4).Trim())); count++; } if (count > 0) { items = System.Linq.Enumerable.ToArray( System.Linq.Enumerable.ThenBy( System.Linq.Enumerable.OrderBy( bulbItems, i => i.AssemblyName), i => i.AssemblyVersion)); return true ; } } } return false ; }

Everything interesting happens in BulbItem ah, that is, yellow light bulbs that appear in the process of invoking the context menu. The light bulb itself is a kind of POCO that can add a link to a specific assembly at the right time.

protected override void ExecuteBeforeTransaction(ISolution solution, JetBrains.TextControl.ITextControl textControl, IProgressIndicator progress) { var project = provider.Project; if (project == null ) return ; var fileSystemPath = FileSystemPath.TryParse(path); if (fileSystemPath == null ) return ; var assemblyFile = provider.Solution.AddAssembly(fileSystemPath); if (assemblyFile == null ) return ; var cookie = project.GetSolution().EnsureProjectWritable(project, out project, SimpleTaskExecutor.Instance); QuickFixUtil.ExecuteUnderModification(textControl, () => project.AddModuleReference(assemblyFile.Assembly), cookie); }

I managed to write the code above only with the help of a member of the JetBrains team ( planerist - thanks!), Because I myself did not have the assiduity to find the right way.

Conclusion

I do not know how much I saved time by implementing this functionality, but the headache in the style of "sitting and waiting for Add Reference" definitely became less. And composing projects with my favorite build set (DI, Mocks, validation, utilities, etc.) has become much easier. ■

Source: https://habr.com/ru/post/75831/

All Articles

Quick add links or “goodbye Add Reference”

Indexing

Using

Conclusion

More articles: