使用autotools生成Makefile(四) 总结

一、configure.ac文件

常用宏

AC_PREREQ
原型：AC_PREREQ(VERSION)
功能：需要的最低autoconf版本

AC_PREREQ([2.65])

AC_INIT
原型：AC_INIT(PACKAGE, VERSION, BUG-REPORT-ADDRESS)
功能：autoconf初始化。告诉autoconf包名称，版本，报告bug的Email

AM_INIT_AUTOMAKE
原型：AM_INIT_AUTOMAKE([OPTIONS…])
功能：初始化automake
参数：

参数	描述
-Wall	打开全部警告
-Werror	将警告当错误处理
-foreign	放宽一些GNU标准需求
-1.11.1	需要automake的最低版本
-dist-bzip2	在使用make dist和make distcheck期间同时创建tar.bz2存档
-tar-ustar	使用ustar格式创建tar存档

AM_INIT_AUTOMAKE([foreign -Wall -Werror])

AC_CHECK_HEADERS 或 AC_CHECK_HEADER
原型：
AC_CHECK_HEADERS(HEADERS…)
AC_CHECK_HEADER(HEADER, [ACT-IF-FOUND], [ACT-IF-NOT])
功能：检查头文件。代码中可以使用HAVE_XXX_H的方式检查该头文件是否存在

# 配置文件中的定义
AC_CHECK_HEADERS([string.h])

# 代码中的定义
#if HAVE_STRING_H
#include <string.h>
#else
/* replace header file */
#endif

AC_CONFIG_SRCDIR
原型：AC_CONFIG_SRCDIR ( unique-file-in-source-dir )
功能：确认某些关键文件在正确的目录中

AC_CONFIG_HEADERS
原型：AC_CONFIG_HEADERS(HEADERS…)
功能：创建头文件

# 创建config.h
AC_CONFIG_HEADERS([config.h])

# 创建config.h, 它的输入文件是config.h.ini, 在autoheader时被创建
AC_CONFIG_HEADERS([config.h:config.h.ini])

AC_CHECK_PROGS
原型：AC_CHECK_PROGS (variable, progs-to-check-for, [ value-if-not-found ], [ path = ‘$PATH’])
功能：将variable定义为第一个发现的程序，如果没有发现就设置为VAL-IF-NOT-FOUND

＃ 如果发现tar,gtar，就设置到变量$TAR中，如果没有发现就设置为‘：’
AC_CHECK_PROGS([TAR], [tar gtar], [:])
if test "$TAR" = :; then
AC_MSG_ERROR([This package needs tar])
fi

AC_DEFINE
原型：AC_DEFINE(VARIABLE, VALUE, DESCRIPTION)
功能：定义一个宏并输出到config.h中
注意：该宏是用于生成C语言的宏。如果value是一个shell变量可以使用AC_DEFINE_UNQUOTED

AC_SUBST
原型：AC_SUBST(VARIABLE, [VALUE])
功能：定义一个宏到Makefile中，可以在Makefile.am中以@XXX@的形式使用

AC_CHECK_LIB
原型：AC_CHECK_LIB(LIBRARY, FUNCT, [ACT-IF-FOUND], [ACT-IF-NOT])
功能：检查库是否存在并且包括函数FUNCT

AC_CHECK_LIB([efence], [malloc], [EFENCELIB=-lefence])
AC_SUBST([EFENCELIB])

AM_CONDITIONAL
原型：AM_CONDITIONAL(NAME, CONDITION)
功能：执行CONDITION中的shell语句，如果成功则定义变量NAME

＃ 仅当系统中存在bar.h文件时定义WANT_BAR
AC_CHECK_HEADER([bar.h], [use_bar=yes])
AM_CONDITIONAL([WANT_BAR], [test "$use_bar" = yes])

编译器和工具检查

宏	功能
AC_PROG_CC	检查C编译器
AC_PROG_CPP	检查C++编译器
AC_PROG_INSTALL	检查install工具
LT_INIT	检查libtool
AC_PROG_SED	检查sed工具
AC_PROG_YACC	检查YACC工具
AC_PROG_LEX	检查LEX工具

错误处理

宏	功能
AC_MSG_ERROR	打印错误信息并退出
AC_MSG_WARN	打印错误信息但不退出

configure.ac 常用宏总结

标签名	说明
AC_PREREQ	声明autoconf要求的版本号
AC_INIT	定义软件名称、版本号、联系方式
AM_INIT_AUTOMAKE	必须要的，指定编译参数
AC_CONFIG_SRCDIR	用来侦测所指定的源码文件是否存在, 来确定源码目录的有效性
AC_CONFIG_HEADER	指定产生的配置文件名称(一般是config.h),用于生成config.h文件，以便 autoheader 命令使用
AC_PROG_CC	用以探测当前系统的C编译器
AC_PROG_RANLIB	用于生成静态库
AC_PROG_LIBTOOL	用于生成动态库
AM_PROG_AR	生成静态库时使用，用于指定打包工具，一般指ar
AC_CONFIG_FILES	告知autoconf本工程生成哪些相应的Makefile文件，不同文件夹下的Makefile通过空格分隔
AC_OUTPUT	最后一个必须的宏,用以输出需要产生的文件
AC_PROG_CXX	用于探测系统的c++编译器
AC_CHECK_LIB	探测工程中出现的库文件及库文件中的方法
PKG_CHECK_MODULES	利用pkg-config生成 _CFLAGS _LIBS
AC_SUBST	输出能够被Makefile.am使用的变量

二、Makefile.am文件

父目录

使用SUBDIRS = XXX的格式增加子目录。

子目录
在autotools中，编译和安装的规则是在一起的：安装目录_编译类型=编译目标

安装目录

安装目录	Makefile中的变量	使用方式
prefix	默认/usr/local	通过–prefix指定
exec_prefix	${prefix}	同prefix
bindir	${exec_prefix}/bin	bin_编译类型
libdir	${exec_prefix}/lib	lib_编译类型
includedir	${prefix}/include	include_编译类型
noinstdir	无	不安装

• 设置编译目标时需要去掉dir后缀
• 如果自定义一个安装目录时需要加上dir的后缀

编译类型

编译类型	说明	使用方式
PROGRAMS	可执行程序	bin_PROGRAMS
LIBRARIES	库文件	lib_LIBRARIES
LTLIBRARIES	libtool库文件	lib_LTLIBRARIES
HEADERS	头文件	include_HEADERS
SCRIPTS	脚本文件	script_SCRIPTS
DATA	数据文件	conf_DATA

• script_SCRIPTS和conf_DATA中的安装目录需要手动配置

编译目标

参数	含义
_SOURCES	源代码文件
_LIBADD	需要链接的库
_LDADD	需要链接的库
_LDFLAGS	对应-L, -l, -shared, -fpic等选项
_LIBTOOLFLAGS	libtool编译时的选项

• 编译选项也可以使用宏AM_CFLAGS进行配置
• 如果你的编译目标为lib时，需要使用_LIBADD
• 如果你的编译目标为bin时，需要使用_LDADD

特别注意
一般在Makefile.am中用以下关键字表示make最终要生成的目标

1. bin_PROGRAMS 该条目后列举的若成功编译，则会生成二进制可执行文件
2. noinst_LIBRARIES 该条目后列举的若成功编译，则最终会生成中间文件
3. lib_LTLIBRARIES 该条目后列举的若成功编译，则会生成库文件(.so .a文件)

其余一些关键字：

1. _CFLAGS 或 _CPPFLAGS 列举预处理阶段源码中包含的头文件的寻找路径

2. _SOURCES 列举要生成的目标文件所依赖的源码文件(.c .cpp等)

3. _LIBADD 和 _LDADD
   均表示链接阶段要链接的库名
   不同：
   _LIBADD 用于Makefile生成中间文件(.la等)或库文件(.so .a)的情况
   _LDADD 用于Makefile生成二进制可执行文件的情况

4. 涉及到make install操作时要注意三个关键字(后2个需要成对出现)
   DESTDIR : 该变量默认为空，安装时需要sudo权限，可安装到系统目录
   _include_HEADERS : 列举要安装的头文件
   _includedir : 指定头文件的安装路径

三、其他

安装配置文件

某些时候，我们需要将一些配置文件安装到特殊的位置，可以使用下面的方式：

# 定义一个编译目标，安装目录为conf，编译类型为数据文件
confdir = ${exec_prefix}/conf
conf_DATA = utils.conf

打包

缺省情况下打包内容如下：

• 所有源文件。
• 所有[Makefile.am]/[Makefile.in]。
• configure需要读取的文件。
• [Makefile.am]和[configure.ac]包含的文件。
• 缺省文件，如README，ChangeLog，NEWS，AUTHORS。

如果需要打包其它文件（包括一些库，特殊的头文件，配置文件，帮助文件），需要特殊指定：

使用EXTRA_DIST来指定。
在编译目标前添加dist或nodist前缀。

为configure定义特殊接口

使用AC_ARG_WITH，添加–with-package参数
使用AC_ARG_ENABLE，添加-–enable-feature参数

配置特殊宏

• 新建一个单独的目录，用于存放自定义宏，一般定义为m4
• 为每个宏定义一个文件，以.m4结尾
• 使用AC_DEFUN定义具体的宏
• 运行aclocal -Im4生成aclocal.m4
• 在根目录下的Makefile.am中添加ACLOCAL_AMFLAGS = -I m4