运用Autoconf和Automake生成Makefile

一、    相关概念的介绍

什么是Makefile？怎么书写Makefile？竟然有工具可以自动生成Makefile?怎么生成啊？开始的时候，我有这么多疑问，所以，必须得先把基本的概念搞个清楚。

 

1. Makefile

　　makefile用来定义整个工程的编译规则。一个工程中的源文件计数，其按类型、功能、模块分别放在若干个目录中，makefile定义了一系列的规则来指定，哪些文件需要先编译，哪些文件需要后编译，哪些文件需要重新编译，甚至于进行更复杂的功能操作，因为 makefile就像一个Shell脚本一样，其中也可以执行操作系统的命令。

　　makefile带来的好处就是——“自动化编译”，一旦写好，只需要一个make命令，整个工程完全自动编译，极大的提高了软件开发的效率。make是一个命令工具，是一个解释makefile中指令的命令工具，一般来说，大多数的IDE都有这个命令，比如：Delphi的make，Visual C++的nmake，Linux下GNU的make。可见，makefile都成为了一种在工程方面的编译方法。

 

2. Autoconf

       Autoconf是一个用于生成可以自动地配置软件源代码包以适应多种Unix类系统的 shell脚本的工具。由Autoconf生成的配置脚本在运行的时候与Autoconf是无关的， 就是说配置脚本的用户并不需要拥有Autoconf。

       对于每个使用了Autoconf的软件包，Autoconf从一个列举了该软件包需要的，或者可以使用的系统特征的列表的模板文件中生成配置脚本。在shell代码识别并响应了一个被列出的系统特征之后，Autoconf允许多个可能使用（或者需要）该特征的软件包共享该特征。 如果后来因为某些原因需要调整shell代码，就只要在一个地方进行修改； 所有的配置脚本都将被自动地重新生成以使用更新了的代码。

 

3. Automake

       Automake是一个从文件`Makefile.am'自动生成`Makefile.in' 的工具。每个`Makefile.am'基本上是一系列make的宏定义 （make规则也会偶尔出现）。生成的`Makefile.in'服从GNU Makefile标准。GNU Makefile标准文档长、复杂，而且会发生改变。Automake的目的就是解除个人GNU维护者维护Makefile的负担 （并且让Automake的维护者来承担这个负担）。典型的Automake输入文件是一系列简单的宏定义。处理所有这样的文件以创建 `Makefile.in'。在一个项目（project）的每个目录中通常包含一个 `Makefile.am'。Automake在几个方面对一个项目做了限制；例如它假定项目使用Autoconf并且对`configure.in'的内容施加了某些限制。

       Automake支持三种目录层次： “flat”、“shallow”和“deep”。一个flat（平）包指的是所有文件都在一个目录中的包。为这类包提供的`Makefile.am' 缺少宏SUBDIRS。这类包的一个例子是termutils。一个deep（深）包指的是所有的源代码都被储存在子目录中的包；顶层 目录主要包含配置信息。GNU cpio 是这类包的一个很好的例子，GNU tar也是。deep包的顶层`Makefile.am'将包括 宏SUBDIRS，但没有其它定义需要创建的对象的宏。一个shallow（浅）包指的是主要的源代码储存在顶层目录中，而 各个部分（典型的是库）则储存在子目录中的包。Automake本身就是这类包（GNU make也是如此，它现在已经不使用automake）。

 

下面，就以这三种目录层次结构给大家介绍

首先下载安装相应的工具

apt-get install automake
apt-get install libtool

二、    Flat目录结构：

1. 目录结构：

Helloworld

|-mytest.h

|-mytest.c

|-mymain.c

　　顶级目录helloworld，该目录下存在三个文件。mytest.h头文件声明了sayhello()方法；mytest.c中实现了sayhello()方法；mymain.c中的main调用了sayhello()方法。

2. 执行步骤：

2.1. Autoscan

　　 在helloworld目录下执行autoscan命令，其中生成一个configure.scan的文件。

2.2. 将configure.scan文件更名为configure.in文件

2.3. 打开configure.in文件，修改文件内容

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

#AC_INIT([2.68])
AC_INIT([hello], [1.0], [**@126.com])
AC_CONFIG_SRCDIR([mymain.c])
#AC_CONFIG_HEADERS([config.h])

AM_INIT_AUTOMAKE(hello, 1.0)

# Check for programs
AC_PROG_CC

# Check for libraries
# Check for header files
# Check for typedefs, structures, and compiler characteristics.
# Check for library functions.

AC_OUTPUT(Makefile)

2.4. 然后分别执行以下两个命令：

aclocal

autoconf

2.5. 在helloworld文件夹下创建一个名为Makefile.am的文件，并输入一下内容： 　　

AUTOMAKE_OPTIONS=gnu
bin_PROGRAMS=hello
hello_SOURCES=mymain.c mytest.c mytest.h

2.6. 执行命令“automake --add-missing”，automake 会根据Makefile.am 文件产生一些文件，其中包含最重要的Makefile.in

[root@localhost hello]# automake --add-missing
configure.ac: installing './install-sh'    //创建install-sh文件
configure.ac: installing './missing'
Makefile.am: installing './INSTALL'
Makefile.am: required file './NEWS' not found
Makefile.am: required file './README' not found
Makefile.am: required file './AUTHORS' not found
Makefile.am: required file './ChangeLog' not found
Makefile.am: installing './COPYING'
Makefile.am: installing './depcomp'
[root@localhost hello]# automake --add-missing //再运行一次，可以辅助生成几个必要的文件
Makefile.am: required file './NEWS' not found //没有找到NEWS文件
Makefile.am: required file './README' not found
Makefile.am: required file './AUTHORS' not found
Makefile.am: required file './ChangeLog' not found 
[root@localhost hello]# touch NEWS    //创建NEWS文件，如果没有自动生成，手工创建
[root@localhost hello]# touch README   //创建README文件
[root@localhost hello]# touch AUTHORS   //创建AUTHORS文件
[root@localhost hello]# touch ChangeLog   //创建ChangeLog文件
[root@localhost hello]# automake --add-missing //再运行一次

2.7. 执行“./configure”命令生成Makefile文件

2.8. 执行“make”命令来编译hello.c程序，从而生成可执行程序hello。生成可执行程序hello后，执行“./hello”。

三、    shallow目录结构

1. 目录结构

helloworld

|-mymain.c

|head

||-mytest.h

||-mytest.c

 　　顶级目录helloworld，该目录下存在一个主文件mymain.c和一个目录head。head目录中，mytest.h头文件声明了sayhello()方法；mytest.c中实现了sayhello()方法；mymain.c中的main调用了sayhello()方法。

2. 执行步骤：

2.1. 在顶层目录下运行autoscan产生configure.scan文件

2.2. 将configure.scan文件更名为configure.in文件

2.3. 打开configure.in文件，修改文件内容

 哈哈，一定看到你想要的结果了吧。

#                                               -*- Autoconf -*-
# Process this file with autoconf to produce a configure script.
 
#AC_INIT([2.68])
AC_INIT([hello], [1.0], [**@126.com])
AC_CONFIG_SRCDIR([mymain.c])
#AC_CONFIG_HEADERS([config.h])
 
AM_INIT_AUTOMAKE(hello, 1.0)
 
# Check for programs
AC_PROG_CC
#使用静态库编译，需要此宏定义
AC_PROG_RAMLIB

# Check for libraries
# Check for header files
# Check for typedefs, structures, and compiler characteristics.
# Check for library functions.

AC_OUTPUT(Makefile head/Makefile)

2.4. 然后分别执行以下两个命令：

aclocal

autoconf

2.5. 在head文件夹下创建Makefile.am文件，内容如下：

AUTOMAKE_OPTIONS=gnu
noinst_LIBRARIES=libmytest.a
libmytest_a_SOURCES=mytest.h mytest.c

2.6. 在helloworld文件夹下创建Makefile.am文件，内容如下：

AUTOMAKE_OPTIONS=gnu
SUBDIRS=head
bin_PROGRAMS=hello
hello_SOURCES=mymain.c
hello_LDADD=head/mytest.a

2.7. 执行命令“automake –-add-missing”，automake会根据Makefile.am 文件产生一些文件，其中包含最重要的Makefile.in
2.8. 执行“./configure”命令生成Makefile文件
2.9. 执行“make”命令来编译hello.c程序，从而生成可执行程序hello。生成可执行程序hello后，执行“./hello”。
哈哈，shallow的目录结构也搞定了哦~~

四、    Deep目录结构

1. 目录结构

helloworld

|head

||-mytest.h

||-mytest.c

|src

||-mymain.c

 

　　顶级目录helloworld，该目录下存在两个目录src和head。Head目录中，mytest.h头文件声明了sayhello()方法；mytest.c中实现了sayhello()方法；src目 录中的mymain.c中的main调用了sayhello()方法。

2. 执行步骤

2.1.  在顶层目录下运行autoscan产生configure.scan文件

2.2.  将configure.scan文件更名为configure.in文件

2.3.  打开configure.in文件，修改文件内容

#                                               -*- Autoconf -*-
# Process this file with autoconf to produce a configure script.
 
#AC_INIT([2.68])
AC_INIT([hello], [1.0], [**@126.com])
AC_CONFIG_SRCDIR([src/mymain.c])
#AC_CONFIG_HEADERS([config.h])
 
AM_INIT_AUTOMAKE(hello, 1.0)
 
# Check for programs
AC_PROG_CC
#使用静态库编译，需要此宏定义
AC_PROG_RAMLIB

# Check for libraries
# Check for header files
# Check for typedefs, structures, and compiler characteristics.
# Check for library functions.

AC_OUTPUT(Makefile head/Makefile src/Makefile)

2.4.  然后分别执行以下两个命令： 

aclocal

autoconf

2.5.  在head文件夹下创建Makefile.am文件，内容如下：

AUTOMAKE_OPTIONS=gnu
noinst_LIBRARIES=libmytest.a
libmytest_a_SOURCES=mytest.h mytest.c

2.6.  在src文件夹下创建Makefile.am文件，内容如下：

AUTOMAKE_OPTIONS=gnu
bin_PROGRAMS=hello
hello_SOURCES=mymain.c
hello_LDADD=../head/libmytest.a

2.7.  在helloworld文件夹下创建Makefile.am文件，内容如下：

AUTOMAKE_OPTIONS=gnu
SUBDIRS=head src

2.8.  执行命令“automake –-add-missing”，automake会根据Makefile.am 文件产生一些文件，其中包含最重要的Makefile.in
2.9.  执行“make”命令来编译hello.c程序，从而生成可执行程序hello。生成可执行程序hello后，执行“./hello”。

五、    总结：
归纳一下以上所有例子的流程：
（1）在存放源代码的顶层目录下执行autoscan命令生成configure.scan文件。
（2）将configure.scan文件改名为configure.in，并对其默认配置进行修改。
（3）执行aclocal、autoconf两个命令，分别生成aclocal.m4、configure文件。
（4）在每个目录下创建一个名为Makefile.am的文件，并输入相应的内容。
（5）执行automake --add-missing，它根据Makefile.am文件，生成Makefile.in。
（6）执行./configure脚本文件，它根据Makefile.in文件，生成最终的Makefile文件。
（7）生成Makefile之后，执行“make”编译工程并且生成可执行程序。