构建基于LXR的源代码浏览平台

前端之家收集整理的这篇文章主要介绍了构建基于LXR的源代码浏览平台前端之家小编觉得挺不错的,现在分享给大家,也给大家做个参考。

构建基于LXR的源代码浏览平台

作者: 张桂权

如果你浏览过FreeBSD/Linux Kernel Cross Reference那么对LXR应该不会很陌生了。LXR,即“the Linux Cross Reference”的缩写,是为了更好的索引及呈现代码库而开发的工具集。LXR最初是为Linux开发的,不过目前已在很多软件项目中得到广泛的应用。

采用LXR构建源代码浏览平台有那些优越之处呢?如果你浏览过Linux的源码库平台,那你就明白了:

1)构建在Web环境的平台,可以供大型项目中的所有人员进行代码查阅,不受物理地域的限制;

2)提供代码cross-referencer浏览,以及代码文件中的“行号”标识,可以从任何地方跳转到所关注“主体”相关的声名及定义内容,方便于阅读。对于大型的软件项目,比如,代码有几十M甚至像Linux内核一样有几百M(对于这样的项目,代码行和文件数量之大是可以想象的。sqlite 3.7.0版本代码sqlite3.c文件大概有4.0M,文本行数118,667行。我用grepwc过滤了一下注释,大概有8万多行的代码。当然,sqlite代码的格式进行了很多优化,能更好的适用于打印排版。每行基本上都控制在80个字符以内,所以逻辑的一行代码可能被分解成几行,从而增加代码的行数。),

3)提供了“文件搜索”、“标识搜索”等查询功能,让阅读体验更加人性化等。

虽然,很多开发人员都喜欢用“Source Insight”、“UltraEdit@H_860_301@、“Kscope”以及“Code Browser”进行代码阅读,但是个人觉得还是没有LXR好。在接触LXR之前,笔者用得最多的还是AIX/HP-UX/HP-UX IA64/LINUX平台的grepvi/?搜索,有时会写复杂的正则表达式进行匹配。当然,各有优缺可圈可点。由于LXR不提供编辑功能,所以需要专业的开发工具进行代码开发。废话少说了,下面以sqlite 3.7.0代码为实例,介绍LXR平台的搭建流程。(注意:笔者使用的是Ubuntu 10.0.4OS环境,所以以下的操作命令只在此环境有效。)

1、安装Apache作为HTTP服务器

sudo apt-get install apache2 libapache2-mod-perl2

sudo apt-get install libcgi-simple-perl libcgi-ajax-perl libhtml-parser-perl libtemplate-perl

2、安装LXR

sudo apt-get install lxr

3、安装flex:安装索引工具glimpse时需要使用

sudo apt-get install flex

4、安装Glimpse作为LXR的源代码“索引”工具
(1)
下载Glimpse最新的源代码

wget http://webglimpse.net/trial/glimpse-latest.tar.gz

(2)代码解压:笔者下载到的是glimpse-4.18.6版本

tar xvfz glimpse-latest.tar.gz

3)切换到源码目录,执行以下的命令进行软件安装

cd glimpse-4.18.6

./configure

make

sudo make install

注意:在当前主流的Unix like的环境下,可以在shell命令中使用&&||等逻辑判断符来链接命令,以简化命令。比如,上面的命令可以简写为如下的模式:

cd glimpse-4.18.6 && ./configure && make && sudo make install

5、配置Apache环境

打开/etc/apache2/httpd.conf增加如下的内容

ServerName localhost

# Linux Cross Reference Refs

Alias /lxr /usr/share/lxr

<Directory /usr/share/lxr>

Options All

AllowOverride All

</Directory>

注意:配置localhostHTTP的访问域名

6、配置LXR相关HTTP访问机制

打开 /usr/share/lxr/http/.htaccess文件,编辑如下的内容

<Files ~ (search|source|ident|diff|find)$>

SetHandler cgi-script

</Files>

7、下载sqlite 3.7.0的源代码,并进行LXR相关的配置

(1)进入 /usr/share/lxr/source/目录

(2)下载sqlite 3.7.0代码

wget http://www.sqlite.org/sqlite-3.7.0.tar.gz

3)解压代码,并将目录更名为sqlite-3.7.0_dev (这个可以不用修改)

tar xvfz sqlite-3.7.0.tar.gz

mv sqlite-3.7.0 sqlite-3.7.0_dev

(4)设置sqlite的版本号

sudo echo sqlite-3.7.0_dev > /usr/share/lxr/source/versions

5创建默认的版本显示到源码的符号链接
ln -s /usr/share/lxr/source/sqlite-3.7.0_dev /usr/share/lxr/source/defversion

6)创建文件索引

cd /usr/share/lxr/source

sudo genxref

sudo glimpseindex -H .

(7) 设计WEB访问权限

chown www-data.www-data .glimpse_*

chown -R www-data.www-data /usr/share/lxr/

chown www-data.www-data fileidx

8修改LXR配置

打开/usr/share/lxr/http/lxr.conf文件,将

sourceroot: /usr/share/lxr/source/$v/linux/

改成

sourceroot: /usr/share/lxr/source/$v

8、启动Apache服务器

sudo apache2 restart

9、浏览sqlite代码

1)访问LXR默认首页

http://localhost/lxr/http/blurb.html

2)从首页转到sqlite代码浏览页面,如下图所示:


9-1 针对sqliteLXR平台界面


9-2 sqlite代码浏览


基于sqlite 3.7.0LXR环境搭建到此结束了。你可以去搭建自己的环境了。

LXR是一个非常“友好”的代码阅读环境,甚至我们可以在SVN代码库上建立LXR平台,然后通过脚本每天定时更新相关的索引,实现最新变更的代码浏览。

参考目录:

1AmirWatad.com"Browser the Linux Kernel Source with LXR"
http://www.amirwatad.com/blog/archives/2009/05/12/browse-the-linux-kernel-source-with-lxr/

2LXR

http://lxr.linux.no/

3Kscope

http://kscope.sourceforge.net/sshots.shtml

4Code Browser

http://linuxtoy.org/archives/code-browser.html

5C/C++集成开发环境 CodeLite IDE for C C++

http://www.codelite.org/

6FreeBSD and Linux Kernel Cross-Reference

http://fxr.watson.org/

猜你在找的Sqlite相关文章