Parcourez les épines des vélos, première partie: découvrez les bases de la personnalisation du débogueur Visual Studio à l'aide de plugins

L'une des innovations de Visual Studio 2012 s'est accompagnée de l'apparition d'un nouveau débogueur personnalisé appelé Concord. Son système de composants permet aux plug-ins VSIX de personnaliser le comportement du débogueur et d'écrire de nouveaux outils contextuels qui peuvent utiliser le débogueur pour leurs besoins. Son API fournit de nombreuses fonctionnalités QOL, telles que le marshaling entre le code managé / non managé, l'intégration transparente avec un processus distant / débogué localement, et plus encore. En fait, presque tout ce qui peut être fait dans l'EDI peut être fait par programme en utilisant l'API Concord! Modifiez les valeurs de variables spécifiques à la volée, appelez des fonctions sur demande (ou faites spécifiquement le programme leur sauter des appels!), Les plugins peuvent rechercher par PDB (!), Bypass étape par étape et même modification de code! Ouvrez le chat et vous découvrirez ces innovations peu connues dans le domaine de la construction de vélos.

Vous devriez probablement recommencer depuis le début. Le débogueur détecte les composants en lisant les informations du fichier vsdconfig référencé par le manifeste du plugin VSIX. À son tour, vsdconfig indique quelles interfaces sont implémentées par les composants du plugin et comment trouver ces composants (lien vers un fichier .dll, indiquant la classe ou, dans le cas de l'implémentation native, indiquant CLSID. Je donnerai des exemples en C #). De plus, un identifiant unique (GUID) pour chaque composant est indiqué, ainsi que son "niveau". Un niveau est ce qui détermine dans quel ordre les plugins seront traités, ainsi que dans le contexte de quel processus cette implémentation sera chargée - dans le processus IDE ou dans le processus de l'application déboguée. Cela est dû au fait que certaines fonctionnalités ne peut fonctionner que dans le cadre de l'IDE, et vice versa - que dans le contexte du processus en cours de débogage. Certaines fonctions API fonctionnent de la même manière ici et là. En outre, un certain nombre de composants ont leurs propres règles de disposition, car ils peuvent dépendre des éléments de débogueur existants situés à leurs niveaux fixes. Pour éviter les incidents, je recommande RTFM (https://docs.microsoft.com/en-us/dotnet/api/microsoft.visualstudio.debugger.componentinterfaces?view=visualstudiosdk-2017) et des expériences indépendantes dans un bac à sable séparé, ce qui ne sera pas dommage. supprimer si quelque chose se produit (cela est connecté, encore une fois, avec une telle nuance - dans certains cas, il n'est même pas clair pourquoi l'assemblage ou le type ne se charge pas, car je ne pouvais toujours pas trouver où les journaux apparaîtraient qui signaleraient le problème de manière stable. Erreur, par exemple, en référence à une dépendance qui ne peut pas être chargée dans le processus cible, elle peut apparaître dans la sortie st di-, ou non. Soyez akuratno, prenez commits fréquentes, et ne restez pas assis derrière le volant ivre).

La liste des niveaux est la suivante (je donnerai le texte en anglais pour que le lecteur n'ait pas d'incidents lors de la réalisation d'actes RFTM):

Niveaux des composants IDE (valeurs> 100 000):

Niveaux de composants du processus cible (valeurs <99,999):

Ensuite, dans l'ordre, le processus de création d'un projet. S'il n'y avait pas de nuances importantes, je pourrais décrire ce processus de manière minimale ou l'ignorer du tout, mais les réalités sont complètement différentes - nous avons besoin d'un certain nombre de dépendances de bibliothèque, ainsi que d'un outil pour créer des fichiers de configuration, qui pour une raison quelconque n'est pas distribué avec VisualStudio, mais est disponible uniquement avec pépite. En fait, nous devons maintenant passer à l'essentiel. Le processus de création et de configuration d'un projet est structuré comme suit:

1. Ouvrez Visual Studio. Dans mon cas, 2017 Community Edition
2. Projet VSIX ( Visual C # -> onglet Extensibilité , ou via la recherche). Appelons ça "HelloVSIX"
3. Ajoutez un nouveau projet de bibliothèque de classes dans la solution et appelez-le «DebuggeePlugin»
4. Nous mettons la référence sur le projet "DebuggeePlugin" dans le projet "HelloVSIX"
5. Nous mettons la référence à l'assembly "Microsoft.VisualStudio.Debugger.Engine" dans le projet DebuggeePlugin
6. Ajouter au projet «DebuggeePlugin» une référence à l'ensemble NuGet Microsoft.VSSDK.Debugger.VSDConfigTool. Ceci est notre outil pour générer des configurations VSD.

Maintenant, nous sommes prêts à faire de notre plugin quelque chose d'utile. Faisons la chose la plus simple que vous puissiez faire - laissez-le afficher un MessageBox qui dit "Bonjour VSIX" lorsque le processus cible rencontre un point d'entrée. Pour ce faire, nous devons créer une classe qui implémente l'interface IDkmEntryPointNotification , ainsi que remplir plusieurs fichiers de configuration. Ajoutez une nouvelle classe publique appelée DkmEntryPointNotificationService et héritez de l' interface IDkmEntryPointNotification et laissez l'implémentation par défaut pour l'instant:

using Microsoft.VisualStudio.Debugger; using Microsoft.VisualStudio.Debugger.ComponentInterfaces; using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; namespace DebuggeePlugin { class DkmEntryPointNotificationService : IDkmEntryPointNotification { public void OnEntryPoint(DkmProcess process, DkmThread thread, DkmEventDescriptor eventDescriptor) { throw new NotImplementedException(); } } } 

Ajoutez le fichier «DkmEntryPointNotificationService.vsdconfigxml» au projet «DebuggeePlugin». Pour chaque classe déclarée qui doit recevoir des notifications via les implémentations des interfaces d'espace de noms Microsoft.VisualStudio.Debugger.ComponentInterfaces, vous devez disposer d'un tel fichier. Soit dit en passant, il est possible d'implémenter plusieurs de ces interfaces à la fois dans une même classe. Nous devons maintenant modifier l'action de génération de notre fichier ".vsdconfigxml". Pour ce faire, vous devez éditer manuellement le fichier de projet (j'ai sérieusement). Nous déchargeons le projet DebuggeePlugin et l'ouvrons avec l'éditeur de studio. Nous devons trouver la balise XLM suivante:

 <None Include="DkmEntryPointNotificationService.vsdconfigxml" /> 

et déplacez cette balise vers votre propre ItemGroup, en changeant le type de None en VsdConfigXmlFiles:

 <ItemGroup> <VsdConfigXmlFiles Include="DkmEntryPointNotificationService.vsdconfigxml" /> </ItemGroup> 

Vous pouvez enregistrer et recharger le projet.

Maintenant, allez dans les configs. La première chose à faire: si «DebuggeePlugin» a ajouté le fichier de projet vsdconfig.xsd, alors il doit être retiré. Nous allons le remplacer maintenant, car il est plus facile de travailler avec du texte brut. Ouvrez DkmEntryPointNotificationService.vsdconfigxml et remplacez le texte par ce qui suit:

 <?xml version="1.0" encoding="utf-8"?> <Configuration xmlns="http://schemas.microsoft.com/vstudio/vsdconfig/2008"> <ManagedComponent ComponentId="422413E1-450E-40A6-AE24-7E80A81CC668" ComponentLevel=^_^quot𘙮quot^_^ AssemblyName="DebuggeePlugin"> <Class Name="DebuggeePlugin.DkmEntryPointNotificationService"> <Implements> <InterfaceGroup> <NoFilter/> <Interface Name="IDkmEntryPointNotification"/> </InterfaceGroup> </Implements> </Class> </ManagedComponent> </Configuration> 

Dans tout fichier de ce type, nous devrons indiquer les éléments suivants:

1. ComponentId - cette valeur peut être générée à l'aide de l'outil de génération de GUID (Tools -> CreateGUID)
2. ComponentLevel est le niveau de notre composant dans la hiérarchie. Consultez le tableau ci-dessus et les informations d'aide sur MSDN pour sélectionner la plage de valeurs souhaitée.
3. Assemblyname est le nom de notre assemblage (pas une solution!). Dans ce cas, il y aura un DebuggeePlugin
4. Nom de classe - doit être indiqué, y compris l'espace de noms dans lequel se trouve la classe. Dans ce cas, DebuggeePlugin.DkmEntryPointNotificationService
5. Tableau InterfaceGroup - chaque entrée qu'il contient indique une interface implémentée par ce composant. À l'intérieur de chaque nœud InterfaceGroup, il devrait y avoir un sous-nœud indiquant les interfaces communes à tous, dans ce groupe, filtre, mais sur les filtres plus tard. Nous avons maintenant un seul nœud d'interface et porte le nom de l'interface IdkmEntryPointNotification. Si nous avions plusieurs interfaces, il y aurait plusieurs nœuds d'interface.

Permettez-moi de vous rappeler que pour chaque classe qui devrait recevoir des notifications du débogueur, il doit y avoir un tel fichier. Mais le plaisir ne s'arrête pas là. Chacun de ces fichiers est ensuite collecté dans un fichier .vsdconfig dans le répertoire de sortie du projet. Et ils doivent être référencés dans le manifeste du plugin. Cela se fait comme suit:

1. Après avoir formé le fichier ".vsdconfigxml", nous devons ... collecter la solution une fois, sinon nous n'aurons aucun fichier .vsdconfig dans le répertoire de sortie du projet)
2. Après cela, ouvrez l'éditeur de texte pour le fichier source.extension.vsixmanifest et ajoutez le code suivant avant la balise PackageManifest de fermeture:

  <Assets> <Asset Type="DebuggerEngineExtension" d:Source="File" Path="DebuggeePlugin.vsdconfig" /> </Assets> 

Si, après les actions terminées, le fichier «DebuggeePlugin.vsdconfig» apparaît dans le projet HelloVSIX, il doit être SUPPRIMÉ DU PROJET et la solution doit être collectée à nouveau, sinon elle ne sera pas mise à jour.

Les travaux préparatoires sont terminés! Vous pouvez commencer à déboguer notre plugin. Cela se fait en démarrant une instance expérimentale de VisualStudio (pour les projets VSIX, il s'agit de la cible de débogage par défaut, donc aucune étape supplémentaire n'est nécessaire). En fait, nous cliquons sur Debug-> StartDebugging et nous voyons une instance expérimentale de VisualStudio. Dans celui-ci, par défaut, notre plugin devrait déjà être installé. Vous pouvez le vérifier via le menu Outils-> Extensions et mises à jour.

Du fait que nous avons implémenté l'interface IDkmEntryPointNotification, nous devrons créer un projet de test dans une instance expérimentale de VisualStudio. En fait, nous créons un nouveau projet, sélectionnez C ++ -> Application console (choisissez C ++, car les exemples suivants contiendront des spécificités C ++), appelez-le VSIXTestApp , exécutez sans aucune modification, collectez et voyez que notre instance expérimentale a cessé de lever une exception à l'intérieur de la méthode DebuggeePlugin. DkmEntryPointNotificationService.OnEntryPoint. Super! Vous devez maintenant afficher la MessageBox. Pour ce faire, il est nécessaire d'ajouter les références suivantes au projet DebuggeePlugin:

• Microsoft.VisualStudio.Shell.15.0
• Microsoft.VisualStudio.Shell.Interop
• Microsoft.VisualStudio.Shell.Interop.8.0
• Microsoft.VisualStudio.OLE.Interop

Ajoutez deux utilisations au début du fichier DkmEntryPointNotificationService.cs:

 using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Shell.Interop; 

Et ajoutez un appel à la méthode VsShellUtilities.ShowMessageBox dans la méthode DkmEntryPointNotificationService.OnEntryPoint:

 using Microsoft.VisualStudio.Debugger; using Microsoft.VisualStudio.Debugger.ComponentInterfaces; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Shell.Interop; using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; namespace DebuggeePlugin { class DkmEntryPointNotificationService : IDkmEntryPointNotification { public void OnEntryPoint(DkmProcess process, DkmThread thread, DkmEventDescriptor eventDescriptor) { VsShellUtilities.ShowMessageBox(Microsoft.VisualStudio.Shell.ServiceProvider.GlobalProvider, "Hello VSIX", "Hello VSIX", OLEMSGICON.OLEMSGICON_INFO, OLEMSGBUTTON.OLEMSGBUTTON_OK, OLEMSGDEFBUTTON.OLEMSGDEFBUTTON_FIRST); } } } l' using Microsoft.VisualStudio.Debugger; using Microsoft.VisualStudio.Debugger.ComponentInterfaces; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Shell.Interop; using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; namespace DebuggeePlugin { class DkmEntryPointNotificationService : IDkmEntryPointNotification { public void OnEntryPoint(DkmProcess process, DkmThread thread, DkmEventDescriptor eventDescriptor) { VsShellUtilities.ShowMessageBox(Microsoft.VisualStudio.Shell.ServiceProvider.GlobalProvider, "Hello VSIX", "Hello VSIX", OLEMSGICON.OLEMSGICON_INFO, OLEMSGBUTTON.OLEMSGBUTTON_OK, OLEMSGDEFBUTTON.OLEMSGDEFBUTTON_FIRST); } } } du using Microsoft.VisualStudio.Debugger; using Microsoft.VisualStudio.Debugger.ComponentInterfaces; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Shell.Interop; using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; namespace DebuggeePlugin { class DkmEntryPointNotificationService : IDkmEntryPointNotification { public void OnEntryPoint(DkmProcess process, DkmThread thread, DkmEventDescriptor eventDescriptor) { VsShellUtilities.ShowMessageBox(Microsoft.VisualStudio.Shell.ServiceProvider.GlobalProvider, "Hello VSIX", "Hello VSIX", OLEMSGICON.OLEMSGICON_INFO, OLEMSGBUTTON.OLEMSGBUTTON_OK, OLEMSGDEFBUTTON.OLEMSGDEFBUTTON_FIRST); } } } 

Nous reconstruisons, lançons une instance expérimentale du studio, lançons un projet de test et le tour est joué!

Nous voyons que l'instance de test du studio a créé MessageBox!



Et qu'en est-il en fait?

Ici, nous avons appris à configurer un projet VSIX contenant un plug-in pour le débogueur Visual Studio, en tenant compte de la plupart des nuances qui entravent le résultat. C'est le point de départ d'un travail plus détaillé. Dans le prochain article, je vais vous montrer un autre point important: comment la communication a lieu entre l'IDE et les composants cibles de débogage.

Pour obtenir de l'aide sur l'utilisation de l'API Concord, vous pouvez vous référer non seulement à MSDN, mais également aux référentiels Microsoft suivants sur le github:
github.com/microsoft/PTVS
github.com/Microsoft/ConcordExtensibilitySamples