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++ 混合三種編譯方式：
    (1) 若是隻指定 .c 擴展名，那麼這是一個 C 程序，用 $(CC) 表示的編譯命令進行編譯和鏈接。
    (2) 若是指定的是除 .c 以外的其它擴展名（如 .cc、.cpp、.cxx 等），那麼這是一個 C++ 程序，用 $(CXX) 進行編譯和鏈接。
    (3) 若是既指定了 .c，又指定了其它 C++ 擴展名，那麼這是 C/C++ 混合程序，將用 $(CC) 編譯其中的 C 程序，用 $(CXX) 編譯其中的 C++ 程序，最後再用 $(CXX) 鏈接程序。
    這些工做都是 make 根據在 Makefile 中提供的程序文件類型（擴展名）自動判斷進行的，不須要用戶干預。
    
    4. 指定編譯選項
    編譯選項由三部分組成：預處理選項、編譯選項以及鏈接選項，分別由 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 實現的。
    
    5. 編譯和鏈接
    上面的各項設置好以後保存 Makefile 文件。執行 make 命令，程序就開始編譯了。
    命令 make 會根據 Makefile 中設置好的路徑和文件類型搜索源程序文件，而後根據文件的類型調用相應的編譯命令、使用相應的編譯選項對程序進行編譯。
    編譯成功以後程序的鏈接會自動進行。若是沒有錯誤的話最終會產生程序的可執行文件。
    注意：在對程序編譯以後，會產生和源程序文件一一對應的 .d 文件。這是表示依賴關係的文件，經過它們 make 決定在源程序文件變更以後要進行哪些更新。爲每個源程序文件創建相應的 .d 文件這也是 GNU Make 推薦的方式。
    
    6. Makefile 目標（Targets）
    下面是關於這個 Makefile 提供的目標以及它所完成的功能：
    (1) make
    編譯和鏈接程序。至關於 make all。
    (2) make objs
    僅僅編譯程序產生 .o 目標文件，不進行鏈接（通常不多單獨使用）。
    (3) make clean
    刪除編譯產生的目標文件和依賴文件。
    (4) make cleanall
    刪除目標文件、依賴文件以及可執行文件。
    (5) 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 <SRCDIRS> directories for the source files
# with extensions specified in <SOURCE_EXT>, then compiles the sources
# and finally produces the <PROGRAM>, 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 <stdio.h>

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 程序能夠從下面的網址上獲得：http://www.gtk.org/tutorial/c58.html#SEC-HELLOWORLD。固然，要編譯 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
http://www.elitecoders.de/mags/cscene/CS2/CS2-10.html
2. GNU Make Manual
http://www.gnu.org/software/make/manual/

 

轉載: http://bbs.chinaunix.net/thread-711092-1-1.html