C/C++ 通用 Makefile(轉)

C/C++ 通用 Makefile(轉)[@more@]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
==================================================

本文提供了一個用於對 C/C++ 程式進行編譯和連線以產生可執行程式的通用 Makefile。

在使用 Makefile 之前，只需對它進行一些簡單的設定即可；而且一經設定，即使以後對源程式檔案有所增減一般也不再需要改動 Makefile。因此，即便是一個沒有學習過 Makefile 書寫規則的人，也可以為自己的 C/C++ 程式快速建立一個可工作的 Makefile。

這個 Makefile 可以在 GNU Make 和 GCC 編譯器下正常工作。但是不能保證對於其它版本的 Make 和編譯器也能正常工作。

如果你發現了本文中的錯誤，或者對本文有什麼感想或建議，可透過 whyglinux AT hotmail DOT com 郵箱和作者聯絡。

此 Makefile 的使用方法如下：

1. 程式目錄的組織
   儘量將自己的源程式集中在一個目錄中，並且把 Makefile 和源程式放在一起，這樣用起來比較方便。當然，也可以將源程式分類存放在不同的目錄中。
   
   在程式目錄中建立一個名為 Makefile 的文字檔案，將後面列出的 Makefile 的內容複製到這個檔案中。（注意：在複製的過程中，Makfile 中各命令前面的 Tab 字元有可能被轉換成若干個空格。這種情況下需要把 Makefile 命令前面的這些空格替換為一個 Tab。）
   
   將當前工作目錄切換到 Makefile 所在的目錄。目前，這個 Makefile 只支援在當前目錄中的呼叫，不支援當前目錄和 Makefile 所在的路徑不是同一目錄的情況。
   
   
2. 指定可執行檔案
   程式編譯和連線成功後產生的可執行檔案在 Makefile 中的 PROGRAM 變數中設定。這一項不能為空。為自己程式的可執行檔案起一個有意義的名子吧。
   
   
3. 指定源程式
   要編譯的源程式由其所在的路徑和檔案的副檔名兩項來確定。由於標頭檔案是透過包含來使用的，所以在這裡說的源程式不應包含標頭檔案。
   
   程式所在的路徑在 SRCDIRS 中設定。如果源程式分佈在不同的目錄中，那麼需要在 SRCDIRS 中一一指定，並且路徑名之間用空格分隔。
   
   在 SRCEXTS 中指定程式中使用的檔案型別。C/C++ 程式的副檔名一般有比較固定的幾種形式：.c、.C、.cc、.cpp、.CPP、.c++、.cp、或者.cxx（參見 man gcc）。副檔名決定了程式是 C 還是 C++ 程式：.c 是 C 程式，其它副檔名錶示 C++ 程式。一般固定使用其中的一種副檔名即可。但是也有可能需要使用多種副檔名，這可以在 SOURCE_EXT 中一一指定，各個副檔名之間用空格分隔。
   
   雖然並不常用，但是 C 程式也可以被作為 C++ 程式編譯。這可以透過在 Makefile 中設定 CC = $(CXX) 和 CFLAGS = $(CXXFLAGS) 兩項即可實現。
   
   這個 Makefile 支援 C、C++ 以及 C/C++ 混合三種編譯方式：
   
   • 如果只指定 .c 副檔名，那麼這是一個 C 程式，用 $(CC) 表示的編譯命令進行編譯和連線。
     
   • 如果指定的是除 .c 之外的其它副檔名（如 .cc、.cpp、.cxx 等），那麼這是一個 C++ 程式，用 $(CXX) 進行編譯和連線。
     
   • 如果既指定了 .c，又指定了其它 C++ 副檔名，那麼這是 C/C++ 混合程式，將用 $(CC) 編譯其中的 C 程式，用 $(CXX) 編譯其中的 C++ 程式，最後再用 $(CXX) 連線程式。
     

這些工作都是 make 根據在 Makefile 中提供的程式檔案型別（副檔名）自動判斷進行的，不需要使用者干預。

指定編譯選項
編譯選項由三部分組成：預處理選項、編譯選項以及連線選項，分別由 CPPFLAGS、CFLAGS與CXXFLAGS、LDFLAGS 指定。

CPPFLAGS 選項可參考 C 預處理命令 cpp 的說明，但是注意不能包含 -M 以及和 -M 有關的選項。如果是 C/C++ 混合程式設計，也可以在這裡設定 C/C++ 的一些共同的編譯選項。

CFLAGS 和 CXXFLAGS 兩個變數通常用來指定編譯選項。前者僅僅用於指定 C 程式的編譯選項，後者僅僅用於指定 C++ 程式的編譯選項。其實也可以在兩個變數中指定一些預處理選項（即一些本來應該放在 CPPFLAGS 中的選項），和 CPPFLAGS 並沒有明確的界限。

連線選項在 LDFLAGS 中指定。如果只使用 C/C++ 標準庫，一般沒有必要設定。如果使用了非標準庫，應該在這裡指定連線需要的選項，如庫所在的路徑、庫名以及其它聯接選項。

現在的庫一般都提供了一個相應的 .pc 檔案來記錄使用庫所需要的預編譯選項、編譯選項和連線選項等資訊，透過 pkg-config 可以動態提取這些選項。與由使用者顯式指定各個選項相比，使用 pkg-config 來訪問庫提供的選項更方便、更具通用性。在後面可以看到一個 GTK+ 程式的例子，其編譯和連線選項的指定就是用 pkg-config 實現的。

編譯和連線
上面的各項設定好之後儲存 Makefile 檔案。執行 make 命令，程式就開始編譯了。

命令 make 會根據 Makefile 中設定好的路徑和檔案型別搜尋源程式檔案，然後根據檔案的型別呼叫相應的編譯命令、使用相應的編譯選項對程式進行編譯。

編譯成功之後程式的連線會自動進行。如果沒有錯誤的話最終會產生程式的可執行檔案。

注意：在對程式編譯之後，會產生和源程式檔案一一對應的 .d 檔案。這是表示依賴關係的檔案，透過它們 make 決定在源程式檔案變動之後要進行哪些更新。為每一個源程式檔案建立相應的 .d 檔案這也是 GNU Make 推薦的方式。

Makefile 目標（Targets）
下面是關於這個 Makefile 提供的目標以及它所完成的功能：

• make
  編譯和連線程式。相當於 make all。
  
• make objs
  僅僅編譯程式產生 .o 目標檔案，不進行連線（一般很少單獨使用）。
  
• make clean
  刪除編譯產生的目標檔案和依賴檔案。
  
• make cleanall
  刪除目標檔案、依賴檔案以及可執行檔案。
  
• make rebuild
  重新編譯和連線程式。相當於 make clean && make all。
  

關於這個 Makefile 的實現原理不準備詳細解釋了。如果有興趣的話，可參考文末列出的“參考資料”。

Makefile 的內容如下：

###############################################################################
#
# Generic Makefile for C/C++ Program
#
# Author: whyglinux (whyglinux AT hotmail DOT com)
# Date: 2006/03/04

# Description:
# The makefile searches in directories for the source files
# with extensions specified in , then compiles the sources
# and finally produces the , 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 ###
###############################################################################


下面提供兩個例子來具體說明上面 Makefile 的用法。

例一　Hello World 程式

這個程式的功能是輸出 Hello, world! 這樣一行文字。由 hello.h、hello.c、main.cxx 三個檔案組成。前兩個檔案是 C 程式，後一個是 C++ 程式，因此這是一個 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

void print_hello()
{
puts( "Hello, world!" );
}



/* File name: main.cxx
* C++ source file.
*/
#include "hello.h"

int main()
{
print_hello();

return 0;
}


建立一個新的目錄，然後把這三個檔案複製到目錄中，也把 Makefile 檔案複製到目錄中。之後，對 Makefile 的相關專案進行如下設定：

PROGRAM := hello # 設定執行程式名
SRCDIRS := . # 源程式位於當前目錄下
SRCEXTS := .c .cxx # 源程式檔案有 .c 和 .cxx 兩種型別
CFLAGS := -g # 為 C 目標程式包含 GDB 可用的除錯資訊
CXXFLAGS := -g # 為 C++ 目標程式包含 GDB 可用的除錯資訊


由於這個簡單的程式只使用了 C 標準庫的函式（puts），所以對於 CFLAGS 和 CXXFLAGS 沒有過多的要求，LDFLAGS 和 CPPFLAGS 選項也無需設定。

經過上面的設定之後，執行 make 命令就可以編譯程式了。如果沒有錯誤出現的話，./hello 就可以執行程式了。

如果修改了源程式的話，可以看到只有和修改有關的原始檔被編譯。也可以再為程式新增新的原始檔，只要它們的副檔名是已經在 Makefile 中設定過的，那麼就沒有必要修改　Makefile。

例二　GTK+ 版 Hello World 程式

這個 GTK+ 2.0 版的 Hello World 程式可以從下面的網址上得到：。當然，要編譯 GTK+ 程式，還需要你的系統上已經安裝好了 GTK+。

跟第一個例子一樣，單獨建立一個新的目錄，把上面網頁中提供的程式儲存為 main.c 檔案。對 Makefile 做如下設定：

PROGRAM := hello # 設定執行程式名
SRCDIRS := . # 源程式位於當前目錄下
SRCEXTS := .c # 源程式檔案只有 .c 一種型別
CFLAGS := `pkg-config --cflags gtk+-2.0` # CFLAGS
LDFLAGS := `pkg-config --libs gtk+-2.0` # LDFLAGS


這是一個 C 程式，所以 CXXFLAGS 沒有必要設定——即使被設定了也不會被使用。

編譯和連線 GTK+ 庫所需要的 CFLAGS 和 LDFLAGS 由 pkg-config 程式自動產生。

現在就可以執行 make 命令編譯、./hello 執行這個 GTK+ 程式了。

參考資料：

1. Multi-file projects and the GNU Make utility
   Author: George Foot
   
   
   
2. GNU Make Manual
   
   

作者:whyglinux<source>