Source-Insight教程

作为一个开放源代码的操作系统，Linux附带的源代码库使得广大爱好者有了一个广泛学习、深入钻研的机会，特别是Linux内核的组织极为复杂，同时，又不能像windows平台的程序一样，可以使用集成开发环境通过察看变量和函数，甚至设置断点、单步运行、调试等手段来弄清楚整个程序的组织结构，使得Linux内核源代码的阅读变得尤为困难。当然Linux下的vim和emacs编辑程序并不是没有提供变量、函数搜索，彩色显示程序语句等功能。它们的功能是非常强大的。比如，vim和emacs就各自内嵌了一个标记程序，分别叫做ctag和etag，通过配置这两个程序，也可以实现功能强大的函数变量搜索功能，但是由于其配置复杂，linux附带的有关资料也不是很详细，而且，即使建立好标记库，要实现代码彩色显示功能，仍然需要进一步的配置（在另一片文章，我将会讲述如何配置这些功能），同时，对于大多数爱好者来说，可能还不能熟练使用vim和emacs那些功能比较强大的命令和快捷键。为了方便的学习Linux源程序，我们不妨回到我们熟悉的window环境下，也算是“师以长夷以制夷”吧。但是在Window平台上，使用一些常见的集成开发环境，效果也不是很理想，比如难以将所有的文件加进去，查找速度缓慢，对于非Windows平台的函数不能彩色显示。于是笔者通过在互联网上搜索，终于找到了一个强大的源代码编辑器，它的卓越性能使得学习Linux内核源代码的难度大大降低，这便是SourceInsight3.0，它是一个Windows平台下的共享软件，由于SourceInsight是一个Windows平台的应用软件，所以首先要通过相应手段把Linux系统上的程序源代码弄到Windows平台下，这一点可以通过在linux平台上将/usr/src目录下的文件拷贝到Windows平台的分区上，或者从网上光盘直接拷贝文件到Windows平台的分区来实现。下面主要讲解如何使用SourceInsight，考虑到阅读源程序的爱好者都有相当的软件使用水平，本文对于一些琐碎、人所共知的细节略过不提，仅介绍一些主要内容，以便大家能够很快熟练使用本软件，减少摸索的过程。安装SourceInsight并启动程序，可以进入图1界面。在工具条上有几个值得注意的地方，如图所示，图中内凹左边的是工程按钮，用于显示工程窗口的情况；右边的那个按钮按下去将会显示一个窗口，里边提供光标所在的函数体内对其他函数的调用图，通过点击该窗体里那些函数就可以进入该函数所在的地方。图图图图1SourceInsight1SourceInsight1SourceInsight1SourceInsight界面图界面图界面图界面图由于SourceInsight实质上是一个支持多种开发语言（java,c,c++等等）的编辑器，只不过由于其查找、定位、彩色显示等功能的强大，而被我们当成源代码阅读工具使用。所以，为了有效的阅读源程序，首先必须选择功能菜单上的“Project”选项的子菜单“NewProject”新建一个项目，项目名称可以自由选定，当然也可以选择删除（Remove）一个项目。当删除一个项目的时候，并不删除原有的源代码文件,只是将该软件生成的那些工程辅助文件删除。设定之后，将会弹出一个对话框如图2，接受默认选择，如果，硬盘空间足够，可以将第一个复选框选上，该选项将会需要与源代码大致同等的空间来建立一个本地数据库以加快查找的速度。图图图图2222工程设置工程设置工程设置工程设置点击“OK”按钮，接受选择后，将会有一个新的对话框弹出，在这个对话框里，可以选择将要阅读的文件加入工程，一种方式是通过在FileName中输入要阅读源代码文件的名称，点击“Add”按钮将其加入，也可以通过其中“AddAll”和“AddTree”两个按钮可以将选中目录的所有文件加入到工程中，其中“AddAll”选项会提示加入顶层文件和递归加入所有文件两种方式，而“AddTree”相当于“AddAll”选项的递归加入所有文件，可以根据需要使用，就我来说，更喜欢“AddTree”一些。由于该程序采用了部分打开文件的方式，没有用到的文件不会打开，所以，加入数千个文件也不用担心加入的文件超出程序的所能容忍的最大值，我就是采用“AddTree”的方式将Linux2.4内核的四千五百九十一个文件加入的。图图图图3333添加文件添加文件添加文件添加文件加入文件后，点击一个文件，可以出现使用界面，如图4所示，其中，右边的那个窗口（LinuxProject，即工程窗口）缺省按照字母顺序列出当前工程中所有的文件。图图图图4444工作窗口工作窗口工作窗口工作窗口点击一个文件就可以打开该文件，显示如图5所示，进入到右边的那个窗口分别可以以文件列表的方式，列出所有的文件，每个窗体下边有一排按钮，左边的窗口（21142.c）从左至右分别为：按字母顺序排列所有标记、按照文件中行数顺序排列标记、按照类型排列标记、浏览本地文件标记、标记窗口属性。右边的窗口（LinuxProject）从左至右分别为：按字母顺序文件列表、显示文件夹、按照文件类型归类文件、全部文件的所有标记列表、按照标记类型归类标记、跳转到定义处、显示标记信息、浏览工程标记、查找函数调用、工程属性，其中全部文件的所有标记列表选项可能要一段时间抽取标记，同步到数据库去，如果开始选择了建立标记数据库，将会在今后节省同步时间，最有用的莫过于浏览标记信息和查找函数调用，前者可以通过“Jump”按钮在不同的地方查找同样的标志，还可以通过“Reference”按钮结合后者进行全局的标记查找。Reference功能是SourceInsight的特色之一，它可以在速度极快的在整个工程中找到所有的标记，并且在该行程序的前边加上红色箭头的小按钮链接上。图6是一个Reference搜索后的结果，它可以有两种模式，一种集中显示结果，图6显示的就是这种模式，在这种模式下，可以通过前边的红色箭头小按钮进入另外一种模式，该标记的具体的所在处，也可以通过标记的具体所在处点击红色箭头小按钮进入警种模式，还可以通过工具条上的两个红色小箭头直接在第二种模式下前后移动，察看相应信息。它的这个强大的功能使得阅读Linux源程序有如神助。但是要注意的是，当进行了第二次“Reference”时，它会提示你将结果集附加在第一个结果集的后边还是取代第一个结果集。如果选择前者，不能对结果集根据前后两次搜索结果进行分类，然后在其子类里进行移动，只能在整个结果集里移动；如果，选择后者，结果集将会被替换为第二次搜索的结果，略微有些不方便。图图图图6Reference6Reference6Reference6Reference的搜索结果的搜索结果的搜索结果的搜索结果当然，SourceInsight还提供了一些其他常见的便利。比如:右键菜单几乎包含了程序的所有功能，可以在编辑窗口为程序加上行号，还可以统计整个工程的程序行数,当然还有功能强大却用不上自动完成功能，似乎连它的30天试用期也是别有用心――可以迫使你尽可能快速的阅读源程序，其他一些技巧大家可以在使用过程中慢慢摸索。怎么样？爱好读源代码的朋友，不妨马上去下载一个，去开始我们的Linux内核探险之旅吧!SourceInsight使用技巧使用技巧使用技巧使用技巧2008/05/1916:44[学习研究]1、、、、缩进与缩进与缩进与缩进与tab（1）Options菜单
Preferences
Typing卡，勾掉下面两项∶Typingtabindentsline，regardlessofselection，空行按tab无法前进Typingtabreplacescurrentselection，选定部分内容、再按tab时会清除所选（2）Options菜单
DocumentOptions（针对不同文件类型，分别进行设置）
下拉左上文件类型框、选择合适类型（c源文件）
EditingOptions框中，tabwidth=2
EditingOptions框中，勾选Expandtabs（这样，按tab键、等价于输入2个空格）（3）Options菜单
DocumentOptions
选择合适的文件类型
点击右边中间的AutoIndent钮
在弹出的框中，左边一定要点Smart，右边有两个复选框IndentOpenBrace和IndentCloseBrace，具体效果可以看SIS的HELP。按照部门里的编程风格要求，最方便的就是把两个复选框都取消掉，然后点OK。勾选AutoIndent之SMART的效果∶在C程序里,如果遇到行末没有分号的语句,如IF,WHILE,SWITCH等,写到该行末按回车，则新行自动相对上一行缩进两列。勾掉IndentOpenBrace和IndentCloseBrace的效果∶继上一段，在相对缩进行里,如果输入},则自动和上一行列对齐（好像勾不勾都会有这个功能）；而输入{时，不会与下面的行对齐（这是勾上IndentOpenBrace时的效果）。2、、、、向项目中添加文件时向项目中添加文件时向项目中添加文件时向项目中添加文件时，，，，只添加特定类型的文件只添加特定类型的文件只添加特定类型的文件只添加特定类型的文件（（（（文件类型过滤器文件类型过滤器文件类型过滤器文件类型过滤器））））有个同事比较生猛，得整汇编代码，但在SIS里建立PROJECT并ADDTREE的时候，根据默认设置并不会把该TREE里面所有汇编文件都包含进来，只加了.inc和.asm后缀的，.s后缀的没有。而且用SIS打开.s的文件，一片黑白没有色彩，感觉回到DOS的EDIT时代了……解决方法是在Options-DocumentOptions里面，点左上的DocumentType下拉菜单，选择x86AsmSourceFile，然后在右边的Filefilter里*.asm；；；；*.inc；；；；的后面加上*.s；接着CLOSE就可以了。上面两个问题解决了，但注意加入*.s后还需要重新ADDTREE一遍才能把这些汇编加到PROJECT里面。3、、、、去掉功能强大但是无用的自动完成功能去掉功能强大但是无用的自动完成功能去掉功能强大但是无用的自动完成功能去掉功能强大但是无用的自动完成功能Options菜单
Preferences
Typing卡
AutoCompletion框，勾掉Useautomaticsymbolcompletionwindow（这里是SIS的全局设置）Options菜单
DocumentOptions
EditingOptions框中，勾掉Allowauto-complete（局部设置）上面两项必须全部勾选，才能启用AutoCompletion功能4、、、、恢复小键盘的恢复小键盘的恢复小键盘的恢复小键盘的+，，，，-，，，，*，，，，/功能功能功能功能Options菜单
Keyassignments，通过关键词Scroll找到ScrollHalfPageUp，取消小键盘/；通过关键词Scroll找到ScrollHalfPageDown取消小键盘*；通过关键词Function找到FunctionUp，取消小键盘-，通过关键词Function找到Functiondown，取消小键盘+。5、、、、恢复恢复恢复恢复ctrl+a的全选功能的全选功能的全选功能的全选功能通过关键词save找到saveall，更改为ctrl+shift+a，通过关键词select找到selectall，更改为ctrl+a6、、、、解决字符等宽对齐问题解决字符等宽对齐问题解决字符等宽对齐问题解决字符等宽对齐问题。。。。SIS默认字体是VERDANA，很漂亮。这网页上应该也是用的VERDANA字体。但由于美观的缘故，VERDANA字体是不等宽的。比如下面两行llllllllllMMMMMMMMMM同样10个字符，长度差多了.用VERDANA来看程序，有些本应该对齐的就歪了。解放方法是使用等宽的字体，但肯定比较丑。可以用DOS字体，也就是记事本里的默认字体sysfixed很丑，要有