VC++内部COM插件的编程实现

一、闲聊

　　今天要谈的话题是COM，稍微深入一点，不知道大家用过C++Test或者Visual Assistant之类的软件没有，它们都有个非常引人注目的功能，那就是把它们自身嵌入到VC开发环境中去。这个功能让我痴迷不已，原因只有一个：我想做一个可以嵌入VC开发环境的VC工程解析器，这样用户在VC开发环境中就可以直接对当前或所有工程进行各种分析，统计。那么实现它简单吗？简单，Next和Copy即可轻松完成；仅仅这些吗？不是，它的背后还有博大精深的COM做支撑。不管困难与否，还是让我们先试为快。

　　二、效果图

 

　　三、实现步骤：

　　<3.1>新建一个类型工程,输入工程名称"CodeAnalyser".

　　<3.2>进入第二个画面，系统要求用户输入插件的名称和描述信息。并且要求用户选择是否需要生成工具栏以及是否自动添加VC事件响应代码。

　　<3.3>点击"Finish"结束向导，进入代码编辑窗口。

　　在这里我们要说的一点是：该工程引用了ICommands接口，并从该接口上派生出 CCommands类。该类完成了所有用户自定义函数接口，VC应用程序消息响应和VC调试动作的消息响应工作。当我们真正为CCommands类添加成员函数之前我们必须先为ICommands接口添加相应的函数接口声明。在本工程中我总共为ICommands接口添加了两个函数接口，它们名字分别为：GetCurDirCommandMethod和QuitCommandMethod声明如下：(在CodeAnalyer.odl文件中)

interface ICommands : IDispatch
{
　// methods
　[id(1)] //在Vtable中的函数索引号
　HRESULT GetCurDirCommandMethod(); //得到VC当前工作目录

　[id(2)] //在Vtable中的函数索引号
　HRESULT QuitCommandMethod (); //退出VC编辑器
};

　　在接口ICommands添加接口函数，那么相应的我们也要在类CCommands中声明和实现ICommands接口函数，函数的内部代码和普通工程代码没什么区别。

//Implement(CCommands类内部接口函数的声明)
public:
STDMETHOD(GetCurDirCommandMethod)(THIS);
STDMETHOD(QuitCommandMethod)(THIS);

//Function Code(Ccommands类内部接口函数的实现)
//得到当前VC开发环境的工作目录[您也可以让它成为你想要实现的功能代码]
STDMETHODIMP CCommands::GetCurDirCommandMethod()
{
　AFX_MANAGE_STATE(AfxGetStaticModuleState());
　VERIFY_OK(m_pApplication->EnableModeless(VARIANT_FALSE));
　BSTR bstrCurDir;
　m_pApplication->get_CurrentDirectory(&bstrCurDir);
　CString str(bstrCurDir);
　::MessageBox(NULL, str, "VC工作目录", MB_OK | MB_ICONINFORMATION);
　VERIFY_OK(m_pApplication->EnableModeless(VARIANT_TRUE));
　return S_OK;
}

//退出VC开发环境

STDMETHODIMP CCommands::QuitCommandMethod()
{
　AFX_MANAGE_STATE(AfxGetStaticModuleState());
　VERIFY_OK(m_pApplication->EnableModeless(VARIANT_FALSE));
　if(::MessageBox(NULL,"您想退出VC++编辑器吗(Y/N)?","询问信息...", MB_YESNO | MB_ICONQUESTION) == IDYES)
　　m_pApplication->Quit();
　　VERIFY_OK(m_pApplication->EnableModeless(VARIANT_TRUE));
　return S_OK;
}

　　<3.4> 创建工具栏，连接工具栏按钮事件

　　所有的幕后工作已经准备就绪，只差个工具栏界面就一切OK了。打开类CDSAddIn,它里面有三个成员函数，其中OnConnection和OnDisconnection成员函数的意义非常重要。它们的意义如下：

　　<1>OnConnection：插件的初始化任务都在这里完成。如COM服务的启动，工具栏/菜单栏的创建，工具栏按钮/菜单项的添加与修改等等。

　　<2>OnDisconnection：插件的卸载工作都在这里完成。如COM服务的卸载，工具栏/菜单栏的销毁，释放等等。

　　了解了它们各自的用途之后我们就可以在相应的消息事件中添加代码了。很显然工具栏的初始化应该在OnConnection事件中完成。

　　在OnConnection事件中系统首先获得了VC应用程序接口，然后调用一个接口函数:AddCommand来为插件添加命令和命令影射函数。然后再使用另外一个接口函数AddCommandBarButton向工具栏中添加工具栏按钮，其中每个工具栏按钮会和一个命令标志符号相连接，这样就能实现按钮和命令（消息）之间的一一对应。下面是添加一个命令和一个工具栏按钮的代码（如果你要添加多个工具栏按钮只要重复此步骤即可）：

LPCTSTR szCommand = _T("GetCurDirCommand");
VARIANT_BOOL bRet;
CString strCmdString;
strCmdString.LoadString(IDS_CMD_STRING);
strCmdString = szCommand + strCmdString;
CComBSTR bszCmdString(strCmdString);
CComBSTR bszMethod(_T("GetCurDirCommandMethod"));

CComBSTR bszCmdName(szCommand); //和下面添加工具栏按钮对应

VERIFY_OK(pApplication->AddCommand(bszCmdString,bszMethod,0,dwCookie,&bRet));
//AddCommand 参数含义：
//bszCmdString：命令字符串。
//bszMethod：Icommands接口函数名。
//第三个参数代表位图偏移量。
//第四和第五个参数分贝为系统参数和返回值（参照MSDN的IApplication介绍）

if (bRet == VARIANT_FALSE)
{
　*OnConnection = VARIANT_FALSE;
　return S_OK;
}

//添加工具栏按钮
if (bFirstTime == VARIANT_TRUE)
{
　VERIFY_OK(pApplication->AddCommandBarButton(dsGlyph, bszCmdName, m_dwCookie));
}

　　<3.5> 编译，连接及在VC中引入插件

　　以上就是我们所有的代码工作，接下来赶快Build以下吧。编译通过的话，在你的工程Debug目录下会有个dll文件。然后打开VC编辑器，在VC任何一个工具栏上点击鼠标右键，弹出如下图所示菜单。然后选择”Customize”子菜单,打开如下图所示的工具栏定制窗口：

　　接着选择该窗口的最后一页"Add-Ins and Macro Files"出现下图所示窗口。

　　然后点击”Browse...”按钮，这时打开你工程下的Debug目录中的DLL文件，这样你就可以看到你制作的工具栏了。同样你再次打开上面的菜单，这次可以看到多了一个工具栏，并且名字乱七八糟的，怎么改变工具栏的名字呢？方法很简单：打开上面窗口中的”Toolbars”选项页，在工具栏列表框中找到你的工具栏，然后在”Toolbar name”编辑框中输入你想要的名字即可。再打开上面的菜单看看名字是不是变了，哈哈！