拡張！～コマンド検出編～ | 株式会社ヘキサドライブ | HEXADRIVE | ゲーム制作を中心としたコンテンツクリエイト会社

HEXA BLOG

ヘキサブログ

プログラム

HEXA BLOGプログラム2018.10.31

拡張！～コマンド検出編～

こんにちは

ハッピーハロウィン

シュンスケです

前回に引き続き、Visual Studioの拡張機能開発に触れてみます。

今回は、もう少し最終到達点であるところのEmacs風という部分を意識して、
入力を検出してみます

1.ソリューションの作成
Visual Studioを起動
メニューのファイル→新規作成→プロジェクト

C#→Extensibility→VSIX Project
ソリューション名は「VSIXTest3」

2.リスナーの追加
プロジェクトを右クリック→追加→新しい項目
Visual C# アイテム→Extensibility→Editor Text Adornment
ファイル名は、「VSCommandHandlerTest.cs」

まずこれだけで動かすと、入力したテキストに対して、aという文字を検索し、
ハイライトがつくような表示がされる拡張が行われます。

これはこれで参考になりますが、今回はもう少し低レイヤーの情報をフックします。

3.フック部分の実装
VSCommandHandlerTest.csを以下のように丸ごと書き換えます。

	using System;
	using System.ComponentModel.Composition;
	using System.Runtime.InteropServices;

	using Microsoft.VisualStudio;
	using Microsoft.VisualStudio.Editor;
	using Microsoft.VisualStudio.OLE.Interop;
	using Microsoft.VisualStudio.Text.Editor;
	using Microsoft.VisualStudio.TextManager.Interop;
	using Microsoft.VisualStudio.Utilities;

	/*
	* 必要な参照
	* System.ComponentModel.Composition
	* Microsoft.VisualStudio.Editor
	* Microsoft.VisualStudio.Shell.15.0
	* Microsoft.VisualStudio.OLE.Interop
	* Microsoft.VisualStudio.Text.UI
	* Microsoft.VisualStudio.Text.UI.Wpf
	* Microsoft.VisualStudio.TextManager.Interop
	* Microsoft.VisualStudio.CoreUtility
	*/

	namespace VSIXTest3
	{
	[Export(typeof(IVsTextViewCreationListener))]
	[ContentType("text")]
	[TextViewRole(PredefinedTextViewRoles.Editable)]
	internal sealed class CommandHandlerProvider : IVsTextViewCreationListener
	{
	//! ビューの作成時に呼ばれる
	public void VsTextViewCreated(IVsTextView textViewAdapter)
	{
	ITextView view = _adapterService.GetWpfTextView(textViewAdapter);
	if( view == null ) return;

	//! フック用のクラス作成処理を登録
	view.Properties.GetOrCreateSingletonProperty(() => new CommandHandler(textViewAdapter));
	}

	[Import]
	internal IVsEditorAdaptersFactoryService _adapterService = null;
	}

	internal sealed class CommandHandler : IOleCommandTarget
	{
	//! コンストラクタ
	internal CommandHandler(IVsTextView adapter)
	{
	adapter.AddCommandFilter(this, out _nextCmdHdl);
	}

	public int QueryStatus(ref Guid pguidCmdGroup, uint cCmds, OLECMD[] prgCmds, IntPtr pCmdText)
	{
	return _nextCmdHdl.QueryStatus(ref pguidCmdGroup, cCmds, prgCmds, pCmdText);
	}

	public int Exec(ref Guid pguidCmdGroup, uint nCmdID, uint nCmdexecopt, IntPtr pvaIn, IntPtr pvaOut)
	{
	//! コマンドのグループGUIDによって、nCmdIDの解釈が変わる
	if( pguidCmdGroup == VSConstants.VSStd2K ) {

	//! 文字入力が行われた場合、入力された文字を判別して、'a'なら無視
	if( nCmdID == (uint)VSConstants.VSStd2KCmdID.TYPECHAR ) {
	var typedChar = (char)(ushort)Marshal.GetObjectForNativeVariant(pvaIn);
	if( typedChar == 'a' ) return VSConstants.S_OK;
	}
	}

	//! コマンド入力が行われた場合、「カット」は無視
	if( pguidCmdGroup == VSConstants.GUID_VSStandardCommandSet97 ) {
	if( nCmdID == (uint)VSConstants.VSStd97CmdID.Cut ) {
	return VSConstants.S_OK;
	}
	}

	//! 次のハンドラに処理を任せる
	return _nextCmdHdl.Exec(ref pguidCmdGroup, nCmdID, nCmdexecopt, pvaIn, pvaOut);
	}

	private IOleCommandTarget _nextCmdHdl = null;
	}
	}