【问题标题】:Implementing a custom wizard for Visual Studio for custom C++ classes为自定义 C++ 类实现 Visual Studio 的自定义向导
【发布时间】:2011-07-05 05:02:57
【问题描述】:

为了使新的 C++ 类符合一些相当挑剔的编码约定(预先说明:我无法讨论这些……),我正在考虑一种为新的 C++ 类生成存根的方法。目前,每个人都在做复制粘贴,经常遗漏一些细节。使用的 IDE 是 MS Visual Studio 2005,但我认为 2008 年和 2010 年在这些主题方面没有太大变化。

我的第一个想法是实现一个命令行脚本来执行此操作,这将是相当直接的。或者,我考虑使用默认的 VS 扩展机制来更好地集成 IDE。因此,当在过滤器(解决方案资源管理器)上选择 Add->New Item... 时,这将与一些自定义内容挂钩。

经过一番调查,我发现有一个易于使用的模板机制,不幸的是它不适用于 C++ (http://msdn.microsoft.com/en-us/library/6db0hwky%28v=vs.80%29.aspx)。对于 C++,您似乎必须实现自定义向导,将 html 用于布局,将 javascript 用于逻辑。

关于自定义向导方法,我得出的结论是,这需要一些努力(至少对我而言)才能完成。 MSDN 对这个主题不是很详细。我在网络上找到了一些演练,它们仅处理项目的自定义向导(Add->New Project... 而不是 Add->New Item... em>)。

所以,这里是 qn:有人做过这个或类似的事情吗?它(更好的 IDE 集成)值得付出努力(应对自定义向导实现的细节),还是您建议改用命令行工具?我猜,在当前的项目中,超过两天的工作不会有回报。

如果您认为自定义向导很棒,也许您可​​以提供一些入门提示。另外,也许还有我没有想到的替代方案。 VS Add-Ins 似乎是最重要的,并且适应例如VC\vcprojectitems\newc++file.cpp 不会做这项工作。

提前致谢并致以最诚挚的问候... 杰布

【问题讨论】:

    标签: c++ visual-studio templates createuserwizard


    【解决方案1】:

    我使用自定义向导做了类似的事情。

    出于我的目的,我只是想在每个类中注入一些简单的宏,以将其插入到静态工厂对象中。

    我不需要修改实际的向导,只是复制了默认的泛型类向导并修改了代码生成javascript。

    关于这个主题的文档是垃圾,但这里是开始 javascript 的好地方(这是你将获得最大权力的地方):

    http://msdn.microsoft.com/en-us/library/t41260xs(v=VS.71).aspx

    默认的类向导 javascript 位于此处:

    C:\Program Files\Microsoft Visual Studio 10.0\VC\VCWizards\CodeWiz\Generic\Class\Scripts\1033\default.js


    复制项目

    复制这个比我想象的要复杂,你需要复制并粘贴

    Microsoft Visual Studio 10.0\VC\VCWizards\CodeWiz\Generic\

    文件夹,然后前往:

    C:\Program Files\Microsoft Visual Studio 10.0\VC\VCAddClass\Generic

    复制此文件夹并修改其中的 Generic.vsdir 以指向复制的 ..\Simple.vsz(VCAddClass 文件夹中的文件)。

    Simple.vsz 文件指向您在开始时欺骗的 VCWizards 中“通用”文件夹的位置,因此将新的 simple.vsz 指向该位置。


    代码生成

    至于实际的代码生成,它并不难掌握。为了更快地开始,这是 default.js 的一般工作方式:

    向导完成后,代码生成方法将从以下位置开始:

    function OnFinish(selProj, selObj)
    

    selProj 是(据我所知)EnvDTE.Project 的一个实例

    http://msdn.microsoft.com/en-us/library/envdte.project.aspx

    从向导获取信息似乎基于:

    wizard.FindSymbol("CLASS_NAME")
    

    真正的魔法开始发生在 selProj.CodeModel 对象上

    oCM.AddClass(strClassName, strHeader, vsCMAddPositionEnd, "", "", vsCMAccessDefault);
    

    似乎这些方法向文件添加任何内容的惯例只是将文件修改为单个操作,因为它需要文件路径作为其参数。

    这会返回一个 CodeClass 实例,并且可以通过它的方法添加,例如:

    AddAttribute
    AddFunction
    ...
    

    如果您正在寻找非常严格的代码格式(或者在我的情况下插入不符合正常代码语法的宏),这会受到很大限制。

    解决此问题的简单方法是为您需要使用 EditPoint 界面完全控制的部分自己构建一个字符串。

    EditPoint 是代码文件中的一个位置,您可以调用如下方法:

    EditPoint.Insert(string)
    Editpoint.InsertFromFile(path)
    

    要在要插入代码的位置获取 EditPoint,只需使用代码生成文件中现有项目之一的位置(如类或构造函数)并使用 .StartPointOf 或 .EndPointOf 获取 TextPoint 和操作参数。

    一旦你有了一个 TextPoint,你就可以像这样创建一个 EditPoint:

    newclass.EndPointOf(vsCMPartBody).CreateEditPoint().Insert("\nprivate:\n  REGISTER_TYPE_MEMBER("+strClassName+");\n");
    

    改为在 .cpp 文件中获取 TextPoint:

    oConstructor.StartPointOf(vsCMPartWhole,vsCMWhereDefinition).CreateEditPoint().Insert("REGISTER_TYPE_BODY_ID("+strClassName+",REPLACE_ID);\n\n\n");
    

    这使您能够通过 JScript 字符串操作来做任何您想做的事情,只要您可以通过向导找到所需的输入数据(我还没有深入研究过)

    【讨论】:

    • +1 只是为了花时间写出如此详细而广泛的答案。
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2022-10-04
    • 2010-10-19
    • 2014-01-06
    相关资源
    最近更新 更多