All Stories

从扩展编辑器开始

  重构auto completion和call tips模块,因为总体设计都被改得天翻地覆,而且决定开始使用TDD的方式进行,所以进度相对来说慢了些,更因为我自己一直静不下心来好好干活,真是令人烦恼啊!  话说其他一些相对可独立分类的小特性大部分已被我清理出来,但剩下还有一些杂七杂八的功能,我却不想再动了,因为从很早的时候就考虑好了这部分功能不应该由C++代码完成,而应该由host提供的扩展机制使用外部extension实现。但是现在的情况看来,这扩展机制短期内是不会加入的,因为老大似乎不支持这样的做法。另外一点是,组内大概除了我,也再没有其他人有足够深厚的兴趣和迫切的需求实现这么一个框架。  最早虽然想到了要用扩展,但并没有考虑很多,只是觉得只要能用内部嵌入的那个Ruby解释器执行一段脚本,而那个解释器同时也能访问到内部的一些数据结构和算法,应该就能处理目前的需求了。当时预见得到的需求也确实简单,比如点击一个菜单项,在当前光标位置插入一个字符串,该字符串可能是当前日期或时间等等。我当时想法相当单纯,甚至想的是菜单项还是依旧在资源管理器中画好,消息映射也还是添加好,最后实现的时候再调用Ruby解释器解释一个外部的脚本文件就可以了。即使这样简单,也比纯粹使用C++实现有一定的优势,至少如果需要修改实现逻辑,就只需要修改那个脚本文件,不再需要修改C++代码,不需要重新编译。  但是自从前几天快速翻看了一遍《Contributing to Eclipse》之后,我就想,要做就做得灵活点,也许不要求完全跟Eclipse一样那么强大有弹性,但也至少要满足以下几个要求:1、在主菜单、弹出式菜单、工具栏(、状态栏)上都可以扩展;2、在扩展之上还可以预留扩展点继续扩展;3、既然用脚本扩展,那么扩展加载应该也像Eclipse那样“懒加载”;4、需要有一种打包策略,足以支持起复杂的多文件的扩展。  暂时就只想到这些,嗯!重构完auto completion和call tips,就悄悄做这个。

讨教Plugins设计

  下午去向人讨教了一下人家怎么设计实现Plugins机制的。据该人士讲述,当时他们的产品2.x版本面对各种千奇百怪的用户需求,以及进度压力(这与我们目前遭遇到的情况类似),经过研究COM相关技术和Eclipse(估计当时也是2.x版本)的Plugins机制,最后在3.0版本实现了目前(也是3.x吧)的Plugins机制。  首先,该软件产品一般的插件都是通过vbs脚本实现,他们内嵌了vbs脚本解释器,使用的当然是最流行最正规的IActiveScript之道。可以扩展的地方包括主菜单、工具栏、弹出式菜单、状态栏等。像Eclipse及其他很多软件一样,基本的界面元素是用XML描述的,以弹出式菜单为例,在XML中首先会定义视图之类的信息,而弹出式菜单是作为视图信息的子节点出现的,说明这个弹出式菜单是在视图上点击右键才会弹出。这里好像是XML里就直接指定了菜单项的ID,对应Windows程序里的命令ID,而ID范围是程序中已固化规定好的,不能超出这个范围。然后指定一个脚本文件,可能还会具体到其中某个函数,每当菜单项触发时,便调用这段脚本。可能还会有触发前、触发后的选项,可以继续使用自定义脚本扩展实现。另外,菜单项有一个状态,如disabled、checked等等,这是在另外一个属性中设置的,该属性同样是指定一个脚本文件或函数,刚好对应MFC中的ON_UPDATE_COMMAND_UI。还有一点是,菜单可能是针对某种具体的选中项才有项的,所以在XML中描述菜单时,可能会包含一个属性,用于指定对其有效的选中项类型,只有在该类型的界面元素被选中并在上面点击鼠标右键时,才会弹出这个菜单。再有就是菜单等界面元素不可避免的一个问题是国际化,他们是把各种语言对应的字符串信息分别写到不同的配置文件中,描述菜单信息的XML里通过指定个别名或ID来动态查找装入相应的字符串。如果激活扩展插件函数时,需要一些固有信息,而是通过规定的格式书写函数参数。  其次,除了支持脚本扩展,该软件还支持COM组件形式的Plugins,这种Plugins相比脚本Plugins肯定强大得多,也许就好比Firefox中的Plugins之于Extensions,不过在介绍时他们一带而过,似乎也不是很支持第三方的去使用这种机制。  最后说一点,为了实现能让vbs脚本访问host程序中的一些信息或方法,他们把所有的东西都用COM接口还实现。似乎这是目前而言,我们能找到的最简单的一种处理方式,所有的状态、中间数据信息都可以保存在host程序中,脚本应该只是描述逻辑,而不保存状态。但这也是我最不屑的,我还是比较欣赏Eclipse(3.0以后用OSGi的不知道有多少变化)的机制,希望我有机会能设计并把它实现!

继续整理代码

  今天又整理了一下代码,又把初始化部分移出来了,居然相关的代码超过1100行,也算是神奇了。现在主要是把相对独立的功能剥离出来,所以并没有仔细地考究里面的代码细节是否写得完美。而且,总感觉现在的结构还不是我理想中的那种样子,但到底做成什么样,我自己也不知道,我想不明白怎么做才能做好。  另外在看代码的过程中,发现其中有一些是重新发明轮子了,其实有直接简单的实现,却因为对系统的不了解,而自己实现了一把,如果不考虑性能等方面的因素,只是关心代码的整洁清晰的话,当然不要自己的实现了。  还是要去整那一体化平台,心里总有种抵制的感觉。想去做图形编辑,想实现一个足够灵活的插件框架,唉!

整理了一下思路

  今天又没动手,人越来越懒了啊!总是在想,既然功能基本正常,就不要去动它了。就像Martin Fowler在书中说的一样。感觉有心无力,唉,心中有那么一点畏惧和抵制。  不过后来花了点时间,在纸上乱画,针对自动联想功能,清理了一下设计思路。现在的实现真的是很C风格化,所有的代码都是揉合在一个类中,所以相关的功能都在这个类里实现。重构时,希望尽量向OO的方向靠拢,那些设计准则,也要尽量地遵守。  从现存的代码看,自动联想从表现上看,可以分为3类,分别是Auto Completion、Call Tips、Code Snippet。其中Auto Completion是通过已输入的几个字符,根据上下文环境,给出候选的可能匹配的完整token,Call Tips则是在当输入函数调用的实参时,以tooltip的形式给出函数原型以提示,而Code Snippet则是在用户触发了事先绑定的事件时,根据已输入的字符,或者也可称为命令符,自动以代码片段替换该代表命令的字符串。总之这3种特性都是为了减轻编码者记忆负担,减少键盘敲击次数,降低出错概率。  当前的实现是当打开一个文件时,或者截获到换行操作时,进行扫描,记录当前文件及其相关包含的变量和常量的定义,除了名称,还需要类型。这样在输入变量时,可以根据名称进行提示,输入方法时,根据类型可以从数据库是查询到相关方法。所以扫描是为了Auto Completion和Call Tips作准备,Code Snippet不需要这些。  当初实现这些特性时,只考虑到了Ruby语言,所以紧紧围绕着Ruby这个主题开展,代码几乎没留下任何一丝空间以供后续扩展。不过既然这次要重构,无论从设计角度,对象职责上看,或是以后要添加扩展新语言支持,都需要把这块代码剥离出来。一个重要的原则是,剥离出来部分不能再跟界面有耦合了,不然单元测试几乎不能做了。  界面部分还是全都放在控件类中,控件类调用Auto Completion、Call Tips实现类获取待显示的内容,实现类应该从统一从一个抽象类继承,每个实现类可以对应一种(或一类)语法。这里需要引入一个工厂类。原来的助手类应该拆分成两部分,即代码扫描分析部分和信息存储查询部分。其中代码扫描部分也有一个抽象基类,从它派生出对应各种语法的具体实现类,把扫描分析的结果存储到信息存储部分,同时,信息查询部分从信息存储部分获取内容,信息存储部分的数据一部分来自于扫描分析部分,另一部分来自于固有持久化层,可能是一个数据库,可能是一个文件文件,可能是一种外部输入数据结构。这样,任何一部分的变化,都会尽可能少地影响其他部分的实现,而且这些实现除了界面相关部分,其他的应该都比较容易做单元测试,自我感觉设计得不错,只是可能工作量大了不少,很容易让人产生放弃的念头,呵呵!

在VC9下面用CppUnit

  因为主工程是用VC9的,所以想用CppUnit的话,一般说来也是用VC9的。不过很郁闷的是,无论怎么弄,总是不正常,不是编译不过,就是运行就崩溃的,真是奇怪呀!  如果实在不行,就换用VC7.1来用CppUnit算了,毕竟照在公司里使用CppUnit的经验,在VC7.1下是好好的,可以有经典的红条,绿条,也可以直接输出测试报告到文件中,嗯,今天就先到这里,又费了一晚的时间!

不需要分发pdb啦

  话说我已经通过抠早期版本FileZilla的代码,能让程序在崩溃那一刻进行dump,但是却只是知道,dump时,如果有相应的pdb文件在搜索路径下,是可以直接得到详尽的信息的,如果当时没有pdb文件,就只能得到一些看似无用的东东。  其实我错了,大大地错了!也不怪中间各种各样的原因,关键是现在知道只要能保留下可执行文件相配套的pdb和源代码在本地就可以了。当初从别人那里拿来dump文件来分析,是因为搜索路径下的pdb和源代码都是跟那个可执行文件不匹配的!  我居然还想着通过什么策略把pdb分发出去,哈哈,太可爱太幼稚了!现在终于可以安心地发放可执行文件出去了,只是崩溃报告机制需要好好设计一下,如何能及时地把报告从用户处取回,考虑到公司的网络环境和使用政策,还是要费点劲的。  另外又引出一个新问题,配置管理怎么做?嗯嗯,越来越复杂哈!

CruiseControl应用实践

  自从知道CruiseControl之后,一直很喜欢这个东东。这回项目组里开始兴起XP、Agile、Refactoring这些东东,于是我就想着希望能尽可能地向书上、网上写的那样,把CI搞起来,现在这个CruiseControl只用来编译一个发布版本的,照他们的说法,不是持续集成,而是持续编译,而且这里连持续编译都算不上,因为不是自动定时轮循的,而是手工去点一下那个force build按钮。鉴于我一个人在做一个项目,中间也没人过问,极大的自由度,照负责人的说法,试验田。呵呵,这次我就把CppUnit和Code Metric集成了进来。  我首先弄的是Code Metric。工程是用VC++开发的,于是用了一个在公司内被推广的工具Source Monitor,开始时没有仔细看它的帮助文档,还冒冒然给作者发了封邮件,问他能不能提供一个命令行版本。作者还好,回了封邮件说,Source Monitor本来就是支持命令行的,可以通过写一个XML格式的命令文件,通过命令行进行相关的代码度量工作,简单试了试,果然可以,基本能满足要求。然后又看到Contrib目录下有几个XML文件,通过ANT来转换Source Monitor生成的XML文件,太好了,又学到一招简单易用的,通过几个xsl文件,把Source monitor生成的度量数据用html格式呈现出来,在CruiseControl中没找到合适的地方显示,就只好把这些svg、html文件都拷贝到artifacts目录下。  然后弄CppUnit。CppUnit其实是个好东西,好处不用多说,但坏处在于它是JUINT的Cpp port,所以某些第三方的支持就不如JUINT的好。比如ANT是直接支持JUINT的,CPPUNIT就不行。另外,CPPUNIT原生支持的XML导出测试报告并不兼容CruiseControl的输入。走了一小点弯路,在网上搜了一下,发现CPPUNIT有个Contrib下的xsl文件,可以把它的原生XML输出转换成JUINT的XML格式输出,于是乎,就可以被CruiseControl接受了,哈哈。便宜说一下,似乎正式发布的源代码包里是没有这个xsl的,但从1.11.0开始就已经有这个了,需要自己从CVS里找。

重构ReviewTools

  今天决定开始对代码审查辅助工具动手,结果发现这个代码写得太复杂了,彻底晕死!本来看起来似乎是个很简单的小程序,功能也算比较简单,就是能添加一些信息,把这些信息保存到一个文件,到需要时能从文件中读出这些信息,另外一个功能是能把信息输出到Excel文件中,或者以一定规则输出到Lotus Notes中。  结果发现,为了跟Excel和Lotus Notes交互,必然使用到了COM接口,然而奇怪的是,原来那个作者把对Excel和Lotus Notes的操作简单地用VBS封装了一遍,结果是另一种脚本COM组件的形式出现,再在MFC程序中调用这些脚本组件,实在是不必要。  其次,因为本程序设计的是能在Source Insight中激活并添加信息,所以需要Source Insight的扩展来支持,也许是Source Insight的宏能力比较弱,原作者就设计成在C盘根目录下放置一个很小的cmdline.exe,让宏直接把所有信息当作命令行参数传入给这个小程序,通过它来调用主程序,于是为了在不同进程间传递数据,便把这个主程序设计成了一个进程外组件了。唉,又是COM,烦死人了。我也要把它改成不用COM的,用Event、File Mapping、Metux、Command Line Parameter应该能解决这个问题。  再次,界面上有个TreeView,TreeView的Data域不知道绑了多少数据上去,晕死!关键是不要绑MSXML的COM接口指针上去啊!  最后,我要在这个基础上重构的话,工作量比重新做一个大概少不了多少了!

好久没有shopping了

  去东门逛了一下午,买了件比较板的衬衣,一条黑色的休闲裤,薄薄的,适合夏天穿,为了搭配这身衣裤,还特地买了条皮带,这样800大洋就花出去了。然后是一双休闲类的皮鞋,又是400多大洋。好久没有这样添置自己的行头了,也许真应该好好地改变一下自己的外观形象,明天穿着人模人样地去公司晃悠一下。  不过逛得好累哦!