公 告

欢迎各位网友添加友情链接,在您添加本博客:http://linux0818.blogspot.com/ 做为链接后, E-mail:linux0818@gmail.com给我,我将将您的网址添加到本博客。

2008年10月23日星期四

用autoconf,automake自动生成Makefile

使用 automake之前系统需要的安装的包:
GNU automake
GNU autoconf
GNU m4
perl
GNU libtool(如果你需要产生 shared library)
gcc
Automake 依赖于: Autoconf, Bash, Coreutils, Diffutils, Grep, M4, Make, Perl, Sed.

注:下面讲的是将所有文件放在一个文件夹里,而一些大项目往往是将源文件放在一个src/目录下,头文件放在一个include/ 目录下的,这样只要将下面的稍做修改就可以啦,我已经试过了,其目录结构是:

test/--------------src/
                  |__________include/
                  |__________lib/
                  |__________other  files(ex: configure,aclocal.m4,Makefile,Makefile.am,Makefile.in )

1、首先写好一个.c文件,如helloworld.c:(下面执行的命令都在此目录下)
-------------start-------------------
#include <stdio.h>

int main(int argc,char **argv)
{
printf("hello,xiongfeng!\n");
return 0;
}
--------------end--------------------

2、生成configure
  我们使用autoscan命令来帮助我们根据目录下的源代码生成一个configure.in的模板文件。
  命令:
   # autoscan
    # ls

ls后显示的文件:
    configure.scan helloworld.c

执行后在hellowrold目录下会生成一个文件:configure.scan,我们可以拿它作为configure.in的蓝本。
configure.scan文件改名为configure.in并编辑:
    #mv configure.scan configure.in
    #vi configure.in
configure.in修改成下面的内容并保存:
--------configure.in start-----------------

#                                               -*- Autoconf -*-
# Process this file with autoconf to produce a configure script.

#AC_PREREQ(2.60)
AC_INIT(helloworld.c)   #这个宏用来检查源代码所在的路径
AM_INIT_AUTOMAKE(helloworld,1.0)  #这个宏是必须的,描述了我们将要生成的软件包的名字及其版本号
#AC_CONFIG_SRCDIR([helloworld.c])
#AC_CONFIG_HEADER([config.h])

# Checks for programs.
AC_PROG_CC   #这个宏将检查系统所用的C编译器。

# Checks for libraries.

# Checks for header files.

# Checks for typedefs, structures, and compiler characteristics.

# Checks for library functions.

AC_OUTPUT(Makefile)  #这个宏是我们要输出的Makefile的名字

--------configure.in stop-------------------
然后执行命令aclocal和autoconf,分别会产生aclocal.m4及configure两个文件:

# aclocal
#ls

ls后显示的文件:
aclocal.m4 configure.in helloworld.c

# autoconf
# ls

ls后显示的文件:
aclocal.m4 autom4te.cache configure configure.in helloworld.c

        大家可以看到configure.in内容是一些宏定义,这些宏经autoconf处理后会变成检查系统特性、环境变
量、软件必须的参数的shell脚本。autoconf 是用来生成自动配置软件源代码脚本(configure)的工
具。configure脚本能独立于autoconf运行,且在运行的过程中,不需要用户的干预。要生成configure
文件,你必须告诉autoconf如何找到你所用的宏。方式是使用aclocal程序来生成你的aclocal.m4。
aclocal根据configure.in文件的内容,自动生成aclocal.m4文件。aclocal是一个perl 脚本程序,它
的定义是:"aclocal - create aclocal.m4 by scanning configure.ac"。autoconf从
configure.in这个列举编译软件时所需要各种参数的模板文件中创建configure。autoconf需要GNU m4宏
处理器来处理aclocal.m4,生成configure脚本。m4是一个宏处理器。将输入拷贝到输出,同时将宏展开。
宏可以是内嵌的,也可以是用户定义的。除了可以展开宏,m4还有一些内建的函数,用来引用文件,执行命令,
整数运算,文本操作,循环等。m4既可以作为编译器的前端,也可以单独作为一个宏处理器。

3、编辑Makefile.am

# vi Makefile.am
内容如下:
----------Makefile.am start------------

AUTOMAKE_OPTIONS=foreign  #它会检查目录下是否存在标准GNU软件包中应具备的各种文件
bin_PROGRAMS=helloworld   #指定我们所要产生的可执行文件的文件名
helloworld_SOURCES=helloworld.c #指定产生"helloworld"时所需要的源代码和头文件

----------Makefile.am stop-------------
   automake会根据你写的Makefile.am来自动生成Makefile.in。Makefile.am中定义的宏和目标,会指导
automake生成指定的代码。例如,宏bin_PROGRAMS将导致编译和连接的目标被生成。

4、运行automake

# automake --add-missing  #让automake加入一个标准的软件包所必须的一些文件
运行后显示:
-----------------start-------------------------
configure.in: installing `./install-sh'
configure.in: installing `./mkinstalldirs'
configure.in: installing `./missing'
Makefile.am: installing `./depcomp'
-----------------stop--------------------------
  automake会根据Makefile.am文件产生一些文件,包含最重要的Makefile.in。

5、执行configure生成Makefile

# ./configure

运行后显示:
------------------------start---------------------------------
checking for a BSD-compatible install... /usr/bin/install -c
checking whether build environment is sane... yes
checking for gawk... gawk
checking whether make sets $(MAKE)... yes
checking for gcc... gcc
checking for C compiler default output... a.out
checking whether the C compiler works... yes
checking whether we are cross compiling... no
checking for suffix of executables...
checking for suffix of object files... o
checking whether we are using the GNU C compiler... yes
checking whether gcc accepts -g... yes
checking for gcc option to accept ANSI C... none needed
checking for style of include used by make... GNU
checking dependency style of gcc... gcc3
configure: creating ./config.status
config.status: creating Makefile
config.status: executing depfiles commands
------------------------stop-----------------------------------
# ls -l Makefile
-rw-r--r-- 1 root root 16687 Apr 21 18:37 Makefile
这样,你的Makefile已经产生出来了。

6、使用Makefile编译代码

# make

运行后显示:
------------------------start-----------------------------------
if gcc -DPACKAGE_NAME=\"\" -DPACKAGE_TARNAME=\"\" -DPACKAGE_VERSION=\"\"
-DPACKAGE_STRING=\"\" -DPACKAGE_BUGREPORT=\"\" -DPACKAGE=\"hello\" -DVER
SION=\"1.0\" -I. -I.     -g -O2 -MT helloworld.o -MD -MP -MF ".deps/hell
oworld.Tpo" -c -o helloworld.o helloworld.c;then mv -f ".deps/helloworl
d.Tpo" ".deps/helloworld.Po"; else rm -f ".deps/helloworld.Tpo"; exit 1;
fi gcc  -g -O2   -o helloworld  helloworld.o 
------------------------stop-------------------------------------

7、运行可执行文件helloworld

#./helloworld

运行后显示:
------------------------start-----------------------------------
hello,xiongfeng!   
------------------------stop-------------------------------------

深入浅出

  针对上面提到的各个命令,我们再做些详细的介绍。

  1、 autoscan

  autoscan是用来扫描源代码目录生成configure.scan文件的。autoscan可以用目录名做为参数,但如果你不使用参数的话,那么autoscan将认为使用的是当前目录。autoscan将扫描你所指定目录中的源文件,并创建configure.scan文件。

  2、 configure.scan

  configure.scan包含了系统配置的基本选项,里面都是一些宏定义。我们需要将它改名为configure.in

  3、 aclocal

  aclocal是一个perl 脚本程序。aclocal根据configure.in文件的内容,自动生成aclocal.m4文件。aclocal的定义是:"aclocal - create aclocal.m4 by scanning configure.ac"。

  4、 autoconf

  autoconf是用来产生configure文件的。configure是一个脚本,它能设置源程序来适应各种不同的操作系统平台,并且根据不同的系统来产生合适的Makefile,从而可以使你的源代码能在不同的操作系统平台上被编译出来。

  configure.in文件的内容是一些宏,这些宏经过autoconf 处理后会变成检查系统特性、环境变量、软件必须的参数的shell脚本。configure.in文件中的宏的顺序并没有规定,但是你必须在所有宏的最前面和最后面分别加上AC_INIT宏和AC_OUTPUT宏。

  在configure.ini中:

  #号表示注释,这个宏后面的内容将被忽略。

  AC_INIT(FILE)

  这个宏用来检查源代码所在的路径。

AM_INIT_AUTOMAKE(PACKAGE, VERSION)

  这个宏是必须的,它描述了我们将要生成的软件包的名字及其版本号:PACKAGE是软件包的名字,VERSION是版本号。当你使用make dist命令时,它会给你生成一个类似helloworld-1.0.tar.gz的软件发行包,其中就有对应的软件包的名字和版本号。

AC_PROG_CC

  这个宏将检查系统所用的C编译器。

AC_OUTPUT(FILE)

  这个宏是我们要输出的Makefile的名字。

  我们在使用automake时,实际上还需要用到其他的一些宏,但我们可以用aclocal 来帮我们自动产生。执行aclocal后我们会得到aclocal.m4文件。

  产生了configure.in和aclocal.m4 两个宏文件后,我们就可以使用autoconf来产生configure文件了。

  5、 Makefile.am

  Makefile.am是用来生成Makefile.in的,需要你手工书写。Makefile.am中定义了一些内容:

AUTOMAKE_OPTIONS

  这个是automake的选项。在执行automake时,它会检查目录下是否存在标准GNU软件包中应具备的各种文件,例如AUTHORS、ChangeLog、NEWS等文件。我们将其设置成foreign时,automake会改用一般软件包的标准来检查。

bin_PROGRAMS

  这个是指定我们所要产生的可执行文件的文件名。如果你要产生多个可执行文件,那么在各个名字间用空格隔开。

helloworld_SOURCES

  这个是指定产生"helloworld"时所需要的源代码。如果它用到了多个源文件,那么请使用空格符号将它们隔开。比如需要 helloworld.h,helloworld.c那么请写成helloworld_SOURCES= helloworld.h helloworld.c。

  如果你在bin_PROGRAMS定义了多个可执行文件,则对应每个可执行文件都要定义相对的filename_SOURCES。

  6、 automake

  我们使用automake --add-missing来产生Makefile.in。

  选项--add-missing的定义是"add missing standard files to package",它会让automake加入一个标准的软件包所必须的一些文件。

  我们用automake产生出来的Makefile.in文件是符合GNU Makefile惯例的,接下来我们只要执行configure这个shell 脚本就可以产生合适的 Makefile 文件了。

  7、 Makefile

  在符合GNU Makefiel惯例的Makefile中,包含了一些基本的预先定义的操作:

make

  根据Makefile编译源代码,连接,生成目标文件,可执行文件。

make clean

  清除上次的make命令所产生的object文件(后缀为".o"的文件)及可执行文件。

make install

  将编译成功的可执行文件安装到系统目录中,一般为/usr/local/bin目录。

make dist

  产生发布软件包文件(即distribution package)。这个命令将会将可执行文件及相关文件打包成一个tar.gz压缩的文件用来作为发布软件的软件包。

  它会在当前目录下生成一个名字类似"PACKAGE-VERSION.tar.gz"的文件。PACKAGE和VERSION,是我们在configure.in中定义的AM_INIT_AUTOMAKE(PACKAGE, VERSION)。

make distcheck

  生成发布软件包并对其进行测试检查,以确定发布包的正确性。这个操作将自动把压缩包文件解开,然后执行configure命令,并且执行make,来确认编译不出现错误,最后提示你软件包已经准备好,可以发布了。

===============================================
helloworld-1.0.tar.gz is ready for distribution
===============================================
make distclean

  类似make clean,但同时也将configure生成的文件全部删除掉,包括Makefile。

 结束语

  通过上面的介绍,你应该可以很容易地生成一个你自己的符合GNU惯例的Makefile文件及对应的项目文件。

  如果你想写出更复杂的且符合惯例的Makefile,你可以参考一些开放代码的项目中的configure.in和Makefile.am文件,比如:嵌入式数据库sqlite,单元测试cppunit。
GNU Makefile详细说明可到GNU官方网站上查阅: http://www.gnu.org/
Automake下载官方网站:ftp://ftp.gnu.org/gnu/automake/

--
/**************************************/
Name: Xiong Feng
E-mail:linux0818@gmail.com
MSN:linux0818@hotmail.com
QQ:23562033
Address: GuangZhou.China
/**************************************/

没有评论:

发表评论