C/C++ 通用 Makefile

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 的使用方法如下：

• 程序目录的组织
  尽量将自己的源程序集中在一个目录中，并且把 Makefile 和源程序放在一起，这样用起来比较方便。当然，也可以将源程序分类存放在不同的目录中。
  
  在程序目录中创建一个名为 Makefile 的文本文件，将后面列出的 Makefile 的内容复制到这个文件中。（注意：在复制的过程中，Makfile 中各命令前面的 Tab 字符有可能被转换成若干个空格。这种情况下需要把 Makefile 命令前面的这些空格替换为一个 Tab。）
  
  将当前工作目录切换到 Makefile 所在的目录。目前，这个 Makefile 只支持在当前目录中的调用，不支持当前目录和 Makefile 所在的路径不是同一目录的情况。
• 指定可执行文件
  程序编译和连接成功后产生的可执行文件在 Makefile 中的 PROGRAM 变量中设定。这一项不能为空。为自己程序的可执行文件起一个有意义的名子吧。
• 指定源程序
  要编译的源程序由其所在的路径和文件的扩展名两项来确定。由于头文件是通过包含来使用的，所以在这里说的源程序不应包含头文件。
  
  程序所在的路径在 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 的内容如下：

view plain copy to clipboard print ?

1. ###############################################################################  
2. #  
3. # Generic Makefile for C/C++ Program  
4. #  
5. # Author: whyglinux (whyglinux AT hotmail DOT com)  
6. # Date:   2006/03/04  
7. # Description:  
8. # The makefile searches in <SRCDIRS> directories for the source files  
9. # with extensions specified in <SOURCE_EXT>, then compiles the sources  
10. # and finally produces the <PROGRAM>, the executable file, by linking  
11. # the objectives.  
12. # Usage:  
13. #   $ make           compile and link the program.  
14. #   $ make objs      compile only (no linking. Rarely used).  
15. #   $ make clean     clean the objectives and dependencies.  
16. #   $ make cleanall  clean the objectives, dependencies and executable.  
17. #   $ make rebuild   rebuild the program. The same as make clean && make all.  
18. #==============================================================================  
19. ## Customizing Section: adjust the following if necessary.  
20. ##=============================================================================  
21. # The executable file name.  
22. # It must be specified.  
23. # PROGRAM   := a.out    # the executable name  
24. PROGRAM   :=  
25. # The directories in which source files reside.  
26. # At least one path should be specified.  
27. # SRCDIRS   := .        # current directory  
28. SRCDIRS   :=  
29. # The source file types (headers excluded).  
30. # At least one type should be specified.  
31. # The valid suffixes are among of .c, .C, .cc, .cpp, .CPP, .c++, .cp, or .cxx.  
32. # SRCEXTS   := .c      # C program  
33. # SRCEXTS   := .cpp    # C++ program  
34. # SRCEXTS   := .c .cpp # C/C++ program  
35. SRCEXTS   :=  
36. # The flags used by the cpp (man cpp for more).  
37. # CPPFLAGS  := -Wall -Werror # show all warnings and take them as errors  
38. CPPFLAGS  :=  
39. # The compiling flags used only for C.  
40. # If it is a C++ program, no need to set these flags.  
41. # If it is a C and C++ merging program, set these flags for the C parts.  
42. CFLAGS    :=  
43. CFLAGS    +=  
44. # The compiling flags used only for C++.  
45. # If it is a C program, no need to set these flags.  
46. # If it is a C and C++ merging program, set these flags for the C++ parts.  
47. CXXFLAGS  :=  
48. CXXFLAGS  +=  
49. # The library and the link options ( C and C++ common).  
50. LDFLAGS   :=  
51. LDFLAGS   +=  
52. ## Implict Section: change the following only when necessary.  
53. ##=============================================================================  
54. # The C program compiler. Uncomment it to specify yours explicitly.  
55. #CC      = gcc  
56. # The C++ program compiler. Uncomment it to specify yours explicitly.  
57. #CXX     = g++  
58. # Uncomment the 2 lines to compile C programs as C++ ones.  
59. #CC      = $(CXX)  
60. #CFLAGS  = $(CXXFLAGS)  
61. # The command used to delete file.  
62. #RM        = rm -f  
63. ## Stable Section: usually no need to be changed. But you can add more.  
64. ##=============================================================================  
65. SHELL   = /bin/sh  
66. SOURCES = $(foreach d,$(SRCDIRS),$(wildcard $(addprefix $(d)/*,$(SRCEXTS))))  
67. OBJS    = $(foreach x,$(SRCEXTS), /  
68.       $(patsubst %$(x),%.o,$(filter %$(x),$(SOURCES))))  
69. DEPS    = $(patsubst %.o,%.d,$(OBJS))  
70. .PHONY : all objs clean cleanall rebuild  
71. all : $(PROGRAM)  
72. # Rules for creating the dependency files (.d).  
73. #---------------------------------------------------  
74. %.d : %.c  
75.         @$(CC) -MM -MD $(CFLAGS) $<  
76. %.d : %.C  
77.         @$(CC) -MM -MD $(CXXFLAGS) $<  
78. %.d : %.cc  
79.         @$(CC) -MM -MD $(CXXFLAGS) $<  
80. %.d : %.cpp  
81.         @$(CC) -MM -MD $(CXXFLAGS) $<  
82. %.d : %.CPP  
83.         @$(CC) -MM -MD $(CXXFLAGS) $<  
84. %.d : %.c++  
85.         @$(CC) -MM -MD $(CXXFLAGS) $<  
86. %.d : %.cp  
87.         @$(CC) -MM -MD $(CXXFLAGS) $<  
88. %.d : %.cxx  
89.         @$(CC) -MM -MD $(CXXFLAGS) $<  
90. # Rules for producing the objects.  
91. #---------------------------------------------------  
92. objs : $(OBJS)  
93. %.o : %.c  
94.         $(CC) -c $(CPPFLAGS) $(CFLAGS) $<  
95. %.o : %.C  
96.         $(CXX) -c $(CPPFLAGS) $(CXXFLAGS) $<  
97. %.o : %.cc  
98.         $(CXX) -c $(CPPFLAGS) $(CXXFLAGS) $<  
99. %.o : %.cpp  
100.         $(CXX) -c $(CPPFLAGS) $(CXXFLAGS) $<  
101. %.o : %.CPP  
102.         $(CXX) -c $(CPPFLAGS) $(CXXFLAGS) $<  
103. %.o : %.c++  
104.         $(CXX -c $(CPPFLAGS) $(CXXFLAGS) $<  
105. %.o : %.cp  
106.         $(CXX) -c $(CPPFLAGS) $(CXXFLAGS) $<  
107. %.o : %.cxx  
108.         $(CXX) -c $(CPPFLAGS) $(CXXFLAGS) $<  
109. # Rules for producing the executable.  
110. #----------------------------------------------  
111. $(PROGRAM) : $(OBJS)  
112. ifeq ($(strip $(SRCEXTS)), .c)  # C file  
113.         $(CC) -o $(PROGRAM) $(OBJS) $(LDFLAGS)  
114. else                            # C++ file  
115.         $(CXX) -o $(PROGRAM) $(OBJS) $(LDFLAGS)  
116. endif  
117. -include $(DEPS)  
118. rebuild: clean all  
119. clean :  
120.         @$(RM) *.o *.d  
121. cleanall: clean  
122.         @$(RM) $(PROGRAM) $(PROGRAM).exe  
123. ### End of the Makefile ##  Suggestions are welcome  ## All rights reserved ###  
124. ###############################################################################  

下面提供两个例子来具体说明上面 Makefile 的用法。

例一　Hello World 程序 

这个程序的功能是输出 Hello, world! 这样一行文字。由 hello.h、hello.c、main.cxx 三个文件组成。前两个文件是 C 程序，后一个是 C++ 程序，因此这是一个 C 和 C++ 混编程序。

view plain copy to clipboard print ?

1. /* File name: hello.h 
2.  * C header file 
3.  */  
4. #ifndef HELLO_H  
5. #define HELLO_H  
6. #ifdef __cplusplus  
7. extern "C" {  
8. #endif  
9.   void print_hello();  
10. #ifdef __cplusplus  
11. }  
12. #endif  
13. #endif  

view plain copy to clipboard print ?

1. /* File name: hello.c 
2.  * C source file. 
3.  */  
4. #include "hello.h"  
5. #include <stdio.h>  
6. void print_hello()  
7. {  
8.   puts( "Hello, world!" );  
9. }  

view plain copy to clipboard print ?

1. /* File name: main.cxx 
2.  * C++ source file. 
3.  */  
4. #include "hello.h"  
5. int main()  
6. {  
7.   print_hello();  
8.   return 0;  
9. }  

建立一个新的目录，然后把这三个文件拷贝到目录中，也把 Makefile 文件拷贝到目录中。之后，对 Makefile 的相关项目进行如下设置：

view plain copy to clipboard print ?

1. PROGRAM   := hello      # 设置运行程序名  
2. SRCDIRS   := .          # 源程序位于当前目录下  
3. SRCEXTS   := .c .cxx    # 源程序文件有 .c 和 .cxx 两种类型  
4. CFLAGS    := -g         # 为 C 目标程序包含 GDB 可用的调试信息  
5. 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 做如下设置：

view plain copy to clipboard print ?

1. PROGRAM   := hello      # 设置运行程序名  
2. SRCDIRS   := .          # 源程序位于当前目录下  
3. SRCEXTS   := .c         # 源程序文件只有 .c 一种类型  
4. CFLAGS    := `pkg-config --cflags gtk+-2.0`  # CFLAGS  
5. LDFLAGS   := `pkg-config --libs gtk+-2.0`    # LDFLAGS  

这是一个 C 程序，所以 CXXFLAGS 没有必要设置——即使被设置了也不会被使用。

编译和连接 GTK+ 库所需要的 CFLAGS 和 LDFLAGS 由 pkg-config 程序自动产生。

现在就可以运行 make 命令编译、./hello 执行这个 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/