automake学习笔记 - 模块化编译

系列文章:
automake学习笔记 - helloworld
automake学习笔记 - 模块化编译
automake学习笔记 - 安装与发布
automake学习笔记 - 交叉编译

一般来说一个工程会由许多不同的模块组成。源码放在一个地方,示例代码放到另一个地方,第三方库又放到其他地方。这种时候又应该怎么去使用automake呢?

这篇文章就讨论了一下如何使用automake去进行模块化编译

我们还是用easylog来做例子,下面是我们修改后的easylog工程的根目录下的文件:

configure.ac examples Makefile.am src

src目录

src目录放的就是库的源代码,我们使用src中的源代码编译出一个库来给其他的程序使用easylog的功能

src目录中有下面几个文件log_interface.h,easy_log.h,easy_log.cpp,cout_log_interface.h,cout_log_interface.cpp,Makefile.am。实际上就是除了main.cpp,其他文件都放到了这里来。因为我们提供给别的是一个库而不是一个可执行程序,所以main.cpp可以不需要编译到目标文件中

.h和.cpp的内容和上一篇文章的内容是一样的。这里的重点其实是Makefile.am。让我们先来看看它的内容:

lib_LTLIBRARIES = libeasylog.la                                                             
libeasylog_la_SOURCES = cout_log_interface.cpp \                                            
                     easy_log.cpp

其实它的内容很简单,就是指定了要编译的库的名字和库的源码。但是有一个问题,我们这里需要编译的是但为什么这里的目标文件是libeasylog.la呢?

Libtool是一种属于GNU构建系统的GNU程序设计工具,它将静态库和动态库抽象成了一种统一的叫做libtool库的概念。libtool库使用la作为后缀。它可以用来构建静态库也能用来构建动态库,而最终编译出来的到底是哪一种,在最后执行configure命令的时候才能确定。同时它编译的时候产生的文件就不再是.o文件而是.lo文件。

这里lib_LTLIBRARIES的lib前缀表示的就是目标文件是一个动态库而不是可执行文件(bin前缀表示目标文件是可执行文件,noinst_LTLIBRARIES表示目标文件是静态库)。而LTLIBRARIES的LT指的就是Libtool。还有一点是一般编译库文件的话我们会在文件名钱加上lib前缀,所以我们的目标文件是libeasylog.la。

而下面的libeasylog_la_SOURCES就是指定编译libeasylog.la使用的源代码

这里顺便说一点,如果这里需要链接其他的库的话需要用 _LIBADD 去指定。如需要链接libpthread这个库的话就需要这样写:

libeasylog_la_LIBADD = -lpthread

examples目录

examples目录里面放了这个库的example代码。因为我们的库是要提供给其他人使用的,所以一般除了文档之外,还会有一些例子去帮助使用者了解应该如何去使用我们的库。这个目录中的example.cpp其实就是上一篇文章中的main.cpp:

#include "easy_log.h"
#include "cout_log_interface.h"


int main()
{
    EasyLog log(std::make_shared<COutLogInterface>());
    log.Debug("test", "testlog");

    return 0;
}

这个目录下也有一个Makefile.am,它是用来配置example程序的编译选项的:

AM_CPPFLAGS = -I$(top_srcdir)/src

bin_PROGRAMS = example
example_SOURCES = example.cpp

example_LDADD = -L$(top_builddir)/src \
                -leasylog

AM_CPPFLAGS的值在c/c++预处理的时候会当做参数传给预处理器例如我们将源码目录传给预处理器,这样预处理器才能找到easy_log.h和cout_log_interface.h

这里的top_srcdir变量会在configure是被定义,它的值是工程目录的位置(也就是configure所在目录的位置),后面的top_builddir也是类似的,不过它的值是编译目录的位置(也就是执行make命令是所在的目录)

这里编译出来的example就是我们的demo程序

根目录

根目录下也有个Makefile.am,这个文件的内容很简单:

SUBDIRS = src examples

就是将src和examples指定为子目录于是在make编译的时候,编译器就会进入到这两个目录中继续编译。它们在这里的先后顺序决定了编译的先后顺序。因为examples中的example程序是依赖于easylog库的,所以要然src先编译

如果不在这里指定子目录的话,在编译目录执行make命令就不会自动编译子目录中为源码,需要自己进到子目录中手动执行make命令。如果工程中的某些部分是可选编译的时候可以这么做。

最后就是configure.ac文件了:

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

AC_PREREQ([2.69])
AC_INIT([easylog], [0.0.2], [466474482@qq.com])
AM_INIT_AUTOMAKE([-Wall -Werror foreign])
AC_CONFIG_SRCDIR([src/log_interface.h])
AC_CONFIG_HEADERS([config.h])

AM_PROG_AR
LT_INIT

# Checks for programs.
AC_PROG_CXX
AC_PROG_CC
AX_CXX_COMPILE_STDCXX_11

# Checks for libraries.

# Checks for header files.

# Checks for typedefs, structures, and compiler characteristics.

# Checks for library functions.

AC_CONFIG_FILES([Makefile
                 examples/Makefile
                 src/Makefile])

AC_OUTPUT

它和上一篇文章只有一点点小的不同:

一是由于将log_interface.h放到src中了,所以AC_CONFIG_SRCDIR需要改一下

AC_CONFIG_SRCDIR([src/log_interface.h])

二是examples和src中的Makefile.am也需要在configure.ac中指定:

AC_CONFIG_FILES([Makefile
                 examples/Makefile
                 src/Makefile])

AC_CONFIG_FILES指定了一些需要从Makefile.in中生成的Makefile。这里如果不指定的话configure就不会为其生成Makefile

三是多了AM_PROG_AR和LT_INIT。如果不定义这两个宏的话,执行autoreconf --install命令得到了下面的错误日志:

src/Makefile.am:1: error: Libtool library used but 'LIBTOOL' is undefined
src/Makefile.am:1:   The usual way to define 'LIBTOOL' is to add 'LT_INIT'
src/Makefile.am:1:   to 'configure.ac' and run 'aclocal' and 'autoconf' again.
src/Makefile.am:1:   If 'LT_INIT' is in 'configure.ac', make sure
src/Makefile.am:1:   its definition is in aclocal's search path.
automake: warnings are treated as errors
/usr/share/automake-1.15/am/ltlibrary.am: warning: 'libeasylog.la': linking libtool libraries using a non-POSIX
/usr/share/automake-1.15/am/ltlibrary.am: archiver requires 'AM_PROG_AR' in 'configure.ac'
src/Makefile.am:1:   while processing Libtool library 'libeasylog.la'
autoreconf: automake failed with exit status: 1

注意AM_PROG_AR 要放在 LT_INIT 之前,要不然 autoreconf --install 的时候会报warn

如果已经加上了 LT_INIT 但还是会报错的话就是系统中没有安装libtool了,必须先安装一下:

sudo apt-get install libtool

编译工程

  1. 在工程根目录创建子build目录用于编译

  2. 进入build目录

  3. 执行../configure

  4. 执行make

之后进入build/examples运行example就可以看到下面输出:

[test] testlog

静态库和动态库的区别

我们之前在src/Makefile.am中生成的是动态库lib_LTLIBRARIES,所以如果将build/src目录删掉,build/examples/example就会因为找不到库而报错:

/home/linjw/workspace/automake-demo/build/examples/.libs/lt-example: error while loading shared libraries: libeasylog.so.0: cannot open shared object file: No such file or directory

但如果将Makefile.am改成生成静态库则不会报错,因为静态库将库的代码也编译到可执行程序之中了。

noinst_LTLIBRARIES = libeasylog.la                                               
libeasylog_la_SOURCES = cout_log_interface.cpp \                                    
                     easy_log.cpp

这里的noinst代表的其实是no install的意思

Demo项目

可以在这里查看完整的项目代码

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,547评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,399评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,428评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,599评论 1 274
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,612评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,577评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,941评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,603评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,852评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,605评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,693评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,375评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,955评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,936评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,172评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,970评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,414评论 2 342

推荐阅读更多精彩内容