How to make a project compatible with VS source control integration

benryan — Fri, 22 Dec 2006 21:52:00 GMT

The following are the necessary mininum steps required to integrate a new project type with source control within Visual Studio.

The project must implement Microsoft.VisualStudio.Shell.Interop.IVsSccProject2 (documentation).

GetSccFiles - return which files are controllable for the given item ID
GetSccSpecialFiles - return hidden files for the given item ID
SetSccLocation - persist the SCC settings to the project file
SccGlyphChange - notifies project that changes have been made to the indicated items' SCC glyphs

The project must utilize Microsoft.VisualStudio.Shell.Interop.IVsSccManager2 (documentation).

RegisterSccProject - call when the project is opened
UnregisterSccProject - call when the project is closed
GetSccGlyphs - call to get source control glyphs and source control status

The project must utilize Microsoft.VisualStudio.Shell.Interop.IVsQueryEditQuerySave2 (documentation).

QueryEditFiles - call before editing a file in the project to notify listeners (e.g. SCC)
QuerySaveFiles - call before saving a file in the project to notify listeners (e.g. SCC)

The project must utilize Microsoft.VisualStudio.Shell.Interop.IVsTrackProjectDocuments2 (documentation)

OnQuery* - call before attempting the add/rename/move/etc. operation to notify listeners (e.g. SCC) and to give listeners the chance to veto the attempt.
OnAfter* - call after the operation has been performed to permit listeners (e.g. SCC) to perform related operations (e.g. pend an SCC add).

To permit SCC commands to show in the context menus, the menu should contain the following groups:

guidSHLMainMenu::IDG_VS_CTXT_SOLUTION_SCC
guidSHLMainMenu::IDG_VS_CTXT_PROJECT_SCC
guidSHLMainMenu::IDG_VS_CTXT_ITEM_SCC

Introduction

benryan — Thu, 21 Dec 2006 22:19:00 GMT

About Me
My name is Ben Ryan, and I have been involved with developing the Team Foundation Server version control client for the last three and a half years here at the Microsoft office in Durham, NC. During most of that time, I have been working on the low level source control integration of Team Foundation Server within Visual Studio. As time allows, I assist my coworker, Michal Malecki (http://blogs.msdn.com/michalma), with the TFS MSSCCI PlugIn.

I have 14 years of software development experience that span several companies and numerous software projects. My previous employers include:

Ateb - C development on Linux-based signature capture appliance
Alerts.com - Java development of a distributed messaging service
HAHT - Integration of Java VM within native Windows and UNIX HAHTsite server application
Data General (now part of EMC) - C development within DG/UX kernel's TCP/IP protocol stack

This list is not all inclusive, but it does offer a representative sampling of my background.

Blogging Topics
For starters, I intend to blog about Visual Studio source control integration. Ideally, I'll cover both what is involved with making a new project type compatible with integrated source control and how a source control provider interacts with Visual Studio. Hopefully, the latter discussions will provide some insight into how TFS operates within Visual Studio and why it operates that way.

After that, I'm not sure what I'll blog about. I'm not too concerned given that the mysteries of the source control integration layer should provide me with blogging fodder for months to come.

TFS Version Control and VS Integration : SCC

How to make a project compatible with VS source control integration

Introduction