基于 JFace Text Framework 构建全功能代码编辑器: 第 10 部分:Text Formatting
2010-03-18 00:00:00 来源:WEB开发网 闂傚倸鍊搁崐鎼佸磹閹间礁纾归柟闂寸绾惧綊鏌熼梻瀵割槮缁炬儳缍婇弻鐔兼⒒鐎靛壊妲紒鐐劤缂嶅﹪寮婚悢鍏尖拻閻庨潧澹婂Σ顔剧磼閹冣挃闁硅櫕鎹囬垾鏃堝礃椤忎礁浜鹃柨婵嗙凹缁ㄧ粯銇勯幒瀣仾闁靛洤瀚伴獮鍥敍濮f寧鎹囬弻鐔哥瑹閸喖顬堝銈庡亝缁挸鐣烽崡鐐嶆棃鍩€椤掑嫮宓佸┑鐘插绾句粙鏌涚仦鎹愬闁逞屽墰閹虫捇锝炲┑瀣╅柍杞拌兌閻ゅ懐绱撴担鍓插剱妞ゆ垶鐟╁畷銉р偓锝庡枟閻撴洘銇勯幇闈涗簼缂佽埖姘ㄧ槐鎾诲礃閳哄倻顦板┑顔硷工椤嘲鐣烽幒鎴旀瀻闁规惌鍘借ⅵ濠电姷鏁告慨顓㈠磻閹剧粯鈷戞い鎺嗗亾缂佸鏁婚獮鍡涙倷閸濆嫮顔愬┑鐑囩秵閸撴瑦淇婇懖鈺冪<闁归偊鍙庡▓婊堟煛鐏炵硶鍋撻幇浣告倯闁硅偐琛ラ埀顒冨皺閺佹牕鈹戦悙鏉戠仸闁圭ǹ鎽滅划鏃堟偨缁嬭锕傛煕閺囥劌鐏犻柛鎰ㄥ亾婵$偑鍊栭崝锕€顭块埀顒佺箾瀹€濠侀偗婵﹨娅g槐鎺懳熺拠鑼舵暱闂備胶枪濞寸兘寮拠宸殨濠电姵纰嶉弲鎻掝熆鐠虹尨宸ョ€规挸妫濆铏圭磼濡搫顫嶇紓浣风劍閹稿啿鐣烽幋锕€绠婚悹鍥у级瀹撳秴顪冮妶鍡樺鞍缂佸鍨剁粋宥夋倷椤掍礁寮垮┑鈽嗗灣閸樠勭妤e啯鍊垫慨妯煎亾鐎氾拷

实现文本格式化
实现 IFormattingStrategy
首先我使用 ExprFormattingStrategy 实现 IFormattingStrategy 接口,我没有实现 IFormattingStrategyExtension,因为例子中的语言太简单了,我不需要多少上下文信息就可以做格式化工作。另外一个原因是:文本格式化的算法因不同的情况而已,且和和 JTF 的架构关系不大,没有必要进行详细的演示。我的格式化方式很简单:每个符号之间会有空格分隔(除了分号),且每行只允许写一条语句。
配置
修改 ExprConfiguration,覆盖 getContentFormatter 方法。我使用缺省实现,并用 setFormattingStrategy 方法注册 ExprFormattingStrategy。出于简单至上的原则,我没有实现 IContentFormatter,如果你的软件需求必须要实现 IContentFormatter,请不要犹豫。
快捷键处理
和内容提示,快速帮助一样,需要一个快捷键来触发文本格式化。普通的文本编辑器并没有格式化的功能,如果我需要使用格式化的命令ID,需要依赖 org.eclipse.jdt.ui 插件,我不太想这样做。当然对我这个例子来说,这无所谓,但如果是正在开发一个真正的产品,我想你也不希望为了使用一个常量就把整个 JDT 都包含进来,所以我通过扩展定义了一个格式化命令,并绑定到 Ctrl+Shift+F。然后,仿照快速帮助时的做法,在 ExprViewer 的 createHandlers 方法中添加一个 handler。
效果
尝试输入一些混乱的代码,全选后然后按下 Ctrl+Shift+F,你会得到如下的对比:
图1. 格式化之前
图2. 格式化之后
结束语
本文介绍的是JTF中文本格式化的基本概念和实现方式,下面是对这一章内容的进一步思考:
ExprFormattingStrategy 太简单了,format 方法的后面三个参数都没怎么用到。看看它们到底是什么意思,想想如何使用它们
我没有实现 IFormattingStrategyExtension,这样得不到很多信息。IFormattingStrategy 的 format 方法参数虽然不少,但是携带的信息还是太有限了。因此在实际的应用中,推荐实现 IFormattingStrategyExtension 以便能使用 IFormattingContext。
格式化会牵涉到很多的文本操作,不妨尝试使用 Eclipse 自带的一些工具。在 org.eclipse.text 插件中,封装了不少类型的文本操作,看看 TextEdit 和它的子类,相信你会有收获。不光是格式化,任何需要操作文档的功能都可以使用。
格式化的重头戏是格式化算法,但是它不在本系列的范畴之内。不过我要再提醒你,要把格式化做到 JDT 那样的水准,重要的是需要一个强大的解析器支持。
这些不足的地方留给有兴趣的读者。
本文示例源代码或素材下载
更多精彩
赞助商链接