GUN Makefile

本文提供一个在GNU/Linux环境下通用的智能Makefile模板，用户可以将其引入到自己的工程当中。即使用户对此
Makefile的工作原理不甚了解，但是只需要修改少数几个关键变量，就可以满足不同的应用需求。


1. 使用环境
GNU make 3.8.1或者以上版本
sed
gcc/binutils
cygwin或者Linux

2. 关键变量
CROSS_COMPILE：交叉编译器前缀
OPTIMIZE：关于优化的编译参数
WARNINGS：关于warning的编译参数
DEFS：    关于宏定义的编译参数
EXTRA_CFLAGS：其它的编译参数
$(OPTIMIZE) $(WARNINGS) $(DEFS) $(EXTRA_CFLAGS)共同构成了传给gcc的编译参数。

INC_DIR：头文件目录
SRC_DIR：源文件目录（当前目录.是被默认包含的）
OBJ_DIR：object文件的输出目录
EXTRA_SRC：源文件列表
EXCLUDE_FILES：exclude文件列表

SUFFIX：源文件的后缀名
TARGET：最终的目标程序名
TARGET_TYPE：目标程序的类型。
可以定义的类型为：ar（static library），so（shared library）和app（application）。

最终Makefile的行为是：
在$(SRC_DIR)定义的每个目录中查找后缀为$(SUFFIX)的文件，并加上$(EXTRA_SRC)中的文件，然后排除掉
$(EXCLUDE_FILES)中的文件，获得本工程定义的源文件列表。对于每一个源文件，编译生成的一个.o文件和一个.d文件
（依赖文件），放在$(OBJ_DIR)目录下。最终生成的目标文件为$(TARGET)。
此Makefile已经充分考虑到文件之间的依赖关系，即，如果某个头文件发生改变，当运行make的时候，所有依赖于它的
源文件都将被重新编译。

附件是一个例子，演示了如何处理不同目录，如何处理不同目标类型，以及如何exclude文件。
  (3.39 KB)

1. ###############################################################################
   
2. #
   
3. # A smart Makefile template for GNU/LINUX programming
   
4. #
   
5. # Author: PRC (ijkxyz AT msn DOT com)
   
6. # Date:   2011/06/17
   
7. #
   
8. # Usage:
   
9. #   $ make           Compile and link (or archive)
   
10. #   $ make clean     Clean the objectives and target.
    
11. ###############################################################################
    
12. 
    
13. CROSS_COMPILE =
    
14. OPTIMIZE := -O2
    
15. WARNINGS := -Wall -Wno-unused -Wno-format
    
16. DEFS     :=
    
17. EXTRA_CFLAGS := 
    
18. 
    
19. INC_DIR   =
    
20. SRC_DIR   =
    
21. OBJ_DIR   =
    
22. EXTRA_SRC =
    
23. EXCLUDE_FILES =
    
24. 
    
25. SUFFIX       = c cpp cc cxx
    
26. TARGET       :=
    
27. #TARGET_TYPE  :=
    
28. TARGET_TYPE  :=
    
29. #TARGET_TYPE  :=
    
30. 
    
31. 
    
32. #####################################################################################
    
33. #  Do not change any part of them unless you have understood this script very well  #
    
34. #  This is a kind remind.                                                           #
    
35. #####################################################################################
    
36. 
    
37. #FUNC#  Add a new line to the input stream.
    
38. define add_newline
    
39. $1
    
40. 
    
41. endef
    
42. 
    
43. #FUNC# set the variable `src-x' according to the input $1
    
44. define set_src_x
    
45. src-$1 = $(filter-out $4,$(foreach d,$2,$(wildcard $d/*.$1)) $(filter %.$1,$3))
    
46. 
    
47. endef
    
48. 
    
49. #FUNC# set the variable `obj-x' according to the input $1
    
50. define set_obj_x
    
51. obj-$1 = $(patsubst %.$1,$3%.o,$(notdir $2))
    
52. 
    
53. endef
    
54. 
    
55. #VAR# Get the uniform representation of the object directory path name
    
56. ifneq ($(OBJ_DIR),)
    
57. prefix_objdir  = $(shell echo $(OBJ_DIR)|sed 's:\(\./*\)*::')
    
58. prefix_objdir := $(filter-out /,$(prefix_objdir)/)
    
59. endif
    
60. 
    
61. GCC      := $(CROSS_COMPILE)gcc
    
62. G++      := $(CROSS_COMPILE)g++
    
63. SRC_DIR := $(sort . $(SRC_DIR))
    
64. inc_dir = $(foreach d,$(sort $(INC_DIR) $(SRC_DIR)),-I$d)
    
65. 
    
66. #--# Do smart deduction automatically
    
67. $(eval $(foreach i,$(SUFFIX),$(call set_src_x,$i,$(SRC_DIR),$(EXTRA_SRC),$(EXCLUDE_FILES))))
    
68. $(eval $(foreach i,$(SUFFIX),$(call set_obj_x,$i,$(src-$i),$(prefix_objdir))))
    
69. $(eval $(foreach f,$(EXTRA_SRC),$(call add_newline,vpath $(notdir $f) $(dir $f))))
    
70. $(eval $(foreach d,$(SRC_DIR),$(foreach i,$(SUFFIX),$(call add_newline,vpath %.$i $d))))
    
71. 
    
72. all_objs = $(foreach i,$(SUFFIX),$(obj-$i))
    
73. all_srcs = $(foreach i,$(SUFFIX),$(src-$i))
    
74. 
    
75. CFLAGS       = $(EXTRA_CFLAGS) $(WARNINGS) $(OPTIMIZE) $(DEFS)
    
76. TARGET_TYPE := $(strip $(TARGET_TYPE))
    
77. 
    
78. ifeq ($(filter $(TARGET_TYPE),so ar app),)
    
79. $(error Unexpected TARGET_TYPE `$(TARGET_TYPE)')
    
80. endif
    
81. 
    
82. ifeq ($(TARGET_TYPE),so)
    
83. CFLAGS  += -fpic -shared
    
84. LDFLAGS += -shared
    
85. endif
    
86. 
    
87. PHONY = all .mkdir clean
    
88. 
    
89. all: .mkdir $(TARGET)
    
90. 
    
91. define cmd_o
    
92. $(obj-$1): $2%.o: %.$1  $(MAKEFILE_LIST)
    
93.         $(GCC) $(inc_dir) -Wp,-MT,$@ -Wp,-MMD,$@.d $(CFLAGS) -c -o $@ $<
    
94. 
    
95. endef
    
96. $(eval $(foreach i,$(SUFFIX),$(call cmd_o,$i,$(prefix_objdir))))
    
97. 
    
98. ifeq ($(TARGET_TYPE),ar)
    
99. $(TARGET): AR := $(CROSS_COMPILE)ar
    
100. $(TARGET): $(all_objs)
     
101.         rm -f $@
     
102.         $(AR) rcvs $@ $(all_objs)
     
103. else
     
104. $(TARGET): LD = $(if $(strip $(src-cpp) $(src-cc) $(src-cxx)),$(G++),$(GCC))
     
105. $(TARGET): $(all_objs)
     
106.         $(LD) $(LDFLAGS) $(all_objs) -o $@
     
107. endif
     
108. 
     
109. .mkdir:
     
110.         @if [ ! -d $(OBJ_DIR) ]; then mkdir -p $(OBJ_DIR); fi
     
111. 
     
112. clean:
     
113.         rm -f $(prefix_objdir)*.o $(TARGET)
     
114. 
     
115. -include $(patsubst %.o,%.o.d,$(all_objs))
     
116. 
     
117. .PHONY: $(PHONY)