与afreez一起学习DirectFB之：编译运行第一个DirectFB程序

摘要：
本文介绍了如果把一个DirectFB源程序文件编译一个可执行的文件，附带性的介绍了gcc的常见编译选项的应用。

---------------------------------------------------------------------------------------------------------------------
声明：
此文为原创，欢迎转载，转载请保留如下信息
作者：聂飞（afreez）
联系方式：afreez@sina.com （欢迎与作者交流）
初次发布时间：2006-05-29
不经本人同意，不得用语商业或赢利性质目的，否则，作者有权追究相关责任！
---------------------------------------------------------------------------------------------------------------------

编程环境：
调试环境：FC5（Fedora Core 5）、DirectFB.0.9.24或DirectFB.0.9.25
安装信息：DirectFB不是默认的安装方式，安装路径为/usr/DirectFB25/

DirectFB源程序
程序名：draw_line.c
功能：在屏幕中间画一条水平直线

#include <stdio.h>
#include <unistd.h>

#include <directfb.h>

//这是最上层的接口，所有的函数入口均由它（IDirectFB）而来
static IDirectFB *dfb = NULL;

//主平面，也就是“屏幕”了。在交互层使用DFSCL_FULLSCREEN，它是主层平面。
static IDirectFBSurface *primary = NULL;

//这里存储主平面的高和宽，从而为其它的操作提供支持
static int screen_width = 0;
static int screen_height = 0;

//用以检测错误的宏定义，用来检测大部分的函数的返回值是否正常。只适合用在小的测试程序
#define DFBCHECK(x...) /
{ /
DFBResult err = x; /
/
if (err != DFB_OK) /
{ /
fprintf( stderr, "%s <%d>:/n/t", __FILE__, __LINE__ ); /
DirectFBErrorFatal( #x, err ); /
} /
}

int main (int argc, char **argv)
{
//为了创建一个平面，需要定义一个平面描述子（surface description）
DFBSurfaceDescription dsc;
//初始化
DFBCHECK (DirectFBInit (&argc, &argv));
DFBCHECK (DirectFBCreate (&dfb));
DFBCHECK (dfb->SetCooperativeLevel (dfb, DFSCL_FULLSCREEN));

//设定dsc的一些属性，现在可以不用关心
dsc.flags = DSDESC_CAPS;
dsc.caps = DSCAPS_PRIMARY | DSCAPS_FLIPPING;

//使用我们设定的dsc创建主平面（primary）
DFBCHECK (dfb->CreateSurface( dfb, &dsc, &primary ));
//得到主平面的宽与高
DFBCHECK (primary->GetSize (primary, &screen_width, &screen_height));
//通过画一个和主平面同等大小的矩形来清空主平面；默认颜色为黑色
DFBCHECK (primary->FillRectangle (primary, 0, 0, screen_width, screen_height));
//为了能显示画出来的线，先设置一下线的颜色，线的位置在屏幕的中间
DFBCHECK (primary->SetColor (primary, 0x80, 0x80, 0xff, 0xff));
DFBCHECK (primary->DrawLine (primary,0, screen_height / 2,screen_width - 1, screen_height / 2));

//显示
DFBCHECK (primary->Flip (primary, NULL, 0));

//等待5秒后，程序自动退出
sleep (5);
primary->Release( primary );
dfb->Release( dfb );
return 23;
}

编译准备
安装完DirectFB后，由于某种原因，我没有把/usr/DirectFB25/lib添加到配置文件/etc/ld.so.conf 中，所以，在进入（每一个）终端时，要设置两个环境变量，如下所示：
$export PKG_CONFIG_PATH=/usr/DirectFB25/lib/pkgconfig/
$export LD_LIBRARY_PATH=/usr/DirectFB25/lib

编译
为了详细分析其编译过程，先分析几个使用不当的编译过程，最后给出两中常用的编译方法。
不当编译1：$gcc draw_line.c -o draw_line
正常情况下，我们做一些练习时，常常使用如下的编译格式来编译：
$gcc src.c –o destination
如果这里，我们同样使用这样的编译选项时，会出现类似如下的编译错误：

draw_line.c:3:22: error: directfb.h: No such file or directory
draw_line.c:4: error: expected '=', ',', ';', 'asm' or '__attribute__' before '*' token
draw_line.c:5: error: expected '=', ',', ';', 'asm' or '__attribute__' before '*' token
draw_line.c: In function 'main':
draw_line.c:20: error: 'DFBSurfaceDescription' undeclared (first use in this function)
draw_line.c:20: error: (Each undeclared identifier is reported only once
draw_line.c:20: error: for each function it appears in.)
draw_line.c:20: error: expected ';' before 'dsc'
draw_line.c:21: error: 'DFBResult' undeclared (first use in this function)
draw_line.c:21: error: expected ';' before 'err'
……

错误中显示了很多编译异常输出，最让人无法忍受的是竟然没有找到头文件directfb.h，编译DirectFB应用程序，可基本上都需要这个头文件的！怎么会找不到呢？
使用$ls /usr/DirectFB25/include/directfb 查看一下，发现里面确实有directfb.h。那么，就是GCC没有找到该文件了，也就是说，gcc默认查找库文件的路径不包括：
/usr/DirectFB25/include/directfb
该路径是我安装的目录，如果不通知gcc的话，它是不会去这里找相关库文件及头文件的。
好了，知道了异常输出的原因之后，我们改用下面的编译命令进行编译。

不当编译2：
$gcc -L/usr/DirectFB25/lib -I/usr/DirectFB25/include/directfb draw_line.c -o draw_line
查看相关的gcc编译参数，我们可以知道其中的-L与-I的含义，相关含义大致如下：
-I（大写的i）参数是用来指定头文件目录，/usr/include目录一般是不用指定的，gcc知道去那里找，但是如果头文件不在/usr/include里我们就要用-I参数指定了，比如头文件放在/not_usr目录里，那编译命令行就要加上- I/not_usr参数了，如果不加你会得到一个类似上面的异常输出。-I参数可以用相对路径，比如头文件在当前目录，可以用-I.来指定。
-l（小写的L）参数就是用来指定程序要链接的库，-l参数紧接着就是库名。当我们自已要用到一个第三方提供的库名字libtest.so，那么我们只要把libtest.so拷贝到 /usr/lib里，编译时加上-ltest参数，我们就能用上libtest.so库了（当然要用libtest.so库里的函数，我们还需要与 libtest.so配套的头文件）。
放在/lib和/usr/lib和/usr/local/lib里的库直接用-l参数就能链接了，但如果库文件没放在这三个目录里，而是放在其他目录里，这时我们只用-l参数的话，链接还是会出错，出错信息大概是：“/usr/bin/ld: cannot find -lxxx”，也就是链接程序ld在那3个目录里找不到libxxx.so，这时另外一个参数-L就派上用场了，比如常用的X11的库，它在 /usr/X11R6/lib目录下，我们编译时就要用-L/usr/X11R6/lib -lX11参数，-L参数跟着的是库文件所在的目录名。再比如我们把libtest.so放在/aaa/bbb/ccc目录下，那链接参数就是- L/aaa/bbb/ccc –ltest。
可是，即使这样来编译，还是会出现如下的类似异常输出信息，大致如下：

/tmp/cc4yJt2K.o: In function `main':draw_line.c:(.text+0x1e): undefined reference to `DirectFBInit'
:draw_line.c:(.text+0x5f): undefined reference to `DirectFBErrorFatal'
:draw_line.c:(.text+0x6b): undefined reference to `DirectFBCreate'
:draw_line.c:(.text+0xac): undefined reference to `DirectFBErrorFatal'
:draw_line.c:(.text+0x107): undefined reference to `DirectFBErrorFatal'
:draw_line.c:(.text+0x178): undefined reference to `DirectFBErrorFatal'
:draw_line.c:(.text+0x1db): undefined reference to `DirectFBErrorFatal'
:draw_line.c:(.text+0x255): undefined reference to `DirectFBErrorFatal'
/tmp/cc4yJt2K.o:draw_line.c:(.text+0x2c8): more undefined references to `DirectFBErrorFatal' follow
collect2: ld returned 1 exit status

这次，头文件directfb.h是找到了，可是，好多库的接口函数却没有找到！注意，此时的输出都是连接错误，已经没有了语法错误了。也就是说，我们写的这个draw_line.c源文件已经通过了预编译、编译和汇编阶段，只是最后的连接过程出现了异常。Gcc的处理过程会经历四个过程，分别为∶预处理(也称 预编译，Preprocessing)、编译(Compilation)、汇编(Assembly)和连接(Linking)，详细介绍见相关资料。
也就是说，我们现在只要解决连接的问题就ok了。那么如何才能找到我们需要的函数库的接口呢？
如果你足够仔细的话，在安装DirectFB提供的事例（如：DirectFB-examples-0.9.23.tar.gz）的时候，其中会提级到一个文件，即directfb.pc。该文件记录了你的一些安装信息，现在让我们来看看它里面的内容把。
$ more /usr/DirectFB25/lib/pkgconfig/directfb.pc

prefix=/usr/DirectFB25
exec_prefix=${prefix}
libdir=${exec_prefix}/lib
includedir=${prefix}/include

Name: DirectFB
Description: Graphics and windowing library for the Linux frame buffer device
Version: 0.9.25
Requires: fusion direct
Libs: -L${libdir} -ldirectfb -lpthread -ldl -lz
Cflags: -D_REENTRANT -I${prefix}/include/directfb

里面详细记录了我们安装的路径、版本以及库的信息。特别注意里面有一行为：
Libs: -L${libdir} -ldirectfb -lpthread -ldl -lz
乖乖，终于找到它了，呵呵。好了，我们再来编译一下把。

正确的编译方式1
$ gcc -L/usr/DirectFB25/lib -I/usr/DirectFB25/include/directfb -ldirectfb -lpthread -ldl -lz draw_line.c -o draw_line
编译后，再也没有异常输出信息了，好了。终于成功了，还等什么？先去运行一下，看看效果吧！

如果你已经欣赏完了你“自己”画的那条直线的话，那么，我们再来看看另一种简便的编译方法。
正确的编译方式2
$gcc `pkg-config --cflags --libs directfb` -o draw_text draw_text.c
注意，这里的pkg-config --cflags --libs directfb两侧使用的不是单引号，而是键盘上数字键1左边的那个和“~”一体的“`”键符号；--libs 后面的包名directfb也不要忘记写，否则会出下类似如下的错误信息：

Package directfb was not found in the pkg-config search path.
Perhaps you should add the directory containing `directfb.pc'
to the PKG_CONFIG_PATH environment variable
No package 'directfb' found

在编译DirectFB应用程序和库的时候，pkg-config是一个十分有用的工具，关于pkg-config的使用方法，详见：
http://pkgconfig.freedesktop.org/wiki/

补充：
如果你安装的版本是DirectFB.0.9.25的话，在你用gcc编译时，可能会出现找不到libdirect-0.9.so.24或libdirectfb-0.9.so.24或libfusion-0.9.so.24的情况（反正我的机器是出现了）。查看你的libs位置：
$ls /usr/DirectFB25/lib
你会发现，其中的库的版本都是*.so.25，鬼才能找到什么*.so.24的连接库。不过，也没有关系了，有条件要上，没有条件，创造条件，也要上了。来，自己动手，丰衣足食吧。
$cd /usr/DirectFB25/lib
ln -s libdirect-0.9.so.25.0.0 libdirect-0.9.so.24
ln -s libdirectfb-0.9.so.25.0.0 libdirectfb-0.9.so.24
ln -s libfusion-0.9.so.25.0.0 libfusion-0.9.so.24

Reference:
1. 本文中的DirectFB画线应用程序来自：
http://www.directfb.org/docs/DirectFB_Tutorials/simple.html
2．Man page of gcc 使用$man gcc查看
3．Gcc相关的中文介绍，参照：
http://www.raidcheng.net/blog/archives/2005/03/
http://www.linuxeden.com/doc/20454.html