Source_Insight使用教程

作为一个开放源代码的操作系统，Linux附带的源代码库使得广大爱好者有了一个广泛学习、深入钻研的机会，特别是 Linux内核的组织极为复杂，同时，又不能像windows平台的程序一样，可以使用集成开发环境通过察看变量和函数，甚至设置断点、单步运行、调试等 手段来弄清楚整个程序的组织结构，使得Linux内核源代码的阅读变得尤为困难。当然Linux下的vim和emacs编辑程序并不是没有提供 变量、函数搜索，彩色显示程序语句等功能。它们的功能是非常强大的。比如，vim和emacs就各自内嵌了一个标记程序，分别叫做ctag和etag，通 过配置这两个程序，也可以实现功能强大的函数变量搜索功能，但是由于其配置复杂，linux附带的有关资料也不是很详细，而且，即使建立好标记库，要实现 代码彩色显示功能，仍然需要进一步的配置（在另一片文章，我将会讲述如何配置这些功能），同时，对于大多数爱好者来说，可能还不能熟练使用vim和 emacs那些功能比较强大的命令和快捷键。为了方便的学习Linux源程序，我们不妨回到我们熟悉的window环境下，也算是“师以长夷以 制夷”吧。但是在Window平台上，使用一些常见的集成开发环境，效果也不是很理想，比如难以将所有的文件加进去，查找速度缓慢，对于非Windows 平台的函数不能彩色显示。于是笔者通过在互联网上搜索，终于找到了一个强大的源代码编辑器，它的卓越性能使得学习Linux内核源代码的难度大大降低，这 便是Source Insight3.0，它是一个Windows平台下的共享软件，由于Source Insight是一个Windows平台的应用软件，所以首先要通过相应手段把Linux系统上的程序源代码弄到Windows平台下，这一点可以通过在 linux平台上将/usr/src目录下的文件拷贝到Windows平台的分区上，或者从网上光盘直接拷贝文件到Windows平台的分区来实现。 下面主要讲解如何使用Source Insight，考虑到阅读源程序的爱好者都有相当的软件使用水平，本文对于一些琐碎、人所共知的细节略过不提，仅介绍一些主要内容，以便大家能够很快熟练使用本软件，减少摸索的过程。安 装Source Insight并启动程序，可以进入图1界面。在工具条上有几个值得注意的地方，如图所示，图中内凹左边的是工程按钮，用于显示工程窗口的情况；右边的那 个按钮按下去将会显示一个窗口，里边提供光标所在的函数体内对其他函数的调用图，通过点击该窗体里那些函数就可以进入该函数所在的地方。 图1 Source Insight界面图 由于Source Insight实质上是一个支持多种开发语言（java,c ,c+等等）的编辑器，只不过由于其查找、定位、彩色显示等功能的强大，而被我们当成源代码阅读工具使用。所以，为了有效的阅读源程序，首先必须选择功 能菜单上的 “Project”选项的子菜单“New Project”新建一个项目，项目名称可以自由选定，当然也可以选择删除（Remove）一个项目。当删除一个项目的时候，并不删除原有的源代码文件, 只是将该软件生成的那些工程辅助文件删除。设定之后，将会弹出一个对话框如图2，接受默认选择，如果，硬盘空间足够，可以将第一个复选框选上，该选项将会 需要与源代码大致同等的空间来建立一个本地数据库以加快查找的速度。图2 工程设置 点击“OK”按钮，接受选择后，将会有一个新的对话框弹出，在这个对话框里，可以选择将要阅读的文件加入工程，一种方式是通过在File Name中输入要阅读源代码文件的名称，点击“Add”按钮将其加入，也可以通过其中“Add All”和“Add Tree”两个按钮可以将选中目录的所有文件加入到工程中，其中“Add All”选项会提示加入顶层文件和递归加入所有文件两种方式，而“Add Tree”相当于“Add All”选项的递归加入所有文件，可以根据需要使用，就我来说，更喜欢“Add Tree”一些。由于该程序采用了部分打开文件的方式，没有用到的文件不会打开，所以，加入数千个文件也不用担心加入的文件超出程序的所能容忍的最大值， 我就是采用“Add Tree”的方式将Linux2.4内核的四千五百九十一个文件加入的。图3 添加文件加入文件后，点击一个文件，可以出现使用界面，如图4所示，其中，右边的那个窗口（Linux Project，即工程窗口）缺省按照字母顺序列出当前工程中所有的文件。图4 工作窗口 点击一个文件就可以打开该文件，显示如图5所示，进入到右边的那个窗口分别可以以文件列表的方式，列出所有的文件，每个窗体下边有一排按钮，左边的窗口 （21142.c）从左至右分别为：按字母顺序排列所有标记、按照文件中行数顺序排列标记、按照类型排列标记、浏览本地文件标记、标记窗口属性。右边的窗 口（Linux Project）从左至右分别为：按字母顺序文件列表、显示文件夹、按照文件类型归类文件、全部文件的所有标记列表、按照标记类型归类标记、跳转到定义 处、显示标记信息、浏览工程标记、查找函数调用、工程属性，其中全部文件的所有标记列表选项可能要一段时间抽取标记，同步到数据库去，如果开始选择了建立 标记数据库，将会在今后节省同步时间，最有用的莫过于浏览标记信息和查找函数调用，前者可以通过“Jump”按钮在不同的地方查找同样的标志，还可以通过 “Reference”按钮结合后者进行全局的标记查找。Reference 功能是Source Insight的特色之一，它可以在速度极快的在整个工程中找到所有的标记，并且在该行程序的前边加上红色箭头的小按钮链接上。图6是一个 Reference搜索后的结果，它可以有两种模式，一种集中显示结果，图6显示的就是这种模式，在这种模式下，可以通过前边的红色箭头小按钮进入另外一 种模式，该标记的具体的所在处，也可以通过标记的具体所在处点击红色箭头小按钮进入警种模式，还可以通过工具条上的两个红色小箭头直接在第二种模式下前后 移动，察看相应信息。它的这个强大的功能使得阅读Linux源程序有如神助。但是要注意的是，当进行了第二次“Reference”时，它会提示你将结果 集附加在第一个结果集的后边还是取代第一个结果集。如果选择前者，不能对结果集根据前后两次搜索结果进行分类，然后在其子类里进行移动，只能在整个结果集 里移动；如果，选择后者，结果集将会被替换为第二次搜索的结果，略微有些不方便。图6 Reference的搜索结果 当然，Source Insight 还提供了一些其他常见的便利。比如:右键菜单几乎包含了程序的所有功能，可以在编辑窗口为程序加上行号，还可以统计整个工程的程序行数,当然还有功能强大 却用不上自动完成功能，似乎连它的30天试用期也是别有用心可以迫使你尽可能快速的阅读源程序，其他一些技巧大家可以在使用过程中慢慢摸索。怎么样？ 爱好读源代码的朋友，不妨马上去下载一个，去开始我们的Linux内核探险之旅吧!SourceInsight使用技巧2008/05/19 16:44 学习研究 1、缩进与tab （1）Options菜单PreferencesTyping卡，勾掉下面两项 Typing tab indents line，regardless of selection，空行按tab无法前进 Typing tab replaces current selection，选定部分内容、再按tab时会清除所选 （2）Options菜单Document Options（针对不同文件类型，分别进行设置）下拉左上文件类型框、选择合适类型（c源文件）Editing Options框中，tab width=2 Editing Options框中，勾选Expand tabs（这样，按tab键、等价于输入2个空格） （3）Options菜单Document Options选择合适的文件类型点击右边中间的Auto Indent钮在弹出的框中，左边一定要点Smart，右边有两个复选框Indent Open Brace和Indent Close Brace，具体效果可以看SIS的HELP。按照部门里的编程风格要求，最方便的就是把两个复选框都取消掉，然后点OK。 勾选Auto Indent之SMART的效果在C程序里, 如果遇到行末没有分号的语句,如IF, WHILE, SWITCH等, 写到该行末按回车，则新行自动相对上一行缩进两列。 勾掉Indent Open Brace和Indent Close Brace的效果继上一段，在相对缩进行里, 如果输入, 则自动和上一行列对齐（好像勾不勾都会有这个功能）；而输入时，不会与下面的行对齐（这是勾上Indent Open Brace时的效果）。 2、向项目中添加文件时，只添加特定类型的文件（文件类型过滤器） 有个同事比较生猛，得整汇编代码，但在SIS里建立PROJECT并ADD TREE的时候，根据默认设置并不会把该TREE里面所有汇编文件都包含进来，只加了.inc和.asm后缀的，.s后缀的没有。而且用SIS打开.s的文件，一片黑白没有色彩，感觉回到DOS的EDIT时代了 解决方法是在Options-Document Options里面，点左上的Document Type下拉菜单，选择x86 Asm Source File，然后在右边的File filter里*.asm；*.inc；的后面加上*.s；接着CLOSE就可以了。上面两个问题解决了，但注意加入*.s后还需要重新ADD TREE一遍才能把这些汇编加到PROJECT里面。 3、去掉功能强大但是无用的自动完成功能 Options菜单Preferences Typing卡Auto Completion框，勾掉Use automatic symbol completion window（这里是SIS的全局设置） Options菜单Document OptionsEditing Options框中，勾掉Allow auto-complete（局部设置） 上面两项必须全部勾选，才能启用Auto Completion功能 4、恢复小键盘的+，-，*，/功能 Options菜单Key assignments，通过关键词Scroll 找到Scroll Half Page Up，取消小键盘/；通过关键词Scroll 找到Scroll Half Page Down取消小键盘*；通过关键词Function找到Function Up，取消小键盘-，通过关键词Function找到Function down，取消小键盘+。 5、恢复ctrl+a的全选功能 通过关键词save 找到save all，更改为ctrl+shift+a，通过关键词select找到select all， 更改为ctrl +a 6、解决字符等宽对齐问题。 SIS默认字体是VERDANA，很漂亮。这网页上应该也是用的VERDANA字体。但由于美观的缘故，VERDANA字体是不等宽的。比如下面两行 llllllllll MMMMMMMMMM 同样10个字符，长度差多了.用VERDANA来看程序，有些本应该对齐的就歪了。解放方法是使用等宽的字体，但肯定比较丑。可以用DOS字体，也就是记事本里的默认字体sysfixed 很丑，要有心理准备。比较推荐的是用Courier New。 SourceInsight提供的功能 1、解析日志信息时非常有用的Source Link 总地说来，SourceLink根据特定的搜索模式，把当前文件中满足模式的行、链接到由该行指定的其他源文件中。 所谓特定的搜索模式，共有两种File, then line和Line, then file，其中前后两部分依靠正则表达式的组的概念来予以分割。如果当前文件具有匹配行，比如Error d:tcsrcq5.c 18: Lvalue required in function jsSort，那么SourceInsight在该行创建SourceLink、把该行链接到由该行指定的文件中（即d:tcsrcq5.c，第18行）。 1.1 创建SourceLink 运行Search菜单的Parse Source Links命令，在弹出的框中、选择搜索模式、并填入相应的正则表达式串，点OK，SIS就会解析当前文件，如果有匹配，就创建SourceLink。 1.2 在解析日志信息时，使用SourceLink 可以打开日志信息，运行Parse Source Links命令，日志中能够匹配模式的每一行（通常是含有错误信息的行）、就会被设置上一个SourceLink 1.3在解析自定义命令输出时，使用SourceLink 首先勾选Custom Command 中的Parse Links in Output，然后选择特定的搜索模式，最后填入合适的正则表达式。这样，Source Insight把输出信息作为当前搜索用文件；并且，如果有匹配行（通常即编译错误信息行），SIS为 该行创建SourceLink、并把每一个错误信息中给定的文件（和行号）作为link目的地，这对于我们修改源代码错误非常有帮助。 2、替换（Replace） VS 上下文敏感的智能重命名（Context-Sensitive Smart Rename） 2.1 替换（Replace） 目前来说，普通的替换命令、快捷键为ctrl+H，足以已满足工作要求。 在弹出的替换窗口中，在Search框中勾选Selection来只在所选文本区域中替换（当然这时你要先选定区域然后再按ctrl+H）、勾选WholeFile来在整个当前文件内替换、两者都不勾选来从当前光标处替换至文件末尾；点右边的Files按钮，可选择替换多个文件的内容。 2.2上下文敏感的智能重命名（Context-Sensitive Smart Rename） Smart Rename命令、快捷键是Ctrl+，是上下文敏感的全局搜索替换。它可以智能地重命名全部项目文件中的一个标示符。SourceInsight的搜索索引（search index）使得搜索过程进行地非常快。而且，使用Smart Rename所做的替换会被记录在Search Results窗口中，每一条替换记录旁有一个SourceLink链接到替换发生地文件。 Smart Rename可以用来重命名标记（symbol）。如果勾选了Smart Reference Matching选项，Smart Rename就只在正确的上下文范围内进行重命名。它可以智能地重命名全部项目文件中的一个标示符；它可以重命名函数本地变量，类或结构体成员、函数。 在弹出的Smart Rename窗口中有下面几项 Old Name 填旧名称。光标下的词会被自动加载；光标的位置非常重要，这是因为Source Insight会根据本地上下文背景、准确地确定你想要重命名哪一个标记。 推荐只填单个词、而不是字符串。 如果你在命名成员变量、或本地变量（），Old Name框中会显示完全标记名、即上层容器名+标记名。例如，框中的DocDraw.paintStruc代表DocDraw是函数名，paintStruc是函数的本地成员变量。 New Name 填新名称。只填标记名，不填上层容器名。 Output Search Results 如果勾选，搜索替换结果日志会被输出到Search Results窗口中。可以通过Windows菜单来切换，或ctrl+tab切换察看。并且每一条记录旁会有SourceLink链接到替换发生地文件。 Confirm Each Replacement 每次替换询问。 Skip Comments 不重名注释部分。 【使用心得列表】 （）如何用Smart Rename重命名数组的数组名？如果只选取数组名，会报错！ （）如果勾掉Smart Reference Matching，会搜索全部项目文件，并且Old Name框中不显示完全限定名；如果勾选Smart Reference Matching，无法重命名数组名，而且鼠标位置不正确时会报错。应该如何应对？ 3、在SourceInsight中提供的正则表达式 3.1在SourceInsight中提供的正则表达式 正则表达式，是用来匹配复杂模式的特殊搜索用字符串。正则表达式串中，许多字符具有特殊的含义。例如，有个特殊的字符代表 行首。 下面是SourceInsight提供的所有可用特殊字符 Table 4.3: Regular Expression Characters Character Matches (at the beginning) beginning of line。如Hello，匹配Hello在句首。 . any single character abc any single character that belongs to the set abc abc any single character that does not belong to the set abc * zero or more occurrences of the preceding character + a tab character s a space character w white space (a tab or a space character) $ the end of the line。如TRUE$，匹配TRUE在句尾。 转义字符。如果在它后面有元字符，取消其特殊含义。 可利用 (和 )、把正则表达式分割成不同的组；模式中的每个组自左向右指定为 Group #n，n=1,2,；组的概念在替换时很有用。 例如 abc(xyz)可匹配abcxyz，其中xyz被认为是group#1， 利用21来替换(abc)(xyz)，替换结果为xyzabc。 3.2 正则表达式在配置tc编译器中的应用 正则表达式格式与源代码文件路径相对应，这里我的tc安装目录为d:tc，tc源文件放在d:tcsrc下，并命名为qn.c或qtn.c（其中n=1,2,）。 观察Tc编译器某一次输出错误信息的格式 Error d:tcsrcq5.c 18: Lvalue required in function jsSort 则我们要匹配d:tcsrcq5.c 18部分，进一步地，按照SourceInsight捕捉输出并加以解析时的要求，要以组的形式、分别匹配d:tcsrcq5.c 18中的文件部分和行号部分 行号(1-90-9*) 空格行号s(1-90-9*) 文件名(d:tcsrcqQtT1-90-9*.cC) 全部加起来为 (d:tcsrcqQtT*1-90-9*.cC)s(1-90-9*) 3.3 正则表达式在配置javac编译器中的应用 我的JAVA_HOME是c:jdk，我的java源文件放于d:javasrc中，并命名为qn.java或qtn.java（其中n=1,2,）。 观察JDK编译器某一次输出错误信息的格式 D:javasrcQ3.java:3: ; expected 正则表达式为 (dD:javasrcqQtT*1-90-9*.java):(1-90-9*) 4、自定义命令 自定义命令与项目相关，在一个项目中定义的所有自定义命令属于该项目、只对该项目有效（包括快捷键等）。 自定义命令类似于命令行批处理文件。SIS允许自定义命令在后台运行；并可以捕捉自定义命令的输出、放置于文件中、或粘贴入当前光标插入点。 分别利用上面SIS对输出信息的处理方式，自定义命令对集成编译器相当有用，可以捕捉编译器输出并创建SourceLink寻错；自定义命令对于文本过滤也相当有用，可选中待过滤区块、运行Sort自定义命令、粘贴回选定区块、即完成文本过滤。 请按下面步骤创建自定义命令 Options菜单Custom Command 点右边Add钮、填入新自定义命令名称，或下拉左边Commands、选择命令进行修改 Run框、填入待执行命令行，可含有特殊元字符，见后面的元字符表 Dir框、执行命令行时应处的目录，如不填，以源代码文件所在目录为命令执行目录 勾选Output框的Capture Output、输出被捕捉，如果勾选Paste Output，输出被粘贴 勾选Control Group框中的Save Files First、SIS会在运行命令前先检查文件是否保存 勾选Control Group框中的Pause When Done、SIS会在命令结束后暂停、方便检查 勾选Source Links in Output框中的Parse Source Links，?/p source insight常用宏 说明: 该宏文件实现一些编码程中能会到的功能, 如添加文件头、函数说明和宏定义等, 使用时能自动添加文件名、函数名和当前日期. 使用说明: 1. Project-Open Project. 打开Base工程(该工程一般在我的文档Source InsightProjectsBase中); 2. Project-Add and Remove Project Files. 加入宏文件(即Gaoke.em); 3. Options-Menu Assignments 打开Menu Assignments窗口, 在Command中输入Macro, 选中要使用的宏, 添加到合适的菜单中.