# Checks for libraries. # Checks for header files. AC_CHECK_HEADERS([fcntl.h]) # Checks for typedefs, structures, and compiler characteristics. AC_HEA

Transcription

1 用 automake /autoconf 来编译工程 Tianzhu Qiao Version: 0.16 Last updated: 02/21/13 参考文献 1. Martin Mann: HowTo Autotools - Distributing source code with autoconf and automake 2. GNU automake manual 前言 一直不想去碰 automake/autoconf, 感觉太复杂了 所以在 linux 一直用 anjuta/code::blocks 来帮助编译 直到最近需要给 bsmedit 产生 makefile, 才不得不硬着头皮去试 概述 1. 创建工程创建 myproject 项目, 项目的源文件在其下的 src 目录中 benben@benben-ubuntu:~/myproject$ ls src benben@benben-ubuntu:~/myproject$ cd src benben@benben-ubuntu:~/myproject/src$ ls main.h main.cpp 2. autoscan 产生 configure.scan 文件进入工程目录的根目录, 运行 autoscan benben@benben-ubuntu:~/myproject$ autoscan 这个命令会产生 configure.scan 文件, 这个文件是 configure.ac 的模板把 configure.scan 改名为 configure.ac 或者 configure.in 这个文件类似于 : # -*- Autoconf -*- # Process this file with autoconf to produce a configure script. AC_PREREQ([2.64]) AC_INIT([FULL-PACKAGE-NAME], [VERSION], [BUG-REPORT-ADDRESS]) AC_INIT_AUTOMAKE # Checks for programs. AC_PROG_CXX AC_PROG_CC AC_PROG_INSTALL AC_PROG_LN_S 1/10

2 # Checks for libraries. # Checks for header files. AC_CHECK_HEADERS([fcntl.h]) # Checks for typedefs, structures, and compiler characteristics. AC_HEADER_STDBOOL AC_C_INLINE AC_TYPE_SIZE_T # Checks for library functions. AC_CHECK_FUNCS([floor memset pow]) AC_CONFIG_FILES AC_OUTPUT 3. 修改 configure.ac 文件下面红色的部分是修改过的内容 # -*- Autoconf -*- # Process this file with autoconf to produce a configure script. AC_PREREQ([2.64]) AC_INIT([myproject], [1.0], [myproject@somewhere.com]) AC_INIT_AUTOMAKE # Checks for programs. AC_PROG_CXX AC_PROG_CC AC_PROG_INSTALL AC_PROG_LN_S # Checks for libraries. # Checks for header files. AC_CHECK_HEADERS([fcntl.h]) # Checks for typedefs, structures, and compiler characteristics. AC_HEADER_STDBOOL AC_C_INLINE AC_TYPE_SIZE_T # Checks for library functions. AC_CHECK_FUNCS([floor memset pow]) AC_CONFIG_FILES AC_OUTPUT(Makefile src/makefile) 4. 创建 Makefile.am 在 myproject 目录下创建 Makefile.am 2/10

3 # tell automake that we have a subdir src SUBDIRS=src 在 src 目录下创建 Makefile.am # create the executable binary bin_programs = myproject myproject_sources = \ main.cpp \ main.h 5. autoconf 回到 myproject 目录 benben@benben-ubuntu:~/myproject$ aclocal benben@benben-ubuntu:~/myproject$ autoconf benben@benben-ubuntu:~/myproject$ automake --add-missing 其中 aclocal: 产生 m4 文件 autoconf: 从刚才编辑的 configure.ac 文件产生 configure 文件 automake add-missing: 产生所有的其他文件 (INSTALL, COPYRIGHT, Makefile.in 等等 ) 如果在最后一步时提示有些文件找不到 ( 比如 NEWS,README,ChangeLog 等等 ), 则 touch 一下这些文件名, 创建相应的空文件 到目前位置, 如果没有提示出错, 则一切具备, 可以编译了创建用于编译的目录 benben@benben-ubuntu:~/myproject$ mkdir build benben@benben-ubuntu:~/myproject$ cd build benben@benben-ubuntu:~/myproject/build$../configure prefix=/home/benben/myproject/build 其中 prefix=/home/benben/myproject/build 选项用来指定安装的目录, 可以不指定, 则安装到默认目录 ( 比如 /usr/local/bin) 最后编译 benben@benben-ubuntu:~/myproject/build$ make 安装 benben@benben-ubuntu:~/myproject/build$ make install 到这里你就可以运行你的程序了, 如果没有错误的话 发布 benben@benben-ubuntu:~/myproject/build$ make dist Debug/Release 版本 到现在为止, 编译使用的是默认的选项, 我们要为它添加 debug/release 版本编译支持 编辑 configure.ac 文件, 在其中添加 # debug option 3/10

4 AC_MSG_CHECKING([whether to build with debug information]) # add the option AC_ARG_ENABLE([debug], [AS_HELP_STRING([--enable-debug], [turn on debug(default=no)])], [debugit=yes], [debugit=no]) AC_MSG_RESULT([$debugit]) if test x"$debugit" = x"yes"; then AC_DEFINE([DEBUG],[],[Debug Mode]) #add the debug CXXFLAGS AM_CXXFLAGS="$AM_CXXFLAGS -g3 -D_DEBUG=1" else AC_DEFINE([NDEBUG],[],[No-debug Mode]) # add the release CXXFLAGS AM_CXXFLAGS="$AM_CXXFLAGS -O2 -s" fi AC_SUBST([AM_CXXFLAGS]) 上面修改了 AM_CXXFLAGS 变量, 这个变量会在生成 makefile 的时候加入到 c++ 编译器的编译选项里面 当然也可以直接修改 CXXFLAGS 变量 重新执行一下上面的 3autoconf 如果运行 benben@benben-ubuntu:~/myproject/build$../configure prefix=/home/benben/myproject/build enable-debug 那么就会生成用于编译 debug 版本的 makefile 值得注意的是如果你某个 Makefile.am 文件定义了自己的 CXXFLAGS, 那么 AM_CXXFLAGS 会被忽略 # create the executable binary bin_programs = myproject myproject_sources = \ main.cpp \ main.h # if you define this line, the AM_CXXFLAGS will be ingored in this makefile myproject_cxxflags = -g -O2 如果你仔细观察编译时的输出, 你会发现, 无论是 debug 还是 release 编译, 编译选项中总是有 -g -O2 选项 这个选项是由 configure.ac 中的 AC_PROG_CXX 带来的,google 一下这个选项, 可以看到 AC_PROG_CXX ([compiler-search-list]) Determine a C++ compiler to use. Check whether the environment variable CXX or CCC (in that 4/10

5 order) is set; if so, then set output variable CXX to its value. If using the GNU C++ compiler, set shell variable GXX to yes. If output variable CXXFLAGS was not already set, set it to -g -O2 for the GNU C++ compiler (-O2 on systems where G++ does not accept -g), or -g for other compilers. 所以要在 configure.ac 中处理一下, 去掉这个默认的选项 # store current user givern compiler flags to avoid default setup via AC_PROG_CXX OLD_CXXFLAGS=$CXXFLAGS OLD_CFLAGS=$CFLAGS # Checks for programs. AC_PROG_CXX AC_PROG_CC # reset compiler flagsto initial flags CXXFLAGS=$OLD_CXXFLAGS CFLAGS=$OLD_CFLAGS 静态库 上面的 makefile 用于产生可执行文件, 如果你的项目要产生一个静态库, 或者项目比较大由许多中间的 静态库编译而成, 那需要如下处理 修改 configure.ac, 加入 AC_PROG_RANLIB # Checks for programs. AC_PROG_CXX AC_PROG_CC AC_PROG_INSTALL AC_PROG_LN_S AC_PROG_RANLIB 这个 macro 用来检测 ranlib 是否存在 编写库的 Makefile.am # this is a library noinst_libraries = libmyprojectlib.a libmyprojectlib_a_sources= \ myprojectlib.h\ myprojectlib.cpp 静态库使用 比如你的可执行程序用到上面的 libmyprojectlib.a 5/10

6 假设程序目录如下 ( 结构太差 ) benben@benben-ubuntu:~/myproject$ ls src benben@benben-ubuntu:~/myproject$ cd src benben@benben-ubuntu:~/myproject/src$ ls main.h main.cpp benben@benben-ubuntu:~/myproject/src$ cd myprojectlib benben@benben-ubuntu:~/myproject/src/myprojectlib$ ls myprojectlib.h myprojectlib.cpp 主程序的 Makefile.am 类似于 # create the executable binary bin_programs = myproject myproject_sources = \ main.cpp \ main.h # the library myproject_ldadd = $(top_builddir)/src/myprojectlib/libmyprojectlib.a # the include directory INCLUDES=-I$(top_srcdir)/src/myprojectlib 动态库 修改 configure.ac, 加入 AC_PROG_LIBTOOL # Checks for programs. AC_PROG_CXX AC_PROG_CC AC_PROG_INSTALL AC_PROG_LN_S AC_PROG_RANLIB AC_PROG_LIBTOOL 这个 macro 用来加入 --enable-shared 和 --disable-shared 选项, 详细的解释看 gun 的文档 编写库的 Makefile.am #this is a shared library lib_ltlibraries = libmyprojectplugin.la libmyprojectplugin_la_sources = \ myprojectplugin.cpp \ myprojectplugin.h 6/10

7 动态库使用 ( 静态加载 ) 比如你的可执行程序用到上面的 libmyprojectplugin.a 假设程序目录如下 benben@benben-ubuntu:~/myproject$ ls src benben@benben-ubuntu:~/myproject$ cd src benben@benben-ubuntu:~/myproject/src$ ls main.h main.cpp benben@benben-ubuntu:~/myproject/src$ cd myprojectplugin benben@benben-ubuntu:~/myproject/src/myprojectplugin$ ls myprojectplugin.h myprojectplugin.cpp 修改 configure.ac, 加入 AM_LDFLAGS AC_SUBST([AM_LDFLAGS]) 主程序的 Makefile.am 类似于 # create the executable binary bin_programs = myproject myproject_sources = \ main.cpp \ main.h AM_LDFLAGS=@AM_LDFLAGS@ \ $(top_builddir)/src/myprojectplugin LIBS=@LIBS@ \ -lmyprojectplugin INCLUDES=-I$(top_srcdir)/src/myprojectplugin 安装目录 bsmedit 中的 plugin(shared library) 需要安装在其他目录下 ( 比如 bsmedit 安装在 /usr/bin, 而 plugin 安装在 /usr/share/bsmedit/plugins 目录下 ) 对应的 Makefile.am # set the install directory for this share library libdir = $(pkgdatadir)/plugins lib_ltlibraries = libmyprojectplugin.la wxwidgets 库 WxWidgets 是跨平台 GUI 库, 如果你的程序是 wxwidgets 程序, 需要在 configure.ac 中加入对 wxwidgets 的支持 ( 当然首先必须安装好 wxwidgets) 7/10

8 在 configure.ac 中添加 : # Checks for libraries. # wx widgets AM_OPTIONS_WXCONFIG reqwx= AM_PATH_WXCONFIG($reqwx, wxwin=1) if test "$wxwin"!= 1; then AC_MSG_ERROR([wxWidgets must be installed on your system. fi Please check that wx-config is in path, the directory where wxwidgets libraries are installed (returned by 'wx-config --libs' or 'wx-config --static --libs' command) is in LD_LIBRARY_PATH or equivalent variable and wxwidgets version is $reqwx or above. ]) CPPFLAGS="$CPPFLAGS $WX_CPPFLAGS" CXXFLAGS="$CXXFLAGS $WX_CXXFLAGS_ONLY" CFLAGS="$CFLAGS $WX_CFLAGS_ONLY" LIBS="$LIBS $WX_LIBS" 这些宏会检测 wxwidgets 的版本, 并且配置相应的参数 如果你在 autoconf 的时候报告说找不到 AM_OPTIONS_WXCONFIG /AM_PATH_WXCONFIG 等宏, 那么你需要从 wxwidgets 的源代码包里面拷贝 wxwin.m4 文件到你的工程目录下, 并且在 configure.ac 的最前面添加 # -*- Autoconf -*- # Process this file with autoconf to produce a configure script. m4_include(wxwin.m4) AC_PREREQ([2.64]) AC_INIT([FULL-PACKAGE-NAME], [VERSION], [BUG-REPORT-ADDRESS]) AC_CONFIG_SRCDIR(src/main.cpp) 现在, 你的程序就可以使用 wxwidgets 了, 而不会告诉你 wx/wx.h 找不到了 Python 库 应为 bsmedit 中有个 plugin 用到了 python 库, 所以我在 configure.ac 中添加了 Python 的检测 #python python_on=0 AM_PATH_PYTHON(2.6,python_on=1) if test "$python_on" = 1; then AC_MSG_CHECKING([$PYTHON include dir]) if $PYTHON -c 'import distutils.sysconfig' 2>/dev/null; then #python headers 8/10

9 PYTHON_INC=`$PYTHON -c 'import os, distutils.sysconfig; print(distutils.sysconfig.get_python_inc().replace(os.sep,"/"))'` AC_SUBST(PYTHON_INC) else AC_MSG_WARN([Couldn't import python module distutils.sysconfig - you probably don't have a python-dev or python-devel package installed]) fi AC_MSG_RESULT([$PYTHON_INC]) fi AM_CONDITIONAL([HAVE_PYTHON_DEVEL],[test -f $PYTHON_INC/Python.h]) 如果你的程序中用到了 python 库, 你的 Makefile.am 类似于 #foowin Makefile.am # add the include directory INCLUDES= -I$(PYTHON_INC) 上层的 Makefile.am, 当检测不到 python 库时不编译这个程序 #if python is not available, not build the sublibwithpython if HAVE_PYTHON_DEVEL sublibwithpython_dir=sublibwithpython endif SUBDIRS = myprojectlib\ $(sublibwithpython_dir) 发布文件 有时候你需要发布一些额外的文件, 比如你的程序是跨平台的, 你想提供 vc 编译的工程文件, 这时你需要用 EXTRA_DIST 来指定这些额外的文件需要被包含在你的 package 中 # create the executable binary bin_programs = myproject myproject_sources = \ main.cpp \ main.h EXTRA_DIST = \ myproject.vcproj Notes 1) mv: cannot stat `.Tpo': No such file or directory 9/10

10 运行如下命令 ( 在 autoconf 之前 ) benben@benben-ubuntu:libtoolize -f 2) 制作 Debian package a. 进到 build 目录下 b. 运行下面的命令, 根据屏幕上的指示执行对应操作 benben@benben-ubuntu:~/myproject/build:checkinstall -D make install 10/10