Architektura wtyczki kontroli kodu źródłowego
Obsługę kontroli źródła można dodać do zintegrowanego środowiska projektowego (IDE) programu Visual Studio, implementując i dołączając wtyczkę kontroli źródła. Środowisko IDE łączy się z wtyczką kontroli źródła za pośrednictwem dobrze zdefiniowanego interfejsu API wtyczki kontroli źródła. Środowisko IDE uwidacznia funkcje kontroli wersji systemu kontroli źródła, udostępniając interfejs użytkownika składający się z pasków narzędzi i poleceń menu. Wtyczka kontroli źródła implementuje funkcję kontroli źródła.
Zasoby wtyczki kontroli źródła
Wtyczka kontroli źródła udostępnia zasoby ułatwiające tworzenie i łączenie aplikacji do przechowywania wersji z środowiskiem IDE programu Visual Studio. Wtyczka kontroli źródła zawiera specyfikację interfejsu API, która musi zostać zaimplementowana przez wtyczkę kontroli źródła, aby można ją było zintegrować ze środowiskiem IDE programu Visual Studio. Zawiera również przykład kodu (napisany w języku C++), który implementuje wtyczkę do kontroli kodu szkieletowego demonstrujące implementację podstawowych funkcji zgodnych z interfejsem API wtyczki kontroli kodu źródłowego.
Specyfikacja interfejsu API wtyczki kontroli źródła umożliwia wykorzystanie dowolnego wybranego systemu kontroli źródła, jeśli utworzysz bibliotekę DLL kontroli źródła z wymaganym zestawem funkcji zaimplementowanych zgodnie z interfejsem API wtyczki kontroli źródła.
Składniki
Pakiet adaptera kontroli źródła na diagramie jest składnikiem środowiska IDE, który tłumaczy żądanie użytkownika dla operacji kontroli źródła na wywołanie funkcji obsługiwane przez wtyczkę kontroli źródła. W takim przypadku środowisko IDE i wtyczka kontroli źródła muszą mieć skuteczne okno dialogowe, które przekazuje informacje między środowiskiem IDE i wtyczką. Aby to okno dialogowe odbywało się, oba muszą mówić w tym samym języku. Interfejs API wtyczki kontroli kodu źródłowego opisany w tej dokumentacji jest typowym słownictwem dla tej wymiany.
Diagram architektury przedstawiający interakcję między programem VS i wtyczką kontroli źródła
Jak pokazano na diagramie architektury, powłoka programu Visual Studio oznaczona jako powłoka programu VS na diagramie, hostuje projekty robocze użytkownika i skojarzone składniki, takie jak edytory i Eksplorator rozwiązań. Pakiet adaptera kontroli źródła obsługuje interakcję między środowiskiem IDE i wtyczką kontroli źródła. Pakiet adaptera kontroli źródła zapewnia własny interfejs użytkownika kontroli źródła. Jest to interfejs użytkownika najwyższego poziomu, z który użytkownik wchodzi w interakcję w celu zainicjowania i zdefiniowania zakresu operacji kontroli źródła.
Wtyczka kontroli źródła może mieć własny interfejs użytkownika, który może składać się z dwóch części, jak pokazano na rysunku. Pole oznaczone etykietą "Interfejs użytkownika dostawcy" reprezentuje niestandardowe elementy interfejsu użytkownika, które udostępniasz jako twórca wtyczki kontroli źródła. Są one wyświetlane bezpośrednio przez wtyczkę kontroli źródła, gdy użytkownik wywołuje zaawansowaną operację kontroli źródła. Pole oznaczone etykietą "Interfejs użytkownika pomocnika" to zestaw funkcji interfejsu użytkownika wtyczki kontroli źródła, które są pośrednio wywoływane za pośrednictwem środowiska IDE. Wtyczka kontroli źródła przekazuje komunikaty związane z interfejsem użytkownika do środowiska IDE za pomocą specjalnych funkcji wywołania zwrotnego udostępnianych przez środowisko IDE. Interfejs użytkownika pomocnika ułatwia bardziej bezproblemową integrację ze środowiskiem IDE (często za pomocą przycisku Zaawansowane ), a tym samym zapewnia bardziej ujednolicone środowisko użytkownika końcowego.
Wtyczka kontroli źródła nie może wprowadzać zmian w powłoce programu Visual Studio i w związku z tym do pakietu adaptera kontroli źródła lub interfejsu użytkownika kontroli źródła dostarczonego przez środowisko IDE. Musi ona maksymalnie wykorzystać elastyczność oferowaną przez implementację różnych funkcji interfejsu API wtyczki kontroli kodu źródłowego, które przyczyniają się do zintegrowanego środowiska użytkownika końcowego. Sekcja referencyjna dokumentacji interfejsu API wtyczki kontroli kodu źródłowego zawiera informacje dotyczące niektórych zaawansowanych funkcji wtyczki kontroli źródła. Aby wykorzystać te funkcje, wtyczka kontroli źródła musi zadeklarować zaawansowane możliwości środowiska IDE podczas inicjowania i musi implementować określone funkcje zaawansowane dla każdej funkcji.