|
C/C++ 通用 Makefile
Generic Makefile for C/C++ Program
==================================================
Keywords: Makefile, make, Generic, C/C++
Author: whyglinux (whyglinux AT hotmail DOT com)
Date: 2006-03-04
==================================================
本文提供了一個(gè)用于對(duì) C/C++ 程序進(jìn)行編譯和連接以產(chǎn)生可執(zhí)行程序的通用 Makefile。
在使用 Makefile 之前，只需對(duì)它進(jìn)行一些簡(jiǎn)單的設(shè)置即可；而且一經(jīng)設(shè)置，即使以后對(duì)源程序文件有所增減一般也不再需要改動(dòng) Makefile。因此，即便是一個(gè)沒(méi)有學(xué)習(xí)過(guò) Makefile 書(shū)寫(xiě)規(guī)則的人，也可以為自己的 C/C++ 程序快速建立一個(gè)可工作的 Makefile。
這個(gè) Makefile 可以在 GNU Make 和 GCC 編譯器下正常工作。但是不能保證對(duì)于其它版本的 Make 和編譯器也能正常工作。
如果你發(fā)現(xiàn)了本文中的錯(cuò)誤，或者對(duì)本文有什么感想或建議，可通過(guò) whyglinux AT hotmail DOT com 郵箱和作者聯(lián)系。 |
|
此 Makefile 的使用方法如下：
* 程序目錄的組織
盡量將自己的源程序集中在一個(gè)目錄中，并且把 Makefile 和源程序放在一起，這樣用起來(lái)比較方便。當(dāng)然，也可以將源程序分類存放在不同的目錄中。
在程序目錄中創(chuàng)建一個(gè)名為 Makefile 的文本文件，將后面列出的 Makefile 的內(nèi)容復(fù)制到這個(gè)文件中。（注意：在復(fù)制的過(guò)程中，Makfile 中各命令前面的 Tab 字符有可能被轉(zhuǎn)換成若干個(gè)空格。這種情況下需要把 Makefile 命令前面的這些空格替換為一個(gè) Tab。）
將當(dāng)前工作目錄切換到 Makefile 所在的目錄。目前，這個(gè) Makefile 只支持在當(dāng)前目錄中的調(diào)用，不支持當(dāng)前目錄和 Makefile 所在的路徑不是同一目錄的情況。
* 指定可執(zhí)行文件
程序編譯和連接成功后產(chǎn)生的可執(zhí)行文件在 Makefile 中的 PROGRAM 變量中設(shè)定。這一項(xiàng)不能為空。為自己程序的可執(zhí)行文件起一個(gè)有意義的名子吧。
* 指定源程序
要編譯的源程序由其所在的路徑和文件的擴(kuò)展名兩項(xiàng)來(lái)確定。由于頭文件是通過(guò)包含來(lái)使用的，所以在這里說(shuō)的源程序不應(yīng)包含頭文件。
程序所在的路徑在 SRCDIRS 中設(shè)定。如果源程序分布在不同的目錄中，那么需要在 SRCDIRS 中一一指定，并且路徑名之間用空格分隔。
在 SRCEXTS 中指定程序中使用的文件類型。C/C++ 程序的擴(kuò)展名一般有比較固定的幾種形式：.c、.C、.cc、.cpp、.CPP、.c++、.cp、或者.cxx（參見(jiàn) man gcc）。擴(kuò)展名決定了程序是 C 還是 C++ 程序：.c 是 C 程序，其它擴(kuò)展名表示 C++ 程序。一般固定使用其中的一種擴(kuò)展名即可。但是也有可能需要使用多種擴(kuò)展名，這可以在 SOURCE_EXT 中一一指定，各個(gè)擴(kuò)展名之間用空格分隔。
雖然并不常用，但是 C 程序也可以被作為 C++ 程序編譯。這可以通過(guò)在 Makefile 中設(shè)置 CC = $(CXX) 和 CFLAGS = $(CXXFLAGS) 兩項(xiàng)即可實(shí)現(xiàn)。
這個(gè) Makefile 支持 C、C++ 以及 C/C++ 混合三種編譯方式：
o 如果只指定 .c 擴(kuò)展名，那么這是一個(gè) C 程序，用 $(CC) 表示的編譯命令進(jìn)行編譯和連接。
o 如果指定的是除 .c 之外的其它擴(kuò)展名（如 .cc、.cpp、.cxx 等），那么這是一個(gè) C++ 程序，用 $(CXX) 進(jìn)行編譯和連接。
o 如果既指定了 .c，又指定了其它 C++ 擴(kuò)展名，那么這是 C/C++ 混合程序，將用 $(CC) 編譯其中的 C 程序，用 $(CXX) 編譯其中的 C++ 程序，最后再用 $(CXX) 連接程序。
這些工作都是 make 根據(jù)在 Makefile 中提供的程序文件類型（擴(kuò)展名）自動(dòng)判斷進(jìn)行的，不需要用戶干預(yù)。
*
* 指定編譯選項(xiàng)
編譯選項(xiàng)由三部分組成：預(yù)處理選項(xiàng)、編譯選項(xiàng)以及連接選項(xiàng)，分別由 CPPFLAGS、CFLAGS與CXXFLAGS、LDFLAGS 指定。
CPPFLAGS 選項(xiàng)可參考 C 預(yù)處理命令 cpp 的說(shuō)明，但是注意不能包含 -M 以及和 -M 有關(guān)的選項(xiàng)。如果是 C/C++ 混合編程，也可以在這里設(shè)置 C/C++ 的一些共同的編譯選項(xiàng)。
CFLAGS 和 CXXFLAGS 兩個(gè)變量通常用來(lái)指定編譯選項(xiàng)。前者僅僅用于指定 C 程序的編譯選項(xiàng)，后者僅僅用于指定 C++ 程序的編譯選項(xiàng)。其實(shí)也可以在兩個(gè)變量中指定一些預(yù)處理選項(xiàng)（即一些本來(lái)應(yīng)該放在 CPPFLAGS 中的選項(xiàng)），和 CPPFLAGS 并沒(méi)有明確的界限。
連接選項(xiàng)在 LDFLAGS 中指定。如果只使用 C/C++ 標(biāo)準(zhǔn)庫(kù)，一般沒(méi)有必要設(shè)置。如果使用了非標(biāo)準(zhǔn)庫(kù)，應(yīng)該在這里指定連接需要的選項(xiàng)，如庫(kù)所在的路徑、庫(kù)名以及其它聯(lián)接選項(xiàng)。
現(xiàn)在的庫(kù)一般都提供了一個(gè)相應(yīng)的 .pc 文件來(lái)記錄使用庫(kù)所需要的預(yù)編譯選項(xiàng)、編譯選項(xiàng)和連接選項(xiàng)等信息，通過(guò) pkg-config 可以動(dòng)態(tài)提取這些選項(xiàng)。與由用戶顯式指定各個(gè)選項(xiàng)相比，使用 pkg-config 來(lái)訪問(wèn)庫(kù)提供的選項(xiàng)更方便、更具通用性。在后面可以看到一個(gè) GTK+ 程序的例子，其編譯和連接選項(xiàng)的指定就是用 pkg-config 實(shí)現(xiàn)的。
* 編譯和連接
上面的各項(xiàng)設(shè)置好之后保存 Makefile 文件。執(zhí)行 make 命令，程序就開(kāi)始編譯了。
命令 make 會(huì)根據(jù) Makefile 中設(shè)置好的路徑和文件類型搜索源程序文件，然后根據(jù)文件的類型調(diào)用相應(yīng)的編譯命令、使用相應(yīng)的編譯選項(xiàng)對(duì)程序進(jìn)行編譯。
編譯成功之后程序的連接會(huì)自動(dòng)進(jìn)行。如果沒(méi)有錯(cuò)誤的話最終會(huì)產(chǎn)生程序的可執(zhí)行文件。
注意：在對(duì)程序編譯之后，會(huì)產(chǎn)生和源程序文件一一對(duì)應(yīng)的 .d 文件。這是表示依賴關(guān)系的文件，通過(guò)它們 make 決定在源程序文件變動(dòng)之后要進(jìn)行哪些更新。為每一個(gè)源程序文件建立相應(yīng)的 .d 文件這也是 GNU Make 推薦的方式。
* Makefile 目標(biāo)（Targets）
下面是關(guān)于這個(gè) Makefile 提供的目標(biāo)以及它所完成的功能：
o make
編譯和連接程序。相當(dāng)于 make all。
o make objs
僅僅編譯程序產(chǎn)生 .o 目標(biāo)文件，不進(jìn)行連接（一般很少單獨(dú)使用）。
o make clean
刪除編譯產(chǎn)生的目標(biāo)文件和依賴文件。
o make cleanall
刪除目標(biāo)文件、依賴文件以及可執(zhí)行文件。
o make rebuild
重新編譯和連接程序。相當(dāng)于 make clean && make all。
關(guān)于這個(gè) Makefile 的實(shí)現(xiàn)原理不準(zhǔn)備詳細(xì)解釋了。如果有興趣的話，可參考文末列出的“參考資料”。
Makefile 的內(nèi)容如下：
###############################################################################
#
# Generic Makefile for C/C++ Program
#
# Author: whyglinux (whyglinux AT hotmail DOT com)
# Date: 2006/03/04
# Description:
# The makefile searches in <SRCDIRS> directories for the source files
# with extensions specified in <SOURCE_EXT>, then compiles the sources
# and finally produces the <ROGRAM>, the executable file, by linking
# the objectives.
# Usage:
# $ make compile and link the program.
# $ make objs compile only (no linking. Rarely used).
# $ make clean clean the objectives and dependencies.
# $ make cleanall clean the objectives, dependencies and executable.
# $ make rebuild rebuild the program. The same as make clean && make all.
#==============================================================================
## Customizing Section: adjust the following if necessary.
##=============================================================================
# The executable file name.
# It must be specified.
# PROGRAM := a.out # the executable name
PROGRAM :=
# The directories in which source files reside.
# At least one path should be specified.
# SRCDIRS := . # current directory
SRCDIRS :=
# The source file types (headers excluded).
# At least one type should be specified.
# The valid suffixes are among of .c, .C, .cc, .cpp, .CPP, .c++, .cp, or .cxx.
# SRCEXTS := .c # C program
# SRCEXTS := .cpp # C++ program
# SRCEXTS := .c .cpp # C/C++ program
SRCEXTS :=
# The flags used by the cpp (man cpp for more).
# CPPFLAGS := -Wall -Werror # show all warnings and take them as errors
CPPFLAGS :=
# The compiling flags used only for C.
# If it is a C++ program, no need to set these flags.
# If it is a C and C++ merging program, set these flags for the C parts.
CFLAGS :=
CFLAGS +=
# The compiling flags used only for C++.
# If it is a C program, no need to set these flags.
# If it is a C and C++ merging program, set these flags for the C++ parts.
CXXFLAGS :=
CXXFLAGS +=
# The library and the link options ( C and C++ common).
LDFLAGS :=
LDFLAGS +=
## Implict Section: change the following only when necessary.
##=============================================================================
# The C program compiler. Uncomment it to specify yours explicitly.
#CC = gcc
# The C++ program compiler. Uncomment it to specify yours explicitly.
#CXX = g++
# Uncomment the 2 lines to compile C programs as C++ ones.
#CC = $(CXX)
#CFLAGS = $(CXXFLAGS)
# The command used to delete file.
#RM = rm -f
## Stable Section: usually no need to be changed. But you can add more.
##=============================================================================
SHELL = /bin/sh
SOURCES = $(foreach d,$(SRCDIRS),$(wildcard $(addprefix $(d)/*,$(SRCEXTS))))
OBJS = $(foreach x,$(SRCEXTS), \
$(patsubst %$(x),%.o,$(filter %$(x),$(SOURCES))))
DEPS = $(patsubst %.o,%.d,$(OBJS))
.PHONY : all objs clean cleanall rebuild
all : $(PROGRAM)
# Rules for creating the dependency files (.d).
#---------------------------------------------------
%.d : %.c
@$(CC) -MM -MD $(CFLAGS) $<
%.d : %.C
@$(CC) -MM -MD $(CXXFLAGS) $<
%.d : %.cc
@$(CC) -MM -MD $(CXXFLAGS) $<
%.d : %.cpp
@$(CC) -MM -MD $(CXXFLAGS) $<
%.d : %.CPP
@$(CC) -MM -MD $(CXXFLAGS) $<
%.d : %.c++
@$(CC) -MM -MD $(CXXFLAGS) $<
%.d : %.cp
@$(CC) -MM -MD $(CXXFLAGS) $<
%.d : %.cxx
@$(CC) -MM -MD $(CXXFLAGS) $<
# Rules for producing the objects.
#---------------------------------------------------
objs : $(OBJS)
%.o : %.c
$(CC) -c $(CPPFLAGS) $(CFLAGS) $<
%.o : %.C
$(CXX) -c $(CPPFLAGS) $(CXXFLAGS) $<
%.o : %.cc
$(CXX) -c $(CPPFLAGS) $(CXXFLAGS) $<
%.o : %.cpp
$(CXX) -c $(CPPFLAGS) $(CXXFLAGS) $<
%.o : %.CPP
$(CXX) -c $(CPPFLAGS) $(CXXFLAGS) $<
%.o : %.c++
$(CXX -c $(CPPFLAGS) $(CXXFLAGS) $<
%.o : %.cp
$(CXX) -c $(CPPFLAGS) $(CXXFLAGS) $<
%.o : %.cxx
$(CXX) -c $(CPPFLAGS) $(CXXFLAGS) $<
# Rules for producing the executable.
#----------------------------------------------
$(PROGRAM) : $(OBJS)
ifeq ($(strip $(SRCEXTS)), .c) # C file
$(CC) -o $(PROGRAM) $(OBJS) $(LDFLAGS)
else # C++ file
$(CXX) -o $(PROGRAM) $(OBJS) $(LDFLAGS)
endif
-include $(DEPS)
rebuild: clean all
clean :
@$(RM) *.o *.d
cleanall: clean
@$(RM) $(PROGRAM) $(PROGRAM).exe
### End of the Makefile ## Suggestions are welcome ## All rights reserved ###
###############################################################################
下面提供兩個(gè)例子來(lái)具體說(shuō)明上面 Makefile 的用法。
例一 Hello World 程序
這個(gè)程序的功能是輸出 Hello, world! 這樣一行文字。由 hello.h、hello.c、main.cxx 三個(gè)文件組成。前兩個(gè)文件是 C 程序，后一個(gè)是 C++ 程序，因此這是一個(gè) C 和 C++ 混編程序。
/* File name: hello.h
* C header file
*/
#ifndef HELLO_H
#define HELLO_H
#ifdef __cplusplus
extern "C" {
#endif
void print_hello();
#ifdef __cplusplus
}
#endif
#endif
/* File name: hello.c
* C source file.
*/
#include "hello.h"
#include <stdio.h>
void print_hello()
{
puts( "Hello, world!" );
}
/* File name: main.cxx
* C++ source file.
*/
#include "hello.h"
int main()
{
print_hello();
return 0;
}
建立一個(gè)新的目錄，然后把這三個(gè)文件拷貝到目錄中，也把 Makefile 文件拷貝到目錄中。之后，對(duì) Makefile 的相關(guān)項(xiàng)目進(jìn)行如下設(shè)置：
PROGRAM := hello # 設(shè)置運(yùn)行程序名
SRCDIRS := . # 源程序位于當(dāng)前目錄下
SRCEXTS := .c .cxx # 源程序文件有 .c 和 .cxx 兩種類型
CFLAGS := -g # 為 C 目標(biāo)程序包含 GDB 可用的調(diào)試信息
CXXFLAGS := -g # 為 C++ 目標(biāo)程序包含 GDB 可用的調(diào)試信息
由于這個(gè)簡(jiǎn)單的程序只使用了 C 標(biāo)準(zhǔn)庫(kù)的函數(shù)（puts），所以對(duì)于 CFLAGS 和 CXXFLAGS 沒(méi)有過(guò)多的要求，LDFLAGS 和 CPPFLAGS 選項(xiàng)也無(wú)需設(shè)置。
經(jīng)過(guò)上面的設(shè)置之后，執(zhí)行 make 命令就可以編譯程序了。如果沒(méi)有錯(cuò)誤出現(xiàn)的話，./hello 就可以運(yùn)行程序了。
如果修改了源程序的話，可以看到只有和修改有關(guān)的源文件被編譯。也可以再為程序添加新的源文件，只要它們的擴(kuò)展名是已經(jīng)在 Makefile 中設(shè)置過(guò)的，那么就沒(méi)有必要修改 Makefile。 |
|
|
例二 GTK+ 版 Hello World 程序
這個(gè) GTK+ 2.0 版的 Hello World 程序可以從下面的網(wǎng)址上得到：http://www.gtk.org/tutorial/c58.html#SEC-HELLOWORLD。當(dāng)然，要編譯 GTK+ 程序，還需要你的系統(tǒng)上已經(jīng)安裝好了 GTK+。
跟第一個(gè)例子一樣，單獨(dú)創(chuàng)建一個(gè)新的目錄，把上面網(wǎng)頁(yè)中提供的程序保存為 main.c 文件。對(duì) Makefile 做如下設(shè)置：
PROGRAM := hello # 設(shè)置運(yùn)行程序名
SRCDIRS := . # 源程序位于當(dāng)前目錄下
SRCEXTS := .c # 源程序文件只有 .c 一種類型
CFLAGS := `pkg-config --cflags gtk+-2.0` # CFLAGS
LDFLAGS := `pkg-config --libs gtk+-2.0` # LDFLAGS
這是一個(gè) C 程序，所以 CXXFLAGS 沒(méi)有必要設(shè)置——即使被設(shè)置了也不會(huì)被使用。
編譯和連接 GTK+ 庫(kù)所需要的 CFLAGS 和 LDFLAGS 由 pkg-config 程序自動(dòng)產(chǎn)生。
現(xiàn)在就可以運(yùn)行 make 命令編譯、./hello 執(zhí)行這個(gè) GTK+ 程序了。
參考資料：
* Multi-file projects and the GNU Make utility
Author: George Foot
http://www.elitecoders.de/mags/cscene/CS2/CS2-10.html
* GNU Make Manual
http://www.gnu.org/software/make/manual/ |
|
|