Пошаговое руководство: Завершение операторов отображение
Можно реализовать язык-основанные функции, такие как завершение выписки, указав идентификаторы, для которых требуется обеспечить завершение, а затем активирован сеанс завершения. Можно указать завершение выписки в контексте языковой службы или можно определить собственные расширения имени файла и тип содержимого и завершение отображения только для данного типа или можно активировать завершения для существующего типа содержимого (например, "открытый текст"). В этом пошаговом руководстве показано, как активировать завершение выписки для типа содержимого "открытого текста", тип содержимого текстовых файлов. Тип содержимого "text" является предком всех других типов содержимого, включая код и XML-файл.
Завершение выписки обычно активированы, введя некоторые знаки, например, введя начало идентификатора как "using". Как правило, закрыт, нажав клавишу ПРОБЕЛ, tab или ВВОД фиксации выделение. Функции IntelliSense, которые активированы, введя символ могут быть реализованы с помощью обработчика команды для нажатий клавиш ( IOleCommandTarget интерфейс) и обработчика, который реализует поставщик IVsTextViewCreationListener интерфейс. Чтобы создать источник завершения, список идентификаторов, которые участвуют в завершении реализуйте ICompletionSource интерфейс и завершения (поставщик источника ICompletionSourceProvider интерфейс). Поставщики, управляемые части .NET Framework расширяемости (MEF) и компонентов, ответственные за экспортировать источник и классы контроллера и импортировать службы и маклеры, например ITextStructureNavigatorSelectorService, который позволяет переходить в текстовом буфере. ICompletionBroker, активировать сеанс завершения.
В этом пошаговом руководстве показано, как реализовать завершение выписки для набора задано жестко идентификаторов. В полных реализациях служба языка и языка ответственны за обеспечение то содержимое.
Обязательные компоненты
Чтобы выполнить это пошаговое руководство, необходимо устанавливать SDK для Visual Studio 2010.
Примечание
Дополнительные сведения о пакете SDK для Visual Studio см. в разделе интеграция SDK Visual Studio.Чтобы узнать, как загрузить пакет SDK для Visual Studio см. в разделе Центр разработчиков расширяемости Visual Studio на веб-сайте MSDN.
Создание проекта MEF
Создание проекта MEF
Создайте проект классификатора редактора. Назовите решение CompletionTest.
Откройте файл source.extension.vsixmanifest в редакторе манифеста VSIX.
Убедитесь, что Содержимое заголовок содержит a компонент MEF тип содержимого и путь равно CompletionTest.dll.
Сохранить и закрыть source.extension.vsixmanifest.
Добавьте следующие ссылки в проект и убедитесь в том, что CopyLocal равно false.
Microsoft.VisualStudio.Editor
Microsoft.VisualStudio.Language.Intellisense
Microsoft.VisualStudio.OLE.Interop
Microsoft.VisualStudio.Shell.10.0
Microsoft.VisualStudio.Shell.Immutable.10.0
Microsoft.VisualStudio.TextManager.Interop
Удалите существующие файлы классов.
Реализация источник завершения
Источник завершения отвечает за сбор набор идентификаторов и добавлять содержимое в окно завершения когда пользователь вводит триггер завершения, например первые буквы идентификатора. В этом примере идентификаторы и их жестко запрограммированные в описаниеAugmentCompletionSession метод. В этом режиме, можно использовать использует средство синтаксического анализа выбранного языка для получения токены заполнения списка завершения.
Реализовать источник завершения
Добавьте файл классов и назовите его TestCompletionSource.
Добавьте следующие ввозы.
Imports System Imports System.Collections.Generic Imports System.Linq Imports System.Text Imports System.ComponentModel.Composition Imports Microsoft.VisualStudio.Language.Intellisense Imports Microsoft.VisualStudio.Text Imports Microsoft.VisualStudio.Text.Operations Imports Microsoft.VisualStudio.Utilities
using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.ComponentModel.Composition; using Microsoft.VisualStudio.Language.Intellisense; using Microsoft.VisualStudio.Text; using Microsoft.VisualStudio.Text.Operations; using Microsoft.VisualStudio.Utilities;
Измените объявление класса для TestCompletionSource таким образом, что она будет реализовывать ICompletionSource.
Friend Class TestCompletionSource Implements ICompletionSource
internal class TestCompletionSource : ICompletionSource
Добавьте закрытые поля для поставщика источника, текстового буфера и списка Completion объекты (которые соответствуют идентификаторам, которые будут участвовать в сеансе завершения).
Private m_sourceProvider As TestCompletionSourceProvider Private m_textBuffer As ITextBuffer Private m_compList As List(Of Completion)
private TestCompletionSourceProvider m_sourceProvider; private ITextBuffer m_textBuffer; private List<Completion> m_compList;
Добавьте конструктор, который задает поставщика источника и буфер. Класс TestCompletionSourceProvider определен в последующих шагах.
Public Sub New(ByVal sourceProvider As TestCompletionSourceProvider, ByVal textBuffer As ITextBuffer) m_sourceProvider = sourceProvider m_textBuffer = textBuffer End Sub
public TestCompletionSource(TestCompletionSourceProvider sourceProvider, ITextBuffer textBuffer) { m_sourceProvider = sourceProvider; m_textBuffer = textBuffer; }
Реализуйте AugmentCompletionSession метод путем добавления набора завершений, содержащий возобновленья необходимо убедиться в контексте. Каждый набор завершений содержит набор Completion возобновленья и соответствующие вкладке окна завершения. (В проектах Visual Basic, вкладки окна завершения назовите Общий и Все.) Метод FindTokenSpanAtPosition определяется на следующем шаге.
Private Sub AugmentCompletionSession(ByVal session As ICompletionSession, ByVal completionSets As IList(Of CompletionSet)) Implements ICompletionSource.AugmentCompletionSession Dim strList As New List(Of String)() strList.Add("addition") strList.Add("adaptation") strList.Add("subtraction") strList.Add("summation") m_compList = New List(Of Completion)() For Each str As String In strList m_compList.Add(New Completion(str, str, str, Nothing, Nothing)) Next str completionSets.Add(New CompletionSet( "Tokens", "Tokens", FindTokenSpanAtPosition(session.GetTriggerPoint(m_textBuffer), session), m_compList, Nothing)) End Sub
void ICompletionSource.AugmentCompletionSession(ICompletionSession session, IList<CompletionSet> completionSets) { List<string> strList = new List<string>(); strList.Add("addition"); strList.Add("adaptation"); strList.Add("subtraction"); strList.Add("summation"); m_compList = new List<Completion>(); foreach (string str in strList) m_compList.Add(new Completion(str, str, str, null, null)); completionSets.Add(new CompletionSet( "Tokens", //the non-localized title of the tab "Tokens", //the display title of the tab FindTokenSpanAtPosition(session.GetTriggerPoint(m_textBuffer), session), m_compList, null)); }
Следующий метод используется для поиска текущего машинное слово от положения курсора.
Private Function FindTokenSpanAtPosition(ByVal point As ITrackingPoint, ByVal session As ICompletionSession) As ITrackingSpan Dim currentPoint As SnapshotPoint = (session.TextView.Caret.Position.BufferPosition) - 1 Dim navigator As ITextStructureNavigator = m_sourceProvider.NavigatorService.GetTextStructureNavigator(m_textBuffer) Dim extent As TextExtent = navigator.GetExtentOfWord(currentPoint) Return currentPoint.Snapshot.CreateTrackingSpan(extent.Span, SpanTrackingMode.EdgeInclusive) End Function
private ITrackingSpan FindTokenSpanAtPosition(ITrackingPoint point, ICompletionSession session) { SnapshotPoint currentPoint = (session.TextView.Caret.Position.BufferPosition) - 1; ITextStructureNavigator navigator = m_sourceProvider.NavigatorService.GetTextStructureNavigator(m_textBuffer); TextExtent extent = navigator.GetExtentOfWord(currentPoint); return currentPoint.Snapshot.CreateTrackingSpan(extent.Span, SpanTrackingMode.EdgeInclusive); }
Реализуйте метод dispose ():
Private m_isDisposed As Boolean Public Sub Dispose() Implements IDisposable.Dispose If Not m_isDisposed Then GC.SuppressFinalize(Me) m_isDisposed = True End If End Sub
private bool m_isDisposed; public void Dispose() { if (!m_isDisposed) { GC.SuppressFinalize(this); m_isDisposed = true; } }
Реализация поставщика источника завершения
Поставщик источника завершения часть компонент MEF, которая создает источник завершения.
Реализация поставщика источника завершения
Добавьте в проект класс TestCompletionSourceProvider, реализующий ICompletionSourceProvider. Экспортировать этот класс с a ContentTypeAttribute открытого текста" и " a " NameAttribute "завершения".
<Export(GetType(ICompletionSourceProvider)), ContentType("plaintext"), Name("token completion")> Friend Class TestCompletionSourceProvider Implements ICompletionSourceProvider
[Export(typeof(ICompletionSourceProvider))] [ContentType("plaintext")] [Name("token completion")] internal class TestCompletionSourceProvider : ICompletionSourceProvider
Импортировать a ITextStructureNavigatorSelectorService, для использования найти текущее машинное слово в источнике завершения.
<Import()> Friend Property NavigatorService() As ITextStructureNavigatorSelectorService
[Import] internal ITextStructureNavigatorSelectorService NavigatorService { get; set; }
Реализуйте TryCreateCompletionSource метод создать источник завершения.
Public Function TryCreateCompletionSource(ByVal textBuffer As ITextBuffer) As ICompletionSource Implements ICompletionSourceProvider.TryCreateCompletionSource Return New TestCompletionSource(Me, textBuffer) End Function
public ICompletionSource TryCreateCompletionSource(ITextBuffer textBuffer) { return new TestCompletionSource(this, textBuffer); }
Реализация поставщика обработки команды завершения
Поставщик обработки команды завершения является производным от a IVsTextViewCreationListener, который прослушивает события создания представления текста и преобразование представление IVsTextView (это позволяет команда добавляемый в цепочке команды оболочки Visual Studio) ITextView. Поскольку этот класс экспорт MEF можно также использовать ее для импорта службы, которые будут самим обработчика команды.
Реализация поставщика обработки команды завершения
Добавьте в проект файл TestCompletionCommandHandler.
Добавьте следующие строки с помощью выписки.
Imports System Imports System.Collections.Generic Imports System.Linq Imports System.Text Imports System.ComponentModel.Composition Imports System.Runtime.InteropServices Imports Microsoft.VisualStudio Imports Microsoft.VisualStudio.Editor Imports Microsoft.VisualStudio.Language.Intellisense Imports Microsoft.VisualStudio.OLE.Interop Imports Microsoft.VisualStudio.Shell Imports Microsoft.VisualStudio.Text Imports Microsoft.VisualStudio.Text.Editor Imports Microsoft.VisualStudio.TextManager.Interop Imports Microsoft.VisualStudio.Utilities
using System; using System.ComponentModel.Composition; using System.Runtime.InteropServices; using Microsoft.VisualStudio; using Microsoft.VisualStudio.Editor; using Microsoft.VisualStudio.Language.Intellisense; using Microsoft.VisualStudio.OLE.Interop; using Microsoft.VisualStudio.Shell; using Microsoft.VisualStudio.Text; using Microsoft.VisualStudio.Text.Editor; using Microsoft.VisualStudio.TextManager.Interop; using Microsoft.VisualStudio.Utilities;
Добавьте в проект класс TestCompletionHandlerProvider, реализующий IVsTextViewCreationListener. Экспортировать этот класс с a NameAttribute "обработчика завершения токена", a ContentTypeAttribute "открытого текста" и " a " TextViewRoleAttributeEditable.
<Export(GetType(IVsTextViewCreationListener))> <Name("token completion handler")> <ContentType("plaintext")> <TextViewRole(PredefinedTextViewRoles.Editable)> Friend Class TestCompletionHandlerProvider Implements IVsTextViewCreationListener
[Export(typeof(IVsTextViewCreationListener))] [Name("token completion handler")] [ContentType("plaintext")] [TextViewRole(PredefinedTextViewRoles.Editable)] internal class TestCompletionHandlerProvider : IVsTextViewCreationListener
Импортировать IVsEditorAdaptersFactoryService, который позволяет преобразовать a IVsTextView к a ITextViewa ICompletionBrokerи a SVsServiceProvider, который позволяет получить доступ к стандартным службы Visual Studio.
<Import()> Friend AdapterService As IVsEditorAdaptersFactoryService = Nothing <Import()> Friend Property CompletionBroker() As ICompletionBroker <Import()> Friend Property ServiceProvider() As SVsServiceProvider
[Import] internal IVsEditorAdaptersFactoryService AdapterService = null; [Import] internal ICompletionBroker CompletionBroker { get; set; } [Import] internal SVsServiceProvider ServiceProvider { get; set; }
Реализуйте VsTextViewCreated метод создать обработчик команд.
Public Sub VsTextViewCreated(ByVal textViewAdapter As IVsTextView) Implements IVsTextViewCreationListener.VsTextViewCreated Dim textView As ITextView = AdapterService.GetWpfTextView(textViewAdapter) If textView Is Nothing Then Return End If Dim createCommandHandler As Func(Of TestCompletionCommandHandler) = Function() New TestCompletionCommandHandler(textViewAdapter, textView, Me) textView.Properties.GetOrCreateSingletonProperty(createCommandHandler) End Sub
public void VsTextViewCreated(IVsTextView textViewAdapter) { ITextView textView = AdapterService.GetWpfTextView(textViewAdapter); if (textView == null) return; Func<TestCompletionCommandHandler> createCommandHandler = delegate() { return new TestCompletionCommandHandler(textViewAdapter, textView, this); }; textView.Properties.GetOrCreateSingletonProperty(createCommandHandler); }
Реализация обработчика команды завершения
Поскольку завершение выписки активированы нажатиями клавиш, необходимо реализовать IOleCommandTarget интерфейс получения и отображения сообщения о нажатии клавиш, которые активируют, фиксирует и закрывает сеанс завершения.
Реализовать обработчик команды завершения
Добавьте в проект класс TestCompletionCommandHandler, реализующий IOleCommandTarget.
Friend Class TestCompletionCommandHandler Implements IOleCommandTarget
internal class TestCompletionCommandHandler : IOleCommandTarget
Добавьте закрытые поля для следующих обработчика команды (к тому, что при передаче командой), представления текста, поставщика обработчика команды (который позволяет обращаться к различным служб) и сеанса завершения.
Private m_nextCommandHandler As IOleCommandTarget Private m_textView As ITextView Private m_provider As TestCompletionHandlerProvider Private m_session As ICompletionSession
private IOleCommandTarget m_nextCommandHandler; private ITextView m_textView; private TestCompletionHandlerProvider m_provider; private ICompletionSession m_session;
Добавьте конструктор, который задает представление текста и полей поставщика и добавить команду в цепочке команды.
Friend Sub New(ByVal textViewAdapter As IVsTextView, ByVal textView As ITextView, ByVal provider As TestCompletionHandlerProvider) Me.m_textView = textView Me.m_provider = provider 'add the command to the command chain textViewAdapter.AddCommandFilter(Me, m_nextCommandHandler) End Sub
internal TestCompletionCommandHandler(IVsTextView textViewAdapter, ITextView textView, TestCompletionHandlerProvider provider) { this.m_textView = textView; this.m_provider = provider; //add the command to the command chain textViewAdapter.AddCommandFilter(this, out m_nextCommandHandler); }
Реализуйте QueryStatus метод путем передачи команду вперед.
Public Function QueryStatus(ByRef pguidCmdGroup As Guid, ByVal cCmds As UInteger, ByVal prgCmds() As OLECMD, ByVal pCmdText As IntPtr) As Integer Implements IOleCommandTarget.QueryStatus Return m_nextCommandHandler.QueryStatus(pguidCmdGroup, cCmds, prgCmds, pCmdText) End Function
public int QueryStatus(ref Guid pguidCmdGroup, uint cCmds, OLECMD[] prgCmds, IntPtr pCmdText) { return m_nextCommandHandler.QueryStatus(ref pguidCmdGroup, cCmds, prgCmds, pCmdText); }
Реализуйте метод Exec. Когда этот метод возвращает нажатие клавиши, он должен выполнить одно из следующих действий:
Необходимо включить символ, записываемая в буфер, а затем активировать или отфильтровать завершение (символы печати делают это).
Исправьте завершение, но не разрешать символ, записываемая в буфер (пробелы, ВКЛАДКА ", и ВСТАВЛЯТЬ это делают при отображении сеанс завершения).
Включите команду для передачи к следующему обработчик (все остальные команды).
Поскольку этот метод может отображать интерфейс пользователя, следует убедиться, что он не вызывается путем вызова в контексте автоматизации IsInAutomationFunction.
Public Function Exec(ByRef pguidCmdGroup As Guid, ByVal nCmdID As UInteger, ByVal nCmdexecopt As UInteger, ByVal pvaIn As IntPtr, ByVal pvaOut As IntPtr) As Integer Implements IOleCommandTarget.Exec If VsShellUtilities.IsInAutomationFunction(m_provider.ServiceProvider) Then Return m_nextCommandHandler.Exec(pguidCmdGroup, nCmdID, nCmdexecopt, pvaIn, pvaOut) End If 'make a copy of this so we can look at it after forwarding some commands Dim commandID As UInteger = nCmdID Dim typedChar As Char = Char.MinValue 'make sure the input is a char before getting it If pguidCmdGroup = VSConstants.VSStd2K AndAlso nCmdID = CUInt(VSConstants.VSStd2KCmdID.TYPECHAR) Then typedChar = CChar(ChrW(CUShort(Marshal.GetObjectForNativeVariant(pvaIn)))) End If 'check for a commit character If nCmdID = CUInt(VSConstants.VSStd2KCmdID.RETURN) OrElse nCmdID = CUInt(VSConstants.VSStd2KCmdID.TAB) OrElse (Char.IsWhiteSpace(typedChar) OrElse Char.IsPunctuation(typedChar)) Then 'check for a a selection If m_session IsNot Nothing AndAlso (Not m_session.IsDismissed) Then 'if the selection is fully selected, commit the current session If m_session.SelectedCompletionSet.SelectionStatus.IsSelected Then m_session.Commit() 'also, don't add the character to the buffer Return VSConstants.S_OK Else 'if there is no selection, dismiss the session m_session.Dismiss() End If End If End If 'pass along the command so the char is added to the buffer Dim retVal As Integer = m_nextCommandHandler.Exec(pguidCmdGroup, nCmdID, nCmdexecopt, pvaIn, pvaOut) Dim handled As Boolean = False If (Not typedChar.Equals(Char.MinValue)) AndAlso Char.IsLetterOrDigit(typedChar) Then If m_session Is Nothing OrElse m_session.IsDismissed Then ' If there is no active session, bring up completion Me.TriggerCompletion() m_session.Filter() Else 'the completion session is already active, so just filter m_session.Filter() End If handled = True ElseIf commandID = CUInt(VSConstants.VSStd2KCmdID.BACKSPACE) OrElse commandID = CUInt(VSConstants.VSStd2KCmdID.DELETE) Then 'redo the filter if there is a deletion If m_session IsNot Nothing AndAlso (Not m_session.IsDismissed) Then m_session.Filter() End If handled = True End If If handled Then Return VSConstants.S_OK End If Return retVal End Function
public int Exec(ref Guid pguidCmdGroup, uint nCmdID, uint nCmdexecopt, IntPtr pvaIn, IntPtr pvaOut) { if (VsShellUtilities.IsInAutomationFunction(m_provider.ServiceProvider)) { return m_nextCommandHandler.Exec(ref pguidCmdGroup, nCmdID, nCmdexecopt, pvaIn, pvaOut); } //make a copy of this so we can look at it after forwarding some commands uint commandID = nCmdID; char typedChar = char.MinValue; //make sure the input is a char before getting it if (pguidCmdGroup == VSConstants.VSStd2K && nCmdID == (uint)VSConstants.VSStd2KCmdID.TYPECHAR) { typedChar = (char)(ushort)Marshal.GetObjectForNativeVariant(pvaIn); } //check for a commit character if (nCmdID == (uint)VSConstants.VSStd2KCmdID.RETURN || nCmdID == (uint)VSConstants.VSStd2KCmdID.TAB || (char.IsWhiteSpace(typedChar) || char.IsPunctuation(typedChar))) { //check for a a selection if (m_session != null && !m_session.IsDismissed) { //if the selection is fully selected, commit the current session if (m_session.SelectedCompletionSet.SelectionStatus.IsSelected) { m_session.Commit(); //also, don't add the character to the buffer return VSConstants.S_OK; } else { //if there is no selection, dismiss the session m_session.Dismiss(); } } } //pass along the command so the char is added to the buffer int retVal = m_nextCommandHandler.Exec(ref pguidCmdGroup, nCmdID, nCmdexecopt, pvaIn, pvaOut); bool handled = false; if (!typedChar.Equals(char.MinValue) && char.IsLetterOrDigit(typedChar)) { if (m_session == null || m_session.IsDismissed) // If there is no active session, bring up completion { this.TriggerCompletion(); m_session.Filter(); } else //the completion session is already active, so just filter { m_session.Filter(); } handled = true; } else if (commandID == (uint)VSConstants.VSStd2KCmdID.BACKSPACE //redo the filter if there is a deletion || commandID == (uint)VSConstants.VSStd2KCmdID.DELETE) { if (m_session != null && !m_session.IsDismissed) m_session.Filter(); handled = true; } if (handled) return VSConstants.S_OK; return retVal; }
В следующем примере закрытый метод, активировать сеанс завершения.
Private Function TriggerCompletion() As Boolean 'the caret must be in a non-projection location Dim caretPoint As SnapshotPoint? = m_textView.Caret.Position.Point.GetPoint(Function(textBuffer) ((Not textBuffer.ContentType.IsOfType("projection"))), PositionAffinity.Predecessor) If Not caretPoint.HasValue Then Return False End If m_session = m_provider.CompletionBroker.CreateCompletionSession(m_textView, caretPoint.Value.Snapshot.CreateTrackingPoint(caretPoint.Value.Position, PointTrackingMode.Positive), True) 'subscribe to the Dismissed event on the session AddHandler m_session.Dismissed, AddressOf OnSessionDismissed m_session.Start() Return True End Function
private bool TriggerCompletion() { //the caret must be in a non-projection location SnapshotPoint? caretPoint = m_textView.Caret.Position.Point.GetPoint( textBuffer => (!textBuffer.ContentType.IsOfType("projection")), PositionAffinity.Predecessor); if (!caretPoint.HasValue) { return false; } m_session = m_provider.CompletionBroker.CreateCompletionSession (m_textView, caretPoint.Value.Snapshot.CreateTrackingPoint(caretPoint.Value.Position, PointTrackingMode.Positive), true); //subscribe to the Dismissed event on the session m_session.Dismissed += this.OnSessionDismissed; m_session.Start(); return true; }
В следующем примере закрытый метод, который unsubscribes из Dismissed событие.
Private Sub OnSessionDismissed(ByVal sender As Object, ByVal e As EventArgs) RemoveHandler m_session.Dismissed, AddressOf OnSessionDismissed m_session = Nothing End Sub
private void OnSessionDismissed(object sender, EventArgs e) { m_session.Dismissed -= this.OnSessionDismissed; m_session = null; }
Построение и тестирование кода
Для тестирования этого кода выполните построение решения CompletionTest и запустите его в экспериментальном экземпляре.
Построение и тестирование решение CompletionTest
Выполните построение решения.
Если запустить этот проект в отладчике, второй экземпляр Visual Studio создается.
Создайте текстовый файл и введите несколько тексту, включающему машинное слово "добавить".
При вводе first "a" и "d", список, содержащий "сложение" и "приспособление" должен быть отображен. Добавление Обратите внимание, что выбрано. При вводе другой "d", список должен содержать только "сложение", которое теперь выделено. Можно исправить "сложение", нажав клавишу ПРОБЕЛ, tab или ввод или закрыть список, введя ESC или любой другой знак.
См. также
Задачи
Пошаговое руководство: Связывание тип контента в расширение имени файла