Architecture du plug-in de contrôle de code source
Vous pouvez ajouter la prise en charge du contrôle de code source à l’environnement de développement intégré (IDE) Visual Studio en implémentant et en attachant un plug-in de contrôle de code source. L’IDE se connecte au plug-in de contrôle de code source via l’API plug-in de contrôle de code source bien définie. L’IDE expose les fonctionnalités de contrôle de version du système de contrôle de code source en fournissant une interface utilisateur qui se compose de barres d’outils et de commandes de menu. Le plug-in de contrôle de code source implémente la fonctionnalité de contrôle de code source.
Ressources de plug-in de contrôle de code source
Le plug-in de contrôle de code source fournit des ressources pour vous aider à créer et connecter votre application de contrôle de version à l’IDE Visual Studio. Le plug-in de contrôle de code source contient la spécification de l’API qui doit être implémentée par un plug-in de contrôle de code source afin qu’il puisse être intégré à l’IDE Visual Studio. Il contient également un exemple de code (écrit en C++) qui implémente un plug-in de contrôle de code source squelette illustrant l’implémentation des fonctions essentielles conformes à l’API plug-in de contrôle de code source.
La spécification de l’API plug-in de contrôle de code source vous permet de tirer parti de n’importe quel système de contrôle de code source de votre choix si vous créez une DLL de contrôle de code source avec l’ensemble requis de fonctions implémentées conformément à l’API plug-in de contrôle de code source.
Composants
Le package de l’adaptateur de contrôle de code source dans le diagramme est le composant de l’IDE qui traduit la demande de l’utilisateur pour une opération de contrôle de code source en un appel de fonction pris en charge par le plug-in de contrôle de code source. Pour ce faire, l’IDE et le plug-in de contrôle de code source doivent avoir une boîte de dialogue efficace qui transmet les informations entre l’IDE et le plug-in. Pour que ce dialogue se produise, ils doivent tous les deux parler la même langue. L’API plug-in de contrôle de code source décrite dans cette documentation est le vocabulaire courant de cet échange.
Diagramme d’architecture montrant l’interaction entre vs et le plug-in de contrôle de code source
Comme illustré dans le diagramme d’architecture, l’interpréteur de commandes Visual Studio, étiqueté en tant qu’interpréteur de commandes VS dans le diagramme, héberge les projets de travail de l’utilisateur et les composants associés, tels que les éditeurs et les Explorateur de solutions. Le package de l’adaptateur de contrôle de code source gère l’interaction entre l’IDE et le plug-in de contrôle de code source. Le package de l’adaptateur de contrôle de code source fournit son propre interface utilisateur de contrôle de code source. Il s’agit de l’interface utilisateur de niveau supérieur avec laquelle l’utilisateur interagit pour lancer et définir l’étendue d’une opération de contrôle de code source.
Le plug-in de contrôle de code source peut avoir sa propre interface utilisateur, qui peut se composer de deux parties, comme illustré dans la figure. La zone intitulée « Interface utilisateur du fournisseur » représente des éléments d’interface utilisateur personnalisés que vous, en tant que créateur de plug-in de contrôle de code source, fournissez. Celles-ci sont affichées directement par le plug-in de contrôle de code source lorsque l’utilisateur appelle une opération de contrôle de code source avancée. La zone intitulée « Interface utilisateur d’assistance » est un ensemble de fonctionnalités d’interface utilisateur du plug-in de contrôle de code source qui sont indirectement appelées via l’IDE. Le plug-in de contrôle de code source transmet les messages liés à l’interface utilisateur à l’IDE via des fonctions de rappel spéciales fournies par l’IDE. L’interface utilisateur d’assistance facilite une intégration plus transparente avec l’IDE (souvent grâce à l’utilisation d’un bouton Avancé ) et offre ainsi une expérience utilisateur final plus unifiée.
Un plug-in de contrôle de code source ne peut pas apporter de modifications à l’interpréteur de commandes Visual Studio et, par conséquent, au package de l’adaptateur de contrôle de code source ou à l’interface utilisateur du contrôle de code source fournie par l’IDE. Elle doit utiliser au maximum la flexibilité offerte par l’implémentation des différentes fonctions d’API plug-in de contrôle de code source qui contribuent à une expérience intégrée pour l’utilisateur final. La section de référence de la documentation de l’API plug-in de contrôle de code source contient des informations sur certaines fonctionnalités avancées du plug-in de contrôle de code source. Pour exploiter ces fonctionnalités, le plug-in de contrôle de code source doit déclarer ses fonctionnalités avancées à l’IDE pendant l’initialisation, et il doit implémenter des fonctions avancées spécifiques pour chaque fonctionnalité.