系列文章：
automake學習筆記 - helloworld
automake學習筆記 - 模塊化編譯
automake學習筆記 - 安裝與發布
automake學習筆記 - 交叉編譯
雖然之前已經用過一段時間的automake,但是總覺得對它的理解不過充分,只是知其然而不知其所以然。于是下定決心好好啃文檔,并將學的的東西記錄下來。
這篇文章用一個簡單的log工具的編譯先對automake做一個hello world級別的介紹。
代碼
我們的demo有6個文件cout_log_interface.h, cout_log_interface.cpp, log_interface.h, easy_log.h, easy_log.cpp, main.cpp
簡單介紹下代碼吧,首先有個簡單的Log類:
class EasyLog {
public:
EasyLog(std::shared_ptr<LogInterface> interface);
void Info(const std::string& tag, const std::string& log);
void Debug(const std::string& tag, const std::string& log);
void Warn(const std::string& tag, const std::string& log);
void Error(const std::string& tag, const std::string& log);
private:
std::string GetLog(const std::string& tag, const std::string& log) const;
std::shared_ptr<LogInterface> interface_;
};
它的實現十分簡單，就是將所有的操作代理給LogInterface:
EasyLog::EasyLog(shared_ptr<LogInterface> interface)
: interface_(interface)
{
}
void EasyLog::Info(const string& tag, const string& log)
{
interface_->DoLog(kInfo, tag, GetLog(tag, log));
}
void EasyLog::Debug(const string& tag, const string& log)
{
interface_->DoLog(kDebug, tag, GetLog(tag, log));
}
void EasyLog::Warn(const string& tag, const string& log)
{
interface_->DoLog(kWarn, tag, GetLog(tag, log));
}
void EasyLog::Error(const string& tag, const string& log)
{
interface_->DoLog(kError, tag, GetLog(tag, log));
}
std::string EasyLog::GetLog(const string& tag, const string& log) const
{
return "[" + tag + "]" + " " + log;
}
LogInterface是一個純虛類，然后LogLevel是一個枚舉體:
enum LogLevel {
kInfo,
kDebug,
kWarn,
kError
};
class LogInterface {
public:
virtual void DoLog(LogLevel level, const std::string& tag, const std::string& log) = 0;
};
我們再寫一個使用標準輸出打印log的LogInterface:
class COutLogInterface : public LogInterface {
public:
virtual void DoLog(LogLevel level, const std::string& tag, const std::string& log);
};
它的實現就是使用cout打印log:
void COutLogInterface::DoLog(LogLevel level, const string& tag, const string& log) {
cout<<log<<endl;
}
當然需要有個main函數:
int main()
{
EasyLog log(std::make_shared<COutLogInterface>());
log.Debug("test", "testlog");
return 0;
}
Makefile.am
automake使用Makefile.am配置工程的源碼,它的內容如下:
bin_PROGRAMS = easylog
easylog_SOURCES = cout_log_interface.cpp \
easy_log.cpp \
main.cpp
bin_PROGRAMS 指定了要編譯生成的目標程序的名字,在這里我們最終編譯出來的目標程序的文件名是easylog
之后的 easylog_SOURCES 指定了需要參與編譯的源代碼。
如果需要同時編譯多個目標程序的話可以用下面的方式分別指定各個目標程序的源代碼
bin_PROGRAMS = program_a program_b
program_a_SOURCES = code_a.cpp
program_b_SOURCES = code_b.cpp
configure.ac
指定了源代碼還不夠，因為automake不僅僅可以用來生成編譯c/c++的makefile，還可以用來編譯生成其他許許多多語言的makefile，所以還需要指定編譯器和依賴文件等。automake使用configure.ac配置這些東西,本例子的configure.ac是這么寫的:
AC_INIT([easylog], [0.0.1], [466474482@qq.com])
AM_INIT_AUTOMAKE([-Wall -Werror foreign])
AC_CONFIG_HEADERS([config.h])
AC_PROG_CXX
AX_CXX_COMPILE_STDCXX_11
AC_CONFIG_FILES([Makefile])
AC_OUTPUT
簡單分析一下configure.ac的內容:
- AC_INIT
指定了工程的名字、版本號、和bug的報告郵箱
- AM_INIT_AUTOMAKE
指定了一些選項,-Wall和-Werror指定編譯的時候將所有的warning當做error來報錯, foreign告訴automake這里不用遵循GNU標準。GNU軟件包應該包括一些附加文件去描述如修改項，作者等信息。在這里我們不需要automake去檢查這些附加文件的存在。
- AC_CONFIG_HEADERS
我們在AC_INIT中配置了版本號等信息,c/c++中一般需要用宏來定義它們,這里就指定了生成的配置宏的頭文件名。配置了這里,automake就會自動幫我們生成config.h頭文件,里面定義了一些VERSION之類的宏
- AC_PROG_CXX
該宏用于檢查系統中是否有g++編譯器
- AX_CXX_COMPILE_STDCXX_11
檢查系統的c++11編譯支持
- AC_CONFIG_FILES
指定了需要configure生成的Makefile,autoreconf的時候會通過Makefile.am生成Makefile.in。而configure的時候會通過Makefile.in生成Makefile。因為Makefile.am和configure.ac在同級目錄,所以直接寫Makefile就好了。在后面我會介紹當Makefile.am和configure.ac不在同級目錄的時候需要怎么配置
- AC_OUTPUT
這是一個結束標志,實際上它是一個腳本命令用來創建AC_CONFIG_HEADERS和AC_CONFIG_FILES所配置的文件
生成Makefile
首先要安裝autoconf
sudo apt-get install autoconf
然后使用下面的命令生成configure
autoreconf --install
除了configure之外，它還會生成一些其他的文件，當然現在我們不需要去管這些文件
之后就能使用configure腳本去生成Makefile和config.h等
./configure
編譯工程
Makefile都已經生成了，現在就可以使用make命令編譯工程啦
編譯成功之后就能在當前目錄看到easylog程序。我們可以運行它:
./easylog
得到下面輸出:
[test] testlog
在build目錄中編譯項目
現在我們編譯生成的.o文件和目標程序都混在源代碼中間,看起來很不舒服。我們可以創建一個build目錄。然后進入build目錄執行下面命令
../configure
這樣就在build目錄下生成Makefile了,于是現在我們在build中使用make命令編輯工程就會發現編譯產生的.o文件和目標文件都在build中而不會污染源代碼了。
使用autoscan生成configure.ac
如果直接手寫configure.ac的話是比較困難的,很容易漏掉一些依賴項沒有檢查。所以就出現了autoscan這個工具,它可以幫我們檢查工程中的依賴項生成configure.ac的模板,然后我們只需要在它生成的模板上略加改動就可以了。
我們在工程目錄下使用autoscan命令,會得到下面的兩個文件:
autoscan.log
configure.scan
autoscan.log是一個日志文件,通過它我們可以知道一些配置為什么會被需要
而configure.scan就是生成出來的configure.ac的模板了,在easylog工程目錄使用autoscan,生成的configure.scan內容如下
# -*- Autoconf -*-
# Process this file with autoconf to produce a configure script.
AC_PREREQ([2.69])
AC_INIT([FULL-PACKAGE-NAME], [VERSION], [BUG-REPORT-ADDRESS])
AC_CONFIG_SRCDIR([log_interface.h])
AC_CONFIG_HEADERS([config.h])
# Checks for programs.
AC_PROG_CXX
AC_PROG_CC
# Checks for libraries.
# Checks for header files.
# Checks for typedefs, structures, and compiler characteristics.
# Checks for library functions.
AC_CONFIG_FILES([Makefile])
AC_OUTPUT
看是不是和我們之前手寫的很像?我們只有在上面進行一些小的修改就能得到最終我們需要的configure.ac了
這里有兩個宏我們是沒有見過的
- AC_PREREQ
用于檢查autoconf的最低版本
- AC_CONFIG_SRCDIR
用一個項目中一定存在的文件去確定源碼目錄的有效性,這是一個安全檢查宏。configure有一個--srcdir的參數可以指定源碼目錄,這個宏就可以檢查出源碼目錄是否不小心配置錯了
Demo項目
可以在這里查看完整的項目代碼
