Condividi tramite


Architettura dei plug-in del controllo del codice sorgente

È possibile aggiungere il supporto del controllo del codice sorgente all'ambiente di sviluppo integrato (IDE) di Visual Studio implementando e collegando un plug-in del controllo del codice sorgente. L'IDE si connette al plug-in del controllo del codice sorgente tramite l'API plug-in di controllo del codice sorgente ben definita. L'IDE espone le funzionalità di controllo della versione del sistema di controllo del codice sorgente fornendo un'interfaccia utente costituita da barre degli strumenti e comandi di menu. Il plug-in del controllo del codice sorgente implementa la funzionalità di controllo del codice sorgente.

Risorse del plug-in del controllo del codice sorgente

Il plug-in controllo del codice sorgente fornisce risorse che consentono di creare e connettere l'applicazione di controllo delle versioni all'IDE di Visual Studio. Il plug-in controllo del codice sorgente contiene la specifica dell'API che deve essere implementata da un plug-in del controllo del codice sorgente in modo che possa essere integrata nell'IDE di Visual Studio. Contiene anche un esempio di codice (scritto in C++) che implementa uno scheletro di plug-in di controllo del codice sorgente che dimostra l'implementazione di funzioni essenziali conformi all'API Plug-in del controllo del codice sorgente.

La specifica dell'API Plug-in del controllo del codice sorgente consente di sfruttare qualsiasi sistema di controllo del codice sorgente di propria scelta se si crea una DLL del controllo del codice sorgente con il set di funzioni richiesto implementato in conformità con l'API plug-in del controllo del codice sorgente.

Componenti

Il pacchetto dell'adattatore del controllo del codice sorgente nel diagramma è il componente dell'IDE che converte la richiesta dell'utente per un'operazione di controllo del codice sorgente in una chiamata di funzione supportata dal plug-in del controllo del codice sorgente. Affinché ciò accada, l'IDE e il plug-in del controllo del codice sorgente devono avere un dialogo efficace che passa le informazioni tra l'IDE e il plug-in. Affinché questo dialogo venga eseguito, entrambi devono parlare la stessa lingua. L'API plug-in del controllo del codice sorgente descritta in questa documentazione è il vocabolario comune per questo scambio.

Diagramma dell'architettura del controllo del codice sorgente

Diagramma dell'architettura che mostra l'interazione tra VS e il plug-in del controllo del codice sorgente

Come illustrato nel diagramma dell'architettura, la shell di Visual Studio, etichettata come shell di Visual Studio nel diagramma, ospita i progetti di lavoro dell'utente e i componenti associati, ad esempio gli editor e Esplora soluzioni. Il pacchetto dell'adattatore del controllo del codice sorgente gestisce l'interazione tra l'IDE e il plug-in del controllo del codice sorgente. Il pacchetto dell'adattatore del controllo del codice sorgente fornisce un'interfaccia utente del controllo del codice sorgente personalizzata. È l'interfaccia utente di primo livello con cui l'utente interagisce per avviare e definire l'ambito di un'operazione di controllo del codice sorgente.

Il plug-in del controllo del codice sorgente può avere una propria interfaccia utente, che può essere costituita da due parti, come illustrato nella figura. La casella con etichetta "Vendor UI" rappresenta elementi dell'interfaccia utente personalizzati forniti dall'utente, come creatore del plug-in del controllo del codice sorgente. Questi vengono visualizzati direttamente dal plug-in del controllo del codice sorgente quando l'utente richiama un'operazione avanzata di controllo del codice sorgente. La casella "Helper UI" è un set di funzionalità dell'interfaccia utente del plug-in del controllo del codice sorgente richiamate indirettamente tramite l'IDE. Il plug-in del controllo del codice sorgente passa messaggi correlati all'interfaccia utente all'IDE tramite funzioni di callback speciali fornite dall'IDE. L'interfaccia utente helper facilita un'integrazione più semplice con l'IDE (spesso tramite l'uso di un pulsante Avanzato ) e offre quindi un'esperienza utente finale più unificata.

Un plug-in del controllo del codice sorgente non può apportare modifiche alla shell di Visual Studio e, di conseguenza, al pacchetto dell'adapter di controllo del codice sorgente o all'interfaccia utente del controllo del codice sorgente fornita dall'IDE. Deve sfruttare al massimo la flessibilità offerta tramite l'implementazione delle varie funzioni API plug-in del controllo del codice sorgente che contribuiscono a un'esperienza integrata per l'utente finale. La sezione di riferimento della documentazione dell'API Plug-in del controllo del codice sorgente include informazioni per alcune funzionalità avanzate del plug-in del controllo del codice sorgente. Per sfruttare queste funzionalità, il plug-in del controllo del codice sorgente deve dichiarare le sue funzionalità avanzate all'IDE durante l'inizializzazione e deve implementare funzioni avanzate specifiche per ogni funzionalità.