configure.in Makefile.am 解析
用前面所介绍的基本概念,已经可以编译全功能的Gtk+/Gnome应用程序了。但是还有一个大问题:如何配置编译选项?一些实用工具如automake、autoconf、libtool等,可以用来简化这一过程。
为了方便维护,同时,也是为了便于使用这些实用工具,应该在编写代码时遵从一些约定。如果要将程序发布为自由软件,最好能使程序源代码的目录结构遵从“GNU项目编码标准”。即使应用程序是私有的商用程序,不想公开源代码,从技术上来说,这么做也是一个非常好的选择,因为这些标准都是经过实践检验,能够让你节省大量的时间和精力。另外还应该在程序代码中包含INSTALL、README的文件。
2.11.1生成源代码树
差不多所有的Gnome应用程序都使用同样的基于GNU工具automake、autoconf和libtool的编译系统。Gtk+和 Gnome提供了一套autoconf宏,用于生成可移植的、符合标准的编译设置。我们用一个称GnomeHello的应用程序来演示Gnome的特性。
Gnome应用程序遵从一系列的约定来生成源代码树和发布的tar文件,大多数约定被自由软件社区广泛使用。这些约定的许多方面已经在“GNU项目编码标准”(GNUProject’sCodingStandards
http://www.gnu.org/prep/standards_toc.html)和Linux文件系统层次标准 (LinuxFilesystemHierarchyStandard:http://www.pathname.com/fhs/)中正式化了。GNU 工具集,包括automake和autoconf使遵从这些标准变得很容易。然而,有时候你可能不想使用GNU工具集,例如,你也许需要一个统一的在 Windows和MacOS平台上都能工作的编译工具(一些工具确实能在Windows平台上工作,它们使用Cygnus的“Cygwin”环境,参看 http://sourceware.cygnus.com/cygwin)。
如果使用了autoconf和automake,除了编译应用程序,用户并不需要有这些工具。使用这些工具的目的是创建能在用户环境使用的、可移植的shell脚本和Makefile文件。Autoconf实际上是一个工具集,其中包含aclocal、autoheader和autoconf等可执行文件。这些工具生成一个可移植的shell脚本—configure,configure和软件包一起发布给用户。它探查编译系统,生成 Makefile文件和一个特殊的头文件config.h。由configure生成的文件能适应用户系统的特定环境。configure脚本从一个称为 Makefile.in的模板文件生成每个Makefile文件。
automake由一个手写的Makefile.am生成Makefile.in文件。Makefile.in文件随软件一同发布,当用户运行 configure时会自动生成Makefile。Libtool软件包是第三个重要的GNU工具,它的作用是确定共享库在特定平台上的特性。因为共享库在不同平台上可能会有所不同。
下面有一些Gnome软件包应该具有的特征:
一个README文件,介绍软件包。
一个INSTALL文件,解释怎样编译、安装软件包。
一个configure脚本,能使程序自动适应特定平台的特征(或者该平台所缺乏的特性)。configure可以带一个参数--prefix,指定要安装的软件包的位置。标准的make目标,比如clean等等。
一个COPYING文件,包含软件包的版权信息。
一个ChangeLog文件,记录了软件的变化。
打包文件,一般用gzip压缩,在名字中包含软件包的版本(例如foo-0.2.1.tar.gz)。它们应该解开到单个目录中,目录应该以软件包及其版本命名,比如foo-0.2.1。
国际化是由GNUgettext软件包提供的。将gettext软件包随应用程序提供给用户,这样用户没有gettext也能够实现国际化。
下面是创建Gtk+/Gnome应用程序源代码树框架的重要步骤:
1)创建一个顶级目录,用以容纳应用程序的所有组件,包括编译文件、文档以及翻译文件。
2)通常在顶级目录下创建一个src子目录,将所有的源代码放在该目录下,并与其他文件分开。
3)在顶级目录下,创建AUTHORS、NEWS、COPYING和README文件。还可以创建一个空的ChangeLog文件。
4)写一个configure.in文件;configure.in文件的主要作用是决定使用什么样的编译器、编译标志以及链接标志。configure.in还可以使用#define符号反映当前平台的特征;它把这些优先放在自动生成的config.h文件里。
5)写一个acconfig.h文件。它是config.h.in文件要使用的模板文件。这个文件应该撤销每个可能在config.h中定义了的符号以避免重复定义(一般在config.h中用#define定义,用#undef撤销定义)autoheader程序基于acconfig.h创建 config.h.in文件,autoconf程序创建config.h文件。autoheader是autoconf软件包中的实用程序。
6)创建一个空的stamp.h.in文件。在configure.in中的AM_CONFIG_HEADER宏会用到它。
7)在顶级目录下,写一个Makefile.am文件,在其中列出每个包含源代码的子目录;在每个子目录中也写一个Makefile.am文件。
8)运行gettext软件包中的gettextize程序。这样可以创建intl和po目录,这是软件国际化所需要的。在intl目录中包含 GNUgettext源代码。如果编译程序的用户没有gettext,它们可以在执行configure脚本时传一个--with-included- gettext参数,让configure在intl目录下自动编译一个gettext的静态版本。在po容纳了翻译文件后,gettextize也会创建一个称为po/Makefile.in.in的文件,用于编译翻译文件。
9)创建一个po/POTFILES.in文件,在其中列出应该扫描字符串以便翻译的源文件。最初的POTFILES.in文件可以是空的。
10)从其他的Gnome模块中复制一个autogen.sh文件和它的宏目录。必须根据自己的软件包的名称修改autogen.sh文件。运行autogen.sh文件将调用libtoolize、aclocal、autoheader、automake以及autoconf。
11)autogen.sh用--add-missing参数调用文件automake。这会添加一些文件,比如带有通用安装指导的 INSTALL文件。编辑INSTALL,在其中包含任何针对应用程序的安装指南。autogen.sh会在每个目录下创建一个Makefile。
2.11.2configure.in文件
autoconf处理configure.in文件,生成一个configure脚本。configure是一个可移植的shell脚本,它检查编译环境以决定哪些库可用,所用平台有什么特征,哪些库和头文件已经找到等等。基于这些信息,它修改编译标记,生成Makefile文件,并/或输出一个包含已定义的预处理符号的config.h文件。configure并不需要运行autoconf,所以在发布应用程序之前生成这个文件,这样,用户就不必有autoconf软件包。
眼前的任务就是写一个configure.in文件。文件基本上是一系列的m4宏,根据传递给它们的参数,这些宏扩展为shell脚本代码段。还可以手工书写shell代码。要真正理解怎样写configure.in文件要求有一些m4的知识以及一些 Bourneshell的知识。幸运的是,有省事的方法;可以找一个已有的configure.in文件,然后修改它以适应你的应用程序。还有一个很全面的autoconf手册,里面介绍了很多随autoconf发布的预先写好的宏。
Gtk+和Gnome的开发者已经进一步简化了这些工作,提供了一些宏用于在用户的系统中定位Gtk+和Gnome。
下面是一个简单的configure.in文件,来自于Gnome版的“Hello,World”:
AC_INIT(src/hello.c)
AM_CONFIG_HEADER(config.h)
AM_INIT_AUTOMAKE(GnomeHello,0.1)
AM_MAINTAINER_MODE
AM_ACLOCAL_INCLUDE(macros)
GNOME_INIT
AC_PROG_CC
AC_ISC_POSIX
AC_HEADER_STDC
AC_ARG_PROGRAM
AM_PROG_LIBTOOL
GNOME_COMPILE_WARNINGS
ALL_LINGUAS="deesfrnorusvfi"
AM_GNU_GETTEXT
AC_SUBST(CFLAGS)
AC_SUBST(CPPFLAGS)
AC_SUBST(LDFLAGS)
AC_OUTPUT([
Makefile
macros/Makefile
src/Makefile
intl/Makefile
po/Makefile.in
pixmaps/Makefile
doc/Makefile
doc/C/Makefile
doc/es/Makefile
])
上面以AC开头的宏来自autoconf,以AM开头的宏来自automake。要从autoconf或 automake中寻求帮助,这一点很有用。以GNOME开头的宏来自于Gnomemacros目录。这些宏都是用m4宏语言写的。如果将 autoconf和automake安装在/usr目录下,autoconf和automake中的标准宏一般放在/usr/share/aclocal 目录下。
AC_INIT总是configure.in中的第一个宏。它扩展为许多可由其他configure脚本共享的模板文件代码。这些代码解析传到 configure中的命令行参数。这个宏的一个参数是一个文件名,这个文件应该在源代码目录中,它用于健全性检查,以保证configure脚本已正确定位源文件目录。
AM_CONFIG_HEADER指定了要创建的头文件,差不多总是config.h。创建的头文件包含由configure定义的C预处理符号。最低限度应该定义PACKAGE和VERSION符号,这样可以将应用程序名称和版本传送到代码中,而无须对它们硬编码(非公用的源文件应该包含 config.h(#include<config.h>)以利用这些定义。然而,不要将config.h文件安装到系统中,因为它有可能与其他的软件包冲突)。
AM_INIT_AUTOMAKE初始化automake。传到这个宏里的参数是要编译的应用程序的名称和版本号(这些参数成为config.h中定义的PACKAGE和VERSION值)。
AM_MAINTAINER_MODE关闭缺省时仅供程序维护者使用的makefile目标,并修改以使configure能理解 --enable-maintainer-mode选项。--enable-maintainer-mode将maintaineronly目标重新打开。仅供维护者使用的makefile目标允许最终用户清除自动生成的文件,比如configure,这意味着要修复编译故障,必须安装有autoconf和automake软件。注意,因为autogen.sh脚本主要是给开发人员用的,autogen.sh会自动传递一个--enable- maintainer-mode选项给configure。
AM_ACLOCAL_INCLUDE指定一个附加的目录,用于搜索m4宏。在这里,它指定为macros子目录。在这个目录中应该有Gnome宏的拷贝。
GNOME_INIT给configure添加一个与Gnome相关的命令行参数个数,并为Gnome程序定义一些makefile变量,这些变量中包含了必要的预处理程序和链接程序标志。这些标志是由gnome-config脚本取得的。安装gnome-libs时会安装gnome- config脚本。
AC_PROG_CC定位C编译器。
AC_ISC_POSIX添加一些在某些平台上实现POSIX兼容需要的标志。
AC_HEADER_STDC检查当前平台上是否有标准的ANSI头文件,如果有,则定义STDC_HEADERS。
AC_ARG_PROGRAM添加一些选项到configure中,让用户能够修改安装程序的名称(如果在用户系统上碰巧有一个与要安装的程序名称相同的程序,这是很有用的)。
AM_PROG_LIBTOOL是由automake用来设置libtool的用途的。只在计划编译共享库或动态可加载模块时才需要设置这个值。
GNOME_COMPILE_WARNINGS给gcc命令行添加许多警告选项,但是在其他绝大多数的编译器上什么也不做。
ALL_LINGUAS=“es”不是一个宏,只是一句shell代码。它包含一个由空格分隔的语言种类缩写表,对应于po子目录下的.po文件。.po文件包含翻译成其他语言的文本,所以ALL_LINGUAS应该列出程序已经被翻译成的所有语言。
AM_GNU_GETTEXT由automake使用,但是这个宏会随gettext软件包发布。它让 automake执行一些与国际化相关的任务。
AC_SUBST输出一个变量到由configure生成的文件中。具体内容将在后面说明。
AC_OUTPUT列出由configure脚本创建的文件。这些文件都是由带.in后缀的同名文件生成的。例如,src/Makefile是由src/Makefile.in生成的,config.h是由config.h.in生成的。在执行AC_OUTPUT宏时,configure脚本处理包含有两个@符号标志的变量(例如@PACKAGE@)的文件。只有用AC_SUBST输出了变量,它才能识别这些变量(许多在上面讨论过的预先写好的宏都用AC_SUBST定义变量)。这些特征用于将一个Makefile.in文件转换成一个Makefile文件。典型情况下,Makefile.in 是由automake从Makefile.am生成的(不过,你可以只用autoconf,而不用automake,自己编写一个 Makefile.in)。 |